Skip navigation links


com.essbase.api.datasource
Interface IEssCube

All Superinterfaces:
IEssAppComponent, IEssBaseObject, IEssExtendedObject, IEssProperties, IEssSubstitutionVariables

public interface IEssCube
extends IEssExtendedObject, IEssProperties, IEssAppComponent, IEssSubstitutionVariables

The IEssCube is the olap cube.

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

Nested Class Summary
static class IEssCube.EEssCubeAccess
          The EEssCubeAccess is an enumeration of cube access levels.
static class IEssCube.EEssCubeletType
           
static class IEssCube.EEssCubeType
          The EEssCubeType class.
static class IEssCube.EEssCurrencyConversionType
          The EEssCurrencyConversionType class.
static class IEssCube.EEssDataLevel
          The EEssDataLevel class is an enumeration of data level on export.
static class IEssCube.EEssDataLoadStatus
          The EEssDataLoadStatus class.
static class IEssCube.EEssLoadStatus
          The EEssLoadStatus class is an enumeration of Cube load status.
static class IEssCube.EEssRestructureOption
          The EEssRestructureOption class is an enumeration of Cube restructure options.
static class IEssCube.EEssTimePeriod
          EEssTimePeriod class represents a time period.
static interface IEssCube.IEssCubeLock
          The IEssCubeLock interface provides information about the data blocks exclusively locked.
static interface IEssCube.IEssSecurityFilter
          The IEssSecurityFilter is cube security filter.

 

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

 

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

 

Field Summary
static long ESS_ASO_DATA_LOAD_BUFFER_ABORT
           
static long ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA
           
static long ESS_ASO_DATA_LOAD_BUFFER_COMMIT
           
static long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD
           
static long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL
           
static long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST
           
static long ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES
           
static long ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES
           
static long ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA
           
static long ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA
           
static long ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA
           
static long ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA
           
static long ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK
           
static long ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE
           
static long ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE
           
static long ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE_LIGHTWEIGHT
           
static long ESS_ASO_VERIFY_MEMBER_EXPR
           
static long ESS_ASO_VERIFY_NUMERIC_EXPR
           
static long ESS_ASO_VERIFY_SET_EXPR
           
static long ESS_ASO_VERIFY_TUPLE_EXPR
           
static short ESS_BLDDL_STAGE_BUILDOTL
           
static short ESS_BLDDL_STAGE_DATALOAD
           
static short ESS_BLDDL_STAGE_FINALIZE
           
static short ESS_BLDDL_STAGE_NONE
           
static short ESS_BLDDL_STAGE_OPENDATASOURCE
           
static short ESS_BLDDL_STAGE_OPENOTL
           
static short ESS_BLDDL_STAGE_RESTRUCT
           
static short ESS_BLDDL_STAGE_VERIFYOTL
           
static short ESS_BLDDL_STAGE_WRITEOTL
           
static short ESS_BLDDL_STATE_DONE
           
static short ESS_BLDDL_STATE_FINALSTAGE
           
static short ESS_BLDDL_STATE_INPROGRESS
           
static short ESS_DOR_ALLDATA
           
static short ESS_DOR_FORCE_ALLDATA
           
static short ESS_DOR_INDATA
           
static short ESS_DOR_LOWDATA
           
static short ESS_DOR_NODATA
           
static int ESS_INCDIMBUILD_ALL
           
static int ESS_INCDIMBUILD_BUILD
           
static short ESS_INCDIMBUILD_RESTRUCT_OPT1
           
static int ESS_INCDIMBUILD_SAVEOTL
           
static int ESS_INCDIMBUILD_VERIFY
           
static short ESS_LIST_TRANSACTIONS_FORCETOFILE
           
static short ESS_LIST_TRANSACTIONS_TOCLIENT
           
static short ESS_LIST_TRANSACTIONS_TOFILE
           
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_ACTUAL_BLOCK_SIZE
           
static int PROP_ACTUAL_MAX_BLOCKS
           
static int PROP_APPLICATION_NAME
           
static int PROP_BLOCK_DENSITY
           
static int PROP_CACHE_MEMORY_LOCKING
           
static int PROP_CALC_CREATE_BLOCK
           
static int PROP_COMMIT_BLOCKS
           
static int PROP_COMMIT_ROWS
           
static int PROP_COMPRESSION_RATIO
           
static int PROP_COUNT_OF_DIMENSIONS
           
static int PROP_COUNT_OF_INMEM_COMPRESSED_BLOCKS
           
static int PROP_COUNT_OF_LOCKS
           
static int PROP_COUNT_OF_NON_MISSING_NON_LEAF_BLOCKS
           
static int PROP_COUNT_OF_USERS_CONNECTED
           
static int PROP_CUBE_ACCESS
           
static int PROP_CUBE_LOAD_STATUS
           
static int PROP_CUBE_TYPE
           
static int PROP_CURRENCY_CATEGORY_MEMBER
           
static int PROP_CURRENCY_CONV_TYPE
           
static int PROP_CURRENCY_CONV_TYPE_MEMBER_NAME
           
static int PROP_CURRENCY_COUNTRY_MEMBER
           
static int PROP_CURRENCY_CUBE_NAME
           
static int PROP_CURRENCY_PARTITION_MEMBER
           
static int PROP_CURRENCY_TIME_MEMBER
           
static int PROP_CURRENCY_TYPE_MEMBER
           
static int PROP_DATA_CACHE_SETTING
           
static int PROP_DATA_CACHE_SIZE
           
static int PROP_DATA_COMPRESS
           
static int PROP_DATA_COMPRESS_TYPE
           
static int PROP_DATA_LOAD_STATUS
           
static int PROP_DATAFILE_CACHE_SETTING
           
static int PROP_DATAFILE_CACHE_SIZE
           
static int PROP_DECLARED_BLOCK_SIZE
           
static int PROP_DECLARED_MAX_BLOCKS
           
static int PROP_DESCRIPTION
           
static int PROP_ELAPSED_CUBE_TIME
           
static int PROP_EXCLUSIVE_LOCK_COUNT
           
static int PROP_INDEX_CACHE_SETTING
           
static int PROP_INDEX_CACHE_SIZE
           
static int PROP_INDEX_PAGE_SETTING
           
static int PROP_INDEX_PAGE_SIZE
           
static int PROP_IS_AUTOLOAD
           
static int PROP_IS_CALC_NO_AGG_MISSING
           
static int PROP_IS_CALC_NO_AVG_MISSING
           
static int PROP_IS_CALC_TWO_PASS
           
static int PROP_IS_LODABLE
           
static int PROP_ISOLATION_LEVEL
           
static int PROP_MAX_MEM_NON_COMP_BLOCKS
           
static int PROP_NAME
           
static int PROP_NON_EXCLUSIVE_LOCK_COUNT
           
static int PROP_NON_MISSING_LEAF_BLOCKS
           
static int PROP_PAGED_IN_BLOCKS
           
static int PROP_PAGED_OUT_BLOCKS
           
static int PROP_PRE_EMAGE
           
static int PROP_RETRIEVAL_BUFFER
           
static int PROP_RETRIEVAL_SORT_BUFFER
           
static int PROP_SPARSE_DENSITY
           
static int PROP_TOTAL_BLOCKS
           
static int PROP_TOTAL_MEMORY_ALL_BLOCKS
           
static int PROP_TOTAL_MEMORY_FOR_INDEX
           
static int PROP_TOTAL_MEMORY_FOR_INMEM_COMPRESSED_BLOCKS
           
static int PROP_TOTAL_MEMORY_PAGED_IN_BLOCKS
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           

 

