Supersession macro commands

The Supersession macro command performs the supersession logic at a scenario level. The supersession definitions are stored in a code list. When you execute the macro, the changeover date is set and the historical measure data is copied from the predecessor to the successor items, at the specified locations, for the cycle period horizon.

This table describes the parameters used for the Supersession macro:

Parameter Description
Code list The code list containing the supersession definitions.
Predecessor Item Attribute The attribute in the code list containing the predecessor items. This is validated to base-level elements in the scenario
Successor Item Attribute The attribute in the code list containing the successor items. This is validated to base-level elements in the scenario.
Predecessor Location Attribute

The attribute in the code list containing the predecessor locations for transfer. The attribute values within the codelist can be set at base or aggregate level (aggregate level only allowed if Successor Location Attribute is not populated). This is validated against the module hierarchy at run-time and an error message is displayed if no value is defined.

Changeover Date Attribute The attribute in the code list containing the date of the supersession. This can be any date (does not require a calendar bucket start or end date).
Transfer Factor Attribute

The attribute in the code list containing the transfer factor from the predecessor item and measure to the successor item and measure. This can be a numeric value > 0.

Introduction Date Measure Code The measure code to copy the changeover date of successor item / locations. The introduction date is written to PCONST for the specified measure for each base-level successor item and location processed.
Discontinuation Date Measure Code

The measure code to copy the changeover date of predecessor item / locations. The discontinuation date is updated to PCONST for the specified measure for each base-level predecessor item and location processed. This value must differ from the value specified for Introduction Date Measure code

From Measure Code The measure code to be copied from the predecessor items and locations.
To Measure Code

The measure code to be copied to the successor items and location. This can be identical to From Measure Code.

Item hierarchy node
The item selection for processing the supersession definitions. If specified, nodes within the selection (equal to or children of) in the supersession definition code list are processed.
Note: Both the predecessor and successor from the definition must exist in the selection. If no value is specified, all nodes accessible to the user in the supersession definition code list are processed.
Location hierarchy node
The location selection to process supersession definitions. If specified, nodes within the selection (equal to or children of) in the supersession definition code list are processed.
Note: If no value specified, all nodes accessible to the user in the supersession definition code list are processed
.
Valid ItemLocation Measure Code A measure defined for the current module, to indicate the valid item/location combinations of successors at the base level when applying supersession for aggregate locations.
Overwrite

Indicated the overwrite pattern of the source data. Possible values:

  • Not defined: the data from the source is added to the destination values.
  • Defined: the data at the destination is overwritten for the item, location, period selection
Successor Location Attribute
The attribute in the code list containing the Successor locations. The attribute values within the codelist must be set at base. This is validated against the module hierarchy at run-time.
Note:  If the attribute values are null for any definitions then the supersession is applied to the Predecessor location.
The value for the Command field must be specified in this format:SuperSession (Code List, Predecessor Item Attribute, Successor Item Attribute, Predecessor Location Attribute, Changeover Date Attribute, Transfer Factor Attribute, Introduction Date Measure Code, Discontinuation Date Measure Code, From Measure Code, To Measure Code, [Item Hierarchy Node], [Location Hierarchy Node],[Valid ItemLocation Measure Code],[Overwrite],[Successor Location Attribute])
Note: The optional Parameters are specified in [ ].