Set up Simulation Step – setup-simulation

Type

Description

Type

Description

setup-simulation

Allows users to select proper field mapping in a predefined simulation created in the package.

Data Requirements

In the package directory in the data folder, this step requires:

  • SimulationPA folder (keeping the structure and naming conventions as provided by Packaging Tool). This folder contains the simulation definition. 

Specific Attributes

Attribute Name

Description

Example

Required

Attribute Name

Description

Example

Required

simulationName

Name of the simulation to be created in Pricefx.

CustomerInsight

true

simulationLabel

Label of the simulation to be created in Pricefx.

Simulation label

false

requiredTypes

Specifies required types for the defined field in the simulation definition.

The field  name should match the simulation definition:  query.projections."FieldKey".name

"requiredTypes" : [     {       "name": "PricingDate",      "type": "DATE"    } ]

false

apName

Name of  the Advanced Property (AP) which reads the field for remapping.

apName

false

ApReMapping

Remapping  configuration for AP config. 

  • key – Field to replace with a new value

  • value – Original value of the field in the AP config

"apReMapping": [ { "key": "QuantityFieldName", "value": "p3_Quantity" } ]

false

 

  • query.projections."FieldKey".name must match the value in the path simulations.[index]mappingParams.[index].value in the simulation definition. If users choose a different field in the UI, the step dynamically changes fields name(value) at both places so that it works in Pricefx.

  • Rollups are currently not supported.

  • The step supports remapping of AP (advanced properties) previously uploaded from other steps, e.g. general form. The step fetches the AP and then rewrites it on the partition by the "apReMapping" definition.

Examples

Field replacement example – before: 

{ "mappingParams": [ { "label": "CustomerId", "name": "CustomerId", "parameterConfig": {}, "type": "", "value": "customerName" } ], "query": { "projections": { "customerName": { "alias": "customerName", "expression": "customerName", "name": "customerName" } } } }

Field replacement example – after: 

 

Example:

 

Measures params with prefixes must honor the order by prefixes: p1 must be first, p2 second and so on.

Measures fields example:





PlatformManager version 1.75.0