Skip navigation links

com.essbase.api.datasource
Interface IEssOlapServer

All Superinterfaces:

IEssAppComponent, IEssBaseObject, IEssExtendedObject, IEssProperties, IEssServer, IEssSubstitutionVariables

public interface IEssOlapServer

extends IEssServer, IEssExtendedObject, IEssProperties, IEssAppComponent, IEssSubstitutionVariables

The IEssOlapServer interface is the OLAP server. JAPI opens and shares a single connection with Essbase between all its interfaces for each JAPI session. JAPI uses counters to track the number of interfaces using the connection based on the IEssCube.openCubeView/ IEssDomain.openCubeView/IEssCube.openMemberSelection() calls and hence the number of close/disconnect calls should match the number of open calls for a proper closure of the connection.

Version:

1.0, 01/04/2004

Author:

Srini Ranga

Nested Class Summary

static interface

IEssOlapServer.IEssOlapConnectionInfo The IEssOlapConnectionInfo interface provides OLAP agent/server connection information.

Nested classes/interfaces inherited from interface com.essbase.api.domain.IEssServer

IEssServer.EEssServerType

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties

IEssProperties.EEssPropertyMode

Nested classes/interfaces inherited from interface com.essbase.api.domain.IEssAppComponent

IEssAppComponent.EEssAppComponentType

Field Summary

static int	ESS_UDF_FUNCTION_RUNTIME
static int	ESS_UDF_FUNCTION_SINGLECELL
static int	ESS_UDF_FUNCTION_TRIGGER_FUNC
static int	ESS_UDF_FUNCTION_VECTOR
static int	PROP_DESCRIPTION
static int	PROP_NAME
static int	s_countProperties
static IEssValueAny.EEssDataType[]	s_propDataTypes
static IEssProperties.EEssPropertyMode[]	s_propModes
static java.lang.String[]	s_propNames

Method Summary

