Skip to main content

Report Scheduler / Batch Reporting

  • Updated

The report scheduler allows you to add reports to be automatically run and delivered to the interested parties on a consistent and ongoing basis. You can also use this tool to package several reports together and run them as a batch.

Create a Scheduled Report Batch

Add Recipients

Choose Report Schedule / Frequency

Add a Report to the Scheduled Batch

Preview Batch Report(s)

Remove a Report from Scheduled Batch

View Batch List

Edit Batch

Delete Batch

Run Batch

Batch Log

Disable Scheduled Report Batch 

Create a Scheduled Report Batch

  1. Open the reporting module.
  2. At the top of the window in the menu bar, choose the calendar icon.

report_batch_icon.png

This will open the report scheduler window.

report_scheduler_screen_addbatch.png

  1. Click the plus sign (+) at the top of the window to add a new batch. This will open the report batch window.

report_batch_screen.png

  1. Enter a name for the batch.
  2. Choose the date and time that you want the batch to run in the Start Date Time field.

Add Recipients

  1. The email addresses can be added to the Email Recipient field. Clicking over the field will show a list of your organization's employee email addresses. You will need to click over their email address in the list to add them.
    Alternatively, if you type in the email addresses, enter a comma between the email addresses. You will need to click the enter key on your keyboard after adding the emails to add these to the list of recipients.

Choose Report Schedule / Frequency

  1. In the Recurrence Pattern section, you may set the schedule for the batch.
  2. Choose the recurrence option. Each recurrence option offers different fields to complete for the recurrence.
  • Daily
report_batch_recurrence_daily.png
  • Weekly
report_batch_recurrence_weekly.png
  • Monthly
report_batch_recurrence_monthly.png
  • Yearly
report_batch_recurrence_yearly.png
  1. You may type a date or use the calendar to set the End Date for the recurrence. The end date cannot be further than one year from the day you are creating the batch.
  2. Choose the Save button in the lower right of the window. This will return you to the report scheduler window.
  3. Click the X in the upper right of the window. This will return you to the reporting module.

Add a Report to the Scheduled Batch

  1. Open the reporting module.
  2. Choose the report you want to add to a batch by opening the report menu and navigating to the report..
  3. Fill in the parameters on the right side of the screen. Using a date range preset (Today, Yesterday, etc.) is recommended so that the report will update the date each time it runs.
  4. Click the Submit button to run the report.

add_report_to_batch.png

  1. Click the Report Scheduler button on the parameters panel. This will open the report scheduler screen.
    Alternatively, once you have set the parameters and run the report, you may click the calendar icon in the menu bar to open the report scheduler screen.

report_scheduler_screen_addreport.png

  1. Click the plus sign (+) on the batch that wish to add the report to. This will open a confirmation window.
  2. Click Yes.

report_scheduler_screen_addreport_confirmation.png

  1. The report will show added to the batch

report_scheduler_screen_report.png

Preview Batch Report(s)

  1. Open the reporting module.
  2. At the top of the window in the menu bar, choose the calendar icon. This will open the Report Scheduler window.
  3. Click to expand the report batch that contains the report you want to preview.
  4. Select the magnifying glass icon in the report row.

batchreport_preview.png

This will open a new tab containing the report you selected.

Remove a Report from Scheduled Batch

  1. Open the reporting module.
  2. At the top of the window in the menu bar, choose the calendar icon. This will open the Report Scheduler window.
  3. Click to expand the report batch that contains the report you want to remove.
  4. Select the trash can icon in the report row.

batchreport_delete.png

This will open a confirmation window. 

remove_report_confirmation.png

  1. Click Yes to remove the report from the batch.

View Batch List

  1. Open the reporting module.
  2. At the top of the window in the menu bar, choose the calendar icon. This will open the Report Scheduler window.

Edit Batch

  1. Click the pencil icon to open the batch in the list. This will open the report batch screen.

report_scheduler_editbatch.png

  1. You can add or remove recipients, update the recurrence options, or update the end date.
  2. Click the save button in the lower right.

Delete Batch

  1. Click the trash can icon for the batch row.

report_scheduler_deletebatch.png

  1. A confirmation window will open. Click Yes on the confirmation window to delete the batch.

delete_batch_confirm.png

Run Batch

  1. Click the play button icon on the batch row.

report_scheduler_runbatch.png

  1. You will receive a confirmation window. Click Yes on the confirmation window to run the batch immediately.

run_batch_confirm.png

Batch Log

  1. Click the page icon on the batch row.

report_scheduler_batchlog.png

  1. This will open the batch log. This shows information about changes made to the batch and when it has been run.

batch_log.png

Disable Scheduled Report Batch 

  1. Open the reporting module.
  2. At the top of the window in the menu bar, choose the calendar icon. This will open the Report Scheduler window.
  3. Select the pencil icon on the row of the batch you wish to disable. This will open the report batch screen.
  4. Click over the Scheduled toggle to move it to the Off setting.

disable_batch.png

  1. Click the Save button in the lower right.

Related articles