You are here: Reporting > Scheduling reports

Report Definitions
Scheduling reports

The Report Browser lets you run reports on a schedule you specify: once a week, every hour, or at some other interval; once, indefinitely, up to a stated number of runs, or over some period of time. You can subscribe to reports and receive their output by email, and add other application users to the distribution list for reports you have scheduled. See Report Definitions — Subscribing to reports.

For an example, see PDN article 26372 How to schedule reports and subscribe to scheduled reports.

Scheduling a report

To schedule a report, right-click the report shortcut in the Report Browser. In the Report Information window that appears, a Schedule button is enabled if the report is available for scheduling. Click the button to display the Schedule Reporting Task form.

The Schedule Reporting Task form

The form allows you to set various options for when and how frequently to run the selected report.

Task Definition

Label	Description
Task Name	Required, and populated by the report. Accept the default, or edit for clarity. The name must have only letters, numbers, and the underscore character, without spaces.
Task Description	Required, and populated by the report. Accept the default, or edit for clarity.

The form lists the category name, shortcut name, report class and report name as provided by the report.

Task Scheduling

Label

Description

Time Of Day

Select an hour when the report will run. The times relate to the time zone where the server running this instance of PRPC is located.

One-time or recurring

Select the One-Time only radio button if the report is to run only once. In the On: field, select the date on which the report will run.

Select the Recurring task radio button if the report is to run more than once. Additional fields appear:

Recurrence Information

Label

Description

Frequency Required. Select Daily, Weekly, Monthly, or Yearly.

Start
Required. Select a start date from the date selection tool.

For an end date select one of the offered radio buttons:

No end date — the report will run indefinitely.

End after: — enter an integer in the occurrences field to indicate how many times the report should run.

End by: — select a date from the date selection tool. The report will recur according to the schedule you set until this date.

On error, retry

If this check box is checked, the report will attempt to run again if it is unable to complete due to an error. In the additional fields that appear, specify how many times the report should attempt to run, and how long it should wait between attempts.

Task Output Processing

Label	Description
Output File Format	Select either `PDF` or `Excel Workbook` from the drop-down list.
Enable authorized users to subscribe to task notifications	Check this check box to allow other authorized users to subscribe to this report. They will receive an output file each time the report runs. See Report Definitions — Subscribing to reports.
Send Notifications to the following users	Select the Operator ID of each person to whom you want the report sent each time it runs. The current user's Operator ID appears by default in the first row of the notifications list. Click the add-row icon ( ) to add additional recipients.

Click Submit to schedule the report, or Cancel to close the form without saving your changes.

Processing notes

A scheduled report is a work item (of work type Pega-ScheduledTask), with prefix PX-ST-, saved in the database table pc_schedule_task. Processing of scheduled reports occurs in background, through the Pega-RulesEngine agents. Ensure that this agent is enabled on at least one node of your system.