Defines application settings.
Syntax
SETAPPSTATE ["appName"] "desc" Y/N Y/N accessLevel Y/N Y/N Y/N Y/N lockTimeout MaxLROFileSize;
| Parameter | Description |
|---|---|
appName | Name of the application. Do not include appName if the active application is selected. |
desc | Text string describing the application. |
Y/N | Sets whether the application is loadable. |
Y/N | Sets whether autoload occurs. |
accessLevel | Default access level. Values: 0 - None. 1 - Read. 2 - Write. 3 - Calculate. 4 - Application Manager or Database Manager |
Y/N | Sets whether connections can be made. |
Y/N | Sets whether commands can be issued. |
Y/N | Sets whether updates can occur. |
Y/N | Sets whether security is enabled. |
lockTimeout | Maximum number of seconds that locks can be placed on blocks by Spreadsheet Add-in users. |
MaxLROFileSize | Maximum size, in kilobytes, for a Linked Reporting Objects (LRO) file. |
Notes
Using the semicolon statement terminator (;) is optional in ESSCMD batch files. However, it is good practice to use the terminator with this command to signal the end of the parameter list. This is especially important if you omit some of the parameters and take their default values. If not all parameters are present, and the ; is omitted, ESSCMD looks for the remaining values in the next statement in the batch file, leading to unpredictable results.
As with many other ESSCMD commands, if you issue only the SETAPPSTATE keyword in interactive mode, ESSCMD prompts you for the other values.
Example
SETAPPSTATE "sample" "The application is ready"
"Y" "Y" 0 "Y" "Y" "Y" "Y" "3600";