Connection Selector List Properties

The following properties are available for Connection Selector List objects, grouped by the categories shown in the Selectors and Selector Lists editors.

Connections

Property Type Default Description

Categories

List<string>

The optional list of connection store categories used to filter the connections. Supports token replacement.

ConnectionIDs

List<string>

The optional list of connection IDs to include. Supports token replacement.

ExcludeConnectionIDs

List<string>

The optional list of connection IDs to exclude. Supports token replacement.

Kinds

List<string>

The optional list of object type kinds used to filter the connections. Supports token replacement.

RequireAllKinds

bool

false

Whether a connection type must match all of the kinds rather than any of them.

Types

List<string>

The optional list of connection object type IDs, such as EssbaseConnection or EPMCloudPlanningConnection, used to filter the connections. Supports token replacement.

Default Selection

Property Type Default Description

DefaultSelectionPolicy

DefaultPolicy

DefaultPolicy.None

Indicates how the default selection is determined.

None - No item(s) is selected by default.

LastUsedItem - The last item(s) used within the context is the default. The context is specified by the view’s SelectorLastUsedItemContext setting.

FirstItem - The first item in the list is the default.

AllItems - All items in the list are automatically selected. This option only applies when multiple selections are allowed.

SpecifiedString - The DefaultSelectionString value, which can be tokenized, is the default.

Today - Today’s date. This option only applies to Date selectors and Generic selectors that use the SelectorComboBox SelectorControlObjectTypeID.

DefaultSelectionString

string

The semi-colon delimited list of values that represents the default selection when the DefaultSelectionPolicy is SpecifiedString. The string can be tokenized.

The DefaultSelectionString is only applicable when the DefaultSelectionPolicy is set to SpecifiedString.

NullLastUsedItemString

string

The string that represents the item value(s) used as the default when the DefaultSelectionPolicy is LastUsedItem and no last used item exists. The value can be tokenized.

Dependencies

Property Type Default Description

DependentOnSelectorIDs

string

A semi-colon delimited list of ID’s of the other selectors that affect this selector list. At runtime, when a selection changes for any of the specified selectors, this selector list is automatically re-generated.

Null Selection

Property Type Default Description

NullSelectionText

string

The text displayed by the selector when no item(s) is selected. The setting is often used to display a prompt. The value can be tokenized.

NullSelectionTokenValue

string

The text assigned to the token when no item(s) is selected. The value can be tokenized.

NullSelectionTokenValue is typically used to specify the token value for a selector that is configured as optional, but still needs to be represented by a token.

Token Value

Property Type Default Description

TokenValueDelimiter

string

;

When the user is allowed to select multiple items, the token value is a delimited list of substrings in which each substring represents a selected item. The TokenValueDelimiter defines the character(s) used to delimit the substrings within the token value. By default, the delimiter is a semi-colon.

TokenValueFormat

string

The optional format applied to the selector token value built from the selected connection IDs, where {0} represents the delimited connection IDs. The format applies to the selector token only; connection assignment always uses the unformatted connection ID of the first selected item. When the view’s EssbaseConnectionID is tokenized to this selector’s token, leave the token formats unset so that the token resolves as a connection ID.

TokenValueItemEscapeSingleQuote

bool

false

Whether each single quotation mark in a connection ID is escaped as a pair of single quotation marks in the selector token value. The escaping applies to the selector token only; connection assignment always uses the unformatted connection ID of the first selected item.

TokenValueItemFormat

string

The optional format applied to each selected connection in the selector token value, where {0} or {ID} represents the connection ID, {Name} the connection name, and {Description} the connection description. The format applies to the selector token only; connection assignment always uses the unformatted connection ID of the first selected item. When the view’s EssbaseConnectionID is tokenized to this selector’s token, leave the token formats unset so that the token resolves as a connection ID.