Events
- Synopsis
- Full Details
In briefAn event is a one-line instruction to Continuum — an event type such as $JOB:HOLD
followed by that type's fields in a fixed order, separated by commas. Continuum recognises 61 types:
44 are applied — three of them raised only by an agent — 9 are accepted but not yet applied, and 8
$NOTIFY types are refused for good.
$MACHINE:STATUS is applied; $MACHINE:MAXJOBS is not.
WhereEvents are built in the same event form wherever they are raised: the job editor's Events tab, the workflow's Event Trigger tab, a Self Service button, a notification's OpCon Event action and a Vision trigger action. A legacy LSAM machine raises them from its MSGIN directory, and your own tooling through the events API. What each one did is in Operations › Event Log.
When
- You need the exact field order of an event type, or what one of its fields does.
- You want to know whether Continuum carries out a type you used before.
- An event failed saying its type or an option is not supported.
- You need to know which permission an event needs.
To decide when a job or workflow fires an event, see Workflow events.
How
- Choose the Event Type in the event form; disabled types are not yet applied.
- Fill in the type's fields; leave optional trailing fields empty.
- Fill in Named Instance when more than one instance of the workflow is built for the date.
- Check the line under Generated Event:, then save.
The full steps are in Run events on job outcomes.
- Fields are read by position. A trailing field can be left off; a middle one is left empty.
- Tags are separated by
,or;; dates and properties by;. - Any field can carry a property token, resolved as the event is processed.
- An event line can be up to 262,144 characters long.
- A
$PROPERTYevent with anMI.name writes an agent's machine property, and needs Agents Edit under All workspaces. $TOKEN:ADD,SETandDELETEare applied as the matching$PROPERTYevent, and$JOB:REVIEWas$JOB:UNDERREVIEW.- An event sent to the events API can be written in Classic's XML syntax; everywhere else uses the comma syntax.
- The permission is checked in the workspace of the object the event names — for example Job Instances Create to add a job, Job Instances Execute to hold, start or restart one.
- A comma inside a value cannot be escaped and shifts every later field.
$SCHEDULE:CANCELcancels only the jobs that have not started; running jobs finish and the instance then completes.- A not-yet-applied type fails every time it is raised, and a not-supported one is refused for good: replace it rather than raising it again.
- Setting Apply Exceptions or Force Restart fails the event rather than being ignored.
Reopen Schedule is accepted, but an add always reopens a Completed instance, even with
N. A Restart Step works only on a UNIX Command, SAP R/3 Job, SAP BW Process Chain, z/OS Batch Job or z/OS Started Task, and only with a step that job reported. Only a z/OS job takes an end step (start|end). - Mark Job Good and Mark Job Bad override the job's real result; its dependents act on the mark.
Task walkthrough: Run events on job outcomes. This page is the full catalog of event types and their syntax.
An event is a one-line instruction to OpCon Continuum: hold a job, build a workflow instance for a date, raise a threshold, set a property, send an email. It is written as an event type followed by that type's fields, separated by commas:
$JOB:HOLD,CURRENT,NIGHTLY_CORE,POST_ACH
Continuum recognises 61 event types in ten categories, plus three older spellings of the property events. Of the 61:
- 44 are applied — Continuum carries them out. Three of them, the tracked and queued job events, only an agent can raise — see Events only an agent raises.
- 9 are accepted but not yet applied. The event is recorded and then fails, saying the type is not yet supported.
- 8 are not supported, and will not be. The event is recorded as failed and refused before it does anything, saying the type is not supported on this platform and will not be applied.
The full list is in The catalog. How a job or workflow decides when an event fires is on Workflow events; what happened to an event once it was raised is in the Event log.
- How Events Work
- Support and Permissions
- Job Events
- Schedule and Definition Events
- Threshold, Resource and Property Events
- Machine and Calendar Events
- Notification and Console Events
- Troubleshooting
How Events Work
Where an event can be raised from
The same event types, with the same fields, are used everywhere. Every surface in the product builds an event in the same event form: you choose the Event Type, the form shows that type's own fields, and the line it will send is shown read-only under Generated Event:. No surface offers a smaller set of types than another, and none offers the three agent-only types.
| Raised from | Where you set it up | More |
|---|---|---|
| A job reaching a status, a termination description or a completion expression | The job editor's Events tab | Workflow events |
| A workflow completing | The Event Trigger tab of the workflow set-up panel | Workflow completion events |
| A Self Service button | The button's events, in Self Service Config | Service requests |
| A notification trigger | An OpCon Event action on the trigger, or on an escalation level | OpCon Event actions |
| A Vision card | An action on the card's trigger. Trigger processing is off by default, so an action is saved but does not fire unless Continuous has turned it on for your organization | Triggers |
| A legacy LSAM machine | A file of event lines written into the agent's MSGIN directory | Events raised by a legacy agent |
| Your own tooling | The events API: POST /api/v1/events, or POST /api/v1/events/batch for several at once | — |
What the event form offers. The Event Type picker lists the types grouped by category, each
shown by its display name with the $TYPE code beneath it.
- A type that is not yet applied is listed but disabled, marked Not yet available, so you can see it exists but cannot pick it for a new event. A saved event of that type reports, for example, Reschedule Job is not yet available, so this event will not fire.
- A type that is not supported is not listed at all, and a saved one reports, for example, Run Command is not supported.
- An event already saved with a type that is no longer offered still shows the type it was saved with, rather than reading as blank.
The older spellings $TOKEN:ADD, $TOKEN:SET and $TOKEN:DELETE are never offered for a new
event, but a stored event or an event line that uses them is accepted and applied as the
$PROPERTY event it stands for. See Property events. In the same way,
Classic's $JOB:REVIEW is applied as $JOB:UNDERREVIEW, with the same fields.
How an event line is written
An event line is the event type, then the type's fields in a fixed order, each separated by a comma:
$TYPE:ACTION,<field 1>,<field 2>,…
| Rule | Detail |
|---|---|
| The order is the contract | Each value is read by its position, against that type's own field list. The syntax column in the catalog gives the order, with each field named by its label in the event form |
| Trailing fields can be left off | Optional fields at the end can be omitted, along with their commas. An optional field in the middle is left empty: $JOB:ADD,CURRENT,NIGHTLY_CORE,POST_ACH,,Region=East leaves Added Job's Frequency blank and sets Instance Properties |
| Too many values are refused | A value with no field to go into is refused (The event line carries 1 value(s) beyond the fields … defines) rather than dropped |
| A comma cannot be escaped | A comma inside a value starts the next field. The event form refuses one (commas aren't allowed here, the event uses commas to separate its fields) in every field except a last field that takes the rest of the line: Tags, which is a list, and the Message of $CONSOLE:DISPLAY. A Vision action is the exception: it sends its fields by name, not as a line, so commas you type are fine there. A comma that a property token brings into a field is a different matter — see An event raised from outside a job |
| Lists inside a field | Tags are separated by , or ;, so red;blue and red,blue both add two tags, and a tag whose own name holds a ; cannot be named in a tag event. Earlier builds read red;blue as one tag. Dates, Instance Properties and Schedule Properties are separated by ; — properties as Name=Value;Name2=Value2 |
| Property tokens | A field value can carry a [[…]] property token, resolved as the event is processed. A comma inside a token belongs to the token, not to the line. The built-in tokens are listed in System properties |
| Optional Y/N fields | Where a field offers (Default), Yes and No, leave it empty for the default, or write Y or N |
| Line length | An event line longer than 262,144 characters is refused before anything else reads it: The event line must be at most 262144 characters. Through the events API that is HTTP 400 |
Schedule Date is the date of the workflow instance the event acts on. It accepts CURRENT, a
signed day offset such as +1 or -1, or a date: MM/DD/YYYY (month first, also with -),
YYYY-MM-DD (also with / or .), DD-Mon-YY or DD-Mon-YYYY with an English month name,
YYYYMMDD, or a five-digit date serial — optionally followed by a time of day, which is ignored.
See A date field accepts a date with a time of day.
CURRENT and the offsets count from today's date in UTC. EARLIEST, LATEST and
SCHEDULE_DATE are refused: name the date instead.
Named Instance is the last field of most job and workflow events. Leave it empty when the
workflow has one instance for the date. When more than one instance of the workflow is built for
that date, name the one you mean, or (unnamed) for the run without an instance name: an event that
does not is refused as ambiguous rather than acting on whichever instance is newest. See
Schedule instances.
Classic XML syntax through the events API
An event sent to the events API can be written in Classic's XML syntax instead of the comma syntax. Continuum reads each element straight onto the event's field before anything else reads it, so the event is routed, permission-checked and applied exactly as the same event in the comma syntax would be. The XML itself is never stored or written to the event log. This event:
<EVENT><TYPE>JOB</TYPE><ACTION>HOLD</ACTION><SKDDATE>CURRENT</SKDDATE><SKDNAME>NIGHTLY_CORE</SKDNAME><JOBNAME>POST_ACH</JOBNAME></EVENT>
is applied as $JOB:HOLD,CURRENT,NIGHTLY_CORE,POST_ACH.
| About an XML event | How it works |
|---|---|
| Where it is accepted | The events API only. An event saved in the event form, and a line in a legacy agent's MSGIN file, use the comma syntax |
| Type and fields | <TYPE> and <ACTION> name the event type. Every other element is matched to its field by name, in any order, using Classic's element names: <SKDDATE>, <SKDNAME> and <JOBNAME> for a job event, for example. The event type sent with the request must be the one the XML names |
| Lists | A list is written with its Classic container: <PROPERTIES><PROPERTY>…</PROPERTY></PROPERTIES>, <TAGS><TAG>…</TAG></TAGS>, <DATES><CALDATE>…</CALDATE></DATES> and <ATTACHMENTS><ATTACH>…</ATTACH></ATTACHMENTS> |
| Commas and line breaks | A value can hold a comma or a line break — a message spread over several lines, say — because each element goes straight onto its field, as in Classic. A line break written as CR LF or CR is read as LF. The comma syntax cannot carry such a value. Earlier builds refused a line break, and a comma anywhere the comma syntax does not allow one |
| Fields left out | An element you leave out leaves its field empty, as in the comma syntax. Classic's N defaults for fields such as Reopen Schedule are not filled in |
| Credentials | <USERNAME> and <USERPWD> are ignored: the API request is already signed in |
| What is refused | An element the event type has no field for (<NAME> is not a field of $JOB:HOLD.), including Classic's <REASON> and <CURRSTATES>, and <APPLYEXCEPTIONS> on $JOB:ADDHLD; an element given twice; a missing <TYPE> or <ACTION>; a comma inside a list item, such as <TAG>a,b</TAG>, which would make two tags; a DOCTYPE, comments, attributes or nesting beyond the lists above; and an event longer than 65,536 characters. Classic drops an element it does not know; Continuum refuses the event and names it |
Support and Permissions
What each support status means
| Status | What happens to the event | The error | Through the API |
|---|---|---|---|
| Applied | Continuum carries it out and records what it changed under State Changes in the event log | — | Accepted |
| Not yet applied | Recorded, then failed, with nothing changed | <type> is not yet supported …, or for $MACHINE:MAXJOBS $MACHINE:MAXJOBS is not supported yet: Continuum does not enforce a per-machine job limit, so the limit cannot be applied. | HTTP 501, code EVENT_NOT_IMPLEMENTED |
| Not supported | Recorded as failed before any token is resolved or anything else is contacted, so nothing is half-done | <type> is not supported on this platform and will not be applied. Remove this event or replace it with a supported one. | HTTP 422, code EVENT_NOT_SUPPORTED |
A not supported refusal is permanent, so a producer stops retrying it; remove or replace the
event. A not yet applied type is one Continuum does not carry out in this release. Both appear
in the event log as FAILED — see
An event type can fail for two different reasons.
A type that is not in the catalog at all is refused with HTTP 400, Unknown event type: <type>.
An applied type can still fail on a particular event: a job that is not on the schedule for that date, a threshold that does not exist, an option Continuum does not offer. Those are noted against each type on the catalog tabs, Job Events to Notification and Console Events, and the event's error in the event log says which.
Permissions an event needs
Each event type needs one permission, named below as it appears in the role editor — the object type's row, then the action, for example Job Instances Execute. The permission is checked in the workspace of the object the event names (the workflow, the threshold, the property) and, for job and workflow instances, in the event's environment.
| Object type in the role editor | Role editor tab | Used by |
|---|---|---|
| Job Instances | Environments | The $JOB events. Adding a job ($JOB:ADD, $JOB:ADDHLD, $JOB:TRACK, $JOB:QUEUED) needs Create; a status change (hold, release, start, restart, skip, mark, cancel, kill) needs Execute; changing a job's settings needs Edit; $JOB:DELETE needs Delete |
| Workflow Instances | Environments | The $SCHEDULE events. Building ($SCHEDULE:BUILD, $SCHEDULE:BUILDHLD) needs Create; hold, release, start and cancel need Execute; $SCHEDULE:DELETE needs Delete |
| Workflows | Workspaces | The $JOBMASTER events, which change the workflow definition |
| Thresholds, Resources, Properties, Agents | Workspaces | Their own events |
| Calendars, Notifications | Global | $CALENDAR events; $NOTIFY:EMAIL |
When it is checked depends on where the event comes from. An event a workflow, a Self Service button, a Vision card or a notification carries is checked against the person who saves it, because it runs later under the platform's own identity. A Self Service request is checked again against the requester when it is submitted. An event sent to the API is checked against the caller, and a legacy agent's event line against the service account its credential belongs to. Some events are refused whatever the role holds. See What an event is refused for.
Property events also depend on the name: a $PROPERTY event on a workflow instance (SI.,
SSI.) needs Workflow Instances Edit, one on a job instance (JI., SJI.) needs
Job Instances Edit, and one on a machine property (MI.) needs Agents Edit under
All workspaces, for ADD, SET and DELETE alike.
Machine events name no workspace, so Agents Edit is checked without one.
$CONSOLE:DISPLAY and the eight not-supported $NOTIFY types need no permission: the first only
writes a message into the event log, and the others are refused before anything happens.
Job Events
The catalog
Each table lists the types in the order the event form shows them. Display name is the name the event form and the event log show.
Job events
$JOB events act on a job in a workflow instance that has already been built for the schedule
date — the same actions an operator takes on the Processes page. The job is
found by Schedule Date, Schedule Name and Job Name, ignoring case; a job that is not
there fails the event with Job instance not found.
A multi-instance job can be named by its bare name. Each instance of a multi-instance job is
named <Job>.<instance>, such as ACH File Arrival.Default. When no job carries the exact name
the event gives, the event acts on that job's Default instance, ignoring case — so
$JOB:RESTART,…,ACH Morning Post,ACH File Arrival restarts ACH File Arrival.Default. If the job
has no Default instance, the event fails with Job instance not found and lists the instance names
to use instead. A separate job literally named ACH File Arrival.Default is never picked this way.
Earlier builds failed an event that named a multi-instance job this way.
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Add Job | $JOB:ADD,<Schedule Date>,<Schedule Name>,<Job Name>,<Added Job's Frequency>,<Instance Properties>,<Reopen Schedule>,<Apply Exceptions>,<Named Instance> | Adds a job defined on the workflow to the workflow instance for that date. Added Job's Frequency names which of the added job's frequencies to use; it can be left empty only when that job has one frequency. Instance Properties are set on the new job instance. Adding to a Completed instance reopens it, whatever Reopen Schedule says; a Cancelled instance is refused. Apply Exceptions is not offered: set to Y, it fails the event | Applied | Job Instances Create |
| Add Job (Held) | $JOB:ADDHLD,<Schedule Date>,<Schedule Name>,<Job Name>,<Added Job's Frequency>,<Instance Properties>,<Reopen Schedule>,<Named Instance> | As Add Job, and the job is added on hold | Applied | Job Instances Create |
| Hold Job | $JOB:HOLD,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Puts the job On Hold, so it does not start until it is released | Applied | Job Instances Execute |
| Release Job | $JOB:RELEASE,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Releases a held job, so it runs when its dependencies are met | Applied | Job Instances Execute |
| Start Job | $JOB:START,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Starts the job now as Wait to Start (Forced), ignoring its dependency and resource checks. Refused when the agent or group the job runs on cannot take work | Applied | Job Instances Execute |
| Skip Job | $JOB:SKIP,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Marks the job Skipped, or Job to Be Skipped when it has to be finished later | Applied | Job Instances Execute |
| Mark Job Good | $JOB:GOOD,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Overrides the job's result with Marked Finished OK, so its dependents run as if it finished OK | Applied | Job Instances Execute |
| Mark Job Bad | $JOB:BAD,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Overrides the job's result with Marked Failed, so dependents that need it to succeed do not run | Applied | Job Instances Execute |
| Mark Job Fixed | $JOB:FIXED,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Marks a failed job Fixed | Applied | Job Instances Execute |
| Cancel Job | $JOB:CANCEL,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Ends the job as Cancelled | Applied | Job Instances Execute |
| Kill Job | $JOB:KILL,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Sets a running job to Running (To Be Terminated) and asks its agent to stop it. Only for a running job. Refused, with nothing changed, when the agent does not allow kills or its platform cannot kill jobs | Applied | Job Instances Execute |
| Delete Job | $JOB:DELETE,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Deletes the job from the workflow instance, and for a container job its nested workflows. Not allowed while the job is running | Applied | Job Instances Delete |
| Mark Under Review | $JOB:UNDERREVIEW,<Schedule Date>,<Schedule Name>,<Job Name>,<Named Instance> | Marks the job Under Review | Applied | Job Instances Execute |
| Restart Job | $JOB:RESTART,<Schedule Date>,<Schedule Name>,<Job Name>,<Force Restart>,<Restart Step>,<Named Instance> | Puts the job back to wait for its start time. Restart Step restarts a UNIX Command, SAP R/3 Job, SAP BW Process Chain, z/OS Batch Job or z/OS Started Task on one of the steps the job reported, as the Restart dialog does — see Restart on a step. A z/OS job takes a range, start|end such as STEP2|STEP4; left empty, the job restarts from the beginning. A step the restart refuses fails the event with the reason. Force Restart is not offered: set to Y, it fails the event | Applied | Job Instances Execute |
| Restart Job (Held) | $JOB:RESTARTHLD,<Schedule Date>,<Schedule Name>,<Job Name>,<Force Restart>,<Restart Step>,<Named Instance> | As Restart Job, and the job restarts On Hold | Applied | Job Instances Execute |
| Reschedule Job | $JOB:RESCHEDULE,<Schedule Date>,<Schedule Name>,<Job Name>,<Offset From>,<Minutes>,<Named Instance> | Offset From is T (Current Time), S (Job Start Time) or N (Job End Time) | Not yet applied | Job Instances Edit |
| Reschedule Job (Held) | $JOB:RESCHEDHLD,<Schedule Date>,<Schedule Name>,<Job Name>,<Offset From>,<Minutes>,<Named Instance> | As Reschedule Job, on hold | Not yet applied | Job Instances Edit |
| Change Machine Group | $JOB:MACHGRP,<Schedule Date>,<Schedule Name>,<Job Name>,<Machine Group>,<Named Instance> | — | Not yet applied | Job Instances Edit |
| Set Max Runtime | $JOB:MAXRUNTIME,<Schedule Date>,<Schedule Name>,<Job Name>,<Maximum Minutes>,<Named Instance> | Sets the job instance's maximum run time, in whole minutes | Applied | Job Instances Edit |
| Set Priority | $JOB:PRIORITY,<Schedule Date>,<Schedule Name>,<Job Name>,<SAM Priority>,<Named Instance> | Sets the job instance's priority, a whole number from 0 to 32767 | Applied | Job Instances Edit |
| Change Connection | $JOB:USER,<Schedule Date>,<Schedule Name>,<Job Name>,<Connection>,<Named Instance> | — | Not yet applied | Job Instances Edit |
| Add Tags | $JOB:TAGADD,<Schedule Date>,<Schedule Name>,<Job Name>,<Tags> | Adds one or more tags to the job instance | Applied | Job Instances Edit |
| Remove Tags | $JOB:TAGDEL,<Schedule Date>,<Schedule Name>,<Job Name>,<Tags> | Removes one or more tags from the job instance | Applied | Job Instances Edit |
| Track Job | $JOB:TRACK,<Schedule Date>,<Schedule Name>,<Job Name>,<Frequency Name>,<Tracking Data> | Agent only. Adds a job the agent saw start outside OpCon to the workflow instance, already started | Applied | Job Instances Create |
| Queue Job | $JOB:QUEUED,<Schedule Date>,<Schedule Name>,<Job Name>,<Frequency Name>,<Tracking Data> | Agent only. Adds a job the agent is holding to the workflow instance, to be released when its dependencies are met | Applied | Job Instances Create |
| Update Queued Job | $JOB:QUESTATE,<Schedule Date>,<Schedule Name>,<Job Name>,<Job Status>,<Tracking Data> | Agent only. Job Status I updates a queued job's description; any other value starts it now | Applied | Job Instances Execute |
Tags takes the rest of the line, so there is no position left for Named Instance on
$JOB:TAGADD and $JOB:TAGDEL. When more than one instance of the workflow is built for the date,
a tag event is refused as ambiguous rather than applied to one of them.
A $JOB:ADD or $JOB:ADDHLD for a multi-instance job adds every instance it applies to, and
reports one outcome per instance — see
Adding a multi-instance job from an event
and A $JOB:ADD event reports one outcome per instance.
Events only an agent raises
Track Job, Queue Job and Update Queued Job are how a z/OS agent reports a job it is tracking or holding, so that a z/OS Tracked Job or z/OS Queued Job on the workflow can run in step with it. Only an agent raises them, from its machine:
- the event form never offers them, on any surface, and a saved event of one of these types is refused, saying for example Track Job is raised only by an agent and can't be used here;
- one sent to the events API, or a retry of one an agent raised, is refused with … is raised only by an agent's LSAM, through MSGIN, and cannot be submitted or replayed by anything else. Nothing was changed.
Tracking Data is the agent's own reference for the job, and it has no Named Instance field:
when more than one instance of the workflow is built for the date, the event is refused. A blank
Schedule Date means today, and a blank Schedule Name means the workflow named AdHoc. What
each one does, and when it is refused, is in
Tracked and queued jobs.
Schedule and Definition Events
Schedule events
$SCHEDULE events act on a workflow instance — the workflow named by Schedule Name, for the
Schedule Date.
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Build Schedule | $SCHEDULE:BUILD,<Schedule Date>,<Schedule Name>,<Log File>,<Overwrite Existing>,<Schedule Properties>,<Named Instance> | Builds the workflow for the date. Overwrite Existing (Y or N, default N) replaces an instance already built. Schedule Properties are set on the instance. A blank Named Instance on a multi-instance workflow builds each of its instances. Log File has no effect. If nothing is built, the event fails and lists why for each instance | Applied | Workflow Instances Create |
| Build Schedule (Held) | $SCHEDULE:BUILDHLD,<Schedule Date>,<Schedule Name>,<Log File>,<Overwrite Existing>,<Schedule Properties>,<Named Instance> | As Build Schedule, and the instance is built on hold | Applied | Workflow Instances Create |
| Check Schedule | $SCHEDULE:CHECK,<Schedule Date>,<Schedule Name>,<Log File>,<Circular Dependency Check> | — | Not yet applied | Workflow Instances View |
| Check All Schedules | $SCHEDULE:CHECKALL,<Schedule Date>,<Log File>,<Circular Dependency Check> | — | Not yet applied | Workflow Instances View |
| Hold Schedule | $SCHEDULE:HOLD,<Schedule Date>,<Schedule Name>,<Named Instance> | Holds the workflow instance | Applied | Workflow Instances Execute |
| Release Schedule | $SCHEDULE:RELEASE,<Schedule Date>,<Schedule Name>,<Named Instance> | Releases a held workflow instance | Applied | Workflow Instances Execute |
| Start Schedule | $SCHEDULE:START,<Schedule Date>,<Schedule Name>,<Named Instance> | — | Not yet applied | Workflow Instances Execute |
| Cancel Schedule | $SCHEDULE:CANCEL,<Schedule Date>,<Schedule Name>,<Named Instance> | Cancels every job in the workflow instance that has not started: jobs On Hold and jobs still waiting, Job to Be Skipped included. Jobs already running keep running. The instance's own status is not set to Cancelled: it completes on its own once its last job ends. See What Cancel Schedule leaves alone | Applied | Workflow Instances Execute |
| Delete Schedule | $SCHEDULE:DELETE,<Schedule Date>,<Schedule Name>,<Log File>,<Named Instance> | — | Not yet applied | Workflow Instances Delete |
A workflow named in a build that does not exist fails the event with Workflow not
found …, naming the workflow. $SCHEDULE:CHECKALL names no workflow, so its permission is checked without a workspace.
What Cancel Schedule leaves alone
$SCHEDULE:CANCEL cancels the jobs that have not started, as Classic OpCon does, and leaves the
rest of the workflow instance to finish:
- Running jobs keep running. Their results are recorded as usual, and the instance completes when the last one ends. With nothing running, it completes as soon as the platform picks up the cancelled jobs.
- Jobs that have finished, or are finishing, are not changed, and nor are jobs Under Review. A job Under Review is not a final status, so it keeps the instance open until you resolve it.
- Nothing left to cancel is not an error. An event sent to an instance with no held or waiting jobs, or to one that has already finished, succeeds and changes nothing, so sending it twice is safe.
- A workflow still being built is refused.
- If a job cannot be cancelled, the others still are, and the event is recorded as failed. Sending it again cancels only what is still waiting.
Each job it cancels gets its own job history entry, as when you cancel a job yourself. Earlier builds set the instance to Cancelled and left its held and waiting jobs in their statuses, so they never ran and never ended.
Workflow definition events ($JOBMASTER)
These events change a job in the workflow definition, not a job in a workflow instance that is already built. The workflow is found by Schedule Name and the job by Job Name; either missing fails the event.
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Set Build State | $JOBMASTER:BUILDSTATE,<Schedule Name>,<Job Name>,<Frequency Name>,<Build State> | Sets the build state of one of the job's frequencies: On Hold, Released, Do Not Schedule, To Be Skipped or Disable Frequency. A frequency the job does not have fails the event | Applied | Workflows Edit |
| Add Master Tags | $JOBMASTER:TAGADD,<Schedule Name>,<Job Name>,<Frequency Name>,<Tags> | Adds tags to the job, or with a Frequency Name to that one frequency. Each tag must already exist; the event fails naming any that do not (Tag(s) not defined …) | Applied | Workflows Edit |
| Remove Master Tags | $JOBMASTER:TAGDEL,<Schedule Name>,<Job Name>,<Frequency Name>,<Tags> | Removes tags from the job, or with a Frequency Name from that one frequency | Applied | Workflows Edit |
Frequency Name decides whose tags the tag events change. Left empty, the event changes the job's
own tags, which apply on every frequency. Given a name, it changes the tags of that frequency only,
which apply to runs built under it — see Tags on a frequency. The name
matches exactly, case included, and a frequency the job does not have fails the event
(Frequency <name> not found on job <job>). Earlier builds refused a tag event that named a
frequency, saying Frequency-scoped job tags are not supported.
Threshold, Resource and Property Events
Threshold events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Set Threshold | $THRESHOLD:SET,<Threshold Name>,<Value> | Sets the threshold to Value: a whole number (100) sets it, and a signed one (+10, -5) adds to or subtracts from its current value | Applied | Thresholds Edit |
| Delete Threshold | $THRESHOLD:DEL,<Threshold Name> | Deletes the threshold. Fails while a workflow still refers to it | Applied | Thresholds Delete |
| Rename Threshold | $THRESHOLD:RENAME,<Current Name>,<New Name> | Renames the threshold | Applied | Thresholds Edit |
A threshold that does not exist fails the event with Threshold not found.
Resource events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Set Resource Max | $RESOURCE:SET,<Resource Name>,<Max Value> | Sets the resource's total to Max Value, a whole number of 0 or more | Applied | Resources Edit |
| Delete Resource | $RESOURCE:DEL,<Resource Name> | Deletes the resource. Fails while a workflow still refers to it | Applied | Resources Delete |
| Rename Resource | $RESOURCE:RENAME,<Current Name>,<New Name> | Renames the resource | Applied | Resources Edit |
A resource that does not exist fails the event with Resource not found. See Thresholds and resources.
Property events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Add Property | $PROPERTY:ADD,<Property Name>,<Initial Value> | Creates the property with that value, or sets the value if the property already exists | Applied | Properties Create, or Properties Edit when it already exists |
| Set Property | $PROPERTY:SET,<Property Name>,<Value> | Sets the value of a property that exists. Fails with Property not found if it does not | Applied | Properties Edit |
| Delete Property | $PROPERTY:DELETE,<Property Name> | Deletes the property | Applied | Properties Delete |
Property Name says where the property is. A plain NAME or OI.NAME is a global property.
SI., JI., SSI. and SJI. names write onto a workflow or job instance instead, and an MI.
name writes an agent's machine property:
MI.DISK_PCT.AIX53 on the agent AIX53, or, with the machine left blank, on the agent the
triggering job ran on or the machine that sent the line. A built-in property cannot be written
(System properties cannot be written). The full grammar, and what a write onto an instance
refuses, is in
Writing a property onto a running instance; the
rules for a machine property are in
Writing a machine property.
The older spellings still work. $TOKEN:ADD, $TOKEN:SET and $TOKEN:DELETE are applied
exactly as $PROPERTY:ADD, $PROPERTY:SET and $PROPERTY:DELETE: the same fields, the same rules
and the same permission. The event log records them under the $PROPERTY type, and a saved
configuration keeps the spelling it was written with.
Machine and Calendar Events
Machine events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Set Machine Status | $MACHINE:STATUS,<Machine Name>,<Status> | Sets the agent's operator mark. Status U (Up) clears any mark, D (Down) marks it Marked Offline, and L (Limited) marks it Marked Draining: running jobs finish and no new work is sent | Applied | Agents Edit |
| Set Machine Max Jobs | $MACHINE:MAXJOBS,<Machine Name>,<Max Jobs> | Continuum does not enforce a per-machine job limit, so the limit cannot be applied. The relay's own concurrent-job setting is what caps how many jobs run | Not yet applied | Agents Edit |
$MACHINE:STATUS is applied. It finds the machine by name, ignoring case and surrounding
spaces. A name no agent has fails the event with Machine not found, and a name more than one agent
has fails it with … matches 2 machines; rename them so the name identifies one machine. Setting
the status the agent already has changes nothing. Raised by a legacy agent, a $MACHINE line may
name only the machine that raised it — see
Which events are applied. The mark itself is
described in Taking an agent out of service.
Who the mark is recorded under. A $MACHINE:STATUS event a signed-in person sends, through a
Self Service button or the events API, records the mark under that person, in the agent's Set by
and in Audit History. One raised by a job, a workflow, a notification, a Vision trigger or a legacy
agent records it as System. The same rule applies to the job and workflow changes that $JOB
and $SCHEDULE events make. See
Who an event's change is recorded under.
Calendar events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Add Calendar Dates | $CALENDAR:ADD,<Calendar Name>,<Dates> | Adds the dates to the calendar. A date it already holds is left as it is | Applied | Calendars Edit |
| Delete Calendar Dates | $CALENDAR:DEL,<Calendar Name>,<Dates> | Removes the dates from the calendar. Fails if it would remove every date, because a calendar must keep at least one | Applied | Calendars Edit |
Dates is a ;-separated list, such as 01/15/2027;02/16/2027, in the date forms Schedule
Date accepts. A calendar that does not exist fails the event with Calendar not found. See
Calendars.
Notification and Console Events
Notification events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Send Email | $NOTIFY:EMAIL,<To>,<CC>,<BCC>,<Subject>,<Message>,<Attachments>,<Exclude Prefix Info> | Sends an email through the Email channel. To, CC and BCC are ;-separated addresses; Subject is up to 500 characters. Message may be left empty: the email is sent with an empty body. Attachments are not supported: any value there fails the event, and the email is not sent | Applied | Notifications Edit |
| Send Text Message | $NOTIFY:TEXTMSG,<To>,<Message>,<Exclude Notification ID> | — | Not supported | — |
| Send SNMP Trap | $NOTIFY:SNMP,<Severity>,<Event ID>,<Message>,<Exclude Notification ID> | — | Not supported | — |
| Run Command | $NOTIFY:COMMAND,<Command>,<Working Directory>,<Connection> | — | Not supported | — |
| Log Event | $NOTIFY:LOG,<Severity>,<Event ID>,<Message>,<Event Source>,<Exclude Prefix Info> | — | Not supported | — |
| Network Send | $NOTIFY:NETSEND,<Machine Name>,<Message>,<Exclude Prefix Info> | — | Not supported | — |
| SPO Alarm | $NOTIFY:SPOAL,<Alarm Text>,<Severity>,<Alarm ID>,<Alarm Qualifier>,<Exclude Notification ID> | — | Not supported | — |
| SPO Command | $NOTIFY:SPOCO,<SPO Instance>,<Command> | — | Not supported | — |
| Task Report | $NOTIFY:TASKS,<To>,<CC>,<BCC>,<Subject>,<Report Date> | — | Not supported | — |
The not-supported types are listed so that an event carried over from an earlier configuration is
recognised and refused by name. To run a command, use a job on an agent; to send mail, use
$NOTIFY:EMAIL. A text message is not available as an event. For how $NOTIFY:EMAIL is
delivered, see Sending mail with $NOTIFY:EMAIL.
Console events
| Display name | Syntax | What it does | Status | Permission |
|---|---|---|---|---|
| Display Message | $CONSOLE:DISPLAY,<Message> | Records the message. The event completes and the message is visible in the event log; nothing else happens. Message takes the rest of the line, commas you type included, up to 2,000 characters. A comma that a property token brings into the message is refused, because Classic OpCon fails a console message with any comma | Applied | None |
Troubleshooting
| Symptom | Likely cause | What to do |
|---|---|---|
| An event type is greyed out in the picker, marked Not yet available | It is one of the nine types Continuum does not yet apply | Use another way to get the same result; see the catalog |
| An event type you used before is not in the picker at all | It is one of the eight not-supported $NOTIFY types | Replace it — mail with $NOTIFY:EMAIL, a command with a job |
The event is FAILED saying the type is not yet supported | A not-yet-applied type, stored before the picker refused it or sent through the API | Remove or replace the event. Raising it again fails the same way |
The event is FAILED saying an option is not supported | $JOB:ADD with Apply Exceptions set to Y, or a $JOB:RESTART with Force Restart set to Y | Clear the option |
A $JOB:ADD is FAILED saying the job has multiple frequencies and naming them | Added Job's Frequency is empty, and the job being added has more than one frequency | Fill in Added Job's Frequency with one of the frequencies the message lists |
A $JOB:ADD is FAILED saying it cannot add a job to a Cancelled workflow instance | The instance for that date was cancelled. Only a Completed instance is reopened by an add | Build a new instance for the date, or add the job to another one |
A $JOB:RESTART is FAILED with Cannot restart on a step: … | The Restart Step is not one the job reported, or the job's type cannot restart on a step | Use a step from the job's Restart Step list, or leave the field empty — see Restart on a step |
| The event fails as ambiguous | More than one instance of the workflow is built for the date | Fill in Named Instance |
| A tag event fails as ambiguous | As above, and the tag events have no Named Instance field | Make sure one instance holds the job for that date, or tag it on the Processes page |
A $JOBMASTER:TAGADD fails naming tags | The tags do not exist yet | Create the tags first |
A $NOTIFY:EMAIL fails naming Attachments | The field has a value — often because a comma in the message pushed text into it | Clear Attachments, and keep commas out of the message |
A $PROPERTY event with an MI. name fails with Machine not found or … matches <n> machines | No agent, or more than one, has the name in the machine part | Correct the name, or rename the agents so the name identifies one |
A $PROPERTY event with an MI. name fails with Cannot default machine name | The machine part is blank, and the event has no job that ran on an agent, or the job's agent could not be identified | Name the agent: MI.<name>.<agent>. See Writing a machine property |
| A value lands in the wrong field | A comma inside a value | Remove the comma, or carry the value in a property token |
An event is FAILED saying a value or a name substituted into a field contains , or ; | A property token resolved to a value holding a separator the field cannot carry — a name in Tags, or a comma in a $CONSOLE:DISPLAY Message | See An event raised from outside a job. Keep the separator out of the value, or type the text into the event |
| An event is refused with The event line must be at most 262144 characters. | The line is longer than the limit | Shorten the line, or split the work across several events |
A $THRESHOLD:DEL or $RESOURCE:DEL fails | A workflow still refers to it | Remove the reference first |
| A save or a submission is refused for permission | Your role does not hold the permission the event type needs in that workspace | See Permissions an event needs |
Related topics
- Workflow events — when a job or workflow fires an event
- Event log — what happened to each event
- Events raised by a legacy agent — event lines from a machine's MSGIN directory
- Service requests — events from a Self Service button
- Notifications (groups, triggers, channels) — the OpCon Event action
- Properties — property tokens in event fields
- System properties — the built-in tokens an event can carry
- Roles and permissions — the permissions on the Support and Permissions tab