GetCaption
Returns a user-friendly member name with the default data type. Useful when addressing members in non-primary hierarchies for the dimension.
Syntax
Member_Expression.GetCaption
Arguments
Member_Expression | MDX expression that returns a member. |
---|
Examples
GetCaption would return a display name for a dimension member in a user-friendly format. This function can be used on any dimension (regardless of the field type).
For example, when importing data from Jira, eazyBI creates the "Issue" dimension with multiple hierarchies (default and Issue.Sub-task). The default hierarchy has just two levels Project > Issue. The second hierarchy groups issues by issue type levels (Project > Epic > Parent > Sub-task).
For default hierarchy, you can use the Name function to return the full name (issue key and summary) of a member:
[Issue].CurrentMember.Name
However, it won't work the same for other (not default) hierarchies in the "Issue" dimension. You can return the user-friendly name for members from other hierarchies using the GetCaption function:
[Issue].CurrentHierarchyMember.GetCaption
If there is just one hierarchy for the dimension, GetCaption would return the same results as the Name function.
Another example is to search and filter Approvals dimension members where the report's current user name belongs to.
Aggregate( Filter( [Approvals].[Approvals].Members, CurrentUserName() MATCHES Replace([Approvals].CurrentHierarchyMember.getCaption,",","|") ) )
The following code would return a user-friendly name for the "Approvals" dimension member which usually is a comma-separated string of users since the dimension Approvals is imported from a multi-user picker custom field.
[Approvals].CurrentHierarchyMember.GetCaption
See also
- Function get can be used to properties for member available properties.
- Function replace to replace one substring with another in the defined string.
- Function CurrentUserName to return the name of the report user.
- Functions CurrentMember and CurrentHierarchyMember to address the dimension members.