Skip navigation links


com.essbase.api.datasource
Interface IEssOlapApplication

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties, IEssSubstitutionVariables

public interface IEssOlapApplication
extends IEssExtendedObject, IEssProperties, IEssSubstitutionVariables

The IEssOlapApplication is olap application.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Nested Class Summary
static class IEssOlapApplication.EEssDataStorageType
          The EEssCubeType class.
static class IEssOlapApplication.EEssLoadStatus
          The EEssLoadStatus class is an enumeration of Application load status.
static class IEssOlapApplication.EEssOlapApplicationAccess
          The EEssOlapApplicationAccess is an enumeration of olap application access levels.

 

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

 

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_COUNT_OF_CUBES
           
static int PROP_COUNT_OF_USERS_CONNECTED
           
static int PROP_DATA_STORAGE_TYPE
           
static int PROP_DESCRIPTION
           
static int PROP_ELAPSED_TIME
           
static int PROP_IS_ALLOW_COMMANDS
           
static int PROP_IS_ALLOW_CONNECTS
           
static int PROP_IS_ALLOW_UPDATES
           
static int PROP_IS_AUTO_LOAD
           
static int PROP_IS_ENABLE_SECURITY
           
static int PROP_IS_LOADABLE
           
static int PROP_LOAD_STATUS
           
static int PROP_LOCALE
           
static int PROP_LOCK_TIMEOUT
           
static int PROP_MAXIMUM_SIZE_OF_ATTACHMENT_FILE
           
static int PROP_MINIMUM_CUBE_ACCESS
           
static int PROP_NAME
           
static int PROP_SERVER_NAME
           
static int PROP_TYPE
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           

 

