ESS_MBRINFO_T

Contains information about an outline member.

typedef struct ESS_MBRINFO_T
{
   ESS_MBRNAME_T         szMember;      
   ESS_USHORT_T          usLevel;       
   ESS_USHORT_T          usGen;         
   ESS_USHORT_T          usConsolidation; 
   ESS_BOOL_T            fTwoPass;      
   ESS_BOOL_T            fExpense;      
   ESS_USHORT_T          usConversion;  
   ESS_MBRNAME_T         szCurMember;   
   ESS_USHORT_T          usTimeBalance; 
   ESS_USHORT_T          usSkip;        
   ESS_USHORT_T          usShare;       
   ESS_USHORT_T          usStorage;     
   ESS_USHORT_T          usCategory;    
   ESS_USHORT_T          usStorageCategory; 
   ESS_MBRCOMMENT_T      szComment;     
   ESS_ULONG_T           ulChildCount;
   ESS_MBRNAME_T         szDimName;     
   ESS_BOOL_T            fAttributed;
   ESS_ATTRIBUTEVALUE_T  Attribute;
   ESS_BOOL_T            fHasRelDesc;  
   ESS_BOOL_T            fHasHAEnabled; 
   ESS_PVOID_T,          pLastSibling;
   ESS_ULONG_T,          ulSiblingCount; 
   ESS_BOOL_T,           fFormula; 
   ESS_BOOL_T,           fUda; 
   ESS_BOOL_T,           fAlias; 
   ESS_BOOL_T,           fIndependentDim;
   ESS_UCHAR_T,          ucHierarchyType; 
   ESS_UCHAR_T,          ucDimSolveOrder;
   ESS_UCHAR_T,          ucSolveOrder;
   ESS_BOOL_T,           fNonUniqueName;
   ESS_BOOL_T,           fFlow; 
   
} ESS_MBRINFO_T, *ESS_PMBRINFO_T, **ESS_PPMBRINFO_T;
Data TypeFieldDescription
ESS_MBRNAME_TszMemberMember name. This field can be set only by the caller when creating the member.
ESS_USHORT_TusLevelLevel of the member in the outline. This field cannot be modified.
ESS_USHORT_TusGenGeneration of the member in the outline. This field cannot be modified.
ESS_USHORT_TusConsolidationUnary consolidation type. It can be one of the following:

  • ESS_UCALC_ADD

  • ESS_UCALC_SUB

  • ESS_UCALC_MULT

  • ESS_UCALC_DIV

  • ESS_UCALC_PERCENT

  • ESS_UCALC_NOOP

ESS_BOOL_TfTwoPassESS_TRUE if two-pass calculation member.
ESS_BOOL_TfExpenseESS_TRUE if expense member.
ESS_USHORT_TusConversionCurrency Conversion type. This is valid only for members of the Accounts dimension. It can be one of the following:

  • ESS_CONV_NONE

  • ESS_CONV_CATEGORY

  • ESS_CONV_NOCONV

ESS_MBRNAME_TszCurMemberIf member is of the Accounts dimension and usConversion is ESS_CONV_CATEGORY. This field defines the currency category. If member is of the Country dimension. This field defines the currency name. This field is undefined in all other situations.
ESS_USHORT_TusTimeBalanceTime balance option. Valid field only for members of the Accounts dimension. It can be one of the following:

  • ESS_TIMEBAL_NONE

  • ESS_TIMEBAL_FIRST

  • ESS_TIMEBAL_LAST

  • ESS_TIMEBAL_AVG

ESS_USHORT_TusSkipTime balance skip option. Valid field only for members of the Accounts dimension if usTimeBalance is not equal to ESS_TIMEBAL_NONE. It can be one of the following:

  • ESS_SKIP_NONE

  • ESS_SKIP_MISSING

  • ESS_SKIP_ZEROS

  • ESS_SKIP_BOTH

