Versions Compared

Old Version 1

changes.mady.by.user Nadja Pollard

Saved on

compared with

New Version Current

changes.mady.by.user Morgan Mackeson-Ellis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

OptionsApplicable ConfigsDescription
descriptionALL

Add a description for the field which will be displayed on mouse-hover and in the bottom description pane of the connection.

displayNameALLAdd the name that is displayed in the configuration field.
documentationALLIf the connection is part of documentation and the value is set to "true", therefore it adds this attribute to the generated documentation.
encryptionCONNECTIONS

Optional encryption settings Encryption setting when persisting the field value to the database: (add bullet points for these)  

  • 'none' : the value will not be encrypted. 
  • 'wherescape' : the value will be encrypted by RED and decrypted as required.
  • 'external' : equivalent to 'none' but allows you to flag that values have been encrypted externally.

This option is required, if you do not add a value in this field, you get an error messageNote: changing this value on an in-use UI Config requires reentering this field in the screen where it appears for the change to take effect.

groupALLAdd a group name for the configuration attributes.
maskedCONNECTIONS, COLUMNS Set the value to "true" to mask the value.
orderALLSet the order value for the created groups.
pageALLThe UI configuration is being applied under the Properties page.
requiredALLIf this value is set to "true", the field must be filled in; otherwise, a message stops you to close the dialog, after clicking OK.
setEnvVarForScriptsCONNECTIONSIf the value is set to "true", it allows you to access your environment variable with the token name, which is found under the description field. For example:
textBoxSettingsALL

"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. This field is applicable for future use.

listViewSettingsALL

"defaultListItem": When the value is '0' the field is blank.

"editable": Set to "true" when the field will be editable.

"list": Enter the list of items you want to display in the configuration field.

"listMessage": This message displays when you hover the mouse on the field.

numericSettingsALL"default": The default value field.
typeALLDescribes the type of the configuration field. The type goes along with the textBoxSettings, listViewSettings, and numericSettings with the specifics described above.

...