Method Summary
 IEssOlapApplication copy(java.lang.String newAppName)
          Copies this application to a new application, including all associated cubes and objects and also starts the new application.
 void createCDF(java.lang.String name, java.lang.String javaSpec, int options, java.lang.String spec, java.lang.String comment)
          Creates 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.
 IEssCube createCube(java.lang.String cubeName, IEssCube.EEssCubeType cubeType)
          Creates a new cube within this application and starts it.
 IEssCube createCube(java.lang.String cubeName, IEssCube.EEssCubeType cubeType, boolean allowNonUniqNames)
          Creates a new cube within this application and starts it.
 void delete()
          Deletes this application.
 void deleteCDF(java.lang.String name)
          Deletes custom defined function.
 void deleteCDM(java.lang.String name)
          Deletes custom defined macro.
 void deleteCube(java.lang.String cubeName)
          Deletes the specified cube.
 void deleteLogFile()
          Deletes this application's log file.
 IEssOlapApplication.EEssLoadStatus getAppLoadStatus()
          Gets the application load status.
 IEssCalcList getCalcList(java.lang.String userName, IEssCube Db)
          Gets the list of calc scripts objects which are accessible to a user.
 IEssCalcList getCalcListEx(java.lang.String userName, IEssCube Db)
          Gets the list of calc scripts objects which are accessible to a user.
 java.lang.String[][] getCDM_CDF()
          Gets custom defined functions and macros on the application.
 int getCountCubes()
          Gets the count of cubes in the application.
 int getCountUsersConnected()
          Gets the count of users connected to the application.
 IEssCube getCube(java.lang.String cubeName)
          Gets the specified cube.
 IEssIterator getCubes()
          Gets the cubes in this application that are accessible to this user.
 IEssOlapApplication.EEssDataStorageType getDataStorageType()
          Gets the application data storage type.
 java.lang.String getDescription()
          Gets the application description.
 int getElapsedAppTime()
          Gets the elapsed number of seconds since application loading.
 java.lang.String getLocale()
          Gets the application locale.
 int getLockTimeout()
          Gets the timeout period (in minutes) after which data-block locks are automatically removed.
 int getMaxAttachFileSize()
          Gets the maximum file size (in bytes) for Linked Reporting Objects (LRO) attachments
 IEssCube.EEssCubeAccess getMinimumCubeAccess()
          Gets the minimum cube access (the lowest possible level of access for all users).
 java.lang.String getName()
          Gets the name of the application.
 IEssOlapServer getOlapServer()
          Gets the parent olap Server.
 java.lang.String getServerName()
          Gets the name of the server the application resides.
 java.lang.String getType()
          Gets the application type.
 IEssOlapApplication.EEssOlapApplicationAccess getUserOrGroupAccess(java.lang.String userOrGroupName)
          Gets the user or group access for this application.
 boolean isAllowCommands()
          Indicates whether users can issue commands to the application.
 boolean isAllowConnects()
          Indicates whether users who have permissions lower than Application Managers can cannot to this application or not.
 boolean isAllowUpdates()
          Indicates whether users with sufficient permissions can update data in the application.
 boolean isAutoLoad()
          Indicates whether the application would be loaded automatically when OLAP server is started.
 boolean isEnableSecurity()
          Indicates whether application security is enabled.
 boolean isLoadable()
          Indicates whether the application can be loaded by users or not.
 void refreshPropertyValues()
          Refreshes the property values.
 void rename(java.lang.String newAppName)
          Renames this application.
 void reRegister()
          Re-establishes this Analytic Services application as Shared Services application.
 void setAllowCommands(boolean allowCommands)
          To enable or disable users from issuing commands to the application during the current session.
 void setAllowConnects(boolean allowConnects)
          Sets flag to indicate whether users can connect to the application.
 void setAllowUpdates(boolean allowUpdates)
          Sets flag to indicate whether users can update in the application.
 void setAutoLoad(boolean autoLoad)
          If you want the application to load automatically when OLAP Server starts, set this to true.
 void setCalcList(java.lang.String userName, IEssCube Db, boolean AllCalcs, java.lang.String[] CalcList)
          Sets the list of calc scripts objects which are accessible to a user.
 void setDescription(java.lang.String desc)
          Sets the application description.
 void setEnableSecurity(boolean enableSecurity)
          Enables or disables the Security settings in the application.
 void setLoadable(boolean loadable)
          Sets flag to indicate whether application can be loaded.
 void setLockTimeout(int lockTimeOutPeriod)
          Sets the maximum time interval(in minutes) that locks on data blocks can be held by users.
 void setMaxAttachFileSize(int maxLroFileSize)
          This is to set the maximum file size (in bytes) for Linked Reporting Objects (LRO) attachments.
 void setMinimumCubeAccess(IEssCube.EEssCubeAccess minCubeAccess)
          Sets the minimum cube access (the lowest possible level of access for all users).
 void setUserOrGroupAccess(java.lang.String userOrGroupName, IEssOlapApplication.EEssOlapApplicationAccess access)
          Sets the user or group access for this application.
 void start()
          Starts this application.
 void stop()
          Stops this application.
 void updatePropertyValues()
          Updates the property values.
 void updatePropertyValues(java.lang.String desc, int maxLroFileSize, boolean loadable, boolean autoLoad, boolean allowCommands, boolean allowConnects, boolean allowUpdates, boolean enableSecurity, int lockTimeOutPeriod, IEssCube.EEssCubeAccess minCubeAccess)
          Updates the specified property values.

 

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.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

PROP_COUNT_OF_USERS_CONNECTED

static final int PROP_COUNT_OF_USERS_CONNECTED
See Also:
Constant Field Values

PROP_LOAD_STATUS

static final int PROP_LOAD_STATUS
See Also:
Constant Field Values

PROP_ELAPSED_TIME

static final int PROP_ELAPSED_TIME
See Also:
Constant Field Values

PROP_IS_LOADABLE

static final int PROP_IS_LOADABLE
See Also:
Constant Field Values

PROP_IS_AUTO_LOAD

static final int PROP_IS_AUTO_LOAD
See Also:
Constant Field Values

PROP_MINIMUM_CUBE_ACCESS

static final int PROP_MINIMUM_CUBE_ACCESS
See Also:
Constant Field Values

PROP_IS_ALLOW_CONNECTS

static final int PROP_IS_ALLOW_CONNECTS
See Also:
Constant Field Values

PROP_IS_ALLOW_COMMANDS

static final int PROP_IS_ALLOW_COMMANDS
See Also:
Constant Field Values

PROP_IS_ALLOW_UPDATES

static final int PROP_IS_ALLOW_UPDATES
See Also:
Constant Field Values

PROP_IS_ENABLE_SECURITY

