Action Model

The Action model editor shows a list of existing Action models, which can then be modified or deleted as required. By default, the list of models is displayed in the order of last modified and as a textual table of model details. It is possible to switch the view to a different sort order or as a graphical gallery of cards.

820 work action list

The model list enables the following actions:

The following sections describe each feature in more detail.

Creating a New Action

Click the button labeled Create, a dialog prompts you to enter basic information:

820 work new action
  • The display name of the action.

  • The action’s unique key.

  • An optional description of the action.

By clicking Create new model, a new action model is created and you are redirected to the edit view of the action where you make further configuration changes. See Action Editor for more information. Once the appropriate information is entered, click the Save and close editor button.

Action Details

There, you see the name, description, version, creator and the modification date of the model as well as the current values of the properties used to define the action.

820 work action details

If you want to see an older version of your model, press on the History button and choose the version you are interested in.

On the top-right, there are these icons:

140 icon edit model

Edits the name, description, and key of the model.

140 icon duplicate model

Duplicates the model.

140 icon delete model

Deletes the model.

140 icon download model

Downloads the model as a file.

820 icon model editor

Opens the editor of the model which allows you to modify the content of the model.

Action Editor

The Action Editor is a set of properties that are used to define the action.

820 work action edit
Property Function

Bot key

The key of the service or bot invoke.

Icon

Name of icon to use.

Scope type

For example, conversation, user, task, BPMN, CMMN or a custom type.

Form

The form displayed when executing this action.

Channels

For example, menu, quick-actions.

Confirmation message

The message text to show on confirmation of the action.

Conformation title

The text of the title for the confirmation.

Confirmation message code

The message code for internationalized text for the confirmation.

Permission groups

A list of groups that can see this action.

Permission user identity link types

A list of link types, for example, candidate, assignee, owner or a custom type.

Example

An example of the use of this action.

Mapped states

A list of scope type states needed to see this action, for example, conversation - active, archived.

Mapped sub-states

A list of scope type sub-states needed to see this action.

Mapped types

A list of scope type types needed to see this action, for example, conversation - direct-message, channel.

Mapped sub-types

A list of scope type sub-types needed to see this action.

Signal name

The process signal key to send when action is invoked if required.

Priority

A number used for ordering when displaying a list of actions.

Theme

The key of a custom theme to use.

Do not show confirmation message

Do not display any confirmation message before executing this action.

Show action globally

Whether the action is available in all contexts.