9.4.3. Plugin properties

Below the header fields, all configurable properties of the selected plugin are listed and can be configured. According to their type, they are presented in simple text fields, lists, or drop down fields.

The following example screen shows five properties with their values. Properties are organized in groups (e.g. "Basic Settings" and "Advanced Settings" in the screen below).

The groups can be opened and closed:

128650240.png

Property Icons

On the right of each property, one more icons may be displayed.

The following table explains all possible the icons:

Icon
Description
Information48np.png
Shows the documentation of the property.
Hint: Click on an info icon, to see the documentation in the "Docs" docking panel at the bottom. 
ButtonRightBlue48np.png
In case of plugin properties, a click on this icon navigates to the sub plugin. This is the same as clicking on the corresponding plugin in the plugin tree on the left.
DatabaseRecordAddBlue48np.png
Adds a new row to a list (only visible for list properties).
DatabaseRecordDelete48np.png
Removes a row from a list (only visible for list properties).
AddDocumentBlue48np.png
Creates a new sub-plugin configuration (only visible for plugin properties).
128650285.png
This icon indicates a validation error for a property value and is displayed on the left side of the field, between the label and the property field. The validation message is displayed when the mouse is placed on the icon.
PlusGrey48np.png
This icon is only informative and has no corresponding action. You find it next to drop down selection fields that allow new values to be added. That is, if none of the suggested values suits you needs, you can simply enter a new value in the field and press enter to select it.
Selection fields without the "plus" icon only allow selection of the pre-configured values.
SpellCheck48np.png
Opens a regular expression tester. Properties which allow the use of regular expressions have this icon.
LoginKey48np.png
Opens a dialog to set/change a secret value, e.g. a password.
ZoomIn48np.png
Shows the property value in a separate window. This can be useful if the value is a large text.
Lightning48np.png
Executes a small test for a part of the current configuration. Such a testlet may either use only the property of its field or require a set of properties of the plugin. This allows the user to validate the configured properties directly in the configuration editor without the need to apply the configuration first. An example is to test the HTTP connectivity of a configured URL.
defaultValue48np.png
Indicates that this property is not locally defined and uses its default value. If a property has a default value and the user tries to enter an empty value, the default is automatically inserted into the field and marked with this icon.
PencilBlue48np.png
This icon is displayed only if the plugin has a hierarchical parent configuration, i.e. it may inherit configuration properties from another plugin configuration.
Click this icon to override a value locally, i.e. use the defined value and not the value inherited from the parent.
Strikeout48np.png
This icon is displayed only if the plugin has a hierarchical parent configuration and this property is overwriting the configuration value defined in the parent configuration.
Click this icon to inherit a value, i.e. discard the "locally" defined value and use the value defined by the hierarchical parent configuration.
DeleteRed48np.png
Undefines a property by removing its value from the configuration. If the property has a default, it is automatically applied to the field. This icon is only visible on specific types of fields, i.e. checkboxes, maps and lists. For textfields and drop-downs, a property can be undefined by entering an empty value in the field. The icon is only visible if the property is optional, has a value and there is no hierarchical parent configured for the plugin. The reason is that mandatory properties always require a value and have no use to remove it. If a hierarchical parent is present, the same behavior is achieved by using the Strikeout48np.png icon.

Property values

  • There are two states a property can have when configuring it:
  • 1.
    Undefined: The property has no value and does not appear in the configuration file.
  • 2.
    Defined with specific value:  The property is in the configuration file with a specific value.

The states can be achieved in different ways depending on the type of field the property uses.

Textfields & drop-downs

Status
Description
Undefined
Enter/select an empty value. If a default is available, it will be loaded.
Defined with specific value
Enter/select a specific value.

Lists, maps and checkboxes

Status
Description
Undefined
Click the DeleteRed48np.png icon by the property. If a default is available, it will be loaded.
Defined with specific value
Enter/select a specific value.

Note that empty lists and maps are also considered as defined with a specific value.

Password fields

Status
Description
Undefined
Click the DeleteRed48np.png icon by the property.
Defined with specific value
Click the LoginKey48np.png icon to set a new value.