static final int PROP_IS_ENABLE_SECURITY
See Also:
Constant Field Values

PROP_LOCK_TIMEOUT

static final int PROP_LOCK_TIMEOUT
See Also:
Constant Field Values

PROP_COUNT_OF_CUBES

static final int PROP_COUNT_OF_CUBES
See Also:
Constant Field Values

PROP_SERVER_NAME

static final int PROP_SERVER_NAME
See Also:
Constant Field Values

PROP_MAXIMUM_SIZE_OF_ATTACHMENT_FILE

static final int PROP_MAXIMUM_SIZE_OF_ATTACHMENT_FILE
See Also:
Constant Field Values

PROP_TYPE

static final int PROP_TYPE
See Also:
Constant Field Values

PROP_LOCALE

static final int PROP_LOCALE
See Also:
Constant Field Values

PROP_DATA_STORAGE_TYPE

static final int PROP_DATA_STORAGE_TYPE
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 name of the application.
Specified by:
getName in interface IEssExtendedObject
Returns:
The application name.
Throws:
com.essbase.api.base.EssException - if an error occur.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Gets the application description.
Returns:
The description.
Throws:
com.essbase.api.base.EssException - if an error occur.

setDescription

void setDescription(java.lang.String desc)
                    throws com.essbase.api.base.EssException
Sets the application description. The change will become effective after you invoke updatePropertyValues().
Parameters:
desc - The description.
Throws:
com.essbase.api.base.EssException - if an error occur.

getType

java.lang.String getType()
                         throws com.essbase.api.base.EssException
Gets the application type.
Returns:
The application type. One of "utf8" or "native".
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLocale

java.lang.String getLocale()
                           throws com.essbase.api.base.EssException
Gets the application locale.
Returns:
The application locale.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMaxAttachFileSize

int getMaxAttachFileSize()
                         throws com.essbase.api.base.EssException
Gets the maximum file size (in bytes) for Linked Reporting Objects (LRO) attachments
Returns:
The maximum attachment file size. A value of indicates 0 unlimited file size.
Throws:
com.essbase.api.base.EssException - if an error occur.

setMaxAttachFileSize

void setMaxAttachFileSize(int maxLroFileSize)
                          throws com.essbase.api.base.EssException
This is to set the maximum file size (in bytes) for Linked Reporting Objects (LRO) attachments. There is no default. There is no minimum or maximum value, excepting limitations imposed by your system resources.

The change will become effective after you invoke updatePropertyValues().

Parameters:
maxLroFileSize - The maximum attachment file size (in bytes). Pass 0 for unlimited file size.
Throws:
com.essbase.api.base.EssException - if an error occur.

isLoadable

boolean isLoadable()
                   throws com.essbase.api.base.EssException
Indicates whether the application can be loaded by users or not. If this is false, all users are prevented from loading (starting) the application. By default, application would be loadable.
Returns:
true if application is loadable.
Throws:
com.essbase.api.base.EssException - if an error occur.

setLoadable

void setLoadable(boolean loadable)
                 throws com.essbase.api.base.EssException
Sets flag to indicate whether application can be loaded. 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.

The change will become effective after you invoke updatePropertyValues().

Parameters:
loadable - true if application is loadable.
Throws:
com.essbase.api.base.EssException - if an error occur.

isAutoLoad

boolean isAutoLoad()
                   throws com.essbase.api.base.EssException
Indicates whether the application would be loaded automatically when OLAP server is started.
Returns:
true if the application will be automatically loaded.
Throws:
com.essbase.api.base.EssException - if an error occur.

setAutoLoad

void setAutoLoad(boolean autoLoad)
                 throws com.essbase.api.base.EssException
If you want the application to load automatically when OLAP Server starts, set this to true. By default, auto load is disabled.

The change will become effective after you invoke updatePropertyValues().

Parameters:
autoLoad - true if the application will be automatically loaded.
Throws:
com.essbase.api.base.EssException - if an error occur.

isAllowCommands

boolean isAllowCommands()
                        throws com.essbase.api.base.EssException
