Scheduling a Background Job
Purpose
The Schedule Job function is used when you want to control when a background job runs. This may be helpful when:
A job uses more resources and should run outside clinic hours.
Data may not be available until later in the day.
Running a job more or less often improves data freshness.
Types of Schedules
⏲️ Interval Schedule – runs the job on a set interval (e.g., every 6 hours).
📅 Calendar Schedule – runs the job on specific calendar days and times.
❌ No Schedule – the job is not scheduled; it must be run manually.
Configuring a Job as an Interval Schedule
Use this when you want the job to run at a regular time interval (e.g., hourly, daily, weekly).
🚧 To set a job to run on an Interval Schedule, follow the steps below:
Locate the job in the System → Jobs table by scrolling or searching.
Confirm there is a Schedule button in the Actions column.
Click the Schedule button.
A window will open with schedule options.
Select Regular Interval for the Schedule Type.
Choose the interval (e.g., every 24 hours, every 6 hours, every 30 minutes).
Options include Monthly, Weekly, Every 48 Hours, Every 24 Hours, Every 12/6/3/2 Hours, or smaller intervals like 60/30/15 minutes.
Click Save.
The job’s record will update in the table.
Check the Schedule/Repeat column to confirm it reflects your new setting.
Configuring a Job as a Calendar Schedule
Use this when the job should run at a specific time on selected calendar days.
🚧 To set a job to a Calendar Schedule, follow the steps below:
Locate the job in the System → Jobs table by scrolling or searching.
Confirm there is a Schedule button in the Actions column.
Click the Schedule button.
A window will open with schedule options.
Select Calendar Schedule for the Schedule Type.
Configure the Start On date (the first day the job should run).
Configure the At Time field (the time of day the job should run).
Select the calendar days to repeat (e.g., Mon/Wed/Fri).
Multiple days can be selected using Shift-click or drag.
Click Save.
The job’s record will update in the table.
Check the Schedule/Repeat column to confirm it reflects your new setting.
Configuring a Job with No Schedule
Use No Schedule if you want to remove a job’s schedule. The job can then only be run manually.
🚧 To set a job to No Schedule, follow the steps below:
Locate the job in the System → Jobs table by scrolling or searching.
Confirm there is a Schedule button in the Actions column.
Click the Schedule button. A window will open with schedule options.
Select No Schedule for the Schedule Type.
Click Save.
The job’s record will update in the table.
Check the Schedule/Repeat column to confirm it reflects your new setting.
Last updated