Skip to main content

Events

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

  1. Choose the Event Type in the event form; disabled types are not yet applied.
  2. Fill in the type's fields; leave optional trailing fields empty.
  3. Fill in Named Instance when more than one instance of the workflow is built for the date.
  4. Check the line under Generated Event:, then save.

The full steps are in Run events on job outcomes.

Notes
  • 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 $PROPERTY event with an MI. name writes an agent's machine property, and needs Agents Edit under All workspaces.
  • $TOKEN:ADD, SET and DELETE are applied as the matching $PROPERTY event, and $JOB:REVIEW as $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.
Watch out
  • A comma inside a value cannot be escaped and shifts every later field.
  • $SCHEDULE:CANCEL cancels 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.