How to Schedule a Custom Report

Custom Reports can be scheduled to deliver via email, in the form of a PDF or CSV file.

Once you have created and saved a custom report, you can create a notification group and a schedule.

Notification Group

Notifications groups are a centralised way to manage who the report is delivered to. You can add new notification groups in the Administration section.

 

A list of the current notification groups will be shown. Click "View" to see what emails are added to that notification group.

To create a new notification group, click the "Add Notification Group" in the top right.

You can select existing users, and add emails of external users who you wish to deliver the report to.

Click "Create"  in the top right to save the notification group. "Cancel" will discard the changes made.

Report Scheduler

To configure a schedule for a custom report to be generated and emailed to a notification group, you can use the Report Scheduler.

On the Report Scheduler, you can see what schedules have already been created.

At the top right, there is a button to Create a new schedule.

A summary of each of the fields is below

  • Name: The display name of the report
  • Description: A description for internal use
  • Enabled: Allows you to turn on/off the schedule without needing to delete it.
  • File Type: Select whether you would like the report to be exported as a CSV or PDF
  • Notification Group: Select the group that you want notifications to be delivered to. Details of how to create a notification group are above.
  • Reports: Select which saved reports you would like to be delivered. You can select one or more.
  • Schedule: Choose a Daily, Weekly, or Monthly delivery. You can specify what time, and for Weekly/Monthly delivery, which day.

Click Save to save the schedule.

Note: Make sure to enable the schedule when you are creating or editing the schedule.