AnalysisHierarchyLabels

This component runs the Analysis Hierarchy (ANH) function and allows you to define an analysis hierarchy, for an analysis dimension, and set up the analysis hierarchy codes.

You can use an analysis hierarchy to reclassify the analysis codes for a dimension to provide a second, higher level of analysis for reporting purposes.

For example, you might have defined analysis dimension codes for:

  • sales areas and wish to summarize them into sales regions.
  • products and wish to summarize them into product category.

You can define more than one analysis hierarchy for an analysis dimension. For example, you may want to group the products in the product analysis dimension, by product category and by product size.

Methods

BulkCreateOrAmend

Driver Type: DJI

Use this method for the bulk creation or amendment of an Analysis Hierarchy, or where performance is critical.

For further information, see Analysis Hierarchy Labels DJI User Guide.

Closed

Driver Type: SASI

Use this method to change the status of one or more analysis hierarchy labels to Closed.

CreateAsDraft
Driver Type: SASI
Use this method to change the status of one or more analysis hierarchy labels to CreateAsDraft.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more analysis hierarchy labels. An analysis hierarchy label and/or an analysis hierarchy code is created if it does not exist and amended if it does.
Delete
Driver Type: SASI
Use this method to remove one or more analysis hierarchy labels.
Note: All analysis hierarchy codes that may exist for the analysis hierarchy label are deleted.
Hidden
Driver Type: SASI
Use this method to change the status of one or more analysis hierarchy labels to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more analysis hierarchy labels to Open..
Query
Driver Type: Export
Use this method to obtain Analysis Hierarchy details or to extract Analysis Hierarchy data from Use this method to change the status of one or more analysis hierarchy labels to SunSystems.
SuspendedHeld
Driver Type: SASI
Use this method to change the status of one or more analysis hierarchy labels to Suspended/Held.

Mandatory fields

When creating or amending analysis hierarchy labels, the following must be supplied:

  • Analysis Dimension ID Short Heading - payload element <AnlCat_SHead>
  • Analysis Hierarchy Label - payload element <AnalysisHierarchyLabel>

When creating or amending analysis hierarchy codes, a value for Analysis Hierarchy Code (payload element <AnalysisHierarchyCode>) must be supplied.

Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

  • Analysis Hierarchy Codes
  • Analysis Dimension Id.