This Application State Structure gets and sets the state parameters for a specific Application. All fields in this structure can be modified using the VB API, with the exception that some fields do not apply to aggregate storage databases. See also the ESB_APPINFO_T structure, which contains additional Application information that cannot be modified. The fields are:
Type ESB_APPSTATE_T Description As String * ESB_DESCLEN Loadable As Integer Autoload As Integer Access As Integer Connects As Integer Commands As Integer Updates As Integer LockTimeout As Long lroSizeLimit As Long Security As Integer End Type
VB Data Type | Field | Description |
---|---|---|
As String * ESB_DESCLEN | Description | Application description (up to 80 characters) |
As String * 1 | Loadable | Flag to indicate whether the application can be loaded (ESB_TRUE if the application is loadable). |
As String * 1 | Autoload | Flag to indicate whether the application is loaded automatically when Essbase Server is started (ESB_TRUE if the application will be automatically loaded). |
As Integer | Access | Default access to databases in the application (lowest possible level of access for all users). Values:
|
As String * 1 | Connects | Flag to indicate whether users can connect to the application (ESB_TRUE if users can connect). |
As String * 1 | Commands | Flag to indicate whether users can issue commands to the application (ESB_TRUE if the application is accepting user commands). |
As String * 1 | Updates | Flag to indicate whether users can update data in the application (ESB_TRUE if the application is accepting user update commands). |
As Long | LockTimeout | Time-out period (in seconds) after which block-level locks are automatically removed. This field does not apply to aggregate storage databases. |
As Long | lroSizeLimit | Limit on the size of LRO files. This limit is set for each application and enables the administrator or program to protect the server from overly large linked files. Essbase itself does not limit the size or have a default value. This limit does not apply to LRO URLs (limited to 512 characters) or to LRO cell notes (limited to 599 characters). This field does not apply to aggregate storage databases. |
As String * 1 | Security | Flag to indicate whether application security is enabled (ESB_TRUE if security is enabled). |