Field Configuration JSON

The UI Configurations allow you to add user-defined UI components including List boxes, Text boxes, and Numeric fields to certain properties pages in the UI. The tables below lists the required common and specific attributes of each UI component. Example configurations follow the tables:

TextBox

Options	Description
name	The name of the configured field; used for token replacement in scripts, model conversion rules and Pebble templates.
displayName	The display name of the configured field that will be shown on the column properties tab.
description	Add a description for the configured field.
type	The type of configured field, for text boxes use "textBox".
textBoxSettings	"default": Any created field can have a default. When you save a value as the default, that value is saved to the metadata for that particular connection. "length": Number of characters that you can type in the field. "multiLineEdit": The "False" value is set by default.
required	Set the value to "true" to force users to specify a value for the field.
masked	Set the value to "true" to mask the value in the UI.
encryption	Optional encryption settings that can be used in combination with connection properties when persisting the field value to the database: 'none' : the value will not be encrypted. 'wherescape' : the value will be encrypted by 3D and decrypted as required. 'external' : equivalent to 'none' but allows you to flag that values have been encrypted externally.

List View

Options	Description
name	The name of the configured field; used for token replacement in scripts, model conversion rules and Pebble templates.
displayName	The display name of the configured field that will be shown on the column properties tab.
description	Add a description for the configured field.
type	The type of configured field, for text boxes use "listView".
listViewSettings	"defaultListItem": a 1-based index used to specify the default list item. "editable": Set to "true" to create an editable list view. "list": Enter the list of items you want to display in the configuration field.
required	Set the value to "true" to force users to specify a value for the field.

Numeric Field

Options	Description
name	The name of the configured field; used for token replacement in scripts, model conversion rules and Pebble templates.
displayName	The display name of the configured field that will be shown on the column properties tab.
description	Add a description for the configured field.
type	The type of configured field, for text boxes use "numeric".
numericSettings	"default": The default value field.
required	Set the value to "true" to force users to specify a value for the field.
masked	Set the value to "true" to mask the value in the UI.
encryption	Optional encryption settings that can be used in combination with connection properties when persisting the field value to the database: 'none' : the value will not be encrypted. 'wherescape' : the value will be encrypted by 3D and decrypted as required. 'external' : equivalent to 'none' but allows you to flag that values have been encrypted externally.

Example

{
  "uiConfigFields": [{
      "name": "simpleTextBox",
      "displayName": "Simple text box",
      "description": "For token replacement in scripts use:\r\n $WSL_SRCCFG_simpleTextBox$",
      "type": "textBox",
      "textBoxSettings": {
        "default": "This is my default value",
        "length": 256,
        "multiLineEdit": false
      },
      "required": false,
      "masked": false,
      "encryption": "none"
    },
    {
      "name": "encryptedTextBox",
      "displayName": "Encrypted and masked text box",
      "description": "For access at runtime use environment variable: WSL_SRCCFG_encryptedTextBox",
      "type": "textBox",
      "textBoxSettings": {
        "default": "This is my default",
        "length": 256,
        "multiLineEdit": false
      },
      "required": true,
      "masked": true,
      "encryption": "wherescape"
    },
    {
      "name": "simpleListView",
      "displayName": "Simple list view",
      "description": "For token replacement in scripts use: $WSL_SRCCFG_simpleListView$",
      "type": "listView",
      "listViewSettings": {
        "defaultListItem": 3,
        "editable": false,
        "list": [
          "My list item one",
          "My list item two",
          "My list item three",
          "My list item four",
          "My list item five"
        ]
      },
      "required": false
    },
    {
      "name": "editableListView",
      "displayName": "Editable list view",
      "description": "For token replacement in scripts use: $WSL_SRCCFG_editableListView$",
      "type": "listView",
      "listViewSettings": {
        "defaultListItem": 0,
        "editable": true,
        "list": [
          "My list item one",
          "My list item two",
          "My list item three",
          "My list item four",
          "My list item five"
        ]
      },
      "required": true
    },
    {
      "name": "booleanListView",
      "displayName": "Boolean list view",
      "description": "For token replacement in scripts use: $WSL_SRCCFG_booleanListView$",
      "type": "listView",
      "listViewSettings": {
        "defaultListItem": 1,
        "editable": false,
        "list": [
          "TRUE",
          "FALSE"
        ]
      },
      "required": false
    },
    {
      "name": "numeric",
      "displayName": "Simple numeric field",
      "description": "For token replacement in scripts use: $WSL_SRCCFG_numeric$",
      "type": "numeric",
      "numericSettings": {
        "defaultValue": 999
      },
      "required": false,
      "masked": false,
      "encryption": "none"
    }
  ],
  "uiConfigName": "Example configuration",
  "uiConfigType": "ConnectionProperties",
  "uiConfigDescription": "A description for the configuration"
}

Content

Space Tools

TextBox

List View

Numeric Field

Example