Administration Guide

Manage Workflow Items

On this page

This page explains how to edit workflow items, manage their processes, enable or disable them, copy or delete them, and find them by number or text. It also covers conditions, Step Action groups, Reopen actions, and recurrent variants. For what actions and triggers are, see Workflow Overview.

In the Settings App

Where items are listed

A class's workflow tree opens from the class's Workflow node, under the class's business area. For Stock Rooms, the Workflow node opens the toolbar actions editor instead.

Under each object class, the workflow tree shows the Actions, Triggers, and Components folders, in this order.

  • Actions holds the Create Actions (not for Approval Stages), the Step Actions, the class's Service Actions where it has any and, for Project Tasks only, Built-in UI Actions.
  • Triggers holds On Condition, On Created/Modified, and On Deleted.
  • Components holds Templates, Forms, Functions, E-mail Notifications, and Push Notifications, in that order.

The Global Workflow object has only the Functions and E-mail Notifications leaves and no Components node.

Rules shared by item windows

  • A new item is placed last in its node's order, is enabled, is not a system item, and is available to any role. Under Service Actions, which lists several kinds, a new service action is instead placed last among the service actions of its own kind, such as Create Action for Mail Connector. Until you reorder them, actions therefore appear in the order they were created.
  • A new Trigger on Created/Modified starts set to run when an object is created.
  • A new item gets the next number from a shared counter.
  • The window of an action or a trigger is titled "[<ID>] <Name>", and the window of a template, form, or function "[<Name>]". Other windows show their own caption. While a window holds unsaved changes, its title starts with "* ".
  • The header line of a window reads "<object> <kind>: <ID>", where the kind is, for example, "Create Action", "Step Action", "Trigger on Create/Modify", "Trigger on Delete", or "Create Action for <connector>". Templates, forms, and push notifications show no ID there.
  • In the Step Action and Create Action windows, Name must not be blank. A save with an empty name is refused with "The "Name" field is mandatory, it can't be left blank." and the window returns to the General tab. Caption is marked as mandatory, but an empty caption is replaced by the name when the item is saved, and clicking into a caption that was never set fills in the name. The service action window fills the caption the same way.

Add an item to processes

A process is a named group of Actions and Triggers. Any Action or Trigger can belong to any number of processes. Membership only changes how you can list and bulk-edit items; it does not change what an item does or when it runs. Forms, templates, and functions have no Processes tab.

  1. Open the Create Action, Step Action, or trigger, and go to its Processes tab. The tab shows how many processes the item belongs to.
  2. Use Add to add the item to a process (Select Process picks several at once), and Remove to take the item out of a process.

Manage processes

Processes are managed under Workflow and Business Logic > Advanced > Processes, where the Process List node shows a grid of Name, Description, and Item Count, sorted by rank and then by name.

  • New (Ins), Edit (Enter or a double-click), and Delete (Del) manage the list.
  • Move Up and Move Down change a process's rank and save at once. They are unavailable while a quick filter is on. The order you set is the order every process drop-down shows.
  • A process name must be unique, both for a new process and when you rename one. A new process is ranked after all existing ones.

Select a process to see its Actions and Triggers:

  • Open opens the item's own editor.
  • New offers five submenus, Create Action, Step Action, Trigger on Condition, Trigger on Create/Modify, and Trigger on Delete, each listing the same object classes. The item you create is already a member of the process.
  • Remove removes only the item's membership in the process; the item itself stays. When you remove several items and one of them fails, for example for lack of the delete right, an error for that item offers Yes, Yes to All, and No to continue, and a summary of how many items were removed follows.
  • Enable and Disable switch all selected items at once.

To delete a process, select it and click Delete, then confirm "Are you sure you want to delete the selected item?". The process and its memberships are deleted; the Actions and Triggers that belonged to it are not. When other records still refer to the process, the delete fails with the message "Cannot delete the process <name> because it contains one or more configuration parameters."

Enable and disable items

In a class's workflow tree, Enable and Disable are on the right-click menu of the item lists other than Built-in UI Actions; the lists of components do not have them. A process's item pane has them too. They switch all selected items at once, and a disabled item keeps its place in the list.

Copy an item

Copy Item on the toolbar of a class's workflow tree copies the selected item at once and opens the copy in its own window.

  • The copy gets a new number and is never a system item. Its name is the original's name followed by " - Copy", then " - Copy (2)" and so on, shortened to the maximum name length.
  • A form, template, or function that the original owns privately is duplicated; a shared one is not, and the copy uses the same one. An icon is always duplicated, even one that other items use, unless the item has no icon.
  • The copy also takes the original's role grants, process memberships, and service field mappings and, for an On-Condition trigger or a scheduled task, its Automation Server job, with the last run date and status cleared.

One Step Action of the Service Catalog Items class cannot be copied; for it, Copy Item shows "This is a system record and it cannot be copied." In a new 2026.1 database created with the Default Workflow (see Default Workflow Configuration), that Step Action is Submit Request. An upgraded database need not have this content, and an administrator may have changed the configuration.

