Skip to main content
Version: 0.10

Schedules

A schedule runs one scan template on a repeating cadence. It has four parts: a name, an optional description, the template it runs, and a cron expression saying when. There are no target lists or maintenance windows on a schedule: what is scanned, and how long a scan may take, are settings of the template.

Schedules live under Scans → Scheduled. For how schedules fit with templates and runs, see Scanning.

Creating a schedule​

Open the New scan schedule dialog in one of three ways:

  • New schedule on Scans → Scheduled, where you also pick the template;
  • Schedule on a template's page, or Schedule scan in the template list's row menu, where the template is already chosen and the name is pre-filled as <template name> schedule.

Then fill in:

FieldNotes
Schedule name2 to 64 characters: letters, digits, spaces and . - _ : / \. Must be unique among the tenant's schedules
Description (optional)Up to 500 characters
Scan templateThe template to run. A template on an isolated integration cannot be scheduled
RunsThe cadence, see Choosing the cadence
Enable straight awayTicked by default

Select Create schedule. The schedule's page opens.

A tenant can have up to 20 schedules by default; your deployment can set a different limit per tenant. Creating one more is refused with a message giving the limit.

Schedules are created paused

Velum Edge always creates a schedule paused. With Enable straight away ticked, the console enables it immediately afterwards. If that second step fails, the schedule exists but is paused, and the console tells you to enable it from its page. Untick the box to create it paused on purpose.

Choosing the cadence​

The Runs editor offers five modes:

ModeYou chooseExpression it writes
HourlyEvery 1 to 23 hours, at 00, 15, 30 or 45 minutes past0 30 */4 * * * (every 4 hours at half past)
DailyEvery 1 to 30 days, at a time0 0 2 * * * (every day at 02:00)
WeeklyOne or more days of the week, at a time0 0 6 * * MON,THU
MonthlyA day of the month from 1 to 28, at a time0 0 3 1 * * (03:00 on the 1st)
CustomAny expression, typed by hand

Times in the pickers are quarter hours. A new schedule starts on daily at 02:00 (0 0 2 * * *).

Under the controls the editor always shows the expression, a plain-language reading of it, and the next three run times converted to your local time. If the expression can never fire (for example 31 February), it says so.

Cron syntax​

Velum Edge evaluates schedules in UTC. Plan cadences against UTC, not your local time: a daily run at 0 0 2 * * * starts at 02:00 UTC, which the editor's preview shows in your own time zone.

The expression has six fields, one more than the Unix crontab most people know. The first field is seconds:

┌───────────── second (0-59)
│ ┌─────────── minute (0-59)
│ │ ┌───────── hour (0-23)
│ │ │ ┌─────── day of month (1-31)
│ │ │ │ ┌───── month (1-12 or JAN-DEC)
│ │ │ │ │ ┌─── day of week (0-7 or SUN-SAT; 0 and 7 are both Sunday)
│ │ │ │ │ │
0 0 2 * * *

Each field accepts * (any), a single value, a list (1,15), a range (MON-FRI), and a step (*/6, or 5/15 meaning from 5 in steps of 15). ? is accepted in place of * in the day fields. A five-field Unix expression such as 0 2 * * * is refused.

When both day of month and day of week are restricted, a run happens only on days that match both. Unix crontab would run on days matching either.

These shorthands are also accepted:

ShorthandSame as
@hourly0 0 * * * *
@daily, @midnight0 0 0 * * *
@weekly0 0 0 * * 0 (Sunday)
@monthly0 0 0 1 * *
@yearly, @annually0 0 0 1 1 *

Examples:

ExpressionRuns (UTC)
0 0 2 * * *Every day at 02:00
0 0 */6 * * *Every 6 hours, on the hour
0 15 1 * * MON-FRI01:15 on weekdays
0 0 22 * * SUN22:00 every Sunday
0 30 0 1,15 * *00:30 on the 1st and 15th of each month
0 0 4 1 */3 *04:00 on the 1st of every third month
note

The console's editor does not accept the special forms L, W and # (last day, nearest weekday, nth weekday) and reports them as not valid. Use lists and ranges instead.

Enabling and pausing​

A schedule is either Enabled or Paused:

  • On the schedule's page, the header button reads Enable or Pause and applies at once, separately from any unsaved edits on the page.
  • In the list, each row's menu offers Enable or Pause for that schedule; ticking rows offers Enable, Pause and Delete schedules.

A paused schedule can still be edited, but nothing runs until it is enabled again. Pausing does not affect a run that has already started.

When the next run happens​

Velum Edge checks enabled schedules every 30 seconds. For each one it takes the later of two moments, when the schedule was last enabled and when it last started a run, adds one minute, and finds the next slot of the cron expression after that. When that slot has passed, it starts a run.

In practice:

  • Enabling starts the clock now. The first run is the next slot more than a minute after you enable the schedule. A schedule enabled at 09:59:30 with an hourly cron does not fire at 10:00; it fires at 11:00.
  • Re-enabling does not catch up. Slots that passed while the schedule was paused are skipped.
  • A missed slot runs once. If a slot passes while the schedule is enabled but nothing could start it (for example the platform was being upgraded), the schedule starts one run as soon as possible, not one per missed slot. The schedule's page shows Due now in this case.
  • A disabled sensor skips the slot. When the template's sensor is disabled, no run is started and the slot is not counted as run, so enabling the sensor again starts one catch-up run.
  • Runs can start up to about 30 seconds after the slot.

A schedule whose template, integration instance, sensor or tenant has been deleted can never run, and Velum Edge pauses it automatically.

If a run is still going​

A schedule does not check whether its previous run has finished. When the next slot comes, it starts a new run even if the last one is still queued, running, or waiting for review. Each run is independent and appears separately in Scans → History.

Leave room between runs

Choose a cadence longer than a scan normally takes, and longer than the time you need to review it if its template holds changes for approval. Overlapping runs of the same template each produce their own changes, and each one that waits for review counts towards the tenant's scan history limit.

The schedule list and page​

Scans → Scheduled lists the tenant's schedules with their Name, the template they run (Runs template), Cadence, Next run, Last run and State. Description and Id can be added from the Columns menu. You can search by name and filter by State (Enabled or Paused). Times are shown in your local time.

A schedule's page has two parts:

  • Schedule: the editable name, description, template and cadence. Changes are saved together with Save changes. The template can be swapped for another template in the same tenant.
  • Status: the state, Next run (or Paused, Due now, or Never with a prompt to check the cadence when the expression can never fire), Last run, Enabled at, the template, and the number of scans the template has run, by this or any other schedule or by hand. A run does not record which schedule started it.

Deleting a schedule​

Use Delete schedule on its page, the row menu in the list, or Delete schedules for ticked rows. The schedule stops; the template and every scan it already produced stay as they are. Deleting cannot be undone.

See also​