Custom documentation fields

By default, AFA adds a field called Documentation to each device policy, which you can use to add comments and other information to a rule. See Adding/Removing AFA Rule Comments.

If desired, you can disable or enable the Documentation field or add more such fields.

Add documentation fields

Each documentation field appears as a column at the far-right side of the device policy.

Note: Documentation fields cannot be deleted, only disabled. For details, see Enable/Disable documentation fields.

To add a documentation field:

  1. Open a terminal and log in using the username "afa" and the related password.

  2. Enter the following command:

    update_document_fields ADD "field_name" "field_type" "field_default_value"

    Where:

    • field_name is the name of the field, for example "My Doc".

    • field_type is the field's type. This can have the following values: Text, Number, Bool, or List.

    • field_default_value is the field's default value, for example "Good rule!".

      Note: If you enable the parameter CONVERT_ANCHOR_TO_LINK_CUSTOM_FIELD, you can include clickable URLs as the field_default_value. A link must be a proper html tag. For example "<a target='_blank' href='/FireFlow/Ticket/Display.html?id=6'>Click here to go to the page.</a>". See CONVERT_ANCHOR_TO_LINK_CUSTOM_FIELD.

The field is added to all device polices in AFA.

Enable/Disable documentation fields

To enable a documentation field:

  1. Open a terminal and log in using the username "afa" and the related password.

  2. Enter the following command:

    update_document_fields ENABLE "field_name"

    Where field_name is the name of the field.

    The field is enabled for all device polices in AFA.

Note: When re-enabling a documentation field, all data that was entered in this field before it was disabled, will appear once again in the device policies.

To disable a documentation field:

  1. Open a terminal and log in using the username "afa" and the related password.

  2. Enter the following command:

    update_document_fields DISABLE "field_name"

    Where field_name is the name of the field.

The field is disabled for all device polices in AFA.