Set up Customer Master Step – setup-customer-master

Owned by Ondřej Tesař
Sept 19, 2024
3 min read

This step creates C (Customers) table structure and populates it with data. For cloning the C table to Customer Data Source use Restore Customer Metadata Step – restore-customer-datasource.

Type

Description

Type

Description

setup-customer-master

This step creates the Customers Master table structure and populates it with provided data.

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

For cloning the Customers table to the Customer Data Source use the Restore Customer Metadata Step – restore-customer-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 which 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 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).

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": "customerId", "label": "Customer Id", "description": "Id of the customer" }, { "name": "name", "label": "Customer Name", "description": "Name of the customer" } ]

true

demoData

Definition of demo data:

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

  • mandatoryFieldMapping – Map of mandatory attribute with mapping to a field from the CSV file.

"demoData": { "filePath": "Products.csv", "mandatoryFieldMapping": { "sku": "Product Id", "label": "Product Name" } }

false

exampleFilePath

Path to a CSV file in the data folder.

"exampleFilePath": ExampleFiles/Customer.csv"

false

showMappingOptions

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

  • Continue 

  • Create data upload for just created/filled table – Users are redirected to a new step where they are forced to fill in the 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 results 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



PlatformManager version 1.75.0