xtrInclusion Value List

Determines if a category is included in a model or a cube.

Applies To

Discussion

Use the constants of this value list with the DrillInclusion property of the DrillDown and DateDrillDown objects, and the Inclusion property of the Category, SpecialCategory, DateLevel, and Level objects. The constants determine under what circumstances categories are included in a model or cube.

If a constant of xtrInclusion is not assigned to a Category or SpecialCategory, the category inherits the setting of the related Level or DateLevel object.

When it is necessary to complete a cube, Transformer includes ancestors of a category, regardless of the inclusion setting.

Constant	Description
trInclusionDefault	Level: trInclusionWhenNeeded. Category: uses the setting of the level in which the category resides.
trInclusionExclude	Excludes the category, the descendants, and all related data from the cube. To use this constant: the category cannot be the share category of another category or link to a special category.
trInclusionGenerate	Always includes the category.
trInclusionSuppress	Level: Retains categories in the model but excludes from cubes those categories with a blank source value. Categories: Excludes the category from the cube but includes all the descendants and their values. To use this constant: the category cannot be the share category of another category or link to a special category.
trInclusionWhenNeeded	Includes the category in the model but omits it from the cube when the category has a zero value.