Members Related List Tool Arguments

None

Indicates the action performed when a member list item is clicked.

The value can be one of the following: None, Replace, Retrieve

If None, no action is performed. If Replace, the active member cell is replaced with the list item value. If Retrieve, the active member cell is replaced with the list item value, and an Essbase retrieve operation is automatically performed.

When the view is configured with a selector that represents the dimension that is associated with the active member, the selection is automatically updated to reflect the selected member item. If the toolbars configuration contains the Auto Refresh tool, the selection change automatically refreshes the view. When this scenario applies, the Action should be set to None.

The Action tool argument is optional. If no tool argument is specified, no action is performed.

Controls whether the tool is available for the selected member cell(s) based on the dimension(s) to which the member(s) belongs. The value is a semi-colon delimited list of dimension names. If one or more dimensions are specified, each selected member must belong to a specified dimension for the tool to be displayed on the context menu.

For example, if the AllowedDimensions is Product;Market, the tool is displayed only when the selected member (or members) belongs to the Product or Market dimension.

The AllowedDimensions tool argument is optional. By default, the tool is displayed on the context menu for members belonging to any dimension.

Both the AllowedDimensions and AllowedOrientations settings are used to control whether the tool is displayed.

MemberCellOrientations.All

Controls whether the tool is available for the selected member cell(s) based on the orientation of the member(s). If one or more orientations are specified, each selected member must be one of the specified orientations for the tool to be displayed on the context menu.

The AllowedOrientation tool argument is optional. By default, the value is All, which indicates that the tool is displayed for any member cell.

Both the AllowedOrientations and AllowedDimensions settings are used to control whether the tool is displayed.

Indicates the relationship of the related members to the member represented by the active cell.

The value can be one of the following: children, descendants, siblings, samelevel, samegen, samedim, parents, dimension, or ancestor

The MemberRelationship tool argument is required.

false

Controls whether the member list items should be sorted in ascending order alphabetically.

The Sort tool argument is optional. By default, the member list items are not sorted, but are displayed in the order returned from Essbase.