com.essbase.api.datasource

Interface IEssOlapApplication

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties, IEssSubstitutionVariables

public interface IEssOlapApplication
extends IEssExtendedObject, IEssProperties, IEssSubstitutionVariables

The IEssOlapApplication object represents Essbase application.

Version:

1.0, 04/04/2001

Author:

Oracle Corporation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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

Fields

Modifier and Type	Field and Description
static short	ESS_CONFIG_INVALID_KEY Contant to represent that the key passed is invalid
static short	ESS_CONFIG_SOURCE_APP Constant to represent whether the configuration is set at application level
static short	ESS_CONFIG_SOURCE_DEFAULT Constant to represent whether the configuration is set at system/default level
static short	ESS_CONFIG_SOURCE_ESSBASE Constant to represent whether the configuration is set at essbase level
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

Modifier and Type	Method and Description
boolean	backup(java.lang.String backupPath, boolean isForce) Creates a backup for this application including all associated cubes and objects.
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.
IEssOlapApplication	copy(java.lang.String newAppName, boolean hideNewApp) Copies this application to a new application, including all associated cubes and objects and also starts the new application.
IEssOlapApplication	copy(java.lang.String newAppName, boolean hideNewApp, int waitForOngoingUpdatesInSecs) Copies this application to a new application, including all associated cubes and objects and also starts the new application.
IEssOlapApplication	copy(java.lang.String newAppName, boolean hideNewApp, int waitForOngoingUpdatesInSecs, boolean withoutData) 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.
IEssCube	createCube(java.lang.String cubeName, IEssCube.EEssCubeType cubeType, short otlNameType) Creates a new cube within this application and starts it.
void	decrypt() Allows the application to be decrypted.
void	delete() Deletes this application.
void	deleteApplicationConfigEntry(java.lang.String key) Deletes configuration value for a given key from application.cfg file
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.
void	encrypt() Allows the application to be encrypted.
java.lang.String	getAgentApplicationId() Returns application Id that uses Agent to identify an app.
long	getApplicationChecksum() Returns a checksum of all files for the given application.
java.lang.String	getApplicationConfigEntry(java.lang.String key) Gets configuration value for a given key from application.cfg 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.
long	getCreationTime() Gets the creation time number of seconds since application loading.
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.
com.essbase.api.metadata.EssEncryptionConfig	getEncryptionConfig() Returns the supported encryption type and mode details.
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	getModifiedBy() Get the modified by information on the Application
long	getModifiedTime() Gets the modified time number of seconds since application loading.
java.lang.String	getName() Gets the name of the application.
IEssOlapServer	getOlapServer() Gets the parent olap Server.
java.lang.String	getOwner() Get the Owner name of the Application
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	isEncrypted() Checks if application is encrypted.
boolean	isLoadable() Indicates whether the application can be loaded by users or not.
EssAppConfig[]	listApplicationConfigEntries() Lists all configuration settings for a given application from application.cfg file Returns an array of AppConfig which contains AppTag Name, AppTag Value and configuration flag -configuration flag is TRUE when config entry exists in app config file -configuration flag is FALSE when config entry does not exist in app config file
void	pauseDataFileWrites() Pauses all disk writes for databases related files.
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	resumeDataFileWrites() Resumes all disk writes for databases related files.
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	setApplicationConfigEntry(java.lang.String key, java.lang.String value) Sets configuration value for a given key in application.cfg file
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	setEncryptionKey(com.essbase.api.metadata.EssEncryptionKeySpec keySpec) Allows to set custom key or use vault key based on the Encryption type specified.
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

ESS_CONFIG_SOURCE_APP

static final short ESS_CONFIG_SOURCE_APP

Constant to represent whether the configuration is set at application level

See Also:

Constant Field Values

ESS_CONFIG_SOURCE_ESSBASE

static final short ESS_CONFIG_SOURCE_ESSBASE

Constant to represent whether the configuration is set at essbase level

See Also:

Constant Field Values

ESS_CONFIG_SOURCE_DEFAULT

static final short ESS_CONFIG_SOURCE_DEFAULT

Constant to represent whether the configuration is set at system/default level

See Also:

