ConsolidatedCountUnique

ConsolidatedCountUnique counts the number of unique elements for which data points actually exist for the specified consolidation. The unique elements are counted along one dimension of the consolidated cell.

This function is valid in both rules and TurboIntegrator processes.

Syntax

ConsolidatedCountUnique( flag-value, unique-along-dimension-name, cube-name,elem_1, elem_2, . . . );

Arguments

flag-value
The flag-value is the sum of the following option values:
  • 1 - Use weighting when computing the number of unique elements for which data points actually exist. If this option value is not included in the flag-value sum, the raw values of elements within the consolidation are used.

    The following conditions might affect whether zeros are included in the calculation.

    • If zero is specified as the weighting of some elements, then the Planning Analytics database configuration parameter ZeroWeightOptimization=F must be set for these elements to be included in the calculation of the number of unique elements. Without this configuration parameter, the elements for which the weighting is zero are eliminated from the consolidation list, and are therefore not included when calculating the number of unique elements.
    • If you want cells containing the value zero to be included when calculating the number of unique elements with actual values, UNDEFVALS must be set in the rules for the cube that is specified by the cube-name argument. This ensures that when a zero is assigned to a cell of the cube, an actual zero value is stored in the cell and the zero value is included when calculating the number of unique elements with actual values.
    • If the rules for the cube that is specified by the cube-name argument include a SKIPCHECK statement, zeros are always ignored when calculating the number of unique elements with actual values. Remove the SKIPCHECK statement from the rule to include zeros in the calculation of the number of unique elements with actual values.
  • 2 - Ignore zero values. If this value is included in the flag-value sum, zero values will not be included in the calculation of the number of unique elements with actual values.
There are three valid values for flag-value.
  • 1 - Use consolidation weighting when computing the number of unique elements with actual values.
  • 2 - Ignore zero values when computing the number of unique elements with actual values.
  • 3 - Use consolidation weighting and ignore zero values when computing the number of unique elements with actual values.
unique-along-dimension-name
The dimension along which unique element entries with real data are to be counted.
cube-name

Name of the cube where the values reside.

If the function is running as part of a cube rule, and NOT as part of a TurboIntegrator process, the cube-name argument can be specified as an empty string to mean the current cube.

element_1, element_2, …

Dimension element names that define the intersection of the cube which is the consolidated value to be processed.

Arguments element_1 through element_n are sequence-sensitive. element_1 must be an element from the first dimension of the cube, element_2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables.

Example

In a cube called Income Statement with three dimensions: Regions, Time, and Income Statement, the Income Statement dimension contains an element called Gross Sales for the overall sales number. To count how many regions had some gross sales in the year 2010 write: 
ConsolidatedCountUnique( 3, 'Regions', 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

This example uses consolidation weighting and ignores zero values when computing the number of unique elements with actual values.