type

Defines what the step does. Available step types are listed here.

create-px-ui

false

name

Provides unique identification of the step.

product-master

true

mandatory

Defines if a step can be skipped or not. If set to true, the step cannot be skipped. This applies only to UI steps (steps which interact with user).

"mandatory": false

true

dependentSteps

Contains a list of step names which must be all executed in order for the given step to be executed.

"dependentSteps": [ "customer-master" ]

[]

onSkipFilter

Object containing information about what should not be deployed in Pricefx when this step is skipped. All filters are used by the deploy-logic step.

Structure:

• key – Type descriptor on an entity type (case insensitive name of the folder created by Packaging Tool – DataSource, ProductExtension, etc.). Contains an array of filters which will be applied on the folder.

  • fieldName – Name of a field in an object.

  • notEquals – Value which will be used for comparison. 

{}

stepLabel

Defines text in a package stepper.

"stepLabel": "Product table setup"

attribute name

allowSkipWhenDeployed

Defines if a step can be skipped or not based on conditions.

• If set to true, a step can be skipped once the following conditions met:

  • For setup-customer-master, setup-product-master, setup-seller-master steps – If there are data and the Customer/Product/Seller master table contains all mandatory fields, the step can be skipped.

  • For other step types – Depending on their nature. The application checks whether the step’s goal is already fulfilled at the partition, and if so, the step can be skipped.

• If set to false, a step cannot be skipped.

"allowSkipWhenDeployed": false

true

ui

Object containing UI specific fields. Contains:

• title – Page title

• description – Page description

{"title": "Title", "description": "desc"}

false

processDescription

Description shown in the progress bar of the step.

"processDescription" : "preparing step data"

false

dependentProperties

Conditional properties to meet to be able to execute a step. For details see Conditional Step.

false

exportIntoSharedState

List of fields that should be exported into a shared state for future usage (in another step). One item must contain these fields:

• sourceJsonPath – String in the format of a JSON path specifying data from the step result.

• destinationFieldName – Field name in the shared state where the data will be stored.

false