Skip to content

Form

A form is an outer level JSON object that contains a list of parameters.

Specification

  • title (optional) Specifies the title of the dialog displaying the parameters. If not specified, the title will be determined by workbench. For example, transformers will have the title ' Parameters'
  • parameters a listing of parameters. See Parameters

Example

 "form": {
   "title" : "My Dialog",
   "parameters": [
       {
           "editor": "url",
           "expressionSettings": {
               "supportsConditionals": false
           },
           "name": "URL",
           "prompt": "URL:",
           "required": true,
           "showPrompt": true,
           "showEditButton": false,
           "supportedValueTypes": [
               "expression",
               "globalParameter"
           ],
           "trimWhitespace": true,
           "type": "text",
           "urlSettings": {
               "validSchemes": [
                   "ftp",
                   "ftps"
               ]
           },
           "valueType": "stringEncoded"
       },
       {
           "addAsAttribute": "varchar(200)",
           "editor": "plaintext",
           "name": "TARGET_ATTRIBUTE",
           "prompt": "Target Attribute:",
           "required": true,
           "showEditButton": false,
           "trimWhitespace": true,
           "type": "text",
           "valueType": "string"
       }
  ]
}