void	changeOlapPassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword) Changes the password of a user at OLAP server.
void	clearActive() Clears the current active application and database for this instance of the IEssOLAPServer object.
void	connect() Opens a connection to the olap agent.
void	connect(boolean useEdsAtOlapSvrNode) Deprecated. This functionality has been deprecated.
void	connect(boolean useConnPool, boolean connPerOp) Deprecated. This functionality has been deprecated.
void	connect(boolean useConnPool, boolean connPerOp, boolean useCluster, java.lang.String connPoolOrClusterName) Deprecated. This functionality has been deprecated.
void	convertApplicationToUnicode(java.lang.String appName) Converts application to unicode.
void	copyOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String destAppName, java.lang.String destCubeName, java.lang.String destObjName) Copies an olap file object.
void	copyOlapFileObjectFromServer(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String clientFileName, boolean lock) Copies an object from the olap server to a client file and optionally locks the server object to prevent updates by others.
void	copyOlapFileObjectToServer(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String clientFileName, boolean unlock) Copies an object from a client file to the olap server, and optionally unlocks the server object to allow updates by others.
IEssOlapApplication	createApplication(java.lang.String appName) Creates a new application and starts it.
IEssOlapApplication	createApplication(java.lang.String appName, short storageType) Creates a new application with the given storage type and starts it.
IEssOlapApplication	createApplication(java.lang.String appName, short storageType, java.lang.String appType) Creates a new application and starts it.
IEssOlapApplication	createApplication(java.lang.String appName, java.lang.String appType) Creates a new application and starts it.
IEssOlapApplication	createApplication(java.lang.String appName, java.lang.String desc, int maxLroFileSize, boolean loadable, boolean autoLoad, boolean allowCommands, boolean allowConnects, boolean allowUpdates, boolean enableSecurity, int lockTimeOutPeriod, IEssCube.EEssCubeAccess minCubeAccess) Creates a new application setting all the specified properties and starts it.
void	createCDF(java.lang.String name, java.lang.String javaSpec, int options, java.lang.String spec, java.lang.String comment) Creates a custom defined function.
void	createCDM(java.lang.String name, java.lang.String definition, java.lang.String signature, java.lang.String spec, java.lang.String comment) Creates custom defined macro.
IEssOlapUser	createOlapExtUser(java.lang.String userName, java.lang.String password, java.lang.String protocol, java.lang.String connParam) Creates a new externally authenticated user.
IEssOlapUser	createOlapExtUserWithType(java.lang.String userName, java.lang.String password, java.lang.String protocol, java.lang.String connParam, short userType) Creates a externally authenticated user with specified application access type.
void	createOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) Creates a new olap file object.
IEssOlapGroup	createOlapGroup(java.lang.String groupName) Creates a new group.
IEssOlapUser	createOlapUser(java.lang.String userName, java.lang.String password) Creates a new user.
IEssOlapUser	createOlapUserWithType(java.lang.String userName, java.lang.String password, short userType) Creates a new user with specified application access type.
void	delete() Deletes this server from the domain if it exists.
void	deleteCDF(java.lang.String name) Deletes custom defined function.
void	deleteCDM(java.lang.String name) Deletes custom defined macro.
void	deleteLogFile() Deletes the agent log file (essbase.log).
void	deleteOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) Delete an existing olap file object.
void	disconnect() Closes the connection to the olap agent.
java.lang.String[]	getActive() Gets the names of the current active application and cube for this instance of the IEssOlapServer object.
IEssOlapApplication	getApplication(java.lang.String appName) Gets the specified application.
IEssIterator	getApplications() Gets the list of applications which are accessible to the caller.
java.lang.String[][]	getCDM_CDF() Gets custom defined functions and macros.
IEssIterator	getConnections() Gets the list of user connections to the olap agent/server.
java.lang.String	getDescription() Gets the olap server description.
java.lang.String	getLocale() Returns the locale of the OLAP server.
long	getLoginId() Returns the signed-in user's login ID for the particular session.
int	getLogSize(boolean agentLog, java.lang.String appName) Gets the size of the Agent log file (ESSBASE.LOG), or of the Server log file (APPNAME.LOG).
IEssCustomMessageHandler	getMessageHandler() Retrieves the custom message handler associated with the session.
java.lang.String	getName() Gets the olap server name/IP address.
IEssOlapFileObject	getOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) Gets information about a specified olap store file object.
IEssIterator	getOlapFileObjects(java.lang.String appName, java.lang.String cubeName, int objType) Gets all the olap store file objects of the types specified.
IEssOlapGroup	getOlapGroup(java.lang.String groupName) Gets olap group information for the given group.
IEssIterator	getOlapGroups(java.lang.String appName, java.lang.String cubeName) Lists all groups who have access to this Essbase, and given application or cube.
IEssOlapLicenseInfo	getOlapLicenseInfo(java.lang.String serverColumnPort) Get the License information structure.
short	getOlapSecurityMode() Displays the type of security in use: native or Shared Services mode.
java.lang.String	getOlapServerVersion() Gets the full version number of the connected Essbase olap server, in the form release.version.revision.
IEssOlapUser	getOlapUser(java.lang.String userName) Gets a user information structure, which contains security information for the user.
IEssIterator	getOlapUsers(java.lang.String appName, java.lang.String cubeName, java.lang.String protocol, boolean bExternalOnly) Lists all users who have access to a particular Essbase server, application or cube.
IEssIterator	getRequests(java.lang.String userName, java.lang.String appName, java.lang.String cubeName) Gets all the requests at the olap server for the matching userName, appName or cubeName.
java.lang.String	getStartCommand() Deprecated. This functionality has been deprecated.
boolean	isConnected() Checks if a connection is open to the olap agent.
boolean	isUnicodeEnabled() Checks if server is unicode enabled.
void	killLastRequest() Deprecated. Replaced with killOwnRequest()
void	killOwnRequest() Kills the last request to a server issued by a user from the same session if it is still running.
void	lockOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) Locks an object on the server to prevent other users from updating it.
IEssMaxlSession	openMaxlSession(java.lang.String MaxlSessionName) Opens a Maxl session with the Analytic server and returns a handle to the session.
void	refreshPropertyValues() Refreshes the property values.
void	renameOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String newObjName) Renames an existing olap file object.
void	reRegisterAllApplications() Re-establishes all Analytic Services applications as Shared Services applications.
void	resyncSSSecurity() Synchronizes the Essbase security definitions for all users, groups, and applications with the current state of Shared Services security.
void	setActive(java.lang.String appName, java.lang.String cubeName) Sets the active application and cube for this instance of the IEssOlapServer object.
void	setDescription(java.lang.String desc) Sets the olap server description.
void	setMessageHandler(IEssCustomMessageHandler handler) Associates the Custom message handler to the session.
void	setStartCommand(java.lang.String startCmd) Deprecated. This functionality has been deprecated.
void	setUnicodeEnabled(boolean enabled) Sets the server unicode enabled.
void	start() Deprecated. This functionality has been deprecated.
void	start(java.lang.String osUserName, java.lang.String osUserPassword, java.lang.String osDomainName) Deprecated. This functionality has been deprecated.
void	stop() Deprecated. This functionality has been deprecated.
void	syncGroups() Forces all groups' security information to be synchronized with the current group information in Shared Services.
void	syncUser(java.lang.String user) Forces a user's/group's security information to be synchronized with that user's/group's current information in Shared Services.
void	syncUsers() Forces all users' security information to be synchronized with the current user information in Shared Services.
void	syncUsersAndGroupsWithApp(IEssOlapApplication application) Synchronize the Essbase application's security definitions so that all users and groups in the application match with the current state of Shared Services security.
void	unlockOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) Unlocks a locked object on the server.
void	updatePropertyValues() Updates the property values.
void	writeToLogFile(boolean agentLog, java.lang.String message) Writes a message to the agent log file (essbase.log) or to the server log file (appname.log).

Methods inherited from interface com.essbase.api.domain.IEssServer

getServerType

Methods inherited from interface com.essbase.api.base.IEssExtendedObject

clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

Methods inherited from interface com.essbase.api.base.IEssProperties

getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny

Methods inherited from interface com.essbase.api.domain.IEssAppComponent

getAppComponentType

Methods inherited from interface com.essbase.api.datasource.IEssSubstitutionVariables

