Scheduling reports

If you need the same report on a regular basis (for example as part of a month-end process) you can define the report once and then request that it be run at a defined interval.

This option is only available to users who have set the user interface preference to Advanced. For information on how to set user preferences, refer to Setting Account Preferences.

Once the advanced user interface has been enabled the user will see an additional tab titled Scheduler in all reports.

graphic

Run this report every...On...

Reports may be scheduled to run daily, weekly or monthly. If you select the weekly or Monthly options you will also be required to supply the weekday or date on which you want the report to be run.

Include data from the...

You must also define the period which will be included in the report. This may be Prior Day, Prior Week, Prior Month or Month To Date. Each of these periods is relative to the date on which the report is scheduled to be run. Care must be taken to ensure that

Repeat until

You must also specify a date on which the scheduled report will stop being generated. The application will continue to reschedule the report until the next scheduled date exceeds the date specified in this field. If you leave this field empty, the report will continue to be rescheduled indefinitely.

Name this report

Use this field to associate a name with the report. This name will be displayed in the notification emails which are sent when each generation of the report is complete and will also be displayed in the Report Management page

Once all the fields have completed as required click the Save button to finalise the new scheduled report.

Examples

  1. Schedule a report to be run on Monday of each week using data from the previous week. Repeat the report indefinitely. graphic
  2. Schedule a report to be run on the first of each month using data from the previous month. Repeat until the end of the year. graphic
  3. Schedule a report to be run on the 15th of each month using data from the 1st to the 14th (inclusive).Repeat indefinitely. graphic

Retrieving the output of scheduled reports

When each generation of a scheduled report is completed a notification email will be sent to the email address associated with your account. You can then log in and access the output using the Manage Reports function.

Alternatively, if you set the account preference for Attach reports to notification email, the output will be attached to the notification email as a zip archive thereby removing the need to log in to retrieve the output. for instruction on how to to set this preference, please refer to Setting Account Preferences.

Modifying & deleting scheduled reports

It is not possible to change the details of a saved schedule. You must use the Manage Reports function to delete the version of the report which is currently pending and then re-enter the scheduled report.

Additional options for settlement reports

If you have selected the Bank Submissions report the scheduler tab will contain an additional option, Report Style. This defines whether the scheduled report will be in the format of a Settlement Summary or Settlement Detail report. You should select the appropriate value for this field before clicking Save.

graphic
Click to download this documentation in PDF format