Actions
On this page
- In the Settings App
- Find a class's actions
- Create or edit a Step Action
- Choose where a Step Action appears
- Group and order Step Actions
- Decide when a Step Action is offered
- Configure the embedded Step Action of Project Tasks
- Create or edit a Create Action
- Bind a form to an action
- Restrict an action to roles
- Set an action's icon
- Copy, enable, disable, or delete an action
- Add an action to a process
- What technicians see in the Web App
- What technicians see in the Mobile App
- Related topics
An action is a workflow item that a user runs. There are two kinds:
- A Step Action acts on an object that already exists. A technician sees it as a button on a ticket.
- A Create Action creates an object through a form. Every Create Action carries a data template, and the template's values are applied when the object is created.
For other workflow item types, see Workflow Overview. You author actions for each class in the Settings App; see Admin Center and Settings App. Technicians run actions in the Web App and Create Actions in the Mobile App; see Perform Actions on Records. A Create Action for the Self Service Portal is not authored on the Create Actions node: it is Create Action for SSP on the New submenu of the Service Actions node.
In the Settings App
Find a class's actions
Each class has its own Workflow node, under the class in its business area. The node opens a tree with these folders:
| Folder | Child nodes |
|---|---|
| Actions | Create Actions (not on Approval Stages), Step Actions, Service Actions, and, on Project Tasks only, Built-in UI Actions |
| Triggers | On Condition, On Created/Modified, On Deleted |
| Components | Templates, Forms, Functions, E-mail Notifications, Push Notifications |
On Stock Rooms, the Workflow node opens the toolbar-actions editor instead of this tree.
The toolbar has New, Edit, Delete, Copy Item, and an ordering command, which reads Display Order... on Create Actions and Step Actions and Order... on the Actions folder. Service Actions has no ordering command. The right-click menu adds New, Enable, Disable, and Export Selected Settingsā¦. Built-in UI Actions does not offer New, Delete, Copy Item, Enable, Disable, or an ordering command.
- New opens an empty editor window. Edit, a double-click, or Enter opens the selected action's window.
- OK saves a changed window and closes it.
- The window title reads
[<ID>] <Name>, with an asterisk in front while there are unsaved changes. The header line names the object and the kind, for exampleStep ActionorCreate Action, followed by the ID.
A new action goes last in its node's order, is enabled, is not a system item, and is open to any role. Until you reorder them, actions appear in the order they were created.
Create or edit a Step Action
The Step Action window has five tabs: General, Condition, Form, Programming, and Processes. One built-in Step Action of Service Catalog Items is the exception: its window opens without the Form and Programming tabs. In a new 2026.1 database created with the Default Workflow (see Default Workflow Configuration), that action is Submit Request; an upgraded database need not have it, and an administrator may have changed it.
- Select Step Actions and click New, or select a Step Action and click Edit.
- On the General tab, enter a Name. Without one, saving is refused with "The "Name" field is mandatory, it can't be left blank." and the window returns to the General tab. Fill in Caption, Hint, and Description, and select or clear Enabled. Caption is marked as mandatory, but if you leave it empty, it is filled with the name. Clicking into the Caption box while no caption has been set also fills it with the name.
- Under Allow to run:, choose Only on a single object or On multiple objects. A new Step Action starts on On multiple objects.
- Under Display in:, select Action Bar, Toolbar, or both, and select Display action caption to show the caption next to the icon on the toolbar. A new Step Action starts with only Action Bar selected. See Choose where a Step Action appears.
- In the Icon: group, set the action's icon. See Set an action's icon.
- On the Condition tab, choose the roles, statuses, and types the action is offered for, and set Additional criteria with Edit.... See Decide when a Step Action is offered.
- On the Form tab, choose the form the action shows. See Bind a form to an action.
- Click OK.
When On multiple objects is selected and the action's form has a section with a condition, the General tab shows "This action uses a form with conditional sections (pages). This may result in incorrect behavior when the action is run on multiple objects. We strongly recommend that you allow the action to run only on a single object."
Choose where a Step Action appears
The two Display in: check boxes decide where the action appears:
| Action Bar | Toolbar | The action appears |
|---|---|---|
| Selected | Cleared | On the Action Bar only |
| Cleared | Selected | On the toolbar only |
| Selected | Selected | On both |
Display action caption decides how a toolbar entry looks: cleared, it shows the icon only; selected, it shows the icon with the action's caption.
Group and order Step Actions
Step Actions can be arranged in named groups.
- Select Step Actions and click Display Order.... The Display Order dialog opens.
- Move an action with Move Up or Move Down (or Ctrl+Up and Ctrl+Down), or drag it.
- To start a group, select the Step Action the group begins with and click New Group... on the toolbar or the right-click menu. New Group... is unavailable when the selected row is a group or directly follows one.
- Type the caption at Group name: and click OK. The name starts as
New group; a name another group already has is refused and you are asked again. A bold group row is inserted above the selected action, and the actions below it are indented. - To change a group, select its row and use Rename Group... or Delete Group, which asks you to confirm.
- Click OK to save the order. Saving is refused while any group has no action in it.
Display Order... on Create Actions orders Create Actions the same way, without groups. Order... on the Actions folder opens a Display Order dialog that offers groups as well.
Decide when a Step Action is offered
Three separate checks decide whether a Step Action is offered on an object: its status, its type, and the user's role. The Condition tab holds a check list for each; their first rows are Any role, Any status, and Any type. Selecting or clearing an Any row selects or clears every row of that list; clearing any other row clears the Any row and leaves the rest alone. Saving with an Any row selected records no restriction for that list.
- A Step Action with no types listed is offered for any type. A Step Action with no statuses listed is offered in any status that is not closed.
- The role check applies only when the action is not open to any role. See Restrict an action to roles.
- When out-of-condition actions are shown disabled, a status that does not match shows the action disabled instead of hiding it.
- An action set to Only on a single object is dropped whenever actions are offered for a selection of several rows.
Two kinds of Step Action behave differently:
- A reopen action is offered exactly on inactive objects: its status list is computed from the class's inactive statuses rather than taken from the Condition tab. The statuses you select on the tab for a reopen action are not saved. On a Computer, a reopen action is refused when reopening would exceed the licensed node count.
- An embedded action is not listed among the ordinary actions and is reached from elsewhere. Project Tasks and stock-room toolbars use embedded actions. For a Project Task action, the window hides the placement and criteria panels. See Configure the embedded Step Action of Project Tasks.
Configure the embedded Step Action of Project Tasks
The embedded Step Actions of Project Tasks are kept in the Built-in UI Actions node of the Actions folder, which exists only under Project Tasks. They open in the ordinary Step Action window. In a new 2026.1 database created with the Default Workflow (see Default Workflow Configuration), the node holds one action, Schedule; an upgraded database need not have it, and an administrator may have changed it.
- In the Workflow node of Project Tasks, select Actions > Built-in UI Actions.
- Select the action and click Edit, or double-click it. The Step Action window opens with the tabs General, Condition, Form, Programming, and Processes.
- On the General tab, change Name, Caption, Hint, and Description, and select or clear Enabled. The tab also shows the action's ID and object class, which you cannot change. Caption is marked as mandatory, but if you leave it empty, it is filled with the name when you save.
- In the Icon: group, set the action's icon. See Set an action's icon.
- On the Condition tab, select the types, statuses, and roles the action is available for. The three check lists work as described in Decide when a Step Action is offered.
- Click OK.
Because the action is embedded, the window does not show the Allow to run: options, the Display in: group, or the Additional criteria box of the Condition tab.
Create or edit a Create Action
You never pick the kind of a Create Action directly: it follows from the subordinated check box and the Available for: option you choose. The Create Action window has the tabs General, Condition, Template, Form, Programming, and Processes, and a Sessions tab for recurrent tickets.
- Select Create Actions and click New, or select a Create Action and click Edit.
- On the General tab, enter Name, Caption, Hint, and Description, and select or clear Enabled. As for a Step Action, only the name is required, and an empty caption is filled with the name.
- If the class is hierarchic or is Work Orders, select This object will be created as subordinated to create the object as subordinated. Other classes do not offer this check box.
- On a ticket class other than Service Requests, choose under Available for: one of Regular Tickets only, Regular and Recurrent Tickets, or Recurrent Tickets only.
- In the Icon: group, set the action's icon.
- On the Condition tab, choose the roles and set Additional criteria. The Condition tab is hidden on Service Requests.
- On the Template tab, choose an existing template or define a custom template used only by this action. Its values are applied when the object is created. See Templates and Defaults.
- On the Form tab, choose the form. A new Create Action starts on the object's full form wherever the full form is allowed.
- While Regular and Recurrent Tickets or Recurrent Tickets only is chosen, a Sessions tab appears.
- Click OK.
The recurrent options come with rules:
- A recurrent option cannot use the object's full form or a wizard form. Picking one is refused with "Recurrent Tickets cannot use the Full Form. Select a different Form for the Action." or "Recurrent Tickets cannot use the form defined as a wizard. Select a different Form for the Action."
- On a ticket class, a Create Action that uses the object's full form and is not created as subordinated is saved as an ordinary Create Action, whatever Available for: says.
- If recurrent tickets already exist for the action, switching back to Regular Tickets only asks you to confirm, and the choice is reverted if you refuse.
- Changing the form of an action that already has recurrent tickets asks "This Action is used to create Recurrent Tickets. Changing the Form will clear all field values that the existing Recurrent Tickets have. Do you want to continue?".
The Condition tab of a Create Action has no status or type lists.
Bind a form to an action
The Form tab has a Form: list of the class's forms inside a Form definition group, with the form's caption, its instruction, the Window Style: choice of Dialog box or Wizard, and the buttons Make Custom and Reuse.
- The full form. A Create Action can use the object's own full form, which the Form: list offers as an entry of its own. While it is selected, the form definition is read-only and Make Custom reads Use Custom. On other actions, choosing no form means the action shows no form.
- A custom form belongs to its action alone and is deleted with it. Make Custom detaches the form as the action's own custom definition. Pointing a second action at a custom form is refused.
- A reusable form can be shared by several actions and stays when an action that uses it is deleted. Reuse opens the Reuse Form prompt, which asks for a Form Name: of up to 50 characters. A name that another form of the class has is refused with "Another form with this name already exists. Enter a different name." and you are asked again. The current definition, with its caption, instruction, and window style, is then saved as a new reusable form.
Switching the Form: list away from a custom definition first asks "The Custom Form definition will be lost. Do you really want to change the current form?". A form cannot be saved without fields, and a form cannot be saved as Wizard while a recurrent Create Action uses it.
The fields, sections, and validation rules of a form are described in Action Forms.
Restrict an action to roles
An action is either open to any role or restricted to the roles you list.
- With Any role selected on the Condition tab, every role may run the action. When an action is set to any role, its individual role grants are removed.
- With individual roles selected, only those roles may run it.
- A role grant can also be scoped to organizational units. A Step Action granted that way is offered only on objects whose organization is in the granting role's list. On a Create Action, the organizational scope does not narrow anything.
- A support account is offered every restricted action, whatever the grants say.
To see which actions a role or an account can run, open the Workflow Actions tab of the Security Role window (see Security Roles) or of a Technician account's window (see Create and Maintain Technician Accounts).
- The tab lists Step Actions and Create Actions only.
- An action open to any role is listed for every role and every account.
- On the account's tab, Restricted marks an action whose granting role is restricted to organizational units.
- Opening a row opens the action's own window. No grant can be removed from this tab.
Set an action's icon
The Step Action and Create Action windows have an Icon: group with the buttons Change..., Set Default, and Clear, and Copy and Paste on its pop-up menu.
- Change... opens a file dialog for BMP, ICO, and PNG files, which
initially opens in the
Resources\Iconsfolder of the installation. That folder holds the icon packsPack1,Pack2,Pack3,Pack5, andPack6; the action icons in theirActionsfolders are all ICO files. The file's content decides whether it is accepted: a file that is not a real PNG, ICO, or BMP image is refused with an error. An ICO file is previewed from its 16 x 16 image, but the original icon file is what is saved. - Paste takes a picture from the clipboard and stores it as a PNG.
- Set Default returns to the built-in icon of the action's kind; Clear leaves the action without an icon.
Once an ICO file has been loaded in the window, a picture you choose or paste after it is shown, but the ICO file is what is saved.
The window of a Create Action for SSP has no Icon: group.
Copy, enable, disable, or delete an action
- Copy Item saves a copy at once, with a new ID, and opens it in its own
window. The copy is named after the original with
- Copy, then- Copy (2)and so on, and it is never a system item. A custom form, template, or function of the original is duplicated; a reusable one is shared by the copy. The icon is duplicated. The copy also takes the original's role grants and process memberships. The built-in Step Action of Service Catalog Items that opens without the Form and Programming tabs cannot be copied: Copy Item refuses it with "This is a system record and it cannot be copied.". - Enable and Disable on the right-click menu switch the selected actions on or off.
- Delete refuses a system item, and refuses an action that a Request Fulfillment refers to. Otherwise it removes the action together with its role grants, process memberships, workflow log rows, and toolbar bindings, and with the form, template, or function the action owned privately, and its icon unless it is the shared default. A reusable form, template, or function is left alone.
Add an action to a process
Actions can also be created from Workflow and Business Logic > Advanced > Processes. Select a process's node and click New, then choose Create Action or Step Action and the class. The action's window opens, and saving it adds the action to the process. Remove takes the action out of the process without deleting it.
What technicians see in the Web App
This section describes the effect of the settings above. How technicians run actions is described in Perform Actions on Records.
Where Step Actions appear
- A record's full form shows in its Action Bar panel the actions set to Action Bar or to both, and on its toolbar the actions set to Toolbar or to both. An action with both Display in: check boxes cleared appears on neither.
- Actions are grouped by their group name, and each toolbar entry shows its caption when Display action caption is selected.
- A list's action menu, opened from the toolbar's action button or from a row's own action button, lists the actions without regard to their Display in: setting. For several selected rows, it offers only actions that may run on multiple objects.
What a Create Action opens
The Web App offers a class's ordinary Create Actions and those set to Regular and Recurrent Tickets, including those set to the full form. A Create Action whose Additional criteria are not met is not offered, even when out-of-condition actions are shown disabled.
- A Create Action whose form has at least one field opens its action form.
- A Create Action set to the full form, or whose form has no fields, opens the class's own full form for the new record.
On a new record's full form opened this way:
- The Activity element, the calendar, Gantt Chart, and tasks tabs, the Related Objects tab, and every grid show a message instead of their content until the record is saved. Notes, Resolution, and Custom Data show their fields.
- On Incidents, Problems, Change Requests, Service Requests, Work Orders, Knowledge Base Articles, Contracts, and Purchase Orders, the Approvals tab is hidden; it first appears once the record has approvals. On Persons and Computers, no tab is hidden, including tabs that a saved record may not show.
- The header leaves out its second block and the lifecycle strip, and the toolbar leaves out the flag menu, the View button, and the print menu.
- Mandatory and read-only settings that the form layout sets for individual fields do not apply.
The first Save creates the record and opens the saved record's own full form.
What technicians see in the Mobile App
The Mobile App's create screen offers only ordinary Create Actions and those set to Regular and Recurrent Tickets, and only when they are bound to a workflow form, in their display order. A Create Action set to the full form or to no form, a subordinated Create Action, and a Create Action set to Recurrent Tickets only are not offered there, and neither is a Create Action whose Additional criteria are not met.
Related topics
- Action Forms - design the forms that actions show.
- Templates and Defaults - set the values a new record starts with.
- Perform Actions on Records - run actions in the Web App.
- Security Roles and Create and Maintain Technician Accounts - see which actions a role or an account can run.