Method Summary
 void archiveBegin(java.lang.String archFileName)
          Prepares this cube for archive by setting read-only status.
 void archiveDatabase(java.lang.String backupFileName, java.lang.String optionsFileName, boolean overWrite)
          Archives the current database to the file specified.
 void archiveEnd()
          After archive, returns cube status to read-write.
 void asyncBuildDimension(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, int buildDimOptions, java.lang.String tmpOtlFileName)
          Asyncronously loads data in to a Cube.
 void asyncLoadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError, java.lang.String userName, java.lang.String password)
          Allows the importing of data from text files to this cube.
 void asyncLoadData(int rulesFileType, java.lang.String rulesFileName, int dataFileType, java.lang.String dataFileName, boolean abortOnError, java.lang.String userName, java.lang.String password, int bufferId)
          Allows the importing of data from text files to this ASO cube.
 void beginDataload(boolean Store, boolean Unlock, boolean AbortOnError, java.lang.String rulesFileName, int rulesObjectType)
          Starts sending an update specification to the active database, and can unlock any data blocks locked for update.
 void beginDataload(boolean Store, boolean Unlock, boolean AbortOnError, java.lang.String rulesFileName, int rulesObjectType, int bufferId)
          Starts sending an update specification to the active database, and can unlock any data blocks locked for update.
 java.lang.String[][] beginDataload(java.lang.String rulesFileName, int rulesObjectType, java.lang.String dataFileName, int dataFileType, boolean AbortOnError, int bufferId)
          Imports from a data file.
 java.lang.String[][] beginDataload(java.lang.String rulesFileName, int rulesObjectType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, boolean AbortOnError, int bufferId)
          Imports the data for ASO from FTP and SQL source.
 java.lang.String[][] beginDataload(java.lang.String rulesFileName, int rulesObjectType, java.lang.String userName, java.lang.String password, boolean AbortOnError, int bufferId)
          Imports the data from SQL source.
 IEssCubeOutline beginIncrementalBuildDim()
          Gives an instruction to the Cube that incremental Dimension build is started.
 void beginStreamBuildDim(java.lang.String rulesFileName, int rulesFileType, int incBuildOption, java.lang.String tmpOtlFilename)
          Begins the Streaming Dimension build on this Cube.
 void beginUpdate(boolean store, boolean unlock)
          Starts sending an update specification to the active database.
 void buildDimension(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String errOutFile)
          Allows the addition or removal of members from the outline in the active cube from a data file and rules file.
 void buildDimensionFile(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String errOutFile, boolean overwriteErrFile)
          Builds a data file used to add or remove members from the active cube outline.
 void buildDimensionStart()
          This starts the process to add or remove members from the active database outline.
 void calculate()
          Executes the default calculation for this cube.
 void calculate(boolean syntaxCheckOnly, java.lang.String calcFileNamePrefix)
          Executes a calc script against the active database from a file.
 void calculate(java.lang.String calcScript, boolean syntaxCheckOnly)
          Sends and optionally executes a calc script against this active cube as a single string.
 java.lang.StringBuffer cancelAsyncProcess(java.lang.String ErrorFileName, boolean overwrite, boolean addToBuffer)
          Cancels the async process.
 void clearActive()
          Clears the currently active application and cube for the instance of the IEssOlapServer object (which is parent of parent to this object).
 void clearAllData()
          Clears all loaded data in the active cube.
 void clearPartialData(java.lang.String regionSpec, boolean isPhysical)
          Clears data from a specific region(slice) of an ASO Database.
 com.essbase.api.datasource.EssBuildDimDataLoadState closeAsyncProcess()
          closes the async process and returns the current state of the process Note : This API must follow the call of either unsynchronized dimension build API or unsynchronized data load API.
 IEssCube copy(java.lang.String newCubeName, IEssOlapApplication destApp)
          Copies this cube to a new cube, including all associated objects and also starts the new cube.
 void copyOlapFileObject(int objType, java.lang.String objName, java.lang.String destAppName, java.lang.String destCubeName, java.lang.String destObjName)
          Copies an olap file object.
 byte[] copyOlapFileObjectFromServer(int objType, java.lang.String objName, boolean lock)
          Copies an object from the olap server to a byte sequence and optionally locks the server object to prevent updates by others.
 void copyOlapFileObjectFromServer(int objType, java.lang.String objName, java.lang.String clientFileName, boolean lock)
          Copies an object from the olap server to a client file and optionally locks the server object to prevent updates by others.
 void copyOlapFileObjectToServer(int objType, java.lang.String objName, byte[] content, boolean unlock)
          Copies an object in the form of byte sequence to the olap server, and optionally unlocks the server object to allow updates by others.
 void copyOlapFileObjectToServer(int objType, java.lang.String objName, java.lang.String clientFileName, boolean unlock)
          Copies an object from a client file to the olap server, and optionally unlocks the server object to allow updates by others.
 void createCDF(java.lang.String appName, java.lang.String name, java.lang.String javaSpec, int options, java.lang.String spec, java.lang.String comment)
          Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
 void createCDM(java.lang.String appName, java.lang.String name, java.lang.String definition, java.lang.String signature, java.lang.String spec, java.lang.String comment)
          Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
 IEssCubeDataloadInstance createDataloadInstance()
          Creates an returns a cube data load instance.
 void createDrillThroughURL(java.lang.String URLName, boolean bIsLevel0, java.lang.String URLLink, java.lang.String[] drillRegions)
          .
 void createLocationAlias(java.lang.String aliasName, java.lang.String hostName, java.lang.String appName, java.lang.String cubeName, java.lang.String userName, java.lang.String password)
          Creates a new location alias; that is, it maps an alias name string to an ordered set of the following five strings: host name, application name, database name, user login name, and user password.
 void createOlapFileObject(int objType, java.lang.String objName)
          Creates a new olap file object.
 void createReferenceCube(java.lang.String locAlias, IEssCube.EEssCubeletType clType, long limit)
          creates a reference cube.
 IEssCube.IEssSecurityFilter createSecurityFilter(java.lang.String filterName)
          Creates an security filter with empty filter rows.
 void delete()
          Deletes this cube.
 void deleteAliasTable(java.lang.String aliasTableName)
          Removes an alias table from the active database.
 void deleteAllAliasTables()
          Clears all alias tables for the active cube.
 void deleteCDF(java.lang.String appName, java.lang.String name)
          Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
 void deleteCDM(java.lang.String appName, java.lang.String name)
          Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
 void deleteLocationAlias(java.lang.String aliasName)
          Deletes an existing location alias.
 void deleteOlapFileObject(int objType, java.lang.String objName)
          Delte an existing olap file object.
 void deleteSecurityFilter(java.lang.String filterName)
          Deletes a security filter.
 java.lang.String[][] endDataload()
          marks the end of an update specification being sent to the active database, and must be called after sending the update specification using EssSendString().
 java.lang.StringBuffer endIncrementalBuildDim(short RestructOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName)
          Ends the Incremental Dimension build.
 java.lang.StringBuffer endIncrementalBuildDim(short RestructOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName, boolean addToBuffer)
          Ends the Incremental Dimension build.
 java.lang.StringBuffer endStreamBuildDim(java.lang.String ErrorFileName)
          Completes the Streaming Dimension build on this Cube.
 java.lang.StringBuffer endStreamBuildDim(java.lang.String ErrorFileName, boolean addToBuffer)
          Completes the Streaming Dimension build on this Cube.
 void endUpdate()
          Marks the end of an update specification being sent to the active database.
 void exportData(java.lang.String fileName, IEssCube.EEssDataLevel dataLevel, boolean columns)
          Exports this cube's data to a text file.
 void exportData(java.lang.String fileName, IEssCube.EEssDataLevel dataLevel, short columns)
          Deprecated. Use the other exportData method.
 int getActualBlockSize()
          Gets the actual block size.
 double getActualMaxBlocks()
          Gets the actual maximum number of blocks in the Cube.
 java.lang.String[][] getAliasTableEntries(java.lang.String aliasTableName)
          Gets the contents of the specified alias table in the active database.
 java.lang.String getAliasTableName()
          Gets the active alias table name from the active database for a user.
 java.lang.String[] getAliasTableNames()
          Gets all the alias table names in this cube.
 IEssOlapApplication getApplication()
          Gets the parent application.
 java.lang.String getApplicationName()
          Gets the parent application name.
 java.lang.String[][] getAssociatedAttributes(java.lang.String baseMbrName, java.lang.String attrDimName)
          Gets the attribute members associated with a given base member.
 java.lang.StringBuffer getAsyncProcessLog(java.lang.String ErrorFileName, boolean overwrite, boolean addToBuffer)
          Gets the async process log.
 com.essbase.api.datasource.EssBuildDimDataLoadState getAsyncProcessState()
          Gets the async process state.
 double getBlockDensity()
          Gets the average Cube block density (calculated using all currently loaded blocks).
 java.lang.String getCalcFunctions()
          Gets all calculator functions available in the application.
 java.lang.String[][] getCDM_CDF(java.lang.String appName)
          Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
 java.lang.String[] getCellDrillThroughReports(java.lang.String[] pMembers)
          Gets the drill through reports associated for the specified member combination as an array of XMLs.
 double getCompressionRatio()
          Gets the average data block compression ratio on the disk.
 int getCountDimensions()
          Gets the number of dimensions in the cube.
 int getCountLocks()
          Gets the number of data blocks currently exclusively locked.
 int getCountUsersConnected()
          Gets the number of users currently connected to the cube.
 IEssCube.EEssCubeAccess getCubeAccess()
          Gets the cube access.
 IEssCube.EEssLoadStatus getCubeLoadStatus()
          Gets cube load status.
 IEssCube.EEssCubeType getCubeType()
          Gets the cube type.
 java.lang.String getCurrencyCategoryMemberName()
          Gets the currency category dimension member.
 IEssCube.EEssCurrencyConversionType getCurrencyConvType()
          Gets the currency conversion type (whether currency conversions are calculated by multiplication or division).
 java.lang.String getCurrencyConvTypeMemberName()
          Gets the name of currency conversion type member (valid in non-currency cubes).
 java.lang.String getCurrencyCountryMemberName()
          Gets the currency country dimension member.
 java.lang.String getCurrencyCubeName()
          The name of associated currency cube (valid in non-currency Cubes).
 java.lang.String getCurrencyPartitionMemberName()
          Gets the currency partition member (non-currency cube only).
 java.lang.String getCurrencyTimeMemberName()
          Gets the currency time dimension member name.
 java.lang.String getCurrencyTypeMemberName()
          Gets the currency type dimension member (currency cube only).
 int getDataCacheSize()
          Deprecated. If the API is used against an 11.1.2.2 release 64-bit Essbase, the return value may not represent the actual size. Refer to getDataCacheSizeEx()
 long getDataCacheSizeEx()
          Gets the run-time data cache size (in Kbytes) currently in use by cube.
 long getDataFileCacheSize()
          Gets the run-time size(in bytes) of the Data Cache.
 IEssCube.EEssDataLoadStatus getDataLoadStatus()
          Gets loading state of the data in the cube.
 java.util.Hashtable<java.lang.String,java.lang.String> getDataLoadThreadErrors()
          Returns the data load thread errors in case of parallel data load involving multiple client side data files.
 int getDeclaredBlockSize()
          Gets the declared data block size.
 double getDeclaredMaxBlocks()
          Gets the declared maximum number of blocks in the Cube.
 int getDefaultAccessLevel()
          Gets the default access level to the cube.
 java.lang.String getDefaultCalcScript()
          Gets the default calc script for this active cube.
 java.lang.String getDescription()
          Gets the cube description.
 IEssDimension getDimension(java.lang.String dimName)
          Gets the dimension.
 IEssIterator getDimensions()
          Gets the list of dimensions.
 IEssURLDrillThrough getDrillThroughURL(java.lang.String URLName)
          Get the drill through URL within this database outline with specified URLName.
 int getElapsedCubeTime()
          Gets the number of seconds the cube has been loaded.
 double getExclusiveLockCount()
          Gets the number of cube blocks currently exclusively locked.
 int getIndexCacheSize()
          Gets the index cache size.
 int getIndexPageSize()
          Gets the size of index page in which buffer pool is constructed in (in bytes).
 double getInMemCompBlocks()
          Gets the number of Cube blocks currently paged into compressed memory.
 java.lang.String[][] getLocationAliases()
          Gets a list of all currently defined location aliases, together with lists of the host names, application names, database names and user names to which the location aliases are mapped.
 IEssIterator getLocks()
          Get the list of locks held on a cube.
 long getMaxMemDataFileCache()
          Gets the maximum memory reserved for compressed Data blocks in cube.
 long getMaxMemIndex()
          Gets the minimum index cache size.
 int getMaxMemNonCompBlocks()
          Deprecated. If the API is used against an 11.1.2.2 release 64-bit Essbase, the value may not represent the actual size. Refer getMaxMemNonCompBlocksEx()
 long getMaxMemNonCompBlocksEx()
          Gets the maximum memory reserved for non-compressed data blocks in the cube(in bytes).
 IEssMember getMember(java.lang.String mbrName)
          Gets the member.
 java.lang.String[] getMemberCalc(java.lang.String mbrName)
          Gets the calc equation for a specific member in the active cube outline.
 java.lang.String getName()
          Gets the cube name.
 double getNonExclusiveLockCount()
          Gets the number of cube blocks currently non-exclusively locked.
 double getNonMissingLeafBlocks()
          Gets the number of non-missing leaf (lowest level) blocks in the cube.
 double getNonMissingNonLeafBlocks()
          Gets the number of non-missing, non-leaf (upper level) blocks in the cube.
 java.lang.String getNoteOfTheDay()
          Gets this cube's note-of-the-day message.
 IEssOlapFileObject getOlapFileObject(int objType, java.lang.String objName)
          Gets information about a specified olap store file object.
 IEssIterator getOlapFileObjects(int objType)
          Gets all the olap store file objects of the types specified.
 IEssIterator getOpenCubeViews()
          Gets the list of open cube views.
 IEssCubeOutline getOutline()
          Deprecated. This method is replaced by openOutline() method.
 double getPagedInBlocks()
          Gets the total number of cube blocks currently paged into memory.
 double getPagedOutBlocks()
          Gets the number of cube blocks currently paged out to disk.
 IEssPerformAllocation getPerformAllocationInstance()
          Gets an IEssPerformAllcation instance using which Allocations can be performed.
 java.lang.String getPerformanceStatistics()
          Gets the performance statistics.
 IEssPerformCustomCalc getPerformCustomCalcInstance()
          Gets an IEssPerformCustomCalc instance using which Custom Calculations can be performed.
 IEssCube.IEssSecurityFilter getSecurityFilter(java.lang.String filterName)
          Starts getting the contents of a filter.
 IEssIterator getSecurityFilters()
          Gets all the security filters for a database.
 IEssIterator getSecurityFiltersWithNameOnly()
          Gets all the security filters for a database only with the filter name initially.
 double getSparseDensity()
          Gets the average density of the sparse dimensions in the Cube.
 double getTotalBlocks()
          Gets the total number of existing data blocks (not the maximum).
 double getTotMemBlocks()
          Gets the total memory used for all Cube blocks.
 double getTotMemIndex()
          Gets the total memory used for the cube index.
 double getTotMemInMemCompBlocks()
          Gets the total memory used for Cube blocks currently paged into compressed memory.
 double getTotMemPagedInBlocks()
          Gets the total memory used for all paged-in (uncompressed) cube blocks.
 java.lang.String getUMCData()
          Retrieves the Universal Member CommentEx.
 IEssCube.EEssCubeAccess getUserOrGroupAccess(java.lang.String userOrGroupName)
          Gets the user or group access for this cube.
 java.lang.StringBuffer incrementalBuildDim(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, int incBuildOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName)
          Performs the Dimension build and/or Data load using the specified rule and data files.
 java.lang.StringBuffer incrementalBuildDim(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, int incBuildOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName, boolean addToBuffer)
          Performs the Dimension build and/or Data load using the specified rule and data files.
 boolean isActive()
          Checks if this cube is currently active for the instance of the IEssOlapServer object (which is parent of parent to this object).
 boolean isAutoLoad()
          Checks if the Cube will be loaded automatically be loaded when the application is started.
 boolean isCalcCreateBlock()
          Checks if to force creation of data block on constant assignment calc equation (only valid for sparse dimensions).
 boolean isCalcNoAggMissing()
          Checks flag to suppress aggregation of members if all their children are missing.
 boolean isCalcNoAvgMissing()
          Checks if to suppress inclusion of missing members in calculating averages (true if missing values are not included).
 boolean isCalcTwoPass()
          Checks if to force two pass calculation when running full calculation of the cube.
 boolean isDataCompress()
          Checks flag to determine whether to compress blocks for this Cube.
 boolean isLoadable()
          Checks if the cube can be loaded/started.
 boolean isSpanRelationalSource()
          Checks if span relational source flag is set or not.
 boolean isValidMember(java.lang.String mbrName)
          Checks if a string is a valid member name within the active cube outline.
 IEssURLDrillThrough[] listDrillThroughURLs()
          Lists the drill through URLs within this database.
 com.essbase.api.datasource.EssLOADBUFFER[] listExistingLoadBuffers()
          Lists existing load buffers.
 IEssReferenceCubeInfo[] listReferenceCubes()
          returns a list of reference cubes on the target, which includes a status for each reference cube (valid or invalid, loaded or unloaded).
 com.essbase.api.datasource.EssTRANSACTION[] listTransactions(short startTimeSrc, java.lang.String startTime, short listOption, java.lang.String fileName)
          EssListTransactions() sends a request for listing transactions happened after certain time to server and retrieves an array of transaction list as requested.
 void loadAliasTable(java.lang.String aliasTableName, java.lang.String fileName)
          Loads an alias table for the active database from a structured text file.
 void loadBufferInit(long bufferId, long duplicateAggregationMethod, long options, long size)
          Creates ASO load buffer with specified ID.
 void loadBufferTerm(long[] bufferId, long commitType, long actionType, long options)
          Stores the loaded buffers.
 void loadData(boolean store, boolean unlock, java.lang.String updSpec)
          Updates data to cube from the specification string.
 java.lang.String[][] loadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError)
          Allows the importing of data from external data sources to this cube.The rule and data files can exist either on the server or the client file-system.
 java.lang.String[][] loadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError, java.lang.String userName, java.lang.String password)
          Allows the importing of data from text files to this cube.
 java.lang.String[][] loadData(java.lang.String updateSpecs, int rulesObjType, java.lang.String rulesFileName, boolean syntaxCheckOnly, boolean unlockAfterUpdate, boolean abortOnError)
          Updates data to the cube from the specified update specification string.
 java.lang.String[][] loadDataEx(boolean store, boolean unlock, java.lang.String updSpec)
          Updates data to cube from the specification string.
 java.lang.String[][] loadDataParallel(IEssCubeDataloadInstance dataloadInstance)
          Allows user to load data in parallel using multiple data files using wildcard specification ('?' or '*').
 void loadReferenceCube(java.lang.String locAlias)
          retrieves reference cube values, placing them in target memory.
 void lockOlapFileObject(int objType, java.lang.String objName)
          Locks an object on the server to prevent other users from updating it.
 void mergeDatabaseData(long options)
          Merges ASO database data.
 IEssCubeView openCubeView(java.lang.String name)
          Opens a cube view.
 IEssCubeView openCubeView(java.lang.String name, boolean useConnPool, boolean connPerOp, boolean useCluster, boolean readOnly)
          Deprecated. Use the other openCubeView method.
 IEssMemberSelection openMemberSelection(boolean usePool, boolean useCluster, java.lang.String connPoolOrClusterName, java.lang.String name)
          Deprecated. This method is deprecated. This method will work in cluster mode automatically based on whether the cube is connected to a cluster.
 IEssMemberSelection openMemberSelection(java.lang.String name)
          Opens a member selection.
 IEssMemberSelection openMemberSelection(java.lang.String name, boolean queryOverCache)
          Deprecated. This method is deprecated. QueryOverCache feature is no longer supported.
 IEssCubeOutline openOutline()
          Opens the cube outline in read-only mode.
 IEssCubeOutline openOutline(boolean dimBldOtl)
           
 IEssCubeOutline openOutline(boolean readOnly, boolean lock, boolean keepTrans)
          Opens the cube outline in read-only or read-write mode.
 IEssCubeOutline openOutline(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental)
          Opens the cube outline in read-only or read-write mode.
 java.lang.String queryMembers(java.lang.String mbrQuery)
          Performs a report-style query to list a selection of cube member information.
 void refreshPropertyValues()
          Refreshes the property values.
 void removeReferenceCube(java.lang.String locAlias)
          deletes a reference cube.
 void rename(java.lang.String newCubeName)
          Renames this cube.
 void renameOlapFileObject(int objType, java.lang.String objName, java.lang.String newObjName)
          Renames an existing olap file object.
 void replayTransactions(com.essbase.api.datasource.EssTRANSACTION_REPLAY replayTran, com.essbase.api.datasource.EssSEQID[] seqIds)
          Sends a request to replay transactions happened after certain time to agent.
 java.lang.String report(boolean output, boolean lockForUpdate, java.lang.String reportFileName, boolean isLocalFile)
          Sends a report specification to this active cube from a file.
 java.lang.String report(java.lang.String reportSpec, boolean output, boolean lockForUpdate)
          Sends a report specification to the active database as a single string.
 IEssSequentialIterator report(java.lang.String reportSpecOrFileName, boolean isFileName, boolean isLocalFile, boolean output, boolean lockForUpdate)
          Sends a report specification to the active database as a single string or from a file.
 void resetPerformanceStatisticsTables(int persistence, int scope)
          Resets values in the performance statistics tables to zero.
 void restoreDatabase(java.lang.String backupFileName, boolean forceDiffName, java.lang.String[] Src_Partitions, java.lang.String[] Dest_Partitions)
          Restores the database with the data from the specified backup file.
 void restructure(short restructOption)
          Restructures the outline on the server.
 void sendString(java.lang.String str)
          Sends a string of data to the active database.
 void setActive()
          Sets this cube active for the instance of the IEssOlapServer object (which is parent of parent to this object).
 void setAliasTableName(java.lang.String aliasTableName)
          Sets the active alias table in the active database for a user.
 void setAutoLoad(boolean autoLoad)
          Sets whether the Cube will be loaded automatically when the application is started.
 void setCalcCreateBlock(boolean value)
          Sets flag to force creation of data block on constant assignment calc equation (only valid for sparse dimensions).
 void setCalcNoAggMissing(boolean value)
          Sets to suppress aggregation of members if all their children are missing.
 void setCalcNoAvgMissing(boolean value)
          Sets to suppress inclusion of missing members in calculating averages.
 void setCalcTwoPass(boolean twoPass)
          Sets to force two pass calculation when running full calculation of cube.
 void setCubeAccess(IEssCube.EEssCubeAccess access)
          Sets the cube access.
 void setCurrencyConvType(IEssCube.EEssCurrencyConversionType convType)
          Sets the currency conversion type (whether currency conversions are calculated by multiplication or division).
 void setCurrencyConvTypeMemberName(java.lang.String mbrName)
          Sets the name of currency conversion type member (valid in non-currency cubes).
 void setCurrencyCubeName(java.lang.String dbName)
          Sets the name of associated currency cube (valid in non-currency cCubes).
 void setDataCompress(boolean dataCompress)
          Sets flag to determine whether to compress blocks for this cube.
 void setDefaultAccessLevel(int accessLevel)
          Sets the default access level to the cube.
 void setDefaultCalcScript(boolean isFileName, java.lang.String defCalcScriptOrFile)
          Sets the default calc script for this active cube.
 void setDescription(java.lang.String desc)
          Sets the cube description.
 void setIndexPageSize(int size)
          Sets the size of index page in which buffer pool is constructed in (in bytes).
 void setLoadable(boolean loadable)
          Sets if the cube can be loaded/started.
 void setMaxMemDataFileCache(long MaxMemDataFileCache)
          Sets the maximum memory reserved for compressed data blocks in cube.
 void setMaxMemIndex(long MaxMemIndex)
          Sets the minimum index cache size value.
 void setMaxMemNonCompBlocks(int memSize)
          Deprecated. Refer setMaxMemNonCompBlocks(long)
 void setMaxMemNonCompBlocks(long memSize)
          Sets the maximum memory reserved for non-compressed data blocks in the cube(in bytes).
 void setNoteOfTheDay(java.lang.String note)
          Sets this cube's note-of-the-day message.
 IEssCube.IEssSecurityFilter setSecurityFilter(java.lang.String filterName, boolean Active, IEssCube.EEssCubeAccess Access)
          Creates or replaces a filter, and starts setting the contents of the filter.
 void setSecurityFilterList(IEssCube.IEssSecurityFilter filter, java.lang.String[] usersAndOrGroups)
          Sets the list of groups and/or users that are assigned to a filter.
 void setSpanRelationalSource(boolean span)
          Sets (or clears) an intenal boolean field informing essbase that pertinent data exists (or not exists) in an attached relational store.
 void setUMCData(java.lang.String UMC)
          Sets the Universal Member CommentEx to the outline without having to restructure the outline.
 void setUserOrGroupAccess(java.lang.String userOrGroupName, IEssCube.EEssCubeAccess access)
          Sets the user or group access for this cube.
 void start()
          Starts/Loads a cube within an Application on the server.
 void stop()
          Stops/Unloads a cube within an application on the server.
 void unloadReferenceCube(java.lang.String locAlias)
          removes reference cube values from target memory.
 void unlockOlapFileObject(int objType, java.lang.String objName)
          Unlocks a locked object on the server.
 void updatePropertyValues()
          Updates the property values.
 void validateCube(java.lang.String errLogFileName)
          Checks the cube for data integrity.
 boolean verifyFormula(java.lang.String formulaName)
          Verified the formula.
 boolean verifyMDXExpression(java.lang.String mdxExpression, long exprType, java.util.List outErrorsIfAny)
          Validates the MDX expression based on its type, against this cube.

 

Methods inherited from interface com.essbase.api.base.IEssExtendedObject
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

 

Methods inherited from interface com.essbase.api.base.IEssProperties
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny

 

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

 

Methods inherited from interface com.essbase.api.datasource.IEssSubstitutionVariables
createSubstitutionVariable, deleteSubstitutionVariable, getSubstitutionVariables, getSubstitutionVariableValue

 

Field Detail

PROP_NAME

static final int PROP_NAME
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_IS_LODABLE

static final int PROP_IS_LODABLE
See Also:
Constant Field Values

PROP_IS_AUTOLOAD

static final int PROP_IS_AUTOLOAD
See Also:
Constant Field Values

PROP_CUBE_ACCESS

static final int PROP_CUBE_ACCESS
See Also:
Constant Field Values

PROP_MAX_MEM_NON_COMP_BLOCKS

static final int PROP_MAX_MEM_NON_COMP_BLOCKS
See Also:
Constant Field Values

PROP_IS_CALC_NO_AGG_MISSING

static final int PROP_IS_CALC_NO_AGG_MISSING
See Also:
Constant Field Values

PROP_IS_CALC_NO_AVG_MISSING

static final int PROP_IS_CALC_NO_AVG_MISSING
See Also:
Constant Field Values

