Skip to main content

Properties

In briefA property is a named value that jobs read at run time through a token such as [[OI.Region]], so one workflow can run against different paths, environments or dates without being rebuilt. Properties belong to a workspace and can be encrypted to hold secrets.

WhereDesign › Toolkit › the Properties tab. New Property opens the editor dialog; a row's menu has Edit (or View) and Delete.

When

  • A value — a path, an environment name, a threshold for a script — is reused across jobs, or changes between environments.
  • A job needs a credential: keep it in an encrypted property rather than in a job parameter.

To find, filter or group related jobs, use a tag instead.

For a value a job computes as it runs, use an expression or write it onto the run with a $PROPERTY event instead.

How

  1. On the Properties tab, select New Property, give it a name and a value, switch Encrypted on for a secret, and save.
  2. Reference it from a job parameter as [[Name]] or [[OI.Name]].

The full steps are on Manage properties, calendars, and tags.

Notes
  • A token that does not resolve fails a job parameter at dispatch, but an event a job fires and a notification still go out with that token left unresolved and the other tokens filled in. An event submitted from outside a job fails instead, and so does an event that would create a property whose name holds an unresolved token.
  • [[MI.Name]] reads a machine property of the job's agent, and [[MI.Name.AGENT01]] another agent's. A $PROPERTY event with an MI. name writes one.
  • [[SSI.…]] and [[SJI.…]] read the parent workflow and the container job of a sub-workflow, in a job parameter or an expression dependency.
  • A value can hold any text, including a URL.
  • An empty value is a real, unset value that resolves to the empty string. To empty an encrypted property, use Clear stored value.
  • Names beginning with $ belong to the platform. Date and time tokens take a format and an offset, as in $SCHEDULE DATE mm/dd/yy(-1dd).
  • An event's schedule date and calendar dates ignore a time of day after the date, so [[$NOW]] works there.
Watch out
  • Properties have no Cross Reference, and their Delete runs no reference check. Confirm a property is unused before you remove it.
  • Don't create two properties whose names differ only in case: a token naming either one fails.
  • An encrypted value is never returned or exported. Turning Encrypted off needs a new value, and an overwriting import that would land an empty value on an encrypted property is refused.
  • A token that brings a comma into an event field fails the event, except a tag list in Tags. A name that brings a , or ; into Tags fails it too, and a $CONSOLE:DISPLAY message keeps only the commas you type.