Integration Properties Step

Type	Description

Type	Description
`integration-properties`	Allows you to define a form with required parameters.

Specific Attributes

Attribute Name	Description	Example	Required

Attribute Name

Description

Example

Required

mandatoryFields

List of fields which must be linked with users's data. Each field must contain:

name – Unique name.
label – Label which will be displayed in PlatformManager.
integrationName
type – Determines what the UI will provide for the end users. The options are:
- text – Provides a field for entering text.
- textarea – Provides an area for entering large amount of text.
- filter – Provides a filter.
- password – Provides a field for entering a password.
- select – Provides a list of options to select from.
- select_ext – Provides a list of options acquired from an external system (e.g. Salesfx, REST endpoint etc.). Before displaying the form, data is fetched from IM directly if the connection parameters are specified. Otherwise the user is prompted to select a connection, configuration and any parameters from which the data will be obtained.
- int – Provides a field for entering a number.
required flag

See below.

true

Example:

{
      "type": "integration-properties",
      "name": "integration-properties",
      "mandatoryFields": [
        {
          "name": "integration.sap.s4.rebates.period",
          "label": "Poll period (in seconds)",
          "type": "text",
          "required": true
        }
      ]
}

Example of a step definition with the select_ext property. In this case, the configuration is filled in and properties are also in the template. Data for the drop-down are received via a call to IM directly.

{
      "type": "integration-properties",
      "name": "integration-properties",
      "mandatoryFields": [
          {
          "name":"select_opportunity",
          "type":"select_ext",
          "label": "Sample external value"
          "configurationName":"sfdc-id-list",
          "properties": [
            {
               "name": "sf.api.version",
               "required": true
           },
            {
               "name": "sfdc.pricebook.id",
               "required": true
            }
          ]
        }
     ]
}

Example of a step with the select_ext property with no configuration prefilled. The user is prompted to select a connection, configuration and any parameters.

code

{
      "type": "integration-properties",
      "name": "integration-properties",
      "mandatoryFields": [
        {
          "name":"select_opportunity",
          "type":"select_ext",
          "label": "Sample external value"
        }
      ]
},