Indicates whether users can issue commands to the application. If this is 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 would be affected, including other administrators. This setting remains in effect only for the duration of the session of owner who has disabled commands. Allowing commands would get enabled in either of the two ways: Session of the owner who disabled it expires or when the owner enables commands.
Returns:
true if the application is accepting user commands.
Throws:
com.essbase.api.base.EssException - if an error occur.

setAllowCommands

void setAllowCommands(boolean allowCommands)
                      throws com.essbase.api.base.EssException
To enable or disable users from issuing commands to the application during the current session. 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. By default, commands are enabled.

Caution: If performing maintenance operations that require disabling commands, you must make those maintenance operations within the same session.

The change will become effective after you invoke updatePropertyValues().

Parameters:
allowCommands - flag to enable to disable any user from issuing a command, during current session.
Throws:
com.essbase.api.base.EssException - if an error occur.

isAllowConnects

boolean isAllowConnects()
                        throws com.essbase.api.base.EssException
Indicates whether users who have permissions lower than Application Managers can cannot to this application or not.
Returns:
true if users can connect.
Throws:
com.essbase.api.base.EssException - if an error occur.

setAllowConnects

void setAllowConnects(boolean allowConnects)
                      throws com.essbase.api.base.EssException
Sets flag to indicate whether users can connect to the application. 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.

The change will become effective after you invoke updatePropertyValues().

Parameters:
allowConnects - if setfalse, disables users to connect.
Throws:
com.essbase.api.base.EssException - if an error occur.

isAllowUpdates

boolean isAllowUpdates()
                       throws com.essbase.api.base.EssException
Indicates whether users with sufficient permissions can update data in the application. If this is false</false>, the OLAP Server prevent all users (except Administrators) from making requests to databases in the application.
Returns:
true if the application is accepting user update commands.
Throws:
com.essbase.api.base.EssException - if an error occur.

setAllowUpdates

void setAllowUpdates(boolean allowUpdates)
                     throws com.essbase.api.base.EssException
Sets flag to indicate whether users can update in the application. This is to enable or disable the Updates to this application till the current session is alive. 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.

The change will become effective after you invoke updatePropertyValues().

Parameters:
allowUpdates - true if the application is accepting user update commands.
Throws:
com.essbase.api.base.EssException - if an error occur.

isEnableSecurity

boolean isEnableSecurity()
                         throws com.essbase.api.base.EssException
Indicates whether application security is enabled. 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.
Returns:
true if security is enabled.
Throws:
com.essbase.api.base.EssException - if an error occur.

setEnableSecurity

void setEnableSecurity(boolean enableSecurity)
                       throws com.essbase.api.base.EssException
Enables or disables the Security settings in the application. 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. The change will become effective after you invoke updatePropertyValues().
Parameters:
enableSecurity - if set to false security settings are disabled and vice versa.
Throws:
com.essbase.api.base.EssException - if an error occur.

getLockTimeout

int getLockTimeout()
                   throws com.essbase.api.base.EssException
Gets the timeout period (in minutes) after which data-block locks are automatically removed. The default interval is 60 minutes.
Returns:
The timeout period (in minutes).
Throws:
com.essbase.api.base.EssException - if an error occur.

setLockTimeout

void setLockTimeout(int lockTimeOutPeriod)
                    throws com.essbase.api.base.EssException
Sets the maximum time interval(in minutes) 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. The change will become effective after you invoke updatePropertyValues().
Parameters:
lockTimeOutPeriod - the Lock time out period (in minutes).
Throws:
EssException.
com.essbase.api.base.EssException

getMinimumCubeAccess

IEssCube.EEssCubeAccess getMinimumCubeAccess()
                                             throws com.essbase.api.base.EssException
Gets the minimum cube access (the lowest possible level of access for all users). This is the default access to cubes in this OLAP application.
Returns:
The minimum cube access.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setMinimumCubeAccess

void setMinimumCubeAccess(IEssCube.EEssCubeAccess minCubeAccess)
                          throws com.essbase.api.base.EssException
Sets the minimum cube access (the lowest possible level of access for all users). 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. The change will become effective after you invoke updatePropertyValues().
Parameters:
minCubeAccess - The minimum cube access.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAppLoadStatus

IEssOlapApplication.EEssLoadStatus getAppLoadStatus()
                                                    throws com.essbase.api.base.EssException
