Scheduling Jobs

Overview

ReportWORQ Jobs can be scheduled for repeated execution from directly within ReportWORQ or by an external scheduler. To schedule a job within ReportWORQ, choose the scheduler icon on the sidebar, then select Add Schedule. Begin by selecting the desired job(s) to be included in the scheduler. Then select the schedule using the schedule time editor. Optionally provide one or more email addresses in the notification list to receive a status notification email when this job completes. Email notifications are only available if the Email Distributor has been configured. Finally, if the job contains parameter values, it is possible to override those parameter values here. For example, if a job was configured to run for a specific Business Unit, we could configure a schedule to run and send reports for Business Unit A daily, and another schedule for Business Unit B Weekly.

The Scheduler can be disabled from the Configuration tab of the Administration screen. When the Scheduler is disabled none of the scheduled tasks will run. When the Scheduler is re-enabled, all scheduled tasks will run at the next scheduled time in the future. Scheduled task times that were missed while the Scheduler was disabled will not run automatically.

The Scheduler allows a user to select a folder OR specific jobs in the folder. The user cannot select a folder and jobs within that folder simultaneously. By selecting a folder ReportWORQ will apply the schedule to all the jobs within that folder. If new jobs are then added to that folder they will also be run on the configured schedule. Alternatively, by selecting individual jobs, ReportWORQ will only apply the schedule to those specific jobs.

The Scheduler, by default, provides a basic user interface for selecting a recurring schedule. However, ReportWORQ also supports an advanced mode, based on Cron syntax, which allows for more customized schedules. Visit Crontab Guru for more details about Cron and examples of different Cron syntax.

View our forum post for advanced scheduling options.

The Whitelist and Blacklist Features

The Whitelist and Blacklist features enable users to add specific rules to existing schedules by either Whitelisting or Blacklisting certain dates. The Blacklist option will remove certain dates from a schedule. For example, if a user has a report that goes out every day of the week, but does not want the report to be sent on the last Friday of the month, that user can add that day as a Blacklisted date and the report will not be sent out. The Whitelist option, on the other hand, will only run the job on the date entered. For example, if a schedule is already in place to run a job every month and a user would like to make a change to send that report out today, rather than deleting their schedule, that user can add a whitelisted date to run the job today. That job will only be run on the whitelisted day and when the user would like to return to the old schedule they can remove the Whitelist option. To enable the Whitelist or Blacklist features, a user must select the Date Filters option in the Scheduler.