Property description

The steps property is an array defining the sequence of steps involved in setting up a data source.

Minimal JSON

{}
{
  "steps": [
    {
      "centerArea": {
        "data": [
          {
            "type": "section",
            "data": [
              {
                "type": "input",
                "variant": "text",
                "labelKey": "di.provider.template.data_source.name.label",
                "key": "name",
                "tooltipKey": "di.provider.template.data_source.name.tooltip",
                "placeholderKey": "",
                "required": true
              }
            ]
          }
        ]
      }
    }
  ]
}

Example taken from the core_sql_server package.

Nested properties

PropertyDescriptionValuesMandatory
centerAreaDefines the central part of the form.jsonNo
dataArray which specifies the components used in the step. Nested in centerArea. See supported data components.arrayNo

Data components

Visual components:

  • text: Displays static text on the page, such as subtitles or descriptions.
  • title: Displays the page title, usually used at the top of the page.
  • section: Creates a container for grouping multiple components.

Data input components:

  • checkbox: Allows users to toggle an option on or off.
  • input: Provides a text box for user input (e.g., data source name).
  • json_input: Accepts custom JSON configurations, such as filters or advanced settings.
  • schedule: Expands additional scheduling options when selected.
  • space_select: Enables users to select a space from available options.
  • workflow_select: Provides a dropdown to assign a workflow state to an object.