Create Rule Documentation

To create a rule documentation field, complete the following steps.

  1. On the toolbar, click System > Documentation.
  2. Click Create.
  3. Enter a unique Name for the field.
  4. Enable is selected by default. If you chose to disable, the field will not be shown in any applications.
  5. Enter a Description of the field.
  6. Select a Display Input Type. This field cannot be changed after saving.
    • String (text)
    • String Array (list)
    • Boolean
    • Integer
    • Username
    • Date

    The Display Input Type field cannot be changed after saving.

  7. Enter a Match Pattern. A regex expression that will populate the documentation field with values automatically.
  8. By default, Status is enabled.
  9. By default, Include in Filters is enabled. This means that the field name will be included in the available filters list.
  10. Click Save.