Defining a History Replacement Engine

  1. Select Configuration > Cycle > Engines.
  2. Click New and select Engine of the type History Replacement.
  3. Specify this information:
    Name
    The name of the history replacement engine.
    Display Name
    The engine name as displayed in the application.
    Users
    The users authorized to access the history replacement engine.
    Roles
    The roles of the user(s) authorized to access the history replacement engine.
    Module
    The module for which the history replacement engine must be used.
    Tags
    The tag linked to the history replacement engine. You can link one or more tags to a history replacement engine.
  4. Click the Default Settings tab. This tab allows you to define general settings for the engine definition including the algorithm.
    Note: 
    • If the selected level in the engine is not the base level for storing scenario values, SCP must aggregate the values to pass to the history replacement engine and prorate the results (output measures) back to the base levels for storing scenario values.
    • It is possible to override the default levels using the CallForecastEngine macro parameters or the Generate Forecasts process with the options from a configured worksheet.
  5. Specify this information:
    Default Algorithm
    The default algorithm used by the forecast engine. Possible values:
    • Simple Mean
    • Simple Naive
    • Simple Past Year
    • Simple User-defined
    • BATS
    • Linear interpolation
    • Offset Forecasts
    Period Constant Spread Measure
    The measure to be used when spreading the forecast engine output to item, location and pconst.
    Note: This field is used when spreading all results to the item and location dimensions where Time-Phased Spread Measure is not defined.
    Time-Phased Spread Measure
    The measure to be used when spreading forecast engine results to item, location and period (full spread).
    Note: If this value is not specified:
    • Period values are prorated using the Cycle’s Period Spread Measure (using the values at iconst, Iconst, period).
    • Item and Location values are prorated using Period Constant Spread Measure (the values at item, location, pconst)
    Item Level
    The default item level for which the engine generates history replacement data. This value can be overridden at the point of execution at the point of execution using the macro parameters or Generate Forecast options.
    Note: If this value is not specified, the base level of the default item hierarchy for the cycle is used.
    Location Level
    The default location level for which the engine generates history replacement. This value can be overridden at the point of execution at the point of execution using the macro parameters or Generate Forecast options.
    Note: If this value is not specified, the base level of the default location hierarchy for the cycle is used.
    Period Level
    Indicates the calendar level for which the engine generates history replacement. This level is validated at run-time because the available options are based on the cycle’s calendar in which the history replacement engine is used.
  6. Click the Measure Mapping tab. This tab lists the required measures that are mapped to the history replacement engine as input or output values.
    Note: The mapped measures are derived from scenario values for the individual item/location combination. The measures are passed to the engine as input for history calculation or received from the engine as output which can be stored in the scenario.

    This table list the measure mappings for an engine:

    Name Scope Description Used by (Algorithm) Engine Input/Output
    History Cycle Period History horizon Indicates the measure that contains the history values to be replaced.
    Note: 
    • Leading zeros are removed, resulting in reduced number of history values being passed.
    • The stored values are normalized using the specified period weightings prior to passing to the engine.
    • If the defined measure contains a calculation rule, a business metric is required in the appropriate cycle, to fetch the calculated values that have to be passed to the engine.
    		 All Input
    Period Weighting Cycle Period History horizon Indicates the measure that contains period weighting values used to normalize the input history and output replacement history.
    Note: 
    • The engine expects the history data to be normalized prior to passing.
    • The history values are normalized using the period weighting measure. This must be done before the values are saved to database.
    • If the defined measure contains a calculation rule, a business metric is required in the appropriate cycle to fetch the calculated values that have to be passed to the engine.
    		All Input
    Replacement Start Date Static (PCONST) Indicates the measure that contains Replacement Start Date (the date from which the result of replacement history is applicable).
    Note: 
    • The start period from which the history data is replaced, is the period (at the Period level defined by the engine) in which the Replacement Start Date exists.
    • If this value is Null for an item at specified location, the replacement history is applicable from the beginning of the oldest history period at Period Level defined by the engine.
    • The measure must be of type Date.
    		All Input
    Replacement End Date Static (PCONST) Indicates the measure that contains Replacement End Date (the date up to which the result of replacement history is applicable).
    Note: 
    • The end period up to which the history data is replaced, is the period (at the Period level defined by the engine) in which the Replacement End Date exists.
    • If this value is Null for an item at specified location, the replacement history is applicable up to the latest history period at the Period Level defined by the engine.
    • The measure must be of type Date.
    		All Input
    Replacement History Cycle Period History horizon Indicates the measure that receive the resulting history values generated by the engine.

    This output value is denormalized using the specified period weighting before saving.

    		All Output
    Do Not Fit Static (PCONST) A measure which stores a flag (>0) indicating that the item at specified location must not be passed to the history replacement engine.
    Note: 
    • The measure is stored at pconst.
    • The output measure of these combinations is not approved by the engine calculation process.
    		 All Input
    Offset Forecast Inclusive History Periods between Replacement Start/End Date Indicates the measure that contain Offset Forecast. The Offset Forecast contains forecast values for historical periods and is used for the inclusive periods between Replacement Start Date and Replacement End Date at the Period Level defined by the engine.
    Note: 
    • This optional mapping is required when the Algorithm is set to Offset Forecasts.
    • If this value is Null for an item at specified location, the replacement history is 0.
    		Offset Forecasts Input
    User-defined Value Static (PCONST) Indicates the measure that contain User-defined Value (the value for each item and location combination) that is applicable for all replacement history periods, inclusive of the period between Replacement Start Date and Replacement End Date, at the Period Level defined by the engine.
    Note: 
    • This optional mapping is required when the algorithm is set to Simple User-defined.
    • If this value is Null for an item or location, the replacement history is 0.
    		 Simple User-defined Input
  7. Click + to map additional Measure Mapping.
  8. Specify this information:
    Parameter
    The parameter name to be mapped to the engine.
    Measure
    The measure in SCP that is mapped to the forecast engine parameter.
  9. Click the Parameters tab. This tab contains the parameters required by the History Engine to configure the engine behavior at the engine level.
    Note: You can specify the value for the required parameters.

    This table list the engine parameter for history replacement:

    Name
    Periodicity

    The periodicity of the history data. This defines the history periods in each year for algorithm calculations. For example, Simple Past Year.

    		 All 12, 13 (monthly data), 52 (weekly data) 0
  10. Click Save. The history replacement engine is defined after successful validation.