createSubstitutionVariable, deleteSubstitutionVariable, getSubstitutionVariables, getSubstitutionVariableValue

Field Detail

PROP_NAME

static final int PROP_NAME

See Also:

Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION

See Also:

Constant Field Values

s_countProperties

static final int s_countProperties

See Also:

Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

ESS_UDF_FUNCTION_VECTOR

static final int ESS_UDF_FUNCTION_VECTOR

See Also:

Constant Field Values

ESS_UDF_FUNCTION_SINGLECELL

static final int ESS_UDF_FUNCTION_SINGLECELL

See Also:

Constant Field Values

ESS_UDF_FUNCTION_TRIGGER_FUNC

static final int ESS_UDF_FUNCTION_TRIGGER_FUNC

See Also:

Constant Field Values

ESS_UDF_FUNCTION_RUNTIME

static final int ESS_UDF_FUNCTION_RUNTIME

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException

Gets the olap server name/IP address.

Specified by:

getName in interface IEssExtendedObject

Returns:

The olap server name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException

Gets the olap server description.

Returns:

The olap server description.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String desc)
                    throws com.essbase.api.base.EssException

Sets the olap server description. The change will become effective after you invoke updatePropertyValues().

Parameters:

desc - The olap server description.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getStartCommand

java.lang.String getStartCommand()
                                 throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Gets the command to start this olap server.

Returns:

The startup command.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setStartCommand

void setStartCommand(java.lang.String startCmd)
                     throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Sets the command to start this olap server. The change will become effective after you invoke updatePropertyValues().

Parameters:

startCmd - The startup command.

Throws:

com.essbase.api.base.EssException - if an error occurs.

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException

Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.

Specified by:

refreshPropertyValues in interface IEssProperties

Throws:

com.essbase.api.base.EssException - if an error occurs.

updatePropertyValues

void updatePropertyValues()
                          throws com.essbase.api.base.EssException

Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues().

Specified by:

updatePropertyValues in interface IEssProperties

Throws:

com.essbase.api.base.EssException - if an error occurs.

connect

void connect()
             throws com.essbase.api.base.EssException

Opens a connection to the olap agent. JAPI opens and shares a single connection with Essbase between all its interfaces for each JAPI session. JAPI uses counters to track the number of interfaces using the connection based on the IEssCube.openCubeView/IEssDomain.openCubeView/IEssCube.openMemberSelection() calls and hence the number of close/disconnect calls should match the number of open calls for a proper closure of the connection.

Throws:

com.essbase.api.base.EssException - if an error occurs.

connect

void connect(boolean useConnPool,
             boolean connPerOp)
             throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Opens a connection to the olap agent. This method allows you to use a connection pool if available and the rest of the connect methods don't use a connection pool.

Parameters:

useConnPool - true to use connection pool if available.

connPerOp - true for connection per operation. false for connection per session.

Throws:

com.essbase.api.base.EssException - if an error occurs.

connect

void connect(boolean useConnPool,
             boolean connPerOp,
             boolean useCluster,
             java.lang.String connPoolOrClusterName)
             throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Opens a connection to the olap agent. This method allows you to use a connection pool if available and the rest of the connect methods don't use a connection pool.

Parameters:

useConnPool - true to use connection pool if available.

connPerOp - true for connection per operation. false for connection per session.

useCluster - true to use cluster if available.

connPoolOrClusterName - connection pool or cluster name to use. If useConnPool is true, this parameter represents connection pool name. If useCluster is true, this parameter represents cluster name. If this parameter is null, a connection pool or a cluster will be chosen, if available, based on the values of other parameters. If it is not null then it should be a valid active connection pool or cluster name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

connect

void connect(boolean useEdsAtOlapSvrNode)
             throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Opens a connection to the olap agent.

Parameters:

useEdsAtOlapSvrNode - If true, the Provider server at the node where this olap server resides is used to traffic the requests between the JAPI client and the olap server. If false, the enterprise server that authenticated the user is used to traffic the requests.

Throws:

com.essbase.api.base.EssException - if an error occurs.

disconnect

void disconnect()
                throws com.essbase.api.base.EssException

Closes the connection to the olap agent. If connection pool is used to obtain the connection, the connection is returned back to the pool.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isConnected

boolean isConnected()
                    throws com.essbase.api.base.EssException

Checks if a connection is open to the olap agent.

Returns:

true if a connection if open.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getOlapServerVersion

java.lang.String getOlapServerVersion()
                                      throws com.essbase.api.base.EssException

Gets the full version number of the connected Essbase olap server, in the form release.version.revision.

Returns:

The version number.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getApplications

IEssIterator getApplications()
                             throws com.essbase.api.base.EssException

Gets the list of applications which are accessible to the caller.

Returns:

The applications (each of type IEssOlapApplication).

Throws:

com.essbase.api.base.EssException - if an error occurs.

getApplication

IEssOlapApplication getApplication(java.lang.String appName)
                                   throws com.essbase.api.base.EssException

Gets the specified application.

Parameters:

appName - The application name.

Returns:

The application.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getOlapUser