PROP_IS_CALC_TWO_PASS

static final int PROP_IS_CALC_TWO_PASS
See Also:
Constant Field Values

PROP_DATA_COMPRESS

static final int PROP_DATA_COMPRESS
See Also:
Constant Field Values

PROP_CALC_CREATE_BLOCK

static final int PROP_CALC_CREATE_BLOCK
See Also:
Constant Field Values

PROP_CURRENCY_CUBE_NAME

static final int PROP_CURRENCY_CUBE_NAME
See Also:
Constant Field Values

PROP_CURRENCY_CONV_TYPE_MEMBER_NAME

static final int PROP_CURRENCY_CONV_TYPE_MEMBER_NAME
See Also:
Constant Field Values

PROP_CURRENCY_CONV_TYPE

static final int PROP_CURRENCY_CONV_TYPE
See Also:
Constant Field Values

PROP_INDEX_PAGE_SIZE

static final int PROP_INDEX_PAGE_SIZE
See Also:
Constant Field Values

PROP_INDEX_CACHE_SIZE

static final int PROP_INDEX_CACHE_SIZE
See Also:
Constant Field Values

PROP_APPLICATION_NAME

static final int PROP_APPLICATION_NAME
See Also:
Constant Field Values

PROP_CUBE_TYPE

static final int PROP_CUBE_TYPE
See Also:
Constant Field Values

PROP_CUBE_LOAD_STATUS

static final int PROP_CUBE_LOAD_STATUS
See Also:
Constant Field Values

PROP_COUNT_OF_USERS_CONNECTED

static final int PROP_COUNT_OF_USERS_CONNECTED
See Also:
Constant Field Values

PROP_COUNT_OF_LOCKS

static final int PROP_COUNT_OF_LOCKS
See Also:
Constant Field Values

PROP_COUNT_OF_DIMENSIONS

static final int PROP_COUNT_OF_DIMENSIONS
See Also:
Constant Field Values

PROP_DATA_LOAD_STATUS

static final int PROP_DATA_LOAD_STATUS
See Also:
Constant Field Values

PROP_ELAPSED_CUBE_TIME

static final int PROP_ELAPSED_CUBE_TIME
See Also:
Constant Field Values

PROP_CURRENCY_COUNTRY_MEMBER

static final int PROP_CURRENCY_COUNTRY_MEMBER
See Also:
Constant Field Values

PROP_CURRENCY_TIME_MEMBER

static final int PROP_CURRENCY_TIME_MEMBER
See Also:
Constant Field Values

PROP_CURRENCY_CATEGORY_MEMBER

static final int PROP_CURRENCY_CATEGORY_MEMBER
See Also:
Constant Field Values

PROP_CURRENCY_PARTITION_MEMBER

static final int PROP_CURRENCY_PARTITION_MEMBER
See Also:
Constant Field Values

PROP_CURRENCY_TYPE_MEMBER

static final int PROP_CURRENCY_TYPE_MEMBER
See Also:
Constant Field Values

PROP_DATA_CACHE_SIZE

static final int PROP_DATA_CACHE_SIZE
See Also:
Constant Field Values

PROP_DECLARED_BLOCK_SIZE

static final int PROP_DECLARED_BLOCK_SIZE
See Also:
Constant Field Values

PROP_ACTUAL_BLOCK_SIZE

static final int PROP_ACTUAL_BLOCK_SIZE
See Also:
Constant Field Values

PROP_DECLARED_MAX_BLOCKS

static final int PROP_DECLARED_MAX_BLOCKS
See Also:
Constant Field Values

PROP_ACTUAL_MAX_BLOCKS

static final int PROP_ACTUAL_MAX_BLOCKS
See Also:
Constant Field Values

PROP_NON_MISSING_LEAF_BLOCKS

static final int PROP_NON_MISSING_LEAF_BLOCKS
See Also:
Constant Field Values

PROP_PAGED_OUT_BLOCKS

static final int PROP_PAGED_OUT_BLOCKS
See Also:
Constant Field Values

PROP_PAGED_IN_BLOCKS

static final int PROP_PAGED_IN_BLOCKS
See Also:
Constant Field Values

PROP_TOTAL_BLOCKS

static final int PROP_TOTAL_BLOCKS
See Also:
Constant Field Values

PROP_NON_EXCLUSIVE_LOCK_COUNT

static final int PROP_NON_EXCLUSIVE_LOCK_COUNT
See Also:
Constant Field Values

PROP_EXCLUSIVE_LOCK_COUNT

static final int PROP_EXCLUSIVE_LOCK_COUNT
See Also:
Constant Field Values

PROP_TOTAL_MEMORY_PAGED_IN_BLOCKS

static final int PROP_TOTAL_MEMORY_PAGED_IN_BLOCKS
See Also:
Constant Field Values

PROP_TOTAL_MEMORY_ALL_BLOCKS

static final int PROP_TOTAL_MEMORY_ALL_BLOCKS
See Also:
Constant Field Values

PROP_TOTAL_MEMORY_FOR_INDEX

static final int PROP_TOTAL_MEMORY_FOR_INDEX
See Also:
Constant Field Values

PROP_COUNT_OF_NON_MISSING_NON_LEAF_BLOCKS

static final int PROP_COUNT_OF_NON_MISSING_NON_LEAF_BLOCKS
See Also:
Constant Field Values

PROP_BLOCK_DENSITY

static final int PROP_BLOCK_DENSITY
See Also:
Constant Field Values

PROP_SPARSE_DENSITY

static final int PROP_SPARSE_DENSITY
See Also:
Constant Field Values

PROP_COMPRESSION_RATIO

static final int PROP_COMPRESSION_RATIO
See Also:
Constant Field Values

PROP_COUNT_OF_INMEM_COMPRESSED_BLOCKS

static final int PROP_COUNT_OF_INMEM_COMPRESSED_BLOCKS
See Also:
Constant Field Values

PROP_TOTAL_MEMORY_FOR_INMEM_COMPRESSED_BLOCKS

static final int PROP_TOTAL_MEMORY_FOR_INMEM_COMPRESSED_BLOCKS
See Also:
Constant Field Values

PROP_DATA_CACHE_SETTING

static final int PROP_DATA_CACHE_SETTING
See Also:
Constant Field Values

PROP_DATAFILE_CACHE_SIZE

static final int PROP_DATAFILE_CACHE_SIZE
See Also:
Constant Field Values

PROP_DATAFILE_CACHE_SETTING

static final int PROP_DATAFILE_CACHE_SETTING
See Also:
Constant Field Values

PROP_INDEX_CACHE_SETTING

static final int PROP_INDEX_CACHE_SETTING
See Also:
Constant Field Values

PROP_INDEX_PAGE_SETTING

static final int PROP_INDEX_PAGE_SETTING
See Also:
Constant Field Values

PROP_RETRIEVAL_BUFFER

static final int PROP_RETRIEVAL_BUFFER
See Also:
Constant Field Values

PROP_RETRIEVAL_SORT_BUFFER

static final int PROP_RETRIEVAL_SORT_BUFFER
See Also:
Constant Field Values

PROP_CACHE_MEMORY_LOCKING

static final int PROP_CACHE_MEMORY_LOCKING
See Also:
Constant Field Values

PROP_ISOLATION_LEVEL

static final int PROP_ISOLATION_LEVEL
See Also:
Constant Field Values

PROP_PRE_EMAGE

static final int PROP_PRE_EMAGE
See Also:
Constant Field Values

PROP_COMMIT_BLOCKS

static final int PROP_COMMIT_BLOCKS
See Also:
Constant Field Values

PROP_COMMIT_ROWS

static final int PROP_COMMIT_ROWS
See Also:
Constant Field Values

PROP_DATA_COMPRESS_TYPE

static final int PROP_DATA_COMPRESS_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_INCDIMBUILD_BUILD

static final int ESS_INCDIMBUILD_BUILD
See Also:
Constant Field Values

ESS_INCDIMBUILD_VERIFY

static final int ESS_INCDIMBUILD_VERIFY
See Also:
Constant Field Values

ESS_INCDIMBUILD_SAVEOTL

static final int ESS_INCDIMBUILD_SAVEOTL
See Also:
Constant Field Values

ESS_INCDIMBUILD_ALL

static final int ESS_INCDIMBUILD_ALL
See Also:
Constant Field Values

ESS_INCDIMBUILD_RESTRUCT_OPT1

static final short ESS_INCDIMBUILD_RESTRUCT_OPT1
See Also:
Constant Field Values

ESS_DOR_ALLDATA

static final short ESS_DOR_ALLDATA
See Also:
Constant Field Values

ESS_DOR_NODATA

static final short ESS_DOR_NODATA
See Also:
Constant Field Values

ESS_DOR_LOWDATA

static final short ESS_DOR_LOWDATA
See Also:
Constant Field Values

ESS_DOR_INDATA

static final short ESS_DOR_INDATA
See Also:
Constant Field Values

ESS_DOR_FORCE_ALLDATA

static final short ESS_DOR_FORCE_ALLDATA
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD

static final long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL

static final long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST

static final long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES

static final long ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES

static final long ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA

static final long ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA

static final long ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA

static final long ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA

static final long ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA

static final long ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_COMMIT

static final long ESS_ASO_DATA_LOAD_BUFFER_COMMIT
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_BUFFER_ABORT

static final long ESS_ASO_DATA_LOAD_BUFFER_ABORT
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE

static final long ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE

static final long ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE_LIGHTWEIGHT

static final long ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE_LIGHTWEIGHT
See Also:
Constant Field Values

ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK

static final long ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK
See Also:
Constant Field Values

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_LIST_TRANSACTIONS_TOCLIENT

static final short ESS_LIST_TRANSACTIONS_TOCLIENT
See Also:
Constant Field Values

ESS_LIST_TRANSACTIONS_TOFILE

static final short ESS_LIST_TRANSACTIONS_TOFILE
See Also:
Constant Field Values

ESS_LIST_TRANSACTIONS_FORCETOFILE

static final short ESS_LIST_TRANSACTIONS_FORCETOFILE
See Also:
Constant Field Values

ESS_ASO_VERIFY_MEMBER_EXPR

static final long ESS_ASO_VERIFY_MEMBER_EXPR
See Also:
Constant Field Values

ESS_ASO_VERIFY_TUPLE_EXPR

static final long ESS_ASO_VERIFY_TUPLE_EXPR
See Also:
Constant Field Values

ESS_ASO_VERIFY_SET_EXPR

static final long ESS_ASO_VERIFY_SET_EXPR
See Also:
Constant Field Values

ESS_ASO_VERIFY_NUMERIC_EXPR

static final long ESS_ASO_VERIFY_NUMERIC_EXPR
See Also:
Constant Field Values

ESS_BLDDL_STATE_DONE

static final short ESS_BLDDL_STATE_DONE
See Also:
Constant Field Values

ESS_BLDDL_STATE_INPROGRESS

static final short ESS_BLDDL_STATE_INPROGRESS
See Also:
Constant Field Values

ESS_BLDDL_STATE_FINALSTAGE

static final short ESS_BLDDL_STATE_FINALSTAGE
See Also:
Constant Field Values

ESS_BLDDL_STAGE_NONE

static final short ESS_BLDDL_STAGE_NONE
See Also:
Constant Field Values

ESS_BLDDL_STAGE_OPENDATASOURCE

static final short ESS_BLDDL_STAGE_OPENDATASOURCE
See Also:
Constant Field Values

ESS_BLDDL_STAGE_OPENOTL

static final short ESS_BLDDL_STAGE_OPENOTL
See Also:
Constant Field Values

ESS_BLDDL_STAGE_BUILDOTL

static final short ESS_BLDDL_STAGE_BUILDOTL
See Also:
Constant Field Values

ESS_BLDDL_STAGE_VERIFYOTL

static final short ESS_BLDDL_STAGE_VERIFYOTL
See Also:
Constant Field Values

ESS_BLDDL_STAGE_WRITEOTL

static final short ESS_BLDDL_STAGE_WRITEOTL
See Also:
Constant Field Values

ESS_BLDDL_STAGE_RESTRUCT

static final short ESS_BLDDL_STAGE_RESTRUCT
See Also:
Constant Field Values

ESS_BLDDL_STAGE_DATALOAD

static final short ESS_BLDDL_STAGE_DATALOAD
See Also:
Constant Field Values

ESS_BLDDL_STAGE_FINALIZE

static final short ESS_BLDDL_STAGE_FINALIZE
See Also:
Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the cube name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

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

setDescription

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

isLoadable

boolean isLoadable()
                   throws com.essbase.api.base.EssException
Checks if the cube can be loaded/started.
Returns:
true if the cube is loadable.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setLoadable

void setLoadable(boolean loadable)
                 throws com.essbase.api.base.EssException
Sets if the cube can be loaded/started. The change will become effective after you invoke updatePropertyValues().
Parameters:
loadable - true if the Cube is loadable.
Throws:
com.essbase.api.base.EssException - if an error occurs..

isAutoLoad

boolean isAutoLoad()
                   throws com.essbase.api.base.EssException
Checks if the Cube will be loaded automatically be loaded when the application is started.
Returns:
true if the Cube will be automatically loaded.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setAutoLoad

void setAutoLoad(boolean autoLoad)
                 throws com.essbase.api.base.EssException
Sets whether the Cube will be loaded automatically when the application is started. The change will become effective after you invoke updatePropertyValues().
Parameters:
autoLoad - true if the Cube will be automatically loaded.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getCubeAccess

IEssCube.EEssCubeAccess getCubeAccess()
                                      throws com.essbase.api.base.EssException
Gets the cube access.
Returns:
The cube access.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
getUserOrGroupAccess(String)

setCubeAccess

void setCubeAccess(IEssCube.EEssCubeAccess access)
                   throws com.essbase.api.base.EssException
Sets the cube access. The change will become effective after you invoke updatePropertyValues().
Parameters:
access - The cube access.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
setUserOrGroupAccess(String, IEssCube.EEssCubeAccess)

getDataFileCacheSize

long getDataFileCacheSize()
                          throws com.essbase.api.base.EssException
Gets the run-time size(in bytes) of the Data Cache.
Returns:
DataFileCacheSize - long, the memory (in bytes).
Throws:
com.essbase.api.base.EssException - if an error occurs..
Since:
11.1.2.2

getMaxMemNonCompBlocks

int getMaxMemNonCompBlocks()
                           throws com.essbase.api.base.EssException
Deprecated. If the API is used against an 11.1.2.2 release 64-bit Essbase, the value may not represent the actual size. Refer getMaxMemNonCompBlocksEx()
Gets the maximum memory reserved for non-compressed data blocks in the cube(in bytes).
Returns:
The maximum memory reserved (in bytes).
Throws:
com.essbase.api.base.EssException - if an error occurs..

getMaxMemNonCompBlocksEx

long getMaxMemNonCompBlocksEx()
                              throws com.essbase.api.base.EssException
Gets the maximum memory reserved for non-compressed data blocks in the cube(in bytes). Replaces old API getMaxMemNonCompBlocks().
Returns:
MaxMem, unsigned long, the maximum memory reserved (in bytes).
Throws:
com.essbase.api.base.EssException - if an error occurs..
Since:
11.1.2.2

setMaxMemNonCompBlocks

void setMaxMemNonCompBlocks(int memSize)
                            throws com.essbase.api.base.EssException
Deprecated. Refer setMaxMemNonCompBlocks(long)
Sets the maximum memory reserved for non-compressed data blocks in the cube(in bytes). The change will become effective after you invoke updatePropertyValues().
Parameters:
memSize - The maximum memory reserved (in bytes).
Throws:
com.essbase.api.base.EssException - if an error occurs..

setMaxMemNonCompBlocks

void setMaxMemNonCompBlocks(long memSize)
                            throws com.essbase.api.base.EssException
Sets the maximum memory reserved for non-compressed data blocks in the cube(in bytes). Allows 64-bit memory size values against 11.1.2.2 64-bit Essbase. The change will become effective after you invoke updatePropertyValues().
Parameters:
memSize - The maximum memory reserved (in bytes).
Throws:
com.essbase.api.base.EssException - if an error occurs..

getMaxMemDataFileCache

long getMaxMemDataFileCache()
                            throws com.essbase.api.base.EssException
Gets the maximum memory reserved for compressed Data blocks in cube.
Returns:
long - unsigned MaxMemDataFileCache
Throws:
com.essbase.api.base.EssException
Since:
11.1.2.2

setMaxMemDataFileCache

void setMaxMemDataFileCache(long MaxMemDataFileCache)
                            throws com.essbase.api.base.EssException
Sets the maximum memory reserved for compressed data blocks in cube.
Parameters:
long - - unsigned MaxMemDataFileCache
Throws:
com.essbase.api.base.EssException
Since:
11.1.2.2

isCalcNoAggMissing

boolean isCalcNoAggMissing()
                           throws com.essbase.api.base.EssException
Checks flag to suppress aggregation of members if all their children are missing.
Returns:
true if missing values are not aggregated.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCalcNoAggMissing

void setCalcNoAggMissing(boolean value)
                         throws com.essbase.api.base.EssException
Sets to suppress aggregation of members if all their children are missing. The change will become effective after you invoke updatePropertyValues().
Parameters:
value - true if missing values are not aggregated.
Throws:
com.essbase.api.base.EssException - if an error occurs..

isCalcNoAvgMissing

boolean isCalcNoAvgMissing()
                           throws com.essbase.api.base.EssException
