cats:procedures:reportscheduler

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
cats:procedures:reportscheduler [2016/04/04 14:30] – jencats:procedures:reportscheduler [2019/11/11 16:47] (current) – jen
Line 1: Line 1:
 =====Report Scheduler===== =====Report Scheduler=====
-{{entry>0;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.) 
  
 +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. 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.+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.}}] [{{:cats:procedures:reports:reportscheduler_mainmenu.png?|Access the report scheduler from the main menu.}}]
  
-Modifying a report presents the same options as adding a new item. 
  
 ====Report Listing==== ====Report Listing====
Line 15: Line 14:
 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. 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:reports:reportscheduler_list.png?600|The list of scheduled reports.}}]+[{{: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. 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.
  
-The report listing also displays a notice if the CATS report printing service is currently running. You can see this in the screenshot above where it says **Scan is Running**. If this message is not present then the reports will not run at their scheduled time.+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==== ====Adding a Report to the Schedule====
  
-To schedule a report, select //New Item// from the menu. +To schedule a report, select **New Item** from the menu. 
  
 This will bring up an empty report scheduler item dialog. This will bring up an empty report scheduler item dialog.
  
-[{{:cats:procedures:reports:reportscheduler_new.png|An empty report scheduler item.}}]+[{{:cats:procedures:reportscheduler_item.png?|An empty report scheduler item}}]
  
 The report scheduler item has the following options: 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.   * **Enabled**: Uncheck this box to disable a scheduler item.
-  * **Title**: The display name for this 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.
-  * **Type**: Use the drop-down to select the type of report. +
-  * **Pick Report**: Click on the button to bring up a list of saved report formats for that report type. +
-  * **Schedule**: Use this area to specify the interval for printing the reports. Reports can be scheduled on a recurring basis (Daily, Weekly, Monthly, or Yearly) or set to be run Manually.+
   * **Next Run**: The calculated date and time that the report will next be run.   * **Next Run**: The calculated date and time that the report will next be run.
   * **Output**: the type of output for the report.   * **Output**: the type of output for the report.
     * **Printer**: send the output to the default printer.     * **Printer**: send the output to the default printer.
     * **HTML**: send the output to a file     * **HTML**: send the output to a file
-      * **HTML**: create an HTML file. 
-      * **Excel**: create an Excel spreadsheet. 
-      * **Word**: create a Word document. 
-      * **PDF**: create a PDF document. 
     * **CSV**: send the output to a CSV 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.     * **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.
  
-Selecting an output of HTML or CSV will provide additional options to send the report as an attachment in an email. +<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 warning>Disabled reports will never run.  You can disable/enable a report by toggling the box at the top right labeled **Enabled**. You should update the //Next run// value for any reports that have been disabled.+
 </note> </note>
  
 ====Modifying a Scheduler Item==== ====Modifying a Scheduler Item====
  
-To modify a scheduler item, either double-click on the item in the list or select it and select //Edit Item// from the menu.+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.
  
-[{{:cats:procedures:reports:reportscheduler_daily.png|A scheduler item for an open position report, set to print daily to email.}}] 
  
 ====Scheduling==== ====Scheduling====
Line 72: Line 81:
 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. 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.
  
-<note important>Sending reports as email attachments requires the CATS email notification service.</note>+[{{: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"}} {{tag>"report listing" "add report to schedule" "scheduling"}}
  • cats/procedures/reportscheduler.1459780238.txt.gz
  • Last modified: 2017/12/19 03:21
  • (external edit)