IEssOlapUser getOlapUser(java.lang.String userName)
                         throws com.essbase.api.base.EssException

Gets a user information structure, which contains security information for the user.

Parameters:

userName -

Returns:

IEssOlapUser The OLAP user

Throws:

com.essbase.api.base.EssException

getOlapUsers

IEssIterator getOlapUsers(java.lang.String appName,
                          java.lang.String cubeName,
                          java.lang.String protocol,
                          boolean bExternalOnly)
                          throws com.essbase.api.base.EssException

Lists all users who have access to a particular Essbase server, application or cube.

Parameters:

appName - - Application name. If null, lists all users.

cubeName - - cube name. If null, lists users for all cubes within application.

protocol - - The name of the external authentication mechanism. This can be null if bExternalOnly is false. - Values are CSS/Client Authentication

bExternalOnly - - true - returns list of external users; false - returns all users

Returns:

IEssIterator - Iterator of EssUSERINFO objects.

Throws:

com.essbase.api.base.EssException

getOlapGroup

IEssOlapGroup getOlapGroup(java.lang.String groupName)
                           throws com.essbase.api.base.EssException

Gets olap group information for the given group.

Parameters:

groupName -

Returns:

IEssOlapGroup The OLAP user

Throws:

com.essbase.api.base.EssException

getOlapGroups

IEssIterator getOlapGroups(java.lang.String appName,
                           java.lang.String cubeName)
                           throws com.essbase.api.base.EssException

Lists all groups who have access to this Essbase, and given application or cube.

Parameters:

appName - - Application name. If null, lists all groups.

cubeName - - cube name. If null, lists groups for all cubes within application.

Returns:

IEssIterator of the groups

Throws:

com.essbase.api.base.EssException

getOlapLicenseInfo

IEssOlapLicenseInfo getOlapLicenseInfo(java.lang.String serverColumnPort)
                                       throws com.essbase.api.base.EssException

Get the License information structure.

Parameters:

serverColumnPort -

Returns:

the License information obejct

Throws:

com.essbase.api.base.EssException

getOlapSecurityMode

short getOlapSecurityMode()
                          throws com.essbase.api.base.EssException

Displays the type of security in use: native or Shared Services mode.

Returns:

short - the security mode ESS_NATIVE_SECURITY 1 ESS_CAS_SECURITY 2 ESS_SS_SECURITY 2

Throws:

com.essbase.api.base.EssException

createOlapUser

IEssOlapUser createOlapUser(java.lang.String userName,
                            java.lang.String password)
                            throws com.essbase.api.base.EssException

Creates a new user. The specified user must not already exist. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

userName - - Name of user to create. User names can be 30 characters long.

password - - Security password for new user. Passwords can be up to 100 characters long.

Returns:

IEssOlapUser

Throws:

com.essbase.api.base.EssException

createOlapExtUser

IEssOlapUser createOlapExtUser(java.lang.String userName,
                               java.lang.String password,
                               java.lang.String protocol,
                               java.lang.String connParam)
                               throws com.essbase.api.base.EssException

Creates a new externally authenticated user. The specified user must already exist in specified external authentication provider. The parameter password is ignored. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

userName - - Name of user to create. User names can be 30 characters long.

password - - Security password for new user. Passwords can be up to 100 characters long.

protocol - - The name of the external authentication mechanism.

connParam - - Parameters used by the external authentication mechanism, if any.

Returns:

IEssOlapUser

Throws:

com.essbase.api.base.EssException

createOlapUserWithType

IEssOlapUser createOlapUserWithType(java.lang.String userName,
                                    java.lang.String password,
                                    short userType)
                                    throws com.essbase.api.base.EssException

Creates a new user with specified application access type. The specified user must not already exist. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

userName - - Name of user to create. User names can be 30 characters long.

password - - Security password for new user. Passwords can be up to 100 characters long.

userType - - Application access type for a user. Possible values 0 - for ESS_USER_NONE which means this user will be enabled without any functionality. or 1 - for ESS_USER_ESSBASE which means this user will be enabled with all functionality.

Returns:

IEssOlapUser

Throws:

com.essbase.api.base.EssException

createOlapExtUserWithType

IEssOlapUser createOlapExtUserWithType(java.lang.String userName,
                                       java.lang.String password,
                                       java.lang.String protocol,
                                       java.lang.String connParam,
                                       short userType)
                                       throws com.essbase.api.base.EssException

Creates a externally authenticated user with specified application access type. The specified user must already exist in the specified external authentication mechanism. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

userName - - Name of user to create. User names can be 30 characters long.

password - - Security password for new user. Passwords can be up to 100 characters long.

protocol - - Name of the external authentication mechanism

connParam - - Parameters used by external authentication mechanism, if any..

userType - - Application access type for a user. Possible values 0 - for ESS_USER_NONE which means this user will be enabled without any functionality. or 1 - for ESS_USER_ESSBASE which means this user will be enabled with all functionality.

Returns:

IEssOlapUser

Throws:

com.essbase.api.base.EssException

createApplication

IEssOlapApplication createApplication(java.lang.String appName)
                                      throws com.essbase.api.base.EssException

Creates a new application and starts it.

Parameters:

appName - The application name.

Returns:

IEssApplication The new application.

Throws:

com.essbase.api.base.EssException - if an error occurs.

createApplication

IEssOlapApplication createApplication(java.lang.String appName,
                                      java.lang.String appType)
                                      throws com.essbase.api.base.EssException

Creates a new application and starts it.

Parameters:

appName - The application name.

appType - The application type ("native" or "utf8").

Returns:

IEssApplication The new application.

Throws:

com.essbase.api.base.EssException - if an error occurs.

createApplication

IEssOlapApplication createApplication(java.lang.String appName,
                                      java.lang.String desc,
                                      int maxLroFileSize,
                                      boolean loadable,
                                      boolean autoLoad,
                                      boolean allowCommands,
                                      boolean allowConnects,
                                      boolean allowUpdates,
                                      boolean enableSecurity,
                                      int lockTimeOutPeriod,
                                      IEssCube.EEssCubeAccess minCubeAccess)
                                      throws com.essbase.api.base.EssException

Creates a new application setting all the specified properties and starts it.

Parameters:

appName - The application name.

desc - the description for this new application.

maxLroFileSize - the maximum file size (in bytes) for Linked Reporting Objects (LRO) attachments. Pass 0 for unlimited file size. There is no default. There is no minimum or maximum value, excepting limitations imposed by your system resources.

loadable - if set to false, prevents all users from loading (starting) the application. Loadable is enabled by default. If set to true</true>, allows users to load (start) the application. This only applies to users who have at least read privilege for the application.

autoLoad - can be set to true if you want the application to load automatically when Analytic Server starts. By default, auto load is disabled.

allowCommands - if set to false, prevents all requests to databases in the application, including non-data-specific requests, such as viewing database information or changing database settings. All users are affected, including other administrators. Administrators are affected by this setting as a safety mechanism to prevent accidental updates to databases during maintenance operations. This setting remains in effect only for the duration of your session. The setting takes effect immediately, and affects users who are currently logged in, as well as users who log in later during your session. [Caution: If performing maintenance operations that require disabling commands, you must make those maintenance operations within the same session]. By default, commands are enabled.

allowConnects - if set to false, prevents any user with a permission lower than Application Managers from making connections to the databases that require the databases to be started. Database connections remain disabled for all databases in the application, until the application setting is re-enabled by setting this to true. By default, connections are enabled.

allowUpdates - if set to false, prevents all users (except Administrators) from making requests to databases in the application. Use before performing update and maintenance operations. The disable updates setting remains in effect only for the duration of your session. [Caution: If performing maintenance operations that require updates to be disabled, you must make those maintenance operations within the same session]. This restriction does not include outline operations. To block metadata updates, set the database to read-only mode, or disable commands and/or connects. By default, updates are enabled.

enableSecurity - when security is disabled, OLAP server ignores all security settings in the application and treats all users as Application Managers. By default, security is enabled.

lockTimeOutPeriod - the time out period (in minutes). This is the the maximum time interval that locks on data blocks can be held by users. When a client data-block lock is held for more than the time out interval, OLAP server removes the lock and the transaction is rolled back. The default interval is 60 minutes. This setting affects all databases in the application.

minCubeAccess - the minimum cube access. This is to grant all users a minimum level of permission to all databases in the application. Users with higher permissions than this specified minimum are not affected.

Returns:

IEssApplication The new application.

Throws:

com.essbase.api.base.EssException - if an error occurs.

createApplication

IEssOlapApplication createApplication(java.lang.String appName,
                                      short storageType)
                                      throws com.essbase.api.base.EssException

Creates a new application with the given storage type and starts it.

Parameters:

appName - The application name.

storageType - The application storagetype - Only valid value in this version is 4 which creates an ASO (Aggregate Storage Option) type application.

Returns:

IEssApplication The new application.

Throws:

com.essbase.api.base.EssException - if an error occurs.

createApplication

IEssOlapApplication createApplication(java.lang.String appName,
                                      short storageType,
                                      java.lang.String appType)
                                      throws com.essbase.api.base.EssException

Creates a new application and starts it.

Parameters:

appName - The application name.

storageType - The application storagetype - Only valid value in this version is 4 which creates an ASO (Aggregate Storage Option) type application.

appType - The application type ("native" or "utf8").

Returns:

IEssApplication The new application.

Throws:

com.essbase.api.base.EssException - if an error occurs.

convertApplicationToUnicode

void convertApplicationToUnicode(java.lang.String appName)
                                 throws com.essbase.api.base.EssException

Converts application to unicode.

Note: If the application is already retrieved before using this API, user has to call getApplication(String) again to get the updated, valid application handle.

Parameters:

appName - The application name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setUnicodeEnabled

void setUnicodeEnabled(boolean enabled)
                       throws com.essbase.api.base.EssException

Sets the server unicode enabled.

Parameters:

enabled - true to unicode enable the server.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isUnicodeEnabled

boolean isUnicodeEnabled()
                         throws com.essbase.api.base.EssException

Checks if server is unicode enabled.

Returns:

true if server is unicode enabled.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getConnections

IEssIterator getConnections()
                            throws com.essbase.api.base.EssException