Checks if to suppress inclusion of missing members in calculating averages (true if missing values are not included).
Returns:
true if missing values are not aggregated.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCalcNoAvgMissing

void setCalcNoAvgMissing(boolean value)
                         throws com.essbase.api.base.EssException
Sets to suppress inclusion of missing members in calculating averages. The change will become effective after you invoke updatePropertyValues().
Parameters:
value - true if missing values are not included.
Throws:
com.essbase.api.base.EssException - if an error occurs..

isCalcTwoPass

boolean isCalcTwoPass()
                      throws com.essbase.api.base.EssException
Checks if to force two pass calculation when running full calculation of the cube.
Returns:
true if two pass calculation is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCalcTwoPass

void setCalcTwoPass(boolean twoPass)
                    throws com.essbase.api.base.EssException
Sets to force two pass calculation when running full calculation of cube. The change will become effective after you invoke updatePropertyValues().
Parameters:
twoPass - true if two pass calculation is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs..

isDataCompress

boolean isDataCompress()
                       throws com.essbase.api.base.EssException
Checks flag to determine whether to compress blocks for this Cube.
Returns:
true is compress blocks is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setDataCompress

void setDataCompress(boolean dataCompress)
                     throws com.essbase.api.base.EssException
Sets flag to determine whether to compress blocks for this cube. The change will become effective after you invoke updatePropertyValues().
Parameters:
dataCompress - true if compression is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs..

isCalcCreateBlock

boolean isCalcCreateBlock()
                          throws com.essbase.api.base.EssException
Checks if to force creation of data block on constant assignment calc equation (only valid for sparse dimensions).
Returns:
true if blocks are forcibly created.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCalcCreateBlock

void setCalcCreateBlock(boolean value)
                        throws com.essbase.api.base.EssException
Sets flag to force creation of data block on constant assignment calc equation (only valid for sparse dimensions). The change will become effective after you invoke updatePropertyValues().
Parameters:
value - true, if blocks are forcibly created.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getCurrencyCubeName

java.lang.String getCurrencyCubeName()
                                     throws com.essbase.api.base.EssException
The name of associated currency cube (valid in non-currency Cubes).
Returns:
The currency Cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCurrencyCubeName

void setCurrencyCubeName(java.lang.String dbName)
                         throws com.essbase.api.base.EssException
Sets the name of associated currency cube (valid in non-currency cCubes). The change will become effective after you invoke updatePropertyValues().
Parameters:
dbName - The currency cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getCurrencyConvTypeMemberName

java.lang.String getCurrencyConvTypeMemberName()
                                               throws com.essbase.api.base.EssException
Gets the name of currency conversion type member (valid in non-currency cubes).
Returns:
The name of the currency conversion type member.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCurrencyConvTypeMemberName

void setCurrencyConvTypeMemberName(java.lang.String mbrName)
                                   throws com.essbase.api.base.EssException
Sets the name of currency conversion type member (valid in non-currency cubes). The change will become effective after you invoke updatePropertyValues().
Parameters:
mbrName - The currency conversion type member name.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getCurrencyConvType

IEssCube.EEssCurrencyConversionType getCurrencyConvType()
                                                        throws com.essbase.api.base.EssException
Gets the currency conversion type (whether currency conversions are calculated by multiplication or division).
Returns:
The currency conversion type.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setCurrencyConvType

void setCurrencyConvType(IEssCube.EEssCurrencyConversionType convType)
                         throws com.essbase.api.base.EssException
Sets the currency conversion type (whether currency conversions are calculated by multiplication or division). The change will become effective after you invoke updatePropertyValues().
Parameters:
convType - The currency conversion type.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getMaxMemIndex

long getMaxMemIndex()
                    throws com.essbase.api.base.EssException
Gets the minimum index cache size. Default value:1048576.
Returns:
long MaxMemIndex
Throws:
com.essbase.api.base.EssException
Since:
11.1.2.2

setMaxMemIndex

void setMaxMemIndex(long MaxMemIndex)
                    throws com.essbase.api.base.EssException
Sets the minimum index cache size value.
Parameters:
MaxMemIndex - - long
Throws:
com.essbase.api.base.EssException
Since:
11.1.2.2

getIndexPageSize

int getIndexPageSize()
                     throws com.essbase.api.base.EssException
Gets the size of index page in which buffer pool is constructed in (in bytes).
Returns:
The index page size.
Throws:
com.essbase.api.base.EssException - if an error occurs..

setIndexPageSize

void setIndexPageSize(int size)
                      throws com.essbase.api.base.EssException
Sets the size of index page in which buffer pool is constructed in (in bytes). Minimum index page size is 1024 and the maximum is 8192. The change will become effective after you invoke updatePropertyValues().
Parameters:
size - The size of the index page (in bytes).
Throws:
com.essbase.api.base.EssException - if an error occurs..

getIndexCacheSize

int getIndexCacheSize()
                      throws com.essbase.api.base.EssException
Gets the index cache size.
Returns:
The index cache size.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getDefaultAccessLevel

int getDefaultAccessLevel()
                          throws com.essbase.api.base.EssException
Gets the default access level to the cube.
Returns:
The default access level. Combination of values from IEssCube.ESS_PRIV_* / IEssCube.ESS_ACCESS_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDefaultAccessLevel

void setDefaultAccessLevel(int accessLevel)
                           throws com.essbase.api.base.EssException
Sets the default access level to the cube. The change will become effective after you invoke updatePropertyValues().
Parameters:
accessLevel - The default access level. Combination of values from IEssCube.ESS_PRIV_* / IEssCube.ESS_ACCESS_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApplicationName

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

getCubeType

IEssCube.EEssCubeType getCubeType()
                                  throws com.essbase.api.base.EssException
Gets the cube type.
Returns:
The cube type.
Throws:
com.essbase.api.base.EssException - if an error occurs..

getCubeLoadStatus

IEssCube.EEssLoadStatus getCubeLoadStatus()
                                          throws com.essbase.api.base.EssException
Gets cube load status.
Returns:
The cube load status.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountUsersConnected

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

getCountLocks

int getCountLocks()
                  throws com.essbase.api.base.EssException
Gets the number of data blocks currently exclusively locked.
Returns:
The number of data blocks exclusively locked.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountDimensions

int getCountDimensions()
                       throws com.essbase.api.base.EssException
Gets the number of dimensions in the cube.
Returns:
The count of dimensions.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDataLoadStatus

IEssCube.EEssDataLoadStatus getDataLoadStatus()
                                              throws com.essbase.api.base.EssException
Gets loading state of the data in the cube.
Returns:
The data load status.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getElapsedCubeTime

int getElapsedCubeTime()
                       throws com.essbase.api.base.EssException
Gets the number of seconds the cube has been loaded.
Returns:
The elapsed dabase time (in seconds).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyCountryMemberName

java.lang.String getCurrencyCountryMemberName()
                                              throws com.essbase.api.base.EssException
Gets the currency country dimension member.
Returns:
The currency country dimension member. null, if none.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyTimeMemberName

java.lang.String getCurrencyTimeMemberName()
                                           throws com.essbase.api.base.EssException
Gets the currency time dimension member name.
Returns:
The currency time dimension member name. null, if none.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyCategoryMemberName

java.lang.String getCurrencyCategoryMemberName()
                                               throws com.essbase.api.base.EssException
Gets the currency category dimension member.
Returns:
The currency category dimension member. null if none.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyPartitionMemberName

java.lang.String getCurrencyPartitionMemberName()
                                                throws com.essbase.api.base.EssException
Gets the currency partition member (non-currency cube only).
Returns:
The currency partition member name. null if none.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCurrencyTypeMemberName

java.lang.String getCurrencyTypeMemberName()
                                           throws com.essbase.api.base.EssException
Gets the currency type dimension member (currency cube only).
Returns:
The currency type member name. null if none exists.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDataCacheSize

int getDataCacheSize()
                     throws com.essbase.api.base.EssException
Deprecated. If the API is used against an 11.1.2.2 release 64-bit Essbase, the return value may not represent the actual size. Refer to getDataCacheSizeEx()
Gets the run-time data cache size (in Kbytes) currently in use by cube. Note that once you have changed the data cache size you must stop and restart the cube in order for the new data cache size to take effect.
Returns:
The data cache size (in Kbytes).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDataCacheSizeEx

long getDataCacheSizeEx()
                        throws com.essbase.api.base.EssException
Gets the run-time data cache size (in Kbytes) currently in use by cube. Note that once you have changed the data cache size you must stop and restart the cube in order for the new data cache size to take effect.
Returns:
The data cache size (in Kbytes).
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.2.2

getDeclaredBlockSize

int getDeclaredBlockSize()
                         throws com.essbase.api.base.EssException
Gets the declared data block size.
Returns:
The declared block size.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getActualBlockSize

int getActualBlockSize()
                       throws com.essbase.api.base.EssException
Gets the actual block size.
Returns:
The actual block size.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDeclaredMaxBlocks

double getDeclaredMaxBlocks()
                            throws com.essbase.api.base.EssException
Gets the declared maximum number of blocks in the Cube.
Returns:
The declared maximum number of blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getActualMaxBlocks

double getActualMaxBlocks()
                          throws com.essbase.api.base.EssException
Gets the actual maximum number of blocks in the Cube.
Returns:
The actual maximum number of blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNonMissingLeafBlocks

double getNonMissingLeafBlocks()
                               throws com.essbase.api.base.EssException
Gets the number of non-missing leaf (lowest level) blocks in the cube.
Returns:
The number of non-missing leaf blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getPagedOutBlocks

double getPagedOutBlocks()
                         throws com.essbase.api.base.EssException
Gets the number of cube blocks currently paged out to disk.
Returns:
The number of paged out blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getPagedInBlocks

double getPagedInBlocks()
                        throws com.essbase.api.base.EssException
Gets the total number of cube blocks currently paged into memory.
Returns:
The count of paged in blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTotalBlocks

double getTotalBlocks()
                      throws com.essbase.api.base.EssException
Gets the total number of existing data blocks (not the maximum).
Returns:
The count of total blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNonExclusiveLockCount

double getNonExclusiveLockCount()
                                throws com.essbase.api.base.EssException
Gets the number of cube blocks currently non-exclusively locked.
Returns:
The count of non-exclusively locked blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getExclusiveLockCount

double getExclusiveLockCount()
                             throws com.essbase.api.base.EssException
Gets the number of cube blocks currently exclusively locked.
Returns:
The exclusive lock count.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTotMemPagedInBlocks

double getTotMemPagedInBlocks()
                              throws com.essbase.api.base.EssException
Gets the total memory used for all paged-in (uncompressed) cube blocks.
Returns:
The total memory used for all paged-in blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTotMemBlocks

double getTotMemBlocks()
                       throws com.essbase.api.base.EssException
Gets the total memory used for all Cube blocks.
Returns:
The total memory used for all Cube blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTotMemIndex

double getTotMemIndex()
                      throws com.essbase.api.base.EssException
Gets the total memory used for the cube index.
Returns:
The total memory used for the Cube index.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNonMissingNonLeafBlocks

double getNonMissingNonLeafBlocks()
                                  throws com.essbase.api.base.EssException
Gets the number of non-missing, non-leaf (upper level) blocks in the cube.
Returns:
The number of non-missing, non-leaf blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getBlockDensity

double getBlockDensity()
                       throws com.essbase.api.base.EssException
Gets the average Cube block density (calculated using all currently loaded blocks).
Returns:
The block density.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getSparseDensity

double getSparseDensity()
                        throws com.essbase.api.base.EssException
Gets the average density of the sparse dimensions in the Cube.
Returns:
The sparse density.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCompressionRatio

double getCompressionRatio()
                           throws com.essbase.api.base.EssException
Gets the average data block compression ratio on the disk.
Returns:
The compression ratio.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getInMemCompBlocks

double getInMemCompBlocks()
                          throws com.essbase.api.base.EssException
Gets the number of Cube blocks currently paged into compressed memory.
Returns:
The number of Cube blocks.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTotMemInMemCompBlocks

double getTotMemInMemCompBlocks()
                                throws com.essbase.api.base.EssException
Gets the total memory used for Cube blocks currently paged into compressed memory.
Returns:
The total memory used.
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.

getLocks

IEssIterator getLocks()
                      throws com.essbase.api.base.EssException
Get the list of locks held on a cube.
Returns:
The cube locks (each of type IEssCube.IEssCubeLock).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOutline

IEssCubeOutline getOutline()
                           throws com.essbase.api.base.EssException
Deprecated. This method is replaced by openOutline() method.
Gets the cube outline.
Returns:
The cube outline.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openOutline

IEssCubeOutline openOutline()
                            throws com.essbase.api.base.EssException
Opens the cube outline in read-only mode.
Returns:
The cube outline.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openOutline

IEssCubeOutline openOutline(boolean dimBldOtl)
                            throws com.essbase.api.base.EssException
Throws:
com.essbase.api.base.EssException

openOutline

IEssCubeOutline openOutline(boolean readOnly,
                            boolean lock,
                            boolean keepTrans)
                            throws com.essbase.api.base.EssException
Opens the cube outline in read-only or read-write mode.
Parameters:
readOnly - true to open the outline in read-only mode. false to open the outline in read-write mode.
lock - true if the outline should be locked when it is opened in any mode.
keepTrans - true to keep transactions. If you are opening an existing outline to make changes (readOnly == false), and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory.
Returns:
The cube outline.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openOutline

IEssCubeOutline openOutline(boolean readOnly,
                            boolean lock,
                            boolean keepTrans,
                            boolean incremental)
                            throws com.essbase.api.base.EssException
Opens the cube outline in read-only or read-write mode.
Parameters:
readOnly - true to open the outline in read-only mode. false to open the outline in read-write mode.
lock - true if the outline should be locked when it is opened in any mode.
keepTrans - true to keep transactions. If you are opening an existing outline to make changes (readOnly == false), and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory.
incremental - true if the outline should be opened in incremental mode.
Returns:
The cube outline.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openMemberSelection

IEssMemberSelection openMemberSelection(java.lang.String name)
                                        throws com.essbase.api.base.EssException
Opens a member selection. JAPI opens and shares a single connection with Essbase between all its interfaces for each JAPI session. JAPI uses counters to track the number of interfaces using the connection based on the IEssCube.openCubeView/IEssDomain.openCubeView/IEssCube.openMemberSelection() calls and hence the number of IEssMemberSelection.close() calls should match the number of openMemberSelection() calls for a proper closure of the connection.
Parameters:
name - The name for the member selection.
Returns:
The member selection.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openMemberSelection

IEssMemberSelection openMemberSelection(boolean usePool,
                                        boolean useCluster,
                                        java.lang.String connPoolOrClusterName,
                                        java.lang.String name)
                                        throws com.essbase.api.base.EssException
Deprecated. This method is deprecated. This method will work in cluster mode automatically based on whether the cube is connected to a cluster.
Opens a member selection.
Parameters:
usePool - true to use connection pool.
useCluster - true to use cluster if available.
connPoolOrClusterName - - connection pool or cluster name to use. If usePool is true, this parameter represents connection pool name, else this parameter represents cluster name. If this parameter is null, a connection pool or a cluster will be chosen, if available, based on the values of other parameters. If it is not null then it should be a valid active connection pool or cluster name.
name - The name for the member selection.
Returns:
The member selection.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openMemberSelection

IEssMemberSelection openMemberSelection(java.lang.String name,
                                        boolean queryOverCache)
                                        throws com.essbase.api.base.EssException
Deprecated. This method is deprecated. QueryOverCache feature is no longer supported.
Opens a member selection.
Parameters:
name - The name for the member selection.
queryOverCache - true to query over EDS outline cache.
Returns:
The member selection.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copy

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

delete

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

rename

void rename(java.lang.String newCubeName)
            throws com.essbase.api.base.EssException
Renames this cube.
Parameters:
newCubeName - The new name for the Cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApplication

IEssOlapApplication getApplication()
                                   throws com.essbase.api.base.EssException
Gets the parent application.
Returns:
The application.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openCubeView

IEssCubeView openCubeView(java.lang.String name)
                          throws com.essbase.api.base.EssException
Opens a cube view. JAPI opens and shares a single connection with Essbase between all its interfaces for each JAPI session. JAPI uses counters to track the number of interfaces using the connection based on the IEssCube.openCubeView/IEssDomain.openCubeView/IEssCube.openMembreSelection() calls and hence the number of IEssCubeView.close() calls should match the number of openCubeView() calls for a proper closure of the connection.
Parameters:
name - The cube view name.
Returns:
The cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openCubeView

IEssCubeView openCubeView(java.lang.String name,
                          boolean useConnPool,
                          boolean connPerOp,
                          boolean useCluster,
                          boolean readOnly)
                          throws com.essbase.api.base.EssException
Deprecated. Use the other openCubeView method.
Opens a cube view. NOTE: Operations Update/Lock/Unlock are not currently allowed in connection pool over cluster.
Parameters:
name - The cube view name.
useConnPool - true to use connection pool if available.
connPerOp - true for connection per operation. false for connection per session.
useCluster - true to use cluster if available.
readOnly - true if to open in read only mode.
Returns:
The cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOpenCubeViews

IEssIterator getOpenCubeViews()
                              throws com.essbase.api.base.EssException
Gets the list of open cube views.
Returns:
The list of open cube views.
Throws:
com.essbase.api.base.EssException - if an error occurs..

report

