EssOtlSetAggLevelUsage

Applies view selection properties to stored hierarchies.

Syntax

ESS_FUNC_M EssOtlSetAggLevelUsage (hOutline, hMember, sAgglevelUsage);

Parameter

Data Type

Description

hOutline

ESS_HOUTLINE_T

Outline context handle (input)

Value

hMember

ESS_HMEMBER_T

A hierarchy member (input).

sAgglevelUsage

ESS_SHORT_T

One of the Level Usage Constants (input).

Constant	Value	Description
ESS_AGGLEVELUSAGE_DEFAULT	11	On primary hierarchies, consider all levels. Do not aggregate secondary hierarchies unless alternate rollups are enabled.
ESS_AGGLEVELUSAGE_ALL	12	Consider all levels for aggregation. This is same as default for primary hierarchies, but not for secondary hierarchies.
ESS_AGGLEVELUSAGE_NOAGGREGATION	13	Do not aggregate along this hierarchy. All views selected are at the input level.
ESS_AGGLEVELUSAGE_BOTTOMONLY	14	Applies only to secondary hierarchies. Consider only lowest level of this hierarchy for aggregation.
ESS_ AGGLEVELUSAGE_TOPONLY	15	Applies only to primary hierarchies. Consider only topmost level of this hierarchy for aggregation.
ESS_ AGGLEVELUSAGE_BOTTOMTOP	16	Applies to primary hierarchies. Select top and bottom levels only.

Notes

This function is applicable only to Release 9.3 or higher aggregate storage databases.
Use this function to apply view selection properties to stored hierarchies to restrict Essbase from choosing certain levels for aggregation.

Return Value

Returns 0 if successful.

Example

   ESS_STS_T         sts = ESS_STS_NOERR;
   ESS_HOUTLINE_T    hOutline = ESS_NULL;
   ESS_HMEMBER_T     hMember = ESS_NULL;
   ESS_SHORT_T       sAggLevelUsage = 0;

   /* code to assign hOutline variable omitted */
   /* code to assign hMember variable omitted */
   /* code to assign sAggLevelUsage variable omitted */

   if (hOutline && hMember)
   {
       sts = EssOtlSetAggLevelUsage (hOutline, hMember, sAggLevelUsage);
 if (sts)
   printf("Error (%ld) setting AggLevelUsage\n", sts);
   }
   else
   {
       if (!hOutline)
          printf("Outline not provided\n");
       if (!hMember)
          printf("Member not provided\n");
   }