Gets the list of user connections to the olap agent/server.

Returns:

The user connections (each of type IEssOlapConnectionInfo).

Throws:

com.essbase.api.base.EssException - if an error occurs.

getActive

java.lang.String[] getActive()
                             throws com.essbase.api.base.EssException

Gets the names of the current active application and cube for this instance of the IEssOlapServer object.

Returns:

The app/cube name pair (String[0] - appName, String[1] - cubeName). null if no active application/cube.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setActive

void setActive(java.lang.String appName,
               java.lang.String cubeName)
               throws com.essbase.api.base.EssException

Sets the active application and cube for this instance of the IEssOlapServer object.

Parameters:

appName - The application name.

cubeName - The cube name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

clearActive

void clearActive()
                 throws com.essbase.api.base.EssException

Clears the current active application and database for this instance of the IEssOLAPServer object.

Throws:

com.essbase.api.base.EssException - if an error occurs.

start

void start()
           throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Starts the OLAP agent if it is not already running.

Throws:

com.essbase.api.base.EssException - if an error occurs.

start

void start(java.lang.String osUserName,
           java.lang.String osUserPassword,
           java.lang.String osDomainName)
           throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Starts the OLAP agent if it is not already running.

Parameters:

osUserName - The OS user name on the destination host.

osUserPassword - The OS user password.

osDomainName - The OS domain name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

stop

void stop()
          throws com.essbase.api.base.EssException

Deprecated. This functionality has been deprecated.

Stops the Essbase OLAP Agent. This function sends a request to the Essbase Agent (ESSBASE.EXE) to shut itself down. The Agent then goes through its normal shutdown procedure, including committing data, stopping all applications and databases, and logging users off before stopping. Only users with Supervisor privilege can shut down the Agent. This function can be called at any time, however, it is normally called to shut down an Agent process which was started in the background.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getLogSize

int getLogSize(boolean agentLog,
               java.lang.String appName)
               throws com.essbase.api.base.EssException

Gets the size of the Agent log file (ESSBASE.LOG), or of the Server log file (APPNAME.LOG).

Parameters:

agentLog - If true, the size of the Agent log file (ESSBASE.LOG) is returned. If false, the size of the Server log file (APPNAME.LOG) is returned.

appName - The application name.

Returns:

The size of the log file.

Throws:

com.essbase.api.base.EssException - if an error occurs.

writeToLogFile

void writeToLogFile(boolean agentLog,
                    java.lang.String message)
                    throws com.essbase.api.base.EssException

Writes a message to the agent log file (essbase.log) or to the server log file (appname.log).

Parameters:

agentLog - If true, message is written to the agent log file, essbase.log. If false, message is written to the server log file, appname.log. If false, make sure that an application is active by invoking setActive(), before invoking this method.

message - The message to be logged to the agent log file (essbase.log), or to the server log file (appname.log).

Throws:

com.essbase.api.base.EssException - if an error occurs.

deleteLogFile

void deleteLogFile()
                   throws com.essbase.api.base.EssException

Deletes the agent log file (essbase.log).

Throws:

com.essbase.api.base.EssException - if an error occurs.

getRequests

IEssIterator getRequests(java.lang.String userName,
                         java.lang.String appName,
                         java.lang.String cubeName)
                         throws com.essbase.api.base.EssException

Gets all the requests at the olap server for the matching userName, appName or cubeName. If any of these parameters is null, it is not used for filtering.

Parameters:

userName - The user name filter. If null, all users are considered.

appName - The application name filter. If null, all applications are considered.

cubeName - The cube name filter. If null, all cubes are considered.

Returns:

The requests (each of type IEssOlapRequest).

Throws:

com.essbase.api.base.EssException - if an error occurs.

getOlapFileObjects

IEssIterator getOlapFileObjects(java.lang.String appName,
                                java.lang.String cubeName,
                                int objType)
                                throws com.essbase.api.base.EssException

Gets all the olap store file objects of the types specified. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object types. Values from IEssOlapFileObject.TYPE_*.

Returns:

The OLAP store file objects (each of type IEssOlapFileObject).

Throws:

com.essbase.api.base.EssException - if an error occurs.

getOlapFileObject

IEssOlapFileObject getOlapFileObject(java.lang.String appName,
                                     java.lang.String cubeName,
                                     int objType,
                                     java.lang.String objName)
                                     throws com.essbase.api.base.EssException

Gets information about a specified olap store file object. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

Returns:

The olap file object information.

Throws:

com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObjectFromServer

void copyOlapFileObjectFromServer(java.lang.String appName,
                                  java.lang.String cubeName,
                                  int objType,
                                  java.lang.String objName,
                                  java.lang.String clientFileName,
                                  boolean lock)
                                  throws com.essbase.api.base.EssException

Copies an object from the olap server to a client file and optionally locks the server object to prevent updates by others. Example:

copyOlapFileObjectFromServer("Sample", "Basic", IEssOlapFileObject.TYPE_TEXT, "Act1", "C:/temp/act1.txt", false);

This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

clientFileName - The full path of destination file in the client.

lock - Flag to control object locking. If true, the server object is locked to prevent updates by other users.