java.lang.String report(java.lang.String reportSpec,
                        boolean output,
                        boolean lockForUpdate)
                        throws com.essbase.api.base.EssException
Sends a report specification to the active database as a single string. The report data can either be output, or the report specification can just be verified (if output and lockForUpdate are set to false) and any errors returned. Also, the corresponding data blocks in the database can optionally be locked by this call (lock for update). Note: For reports with large output, use the report method that returns IEssSequentialIterator, instead of this method. Usage example:
String output = report("IDESC Year !", true, false);
Parameters:
reportSpec - The report script as a single string. (must be less than 64 Kbytes)
output - If true, data is output from the server, according to the specified report. If false, no data is output.
lockForUpdate - If true, all blocks which are accessed by the report specification are locked for update. If false, no blocks are locked.
Returns:
The report output.
Throws:
com.essbase.api.base.EssException - if an error occurs.

report

java.lang.String report(boolean output,
                        boolean lockForUpdate,
                        java.lang.String reportFileName,
                        boolean isLocalFile)
                        throws com.essbase.api.base.EssException
Sends a report specification to this active cube from a file. The report data can either be output, or the report specification can just be verified (if output and lockForUpdate are set to false) and any errors returned. Also, the corresponding data blocks in the cube can optionally be locked by this call (lock for update). Note: For reports with large output, use the report method that returns IEssSequentialIterator, instead of this method. Usage example:
String output = report(true, false, "Top", false);
Parameters:
output - If true, data is output from the server, according to the specified report. If false, no data is output.
lockForUpdate - If true, all blocks which are accessed by the report specification are locked for update. If false, no blocks are locked.
reportFileName - The name of the report specification file. Specify the full path name for local file. Specify just the file name without the extension for server based files.
isLocalFile - true if the file is located in the JAPI client machine. false if the file is located in the olap server database directory.
Returns:
The report output.
Throws:
com.essbase.api.base.EssException - if an error occurs.

report

IEssSequentialIterator report(java.lang.String reportSpecOrFileName,
                              boolean isFileName,
                              boolean isLocalFile,
                              boolean output,
                              boolean lockForUpdate)
                              throws com.essbase.api.base.EssException
Sends a report specification to the active database as a single string or from a file. The report data can either be output, or the report specification can just be verified (if output and lockForUpdate are set to false) and any errors returned. Also, the corresponding data blocks in the database can optionally be locked by this call (lock for update). Note: Make sure to iterate through all the results before invoking any other method. Usage example:
            IEssSequentialIterator output = report("Top", true, false, true, false);
            String part = null;
            while ((part = output.getNextString()) != null)
                System.out.print(part);
                
Parameters:
reportSpecOrFileName - The report script as a single string or a file name holding the report.
isFileName - true if the reportSpecOrFileName parameter contains a file name. false if it contains the report specification itself.
isLocalFile - true if the file is located in the JAPI client machine. false if the file is located in the olap server database directory.
output - If true, data is output from the server, according to the specified report. If false, no data is output.
lockForUpdate - If true, all blocks which are accessed by the report specification are locked for update. If false, no blocks are locked.
Returns:
The report output iterator.
Throws:
com.essbase.api.base.EssException - if an error occurs.

calculate

void calculate(java.lang.String calcScript,
               boolean syntaxCheckOnly)
               throws com.essbase.api.base.EssException
Sends and optionally executes a calc script against this active cube as a single string. The calculation can either be performed, or the calc script can just be verified and any errors returned.
Parameters:
calcScript - The calc script as a single string.
syntaxCheckOnly - true if to perform syntax check only.
Throws:
com.essbase.api.base.EssException - if an error occurs.

calculate

void calculate()
               throws com.essbase.api.base.EssException
Executes the default calculation for this cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

calculate

void calculate(boolean syntaxCheckOnly,
               java.lang.String calcFileNamePrefix)
               throws com.essbase.api.base.EssException
Executes a calc script against the active database from a file. The calculation can either be performed, or the calc script can just be verified and any errors returned.
Parameters:
syntaxCheckOnly - true if to perform syntax check only.
calcFileNamePrefix - The calc script file name's prefix. This file should be located in the olap server's application/cube directory, with extension '.csc'. For eq, if the file name is calcall.csc, you should pass "calcall" to this param.
Throws:
com.essbase.api.base.EssException - if an error occurs.

beginUpdate

void beginUpdate(boolean store,
                 boolean unlock)
                 throws com.essbase.api.base.EssException
Starts sending an update specification to the active database. This call must be followed by successive calls to EssSendString() to send the update specification, and finally by a call to EssEndUpdate(). The update data can either be stored in the database, or just verified and any errors returned. Also, any data blocks locked for update can be unlocked by this call.
Parameters:
store - Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored.
unlock - Controls unlocking of data blocks. If TRUE, all relevant blocks which are locked will be unlocked (after data is stored, if necessary). If FALSE, no blocks are unlocked.
Throws:
com.essbase.api.base.EssException - if an error occurs.

sendString

void sendString(java.lang.String str)
                throws com.essbase.api.base.EssException
