Symbolic Constant Definitions

The following tables describe the symbolic constants used specifically by the Outline API. These constants are defined in the Essbase Visual Basic global text file esb32.bas.

Restructure values

ValueDescription
ESB_DOR_ALLDATAKeep all data
ESB_DOR_NODATADiscard all data
ESB_DOR_LOWDATAKeep only level 0 data
ESB_DOR_INDATAKeep only input data

Account member currency conversion category values

ValueDescription
ESB_CONV_NONEDefault conversion category. Member inherits category from parent.
ESB_CONV_CATEGORYDefine a currency conversion category for this member
ESB_CONV_NOCONVNo conversion for this member

Account member time balance values

ValueDescription
ESB_TIMEBAL_NONENo time balance
ESB_TIMEBAL_FIRSTFirst time balance member
ESB_TIMEBAL_LASTLast time balance member
ESB_TIMEBAL_AVGAverage time balance member

Account member time balance skip values

Only valid if time balance does not equal ESB_TIMEBAL_NONE

ValueDescription
ESB_SKIP_NONEDon't skip anything
ESB_SKIP_MISSINGSkip the value if the data is #missing
ESB_SKIP_ZEROSSkip the value if the data is 0
ESB_SKIP_BOTHSkip the value if the data is #missing or 0

Share constants

ValueDescription
ESB_SHARE_DATANormal member (default value)
ESB_SHARE_NEVERNever share this member, even if it would normally be an implicit share.
ESB_SHARE_LABELLabel member. Do not store data for this member.
ESB_SHARE_SHAREShared member. This member cannot have children and must have the actual member with the same name in the same dimension.

Dimension categories (tags)

ValueDescription
ESB_CAT_NONENo category
ESB_CAT_ACCOUNTSAccounts dimension
ESB_CAT_TIMETime dimension
ESB_CAT_COUNTRYCountry dimension
ESB_CAT_TYPEType dimension. This dimension is valid only in currency databases
ESB_CAT_CURPARTITIONCurrency partition dimension. Valid only in non-currency databases.

Dimension categories

Used for optimizing storage when using storage auto-configure

ValueDescription
ESB_STORECAT_OTHERNone or don't know storage category
ESB_STORECAT_TIMETime storage category
ESB_STORECAT_UNITSUnits storage category
ESB_STORECAT_SCENARIOScenario storage category
ESB_STORECAT_ACCOUNTSAccounts storage category
ESB_STORECAT_PRODUCTProduct storage category
ESB_STORECAT_ORGANOrganization storage category
ESB_STORECAT_MARKETMarket storage category
ESB_STORECAT_CUSTOMERCustomer storage category
ESB_STORECAT_DISTDistribution Channel storage category
ESB_STORECAT_BUSUNITBusiness Unit storage category
ESB_STORECAT_GEOGGeographical Location storage category

Sorting options

ValueDescription
ESB_SORT_ASCENDINGSort in ascending order
ESB_SORT_DESCENDINGSort in descending order

Query types

Used for defining the operation to perform in ESB_PREDICATE_T

Value
ESB_CHILDREN
ESB_DESCENDANTS
ESB_BOTTOMLEVEL
ESB_SIBLINGS
ESB_SAMELEVEL
ESB_SAMEGENERATION
ESB_PARENT
ESB_DIMENSION
ESB_NAMEDGENERATION
ESB_NAMEDLEVEL
ESB_SEARCH
ESB_WILDSEARCH
ESB_USERATTRIBUTE
ESB_ANCESTORS

Query options

You can specify for certain query types in ESB_PREDICATE_T

Value
Description
ESB_MEMBERSONLY
Valid for ESB_SEARCH, ESB_WILDSEARCH
ESB_ALIASESONLY
Valid for ESB_SEARCH, ESB_WILDSEARCH
ESB_MEMBERSANDALIASES
Valid for ESB_SEARCH, ESB_WILDSEARCH
ESB_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 ESB_PMBRCOUNTS_T.

Generation and level options

You can use with EsbOtlGetGenNames() and EsbOtlGetLevelNames()

Value
Description
ESB_GENLEV_ALL
Returns default and user-defined names
ESB_GENLEV_ACTUAL
Returns only names that are user-defined
ESB_GENLEV_DEFAULT
Returns all default names, including the default names for generations and levels that also have user-defined names
ESB_GENLEV_NOACTUAL
Returns all default names, excluding the default names for generations and levels that also have user-defined names