After you create one or more report templates in DataMiner, you can schedule customized reports to run automatically at pre-determined intervals. For example, a quality manager may want to see a report emailed each morning detailing the state of production that occurred overnight.

The Report Scheduler allows you to:

• Generate customized reports on a timed interval
• Schedule and email reports automatically
• Generate customized reports automatically in response to certain thresholds or conditions being reached or exceeded using alarms set up with triggers and reactions. For example, when Yield falls below 94%, you might generate a quality report and email the Production Manager and Quality Team.

The Report Scheduler window

• Report Schedule tab - Use the settings on this tab to create, edit, or delete a report schedule. The window displays all existing reports, including information about who has access, when a report was created or last modified, and the recurrence type. If a report is queued, you can select it and temporarily suspend queuing if you want to make changes to the report.
• Report Schedule Queue tab - Use the settings on this tab to view and modify the reporting queue. You can temporarily hold a report by selecting the Place On Hold button, then use the Set To Ready button to resume the report. There's also a Stop button to stop a report from running—even if it already started running.

• Alarm Report Schedule Queue - This tab displays alarm reports by name, status, scheduled start date, started date, and completed date.
  
  

  Note:

  On any of the Report Scheduler tabs, use the Show only your report schedule queues check box to toggle between your report queue and everyone's.

Create and schedule a report

1. Log into the Analytics client application, then select Report Scheduler.
   
   

   Tip

   You can also access the Report Scheduler directly from the Production client application by logging into Production, then selecting Advanced Features >Report Scheduler.

2. Select Add New.
3. Enter a Name for the scheduled report in the Add New Report Schedule dialog.
   
   
   
   

4. Select the Output Retention check box, then specify how long the report will be retained before it is deleted. (You can specify a maximum of 180 days.)
   
   

   Note:

   Output retention is the length of time the file is stored in the report queue. Overwriting the output file overwrites the file in the selected folder.

5. Use the Select a Template drop-down to select a report template.

6. Under Select Items for Output, select the check boxes for the data items you want to include in the report (Report or Chart).
   
   

   Note:

   If you purchased the xStream Analytics option, your Type selections in the Add New Report Schedule dialog will also include Data Grid and Pivot Data.

7. For each output type you selected in Step 5, use the Output Type drop-down to select an output type for the report (Bitmap, PDF, HTML, and so on).
   
   
   
   
   

   Note:

   If you purchased the xStream Analytics option, your Output Type selections in the Add New Report Schedule dialog will also include these output formats: *.htm, *.txt, *.xml, and *.xls.

8. If the report template you selected has predefined runtime parameters, select the Runtime Parameters tab.
   
   

   Note:

   The availability of runtime parameters in the Report Scheduler can significantly reduce the number of report templates you need. In DataMiner, you can set up a "master" template that can be used for multiple reports. For example, if you previously created six report templates for six different customers, you can instead create a "master" template to use for multiple report schedules using Customer as a runtime parameter.

9. Select the highlighted runtime parameters on the appropriate tabs, then select OK.
   
   
   
   
10. Select the Schedule Settings tab along the top and clear the Run the report immediately check box.
11. Specify the Start time and date for the scheduled report to run.

12. Under Recurrence Pattern, select a frequency to run the report and when to repeat the report.
    
    
    
    

    Note:

    You can also specify how many reports to generate before stopping or set an end-date for the scheduled report. The default No end date setting keeps the report scheduled indefinitely.

13. Select the Grant Access tab, then use the Groups and Users tabs to select the check boxes that correspond to the groups and users who will have access to the report.
    
    
    
    
14. Select the Email Output tab, then use the Groups and Users tabs to select the check boxes that correspond to the Groups and Users who will receive the emailed report when the report for viewing at the specified frequency.
15. (Only for users who purchased the xStream option) Select the Export Location tab, then select the Browse button and select the location where reports will be exported automatically.
    
    
    
    

16. (Only for users who purchased the xStream option) Select the Overwrite output file with each generation check box if you only want to save the latest report each time a scheduled report is generated.
    
    

    Warning!

    Do not select the Overwrite output file with each generation check box if you need historical reports. When you select the check box, the latest report will be saved, but that report will be overwritten when the next scheduled report is generated.

17. Select OK to save the scheduled report.
    
    The scheduled report is now displayed in the list.