Maintaining Applications and Databases

Apart from maintaining database outlines, there are some other administrative functions that can be performed with the API.

To get information about an application, use EsxGetApplicationInfo(). To get modifiable application state parameters, call EsxGetApplicationState() (a corresponding Set function also exists to update these parameters). Similar administrative functions exist for databases.

When using any of the application or database Set functions, call the corresponding Get function first to initialize the structure fields.

To get an application log file, call EsxGetLogFile().

To get a selection of database run-time statistics, call EsxGetDatabaseStats(). To get or set a database note (a text string that can be viewed from the default login dialog box), use EsxGetDatabaseNote() and EsxSetDatabaseNote().

To export part or all of a database into a text file format that can be reloaded into databases, use EsxExport().

To move Essbase file objects (outlines, calc scripts, rules files, and so on) between applications or databases, use EsxCopyObject(). To move objects between the client and server for editing, use EsxGetObject() and EsxPutObject().

To create an object, call EsxCreateObject(). To rename an object, call EsxRenameObject(). To delete an object, call EsxDeleteObject(). To list all objects of a particular type within an application or database, call EsxListObjects().

For detailed descriptions of using the administration functions for database and application, see C Main API Database Functions, C Main API Application Functions, VB Main API Database Functions, and VB Main API Application Functions.

See API Libraries.