Custom fields
- Synopsis
- Full Details
In briefCustom fields are your own metadata fields for jobs. An administrator defines each field once for the whole organization — its name, input type, default and whether it is required — and its value is then set job by job in the job editor.
WhereAdministration › Custom Fields for the definitions; New Custom Field adds one. Values are set in the Custom Fields section of the job editor, in both the Workflow View and the Process View.
When
- You want every job to carry information Continuum has no field for, such as an owner or a cost centre.
- You want a value to be mandatory on every job definition.
- You need to correct a custom-field value on a run that is already under way.
How
- Open Administration › Custom Fields and select New Custom Field.
- Give it a Name and an Input Type; for Select, enter its Options.
- Set Required field, Default Value and Display Order as needed, and save.
- Set each job's value in the job editor's Custom Fields section. The full walkthrough is Manage custom fields.
- Custom fields apply to jobs only today.
- A Default Value is written onto every job that has no value for the field when its workflow is saved or imported, and the Workflow View job editor names it in a hint under the empty field. A field you clear stays empty.
- Required field is enforced when you save a new job or clear the value, and a usable default satisfies it. Jobs saved before a field became required still save without it. On a built job instance it is enforced only for a field the instance was built with.
- Push Changes to Workflow carries custom fields field by field, so a field the instance never had keeps its workflow value.
- A save or import that removes a value for a deleted or unknown field says so: the workflow editor shows a warning after the commit, and the API response carries a removedCustomFields list.
- A job instance that holds a value for a deleted field can still be edited while that value is sent back unchanged.
- A Select field cannot be saved without at least one option.
- A default that does not fit its Input Type, or a Select default that is not one of its options, is refused when you save the field.
- Changing a field's type or options leaves job values that no longer fit in place. A workflow still saves while those values are untouched; changing one to another value that does not fit is refused.
- The Process View job editor lists only the first 100 definitions, so a set larger than that is not fully shown on a built job instance.
Task walkthrough: Manage custom fields. This page is the full configuration and troubleshooting reference.
Custom fields let an administrator add their own metadata fields. Definitions are tenant-global, and today they apply to jobs.
Definition fields
Definitions are managed under Administration › Custom Fields. The list shows Name, Input Type, Required and Order; New Custom Field opens the form below.
Deleting several fields at once acts only on the rows the list shows: changing the Input Type filter clears the selection. When a field cannot be deleted, the dialog stays open and names it with the reason, and only the fields that failed stay selected. Earlier builds closed the dialog and cleared the selection, and could name the field by its identifier.
| Field | Notes |
|---|---|
| Name | Required, up to 100 characters, and unique in your organization. |
| Input Type | One of Text, Number, Boolean, Select, Date, Textarea. |
| Required field | Whether a value is required. Off by default. |
| Default Value | Optional. A job that has no value for the field is given this one when its workflow is saved or imported — see How a default reaches a job. The input matches the Input Type: an On / Off choice for Boolean, a date picker for Date, a number for Number, and a choice from the field's Options for Select. A default that does not fit is refused when you save the field. |
| Options | The choices. Shown, and required, only for Select; not saved for any other type. |
| Description | Optional, up to 500 characters. |
| Display Order | Controls ordering in the UI: lower numbers first, then by name. Defaults to 0. |
Where values are set
A definition creates a field; the value is set per job, in the job editor's Custom Fields section. That section appears in both job editors:
| Where | What you are editing | Required fields |
|---|---|---|
| The Workflow View job editor, in the workflow editor | The job definition — every future build reads it | Enforced in the job editor, and on a workflow save for a new job or a job whose value the save clears. A job saved before the field became required still saves without it — see A field that changes after jobs use it. |
| The Process View job editor, on a built job instance | That instance only — see Editing a job on a running instance | Enforced only for a field the instance was built with: clearing its value is refused. A field marked required after the build is not enforced. |
Earlier builds showed the section in the Workflow View only, so a job's custom fields were invisible on the Process View and could not be corrected on a run that was already going.
A job instance with a Boolean or Number custom field can be edited. The Process View job editor sends every custom field on each save, and earlier builds refused any value that was not text, so such an instance could not be edited at all. Each value is still checked against its field's Input Type.
Why an instance save is not held to a field marked required later. The instance's custom-field values are fixed when the workflow is built, so a field you marked required after that build has no value on the instance to check. Enforcing it there would refuse an unrelated edit on a run the platform is perfectly willing to accept. A field the instance was built with is still checked: you cannot clear a required value on the instance.
Push Changes to Workflow carries custom fields, and carries them field by field rather than replacing the whole set — so a definition added since the build keeps the value it has on the workflow, instead of being wiped by an instance that never had a value for it. Clearing a field on the instance and pushing does clear it on the definition: that is an edit you made, and it travels. Clearing a required field this way is refused when the workflow is saved.
How a default reaches a job
A field's Default Value is written onto the job itself, so it travels with the workflow into every build and is on the job instance at run time. It is applied when a workflow is saved — created or updated — and when it is imported (see Automation export and import).
| The job's value for the field | What a save or import does |
|---|---|
| None — the job has never had a value for it | Gives it the default. |
| Cleared by you in the job editor | Keeps it empty. Clearing a field is an edit, and the default does not undo it. |
| A value that fits the field | Keeps it, even when it differs from the default. |
| A value that does not fit, which this save sets or changes | Refuses the save or import. The message names the job, the field and the value: Job 'Job-1' has an invalid value '5' for custom field 'Priority': …. Pick a new value in the job editor and save again. |
| A value that no longer fits — for example, after the field's Input Type or a Select field's Options changed — which this save leaves as it was | Keeps it. The save goes through. See A field that changes after jobs use it. |
| A value for a field whose definition has been deleted | Removes it, whichever save it is. The job editor has no control for a deleted field, so this value could never be cleared by hand. |
| A value for a field that does not exist | Keeps it when the job already held that same value; otherwise removes it. |
An import is checked the same way as a save, including required fields, and is all or nothing: when any workflow in the bundle is refused, nothing is imported, and the message names each workflow.
A save tells you which values it removed
A save or import never removes a custom-field value without saying so. When a save removes a value because its field was deleted, or because no field here has that identity:
- In the workflow editor, the confirmation after you commit turns into a warning: Changes are committed to a version. Removed values for custom fields that no longer exist: Extract: Cost Center. It lists each job with the fields removed from it, up to five jobs and then a count of the rest. A field that no longer exists shows its name; one that never existed here shows its identifier.
- Through the API, the response to a workflow create or update carries a removedCustomFields list — the job, the field identifier, and the field name when the field was deleted. An import's response carries the same list with the workflow's name on each entry. The list is absent when nothing was removed.
If the registry of custom fields changes while a save or a job instance edit is reading it, the request is refused with Custom field definitions changed while they were being read. Try again. (a 503) instead of dropping a value it could not match. Retry the request.
Editing a job instance that holds a removed field
A job instance built while a field existed keeps that field's value after the field is deleted. The instance can still be edited: a value sent back unchanged is not checked, as in a workflow save. A new or changed value for a field that is deleted is refused, naming it (Custom field 'Cost Center' has been deleted); for a field that never existed, the message is Unknown custom field ID followed by the identifier.
A field that changes after jobs use it
A save checks only the custom-field values it sets or changes. A value is compared with what the same job held in the workflow's current version; one that is unchanged is not checked again. So changing or deleting a field never leaves workflows that can no longer be saved:
| You change the field | Jobs that already hold a value | A job whose value a save sets or changes |
|---|---|---|
| Delete it | Every save removes the value | — |
| Remove a Select option, or change the Input Type | Keep the value, and the save goes through | Refused if the new value does not fit |
| Mark it Required field | Saved without a value, as before | A new job, or a job whose value you clear, is refused without one |
A copied job or workflow, and an import, are new jobs, so every value they carry is checked. Restoring an older version of a workflow is checked against the current one: a value that differs from the current version and no longer fits is refused, naming the job and the field.
In the job editor, a value that no longer fits is flagged on the field — This value is no longer allowed: '…'. Clear it or pick another. — so you can see it and correct it. The flag does not stop you applying the job.
Earlier builds re-checked every value on every save, so deleting fields, removing a Select option a job held, or marking a field required could leave a workflow that could never be saved again, including by an event or a push from a running instance.
In the Workflow View job editor, a field the job has no value for is shown empty, with a hint under it naming the default that the save will apply — Default: Augusta, applied when you save (a Boolean default reads On or Off). A required field with a usable default counts as filled in: neither the editor nor the save refuses it. The Process View job editor does not show defaults; a built instance carries what its workflow had when it was built.
A default is used only when it fits the field:
| Input Type | A default that is used |
|---|---|
| Text, Textarea | Any text that is not blank |
| Number | A number, such as 1 or 2.5 |
| Boolean | true or false, in any case |
| Date | A real date written YYYY-MM-DD, such as 2026-12-31 |
| Select | One of the field's Options, exactly as written |
A default that does not fit — abc on a Number field, or a Select default that is not one
of its options — is refused when you save the field: defaultValue 'abc' must be a number. The
check runs when you create a field and whenever you change its Input Type, Options or
Default Value. On the field's page, changing the Input Type, or removing the option a
Select default names, clears a default that no longer fits. A default saved before this check
existed and that does not fit is still ignored: jobs are given no value, and a required field
with such a default is reported as missing.
Defaults apply from a workflow's next save. Adding a default does not change jobs in workflows nobody saves, and changing a default later does not change jobs that already hold a value.
- Custom fields currently apply to jobs. The model is extensible to other object types, but there is no per-object-type assignment in the UI today, so custom fields are not yet available on other objects.
- A Select field needs Options; an empty options list isn't valid.
- Values are typed: a Number field holds a number, a Boolean field true or false, a
Date field a date written
YYYY-MM-DD, and the other input types text. A workflow save is refused when it sets or changes a value that does not fit its field — see A field that changes after jobs use it. - When a workflow save is refused for a missing required value, the message names the job, not just the field: Job 'Nightly ACH' is missing required custom field 'Cost Center'.
- The Workflow View job editor lists every definition, so any value a save refuses can be fixed there. The Process View job editor still lists only the first 100, so on a built job instance a tenant with more than 100 custom fields will not see them all. Keep the set to what you use.