Schedule Configured Reports
- Last UpdatedOct 30, 2024
- 6 minute read
You can define schedules for the reports that you have configured. You can schedule reports for one time only or on a recurring basis. The schedules are stored as SQL jobs on the BatchHistory databases SQL Agent (NOTE: SQL Agent needs to be running). You can edit them as your specific application requires.
To open the Report Schedule page
-
Open the AVEVA Batch Management Reports Administration page.
-
Click Schedule. The scheduled reports page appear.
To add a scheduled report
-
Click Schedule New Report. The Add Report form appears.
-
In the Name box, enter a name for the scheduled report.
-
Slide the Options settings to Enabled. If you do not slide the Options settings to Enabled, the report does not run as specified by the scheduled settings.
-
Select a report type from the Report Selection list. The list contains the report configurations that you have defined using the Report Configuration page.
-
Select a Schedule Type from the list. The list shows available intervals at which the report is to be produced. The type that you select determines the rest of the selections that appear on the form.
Note: If you select the End of Batch schedule type for a Batch Journal report, you must specify the BatchJournalEOB report template, instead of the normal BatchJournal template. The BatchJournalEOB template is optimized for End of Batch reports. For other schedule types, use the BatchJournal template.
The BatchJournal report template is meant to be used for interactive access. The BatchJournalEOB report template is meant to be used with End of Batch report triggers.
-
In the Description box, optionally enter text that describes the report.
-
Click Save Report Data. Based on the Schedule Type that you selected, the appropriate report form appears.
Schedule One Time Only Reports
A specific form appears for reports that are to be run only one time.
To schedule one time only reports
-
In the Name box, type a name for the scheduled report.
-
Slide the Options settings to Enabled. If you do not slide the Options settings to Enabled, the report does not run as specified by the scheduled settings.
-
Select a report type from the Report Selection list. The list contains the report configurations that you have defined using the Report Configuration page.
-
Select the One Time Only report from the Schedule Type list. The list shows available intervals at which the report is to be produced. The type that you select determines the rest of the selections that appear on the form.
-
In the Description box, optionally type text that describes the report.
-
The Report Duration area enables you to designate the amount of batch data that you want to include by specifying a period of elapsed time.
-
If you select Preset Duration, you can select a period of elapsed time from the list.
-
If you select Custom Duration, you can type a period of elapsed time in the Minutes box.
-
-
In the Run Date/Time boxes, type the date and the time that you want the report to run.
-
Click Save Report Data.
Schedule Daily Reports
If you select Daily Reports, a specific form appears.
To schedule a daily report
-
In the Name box, type a name for the scheduled report.
-
Slide the Options settings to Enabled. If you do not slide the Options settings to Enabled, the report does not run as specified by the scheduled settings.
-
Select a report type from the Report Selection list. The list contains the report configurations that you have defined using the Report Configuration page.
-
Select the Daily report from the Schedule Type list. The list shows available intervals at which the report is to be produced. The type that you select determines the rest of the selections that appear on the form.
-
In the Description box, optionally enter text that describes the report.
-
The Report Duration area enables you to designate the amount of batch data that you want to include by specifying a period of elapsed time.
-
If you select Preset Duration, you can select a period of elapsed time from the list.
-
If you select Custom Duration, you can type a period of elapsed time in the Minutes box.
-
-
In the Occurs box, type the frequency of occurrence, in days.
-
In the Daily Frequency area, you can select options for the report to run once or at intervals during the day:
-
If you select Occurs Once, enter the time in the box.
-
If you select Occurs Every, enter an interval number in the box, select an interval type, and enter start and end times.
-
-
In the Duration area:
-
Type the Start Date in the box.
-
Select either No End Date if you want the report to run on a recurring basis or End Date. If you select End Date, type an ending date in the box.
-
-
Click Save Report Data.
Schedule Weekly Reports
If you select Weekly Reports, a specific form appears.
To schedule a weekly report
-
In the Name box, type a name for the scheduled report.
-
Slide the Options settings to Enabled. If you do not slide the Options settings to Enabled, the report does not run as specified by the scheduled settings.
-
Select a report type from the Report Selection list. The list contains the report configurations that you have defined using the Report Configuration page.
-
Select the Weekly report from the Schedule Type list. The list shows available intervals at which the report is to be produced. The type that you select determines the rest of the selections that appear on the form.
-
In the Description box, optionally type text that describes the report.
-
The Report Duration area enables you to designate the amount of batch data that you want to include by specifying a period of elapsed time.
-
If you select Preset Duration, you can select a period of elapsed time from the list.
-
If you select Custom Duration, you can type a period of elapsed time in the Minutes box.
-
-
In the Occurs area:
-
Type the frequency of occurrence, in weeks.
-
Select the day on which the report is to be run.
-
-
In the Daily Frequency area, you can select options for the report to run once or at intervals during the day:
-
If you select Occurs Once, enter the time in the box.
-
If yo select Occurs Every, enter an interval number in the box, select an interval type, and enter start and end times.
-
-
In the Duration area:
-
Type the Start Date in the box.
-
Select either No End Date if you want the report to run on a recurring basis or End Date. If you select End Date, type an ending date in the box.
-
-
Click Save Report Data.
Schedule Monthly Reports
If you select Monthly Reports, a specific form appears.
To schedule a monthly report
-
In the Name box, type a name for the scheduled report.
-
Slide the Options settings to Enabled. If you do not slide the Options settings to Enabled, the report does not run as specified by the scheduled settings.
-
Select a report type from the Report Selection list. The list contains the report configurations that you have defined using the Report Configuration page.
-
Select the Monthly report from the Schedule Type list. The list shows available intervals at which the report is to be produced. The type that you select determines the rest of the selections that appear on the form.
-
In the Description box, optionally type text that describes the report.
-
The Report Duration area enables you to designate the amount of batch data that you want to include by specifying a period of elapsed time.
-
If you select Preset Duration, you can select a period of elapsed time from the list.
-
If you select Custom Duration, you can type a period of elapsed time in the Minutes box.
-
-
In the Occurs area, select an option for when you want the report to run:
-
Specify the Day of the Month on which you want the report to occur.
-
Specify the day of the week and the monthly recurrence of the report.
Example 1: The 2nd Friday of every 6 months.
Example 2: The Last Day of every 1 month.
Example 3: The 1st Day of every 12 months.
-
-
In the Daily Frequency area, you can select options for the report to run once or at intervals during the day:
-
If you select Occurs Once, enter the time in the box.
-
If yo select Occurs Every, enter an interval number in the box, select an interval type, and enter start and end times.
-
-
In the Duration area:
-
Type the Start Date in the box.
-
Select either No End Date if you want the report to run on a recurring basis or End Date. If you select End Date, type an ending date in the box.
-
-
Click Save Report Data.
Schedule an End of Batch Report
To schedule an end of Batch Report
-
In the Name box, type the name for the scheduled report.
-
Slide the Options setting to Enabled.
-
In the Report Selection list, click the End of Batch report that you previously configured.
-
In the Schedule Type list, click End of Batch.
-
In the Description box, optionally type text that describes the report.