Configuring scripts

The CAS is able to run command line scripts (for example, batch files) with a set of parameters defined by a user. The parameter values are calculated based on the same macros as it is done for message notifications.

Before you begin

Before configuring scripts, ensure that:

  • You know the location of the executable (a script file or a script interpreter).
  • You are familiar with special fields and macros that are mapped to real traffic data and can be used as parameters. For more information, see Alert notifications.
  • The user that runs the Central Analysis Server service has permissions for running the script.

Configuring script recipients

  1. Open the Alert management screen.
  2. Switch to the Recipients tab and choose Script.
    The screen lists all script recipients and available alert definitions.
  3. Click Recipient Configuration.
    The Recipient Configuration window opens.
  4. On the Scripts tab, click Add.
    The Add Script Recipient window opens.
  5. Specify the script parameters.
    • Description
      Provide a short description of what the script does.

    • Alert type
      Select the alert type for which the script will be executed.

    • Executable
      Point a file containing a program that is executed when an alert occurs. This can be, for example, a batch file (.bat), an executable file (.exe), or an interpreter that executes a script. For more information, see Alert scripting.
      The file must be located on the same server as CAS.

    • Parameters
      Type script parameters. You can use the available macros as parameter values.

      Note

      Parameters are configured per script, not per alert. The same script can be a recipient of more than one alert type.
      To send script notifications for two different types of alerts (requiring two different parameter configurations), you have to add such script recipient twice on the recipient configuration screen.

  6. Click Save to save the configuration and close the Add Script Recipient window.
    The new script recipient appears in the recipient table.
  7. Click Close to leave the Recipient Configuration screen.

Next

  • To edit a script recipient, use the links in the Actions table column, on the Recipient Configuration screen.
  • To delete a script recipient from the list, select the check box beside the recipient name and click Delete.