Workflow Administration

This page describes how to administer workflows.

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). Refer to Workflows (Legacy) for more information.

Authentication & Privileges

Systems or users administrating workflows in Semarchy xDM must be authenticated and fulfill one of the following conditions:

  • Have one role having Grant full access to the model selected in Model Privileges.

  • Have the role defined as Workflow Administrator Role in the workflow definition.

  • (Applies to Workflow Administration REST API) For read-only endpoints only (list or get workflow instances, list or get user task instances): Be either the initiator of the workflow instance, or a candidate or an assignee of any user task of the workflow instance.

Workflow Administration REST API

The following API endpoints are available to administer workflows:

  • Workflow Instances:

    • List and get workflow instances.

    • Kill a workflow instance.

    • Retry a specific failed step of a workflow instance.

  • User Task Instances:

    • List and get user task instances.

    • Assign a user task.

    • Release a user task.

For a complete description of each API endpoint, refer to the REST API Documentation.

Workflow Administration UI

Access Workflow Administration View

To access workflow administration:

  1. Open the application whose workflow you want to administer.

  2. In the navigation drawer, click My Tasks.

  3. In My Tasks, in the bottom section of the left menu, click Administration.

The list of workflows is displayed.

You can also access the administration view using the following URLs:

View URL

Adminstration view with no filter

http://<hostName>/semarchy/mdm-app/<modelName>/<applicationName>/mytasks/admin

Specific search results

http://<hostName>/semarchy/mdm-app/<modelName>/<applicationName>/mytasks/admin?search=encoded search criteria

Specific workflow instance editor

http://<hostName>/semarchy/mdm-app/<modelName>/<applicationName>/mytasks/admin/<workflowInstanceId>

Specific workflow instance editor with a step

http://<hostName>/semarchy/mdm-app/<modelName>/<applicationName>/mytasks/admin/<workflowInstanceId>/<stepInstanceId>

Workflow Instance List

The workflow administration view displays the list of workflow instances in a tabular format with the following columns:

Column Description

Workflow

Workflow label and identifier.

Description

Description of the workflow instance.

Status

Status of the workflow instance.

Initiator

Initiator of the workflow instance.

Current Root Step

Current root step for this workflow instance.

Assigned To

Current assignee.

Start Date

Start date of the request.

End Date

End date of the request.

Due Date

Due date to complete the workflow.

Priority

Priority assigned to the workflow instance.

Workflow ID

Identifier of the workflow instance.

Actions

You can perform the following actions on the workflow instances from the workflow administrator view.

  • View workflow instance details: Click any workflow line to open its details or select a workflow and from the action menu, click Details. This opens the Workflow Instance Editor and displays all the workflow steps.

  • Kill a workflow instance: Select the workflow that you want to kill and from the action menu, click Kill.

Workflow Instance Editor

The workflow instance editor contains the following sections:

  • History: Displays the completed and ongoing step(s) of the workflow instance as a diagram.

    A selected step is indicated by an enlarged icon.

  • Details: Displays the details of the selected workflow step. When no step is selected, this section is empty.