Sends a string of data to the active database. The string must be less than 32 Kbytes long. This function should be called after EssBeginReport(), EssBeginUpdate(), or EssBeginCalc(). For sending UTF-8 data, the string should start with the unicode byte order mark ?.
Parameters:
str - Data string (must be less than 32 Kbytes in length.
Throws:
com.essbase.api.base.EssException - if an error occurs.

endUpdate

void endUpdate()
               throws com.essbase.api.base.EssException
Marks the end of an update specification being sent to the active database. This function must be called after sending the update specification (using EssSendString()).
Throws:
com.essbase.api.base.EssException - if an error occurs.

beginDataload

void beginDataload(boolean Store,
                   boolean Unlock,
                   boolean AbortOnError,
                   java.lang.String rulesFileName,
                   int rulesObjectType)
                   throws com.essbase.api.base.EssException
Starts sending an update specification to the active database, and can unlock any data blocks locked for update. The update data can either be stored in the database, or just verified and any errors returned. This loads data using the default bufferId.
Parameters:
Store - - Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored
Unlock - - Controls unlocking of data blocks. If TRUE, all relevant blocks which are locked will be unlocked (after data is stored, if necessary). If FALSE, no blocks are unlocked. Note : Not supported for aggregate storage databases. In case of a ASO database, it needs be passed as FALSE.
AbortOnError - - If TRUE, data load stops on the first error. Otherwise, data load continues.
rulesFileName - - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data". This parameter can be null for Essbase OLAP server versions 6.5.1 and after, but not before (as there is a known bug that it hangs).
rulesObjectType - - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
Throws:
com.essbase.api.base.EssException

beginDataload

java.lang.String[][] beginDataload(java.lang.String rulesFileName,
                                   int rulesObjectType,
                                   java.lang.String userName,
                                   java.lang.String password,
                                   boolean AbortOnError,
                                   int bufferId)
                                   throws com.essbase.api.base.EssException
Imports the data from SQL source. This has a provision to specify the Buffer Id. The update data can either be stored in the database, or just verified and any errors returned.
Parameters:
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data". This parameter can be null for Essbase OLAP server versions 6.5.1 and after, but not before (as there is a known bug that it hangs).
rulesObjectType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
userName - - String, the SQL source username.
password - - String, the SQL user's password.
AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.
bufferId - The Buffer Identifier
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException

beginDataload

java.lang.String[][] beginDataload(java.lang.String rulesFileName,
                                   int rulesObjectType,
                                   java.lang.String dataFileName,
                                   int dataFileType,
                                   java.lang.String userName,
                                   java.lang.String password,
                                   boolean AbortOnError,
                                   int bufferId)
                                   throws com.essbase.api.base.EssException
Imports the data for ASO from FTP and SQL source. This has a provision to specify the Buffer Id. The update data can either be stored in the database, or just verified and any errors returned.
Parameters:
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data". This parameter can be null for Essbase OLAP server versions 6.5.1 and after, but not before (as there is a known bug that it hangs).
rulesObjectType - - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
dataFileName - - String, for an FTP source, then ftp://host/folder/data.txt, null for SQL source.
dataFileType - - int, the data file object type. Values from IEssOlapFileObject.TYPE_*.
userName - - String, the SQL source/FTP username.
password - - String, the SQL/FTP user's password.
AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.
bufferId - The Buffer Identifier
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException

beginDataload

java.lang.String[][] beginDataload(java.lang.String rulesFileName,
                                   int rulesObjectType,
                                   java.lang.String dataFileName,
                                   int dataFileType,
                                   boolean AbortOnError,
                                   int bufferId)
                                   throws com.essbase.api.base.EssException
Imports from a data file. This has a provision to specify the Buffer Id. The update data can either be stored in the database, or just verified and any errors returned.
Parameters:
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data". This parameter can be null for Essbase OLAP server versions 6.5.1 and after, but not before (as there is a known bug that it hangs).
rulesObjectType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
dataFileName - - The data file name in the olap server's app/cube directory. For eg, for the file named data.txt in olap server's app/cube directory pass "Data".
dataFileType - - The data file object type. Values from IEssOlapFileObject.TYPE_*.
AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.
bufferId - The Buffer Identifier
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException

beginDataload

void beginDataload(boolean Store,
                   boolean Unlock,
                   boolean AbortOnError,
                   java.lang.String rulesFileName,
                   int rulesObjectType,
                   int bufferId)
                   throws com.essbase.api.base.EssException
Starts sending an update specification to the active database, and can unlock any data blocks locked for update. This has a provision to specify the Buffer Id. The update data can either be stored in the database, or just verified and any errors returned.
Parameters:
Store - Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored
Unlock - Not supported for aggregate storage databases. Always pass FALSE for this parameter.
AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data". This parameter can be null for Essbase OLAP server versions 6.5.1 and after, but not before (as there is a known bug that it hangs).
rulesObjectType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
bufferId - The Buffer Identifier
Throws:
com.essbase.api.base.EssException

endDataload

java.lang.String[][] endDataload()
                                 throws com.essbase.api.base.EssException
marks the end of an update specification being sent to the active database, and must be called after sending the update specification using EssSendString().
Returns:
String [][] - null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException

getAliasTableNames

java.lang.String[] getAliasTableNames()
                                      throws com.essbase.api.base.EssException
Gets all the alias table names in this cube.
Returns:
The alias table names.
Throws:
com.essbase.api.base.EssException - if an error occurs.

loadAliasTable

void loadAliasTable(java.lang.String aliasTableName,
                    java.lang.String fileName)
                    throws com.essbase.api.base.EssException
Loads an alias table for the active database from a structured text file.
Parameters:
aliasTableName - The name of the alias table to load.
fileName - The full path name of the structured alias names file on the server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAliasTableName

java.lang.String getAliasTableName()
                                   throws com.essbase.api.base.EssException
Gets the active alias table name from the active database for a user.
Returns:
aliasTableName The name of active alias table.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setAliasTableName

void setAliasTableName(java.lang.String aliasTableName)
                       throws com.essbase.api.base.EssException
Sets the active alias table in the active database for a user.
Parameters:
aliasTableName - The name of the alias table to set active.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAliasTableEntries

java.lang.String[][] getAliasTableEntries(java.lang.String aliasTableName)
                                          throws com.essbase.api.base.EssException
Gets the contents of the specified alias table in the active database.
Returns:
The alias table entries in the following order: [0][0] - first member name, [0][1] - alias name for first member, [1][0] - second member name, [1][1] - alias name for second member, and so on.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteAliasTable

void deleteAliasTable(java.lang.String aliasTableName)
                      throws com.essbase.api.base.EssException
Removes an alias table from the active database.
Parameters:
aliasTableName - The name of the alias table to remove.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteAllAliasTables

void deleteAllAliasTables()
                          throws com.essbase.api.base.EssException
Clears all alias tables for the active cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isActive

boolean isActive()
                 throws com.essbase.api.base.EssException
Checks if this cube is currently active for the instance of the IEssOlapServer object (which is parent of parent to this object).
Returns:
true if this cube is currently active.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setActive

void setActive()
               throws com.essbase.api.base.EssException
Sets this cube active for the instance of the IEssOlapServer object (which is parent of parent to this object).
Throws:
com.essbase.api.base.EssException - if an error occurs.

clearActive

void clearActive()
                 throws com.essbase.api.base.EssException
Clears the currently active application and cube for the instance of the IEssOlapServer object (which is parent of parent to this object).
Throws:
com.essbase.api.base.EssException - if an error occurs.

clearAllData

void clearAllData()
                  throws com.essbase.api.base.EssException
Clears all loaded data in the active cube.
Throws:
com.essbase.api.base.EssException - if an error occurs.

validateCube

void validateCube(java.lang.String errLogFileName)
                  throws com.essbase.api.base.EssException
Checks the cube for data integrity. Example usage: validateCube("errlog");
Parameters:
errLogFileName - Error log file name, to be placed in the app\cube directory in the olap server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

start

void start()
           throws com.essbase.api.base.EssException
Starts/Loads a cube within an Application on the server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

stop

void stop()
          throws com.essbase.api.base.EssException
Stops/Unloads a cube within an application on the server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNoteOfTheDay

java.lang.String getNoteOfTheDay()
                                 throws com.essbase.api.base.EssException
Gets this cube's note-of-the-day message. The note-of-the-day message may be used to display useful information about the cube (whether data has been loaded, when it was last calculated, etc.) to users before they connect to the cube. The cube note string will always be less than 64 Kbytes in length.
Returns:
The note-of-the-day message.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setNoteOfTheDay

void setNoteOfTheDay(java.lang.String note)
                     throws com.essbase.api.base.EssException
Sets this cube's note-of-the-day message. The note-of-the-day message may be used to display useful information about the cube (whether data has been loaded, when it was last calculated, etc.) to users before they connect to the cube. The cube note string will always be less than 64 Kbytes in length.
Parameters:
note - The note-of-the-day message.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDefaultCalcScript

java.lang.String getDefaultCalcScript()
                                      throws com.essbase.api.base.EssException
Gets the default calc script for this active cube.
Returns:
The default calc script.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDefaultCalcScript

void setDefaultCalcScript(boolean isFileName,
                          java.lang.String defCalcScriptOrFile)
                          throws com.essbase.api.base.EssException
Sets the default calc script for this active cube.
Parameters:
isFileName - true if defCalcScriptOrFile is a file name, false if defCalcScriptOrFile is the calc script.
defCalcScriptOrFile - The default calc script or the file that contains calc script.
Throws:
com.essbase.api.base.EssException - if an error occurs.

queryMembers

java.lang.String queryMembers(java.lang.String mbrQuery)
                              throws com.essbase.api.base.EssException
Performs a report-style query to list a selection of cube member information.

This function supports an attribute member long name. See the Technical Reference for descriptions of report specifications.

This function can return information on member stored as a relational partition if its enabled using IEssCube.setSpanRelationalSource.

This function supports sorting of members based on member names, aliases (which are the same as member names for relational members) and dimension/generation numbers. For other options, the relational members are treated identically and displayed at the end of the list of members.

Not all member selection strings are supported in the relational store. This function can return relational information on the following member selection strings:

The Member query string consists of a selection string and an optional sorting command followed by an optional output command. The form is:

 mbrQuery ==: <selectionstring> [<sortcommand> [<outputcommand>] ]
 
The valid values for member <selectionstring> are:
 <CHILDRENOF
 <ALLINSAMEDIM
 <DIMTOP
 <OFSAMEGENERATION
 <ONSAMELEVELAS
 <ANCESTORSOF
 <PARENTOF
 <DESCENDANTSOF
 <ALLSIBLINGSOF
 <LSIBLINGOF
 
Parameters:
mbrQuery - The member query string. A query string is a command similar to a report specification.
Returns:
The resultset containing cube member information.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
setSpanRelationalSource(boolean)

isValidMember

boolean isValidMember(java.lang.String mbrName)
                      throws com.essbase.api.base.EssException
Checks if a string is a valid member name within the active cube outline.
Parameters:
mbrName - The member name to be verified.
Returns:
true if the member is valid.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMember

IEssMember getMember(java.lang.String mbrName)
                     throws com.essbase.api.base.EssException
Gets the member. Note: For IEssMember object obtained using IEssCube.getMember(), only the following methods can be used from IEssMember: getName(), isDimensionRootMember(), getLevelNumber(), getGenerationNumber(), getUnaryConsolidationType(), getDimensionName(), getParentMemberName(), getFirstChildMemberName(), getPreviousSiblingMemberName(), getNextSiblingMemberName(), getMemberNumber(), getDimensionNumber(). The rest of the methods in IEssMember will throw an exception.
Parameters:
mbrName - The member name.
Returns:
The member.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getMemberCalc

java.lang.String[] getMemberCalc(java.lang.String mbrName)
                                 throws com.essbase.api.base.EssException
Gets the calc equation for a specific member in the active cube outline.
Parameters:
mbrName - The member name.
Returns:
The calc equations. String[0] - member calc string, String[1] - member last calc string. The value is "" for default rollup.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimension

IEssDimension getDimension(java.lang.String dimName)
                           throws com.essbase.api.base.EssException
Gets the dimension. Note: For IEssDimension object obtained using IEssCube.getDimension(), only the following methods can be used from IEssDimension: getName(), getDimensionNumber(), getType(), getTag(), getDeclaredSize(), getActualSize(), getAttributeDimensionDataType(). The rest of the methods in IEssDimension will throw an exception.
Parameters:
dimName - The dimension name.
Returns:
The dimension.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDimensions

IEssIterator getDimensions()
                           throws com.essbase.api.base.EssException
Gets the list of dimensions.
Returns:
The dimensions.
Throws:
com.essbase.api.base.EssException - if an error occurs.

buildDimension

void buildDimension(java.lang.String rulesFileName,
                    int rulesFileType,
                    java.lang.String dataFileName,
                    int dataFileType,
                    java.lang.String errOutFile)
                    throws com.essbase.api.base.EssException
Allows the addition or removal of members from the outline in the active cube from a data file and rules file. The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. Only text files are supported from a client file-system.
Parameters:
rulesFileName - The rules file name.
rulesFileType - The rules file type (IEssOlapFileObject.TYPE_*).
dataFileName - The data file name.
dataFileType - The data file type (IEssOlapFileObject.TYPE_*).
errOutFile - The error output file name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

buildDimensionFile

void buildDimensionFile(java.lang.String rulesFileName,
                        int rulesFileType,
                        java.lang.String dataFileName,
                        int dataFileType,
                        java.lang.String errOutFile,
                        boolean overwriteErrFile)
                        throws com.essbase.api.base.EssException
Builds a data file used to add or remove members from the active cube outline. This should be preceeded by a buildDimensionStart() and succeeded by a restructure(short) call. This can be called repeatedly prior to restructuring to add members via multiple rules and/or data file to the outline. The database must be restructured after completion of the call(s) to this API. The outline must be unlocked after restructuring.
Parameters:
rulesFileName - The rules file name.
rulesFileType - The rules file type (IEssOlapFileObject.TYPE_*).
dataFileName - The data file name.
dataFileType - The data file type (IEssOlapFileObject.TYPE_*).
errOutFile - The error output file name.
overwriteErrFile - A Boolean value which detemines whether this operation overwrites an existing file name specified in errOutFile. if set to true, existing errOutFile will be overwritten and previos content of the file will be lost. If set to false, error records get appended to the existing errOutFile.
Throws:
com.essbase.api.base.EssException - if an error occurs.

buildDimensionStart

void buildDimensionStart()
                         throws com.essbase.api.base.EssException
This starts the process to add or remove members from the active database outline. This API calls a setActive on the database. The outline must be locked prior to calling this API.
Throws:
com.essbase.api.base.EssException
See Also:
buildDimensionFile(String, int, String, int, String, boolean), restructure(short)

restructure

void restructure(short restructOption)
                 throws com.essbase.api.base.EssException
Restructures the outline on the server. This is an asynchronous call.
Parameters:
restructOption -
Throws:
com.essbase.api.base.EssException

getOlapFileObjects

IEssIterator getOlapFileObjects(int objType)
                                throws com.essbase.api.base.EssException
Gets all the olap store file objects of the types specified. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object types. Values from IEssOlapFileObject.TYPE_*.
Returns:
The OLAP store file objects (each of type IEssOlapFileObject).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOlapFileObject

IEssOlapFileObject getOlapFileObject(int objType,
                                     java.lang.String objName)
                                     throws com.essbase.api.base.EssException
Gets information about a specified olap store file object. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
Returns:
The olap file object information.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObjectFromServer

void copyOlapFileObjectFromServer(int objType,
                                  java.lang.String objName,
                                  java.lang.String clientFileName,
                                  boolean lock)
                                  throws com.essbase.api.base.EssException
Copies an object from the olap server to a client file and optionally locks the server object to prevent updates by others. Use the overloaded API copyOlapFileObjectFromServer(int, String, boolean) to copy the object to the client system in 3-tier mode(non embedded mode). Example:
copyOlapFileObjectFromServer(IEssOlapFileObject.TYPE_TEXT, "Act1", "C:/temp/act1.txt", false);
This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
clientFileName - The full path of destination file in the client. The file will be local to the server if not in Embedded mode.
lock - Flag to control object locking. If true, the server object is locked to prevent updates by other users.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObjectFromServer

byte[] copyOlapFileObjectFromServer(int objType,
                                    java.lang.String objName,
                                    boolean lock)
                                    throws com.essbase.api.base.EssException
Copies an object from the olap server to a byte sequence and optionally locks the server object to prevent updates by others. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
lock - Flag to control object locking. If true, the server object is locked to prevent updates by other users.
Returns:
a byte sequence of the server object.
Throws:
com.essbase.api.base.EssException - if an Excepption occurs.

copyOlapFileObjectToServer

void copyOlapFileObjectToServer(int objType,
                                java.lang.String objName,
                                java.lang.String clientFileName,
                                boolean unlock)
                                throws com.essbase.api.base.EssException
Copies an object from a client file to the olap server, and optionally unlocks the server object to allow updates by others. Use the overloaded API copyOlapFileObjectToServer(int, String, byte[], boolean) to copy the object from client system in 3-tier mode(non embedded mode). Example:
copyOlapFileObjectToServer(IEssOlapFileObject.TYPE_TEXT, "Test", "C:/temp/test.txt", false);
In case of copying a IEssOlapFileObject.TYPE_OUTLINE type object, the outline file will be copied as a ".otn" file on the server representing it as an intermediate Outline file. If this object name is same as the existing cube (or outline) name, then, performing a restructure operation on this cube will replace the .otn file as the outline file. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
clientFileName - The full path of source file in the client. The file should be local to the server if not in embedded mode.
unlock - Flag to control object locking. If true, the server object is unlocked.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObjectToServer

void copyOlapFileObjectToServer(int objType,
                                java.lang.String objName,
                                byte[] content,
                                boolean unlock)
                                throws com.essbase.api.base.EssException
Copies an object in the form of byte sequence to the olap server, and optionally unlocks the server object to allow updates by others. Outline objects cannot be copied. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
content - The byte sequence of the object in the client.
unlock - Flag to control object locking. If true, the server object is unlocked.
Throws:
com.essbase.api.base.EssException - if an error occurs.

lockOlapFileObject

void lockOlapFileObject(int objType,
                        java.lang.String objName)
                        throws com.essbase.api.base.EssException
Locks an object on the server to prevent other users from updating it. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

unlockOlapFileObject

void unlockOlapFileObject(int objType,
                          java.lang.String objName)
                          throws com.essbase.api.base.EssException
Unlocks a locked object on the server. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createOlapFileObject

void createOlapFileObject(int objType,
                          java.lang.String objName)
                          throws com.essbase.api.base.EssException
Creates a new olap file object. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteOlapFileObject

void deleteOlapFileObject(int objType,
                          java.lang.String objName)
                          throws com.essbase.api.base.EssException
Delte an existing olap file object. Outline Objects can not be deleted. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

renameOlapFileObject

void renameOlapFileObject(int objType,
                          java.lang.String objName,
                          java.lang.String newObjName)
                          throws com.essbase.api.base.EssException
Renames an existing olap file object. Outline and LRO Objects cannot be renamed. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copyOlapFileObject

void copyOlapFileObject(int objType,
                        java.lang.String objName,
                        java.lang.String destAppName,
                        java.lang.String destCubeName,
                        java.lang.String destObjName)
                        throws com.essbase.api.base.EssException
Copies an olap file object. Outline Object can not be copied. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALL
Parameters:
objType - The object type. Value from IEssOlapFileObject.TYPE_*.
objName - The object name.
destAppName - The destination application name.
destCubeName - The destination cube name.
destObjName - The destination object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

archiveBegin

void archiveBegin(java.lang.String archFileName)
                  throws com.essbase.api.base.EssException
Prepares this cube for archive by setting read-only status.
Parameters:
archFileName - The name of the file to contain archive information. This file will be created in the olap server's application/cube directory. For eg, if you invoke as archiveBegin("archfile"), a file named archfile will be created in the directory mentioned above.
Throws:
com.essbase.api.base.EssException - if an error occurs.

archiveEnd

void archiveEnd()
                throws com.essbase.api.base.EssException
After archive, returns cube status to read-write.
Throws:
com.essbase.api.base.EssException - if an error occurs.

exportData

void exportData(java.lang.String fileName,
                IEssCube.EEssDataLevel dataLevel,
                boolean columns)
                throws com.essbase.api.base.EssException
Exports this cube's data to a text file.
Parameters:
fileName - The name of the server file to contain the exported information.
dataLevel - Controls level of data to export.
columns - Controls output of data blocks in column format (for creating rules files).
Throws:
com.essbase.api.base.EssException - if an error occurs.

exportData

void exportData(java.lang.String fileName,
                IEssCube.EEssDataLevel dataLevel,
                short columns)
                throws com.essbase.api.base.EssException
Deprecated. Use the other exportData method.
Throws:
com.essbase.api.base.EssException

loadData

java.lang.String[][] loadData(java.lang.String updateSpecs,
                              int rulesObjType,
                              java.lang.String rulesFileName,
                              boolean syntaxCheckOnly,
                              boolean unlockAfterUpdate,
                              boolean abortOnError)
                              throws com.essbase.api.base.EssException
Updates data to the cube from the specified update specification string. The update data can either be stored in the cube, or just verified and any errors returned. Also, any data blocks locked for update can be unlocked by this call.
Parameters:
updateSpecs - The update specification string. For eq: "Product Jan Sales Actual Market 4444\n Product Feb Sales Actual Market 5555".
rulesObjType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data". This parameter can be null for Essbase OLAP server versions 6.5.1 and after, but not before (as there is a known bug that it hangs).
syntaxCheckOnly - true, if syntax check only. false, to store data.
unlockAfterUpdate - true to unlock blocks after the update.
abortOnError - If true, data load stops on the first error. Otherwise, data load continues.
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException - if an error occurs.

loadData

java.lang.String[][] loadData(int rulesObjType,
                              java.lang.String rulesFileName,
                              int dataObjType,
                              java.lang.String dataFileName,
                              boolean abortOnError,
                              java.lang.String userName,
                              java.lang.String password)
                              throws com.essbase.api.base.EssException
Allows the importing of data from text files to this cube. The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. To specify data files over a FTP Protocol, dataFileName needs to contain the name of the ftp source and userName and password to be nonempty. Only text files are supported from a client file-system. Returns an error-list only when rules files is specified. Example usage for demo/basic cube:
loadData( IEssOlapFileObject.TYPE_RULES, null, IEssOlapFileObject.TYPE_TEXT, "Data", false);
Parameters:
rulesObjType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data".
dataObjType - The data file object type. Values from IEssOlapFileObject.TYPE_*.
dataFileName - The data file name in the olap server's app/cube directory. For eg, for the file named data.txt in olap server's app/cube directory pass "Data".
abortOnError - If true import stops on the first error otherwise continues.
userName - external data source username.
password - external data source password.
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException - if an error occurs.

loadData

java.lang.String[][] loadData(int rulesObjType,
                              java.lang.String rulesFileName,
                              int dataObjType,
                              java.lang.String dataFileName,
                              boolean abortOnError)
                              throws com.essbase.api.base.EssException
Allows the importing of data from external data sources to this cube.The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file and provide a path relative to the server for a file on the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. Only text files are supported from a client file-system. Returns an error-list only when rules files is specified.
Parameters:
rulesObjType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data".
dataObjType - The data file object type. Values from IEssOlapFileObject.TYPE_*.
dataFileName - The data file name in the olap server's app/cube directory. For eg, for the file named data.txt in olap server's app/cube directory pass "Data".
abortOnError - If true import stops on the first error otherwise continues.
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, file record containing the error.
Throws:
com.essbase.api.base.EssException - if an error occurs.

loadData

void loadData(boolean store,
              boolean unlock,
              java.lang.String updSpec)
              throws com.essbase.api.base.EssException
Updates data to cube from the specification string.
Parameters:
store - Controls storage of data. If true data is stored in the server; if false no data is stored.
unlock - Controls unlocking of data blocks. If true all relevant blocks which are locked will be unlocked (after data is stored, if necessary). If false no blocks are unlocked.
updSpec - The update specification as a single string.
Throws:
com.essbase.api.base.EssException - if an error occurs.

loadDataEx

java.lang.String[][] loadDataEx(boolean store,
                                boolean unlock,
                                java.lang.String updSpec)
                                throws com.essbase.api.base.EssException
Updates data to cube from the specification string.
Parameters:
store - Controls storage of data. If true data is stored in the server; if false no data is stored.
unlock - Controls unlocking of data blocks. If true all relevant blocks which are locked will be unlocked (after data is stored, if necessary). If false no blocks are unlocked.
updSpec - The update specification as a single string.
Returns:
null if no error. If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, record containing the error.
Throws:
com.essbase.api.base.EssException
Since:
11.1.2

createDataloadInstance

IEssCubeDataloadInstance createDataloadInstance()
Creates an returns a cube data load instance. On the return blank instance, user can set the data load input parameter and then use the instance to pass the input paramters for data load APIs like loadDataParallel(IEssCubeDataloadInstance)
Returns:
a IEssCubeDataloadInstance instance
Since:
11.1.2.2

loadDataParallel

java.lang.String[][] loadDataParallel(IEssCubeDataloadInstance dataloadInstance)
                                      throws com.essbase.api.base.EssException
Allows user to load data in parallel using multiple data files using wildcard specification ('?' or '*'). In case the client side data files are specified, API will use multiple threads to load data files in parallel. This API is applicable for BSO cubes only.
Note : In case any data file load failure occurs while loading client side data files, same can be retrieved using getDataLoadThreadErrors().
Parameters:
dataloadInstance - the dataload instance which contains the dataload input paramters
Returns:
If error, returns a two dimensional array of errors, where each dimension contains the following in that order: error string, member name, record containing the error.
Throws:
com.essbase.api.base.EssException - in an error occurs.
Since:
11.1.2.2

getDataLoadThreadErrors

java.util.Hashtable<java.lang.String,java.lang.String> getDataLoadThreadErrors()
Returns the data load thread errors in case of parallel data load involving multiple client side data files.
Returns:
A hashtable containing key value pair of data file name or thread ID as key and the failure message as value.
Since:
11.1.2.2

beginIncrementalBuildDim

IEssCubeOutline beginIncrementalBuildDim()
                                         throws com.essbase.api.base.EssException
Gives an instruction to the Cube that incremental Dimension build is started. This call is needed as a pre-requiste before you can invoke IEssCube.incrementalBuildDim method one or more times. Caller API can use the returned outline handle to execute other outline editing API before invoking the endIncrementalBuildDim(short, String, String) call.
Returns:
a reference to the Outline, opening it for the Dimension build mode
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
incrementalBuildDim(String, int, String, int, String, String, int, String, String, boolean)

incrementalBuildDim

java.lang.StringBuffer incrementalBuildDim(java.lang.String rulesFileName,
                                           int rulesFileType,
                                           java.lang.String dataFileName,
                                           int dataFileType,
                                           java.lang.String userName,
                                           java.lang.String password,
                                           int incBuildOption,
                                           java.lang.String tmpOtlFilename,
                                           java.lang.String ErrorFileName)
                                           throws com.essbase.api.base.EssException
Performs the Dimension build and/or Data load using the specified rule and data files. In order to use this method one or more times, the pre-requiste is to invoke IEssCube.beginIncrementalBuildDim method. After you are done with the incremental builds, invoke IEssCube.endIncrementalBuildDim method to complete the process. The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. If the the data file is to be ftp-ed, then, userName and password needs to be specified for the FTP authentication. Example of a FTP Data Souce: dataFileName = ftp://myhost/mycubeData.txt
Parameters:
rulesFileName - Rules file name.
rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).
dataFileName - Data file Name.
dataFileType - Date file type (Example: IEssOlapFileObject.TYPE_TEXT).
userName - Login-id, in the case of FTP based data source. Otherwise, can be null.
password - Password, in the case of FTP based data source. Otherwise, can be null.
incBuildOption - One of the IEssCube.ESS_INCDIMBUILD_* options
tmpOtlFilename - FileName for the Temporary Outline.
ErrorFileName - - the absolute filename into which error should be written to.
Returns:
StringBuffer - a buffer with the errors. Incase of an exception, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
beginIncrementalBuildDim()

incrementalBuildDim

java.lang.StringBuffer incrementalBuildDim(java.lang.String rulesFileName,
                                           int rulesFileType,
                                           java.lang.String dataFileName,
                                           int dataFileType,
                                           java.lang.String userName,
                                           java.lang.String password,
                                           int incBuildOption,
                                           java.lang.String tmpOtlFilename,
                                           java.lang.String ErrorFileName,
                                           boolean addToBuffer)
                                           throws com.essbase.api.base.EssException
Performs the Dimension build and/or Data load using the specified rule and data files. In order to use this method one or more times, the pre-requiste is to invoke IEssCube.beginIncrementalBuildDim method. After you are done with the incremental builds, invoke IEssCube.endIncrementalBuildDim method to complete the process. The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. If the the data file is to be ftp-ed, then, userName and password needs to be specified for the FTP authentication. Example of a FTP Data Souce: dataFileName = ftp://myhost/mycubeData.txt
Parameters:
rulesFileName - Rules file name.
rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).
dataFileName - Data file Name.
dataFileType - Date file type (Example: IEssOlapFileObject.TYPE_TEXT).
userName - Login-id, in the case of FTP based data source. Otherwise, can be null.
password - Password, in the case of FTP based data source. Otherwise, can be null.
incBuildOption - One of the IEssCube.ESS_INCDIMBUILD_* options
tmpOtlFilename - FileName for the Temporary Outline.
ErrorFileName - - the absolute filename into which error should be written to.
addToBuffer - - if set to false then error records will not be appended to returning StringBuffer
Returns:
StringBuffer - a buffer with the errors. Incase of an exception, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
beginIncrementalBuildDim()

