Skip to main content
Pentaho Documentation

Schedule Reports

Overview

Use the Schedules perspective to schedule your reports to run at regular intervals.

You can use the Schedules page of the User Console to schedule a report to run at regular intervals, on certain dates and times, and with different parameters. You can also set a scheduled report to be emailed automatically, if your system administrator has configured the server for emailing reports. After you schedule a report, you can pause or delete a schedule, as well as edit the schedule to change the frequency of the report, parameters, or email settings.

The system administrator may set up times when you cannot run a scheduled report, for example, to perform system maintenance, or to minimize scheduling during peak times. If any blocked out times are set up, you can view these times so you can choose an alternate schedule.

Schedule a Report

You can create a schedule and designate the frequency of the scheduled report, report parameters, and email settings.

  1. Login to the User Console, and click Browse Files to browse to the location of your report.
  2. Double-click the folder containing your report in the Browsing pane on the left, then click to select the report you want to schedule from the middle pane. The File Actions pane on the right of the Browse Files window populates with a list of actions that you can do with the selected report.
  3. Select Schedule from the File Actions pane. The New Schedule window appears.
  4. Enter a name for the schedule in the Schedule Name field. If no name is entered in the Schedule Name field, the default is the name of the report file.
  5. Choose a time interval for the report from the Recurrence list. To enter a custom time interval, choose Cron and consult the Quartz reference to learn the Quartz Cron syntax. If blockout times have been scheduled by your administrator, a View Blockout Times button appears on the bottom of the New Schedule window. A list of blockout times is viewable by clicking View Blockout Times.
  6. Choose a Start Time and a Recurrence Pattern, as well as Start and End Dates for the report. Click Next.
  7. Choose what type of file you would like the schedule to create from the Parameters field. Click Next. The email option will only appear if your system administrator has enabled email on the server.
    1. If you do not want to email a copy of the report, choose No.
    2. If you want to email a copy of the report, choose Yes. Type to fill in or edit the fields that appear.
  8. Click OK.

The schedule is created and appears in the list in the Schedules window of the console.

Edit a Schedule

You can edit a schedule to change the frequency of the scheduled report, report parameters, and email settings.

  1. Click the Home drop-down menu on the upper-left and click the link to the Schedules. The list of schedules appears in the Schedules page.
  2. Click the schedule you want to edit in the list, then click Edit in the scheduling toolbar. The Edit Schedule window appears.
  3. Type to rename the schedule in the Schedule Name field.
  4. Choose a new time interval for the report from the Recurrence list.
  5. Choose a new Start Time and Recurrence Pattern, as well as new Start and End Dates for the schedule. Click Next. If blockout times have been scheduled by your administrator, a View Blockout Times button appears on the bottom of the New Schedule window. A list of blockout times is viewable by clicking View Blockout Times.
  6. Choose what type of file you would like the schedule to create from the Parameters field. Click Next. The email option will only appear if your system administrator has enabled email on the server.
    1. If you do not want to email a copy of the report, choose No.
    1. If you want to email a copy of the report, choose Yes. Type to fill in or edit the fields that appear.
  7. Click OK.

The schedule is edited and appears in the list in the Schedules window of the console.

Delete a Schedule

After you have scheduled a report, you can easily delete the schedule without deleting the report.

  1. Click the Home drop-down menu on the upper-left and click the link to Schedules. The list of schedules appears in the Schedules page.
  2. Click the schedule that you want to delete in the list. The schedule is highlighted.
  3. Click Delete in the upper right of the toolbar to delete the highlighted schedule. This deletes the schedule while leaving the report intact.

The previously scheduled report no longer runs at the specified interval.