Monitors are scheduled within the "Scheduling and Notifications" panel of the editor and are described in the following document.



The following configuration options are available within the "Scheduling and Notifications" panel:




General Settings



  • Is Enabled
    • Unless this is enabled the scheduler will not execute
  • Time Of Day
    • Specifying the time of day will cause the scheduler to execute at that time and deliver the report.  Leave blank for interval scheduling (or can be used in conjunction with interval scheduling)
  • Interval
    • Will execute every N minutes as specified by the interval
  • Send Notifications on Weekdays Only
    • Enabling this option will restrict notifications to only be sent during weekdays



Email Settings



  • Pass
    • Enable Email Success
      • Enable notifications if a monitor "passes"
    • To Email Address
      • Comma-delimited email addresses of report recipients
    • On Success GroupBy Column Name (pass)
      • Allows monitor results to be grouped by an email address column in the SQL execution result.  Each group of rows within the result will be sent to that email address.  This allows a single monitor execution to be grouped and dynamically sent to multiple people.  For more granular control see "Scheduler Custom Actions" specified further below.
      • When a value is specified the aggregate set of all rows will still be sent to the address specified in the "To Email Address" and the email groups will also be sent
  • Triggered / Error
    • Enable Email On Failure
      • Enable notifications if a monitor is "triggered" or has an execution failure/error
    • To Email Address
      • Comma-delimited email addresses of report recipients to receive notification of report failure
    • On Failure GroupBy Column Name
      • Allows monitor results to be grouped by an email address column in the SQL execution result.  Each group of rows within the result will be sent to that email address.  This allows a single monitor execution to be grouped and dynamically sent to multiple people.  For more granular control see "Scheduler Custom Actions" specified further below.
      • When a value is specified the aggregate set of all rows will still be sent to the address specified in the "To Email Address" and the email groups will also be sent



Scheduler Custom Actions


Target notifications can be defined to send grouped/filtered result sets based on row/column values allowing for a single report execution to target multiple users.  In the example below a scheduler action has been created to send all rows with the column name "Region" and row value of "Northwest"  to the the "team1@mycompany.com" email address.  An infinite number of actions can be defined within the scheduler.  Scheduler options as specified previously in this document and can be used in conjunction with Scheduler Custom Actions or independently, they are not mutually exclusive.



To create a custom scheduler action choose the "email" action type and click the "Add" button:



The following options can be configured for a custom scheduler action:

  • Target Email Address
    • Email address in which this notification will be sent
  • Match Column Name
    • Column name to use for matches
  • Match Method
    • Type of match method to use for column (currently only Equals is supported, in future versions this will be expanded)
  • Match Value
    • Value of row used for match
  • NotifyOnSuccess
    • Send notification on success
  • NotifyOnFailure
    • Send notification on failure
  • Notify on Weekdays Only
    • Enabling this option will restrict notifications to only be sent during weekdays