Throws:

com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObjectToServer

void copyOlapFileObjectToServer(java.lang.String appName,
                                java.lang.String cubeName,
                                int objType,
                                java.lang.String objName,
                                java.lang.String clientFileName,
                                boolean unlock)
                                throws com.essbase.api.base.EssException

Copies an object from a client file to the olap server, and optionally unlocks the server object to allow updates by others. Example:

copyOlapFileObjectToServer("Sample", "Basic", IEssOlapFileObject.TYPE_TEXT, "Test", "C:/temp/test.txt", false);

This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

clientFileName - The full path of source file in the client.

unlock - Flag to control object locking. If true, the server object is unlocked to allow updates by other users.

Throws:

com.essbase.api.base.EssException - if an error occurs.

lockOlapFileObject

void lockOlapFileObject(java.lang.String appName,
                        java.lang.String cubeName,
                        int objType,
                        java.lang.String objName)
                        throws com.essbase.api.base.EssException

Locks an object on the server to prevent other users from updating it. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

unlockOlapFileObject

void unlockOlapFileObject(java.lang.String appName,
                          java.lang.String cubeName,
                          int objType,
                          java.lang.String objName)
                          throws com.essbase.api.base.EssException

Unlocks a locked object on the server. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

createOlapFileObject

void createOlapFileObject(java.lang.String appName,
                          java.lang.String cubeName,
                          int objType,
                          java.lang.String objName)
                          throws com.essbase.api.base.EssException

Creates a new olap file object. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

deleteOlapFileObject

void deleteOlapFileObject(java.lang.String appName,
                          java.lang.String cubeName,
                          int objType,
                          java.lang.String objName)
                          throws com.essbase.api.base.EssException

Delete an existing olap file object. Outline Objects can not be deleted. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

renameOlapFileObject

void renameOlapFileObject(java.lang.String appName,
                          java.lang.String cubeName,
                          int objType,
                          java.lang.String objName,
                          java.lang.String newObjName)
                          throws com.essbase.api.base.EssException

Renames an existing olap file object. Outline and LRO Objects cannot be renamed. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObject

void copyOlapFileObject(java.lang.String appName,
                        java.lang.String cubeName,
                        int objType,
                        java.lang.String objName,
                        java.lang.String destAppName,
                        java.lang.String destCubeName,
                        java.lang.String destObjName)
                        throws com.essbase.api.base.EssException

Copies an olap file object. Outline Object can not be copied. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL

Parameters:

appName - The application name.

cubeName - The cube name. null to use the application directory.

objType - The object type. Value from IEssOlapFileObject.TYPE_*.

objName - The object name.

destAppName - The destination application name.

destCubeName - The destination cube name.

destObjName - The destination object name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

killLastRequest

void killLastRequest()
                     throws com.essbase.api.base.EssException

Deprecated. Replaced with killOwnRequest()

Kills the last request if it is still running.

Throws:

com.essbase.api.base.EssException - if an error occurs.

killOwnRequest

void killOwnRequest()
                    throws com.essbase.api.base.EssException

Kills the last request to a server issued by a user from the same session if it is still running.

Throws:

com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException

Deletes this server from the domain if it exists. Otherwise this API throws an exception.

Specified by:

delete in interface IEssServer

Throws:

com.essbase.api.base.EssException - if an error occurs.

changeOlapPassword

void changeOlapPassword(java.lang.String userName,
                        java.lang.String oldPassword,
                        java.lang.String newPassword)
                        throws com.essbase.api.base.EssException

Changes the password of a user at OLAP server. The user does not have to be logged on to the OLAP server while calling this API.

Parameters:

userName - The userName whose password has to change.

oldPassword - The old password of the user.

newPassword - The new password to be set.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getLoginId

long getLoginId()
                throws com.essbase.api.base.EssException

Returns the signed-in user's login ID for the particular session.

Returns:

loginid - the loginid from the user's session

Throws:

com.essbase.api.base.EssException

getLocale

java.lang.String getLocale()
                           throws com.essbase.api.base.EssException

Returns the locale of the OLAP server.

Returns:

locale - locale of the OLAP server.

Throws:

com.essbase.api.base.EssException

syncUser

void syncUser(java.lang.String user)
              throws com.essbase.api.base.EssException

Forces a user's/group's security information to be synchronized with that user's/group's current information in Shared Services. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator, Application Manager, or Database Manager.

Parameters:

user - - String, the user/group name to be synchronized.

Throws:

com.essbase.api.base.EssException

syncUsers

void syncUsers()
               throws com.essbase.api.base.EssException

Forces all users' security information to be synchronized with the current user information in Shared Services. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator, Application Manager, or Database Manager.

Throws:

com.essbase.api.base.EssException

syncGroups

void syncGroups()
                throws com.essbase.api.base.EssException

Forces all groups' security information to be synchronized with the current group information in Shared Services. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator, Application Manager, or Database Manager.

Throws:

com.essbase.api.base.EssException

syncUsersAndGroupsWithApp

void syncUsersAndGroupsWithApp(IEssOlapApplication application)
                               throws com.essbase.api.base.EssException

