Scheduled Background Tasks

This functionality enables you to schedule a background task at any given time. So, instead of running a background task now, you can schedule it to run at a different time. The background task scheduler will be available when launching the following processes:

  • Synchronise from the asset tree
  • Accept development in the asset tree
  • Generate proposed work orders.

Scheduled background tasks run on schedule frequencies. You are able to define the schedule frequency for a background task. For example, a background task can be scheduled to run once-off in the future or to run on a repeated schedule, such as on Wednesdays at 10 pm. The background task will not initiate as per normal process but will be triggered by the preconfigured schedule frequency.

Cron Expressions

In On Key, certain frequencies for scheduled background tasks are based on cron expressions. A cron expression consists of a string of fields, each field representing individual details of a schedule, such as the minutes, hours, days of the month, months and days of the week. The fields in a cron expression can be replaced with values and special characters, which determines the schedule.

When a scheduled background task's Frequency is set to "Schedule Days Of The Week" or "Schedule Days Of The Month", then the Cron Schedule will be autopopulated with the related cron expression. When the Frequency is set to "Custom", then you need to enter the applicable cron expression as the Cron Schedule. For information and examples on cron expressions that can be used for "Custom" frequencies, you can refer to crontab guru, which is a cron schedule expression editor.

My Scheduled Background Tasks

The Scheduled Background Tasks Dashboard shows the global scheduled background tasks for all users, whereas the My Scheduled Background Tasks Dashboard displays only your own scheduled background tasks. It enables you to see all the background tasks that you've scheduled in On Key.

To access your own scheduled background tasks, click System Management > My Scheduled Background Tasks in the main menu.

Scheduled Background Task Permissions

You will always be able to work on the scheduled background tasks that you create, ie the scheduled background tasks that are visible on the My Scheduled Background Tasks Dashboard. However, to be able to work on scheduled background tasks created by other users, you need the following custom permissions:

  • Can Schedule Background Task
  • Can View Others Schedule Background Tasks
  • Can Delete Others Schedule Background Tasks
  • Can Update Others Schedule Background Tasks.