You can use the Schedules page of the Pentaho 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
Log on to the User Console, and then click the Browse Files button.
In the Folders pane, browse to the folder containing the file that you want to run.
In the File pane, click on the file that you want to run.
In the File Actions pane, click Schedule.The New Schedule dialog box displays.
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.
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.
Click Next.The selected report may run using several parameters which you may be asked to specify, such as output type.
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.
When you have completed your parameter selections, click Finish.
Edit a Schedule
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.
Click the schedule you want to edit in the list, then click Edit in the scheduling toolbar.The Edit Schedule window appears.
Type to rename the schedule in the Schedule Name field.
Choose a new time interval for the report from the Recurrence list.
Choose a new Start Time and Recurrence Pattern, as well as new Start and End by 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.
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.
Delete a Schedule
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.
Click the schedule that you want to delete in the list.The schedule is highlighted.
Click Delete in the upper right of the toolbar to delete the highlighted schedule.The schedule is deleted, leaving the report intact.
As an administrator, you may create, run, delete, stop, edit, or resume schedules through the Schedules page in the Pentaho User Console.
After a report is scheduled by any user, an admin may edit, pause, or delete that schedule, as well as change the frequency of the report, change parameters, or adjust email settings. To distribute reports using email, make sure you have configured the email server. You also have the ability to prevent users from scheduling specific files or reports.
You might need to control when schedules can run by setting up periods of time to forbid schedules. Setting up blockout times allows you to perform administrative functions, such as system maintenance or managing server traffic during peak usage times.
Prevent Scheduling of a Single Report or File
From the User Console Home menu, click Browse Files.The Browse Files page appears.
Browse to the location of a report from the Browse pane on the left of the Browse Files page.The Files pane in the center populates with a list of reports.
Click to select the report for which you want to deny scheduling, then click Properties in the Folder Actions pane.The Properties window for that report appears.
Click the General tab in the Properties window, then disable the box next to Allow Scheduling.
Prevent Scheduling by Setting Blockout Times
From the Pentaho User Console, you set up specific times on the server to block the running of schedules, which allows you to perform administrative functions such as system maintenance or managing server traffic during peak usage times.
From the User Console Home menu, click SchedulesThe Schedules page appears.
Click the Create Blockout Time button or the green Plus Sign (+) in the Blockout Times tool on the left side of the Schedules screen.The Blockout Time dialog box appears.
Enter values in the Recurrence, Start Time, Duration or End Time, and Start Date fields for the blocked out time.
Click OK. If Run Once is selected in the Recurrence field, a dash displays under the Start Time and End Time fields in the blockout list, until the blockout time passes.
Schedule Deletion of Generated Files
From the Pentaho User Console, perform the following steps:
Click on Administration in the drop-down menu on the upper right, then click on Settings.The Settings page appears.
To manually delete generated files now, confirm the age of the files to be deleted, then press Delete Now.The generated files older than the specified age are deleted.
To schedule regular deletion of generated files, press Schedule Deletion.The Schedule Deletion window appears.
Enter an age for the generated files in the field specifying number of days.
Choose a time interval for the schedule from the Recurrence list.
Choose a Start Time and a Recurrence Pattern, as well as Start Date and End Date for the scheduled deletion. Click OK.
Set Up Emails for Scheduled Reports
A convenient way to share reports is to specify an email server to be used by the Pentaho Server to send these reports to recipients. This feature works with the report scheduling feature to automate the process of emailing reports to your user community. Having an email server is not required to configure the Pentaho Server. If you want to get started quickly or do not have information about your email server, skip this task for now. You can always come back to it later.
Set up the Mail Server page
Log on to PUC, click Home and then select Administration from the drop-down menu.The Users / Roles page appears.
Click Mail Server.The Mail Server page appears.
Enter your email server settings.
Setting Description Connection Protocol Select the protocol used to access the email server:
- Microsoft Graph API
You must use Microsoft Graph API for Microsoft Exchange servers that require OAuth authentication. For other exchange servers, whether requiring OAuth authentication or not, use STMP as usual.
Host Name (SMTP) Address of your SMTP email server for sending email. Not applicable for Microsoft Graph API. Port Port number of your SMTP email server, usually 25. For Gmail, the value is 587. The default is 25. For Gmail, the value is 587. Not applicable for Microsoft Graph API. Authentication Type Select the type of authentication required to connect to the email server:
- OAuth 2.0
- Basic (for username /password-based access)
- No Auth
User Name Username used to connect to the email server for sending email. Required for all authentication mechanisms. Password Password used to connect to the email server. Only applicable when Authentication Type is Basic. Client ID Client identifier required to get the Auth Token from OAuth servers. Only applicable when Authentication Type is OAuth 2.0. Client Secret Client Secret credential required to get the Auth Token from OAuth servers. Only applicable when Authentication Type is OAuth 2.0. Scope Parameter required by the OAuth server to identify the permissions or scope of the Auth token being requested:
- For Microsoft Graph API, when the Grant Type is Client Credentials, see https://graph.microsoft.com/.default. For others, see https://learn.microsoft.com/en-us/graph/api/user-sendmail?view=graph-rest-1.0&tabs=http.
- For Gmail, see https://developers.google.com/gmail/api/auth/scopes.
Grant Type Select the method that is used by the application to gain the Access Token from the OAuth servers:
- Client Credentials
- Authorization Code
- Refresh Token
Microsoft Graph API supports all types. Gmail supports only the Authorization Code and Refresh Token types.NoteIf using Authorization Code, then the application gets a Refresh Token and replaces the Grant Type and token values for a one-time use code.
Token URL URL of the OAuth Server to get access tokens. Refresh Token Value obtained from the OAuth server for fetching a new access token. Only required when Refresh Token is the Grant Type. Authorization Code One-time use code obtained from the Authentication URL. Only required when Authorization Code is the Grant Type. Redirect URI Redirect URI provided during credential setup that is used for validation while getting the access token. Only required when Authorization Code is the Grant Type. Email "From" Name Name that appears in the "From:" field in an email. If left blank, the default email name for this field is Pentaho Scheduler. Email "From" Address Address that appears in the "From:" field in an email. If left blank, the default email address for this field is Pentaho Scheduler. Use Start TLS Select if the email server requires a Start TLS connection. Use SSL Select if the email server requires an SSL connection. This value must be enabled for Gmail. Not applicable for Microsoft Graph API.
Click Test Email Configuration, then click Save.A success message appears.