Create or edit an Inform

Informs are applied to content rules using the Generate an Inform action in the What To Do? section of the rule. You must create an Inform before you can apply it to a content rule.

To create or modify an Inform:

  1. Click Policy > Policy References > Informs. The Manage Informs page is displayed.
  2. Click New to create an Inform. To edit an existing Inform, select an entry from the list and click Edit.

  3. Edit the Overview section and provide the Inform with a Name or any Notes you want to include to describe it. For example, you might include a note describing how the Inform or its configuration form part of a policy. Click Save.

  4. In the Inform Content section, configure details about the content of the Inform message the Gateway sends:

    1. Set the From address. This is the email address which is displayed as the "From:" address in the Inform. When setting the From address, select from the following options:

      • Administrator: Sends an Inform from the Gateway Administrator email address.
      • Server: Sends an Inform from the Gateway email address. This is the default email account.
      • This email address: Sends an Inform from an email address that you specify.

    2. Enter an appropriate Subject. This text appears in the subject line of the Inform.

    3. Enter your Inform text. This text appears in the body of the Inform. You can use Plain Format or HTML Format.

      Token Description
      %ADMIN%

      The administrator account email address used by the Policy Engine.
      %DETECTED%

      Items detected by the What To Look For? clauses in invoked content rules.
      %DIAGNOSTICS%

      A complete report of the data analysis.
      %FORMATSUBTYPE%

      The low level type of data recognized.
      %FORMATTYPE%

      The type of data recognized.
      %POLICY%

      A list of the content rules invoked on the message.
      %ROUTE%

      The name of the route that determined the policy.
      %RULES%

      A comma separated list of matched rules.
      %SERVERADDRESS%

      The hostname of the Clearswift Gateway .
      %URL%

      The full URL of the request.
      %URL_CATEGORY%

      The  URL category name for the current request.
      %USER%

      The user name, or, if no user name is available, the IP address of the client machine.
      %USERADDRESS%

      The IP address of the client machine.

    4. Select from the following Web Policy Options:

      • Do not include either the HTTP/HTTPS headers or data: Sends an Inform only. The recipient does not receive the data that triggered the content rule.
      • Include HTTP/HTTPS data only: Sends an Inform, along with the Web page content that triggered the rule as an attachment.
      • Include HTTP/HTTPS headers and data: Sends an Inform, along with along with the HTTP header information and the web page content that triggered the rule, as attachments.
      • Include diagnostic information: The Inform includes an attachment of diagnostic information from the Gateway policy engine. The Clearswift support staff can use this diagnostics information to assist you with resolving issues.
       

      • To include HTTPS data when selecting Include HTTP/HTTPS data only, Include HTTP/HTTPS headers and data, or Include diagnostic information, you will first need to run the following script:

        /opt/cs-gateway/scripts/support/include_https_in_informs true

        Information will only be included for HTTPS traffic in the inform once the above script is run as root and then configuration is applied in the UI.

      • The %URL% and %DIAGNOSTICS% tokens will only be replaced in the inform for HTTPS traffic if the script above has been run.
  5. Click Save.
  6. Apply the configuration. Any group changes should be applied to each Gateway in a peer group.

See also...