Report Scheduler [CATS Knowledge Base]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
=====Report Scheduler=====

The report scheduler allows users to specify reports to be run on a schedule. (For example, running the open physical position report every morning.)
{{entry>0;Report Scheduler;-}}
Any report that can be designed and run from within CATS is available to be printed by the scheduler.

Access the report scheduler by choosing **File > Position Reports > Report Scheduler** from the main menu.

[{{:cats:procedures:reports:reportscheduler_mainmenu.png?|Access the report scheduler from the main menu.}}]


====Report Listing====

When you enter the report scheduler, CATS will display a list of the currently scheduled reports. For regular users, this list will contain only items scheduled by that particular user.

[{{:cats:procedures:reportscheduler_mainpage.png?|The list of scheduled reports}}]

The report listing displays the current status of each item, including the next scheduled run for the report, the last successful run, the result of the run and the output type.

Menu options for the report scheduler is as follows:
  * **New Item**: Create a new schedule.
  * **Delete Item**: Delete an schedule.
  * **Copy Item**: Copy a schedule item.
  * **Refresh List**: Refresh the item list.
  * **Recent Reports**: Shows any recently printed reports.
  * **Start Scan**: Run report immediate.
  * **Exit**: Take you back to the main menu.

See below for more details on each option.
====Adding a Report to the Schedule====

To schedule a report, select **New Item** from the menu. 

This will bring up an empty report scheduler item dialog.

[{{:cats:procedures:reportscheduler_item.png?|An empty report scheduler item}}]

The report scheduler item has the following options:
  * **Report Selection**: Choose a recently used report or select report by type. Make your report selection. If you are selecting a report by type, choose the report, and then click **Show List**. Choose the file name and click **Modify**. 

[{{:cats:procedures:reportscheduler_showlist.png?|Choose the report to schedule.}}]

Additional scheduler options are as follows:
  * **Report**: This option will automatically fill in when you choose you report type.
  * **Job Title**: This option will automatically fill in when you choose you report type.
  * **Sharing**:Allows control over what users can see or edit this report scheduler item.
[{{:cats:procedures:reportscheduler_sharing.png?|Allows control over users to see or edit report}}]
  * **Enabled**: Uncheck this box to disable a scheduler item.
  * **Schedule**: Use this area to specify the interval for printing the reports. Reports can be scheduled on a recurring basis (Daily, Weekly, Monthly, Yearly or Custom) or set to be run Manually.
  * **Next Run**: The calculated date and time that the report will next be run.
  * **Output**: the type of output for the report.
    * **Printer**: send the output to the default printer.
    * **HTML**: send the output to a file
    * **CSV**: send the output to a CSV file.
    * **Transfer**: send the output to a transfer file that can be printed to a printer later.
  * **Save to**: This features allows you to save the report.

<note warning>Disabled reports will never run.  You can disable/enable a report by toggling the box at the right labeled **Enabled**. You should update the //Next run// value for any reports that have been disabled.
</note>

====Modifying a Scheduler Item====

To modify a scheduler item, double-click on the item in the list.
[{{:cats:procedures:reportscheduler_highlightitem.png?|Highlight and double-click the item on the list.}}]
Modifying a report presents the same options as adding a new item.


====Scheduling====

The following is a quick explanation of the different scheduling options:

  * //Manual// runs only once. To run it again, enter the Report Scheduler and modify the item and click on **Now**.
  * //Daily// runs at the specified time each day. (e.g. 8:00 - will print every day at 8 AM)
  * //Weekly// runs at the specified time on the specified days. (e.g. MWF 16:15 - will print every Monday, Wednesday, and Friday at 3:15 PM)
  * //Monthly// runs once a month on the specified day of the month at the specified time. (e.g. 15 10:30 - will print on the 15th of the month at 10:30 AM)
  * //Yearly// runs once every year on the specified month, day and time. (e.g. 8 15 5:00 - will print August 15th at 5 AM)
  * Custom reports will on an interval of the specified number of minutes. (e.g. 1000 - will print every 1,000 minutes).
<note>You can set any report to run immediately by clicking on the **Now** button. You can also specify a specific date and time for a report by entering it into the //Next run// field.</note>

====Sending the Report as an Email Attachment====
To have the report sent as an email, select HTML or CSV as the output type and then enter the email address and subject line. To send to multiple addresses select the **...** button next to the Email field and enter a list of addresses separated by commas.

[{{:cats:procedures:reportscheduler_emailreport.png?|Send report as email attachment}}]

<note important>Sending reports as email attachments requires the CATS email notification service.See [[cats:procedures:maintenance:trackingnotifications|]].</note>

{{tag>"report listing" "add report to schedule" "scheduling"}}