# 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
- Account member time balance skip values
- Account member time balance values
- Dimension categories
- Dimension categories (tags)
- Generation and level options
- Query types
- Query options
- Restructure values
- Share constants
- Sorting options

### Account member currency conversion category values

Value | Description
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

Value | Description
ESS_SKIP_NONE | Don't skip anything
ESS_SKIP_MISSING | Skip the value if the data is #missing
ESS_SKIP_ZEROS | Skip the value if the data is 0
ESS_SKIP_BOTH | Skip the value if the data is #missing or 0

### Account member time balance values

Value | Description
ESS_TIMEBAL_NONE | No time balance
ESS_TIMEBAL_FIRST | First time balance member
ESS_TIMEBAL_LAST | Last time balance member
ESS_TIMEBAL_AVG | Average time balance member

### Dimension categories

Used for optimizing storage when using storage auto-configure

Value | Description
ESS_STORECAT_ACCOUNTS | Accounts storage category
ESS_STORECAT_ATTRCALC | Attribute calculation (aggregation) storage category
ESS_STORECAT_ATTRIBUTE | Attribute storage category
ESS_STORECAT_BUSUNIT | Business Unit storage category
ESS_STORECAT_CUSTOMER | Customer storage category
ESS_STORECAT_DIST | Distribution Channel storage category
ESS_STORECAT_GEOG | Geographical Location storage category
ESS_STORECAT_MARKET | Market storage category
ESS_STORECAT_ORGAN | Organization storage category
ESS_STORECAT_OTHER | None or don't know storage category
ESS_STORECAT_PRODUCT | Product storage category
ESS_STORECAT_SCENARIO | Scenario storage category
ESS_STORECAT_TIME | Time storage category
ESS_STORECAT_UNITS | Units storage category

### Dimension categories (tags)

Value | Description
ESS_CAT_ACCOUNTS | Accounts dimension
ESS_CAT_ATTRCALC | Attribute calculation dimension or member. Used internally for aggregation.
ESS_CAT_ATTRIBUTE | Attribute dimension or member
ESS_CAT_COUNTRY | Country dimension
ESS_CAT_CURPARTITION | Currency partition dimension. Valid only in non-currency databases.
ESS_CAT_NONE | No category
ESS_CAT_TIME | Time dimension
ESS_CAT_TYPE | Type dimension. Valid only in currency databases.

### Generation and level options

You can use with EssOtlGetGenNames() and EssOtlGetLevelNames()

Value | Description
ESS_GENLEV_ALL | Returns default and user-defined names
ESS_GENLEV_ACTUAL | Returns 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

Value | Description
ESS_MEMBERSONLY | Valid for ESS_SEARCH, ESS_WILDSEARCH
ESS_ALIASESONLY | Valid for ESS_SEARCH, ESS_WILDSEARCH
ESS_MEMBERSANDALIASES | Valid 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_INCLUDEHYBRIDANALYSIS | Includes relational sources if present.
ESS_EXCLUDEHYBRIDANALYSIS | Excludes 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

Value | Description
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
ESS_DOR_FORCE_ALLDATA | Reload all data

### Share constants

Value | Description
ESS_SHARE_DYNCALCNOSTORE | Shared 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_DATA | Normal member (default value)
ESS_SHARE_LABEL | Label member. Do not store data for this member.
ESS_SHARE_NEVER | Never 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

Value | Description
ESS_SORT_ASCENDING | Sort in ascending order
ESS_SORT_DESCENDING | Sort in descending order
ESS_SORT_USERDEFINED | User supplies a custom sorting routine