Scheduled reports
Overview
A scheduled report runs a report/reports regularly on a nominated day and time and send them to a pre-defined list of users and groups.
Creating a scheduled report
To create a scheduled report, navigate to Reporting > Reports > New scheduled report navigation menu.
It is important to understand how the fields are used and can be used. Scheduled reports have the following fields:
Field name | Description | Example |
|---|---|---|
Name | Name of the scheduled report | Incident management snapshot |
Description | Description of the scheduled report | Last week’s snapshot for incident management |
Reports | List of report(s) that you want run and sent |
|
Schedule | When the scheduled report is supposed to run | Every Monday at 6AM |
Template reports | List of template report(s) that you want run and sent |
|
Active | If the scheduled report is active | Yes |
Run as | The nominated reports and template reports will be run using this user and its permissions | Someone |
Users | List of Servicely user accounts to receive the reports/template reports when the scheduled report runs |
|
Groups | List of Servicely Groups to receive the reports/template reports when the scheduled report runs |
|
Subject | Subject of the email that will be sent out when the scheduled report runs and sends the nominated reports/template reports out. Note that you can also access the user object such as ${user.Name()} | Last week’s incident management |
Body | Body of the email that will be sent out when the scheduled report runs and sends the nominated reports/template reports out. Note that you can also access the user object such as ${user.Name()} | Hi ${user.Name()}, Please find attached Last week’s snapshot for incident management. |
Table | This is a table that can be used as a parameter whether the scheduled report should run and be sent. Example is a control table that can suspend particular scheduled reports. If a table combined with the condition returns 0 records then the scheduled report will not run. |
|
Condition | A condition linked to a table that can be used as a parameter whether the scheduled report should run and be sent. If a table combined with the condition returns 0 records then the scheduled report will not run. |
|
Context script | To be passed to Template reports that are part of the Scheduled report. This is the same as when you have to provide context when previewing a Template report.
Note that the context script can be constructed to provide “default” values and an “overrides” that uses the template report key or the template report id to distinguish one override from another. In this example all other reports in the scheduled report look at an Incident record, while the template report with key SampleTemplateReport looks at a Change Record instead. answer = { default: { table: "Incident", id: "cc91c0bd245811eebc251e79e3c7c1bb" }, overrides: { SampleTemplateReport: { table: "Change", id: "4e24e07d247f11ee8bbde66d9ebc34c6" } }} |
answer = { table: "Incident", id: "cc91c0bd245811eebc251e79e3c7c1bb"}; |
Please note that if your report generated is over 50MB, it will not be sent and an error will be sent in the resulting email.