Create Customer Extension Table Step – create-cx-ui

Type

Description

Type

Description

create-cx-ui

Creates a customer extension table based data provided by the user.

Specific Attributes

Attribute Name

Description

Example

Required

Attribute Name

Description

Example

Required

uniqueName

Specifies the table's unique name. If not specified in the step, the user will be allowed to provide it.

"uniqueName": "coolTable"

false

mandatoryFields

Specifies a 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).

"mandatoryFields": [ { "name": "attribute1", "label": "Product Id", "description": "Identification of the product" }, { "name": "attribute2", "label": "Customer Id", "description": "Identification of the customer" } ]

true

skipOptionalFields

 If set to true, skips the optional field UI in the step.

"skipOptionalFields": true

false

businessKey

An array of names of fields which should be included in a business key.

"businessKey": [ "sku" ]

false

allowChangeBusinessKey

Specifies if users are allowed to change a business key definition. The default value is TRUE.

"allowChangeBusinessKey": false

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 the data upload name. 

  • Run IM SFTP Template

"showMappingOptions": true

false

Example

{ "type": "create-cx-ui", "name": "create-cx-name", "skipOptionalFields": true, "mandatoryFields": [ { "name": "customerId", "label": "Customer Id", "description": "Identification of the customer" } ], "businessKey": [ "customerId" ], "allowChangeBusinessKey": false }



PlatformManager version 1.75.0