Constant Definitions

The following constants are defined in the Essbase API:

Attributes Constants
Dimension Tag Constants
Information Flag Constants
Maximum String Lengths
Size Flag Constants

Attributes Constants

The following constants define the data type of the member queried and returned for the usInputMemberType and usOutputMemberType fields of the ESS_ATTRIBUTEQUERY_T structure.

Value Definition
ESS_BASE_DIMENSION A dimension that is not an attribute dimension
ESS_BASE_MEMBER A member that is not an attribute member
ESS_ATTRIBUTE_DIMENSION An attribute dimension
ESS_ATTRIBUTE_MEMBER An attribute member
ESS_ATTRIBUTED_MEMBER A base member or dimension that has attributes associated with it. Also called a standard member or dimension.

The following constant defines the attribute member status for the Status field of the ESS_MBRINFO_T structure.

Value Definition
ESS_MBRSTS_ATTRIBUTE Attribute member status

The following constants define the attribute dimension tag type for the DimTag field of the ESS_DIMENSIONINFO_T structure.

Value Definition
ESS_TTYPE_ATTRIBUTE Attribute tag
ESS_TTYPE_ATTRCALC Attribute calculation tag. Used internally for aggregation.

The following constants define the attribute member data type for the usDataType field of the ESS_ATTRIBUTEVALUE_T structure and the DimDataType field of the ESS_DIMENSIONINFO_T structure.

Value Definition
ESS_ATTRMBRDT_BOOL Boolean data type
ESS_ATTRMBRDT_DATETIME Datetime data type
ESS_ATTRMBRDT_DOUBLE Double data type
ESS_ATTRMBRDT_STRING String data type
ESS_ATTRMBRDT_NONE No data type

The following constants define the type of attribute query operation for the usOperation field of the ESS_ATTRIBUTEQUERY_T structure.

Value Definition
ESS_EQ Equal to
ESS_NEQ Not equal to
ESS_GT Greater than
ESS_LT Less than
ESS_GTE Greater than or equal to
ESS_LTE Lesser than or equal to
ESS_TYPEOF Type of
ESS_ALL All

C API Attributes Terminology

Bucketing Type

When building a dimension, you can associate a zero-level attribute member of type ESS_ATTRMBRDT_DOUBLE with a range of data in a relational source.

Bucketing type determines the upper or lower limit of the data range.

See usBucketingType.

ESS_ATTRIBUTE_DIMENSION and ESS_ATTRIBUTE_MEMBER:

ESS_ATTRIBUTE_DIMENSION is an attribute dimension.

ESS_ATTRIBUTE_MEMBER is a member of an attribute dimension.

See ESS_ATTRIBUTEQUERY_T.

Also see EssCheckAttributes().

ESS_ATTRIBUTED_MEMBER:

ESS_ATTRIBUTED_MEMBER is a member (of a base dimension) which has an attribute member associated with it.

See ESS_ATTRIBUTEQUERY_T.

Also see EssCheckAttributes().

ESS_BASE_DIMENSION and ESS_BASE_MEMBER:

ESS_BASE_DIMENSION is a standard dimension that has an attribute dimension associated with it.

ESS_BASE_MEMBER is a member of a base dimension.

See ESS_ATTRIBUTEQUERY_T.

Also see EssCheckAttributes().

ESS_STANDARD_DIMENSION and ESS_STANDARD_MEMBER:

ESS_STANDARD_DIMENSION is any dimension that is not an attribute dimension.

ESS_STANDARD_MEMBER is a member of a standard dimension.

See ESS_ATTRIBUTEQUERY_T.

Also see EssCheckAttributes().

Long Name

A zero-level attribute member that is not of type ESS_ATTRMBRDT_STRING is uniquely identified by a long name.

A zero-level attribute member of type ESS_ATTRMBRDT_STRING must itself be unique.

See the following structures:

Also see the following functions:

And, see Notes on Adding an Attribute Member.

Short Name

A zero-level attribute member that is not of type ESS_ATTRMBRDT_STRING is called a short name.

It is provided to a function as a parameter of type ESS_STR_T.

See EssOtlFindAttributeMembers().


Dimension Tag Constants

The following constants define the available information flags used in the DimTag field of the ESS_DIMENSIONINFO_T structure.

ConstantDefinition
ESS_TTYPE_NONENo dimension type. Value for DimTag field of ESS_DIMENSIONINFO_T.
ESS_TTYPE_CATEGORYAccounts: Currency ACCOUNTS tag. Value for DimTag field of ESS_DIMENSIONINFO_T
ESS_TTYPE_CNAMECountry: Currency COUNTRY tag. Value for DimTag field of ESS_DIMENSIONINFO_T
ESS_TTYPE_CTIMETime: Currency TIME tag. Value for DimTag field of ESS_DIMENSIONINFO_T
ESS_TTYPE_TYPEType: Currency TYPE tag. Value for DimTag field of ESS_DIMENSIONINFO_T
ESS_TTYPE_PARTITIONCurrency PARTITION tag. Value DimTag field of ESS_DIMENSIONINFO_T

Information Flag Constants

The following constants define the available information flags used in the DbReqFlags (Data Load) field of the ESS_DBREQINFO_T structure.

ConstantDefinition
ESS_DBREQFLAG_CALCDEFDefault flag for DbReqFlags field. Used the default calc script. Value: 0x00000001.
ESS_DBREQFLAG_CALCDSCRCustom calc script flag for DbReqFlags field. Used a custom calc script. Value: 0x00000002.

Maximum String Lengths

The following constants define the maximum lengths of various string types in the Essbase API. All of these constants include the terminating NULL character:

ConstantDefinition
ESS_ALIASNAMELENMaximum length of an alias table name
ESS_APPNAMELENMaximum length of an application name
ESS_CRDB_MAXIMUMMaximum dimension number for a Currency database
ESS_DBNAMELENMaximum length of a database name
ESS_DESCLENMaximum length of an application or database description
ESS_FTRNAMELENMaximum length of a filter name
ESS_LINELENMaximum length of a line in a report
ESS_MBRCOMMENTEXLENMaximum length of an extended member comment
ESS_MBRNAMELENMaximum length of a member name
ESS_NAMELENMaximum length of a general name
ESS_PASSWORDLENMaximum length of a user password
ESS_PATHLENMaximum length of a file path name
ESS_OBJNAMELENMaximum length of an object name
ESS_SVRNAMELENMaximum length of a server name
ESS_USERNAMELENMaximum length of a user or group name

Size Flag Constants

The following constants define the maximum and minimum size for the MaxMemIndex and IndexPageSize fields of the ESS_DBSTATE_T structure.

ConstantDefinition
ESS_INDEXCACHEMIN_SIZEMinimum index cache size for the MaxMemIndex field of the ESS_DBSTATE_T structure. Value: 1048576. No maximum value is defined.
ESS_INDEXPAGEMAX_SIZEMaximum index page size for the IndexPageSize field of the ESS_DBSTATE_T structure. Value: 8192
ESS_INDEXPAGEMIN_SIZEMinimum index page size for the IndexPageSizeMin field of the ESS_DBSTATE_T structure. Value: 1024