These functions initialize the API, and log in and out of the Essbase Server. They also obtain version information, and enable an application to create and delete local contexts.
| Function | Description |
|---|---|
| EssAutoLogin | Displays a dialog box which allows the user to log in to an Essbase Server, and optionally selects an active application and database. |
| EssCreateLocalContext | Creates a local API context for use in local API operations. |
| EssDeleteLocalContext | Releases a local context previously created by EssCreateLocalContext(). |
| EssGetAPIVersion | Gets the full version number of the connected API client module. |
| EssGetVersion | Gets the full version number of the connected Essbase Server. |
| EssInit | Initializes the API and message database. |
| EssLogin | Logs a user in to the Essbase Server. |
| EssLoginAs | Logs in to the Essbase Server as another user. |
| EssLoginEx | Logs in to the Essbase Server using an authentication token. |
| EssLoginExAs | Logs in to the Essbase Server as another user, using an authentication token. |
| EssLoginSetPassword | Logs in a user, and changes the password. |
| EssLogout | Logs a user out from an Essbase Server. |
| EssLogoutUser | Allows a Supervisor or Application Designer to disconnect another user from an Essbase Server. |
| EssLogSize | Returns the size of the Essbase Server log file (essbase.log), or of the application log file (appname.log). |
| EssShutdownServer | Allows a Supervisor to remotely stop the Essbase Server. |
| EssTerm | Terminates the API and releases all system resources used by the API. |
| EssValidateHCtx | Validates a specific API context handle (hCtx). |
| EssWriteToLogFile | Writes a message to the Essbase Server log file (essbase.log), or to the application log file (appname.log). |