Tags
- Synopsis
- Full Details
In briefA tag is a global label you put on jobs so you can group, filter and search them. A job holds each tag by its identity, so renaming a tag keeps it on every job that carries it.
WhereDesign › Toolkit › the Tags tab. New Tag opens the editor dialog; a row's menu has Edit (or View), Cross Reference and Delete. A job's Tags field in the workflow job editor can also create a tag.
When
- You want to find, filter or group related jobs.
To give a job a value it reads at run time, use a property instead.
How
- On the Tags tab, select New Tag, give it a Name, and save — pressing Enter in the dialog saves too, once.
- Add it to jobs from their Tags field. You can also create a tag there.
The full steps are on Manage properties, calendars, and tags.
- A tag name is 3–255 characters and unique, following the platform naming rules.
- A job's frequency can carry its own tags, which runs built under that frequency add to the job's.
- Typing a new name in a job's Tags field offers
+ Create tag '<name>'if you hold Tags Create, which is tenant-wide.
- A reference to a deleted tag does not block a workflow save, but an import refuses a bundle whose tag reference names a deleted tag.
- A workflow last saved before tags were held by identity may not be listed against its tags in Cross Reference until it is saved again.
Task walkthrough: Manage properties, calendars, and tags. This page is the full configuration and troubleshooting reference.
A tag is a label for organizing and finding jobs (and other objects). Where a property carries a value a job reads at run time, a tag carries a label you group and search by. Tags are global: every workspace shares them.
Where tags are managed
Tags live in the Toolkit, on the Tags tab, and are created, edited and viewed in one dialog over the list. Tags have a Cross Reference action, and it lists the jobs carrying the tag.
Tag fields
| Field | Notes |
|---|---|
| Name | Unique tag name. 3–255 characters, following the platform naming rules. |
| Description | Optional. |
- Tags are global (shared across workspaces). A job carries a list of tag references, each holding the tag's identity with its name beside it.
- Tags drive filtering and search; a cross-reference view shows which jobs use a given tag. It is the one place a tag's uses are listed: the Tags report has no references column — see Tags: no References column.
How a job holds on to its tags
Every workflow save checks each tag reference. A renamed tag is still the one the job carries, and the stored name is refreshed. You do not need the save to see the new name: the job's Tags field shows it as soon as you open the workflow, and exports carry it. An identity that names no tag in your tenant — one carried in from another environment, for instance — is pointed at the tag here that has the stored name. A tag is optional on a job, so a reference to a deleted tag never blocks the save: it is left as stored, and it is never swapped for a new tag created under the same name. An import is stricter, and refuses a bundle whose tag reference names a deleted tag. Cross Reference and the delete check match by the stored identity, so a workflow last saved before tags were held by identity may not be listed against its tags until it is saved again. See Renaming or replacing an object a workflow uses.
Tags on a frequency
A job's frequency can carry tags of its own. In the workflow job editor, the Frequencies tab has a Frequency Tags section for the frequency you select — Select tags for this frequency — that works like the job's Tags field, creating a tag included. The tags apply only to runs of the job built under that frequency:
- A built job carries both lists. A job built for a date, or added to a run, under a frequency gets the job's own tags followed by that frequency's, each tag once. A job instance has one merged list, so its Frequencies tab shows no Frequency Tags section: edit the instance's Tags field instead.
- Notifications match on both. A Job notification group member chosen by Tag matches a job whose own tags, or the tags of the frequency its run was built under, include the tag.
- Push Changes keeps them apart. Pushing a job instance's changes back to the workflow does not turn a tag that only its frequency carried into a tag on the job.
- A frequency's tags count as uses. Cross Reference lists a job whose frequency carries the tag, and the tag cannot be deleted while one does.
- Events can edit them.
$JOBMASTER:TAGADDand$JOBMASTER:TAGDELwith a Frequency Name add or remove that frequency's tags.
Creating a tag from a job
A job's Tags field in the workflow job editor creates tags as well as selecting them. Type a name
that matches no existing tag — the match ignores case — and + Create tag '<name>' is offered as
the first row in the list. Choosing it creates the tag and applies it to the job in one step, so a
tag you realise you need does not send you out to Toolkit → Tags and back.
A job's tag must name a tag that exists, which is why the tag is created first and added to the job only once it does. A name that the tag naming rules refuse is reported under the field, and the job keeps the tags it already had.
The create row appears only if you hold Tags Create. Tags are a global-scope object type, so the permission is tenant-wide — it is not narrowed to the workspace the job lives in. Without it the field selects from the existing catalog and says Select tags; with it, the placeholder reads Select or type tag name.
Related topics
- Properties — named values a job reads at run time
- Object naming — the naming rules a tag name follows
- Global search — finding jobs and other objects