Relatude Help

36.2 Schedules

"LocalSettings": {
  "Schedules": [
    { "Id": "2f6d0c1e-5a7b-4c39-9f0e-0b3c2d1e4f50", "Job": "backup", "Unit": "Days", "At": "02:00" },
    { "Id": "8b1c4e2a-0d3f-4b6a-a1c2-7e9f0a1b2c3d", "Job": "delete-old-backups", "Unit": "Days", "At": "03:00" },
    { "Id": "c47e9a10-2b3c-4d5e-8f60-718293a4b5c6", "Name": "Weekly truncation", "Job": "truncate-log",
      "Argument": "delete-old", "Unit": "Weeks", "Days": "Sun", "At": "04:00", "TimeZone": "Europe/Oslo" },
    { "Id": "e09a5b6c-7d8e-4f90-a1b2-c3d4e5f60718", "Job": "send-digest", "Every": 15, "Unit": "Minutes",
      "At": "08:00", "Until": "18:00", "Days": "Mon-Fri" }
  ]
}
Field Default What it does
Id — Identifies the schedule. Use any new guid
Job — The job to run, not case sensitive. While no such job is registered, its runs are skipped with the reason
Name the job's name What the Scheduler page and the log call the schedule
Argument none Handed to the job
Enabled true Off keeps the schedule without running it
Every, Unit 1, Days The interval. Unit is Seconds, Minutes, Hours, Days, Weeks or Months
At midnight HH:mm. For days, weeks and months, the time of the run. Below a day, the first run of the day
Until midnight Below a day only: the last time of day a run may start
Days every day Days of the week: Mon,Wed,Fri or Mon-Fri. A weekly schedule without days runs on Mondays. Not used by months
DayOfMonth 1 Months only, 1 to 31. A shorter month runs on its last day, so 31 means the last day of every month
TimeZone the server's An IANA id such as Europe/Oslo, or UTC. 02:00 stays 02:00 across summer time. A cloud host's own zone is usually UTC
RunMissed true Runs that fell due while the database was closed run once when it opens. Off skips them

How the times work:

  • Below a day, runs follow the interval from At until Until, and the next day starts again at At, as in cron. So every 7 hours leaves a shorter gap before midnight.
  • Intervals of several days, weeks or months count from a fixed point in the calendar, so a restart does not shift them.
  • Summer time. A time the clock skips runs at the first minute after the jump. A time the clock passes twice runs the first time.
  • A changed schedule starts from the change. Moving a daily run from 14:00 to 08:00 at 10:30 does not count this morning's 08:00 as missed.
  • No overlap. While a schedule's previous run is queued or running, the schedule skips its time and says so.

The scheduler reads the schedules from the settings at every tick, so a change applies without reopening the database. Nothing runs while AutoDequeTasks is off: the runs are queued, but nothing takes them.