Schedule a Report

You can run reports from the User Console using scheduling options to launch reports during off-peak hours or on a recurring basis.

1. Log on to the User Console, and then click the Browse Files button.

2. In the Folders pane, browse to the folder containing the file that you want to run.

3. In the File pane, click on the file that you want to run.

4. In the File Actions pane, click Schedule.

   The New Schedule dialog box displays.

   

   New Schedule dialog box in User Console
5. Enter your selections for the following fields:

   Field	Description
   Schedule Name	Specify a name for the schedule, which will also be the name of the generated report content. If no name is entered in the Schedule Name field, the default is the name of the report file.
   Append timestamp to generated content	Click this check box to append the value specified in the Generated Content Name with a timestamp. When selected, a menu displays with a list of timestamp format options. Use the Preview panel to view how the name will display on the generated file
   Generated Content Location	Specify a location for the generated content. Click Select to browse to a folder location to choose it.
   Overwrite existing files with the same name and timestamp	Click this check box to overwrite any existing files that have the same name and timestamp as the one you are running and saving to the specified location.

6. Click Next. The schedule fields display.

   

   If selecting a recurrence, be sure to select start and end dates, as well as a recurrence pattern.

Field	Description
Recurrence	Choose a time interval for the report from the Recurrence list. Options include: Run Once: Runs the file one time. Seconds: Runs the file repeatedly at the time interval (in seconds) specified in the Recurrence pattern. Minutes: Runs the file repeatedly at the time interval (in minutes) specified in the Recurrence pattern. Hours: Runs the file repeatedly at the time interval (in hours) specified in the Recurrence pattern. Daily: Runs the file repeatedly, either every weekday at the time interval in days or at the time interval in 24-hour increments as specified in Recurrence pattern. Weekly: Runs the file repeatedly on the day(s) specified in the Recurrence pattern. Monthly: Runs the file repeatedly on the day of the month specified in the Recurrence pattern. Yearly: Runs the file repeatedly on the date specified in the Recurrence pattern. Cron: Runs the file according to the Quartz cron attributes in the Cron String field. If you want to enter a custom time interval, choose the Cron option. If blockout times have been scheduled by your administrator, a View Blockout Times button appears on the bottom of the New Schedule window. Click View Blockout Times to view the list of blockout times. For more information, see Prevent Scheduling by Setting Blockout Times.
Start Time	Specify a start time to run the file.
Ignore daylight saving adjustment (Use 24 hour interval)	Select this check box to ignore a daylight saving change in the recurrence pattern. When Daily is selected as the Recurrence pattern, the report is run after the number of 24-hour increments have elapsed. When you clear this check box, the report runs on the Start time after the number of specified days has elapsed.
Recurrence pattern	Depending your selected time interval in the Recurrence field, specify the recurrence pattern.
Range of recurrence	Specify the start and end dates for running this report. The report will begin running according to the specified recurrence pattern on the start date specified and complete its run cycle on the end date specified in this section.
Start Date (Run Once)	If you select Run Once for Recurrence, then specify the date to run the report.
Cron String (Cron)	If you select Cron for Recurrence, then specify the Cron syntax. Consult the Quartz cron attributes reference to learn the Quartz Cron syntax.

7. Click **Next**.

The selected report may run using several parameters which you may be asked to specify, such as output type.

8. If your Pentaho administrator has set up an email server, you may elect to email a copy of the report to selected users.

For example, you may want users in the Finance department to receive the Excel output of the report via email every time the report is run on the recurring schedule.

-   Click **No** to skip emailing a copy of the report to users.
-   Click **Yes** to email a copy of the report to users. Fill in the fields that display with the users’ details, and then click **OK**.

9. When you have completed your parameter selections, click Finish.

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

Note: For more information on how to email copies of reports to users when scheduling a report to run from the User Console, see Set Up Emails for Scheduled Reports.