Set up Product Master Step – setup-product-master

Type

Description

Type

Description

setup-product-master

This step creates a Product Master table structure and populates it with provided data. 

The user uploads a file containing products, links mandatory fields and selects fields which should be created in the Product Master table. The step sets up the Product Master table according to the user's preferences and fills it with the provided data.

For cloning the Product table to a Product Data Source use the Restore Product Metadata Step – restore-product-datasource step. 

Data Requirements

Only if the demoData or exampleFilePath options are used (which save the user from having to provide data), this step requires a CSV file with data in the data folder. 

Specific Attributes

Attribute Name

Description

Example

Required

Attribute Name

Description

Example

Required

mandatoryFields

List of fields that must be linked with users's data. Information about fields has to be stored in the data folder in a format defined by Packaging Tool. Each field must contain:

  • name –  Unique name of the field in PFX.

  • label – Label which will be displayed in PlatformManager.

  • description – Description of the field which will be displayed in PlatformManager.

  • mappingAliases – An array of possible mapping aliases ("Product Id" and "Unique Identification" for SKU).

Field definitions stored in the data folder are used to decide if this step has already been deployed. To consider this step already deployed, the fields in the table must match exactly (all fields attributes must match).

"mandatoryFields": [ { "name": "sku", "label": "Product Id", "description": "Identification of the product" }, { "name": "label", "label": "Product Name", "description": "Name of the product" } ]

true

demoData

Definition of demo data:

  • filePath – Path to a CSV file in the data folder.

"demoData": {"filePath": "Products.csv"}

false

exampleFilePath

Path to a CSV file in the data folder.

"exampleFilePath": "ExampleFiles/Product.csv"

false

showMappingOptions

If set to true, a modal dialog with mapping options appears after the mapping step, with these options:

  • Continue 

  • Create data upload for just created/filled table – Users are redirected to a new step where they are forced to fill in data upload name.

  • Run IM SFTP Template

"showMappingOptions": true

false

significantFields

Similar to optional fields. The only difference is that the user is advised to fill this fields for better accelerator result and definition of the fields must be provided in the Accelerator (in the data folder). Each field must contain:

  • name – Unique name of the field in Pricefx.

  • label – Label which will be displayed in PlatformManager.

  • description – Description of the field which will be displayed in PlatformManager.

  • mappingAliases - An array of possible mapping aliases ("Product Id" and "Unique Identification" for sku)

"significantFields": [ { "name": "Currency", "label": "Currency", "description": "" } ]

false

Example

{ "name": "product-master", "type": "setup-product-master", "exampleFilePath": "ExampleFiles/Product.csv", "mandatoryFields": [ { "name": "sku", "label": "Product Id", "description": "Identification of the product" }, { "name": "label", "label": "Product Name", "description": "Name of the product" } ] }



PlatformManager version 1.75.0