Constant Field Values

ESS_CONFIG_INVALID_KEY

static final short ESS_CONFIG_INVALID_KEY

Contant to represent that the key passed is invalid

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.

getOwner

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

Get the Owner name of the Application

Returns:

The Onwer name.

Throws:

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

getModifiedBy

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

Get the modified by information on the Application

Returns:

The modifiedBy name.

Throws:

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

getCreationTime

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

Gets the creation time number of seconds since application loading.

Returns:

The creation time number of seconds.

Throws:

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

getModifiedTime

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

Gets the modified time number of seconds since application loading.

Returns:

The modifiedBy time.

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

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:

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

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, 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 - if an error occurs

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.

createCube

IEssCube createCube(java.lang.String cubeName,
                    IEssCube.EEssCubeType cubeType,
                    short otlNameType)
             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

otlNameType - Valid values are IEssCubeOutline.ESS_OTL_NAME_*

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.

copy

IEssOlapApplication copy(java.lang.String newAppName,
                         boolean hideNewApp)
                  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.

If hideNewApp is used, then, it will make the cloned application hidden. That is, if one uses the IEssOlapServer.getApplications(), it will not list the hidden application. Alternatively, one has to use IEssOlapServer.getHiddenApplicationNames().

Parameters:

newAppName - The new application name.

hideNewApp - If true, makes the application hidden from regular applications.

Returns:

The new application.

Throws:

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

copy

IEssOlapApplication copy(java.lang.String newAppName,
                         boolean hideNewApp,
                         int waitForOngoingUpdatesInSecs)
                  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.

If hideNewApp is used, then, it will make the cloned application hidden. That is, if one uses the IEssOlapServer.getApplications(), it will not list the hidden application. Alternatively, one has to use IEssOlapServer.getHiddenApplicationNames().

The parameter, waitForOngoingUpdatesInSecs allows to control how long the copying process can wait, if there are any ongoing write-operations on the cubes(s) of this application. For example, if there is a dataload in progress, the cloning process will fail. If you specified waitForOngoingUpdatesInSecs as 60, Essbase will wait upto one minute for dataload to complete before initiating cloning process. If dataload doesn't complete within this specified wait-interval, Essbase will not do the copy and fail indicating the same with an error; the dataload will continue.

Parameters:

newAppName - The new application name.

hideNewApp - If true, makes the application hidden from regular applications.

waitForOngoingUpdatesInSecs - Waiting period (in seconds) for any active write-operations to complete.

Returns:

The new application.

Throws:

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

copy

IEssOlapApplication copy(java.lang.String newAppName,
                         boolean hideNewApp,
                         int waitForOngoingUpdatesInSecs,
                         boolean withoutData)
                  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.

If hideNewApp is used, then, it will make the cloned application hidden. That is, if one uses the IEssOlapServer.getApplications(), it will not list the hidden application. Alternatively, one has to use IEssOlapServer.getHiddenApplicationNames().

The parameter, waitForOngoingUpdatesInSecs allows to control how long the copying process can wait, if there are any ongoing write-operations on the cubes(s) of this application. For example, if there is a dataload in progress, the cloning process will fail. If you specified waitForOngoingUpdatesInSecs as 60, Essbase will wait upto one minute for dataload to complete before initiating cloning process. If dataload doesn't complete within this specified wait-interval, Essbase will not do the copy and fail indicating the same with an error; the dataload will continue.

Parameters:

newAppName - The new application name.

hideNewApp - If true, makes the application hidden from regular applications.

waitForOngoingUpdatesInSecs - Waiting period (in seconds) for any active write-operations to complete.

withoutData - To exclude data being replicated from primary application.

Returns:

The new application.

Throws:

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

backup

boolean backup(java.lang.String backupPath,
               boolean isForce)
        throws com.essbase.api.base.EssException

Creates a backup for this application including all associated cubes and objects.

Parameters:

backupPath - Path where backup files will be created.

isForce - Force backup. Block write requests if needed.

Returns:

true if the backup was dirty.

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.

Parameters:

userOrGroupName - user or group name

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:

