Initialization and Login Functions

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.

FunctionDescription
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 Essbase API client module.
EssGetVersion()Gets the full version number of the connected Essbase server.
EssInit()Initializes the Essbase API and message database.
EssLogin()Logs a user in to the Essbase server.
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 Agent log file (ESSBASE.LOG), or of the Server log file (APPNAME.LOG).
EssShutdownServer() Allows a Supervisor to remotely stop the Essbase Agent.
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 Agent log file (ESSBASE.LOG), or to the Server log file (APPNAME.LOG).