Scheduled notifications

Introduction to scheduled notifications

Administrators can create email notifications to announce events and send status reports automatically. While some of these notifications may be triggered by events like the discovery of a critical vulnerability, some types of notifications may need to be generated at regular intervals, like a weekly status report on the health of business critical hosts.

Schedules can be created to automate notifications like this. Schedules are flexible and allow you to specify not just how frequently notifications are generated, but the exact days and hours they should be generated.

Administration > Notifications > Schedules will take you to the Manage Scheduled Notifications page, which displays a list view of all scheduled notifications.

Table 1: List view contents

Columns Description
Title Title of scheduled notification.
Run Schedule the notification is run on. E.g. weekly.
Notification Title of notification that runs on this schedule.
Last Run Date this scheduled notification was last run.
Next Run Date this this scheduled notification will next be run.
Active Whether this notification schedule is active.
Last Updated Date the scheduled notification was last updated.

Create a new scheduled notification

  1. Navigate to Administration > Notifications > Schedules
  2. Click Create Scheduled Notifications
  3. Fill in the following and click Create:

Table 2: New scheduled notification properties

Field Description
Title Title of the scheduled notification. The title will be displayed wherever the scheduled notification appears in the UI.
Name Reference name for queries and scripts. The name can contain only letters, numbers, and underscores.
Notification Notification the schedule sends. Notifications can be created in the Notifications section of the administrative back end.
Run As Allows you to select who the notification is run as.
Active Whether the scheduled notification is active. Inactive schedules are effectively archived and will not run.
Conditional Allows you to enter a Groovy script that specifies additional conditions for running the schedule.
Execute pre-sync script Allows you to enter a Groovy script to be run before the scheduled notification is sent.
Execute post-sync script Allows you to enter a Groovy script to be run after the scheduled notification is sent.
Run Sets how often the scheduled notification will be sent (e.g. hourly, daily, weekly). The options below will change depending on what frequency is set, allowing you to specify exact times.
Accessible from Specifies whether this schedule will be available to all Brinqa applications or only the application you are currently administrating.

Edit or delete a scheduled notification

Existing scheduled notifications can be edited or deleted by clicking the Actions button that appears to the right on mouseover of the entry on the list view.

TUTORIAL: Weekly notification schedule

  1. Navigate to Administration > Notifications > Schedules
  2. Click Create Scheduled Notification
  3. Enter a Title. The title is a good place to call out the notification being scheduled and when it will run.
  4. Select the Notification this schedule should affect
  5. Select "Weekly" for the Run field
  6. Select a Day when the notification should be sent
  7. Enter a Time when the notification should be sent
  8. Click Create