Symbolic Constant Definitions

This section describes the symbolic constants used by the Outline API. These constants are defined in the Essbase Outline API C language header file essotl.h.

Account member currency conversion category values

ValueDescription
ESS_CONV_NONE Default conversion category. Member inherits category from parent.
ESS_CONV_CATEGORY Define a currency conversion category for this member
ESS_CONV_NOCONV No conversion for this member

Account member time balance skip values

Only valid if time balance is not ESS_TIMEBAL_NONE

ValueDescription
ESS_SKIP_NONEDon't skip anything
ESS_SKIP_MISSINGSkip the value if the data is #missing
ESS_SKIP_ZEROSSkip the value if the data is 0
ESS_SKIP_BOTHSkip the value if the data is #missing or 0

Account member time balance values

ValueDescription
ESS_TIMEBAL_NONENo time balance
ESS_TIMEBAL_FIRSTFirst time balance member
ESS_TIMEBAL_LASTLast time balance member
ESS_TIMEBAL_AVGAverage time balance member

Dimension categories

Used for optimizing storage when using storage auto-configure

ValueDescription
ESS_STORECAT_ACCOUNTSAccounts storage category
ESS_STORECAT_ATTRCALCAttribute calculation (aggregation) storage category
ESS_STORECAT_ATTRIBUTEAttribute storage category
ESS_STORECAT_BUSUNITBusiness Unit storage category
ESS_STORECAT_CUSTOMERCustomer storage category
ESS_STORECAT_DISTDistribution Channel storage category
ESS_STORECAT_GEOGGeographical Location storage category
ESS_STORECAT_MARKETMarket storage category
ESS_STORECAT_ORGANOrganization storage category
ESS_STORECAT_OTHERNone or don't know storage category
ESS_STORECAT_PRODUCTProduct storage category
ESS_STORECAT_SCENARIOScenario storage category
ESS_STORECAT_TIMETime storage category
ESS_STORECAT_UNITSUnits storage category

Dimension categories (tags)

ValueDescription
ESS_CAT_ACCOUNTSAccounts dimension
ESS_CAT_ATTRCALCAttribute calculation dimension or member. Used internally for aggregation.
ESS_CAT_ATTRIBUTEAttribute dimension or member
ESS_CAT_COUNTRYCountry dimension
ESS_CAT_CURPARTITION Currency partition dimension. Valid only in non-currency databases.
ESS_CAT_NONENo category
ESS_CAT_TIMETime dimension
ESS_CAT_TYPEType dimension. Valid only in currency databases.

Generation and level options

You can use with EssOtlGetGenNames() and EssOtlGetLevelNames()

ValueDescription
ESS_GENLEV_ALLReturns default and user-defined names
ESS_GENLEV_ACTUALReturns only names that are user-defined
ESS_GENLEV_DEFAULT Returns all default names, including the default names for generations and levels that also have user-defined names
ESS_GENLEV_NOACTUAL Returns all default names, excluding the default names for generations and levels that also have user-defined names

Query options

You can specify for certain query types in ESS_PREDICATE_T

ValueDescription
ESS_MEMBERSONLYValid for ESS_SEARCH, ESS_WILDSEARCH
ESS_ALIASESONLYValid for ESS_SEARCH, ESS_WILDSEARCH
ESS_MEMBERSANDALIASESValid for ESS_SEARCH, ESS_WILDSEARCH
ESS_COUNTONLY Valid for any query type. Queries the outline without returning any data. Returns a count of how many members meet the query type by filling in the ulTotalCount field in ESS_PMBRCOUNTS_T.
ESS_INCLUDEHYBRIDANALYSISIncludes relational sources if present.
ESS_EXCLUDEHYBRIDANALYSISExcludes relational sources if present.

Query types

Used for defining the operation to perform in ESS_PREDICATE_T

Values
ESS_CHILDREN
ESS_DESCENDANTS
ESS_BOTTOMLEVEL
ESS_SIBLINGS
ESS_SAMELEVEL
ESS_SAMEGENERATION
ESS_PARENT
ESS_DIMENSION
ESS_NAMEDGENERATION
ESS_NAMEDLEVEL
ESS_SEARCH
ESS_WILDSEARCH
ESS_USERATTRIBUTE
ESS_ANCESTORS
ESS_DTSMEMBERS
ESS_DIMUSERATTRIBUTES

Restructure values

ValueDescription
ESS_DOR_ALLDATA Keep all data
ESS_DOR_NODATA Discard all data
ESS_DOR_LOWDATA Keep only level 0 data
ESS_DOR_INDATA Keep only input data

Share constants

ValueDescription
ESS_SHARE_DYNCALCNOSTOREShared member. A member tagged as no Dynamic Calc And Store.
ESS_SHARE_DYNCALCSTORE Shared member. A member tagged as Dynamic Calc And Store.
ESS_SHARE_DATANormal member (default value)
ESS_SHARE_LABELLabel member. Do not store data for this member.
ESS_SHARE_NEVERNever share this member, even if it would normally be an implicit share.
ESS_SHARE_SHARE Shared member. This member cannot have children and must have the actual member with the same name in the same dimension.

Sorting options

ValueDescription
ESS_SORT_ASCENDINGSort in ascending order
ESS_SORT_DESCENDINGSort in descending order
ESS_SORT_USERDEFINEDUser supplies a custom sorting routine