endIncrementalBuildDim

java.lang.StringBuffer endIncrementalBuildDim(short RestructOption,
                                              java.lang.String tmpOtlFilename,
                                              java.lang.String ErrorFileName)
                                              throws com.essbase.api.base.EssException
Ends the Incremental Dimension build. Restructures the outline opened during beginIncrementalBuildDim() call and closes it as well.
Parameters:
RestructOption - - the Restructure option. Values are : ESS_DOR_ALLDATA, ESS_DOR_FORCE_ALLDATA, ESS_DOR_INDATA, ESS_DOR_LOWDATA, ESS_DOR_NODATA,
tmpOtlFilename - FileName of the Temporary Outline you used in incrementalBuildDim.
ErrorFileName - - the absolute filename into which error should be written to.
Returns:
StringBuffer - a buffer containing the error records. Incase of an exception with the outline, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
beginIncrementalBuildDim()

endIncrementalBuildDim

java.lang.StringBuffer endIncrementalBuildDim(short RestructOption,
                                              java.lang.String tmpOtlFilename,
                                              java.lang.String ErrorFileName,
                                              boolean addToBuffer)
                                              throws com.essbase.api.base.EssException
Ends the Incremental Dimension build. Restructures the outline opened during beginIncrementalBuildDim() call and closes it as well.
Parameters:
RestructOption - - the Restructure option. Values are : ESS_DOR_ALLDATA, ESS_DOR_FORCE_ALLDATA, ESS_DOR_INDATA, ESS_DOR_LOWDATA, ESS_DOR_NODATA,
tmpOtlFilename - FileName of the Temporary Outline you used in incrementalBuildDim.
ErrorFileName - - the absolute filename into which error should be written to.
addToBuffer - - if set to false then error records will not be appended to returning StringBuffer
Returns:
StringBuffer - a buffer containing the error records. Incase of an exception with the outline, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
beginIncrementalBuildDim()

beginStreamBuildDim

void beginStreamBuildDim(java.lang.String rulesFileName,
                         int rulesFileType,
                         int incBuildOption,
                         java.lang.String tmpOtlFilename)
                         throws com.essbase.api.base.EssException
Begins the Streaming Dimension build on this Cube.
Parameters:
rulesFileName - Rules file name.
rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).
incBuildOption - One of the IEssCube.ESS_INCDIMBUILD_* options
tmpOtlFilename - FileName for the Temporary Outline.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
endStreamBuildDim(String, boolean)

endStreamBuildDim

java.lang.StringBuffer endStreamBuildDim(java.lang.String ErrorFileName)
                                         throws com.essbase.api.base.EssException
Completes the Streaming Dimension build on this Cube.
Parameters:
ErrorFileName - - the absolute filename into which error should be written to.
Returns:
StringBuffer - a buffer containing error records. Incase of an exception with the outline, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
endStreamBuildDim(String, boolean)

endStreamBuildDim

java.lang.StringBuffer endStreamBuildDim(java.lang.String ErrorFileName,
                                         boolean addToBuffer)
                                         throws com.essbase.api.base.EssException
Completes the Streaming Dimension build on this Cube.
Parameters:
ErrorFileName - - the absolute filename into which error should be written to.
addToBuffer - - if set to false then error records will not be appended to returning StringBuffer
Returns:
StringBuffer - a buffer containing error records. Incase of an exception with the outline, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1
See Also:
endStreamBuildDim(String)

loadBufferInit

void loadBufferInit(long bufferId,
                    long duplicateAggregationMethod,
                    long options,
                    long size)
                    throws com.essbase.api.base.EssException
Creates ASO load buffer with specified ID.
Parameters:
bufferId - - desired buffer ID. It can be in range of 1 and 2147483647.
duplicateAggregationMethod - - method to use for collision resolution within the buffer. One of the following constants describing how to combine multiple values for the same cell within the buffer Values are: ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD 0 ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL 1 ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST 2
options - - a combination of the AD_UKR_LOAD_BUFFER_OPTION_XXX constants. Use bitwise OR (|) to specify multiple options; for example, ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES | ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES. values are: ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES 0x00000001 ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES 0x00000002
size - - percentage of the total load buffer resources that the load buffer will be allowed to use; must be within [0, 100], and the value of 0 is interpreted as "default", which is currently 100. It's up to Essbase server to determine the actual value of the "default size". The operation fails if the total size of all load buffers exceeds 100.
Throws:
com.essbase.api.base.EssException
Since:
11.1.1

loadBufferTerm

void loadBufferTerm(long[] bufferId,
                    long commitType,
                    long actionType,
                    long options)
                    throws com.essbase.api.base.EssException
Stores the loaded buffers.
Parameters:
bufferId - - the array of buffer identifiers
commitType - - commit options values are: ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA 0 ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA 1 ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA 2 ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA 3 ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA 4
actionType - - commit or abort. values are: ESS_ASO_DATA_LOAD_BUFFER_COMMIT 1 ESS_ASO_DATA_LOAD_BUFFER_ABORT 2
options - Values are: ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE 0x00000000 ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE 0x00000001 ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE_LIGHTWEIGHT 0x00000002 ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK 0x00000003
Throws:
com.essbase.api.base.EssException
Since:
11.1.1

listExistingLoadBuffers

com.essbase.api.datasource.EssLOADBUFFER[] listExistingLoadBuffers()
                                                                   throws com.essbase.api.base.EssException
Lists existing load buffers. This would return an error when called on a BSO database. The class EssLOADBUFFER contains information about aggregate storage data load buffers. It has the following useful functions: EssLOADBUFFER.isActive() - Returns true if the buffer is currently in use by a data load EssLOADBUFFER.getBufferId() - ID of a data load buffer (a number between 1 and 4294967296). EssLOADBUFFER.getDuplicateAggregationMethod() - One of the following constants describing how to combine multiple values for the same cell within the buffer: ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD: Add values when the buffer contains multiple values for the same cell. ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL: Verify that multiple values for the same cells are identical, and ignore the duplicates if they are. Stop the data load with an error message if they differ. ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST: Use the last value loaded into the buffer as the final value for the cell. EssLOADBUFFER.isInternal() - Returns true if the buffer was created by Essbase; returns false for user-created buffers EssLOADBUFFER.getOptionFlags() - Either (or a combination) of the following load buffer options: ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES EssLOADBUFFER.getSize() - Returns resource usage
Returns:
- Array of EssLOADBUFFER structures
Throws:
com.essbase.api.base.EssException

mergeDatabaseData

void mergeDatabaseData(long options)
                       throws com.essbase.api.base.EssException
Merges ASO database data. Merges incremental slices with the main slice.
Parameters:
options - Values are: ESS_MERGE_DATABASE_DATA_ALL 1 ESS_MERGE_DATABASE_DATA_INCREMENTAL 2
Throws:
com.essbase.api.base.EssException

getUserOrGroupAccess

IEssCube.EEssCubeAccess getUserOrGroupAccess(java.lang.String userOrGroupName)
                                             throws com.essbase.api.base.EssException
Gets the user or group access for this cube. This API does bit masking and takes care of values without APPLOAD privilege for backward compatability(older versions).
Returns:
The cube access.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setUserOrGroupAccess

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

createSecurityFilter

IEssCube.IEssSecurityFilter createSecurityFilter(java.lang.String filterName)
                                                 throws com.essbase.api.base.EssException
Creates an security filter with empty filter rows. Use IEssCube.setSecurityfilter to create filter with rows.
Parameters:
filterName - Filter name, up to 30 characters long.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteSecurityFilter

void deleteSecurityFilter(java.lang.String filterName)
                          throws com.essbase.api.base.EssException
Deletes a security filter.
Parameters:
filterName - The filter name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getSecurityFilter

IEssCube.IEssSecurityFilter getSecurityFilter(java.lang.String filterName)
                                              throws com.essbase.api.base.EssException
Starts getting the contents of a filter. This call must be followed by successive calls to IEssCube.IEssSecurityFilter.getFilterRow() to fetch the rows for the filter. This function requires the caller to have database designer privilege for the specified database.
Parameters:
filterName - The filter name.
Returns:
The security filter.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSecurityFilter

IEssCube.IEssSecurityFilter setSecurityFilter(java.lang.String filterName,
                                              boolean Active,
                                              IEssCube.EEssCubeAccess Access)
                                              throws com.essbase.api.base.EssException
Creates or replaces a filter, and starts setting the contents of the filter. If the filter does not already exist, it will first be created by this call. This call must be followed by successive calls to IEssCube.IEssSecurityFilter.setFilterRow() to set all the rows for the filter. To avoid overwriting a filter that already exists, use IEssCube.createSecurityFilter. IEssCube.createSecurityFilter creates only a uniquely named filter for a particular database, but will not overwrite an existing filter of the same name on the same database.
Parameters:
filterName - Filter name, up to 30 characters long
Active - - Filter active flag. If true, the filter is set active, otherwise it is set inactive.
Access - - access level.
Returns:
IEssCube.IEssSecurityFilter
Throws:
com.essbase.api.base.EssException - if an error occurs.

getSecurityFilters

IEssIterator getSecurityFilters()
                                throws com.essbase.api.base.EssException
Gets all the security filters for a database. Retrieves all the filter details also. This can turn out to be costly in terms network resources used if the number of of filters is high. Use getSecurityFiltersWithNameOnly() if only filter names are required.
Returns:
The security filters (each of type IEssCube.IEssSecurityFilter).
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
getSecurityFiltersWithNameOnly()

getSecurityFiltersWithNameOnly

IEssIterator getSecurityFiltersWithNameOnly()
                                            throws com.essbase.api.base.EssException
Gets all the security filters for a database only with the filter name initially. This would delay retrieving the actual details of each filter to only when the filter details(access, filter-row) are actually referred/accessed. This would be useful when the number of filters is high to delay retrieving the filter details to the point when the filter details have been referred/accessed.
Returns:
The security filters (each of type IEssCube.IEssSecurityFilter).
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
getSecurityFilters()

setSecurityFilterList

void setSecurityFilterList(IEssCube.IEssSecurityFilter filter,
                           java.lang.String[] usersAndOrGroups)
                           throws com.essbase.api.base.EssException
Sets the list of groups and/or users that are assigned to a filter. The users array size parameter controls the number of groups or users assigned to the filter. A array of size zero will remove all the groups and/or users from the list. This function requires the caller to have database Design privilege for the specified database.
Parameters:
filter - The Filter to which you want to link users and/or groups.
usersAndOrGroups - List of Users and/or Groups
Throws:
com.essbase.api.base.EssException - if an error occurs.

getPerformanceStatistics

java.lang.String getPerformanceStatistics()
                                          throws com.essbase.api.base.EssException
Gets the performance statistics. Usage example:
                resetPerformanceStatisticsTables(4, 7);
                String stats = getPerformanceStatistics();
                
Returns:
The performance statistics.
Throws:
com.essbase.api.base.EssException - if an error occurs.

resetPerformanceStatisticsTables

void resetPerformanceStatisticsTables(int persistence,
                                      int scope)
                                      throws com.essbase.api.base.EssException
Resets values in the performance statistics tables to zero.
Parameters:
persistence - One of the following values indicating the persistence of the set of tables to be reset: 0: Reset short term tables only, 1: Reset short and medium term tables, 2: Reset short, medium and long term tables, 3: Disable performance statistics gathering, 4: Enable performance statistics gathering.
scope - One of the following values indicating the scope of the set of tables to be reset: 1: Reset thread-based tables only, 2: Reset cube-based tables only, 4: Reset server-based tables only, 7: Reset all tables.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createLocationAlias

void createLocationAlias(java.lang.String aliasName,
                         java.lang.String hostName,
                         java.lang.String appName,
                         java.lang.String cubeName,
                         java.lang.String userName,
                         java.lang.String password)
                         throws com.essbase.api.base.EssException
Creates a new location alias; that is, it maps an alias name string to an ordered set of the following five strings: host name, application name, database name, user login name, and user password.
Parameters:
aliasName - The location alias name.
hostName - The target host.
appName - The target application name.
cubeName - The target cube name.
userName - The user name.
password - The user password.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteLocationAlias

void deleteLocationAlias(java.lang.String aliasName)
                         throws com.essbase.api.base.EssException
Deletes an existing location alias.
Parameters:
aliasName - The location alias name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLocationAliases

java.lang.String[][] getLocationAliases()
                                        throws com.essbase.api.base.EssException
Gets a list of all currently defined location aliases, together with lists of the host names, application names, database names and user names to which the location aliases are mapped.
Returns:
Two dimensional array of strings where each row contains the following in the specified order: aliasName, hostName, appName, cubeName, userName. i.e [0][0] is aliasName, [0][1] is hostName, [0][2] is appName, [0][3] is cube name, [0][4] is user name, [1][0] is aliasName, [1][1] is hostName and so on.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getAssociatedAttributes

java.lang.String[][] getAssociatedAttributes(java.lang.String baseMbrName,
                                             java.lang.String attrDimName)
                                             throws com.essbase.api.base.EssException
Gets the attribute members associated with a given base member.
Parameters:
baseMbrName - The base member name.
attrDimName - The attribute dimension name (optional).
Returns:
Two dimensional array of strings where each row contains the following in the specified order: attribute member name, attribute dimension name, attribute value data type (One of the following values for an attribute dimension or zero-level attribute member: bool, string, datetime, double. One of the following values for an attribute member, but not an attribute dimension: none, auto), string representation of attribute value (for boolean, string, datetime, double data types). i.e [0][0] is attribute member name, [0][1] is attribute dimension name, [0][2] is attribute value data type, [0][3] is string representation of attribute value, [1][0] is attribute member name, [1][1] is attribute dimension name and so on.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSpanRelationalSource

void setSpanRelationalSource(boolean span)
                             throws com.essbase.api.base.EssException
Sets (or clears) an intenal boolean field informing essbase that pertinent data exists (or not exists) in an attached relational store. When operations like member selection are performed essbase looks at this internal boolean field and spans (or not) to the relational source. By default it is false. The value set through this API is valid only for the specific Essbsae client session.
Parameters:
span - true to span to relational source.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSpanRelationalSource

boolean isSpanRelationalSource()
                               throws com.essbase.api.base.EssException
Checks if span relational source flag is set or not. To be used after invoking setSpanRelationalSource(boolean). This will return the value set using a earlier setSpanRelationalSource(boolean) with in the same session. By default value is false.
Returns:
true if flag is set.
Throws:
com.essbase.api.base.EssException - if an error occurs.

verifyFormula

boolean verifyFormula(java.lang.String formulaName)
                      throws com.essbase.api.base.EssException
Verified the formula.
Parameters:
formulaName - The name of the formula.
Returns:
true if formula syntax is correct.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCalcFunctions

java.lang.String getCalcFunctions()
                                  throws com.essbase.api.base.EssException
Gets all calculator functions available in the application. It includes all native functions and all user defined functions (UDFs) and user defined macros (CDMs).
Returns:
The calc functions in xml format.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createCDF

void createCDF(java.lang.String appName,
               java.lang.String name,
               java.lang.String javaSpec,
               int options,
               java.lang.String spec,
               java.lang.String comment)
               throws com.essbase.api.base.EssException
Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
Creates custom defined function.
Parameters:
appName - Application Name on which this function must be created.
name - Function name
javaSpec - Java Specification
options - An option must be one of possible values of IEssCube.ESS_UDF_FUNCTION_*
spec - Function specification
comment - Description for this function.
Throws:
if - an error occurs.
com.essbase.api.base.EssException
See Also:
IEssOlapServer.createCDF(String, String, int, String, String), IEssOlapApplication.createCDF(String, String, int, String, String)

deleteCDF

void deleteCDF(java.lang.String appName,
               java.lang.String name)
               throws com.essbase.api.base.EssException
Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
Deletes custom defined function.
Parameters:
appName - Application Name associated with the specified function.
name - Function that has to be deleted.
Throws:
if - an error occurs.
com.essbase.api.base.EssException
See Also:
IEssOlapServer.deleteCDF(String), IEssOlapApplication.deleteCDF(String)

createCDM