ESS_USHORT_TusShareShare option. It can be one of the following:

  • ESS_SHARE_DATA (default value)

  • ESS_SHARE_DYNCALCSTORE

  • ESS_SHARE_DYNCALCNOSTORE

  • ESS_SHARE_LABEL

  • ESS_SHARE_NEVER

  • ESS_SHARE_SHARE (Valid for level 0 members only)

ESS_USHORT_TusStorageDimension storage type. This field is valid only for dimension members and can be one of the following:

  • ESS_DIMTYPE_DENSE

  • ESS_DIMTYPE_SPARSE

ESS_USHORT_TusCategoryDimension category. This field is valid only for dimensions and attribute members. It can be one of the following:

  • ESS_CAT_ACCOUNTS

  • ESS_CAT_ATTRCALC (for internal use only)

  • ESS_CAT_ATTRIBUTE

  • ESS_CAT_COUNTRY

  • ESS_CAT_CURPARTITION (for non-currency databases only)

  • ESS_CAT_NONE

  • ESS_CAT_TIME

  • ESS_CAT_TYPE (for currency databases only)

ESS_USHORT_TusStorageCategoryDimension storage category. This field is valid only for dimensions and attribute members. Optimizes the storage types of dimensions when the outline is configured for automatic optimization. It can be one of the following:

  • ESS_STORECAT_ACCOUNTS

  • ESS_STORECAT_ATTRCALC (for internal use only)

  • ESS_STORECAT_ATTRIBUTE

  • ESS_STORECAT_BUSUNIT

  • ESS_STORECAT_CUSTOMER

  • ESS_STORECAT_DIST

  • ESS_STORECAT_GEOG

  • ESS_STORECAT_MARKET

  • ESS_STORECAT_ORGAN

  • ESS_STORECAT_OTHER

  • ESS_STORECAT_PRODUCT

  • ESS_STORECAT_SCENARIO

  • ESS_STORECAT_TIME

  • ESS_STORECAT_UNITS

ESS_MBRCOMMENT_TszCommentMember comment array
ESS_ULONG_TulChildCountThis field contains the total number of children of the member specified in ESS_MBRNAME_T.
ESS_MBRNAME_TszDimNameAttribute dimension name
ESS_BOOL_TfAttributedIndicates whether the member has attributes associated with it. Values: ESS_TRUE and ESS_FALSE.
ESS_ATTRIBUTEVALUE_TAttributeAttribute value
ESS_BOOL_TfHasRelDescThe member has relational descendants.
ESS_BOOL_TfHasHAEnabledThe dimension has relational partitions enabled.

Valid only for Dimension members.

RSS_PVOID_TpLastSiblingLast sibling pointer
ESS_ULONG_TuSiblingCountSibling count
ESS_BOOL_TfFormulaIndicates whether has a formula
ESS_BOOL_TfUdaIndicates whether has UDA
ESS_BOOL_TfAliasIndicates whether has alias
ESS_BOOL_TfIndependentDimFor dimensions on varying attribute outlines; indicates if an independent dimension
ESS_UCHAR_TucHierarchyTypeDefines the type of hierarchy based on the generation.

If the member is generation 1, then:

  • ESS_STORED_HIERARCHY indicates a single stored hierarchy

  • ESS_DYNAMIC_HIERARCHY indicates a single dynamic hierarchy

  • ESS_MULTIPLE_HIERARCHY_IS_ENABLED indicates multiple hierarchies

If the member is generation 2, then:

  • ESS_STORED_HIERARCHY indicates a sub hierarchy

  • ESS_DYNAMIC_HIERARCHY indicates a dynamic sub hierarchy

ESS_UCHAR_TudDimSolveOrderDefines the solve order for the dimension.
ESS_UCHAR_TudSolveOrderIndicates the solve order value. The solve order can be 0-127.
ESS_BOOL_TfNonUniqueNameIndicates whether the member name is unique
ESS_BOOL_TfFlowIndicates that member is type Flow