Delete an item

Delete on the toolbar of a class's workflow tree deletes the selected item.

  • When any item being deleted is a system item, the delete is refused.
  • An Action that a Request Fulfillment refers to cannot be deleted.
  • Otherwise the item is deleted together with its role grants, process memberships, trigger history, workflow log rows, parameter bindings, service field mappings, and toolbar bindings. The forms, templates, and functions that the item owned privately are deleted too, and so is its icon unless it is the shared default icon. A shared form, template, or function is kept.

Delete a form, template, or function

A form, a template, or a function that anything still refers to cannot be deleted. The delete stops with the message "Unable to delete <kind and name> because one or more workflow items refer to it. Remove dependencies first.", and the object's editor opens on its Usage tab, or its Callers tab for a function, which lists what refers to it. A system record is refused before this check.

Go to an item by its number

Go To... opens a workflow item, an e-mail notification, or a function by the number its window shows. The three share one number space.

  1. On the Search menu, click Go To..., or press Ctrl+G.
  2. In the Go To dialog, enter the number in Workflow Item #:. The field accepts digits only. Its drop-down lists the numbers you opened before, newest first, up to twenty.

When the number is found, the tree selects the object class and workflow branch the item belongs to, and the item's window opens. A number also finds a Stock Room toolbar action. When nothing has the number, the message "Workflow Item # <number> was not found." appears and the dialog opens again. When the item belongs to a class you may not view, the no-rights message appears instead.

Search the workflow for text

The Search menu also holds these commands:

  • Find... (Ctrl+F) and Find Next (F3) search the text of the program you are editing.
  • Search in Workflow opens a separate window with an empty search box. The text you type is matched as plain text: the characters [, %, _, and ~ have no special meaning.

The Search in Workflow window lists one row for each use, with the object, the item kind, the item name, the placement, and the placement details, sorted by those columns in that order. Open reopens the item that holds the text on the tab its placement names (criteria, programming, parameters, notification, form, form validation, template, or field mapping) and, where the placement identifies one row, selects that row.

Set an item's condition

The item-condition dialog is shared by the item kinds. Only the scheduled Trigger on Condition (the On-Condition trigger) requires a condition. For every other kind, the condition is optional: Step Action, Create Action, the Created/Modified triggers, the Delete trigger, and the Trigger on Condition that runs after the object has been saved.

The two kinds labeled Trigger on Condition are authored in one dialog. Its first choice, a schedule or After the object has been saved, decides the kind: a scheduled trigger runs on the Automation Server's schedule over every object that matches its condition, and the other runs while the object is saved, after it has been written.

The condition vocabulary depends on the kind:

Item kind Vocabulary
Create Actions create context
Step Actions update context
Created/Modified triggers trigger context
Delete trigger delete context
On-Condition trigger timer context

An On-Condition trigger never acts on an object in one of its class's inactive statuses, such as Closed, Retired, or Inactive, whatever its condition says.

Arrange Step Actions into groups

Step Actions can be arranged into named Action Bar/Toolbar groups in their Display Order dialog, which also sets their order. In this dialog, a group is a bold row, and the actions under it are indented. On the Actions folder, Order... opens a Display Order dialog that offers groups too.

  1. In the class's workflow tree, select Step Actions and click Display Order....
  2. Select the row above which the group should start, and click New Group... on the toolbar or the right-click menu. The command is offered only when neither the selected row nor the row before it is a group.
  3. At the Group name: prompt, enter a name (the prompt offers "New group") and click OK. The group is inserted above the selected row.
  4. Move actions and groups with Move Up and Move Down, with Ctrl+Up and Ctrl+Down, or by dragging. The keys and dragging move several selected rows at once.
  5. To rename a group, select its row and click Rename Group.... To delete a group, select its row, click Delete Group, and confirm "Delete the group?". Both commands are available only on a group row. Deleting removes only the group row; its actions stay in place under the group above them.
  6. Click OK to save the arrangement.

A group name must be unique. New Group... and Rename Group... refuse a name that another group has with "Another group with this name already exists. Enter a different name."; for a new group, you are asked for a name again. Saving is refused with "The group '<name>' should contain at least one action." when a group is the last row or is followed directly by another group.

Reopen Actions

A Reopen Action's status list is computed, not authored. For a Reopen action, the status check list on the Condition tab of the Step Action window is filled only with the class's closed and inactive statuses and is disabled, so you cannot change it. A Reopen Action is offered exactly on inactive objects.

On Computers, a Reopen Action is also checked against the licensed number of nodes and is refused when reopening would exceed it. Among workflow items, this is the only place where a license limit blocks an action.

Recurrent variants on tickets

On a ticket class other than Service Request, the Create Action window shows the Available for panel, where the Create Action can be made a recurrent variant. A recurrent variant cannot use the class's full form. If recurring tickets already exist for the Create Action, switching it back to Regular Tickets only asks for confirmation, and the switch is reverted if you decline.