Sign On And Set Active Essbase Connection Tool Arguments
The following properties are available for Sign On And Set Active Essbase Connection Tool Arguments objects, grouped by the categories shown in the Toolbars Designer.
Misc
| Property | Type | Default | Description |
|---|---|---|---|
string |
If specified, the value replaces the default "APS URL" editor caption. |
||
bool |
true |
Controls whether the APS URL editor is enabled. When set to False, the user is not allowed to edit the specified APS URL. The APS URL is optional. If not specified, the APS URL configured in the dodeca-essbase.properties file is used |
|
bool |
true |
Controls whether the user is allowed to key in an APS URL that does not appear in the configured list of servers. When set to True, the user is only allowed to select an item from the dropdown list. |
|
string |
If specified, the value replaces the default "Select an APS URL" string displayed in the editor when no value is selected. |
||
bool |
true |
Controls whether the APS URL editor is visible. When set to False, the editor is not displayed in the control. |
|
AutoOpenEssbaseSignOnControlPolicy |
Default valueAutoOpenEssbaseSignOnControlPolicy.OnlyWhenViewNotAssignedEssbaseConnection |
Controls whether the user-interface control automatically opens when the view opens. The AutoOpenDockedControl setting is only applicable when the ControlDisplayMode is DockedControl or LockedDockedControl. AutoOpen - The control automatically opens when the view opens. DoNotAutoOpen - The control does not automatically opens when the view opens. OnlyWhenViewNotAssignedEssbaseConnection - The control automatically opens when the view is not assigned an Essbase connection. By default, the policy is set to OnlyWhenViewNotAssignedEssbaseConnection. |
|
UserControlDisplayMode |
UserControlDisplayMode.DockedControl |
Controls whether a docked pane or a modal dialog contains the user-interface control that displays the Essbase server/application/database tree. DockedControl — Displays a pane that contains the user-interface control. The pane is docked the first time the user clicks the tool button. The docked location is specified by the DockedControlLocation. LockedDockedControl — Same as a DockedControl, except that the user cannot move the control to a different docked location. ModalDialog — Displays a modal dialog that contains the user-interface control. The dialog is displayed each time the user clicks the tool button, and must be closed by the user. |
|
DockedControlLocation |
DockedControlLocation.Right |
The initial docked location for the user-interface control. The setting is only applicable when the ControlDisplayMode is set to DockedControl or LockedDockedControl. |
|
DodecaEssbaseServiceConfigContainer |
EssbaseServiceConfigContainer |
The DodecaEssbaseServiceConfig setting configures the Essbase services (i.e. dodeca-essbase service URL’s) that appear in the Essbase Service Editor’s dropdown list, and optionally includes an APS URL and/or one or more servers for each dodeca-essbase service. A specified APS URL or Essbase server(s) overrides the corresponding entry in the dodeca-essbase.properties file associated with the dodeca-essbase service. The Essbase Service Configuration editor contains any entries that were previously configured along with all the unique service paths that are specified as a ServletPath value in the Essbase connections metadata. An item can also be added using the Add button. The checkboxes at the left of each item are used to indicate whether the service should be available to the user. |
|
string |
If specified, the value replaces the default "Essbase Server" editor caption. |
||
bool |
true |
Controls whether the Essbase Server editor is enabled. When set to False, the user is not allowed to edit the specified Essbase Server. The Essbase Server is optional. If not specified, the server(s) configured in the dodeca-essbase.properties file are used. |
|
bool |
true |
Controls whether the user is allowed to key in an Essbase server that does not appear in the configured list of servers. When set to True, the user is only allowed to select an item from the dropdown list. |
|
string |
If specified, the value replaces the default "Select an Essbase Server" string displayed in the editor when no value is selected. |
||
bool |
true |
Controls whether the Essbase Server editor is visible. When set to False, the editor is not displayed in the control. |
|
string |
If specified, the value replaces the default "Essbase Service" editor caption. |
||
bool |
true |
Controls whether the Essbase Service editor is enabled. When set to False, the user is not allowed to edit the specified Essbase Service. |
|
bool |
true |
Controls whether the user is allowed to key in an Essbase service that does not appear in the configured list of services. When set to True, the user is only allowed to select an item from the dropdown list. |
|
string |
If specified, the value replaces the default "Select an Essbase Service" string displayed in the editor when no value is selected. |
||
bool |
true |
Controls whether the Essbase Service editor is visible. When set to False, the editor is not displayed in the control. If not visible, the first Essbase service specified in the DodecaEssbaseServiceURLs setting is used. |