Form Integration Properties

Type	Description

Type

Description

form-integration-properties

Shows a generic form with fields defined by a step. All fields of the form are re-created as placeholders for usage in the Integration Template.

This step is the basis for configuring Accelerators (Solution Forms).

Attribute	Description	Example	Required?

Attribute

Description

Example

Required?

form

Specifies an array of supported fields. The supported fields are defined in Solution Form Attributes.

[
  {
    "name": "test",
    "label": "Test",
    "type": "string",
    "placeholder": "Input something",
    "required": true,
    "default": "cool",
    "mode": "default" | "multiple" | "tags"
  }
]

true

sharedStateConditions

Specifies conditions between fields in the form and data in the shared state (allowing removal of fields in the form based on results of previous steps). If there is a field in the shared state (created by a previous step), a field in the form is displayed. It contains these fields:

type – Type of the condition (currently supported are jsonPathEquals and jsonPathContains) (String).
fieldName – Name of the field in the form (String).
jsonPath – JSON path to the requested value in the shared state (String).
value – Value of the JSON path (String).

 "sharedStateConditions": [
    {
      "type": "jsonPathEquals",
      "fieldName": "test",
      "jsonPath": "$.existing",
      "value": "true"
    },
    {
      "type": "jsonPathEquals",
      "fieldName": "datamartName",
      "jsonPath": "$.nonExisting",
      "value": "true"
    }
  ]

false

validators

An array of complex cross field validators. Validators are validated on the form submit. Validators allow validating fields among each other and against database values. Each validator has these attributes:

type – Type of the validator (String).
parameters – List of the parameters the validator needs to use for a validation (Array).
parameters.type – Source of the parameter [“shared-state” or “form“].
parameters.value – A name of a field from the source that should be used (String).

  "validators":[
        {
          "type": "sftp-connection-used",
          "parameters": [
            {
              "type": "shared-state",
              "name": "connectionName"
            },
            {
              "type": "form",
              "name": "directory"
            }
          ]
        }
      ],

Validators:

sftp-connection-used

This validator validates if a connection with a directory is already used in a route in IntegrationManager. The order of parameters is mandatory. The first parameter describes a connection (can be resolved as the name of the connection or its ID). The second parameter describes a folder. The validator checks if the combination of the connection and folder has already been used in some route in IntegrationManager.

Example

Test2 field is displayed only if the value in the field Hello is 'Bye'.