Gets the application load status.
Returns:
The application load status.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountUsersConnected

int getCountUsersConnected()
                           throws com.essbase.api.base.EssException
Gets the count of users connected to the application.
Returns:
The count of users connected.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getElapsedAppTime

int getElapsedAppTime()
                      throws com.essbase.api.base.EssException
Gets the elapsed number of seconds since application loading.
Returns:
The elapsed number of seconds.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountCubes

int getCountCubes()
                  throws com.essbase.api.base.EssException
Gets the count of cubes in the application.
Returns:
The count of cubes.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getServerName

java.lang.String getServerName()
                               throws com.essbase.api.base.EssException
Gets the name of the server the application resides.
Returns:
The server name.
Throws:
com.essbase.api.base.EssException - if an error occur.

getDataStorageType

IEssOlapApplication.EEssDataStorageType getDataStorageType()
                                                           throws com.essbase.api.base.EssException
Gets the application data storage type.
Returns:
The application data storage type.
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.

updatePropertyValues

void updatePropertyValues(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
Updates the specified property values. If the update is successful, the local cache is set with these values.
Parameters:
desc - the description for this 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.
Throws:
com.essbase.api.base.EssException

getCubes

IEssIterator getCubes()
                      throws com.essbase.api.base.EssException
Gets the cubes in this application that are accessible to this user.
Returns:
The cubes (each of type IEssCube).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createCube

IEssCube createCube(java.lang.String cubeName,
                    IEssCube.EEssCubeType cubeType)
                    throws com.essbase.api.base.EssException
Creates a new cube within this application and starts it.
Parameters:
cubeName - The cube name.
cubeType - The cube type. Valid values for ASO applications - IEssCube.EEssCubeType.ASO and IEssCube.EEssCubeType.NORMAL, for BSO applications - IEssCube.EEssCubeType.NORMAL and IEssCube.EEssCubeType.CURRENCY
Returns:
The new cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createCube

IEssCube createCube(java.lang.String cubeName,
                    IEssCube.EEssCubeType cubeType,
                    boolean allowNonUniqNames)
                    throws com.essbase.api.base.EssException
Creates a new cube within this application and starts it.
Parameters:
cubeName - The cube name.
cubeType - The cube type. Valid values for ASO applications - IEssCube.EEssCubeType.ASO and IEssCube.EEssCubeType.NORMAL, for BSO applications - IEssCube.EEssCubeType.NORMAL and IEssCube.EEssCubeType.CURRENCY
allowNonUniqNames - if true, creates a database that supports non-unique member names.
Returns:
The new cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCube

IEssCube getCube(java.lang.String cubeName)
                 throws com.essbase.api.base.EssException
Gets the specified cube.
Parameters:
cubeName - The cube name.
Returns:
The cube.
Throws:
com.essbase.api.base.EssException - if an error occur.

deleteCube

void deleteCube(java.lang.String cubeName)
                throws com.essbase.api.base.EssException
Deletes the specified cube.
Parameters:
cubeName - The cube name.
Throws:
com.essbase.api.base.EssException - if an error occur.

rename

void rename(java.lang.String newAppName)
            throws com.essbase.api.base.EssException
Renames this application. If the application is running, then it is first stopped.
Parameters:
newAppName - The new name of the application.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copy

IEssOlapApplication copy(java.lang.String newAppName)
                         throws com.essbase.api.base.EssException
Copies this application to a new application, including all associated cubes and objects and also starts the new application.
Parameters:
newAppName - The new application name.
Returns:
The new application.
Throws:
com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException
Deletes this application. If the application is running, then it is first stopped.
Throws:
com.essbase.api.base.EssException - if an error occurs.

start

void start()
           throws com.essbase.api.base.EssException
Starts this application.
Throws:
com.essbase.api.base.EssException - if an error occurs.

stop

void stop()
          throws com.essbase.api.base.EssException
Stops this application.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteLogFile

void deleteLogFile()
                   throws com.essbase.api.base.EssException
Deletes this application's log file.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUserOrGroupAccess

IEssOlapApplication.EEssOlapApplicationAccess getUserOrGroupAccess(java.lang.String userOrGroupName)
                                                                   throws com.essbase.api.base.EssException
Gets the user or group access for this application.
Returns:
The application access.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setUserOrGroupAccess

void setUserOrGroupAccess(java.lang.String userOrGroupName,
                          IEssOlapApplication.EEssOlapApplicationAccess access)
                          throws com.essbase.api.base.EssException
Sets the user or group access for this application.
Parameters:
access - The application access.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOlapServer

IEssOlapServer getOlapServer()
                             throws com.essbase.api.base.EssException
Gets the parent olap Server.
Returns:
The olap Server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCalcList

IEssCalcList getCalcList(java.lang.String userName,
                         IEssCube Db)
                         throws com.essbase.api.base.EssException
Gets the list of calc scripts objects which are accessible to a user. If successful, the user's allow all calcs setting is returned in IEssCalcList.getAllCalcs() and a list of calc script object names is returned in IEssCalcList.getCalcList(). In order to access any calc script objects, the specified user must have at least calculate access to the appropriate database. If the IEssCalcList.getAllCalcs() flag is set to TRUE, IEssCalcList.getCalcList() is NULL. This function requires the caller to have database Design privilege (ESS_PRIV_DBDESIGN) for the specified database, unless they are getting their own calc list.
Parameters:
userName - - the username
Db - - IEssCube instance. If NULL, uses Application subdirectory, the userName requires ESS_PRIV_APPDESIGN privileges.
Returns:
- IEssCalcList
Throws:
com.essbase.api.base.EssException

getCalcListEx

IEssCalcList getCalcListEx(java.lang.String userName,
                           IEssCube Db)
                           throws com.essbase.api.base.EssException
Gets the list of calc scripts objects which are accessible to a user. EssCalcListEx will not return all calc access if the user has calc access because its part of a group. EssGetCalcList returns all calc enabled if calc access is thru group, even though if it is per user it does not return all calc TRUE just because it has calc access. This function requires the caller to have database Design privilege (ESS_PRIV_DBDESIGN) for the specified database, unless they are getting their own calc list.
Parameters:
userName - - the username
Db - - IEssCube instance. If NULL, uses Application subdirectory, the userName requires ESS_PRIV_APPDESIGN privileges.
Returns:
- IEssCalcList
Throws:
com.essbase.api.base.EssException

setCalcList

void setCalcList(java.lang.String userName,
                 IEssCube Db,
                 boolean AllCalcs,
                 java.lang.String[] CalcList)
                 throws com.essbase.api.base.EssException
Sets the list of calc scripts objects which are accessible to a user. If the AllCalcs flag is set to TRUE, the Count and pCalcList arguments will be ignored. In order to access any calc script objects, the user must have at least calculate access to the appropriate database. This function requires the caller to have database Design privilege (ESS_PRIV_DBDESIGN) for the specified database.
Parameters:
userName - - the username
Db - - IEssCube instance. If NULL, uses Application subdirectory
AllCalcs - - Allow all calcs flag. If TRUE, the user can access all calc scripts, otherwise, they can only access those specified in the CalcList argument.
CalcList - - an array of calc script object names
Throws:
com.essbase.api.base.EssException

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 custom defined function.
Parameters:
name - Function name
javaSpec - Java Specification
options - An option must be one of possible values of IEssOlapApplication.ESS_UDF_FUNCTION_*
spec - Function specification
comment - Description for this function.
Throws:
throws - EssExcepton 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:
com.essbase.api.base.EssException - if an error occurs.

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 - Marco definition
signature - Signature for this macro.
spec - Specification for this macro.
comment - Description for this macro.
Throws:
com.essbase.api.base.EssException - if an error occurs.

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:
com.essbase.api.base.EssException - if an error occurs.

getCDM_CDF

java.lang.String[][] getCDM_CDF()
                                throws com.essbase.api.base.EssException
Gets custom defined functions and macros on the application.

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 will be "local"

Returns:
list of CDF and CDMs.
Throws:
com.essbase.api.base.EssException - if an error occurs.

reRegister

void reRegister()
                throws com.essbase.api.base.EssException
Re-establishes this Analytic Services application as Shared Services application. This function requires the caller to be an Administrator, Application Manager, or Database Manager.If caller does not have sufficient permissions for the application, 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.

Skip navigation links