Workflow Configuration Editor

The workflow configuration editor allows you to configure the workflow. Besides some general settings, the places, transitions and global actions can be configured with a visual editor.

General Settings

Define some general workflow settings like

• ID: Read-only internal name of the workflow, generated from the label when the workflow is created
• Label: Label for workflow that is shown in user interface
• Folder: Folder of the workflow in the workflow listing
• Active: Activate or deactivate the workflow
• Description: Description of the workflow, only visible in the workflow designer
• Priority: When multiple custom view or permission settings from different places in different workflows are valid, the workflow with the highest priority will be used.
• Type: A workflow with type Workflow can handle multiple places at one time whereas a State Machine provides a finite state machine (only one place at one time). See the Symfony docs for more details.

Subject settings

The subject settings define, to what elements the workflow should be applied to. There are two strategies available:

• Simple: Select one or multiple classnames for which the workflow should be applied to.
• Expression: Select a classname from the list and an additional condition when the workflow should be applied. The condition is a Symfony expression and can filter elements with specific criteria, e.g. all products of a certain type. See Pimcore docs for more details.

Advanced Settings

The advanced settings allow configuring two more settings:

• Marking Store: The marking store defines where the current workflow places of an element are stored. State Table should be sufficient for most cases. The other options (Single State, Multiple State, Data Object Multiple State) store the places in a field of the subject and require a Field Name. See Pimcore docs for more details.
• Enable Audit Trail: Enable default audit trail feature provided by Symfony. See the Symfony docs for more details.

Workflow Definition

The workflow definition tab allows the visual definition of places, transitions and global actions of the workflow. Each workflow has to have at least one transition.

Workflow elements can be added via the palette on the left side, or inline in the context pad of a selected element. The context pad also allows you to open a configuration window to configure the element.

Place Settings

Places are the states in which an element can be. The General tab of the place settings has the following configuration options:

• ID: Read-only identifier of the place within the workflow.
• Label: Nice name which will be used in the Pimcore backend.
• Title: Title/tooltip for this place when it is displayed in the header of the Pimcore element detail view in the backend.
• Visible in Header: If set to false, the place will be hidden in the header of the Pimcore element detail view in the backend.
• Color: Color of the place which will be used in the Pimcore backend (only HEX color definitions are supported).
• Inverted Color: If set to true the color will be used as border and font color otherwise as background color.

Permission Settings

The Permissions tab of the place settings defines what is allowed with the element in the current place. Permissions cover classic permissions like allowing modifying, saving, publishing, deleting elements as well as defining a custom layout for data objects (Object Layout). A place can have multiple permission sets defined, each with a condition that defines what permission set applies (e.g. different permission sets for different user groups). The badge on the tab shows how many permission sets are configured.

The tab is only shown to users with the permission_workflow_designer_place_permissions permission, see Installation and Configuration.

Transition Settings

Transitions are the actions that can be applied on the elements. The General tab of the transition settings has the following configuration options:

• ID: Read-only identifier of the transition within the workflow.
• Label: Nice name for the Pimcore backend.
• Guard: A symfony expression to block the transition from being allowed to be executed. E.g. certain transitions can be executed by certain user groups only.
  Example: is_fully_authenticated() and has_role('ROLE_JOURNALIST') and subject.getTitle() == 'My first article'
• Icon Class: CSS class to define the icon which will be used in the actions button in the backend.
• Object Layout: Forces an object layout after the transition was performed. This objectLayout setting overrules all objectLayout settings within the places configs.
• Change Published State: Change published state of element while transition (only available for documents and data objects).

Notes Settings

The Notes section at the bottom of the General tab lets users leave a comment when executing the transition. The comments are stored in Notes & Events of the workflow subject, see also Pimcore docs.

• Enable Comment: If enabled a detail window will open when the user executes the transition. In this detail view the user will be asked to enter a "comment". This comment then will be used as comment for the notes/events feature. The remaining notes settings only appear once this is enabled.
• Comment Required: Set this to true if the comment should be a required field.
• Notes Type: Define the type of the created note.
• Notes Title: Define the title for the created note.
• Comment Setter Function: Can be used for data objects. The comment will be saved to data objects through this setter function in addition to the notes/events.
• Comment Getter Function: Can be used for data objects to prefill the comment field with data from the data object.

Additional Fields

Beyond the comment, the notes section can collect further input in the same detail window. Each additional field has a Name (letters, numbers and underscores only), a Label, a Type (Input, Textarea, Select, Datetime, Date, User, Checkbox), a Required flag, an optional Default Value and an optional Setter Function that writes the value to a data object. Select fields additionally take a list of key/value Options.

Notifications Settings

The Notifications tab configures notifications sent when the transition is executed. Details also see Pimcore docs.

• Condition: A symfony expression can be configured here. All sets of notification which are matching the condition will be used.
• Notify Users: Send notification to a list of users (user names) when the transition gets applied.
• Notify Roles: Send notification to a list of user roles (role names) when the transition gets applied.
• Channel Type: Define which channel the notification should be sent to, possible values are Mail and Pimcore Notification.
• Mail Type: Type of mail source, possible values are Template and Pimcore Document.
• Mail Path: Path to mail source - either Symfony path to template or fullpath to Pimcore document. Optional use %%_locale%% as placeholder for language.

The tab is only shown to users with the permission_workflow_designer_trans_notifications permission, see Installation and Configuration.

Global Action Settings

In addition to transitions, Pimcore workflows also allow defining global actions. While transitions are only available when the element is in a certain place, global actions are available at every place. Besides that, they are very similar to transitions.

Global actions offer ID, Label, Guard, Icon Class, Object Layout and the same Notes settings including additional fields, all described under Transition Settings above. They have no Change Published State setting and no notifications tab.

Additional Features

• Undo and redo of definition changes (does not include detail configuration of workflow elements configuration windows).
• Zoom in, zoom out and automatic zoom.
• Minimap for improved navigation in big workflows.