Automate generation and distribution of a report
Generate and distribute scheduled reports via email.
Before you begin
Roles required: system_scheduler_admin
A user with the report_scheduler role can also create a scheduled report through a different navigation path. For more information, see Schedule emails of Core UI reports.
About this task
Scheduled reports can be distributed in PDF, CSV, or XLS format. Graphical reports can be distributed in PNG or PDF format. Multilevel pivot reports can only be scheduled in PDF format.
Note:
- It is not possible to schedule Calendar, Map, or Single Score reports. You can schedule Pivot Table reports only if the plug-in com.snc.whtp is enabled.
- Data may not appear on reports created by an individual whose user account is deactivated. To ensure that the desired data appears, an active user must recreate the scheduled report.
Procedure
Navigate to All > System Definition > Scheduled Jobs.
Select New.
Select Automate the generation and distribution of a report.
Populate the following fields:
| Field | Description | |
|---|---|---|
| Name | Name of the scheduled report. | |
| Report | Reference to the report you are scheduling. You can use the Search icon Image omitted: SearchIcon.png UsersSearch icon to locate the report.<strong>Note:</strong> Automatic email support is not available for Calendar, Map, and Single Score reports.</td></tr><tr><td> | Individual users who receive the report at the scheduled date and time. Users must have Notification set to Enabled on their user records to receive reports. |
| Groups | Groups that receive the report at the scheduled date and time. | |
| Email addresses | Comma-separated list of email addresses of report recipients who are not users on your instance. | |
| Application | Name of the scoped application that contains the report. Global appears if the report is in the global scope. | |
| Active | When active, scheduled reports are delivered. | |
| Run | Time interval to use for running the scheduled job:
For example, if the business calendar represents a fiscal year, and the starting date of each entry is a fiscal month, the scheduled job runs on the first day of each month.
Note: When you select Business Calendar: Entry Start or Business Calendar: Entry End, you can apply an offset factor to schedule the job to run before or after the time span of the selected business calendar. If you select a business calendar and all its business calendar spans are in the past, the job would never run since that is an invalid configuration. To learn more, see the Offset type and Offset fields. To learn more about creating and using business calendars and defining business calendar entries, see Creating business calendars and Define business calendar entries. | |
| Time zone | Time zone to use with the Time field entry when you specify the time at which the scheduled job should run. Select a time zone entry:
For example, the scheduled job runs at 04:45 p.m. US/Pacific time if it’s the user's assigned time zone, and you enter
For example, the scheduled job runs at 10:15 p.m. London time if Europe/London is the default system time zone for the instance, and you enter
For example, the scheduled job runs at 1:30 p.m. in the US Eastern time zone if you select US/Eastern, and enter | |
| Time | Time of day at which the scheduled job should run, expressed in hours, minutes, and seconds on a 24-hour clock. The selection that you make in the Time zone field determines the time zone for this entry. | |
| Day | Day on which the scheduled job should run.
| |
| Repeat Interval | Duration of the repeat interval for each scheduled job execution. Enter the duration in the number of days, hours, or minutes. For example:
| |
| Starting | Allows you to define the beginning window of time when you would like your job to start running. The job will actually run at the time specified in Run time. Select the calendar date and time. The Starting field appears only if you select one of the following Run types in the Run field:- Daily - Day and Month in Year - Day in Week in Month in Year - Monthly - Once - Periodically - Week in Month - Weekly For the run type Periodically, the Starting time is the date and time of the first scheduled job generation. | |
| Business Calendar | Business calendar entry that you’re using to determine the business calendar start or end date for the scheduled job. This field appears only if you select Business Entry: Start Date or Business Entry: End Date in the Time field. | |
| Offset type | Type of time offset, if any, to apply to the business calendar that you selected for scheduling this job:
| |
| Offset | Amount of time offset, expressed in days, hours, minutes, and seconds, to apply to the business calendar that you selected for scheduling this job. For example, if you want to schedule the job to start three days, 14 hours, 10 minutes, and 45 seconds before the business calendar start date, do the following actions:
| |
| Priority | Numerical priority for the scheduled job:
| |
| Conditional | When enabled, specify a scripted condition for generating the report. | |
| Omit if no records | When enabled, empty reports are not distributed. | |
| Condition | A conditional script that determines if a scheduled job should run. The last expression of the script should evaluate to a Boolean (true/false) value. This text box appears only if you select Use conditions. For more information about scripts on the ServiceNow platform, see Scripts.Warning: Conditional scripts for scheduled emails are executed in the sandbox. Therefore, function definitions are not allowed. Some API calls and keywords are also not allowed. For more information, see Script sandbox property. | |
| Subject | Text that appears in the subject line of the distribution email. | |
| Introductory message | \(Optional\) Add a message to the report. If the report output type is Embedded PNG, - Use the tag `${report:png}` in the message body to position the report in the message. Otherwise, the report appears at the bottom of the message. - Use the tag `${report:include_with}` to position other reports included with the email. Otherwise, these reports appear at the bottom of the message. | |
| Type | Report output type. Graphical reports can be PNG or PDF files. List reports can be PDF, Excel, or CSV files.When scheduling a graphical report, select the output type PDF or PDF-landscape to include the chart grid data. When scheduling a List report, select output type Excel or CSV. Select Embedded PNG to embed the report visualization in the body of the email. Large images are scaled to fit the email. For more information, see the section Report output formats. Note: It is only possible to schedule multilevel pivot reports in PDF output. | |
| Zip output | When selected, the report is sent as a zip file attachment to the email. | |
| Include with | One or more additional reports to include with the email. It is not possible to order the reports within the email. You can use the Search icon Image omitted: SearchIcon.png Search icon to locate the additional reports. | |
| Page size \(Multilevel pivot report only\) | Choose from A3, A4, Letter, or Legal size. To specify a different paper size, select Custom and enter the Page height and Page width in pixels. | |
| Page height \(in pixels\) \(Multilevel pivot report only\) | Shows when Page size is set to Custom. For non-standard paper sizes, multiply the page height in inches by 72 and enter the value in this field. | |
| Page width \(in pixels\) \(Multilevel pivot report only\) | Shows when Page size is set to Custom. For non-standard paper sizes, multiply the page width in inches by 72 and enter the value in this field. |
- Select Submit.
What to do next
To edit the scheduled email of a report job, open the job from the Scheduled Jobs list. To stop scheduled emails of a report, delete the relevant job's row from the Scheduled Jobs list.
Parent Topic:Create a scheduled job
Related topics
Advanced options for scheduled jobs