void createCDM(java.lang.String appName,
               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
Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
Creates custom defined macro.
Parameters:
appName - Application Name on which this macro must be created.
name - Macro name
definition - Marco definition
signature - Signature for this macro.
spec - Specification for this macro.
comment - Description for this macro.
Throws:
if - an error occurs.
com.essbase.api.base.EssException
See Also:
IEssOlapServer.createCDM(String, String, String, String, String), IEssOlapApplication.createCDM(String, String, String, String, String)

deleteCDM

void deleteCDM(java.lang.String appName,
               java.lang.String name)
               throws com.essbase.api.base.EssException
Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
Deletes custom defined macro.
Parameters:
appName - Application Name associated with the specified macro.
name - Macro that has to be deleted.
Throws:
if - an error occurs.
com.essbase.api.base.EssException
See Also:
IEssOlapServer.deleteCDM(String), IEssOlapApplication.deleteCDM(String)

getCDM_CDF

java.lang.String[][] getCDM_CDF(java.lang.String appName)
                                throws com.essbase.api.base.EssException
Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication.
Gets custom defined functions and macros on the specified 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 either a value "cdf" or "cdm" to idic
Result [x][4] represents either a value "cdf" or "cdm".

Parameters:
appName - Application Name
Returns:
list of CDF and CDMs.
Throws:
if - an error occurs.
com.essbase.api.base.EssException
See Also:
IEssOlapServer.getCDM_CDF(), IEssOlapApplication.getCDM_CDF()

createReferenceCube

void createReferenceCube(java.lang.String locAlias,
                         IEssCube.EEssCubeletType clType,
                         long limit)
                         throws com.essbase.api.base.EssException
creates a reference cube. The use of reference cubes can decrease data tranfer time when using '@XREF' to access data across databases. Before a reference cube can be used, it must be loaded. Creating a reference cube defines the source database and member content of the reference cube. Creating a reference cube also loads it. You can unload a reference cube and reload it. Loading a reference cube retrieves reference cube values, placing them in target memory.
Parameters:
locAlias - - Location alias on the selected application and database
clType - - The type of reference cube. Possible values are PASSIVE ACTIVE
limit - - Size limit for the reference cube
Throws:
com.essbase.api.base.EssException

removeReferenceCube

void removeReferenceCube(java.lang.String locAlias)
                         throws com.essbase.api.base.EssException
deletes a reference cube.
Parameters:
locAlias - - Location alias on the selected application and database.
Throws:
com.essbase.api.base.EssException

unloadReferenceCube

void unloadReferenceCube(java.lang.String locAlias)
                         throws com.essbase.api.base.EssException
removes reference cube values from target memory. Before a reference cube can be used, it must be loaded. Creating a reference cube also loads it. You can unload a reference cube and reload it. Loading a reference cube retrieves reference cube values, placing them in target memory. When you load an active reference cube, it is also registered with the source database. Unloading or deleting the reference cube deregisters it.
Parameters:
locAlias - - Location alias on the selected source application and database.
Throws:
com.essbase.api.base.EssException

loadReferenceCube

void loadReferenceCube(java.lang.String locAlias)
                       throws com.essbase.api.base.EssException
retrieves reference cube values, placing them in target memory. Before a reference cube can be used, it must be loaded. Creating a reference cube also loads it. You can unload a reference cube and reload it. Loading a reference cube retrieves reference cube values, placing them in target memory. When you load an active reference cube, it is also registered with the source database. Unloading or deleting the reference cube deregisters it.
Parameters:
locAlias - - Location alias on the selected source application and database.
Throws:
com.essbase.api.base.EssException

listReferenceCubes

IEssReferenceCubeInfo[] listReferenceCubes()
                                           throws com.essbase.api.base.EssException
returns a list of reference cubes on the target, which includes a status for each reference cube (valid or invalid, loaded or unloaded).
Returns:
- an array of IEssReferenceCubeInfo which contains Reference cube Information.
Throws:
com.essbase.api.base.EssException

archiveDatabase

void archiveDatabase(java.lang.String backupFileName,
                     java.lang.String optionsFileName,
                     boolean overWrite)
                     throws com.essbase.api.base.EssException
Archives the current database to the file specified.
Parameters:
backupFileName - - Full path to the file where the back up need to be taken. The backup file will be created on the olap server, at the location specified For eg, if you invoke as archiveDatabase("C:/Hyperion/samplebasic.arc"), a file named 'samplebasic.arc' will be created at the location mentioned ie. C:/Hyperion on the olap server.
optionsFileName - - Not used in this release. Reserved for the future, pass empty String in this release.
overWrite - - Pass True if you want to over write to an existing backup file, false otherwise.
Throws:
com.essbase.api.base.EssException

restoreDatabase

void restoreDatabase(java.lang.String backupFileName,
                     boolean forceDiffName,
                     java.lang.String[] Src_Partitions,
                     java.lang.String[] Dest_Partitions)
                     throws com.essbase.api.base.EssException
Restores the database with the data from the specified backup file. Database to be restored should be empty, if not, it will be cleaned first and then it will get restored from the backup file.

The Database must be unloaded before restoring it.

Parameters:
backupFileName - - Full path to the file on the olap server from where restore need to be done.
forceDiffName - - Pass true if you want to force restoring to different application or database name. If true is passed and the application and database name is same that the back up is taken, there is no difference from passing false.
Src_Partitions - - A list of disk partition names to be replaced.
Dest_Partitions - - A list Disk partition name with which the Corresponding source partition names need to be replaced.
Throws:
com.essbase.api.base.EssException

listTransactions

com.essbase.api.datasource.EssTRANSACTION[] listTransactions(short startTimeSrc,
                                                             java.lang.String startTime,
                                                             short listOption,
                                                             java.lang.String fileName)
                                                             throws com.essbase.api.base.EssException
EssListTransactions() sends a request for listing transactions happened after certain time to server and retrieves an array of transaction list as requested.
Parameters:
startTimeSrc - - short, is time given as an input or based on restored database time stamp. Values are: ESS_TRLOG_TIMESPECIFIED - 1, ESS_TRLOG_TIMEFROMDB - 2.
startTime - - String, in the format "MM/dd/yyyy:HH:mm:ss". Time input compared to which all the transactions need to be listed
listOption - - It can be one of IEssCube.ESS_LIST_TRANSACTIONS_* If this is IEssCube.ESS_LIST_TRANSACTIONS_TOFILE or ESS_LIST_TRANSACTIONS_FORCETOFILE out put is not returned in EssTRANSACTION[]. Instead the required content is written to the FileName as comma separated file. If the option is IEssCube.ESS_LIST_TRANSACTIONS_TOFILE, API will error out if the specified file name already exists. The file will be over written if IEssCube.ESS_LIST_TRANSACTIONS_FORCETOFILE is used.
fileName - - String, the file name
Returns:
EssTRANSACTION[] - Array
Throws:
com.essbase.api.base.EssException

replayTransactions

void replayTransactions(com.essbase.api.datasource.EssTRANSACTION_REPLAY replayTran,
                        com.essbase.api.datasource.EssSEQID[] seqIds)
                        throws com.essbase.api.base.EssException
Sends a request to replay transactions happened after certain time to agent. Or it could be an array of sequence Id's. The time could be given or could be based on last replay/restore time.
Parameters:
replayTran - - EssTRANSACTION_REPLAY, specifying input type and number of sequence id's/or time. Values for EssTRANSACTION_REPLAY.InpType are: ESS_REPLAY_BASED_GIVENTIME - 1, ESS_REPLAY_BASED_LASTREPLAYTIME - 2, ESS_REPLAY_BASED_SEQUENCEID - 3.
seqIds - - Array of EssSEQID (can be just one).
Throws:
com.essbase.api.base.EssException

setUMCData

void setUMCData(java.lang.String UMC)
                throws com.essbase.api.base.EssException
Sets the Universal Member CommentEx to the outline without having to restructure the outline.
Parameters:
UMC -
Throws:
com.essbase.api.base.EssException

getUMCData

java.lang.String getUMCData()
                            throws com.essbase.api.base.EssException
Retrieves the Universal Member CommentEx.
Returns:
Universal Member CommentEx String
Throws:
com.essbase.api.base.EssException

clearPartialData

void clearPartialData(java.lang.String regionSpec,
                      boolean isPhysical)
                      throws com.essbase.api.base.EssException
Clears data from a specific region(slice) of an ASO Database. This method is applicable only for ASO database.
Parameters:
regionSpec - the MDX set expression which specifies the region to be cleared.
isPhysical - if set true, data will be cleared physically(cells will be removed from cube) else logical clearing(cell value is set to 0) will be performed.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.1.1.0

getPerformAllocationInstance

IEssPerformAllocation getPerformAllocationInstance()
                                                   throws com.essbase.api.base.EssException
Gets an IEssPerformAllcation instance using which Allocations can be performed.
Returns:
IEssPerformAllocation instance
Throws:
com.essbase.api.base.EssException
Since:
11.1.2

getPerformCustomCalcInstance

IEssPerformCustomCalc getPerformCustomCalcInstance()
                                                   throws com.essbase.api.base.EssException
Gets an IEssPerformCustomCalc instance using which Custom Calculations can be performed.
Returns:
IEssPerformCustomCalc instance
Throws:
com.essbase.api.base.EssException
Since:
11.1.2

verifyMDXExpression

boolean verifyMDXExpression(java.lang.String mdxExpression,
                            long exprType,
                            java.util.List outErrorsIfAny)
                            throws com.essbase.api.base.EssException
Validates the MDX expression based on its type, against this cube.

If the expression is invalid, then this operation will throw EssException indicating the error message details, plus, object will be populated with the list of detailed errors.

If the expression is valid, then, there will be no exception thrown. The return value is a status indicating whether the expression is completely valid or it has warnings. If it has warning(s), the status returned, will be false and your outErrorsIfAny list will be populated with the warning information. For instance, assuming [Scenario] is a dimension/member in your outline, then, "SUBSET(Scenario.Members, -1, 10)" is a executable MDX set expression, but, it will have a warning about a negative index in SUBSET function.

Refer MdxQuery.java sample for an example usage.

Parameters:
mdxExpression - the MDX expression to be validated on this cube.
exprType - the MDX expression type. It can take one of the ESS_ASO_VERIFY_* values based type of expression that needs to be validated. Possible values are ESS_ASO_VERIFY_MEMBER_EXPR, ESS_ASO_VERIFY_TUPLE_EXPR, ESS_ASO_VERIFY_SET_EXPR, ESS_ASO_VERIFY_NUMERIC_EXPR. For example, if the expression to be validated is for POV, this argument should be set to ESS_ASO_VERIFY_SET_EXPR because POV is expected to be an MDX set expression.
outErrorsIfAny - an output object for collecting the warnings/errors returned by Essbase. This object needs to be instantiated by the caller so that Essbase can populate the messages (if any). Note that, if this List object is non-empty, this operation will be appending the returned warnings/errors. So, if you are reusing your outErrorsIfAny object and like to see the errors corresponding to this particular call only, please make sure that you clear this list object before invoking this method. The list will contain elements of type EssPerformAllocationError only.
Returns:
true - if MDX expression is valid; false - if MDX expression is executable with warnings.
Throws:
com.essbase.api.base.EssException - if (1) the expression is invalid or (2) the operation failed for other reasons such as failing to connect to Essbase. In the second scenario, the exception message will indicate the error occured and there will be no errors returned within your outErrorsIfAny list operation failed before it could verify the expression.
Since:
11.1.2
See Also:
EssPerformAllocationError

createDrillThroughURL

void createDrillThroughURL(java.lang.String URLName,
                           boolean bIsLevel0,
                           java.lang.String URLLink,
                           java.lang.String[] drillRegions)
                           throws com.essbase.api.base.EssException
. This creates a drill through URL within this database/cube with the specified URL definition.
Parameters:
URLName - Name of the URL.
bIsLevel0 -
URLLink - URL XML
drillRegions - List of Symmetric regions.
Throws:
com.essbase.api.base.EssException - If an error occurs.
Since:
11.1.1.3

listDrillThroughURLs

IEssURLDrillThrough[] listDrillThroughURLs()
                                           throws com.essbase.api.base.EssException
Lists the drill through URLs within this database.
Returns:
array of IEssURLDrillThrough instances.
Throws:
com.essbase.api.base.EssException - If an error occurs.
Since:
11.1.1.3

getDrillThroughURL

IEssURLDrillThrough getDrillThroughURL(java.lang.String URLName)
                                       throws com.essbase.api.base.EssException
Get the drill through URL within this database outline with specified URLName.
Parameters:
URLName - Name of the URL to be retrieved.
Returns:
an instance of IEssURLDrillThrough of the URL specified by the URLName.
Throws:
com.essbase.api.base.EssException - If an error occurs.
Since:
11.1.1.3

getCellDrillThroughReports

java.lang.String[] getCellDrillThroughReports(java.lang.String[] pMembers)
                                              throws com.essbase.api.base.EssException
Gets the drill through reports associated for the specified member combination as an array of XMLs.
Parameters:
pMembers - array of members which are part of member combination.
Returns:
drill through URL XMLs associated with a data cell as an array of Strings
Throws:
com.essbase.api.base.EssException - If an error occurs.
Since:
11.1.1.3

getAsyncProcessLog

java.lang.StringBuffer getAsyncProcessLog(java.lang.String ErrorFileName,
                                          boolean overwrite,
                                          boolean addToBuffer)
                                          throws com.essbase.api.base.EssException
Gets the async process log. Note : This API must follow the call of either unsynchronized dimension build API or unsynchronized data load API.
Parameters:
ErrorFileName - File name to which process log to be written.
overwrite - if set to true it will overwrite the existing file.
addToBuffer - - if set to false then error records will not be appended to returning StringBuffer
Returns:
StringBuffer - a buffer with the errors. Incase of an exception, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs
Since:
11.1.2

getAsyncProcessState

com.essbase.api.datasource.EssBuildDimDataLoadState getAsyncProcessState()
                                                                         throws com.essbase.api.base.EssException
Gets the async process state. Note : This API must follow the call of either unsynchronized dimension build API or unsynchronized data load API.
Returns:
the EssBuildDimDataLoadState structure.
Throws:
com.essbase.api.base.EssException - if an error occurs
Since:
11.1.2

cancelAsyncProcess

java.lang.StringBuffer cancelAsyncProcess(java.lang.String ErrorFileName,
                                          boolean overwrite,
                                          boolean addToBuffer)
                                          throws com.essbase.api.base.EssException
Cancels the async process. Upon successful, the network connection is closed and the log is returned. Note : This API must follow the call of either unsynchronized dimension build API or unsynchronized data load API.
Parameters:
ErrorFileName - file name to which process log to be written.
overwrite - if set to true it will overwrite the existing file.
addToBuffer - - if set to false then error records will not be appended to returning StringBuffer
Returns:
StringBuffer - a buffer with the errors. Incase of an exception, the caller function will not receive the error log as an exception will be thrown, but can get the errors if a file is specified in ErrorFileName param above.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.2

closeAsyncProcess

com.essbase.api.datasource.EssBuildDimDataLoadState closeAsyncProcess()
                                                                      throws com.essbase.api.base.EssException
closes the async process and returns the current state of the process Note : This API must follow the call of either unsynchronized dimension build API or unsynchronized data load API.
Returns:
the EssBuildDimDataLoadState structure.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.2

asyncBuildDimension

void asyncBuildDimension(java.lang.String rulesFileName,
                         int rulesFileType,
                         java.lang.String dataFileName,
                         int dataFileType,
                         java.lang.String userName,
                         java.lang.String password,
                         int buildDimOptions,
                         java.lang.String tmpOtlFileName)
                         throws com.essbase.api.base.EssException
Asyncronously loads data in to a Cube. With incBuildOption equal to ESS_INCDIMBUILD_ALL, it is self-complete dimension build API. With all other valid options for “incBuildOption” the API can be imbedded in incremental dimension build API sequence. Note : It returns error if the data object is located in client. The network connection between client and server is still active even though the function retuned. User must explicitly call closeAsyncProcess() to close the connection.
Parameters:
rulesFileName - Rules file name.
rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).
dataFileName - Data file Name.
dataFileType - Date file type (Example: IEssOlapFileObject.TYPE_TEXT).
userName - Login-id, in the case of FTP based data source. Otherwise, can be null.
password - Password, in the case of FTP based data source. Otherwise, can be null.
buildDimOptions - One of the IEssCube.ESS_INCDIMBUILD_* options
tmpOtlFileName - FileName for the Temporary Outline.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.2

asyncLoadData

void asyncLoadData(int rulesObjType,
                   java.lang.String rulesFileName,
                   int dataObjType,
                   java.lang.String dataFileName,
                   boolean abortOnError,
                   java.lang.String userName,
                   java.lang.String password)
                   throws com.essbase.api.base.EssException
Allows the importing of data from text files to this cube. The rule file can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. Note : It returns error if the data object is located in client. The network connection between client and server is still active even though the function retuned. User must explicitly call closeAsyncProcess() to close the connection. Only text files are supported from a client file-system.
Parameters:
rulesObjType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data".
dataObjType - The data file object type. Values from IEssOlapFileObject.TYPE_*
dataFileName - The data file name in the olap server's app/cube directory. For eg, for the file named data.txt in olap server's app/cube directory pass "Data".
abortOnError - If true import stops on the first error otherwise continues.
userName - external data source username.
password - external data source password.
Throws:
com.essbase.api.base.EssException - if an error occurs
Since:
11.1.2

asyncLoadData

void asyncLoadData(int rulesFileType,
                   java.lang.String rulesFileName,
                   int dataFileType,
                   java.lang.String dataFileName,
                   boolean abortOnError,
                   java.lang.String userName,
                   java.lang.String password,
                   int bufferId)
                   throws com.essbase.api.base.EssException
Allows the importing of data from text files to this ASO cube. This has a provision to specify the Buffer Id. The rule file can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. Note : It returns error if the data object is located in client. The network connection between client and server is still active even though the function retuned. User must explicitly call closeAsyncProcess() to close the connection. Only text files are supported from a client file-system.
Parameters:
rulesFileType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.
rulesFileName - The rules file name in the olap server. For eg, for the rules file named Data.rul in olap server's app/cube directory pass "Data".
dataFileType - The data file object type. Values from IEssOlapFileObject.TYPE_*
dataFileName - The data file name in the olap server's app/cube directory. For eg, for the file named data.txt in olap server's app/cube directory pass "Data".
abortOnError - If true import stops on the first error otherwise continues.
userName - external data source username.
password - external data source password.
bufferId - The Buffer Identifier.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.2

Skip navigation links