Synchronize the Essbase application's security definitions so that all users and groups in the application match with the current state of Shared Services security. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator, Application Manager, or Database Manager.

Parameters:

application - - IEssOlapApplication, the application to sync with

Throws:

com.essbase.api.base.EssException

resyncSSSecurity

void resyncSSSecurity()
                      throws com.essbase.api.base.EssException

Synchronizes the Essbase security definitions for all users, groups, and applications with the current state of Shared Services security. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator.

Throws:

com.essbase.api.base.EssException

createOlapGroup

IEssOlapGroup createOlapGroup(java.lang.String groupName)
                              throws com.essbase.api.base.EssException

Creates a new group.

The specified group must not already exist. his method requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Parameters:

groupName - name of the group to be created

Returns:

IEssOlapGroup

Throws:

com.essbase.api.base.EssException - if an error occurs.

Since:

11.1.1

createCDF

void createCDF(java.lang.String name,
               java.lang.String javaSpec,
               int options,
               java.lang.String spec,
               java.lang.String comment)
               throws com.essbase.api.base.EssException

Creates a custom defined function.

Parameters:

name - Function name

javaSpec - Java Specification

options - An option must be one of possible values of IEssOlapServer.ESS_UDF_FUNCTION_*

spec - Function specification

comment - Description for this function.

Throws:

if - an error occurs.

com.essbase.api.base.EssException

deleteCDF

void deleteCDF(java.lang.String name)
               throws com.essbase.api.base.EssException

Deletes custom defined function.

Parameters:

name - Function that has to be deleted.

Throws:

if - an error occurs.

com.essbase.api.base.EssException

createCDM

void createCDM(java.lang.String name,
               java.lang.String definition,
               java.lang.String signature,
               java.lang.String spec,
               java.lang.String comment)
               throws com.essbase.api.base.EssException

Creates custom defined macro.

Parameters:

name - Macro name

definition - Macro definition

signature - Signature for this macro.

spec - Specification for this macro.

comment - Description for this macro.

Throws:

if - an error occurs.

com.essbase.api.base.EssException

deleteCDM

void deleteCDM(java.lang.String name)
               throws com.essbase.api.base.EssException

Deletes custom defined macro.

Parameters:

name - Macro that has to be deleted.

Throws:

if - an error occurs.

com.essbase.api.base.EssException

getCDM_CDF

java.lang.String[][] getCDM_CDF()
                                throws com.essbase.api.base.EssException

Gets custom defined functions and macros.

The result will consist of 'n' x 5 elements where 'n' represents the total number of custom functions and custom macros. For any 'x' value ranging from 0 to n-1,
Result [x][0] represents the Name
Result [x][1] represents the Specification
Result [x][2] represents the Comment
Result [x][3] represents the Type either a value "cdf" or "cdm"
Result [x][4] represents the Scope which is will be "global"

Returns:

list of CDF and CDMs.

Throws:

if - an error occurs.

com.essbase.api.base.EssException

setMessageHandler

void setMessageHandler(IEssCustomMessageHandler handler)
                       throws com.essbase.api.base.EssException

Associates the Custom message handler to the session. The API includes a mechanism for intercepting error messages and other messages generated at the server and for displaying the appropriate messages automatically on the client program's screen. This mechanism, although generally useful, can be turned on if desired. The API allows your program to prevent those messages from appearing and to trap them for processing within your program. You can choose which messages to display and then display the chosen messages in a way that is consistent with the client program's internal message and error handling. This mechanism provides seamless integration of Essbase with your program. Client programs using this API should always use the getMessageHandler() API to retrieve the latest state of the handler.

Parameters:

handler -

Throws:

com.essbase.api.base.EssException

getMessageHandler

IEssCustomMessageHandler getMessageHandler()
                                           throws com.essbase.api.base.EssException

Retrieves the custom message handler associated with the session. Client programs should always use the instance returned by this API to access the latest state of the Custom message handler.

Returns:

IEssCustomMessageHandler or null if one was not associated

Throws:

com.essbase.api.base.EssException

See Also:

setMessageHandler(IEssCustomMessageHandler)

reRegisterAllApplications

void reRegisterAllApplications()
                               throws com.essbase.api.base.EssException

Re-establishes all Analytic Services applications as Shared Services applications. This function requires the caller to be an Administrator, Application Manager, or Database Manager. For any applications for which the caller does not have sufficient permissions, the re-registration will be skipped with a warning. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error.

Throws:

com.essbase.api.base.EssException - if an error occurs.

openMaxlSession

IEssMaxlSession openMaxlSession(java.lang.String MaxlSessionName)
                                throws com.essbase.api.base.EssException

Opens a Maxl session with the Analytic server and returns a handle to the session. Maxl statements can be executed using the returned handle. Client applicaions should IEssMaxlSession.close() the session after usage is complete. The session instance can be used to execute multiple Maxl statements sequencially using the same handle.

Parameters:

MaxlSessionName - - a name to the session.

Returns:

IEssMaxlSession - a handle to the session opened.

Throws:

com.essbase.api.base.EssException

Since:

11.1.2

Skip navigation links