Start and End Events

This article explains the concept of start and end events in a workflow definition.

Data-driven workflows, available in Semarchy xDM 2023.1 and later, are subject to specific licensing requirements; please confirm your eligibility to use such new functionality by consulting your license agreement or by contacting your Semarchy account representative prior to use.
All customers can still use the workflow feature available in previous versions (now known as legacy workflows). For more information, see Workflows (Legacy).

Start and end events represent the starting and ending points of the workflow. All workflow definitions must have at least one start and one end event.

Depending on the use case, a data-driven workflow can have as many start and end events as necessary. For example, the same workflow can be configured to start at a different step depending on the initiator’s role, or it can be designed to start either from scratch (e.g., for a creation task) or from a selection of existing data (e.g., for an editing task). Likewise, the same workflow can be configured to complete when various end events occur (e.g., once records are submitted for publication to the hub, when an edit is rejected, or when a task is discarded).

Between the start and end events, a workflow also has some user tasks, automations, and control flows, linked together by transitions.

Add a Start Event

To add a start event in a workflow definition:

  1. In the workflow editor, click the workflow add button Create Step button. The Add a Step dialog appears.

  2. From the Type drop-down list, select Start Event.

  3. In the Name field, enter a name for the step.

  4. Click Create. The start step graphical element is added to the workspace: Start step

  5. Select the step. The side panel sweeps in from the right.

  6. In the side panel, set the start event properties.

Start Event Properties

Start event properties allow you to define how the workflow should start and progress.

General Properties

The general properties allow you to set a display name for the step, define the required user roles for initiating the workflow, and set a priority for the workflow.

Table 1. General Properties
Property Required Description

Label

Optional

Label to be displayed in the diagram.

Initiator Required Role

Optional

User role that can initiate the workflow. Selecting <None> allows all user roles to initiate the workflow.

Default Priority

Required

Default priority of the workflow. Possible values are:

  • Low

  • Normal

  • High

  • Critical

By default, this field is set to Normal.

Startup Context Properties

The Startup Context properties allow you to define how the workflow is used to author records.

Table 2. Startup Context Properties
Property Required Description

Context Type

Required

Determines how the workflow is to be used to author records. Possible values are:

  • Start From Empty Selection: for authoring new records from a root entity. This option is actionable through both an application action in the navigation drawer and an entity action item in the actions menuOptions menu.

  • Start From Selection: only for authoring an existing record from a root entity. This option is actionable through an entity action item in the actions menuOptions menu.

Authored Entity

Required

Only available if Context Type is not set to Start From Empty Selection.

Entity on which the workflow is based.

Record Type

Optional

Only available if Context Type is set to Start From Selection.

The type of records from which the workflow can be triggered. Possible values are:

  • Golden Data (default): consolidated and certified (i.e., golden) records. This option can be selected for all types of entities.

  • Source Authoring Data With Errors: erroneous source records authored by users. This option can be selected for all types of entities.

  • Golden Data With Errors: erroneous golden records. This option can be selected only for ID- and fuzzy-matched entities.

Condition on Selection

Optional

Only available if Context Type is set to Start From Selection.

SemQL condition on the selected records for the start action to be enabled.

Click the undock SemQL editor icon to use the SemQL editor.

Refer to Workflow Attributes for more information on all the attributes.

Startup Parameter Properties

The Startup Parameter properties allow you to select the mandatory and optional parameters that must or can be provided when starting a workflow via the user interface or REST API calls.

workflow startup dialog

Table 3. Startup Parameter Properties
Property Description

Enable Description

Allows business users to add a description for the workflow instance.

Enable Comment

Allows business users to write a comment.

Mandatory Comment

If the Enable Comment option is selected, then this option makes entering a comment mandatory.

Enable Priority

Allows business users to select a priority for the workflow.

Enable Due Date

Allows business users to specify a due date for completing the workflow.

Mandatory Due Date

If the Enable Due Date option is selected, then this option makes specifying the due date mandatory.

Enable Next Task Assignee Selection

Allows business users to specify the next user in the workflow.

Mandatory Next Task Assignee Selection

If the Enable Next Assignee Selection option is selected, then this option makes specifying the next user in the workflow mandatory.

Enable Attachments

Allows business users to add attachments in the workflow.

Mandatory Attachment

If the Enable Attachments option is selected, then this option makes adding attachments mandatory.

Show the Wait

Displays a dialog informing the user that the workflow is being created. This dialog is visible until the user hides it, a user task is initiated, or the workflow is complete.

Transition Property

The Transition property allows you to specify the step that should immediately follow the start event.

Table 4. Transition Property
Property Required Description

Target Step

Required

Step to transition to after the start event is triggered and the startup dialog is submitted.

Add an End Event

To add an end event in a workflow definition:

  1. In the blank workspace, click the workflow add button Create Step button. The Add a Step dialog appears.

  2. From the Type drop-down list, select EndEvent.

  3. In the Name field, enter a name for the step.

  4. Click Create. The end step graphical element is added to the workspace: End step