userOrGroupName - The user or the group name for which access to be set.

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 - if an error occurs

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 - if an error occurs

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 - if an error occurs

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:

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

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.

setApplicationConfigEntry

void setApplicationConfigEntry(java.lang.String key,
                               java.lang.String value)
                        throws com.essbase.api.base.EssException

Sets configuration value for a given key in application.cfg file

Parameters:

key - - application configuration key

Examples to some configuration properties and one of the valid values

Key	Value	Description
DATACACHESIZE	3M	Sets value applied to all database under an application
DATACACHESIZE Sample Basic	2M	Sets value applied to a specific database under an application
DATACACHESIZE Sample	4M	Sets value applied to all database under an application

value - - application configuration value

Throws:

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

Since:

11.1.2.4.500

getApplicationConfigEntry

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

Gets configuration value for a given key from application.cfg file

Parameters:

key - - application configuration key

Example configuration properties that you can request

Key	Value	Description
DATACACHESIZE	3M	Gets value applied to all database under an application
DATACACHESIZE Sample Basic	2M	Gets value applied to a specific database under an application
DATACACHESIZE Sample	4M	Gets value applied to all database under an application

Returns:

- configuration value for a input key

Throws:

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

Since:

11.1.2.4.500

deleteApplicationConfigEntry

void deleteApplicationConfigEntry(java.lang.String key)
                           throws com.essbase.api.base.EssException

Deletes configuration value for a given key from application.cfg file

Parameters:

key - - application configuration key

Valid options for this parameter

Key	Value	Description
DATACACHESIZE	3M	Deletes value applied to all database under an application
DATACACHESIZE Sample Basic	2M	Deletes value applied to a specific database under an application
DATACACHESIZE Sample	4M	Deletes value applied to all database under an application

Throws:

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

Since:

11.1.2.4.500

listApplicationConfigEntries

EssAppConfig[] listApplicationConfigEntries()
                                     throws com.essbase.api.base.EssException

Lists all configuration settings for a given application from application.cfg file Returns an array of AppConfig which contains AppTag Name, AppTag Value and configuration flag
-configuration flag is TRUE when config entry exists in app config file -configuration flag is FALSE when config entry does not exist in app config file

Returns:

Array of Application Config entries.

Throws:

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

Since:

11.1.2.4.500

getAgentApplicationId

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

Returns application Id that uses Agent to identify an app.

Returns:

The application id.

Throws:

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

getApplicationChecksum

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

Returns a checksum of all files for the given application.

Returns:

The checksum of all files for the application.

Throws:

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

pauseDataFileWrites

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

Pauses all disk writes for databases related files.

Throws:

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

resumeDataFileWrites

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

Resumes all disk writes for databases related files.

Throws:

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

encrypt

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

Allows the application to be encrypted. Applicable only when Essbase is deployed as a stack on OCI, using Oracle Cloud Marketplace listing.

Throws:

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

isEncrypted

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

Checks if application is encrypted. Returns true if encrypted. Applicable only when Essbase is deployed as a stack on OCI, using Oracle Cloud Marketplace listing.

Returns:

boolean

Throws:

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

decrypt

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

Allows the application to be decrypted. Applicable only when Essbase is deployed as a stack on OCI, using Oracle Cloud Marketplace listing.

Throws:

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

setEncryptionKey

void setEncryptionKey(com.essbase.api.metadata.EssEncryptionKeySpec keySpec)
               throws com.essbase.api.base.EssException

Allows to set custom key or use vault key based on the Encryption type specified. Applicable only when Essbase is deployed as a stack on OCI, using Oracle Cloud Marketplace listing.

Parameters:

keySpec - ,an object with non empty encryption type and key

Throws:

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

getEncryptionConfig

com.essbase.api.metadata.EssEncryptionConfig getEncryptionConfig()
                                                          throws com.essbase.api.base.EssException

Returns the supported encryption type and mode details. Applicable only when Essbase is deployed as a stack on OCI, using Oracle Cloud Marketplace listing. Mode can have one of NOT_CONFIGURED(0),ORACLE_KEYSTORE(1), ORACLE_VAULT(2) Type could be one of AES_256, OCID

Returns:

EssEncryptionConfig

Throws:

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