Workflows

See the config-artifact guide for how to add, register, and deploy workflows. This page covers how to name them.

Workflow file & display names

Workflow template files are always lower_snake_case.

Workflow display names should avoid special characters. Write them in a friendly way, with spaces.

Prefixes

Use a small, agreed set of prefixes to distinguish who or what invokes a workflow:

Prefix	Use	File	Display name
(none)	User-invokable workflows	engineering_release.xml	Engineering release
ADMIN	Admin workflows, hidden from general users	admin_set_status_50.xml	ADMIN Set status 50
sys	System-invoked workflows (e.g. via an integration or as a sub-workflow)	sys_invoke_some_utility.xml	sys_invoke_some_utility

Display names for system workflows are lower_snake_case (unlike admin and user workflows, which use friendly, spaced names).

Caution

Avoid a SUB prefix for sub-workflows. As soon as a sub-workflow is also invoked by something else like an AIG integration, Mendix, and so on, the SUB prefix becomes ambiguous.