# Schedule a Report

You can run User Console reports with scheduling options set to launch reports during times of reduced traffic on your system or on a recurring basis.

Perform the following steps to set up a schedule for running a report:

1. Log in 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 **Files** pane, click the file that you want to run.
4. In the **File Actions** pane, click **Schedule**.

   The New Schedule dialog box opens.

   ![New Schedule dialog box](https://591371677-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFgwF7oC7Y6b7XWdahykf%2Fuploads%2Fgit-blob-1ed6031fb4bdb9b09584580e15d1e62fb532379d%2FNew%20schedule%20dialog%20pg1.png?alt=media)
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**                     | Select this checkbox to append the value specified in the **Schedule Name** with a timestamp to name the generated content. Use the list to choose the timestamp format. The **Preview** box shows the formatted name and timestamp, which is also the **Attachment name** if the report is emailed.                                                                                                                                                                                                                                                                                                                                             |
| **Generated Content Location**                                | <p>Specify a location for the generated content. Click <strong>Select</strong> to open the Select Folder dialog box and browse to a folder location to choose it.</p><p>If an administrator has added a Virtual File System (VFS) location for storage, you can select it in the VFS Connections section. If the VFS connection was created in the current session, you may have to refresh the connection using the refresh button. When you click <strong>OK to create the connection</strong>, a Pentaho virtual file system (<code>pvfs</code>) path appears in the <strong>Generated Content Location</strong> box as the VFS location.</p> |
| **Overwrite existing files with the same name and timestamp** | Select this checkbox to overwrite any existing files with the same name and timestamp and save it to the specified location.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **Owner**                                                     | Specify the schedule owner. Click **Change** to view the list of available users in the user repository and select a new user.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

6\. Click \*\*Next\*\*.

```
![New Schedule dialog box](New%20schedule%20dialog%20pg2.png)

Choose the log level, mode, and view any scheduled block-out times. If selecting a recurrence, select the start and end dates and recurrence pattern.
```

| Section                                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Recurrence**                                               | <p>Choose a time interval for the report from the <strong>Recurrence</strong> list:</p><ul><li><strong>Run Once</strong>: Runs the file one time.</li><li><strong>Seconds</strong>: Runs the file repeatedly at the time interval (in seconds) specified in the <strong>Recurrence pattern</strong>.</li><li><strong>Minutes</strong>: Runs the file repeatedly at the time interval (in minutes) specified in the <strong>Recurrence pattern</strong>.</li><li><strong>Hours</strong>: Runs the file repeatedly at the time interval (in hours) specified in the <strong>Recurrence pattern</strong>.</li><li><strong>Daily</strong>: 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 <strong>Recurrence pattern</strong>.</li><li><strong>Weekly</strong>: Runs the file repeatedly on the day(s) specified in the <strong>Recurrence pattern</strong>.</li><li><strong>Monthly</strong>: Runs the file repeatedly on the day of the month specified in the <strong>Recurrence pattern</strong>.</li><li><strong>Yearly</strong>: Runs the file repeatedly on the date specified in the <strong>Recurrence pattern</strong>.</li><li><strong>Cron</strong>: Runs the file according to the <a href="schedule-a-report/quartz-cron-attributes">Quartz cron attributes</a> in the <strong>Cron String</strong> field. If you want to enter a custom time interval, choose the <strong>Cron</strong> option.<br>If block-out times have been scheduled by your administrator, a <strong>View Blockout Times</strong> button appears on the bottom of the New Schedule window. Click <strong>View Blockout Times</strong> to view the list of block-out times. For more information, see <a href="manage-schedules/prevent-scheduling-by-setting-blockout-times">Prevent Scheduling by Setting Blockout Times</a>.</li></ul> |
| **Start Time**                                               | Specify a start time to run the file.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **Ignore daylight saving adjustment (Use 24 hour interval)** | <p>Select this checkbox to ignore a daylight-saving change in the recurrence pattern. When <strong>Daily</strong> is selected as the <strong>Recurrence pattern</strong>, the report runs after the number of 24-hour increments have elapsed.</p><p>When you clear this checkbox, the report runs on the <strong>Start time</strong> after the number of specified days has elapsed.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **Recurrence pattern**                                       | Depending on 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](https://docs.pentaho.com/pba/10.2-analytics/pentaho-user-console/about-pentaho-user-console-perspectives/schedules/schedule-reports/schedule-a-report/quartz-cron-attributes) reference to learn the Quartz Cron syntax.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **Details**                                                  | Click **Enable safe mode** to check every row that passes through the stream to ensure that all layouts are the same as the first row. If a row does not match the first row's layout, an error is generated and included in the report.Click **Gather performance metrics** and select a **Log Level** from the list to review the processing activities and operations. See Logging Levels in the **Pentaho Data Integration** document for log details.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **View Blockout Times**                                      | Click to view the block-out times scheduled by your administrator. For more information, see [Prevent Scheduling by Setting Blockout Times](https://docs.pentaho.com/pba/10.2-analytics/pentaho-user-console/about-pentaho-user-console-perspectives/schedules/schedule-reports/manage-schedules/prevent-scheduling-by-setting-blockout-times).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

7\. Click \*\*Next\*\*. The selected report may run using several parameters which you may be asked to specify, such as output type:

```
-   **HTML**
-   **PDF**
-   **Excel**
-   **Comma Separated Value**
-   **Rich Text-Format**
-   **Text**
```

8\. Click **Next**.

```
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** if you do not want to email a copy of the report.
-   Click **Yes** if you want to email a copy of the report.
```

9\. If you selected **Yes**, enter email addresses in the **To** field, or click **Select** and use the Select Groups and/or Emails dialog box to specify emails and email groups who should receive report emails then click **OK**.

```
**Note:** For unique report identification, select **Append timestamp to generated content** and a time stamp format \(see step 5\) to produce the **Attachment name**.
```

10\. Click **Finish**.

The schedule is created and appears in the Schedules page 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](https://docs.pentaho.com/pba/10.2-analytics/pentaho-user-console/about-pentaho-user-console-perspectives/schedules/schedule-reports/set-up-emails-for-scheduled-reports).