This Application State Structure gets and sets the state parameters for a specific application. All fields in this structure can be modified using the API, with the exception that some fields do not apply to aggregate storage databases. See also the ESS_APPINFO_T structure, which contains additional application information that cannot be modified. The fields are:
typedef struct ESS_APPSTATE_T { ESS_DESC_T Description; ESS_BOOL_T Loadable; ESS_BOOL_T Autoload; ESS_ACCESS_T Access; ESS_BOOL_T Connects; ESS_BOOL_T Commands; ESS_BOOL_T Updates; ESS_BOOL_T Security; ESS_ULONG_T LockTimeout; ESS_ULONG_T lroSizeLimit; } ESS_APPSTATE_T, *ESS_PAPPSTATE_T, **ESS_PPAPPSTATE_T;
Data Type | Field | Description |
---|---|---|
ESS_DESC_T | Description | The application description (up to 80 characters) |
ESS_BOOL_T | Loadable | Flag to indicate whether application can be loaded (ESS_TRUE : application is loadable) |
ESS_BOOL_T | Autoload | Flag to indicate whether the application is loaded automatically when Essbase is started (ESS_TRUE if the application will be automatically loaded) |
ESS_ACCESS_T | Access | The default access to databases in the application (the lowest possible level of access for all users). This field can contain the following values:
|
ESS_BOOL_T | Connects | Flag to indicate whether users can connect to the application (ESS_TRUE if users can connect). |
ESS_BOOL_T | Commands | Flag to indicate whether users can issue commands to the application (ESS_TRUE if the application is accepting user commands). |
ESS_BOOL_T | Updates | Flag to indicate whether users can update data in the application (ESS_TRUE if the application is accepting user update commands). |
ESS_BOOL_T | Security | Flag to indicate whether application security is enabled (ESS_TRUE if security is enabled). |
ESS_ULONG_T | LockTimeout | Timeout period (in seconds) after which block-level locks are automatically removed. This field does not apply to aggregate storage databases. |
ESS_ULONG_T | 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. |