Custom Module Workflow

Define a sequence of steps and actions in workflows to establish directional paths for managing custom module records.

You can create multiple workflows for a custom module. However, only the default workflow will be executed.

 

This page discusses custom module workflows under the following topics:

 

Create Workflows

The selected state will be considered as the main state node of the workflow.
You can also create a workflow without selecting the state.

 

You will be directed to the workflow editor. In the workflow editor, you can add various nodes to automate actions. Connect the source and target nodes using the cursor to specify the workflow path.

Configure Workflows

Use the workflow editor to define directional paths for records within a workflow.
The workflow editor contains:

The stencil panel comprises two tabs: Drag & Drop Nodes and Details. You can add nodes to the editor from the Drag & Drop Nodes tab by using a simple drag-and-drop action. The Details tab displays the basic information about the workflow. You can click next to each field to modify its details.

The nodes in the stencil panel are grouped into State Nodes, Condition Nodes, Action Nodes, and Branch Nodes.

Default view of a new workflow editor

 

Configure Nodes

Nodes are workflow elements that define how custom module workflows should be processed. The stencil panel contains the following nodes under the Drag & drop Nodes tab.

 

You can add nodes to the editor by using a simple drag-and-drop action. When a node is added, a pop-up window appears, allowing you to specify its properties.

Refer to the following sections to understand the purpose of each node and how to configure them.

State Node

Refers to the record status in the workflow.

If the State is selected during workflow creation

If the State is not selected during workflow creation

  • Select the required status or custom configuration from the drop-down.
  • Click Save.

  • Provide a name and description for the status.

  • Click Save.

 

You can have multiple statuses in the workflow. However, the same status cannot be repeated.

Link Type

The link type defines how the process moves from one node to another. It determines whether the transition between nodes happens automatically or requires user action. You can add a link type while connecting the start node to a state node, or while connecting a state node to a condition/action/branch node.

Click  on the connector to set the link type. There are two link types:

Auto - The link triggers automatically when the state is reached. Each state node can have only one auto link.

Transition - Requires technician intervention to move the record to the next step. Transition links appear as actionable buttons on the record details page.

Use transitions to define user scope, mandate fields, and trigger actions at defined times. The following section explains how to create transitions in detail.

 

 

Configure Transitions

Before - This phase occurs prior to the transition execution.

Before option is not applicable when the Start node is connected to a State node.
If Scope and Criteria are not configured, the transition button will be visible to all technicians with record edit permissions.

 

During - This phase occurs as the record transitions to the next state. Actions configured in the during rules are executed when the transition occurs.

 

After - This phase follows the transition.

 

Condition Nodes

Checks whether the configured conditions are met and moves the record to the next node. Following are the different types of condition nodes:

 

If

Checks if the specified conditions are met before the record proceeds to the next node.

 

 

The If node has a single input port and two output ports (Yes/No).

 

 

Wait For

Pauses the record workflow until specified conditions are met.

{ "sdp_workflow_signals" : [ { "entity_name" : "cm_<custom_module>" , "entity_id" : <entity_id> , "wait_for_node_name" : <name> } ] }

 

 

The Wait For node has a single input port and a single output port.

 

 

Switch

A multi-way branch node that refers to the value of a chosen field and applies the workflow path based on the selected value.

 

 

The Switch node has a single input port and N number of output ports based on the added field options.

 

Action Nodes

Automates the following actions during workflow execution:

 

Notification

Automatically sends emails or messages to users or groups when the node is reached.

 

The Notification node has a single input port and a single output port.

 

Field Update

Updates field values in the record when predefined conditions are met.

 

The Field Update node has a single input port and a single output port.

 

 

Custom Function

Executes custom operations by using custom functions.

 

 

The Custom Function node has a single input port and two output ports (Success and Failure). The failure port executes an alternate path if the custom function encounters an error.

 

 

User Defined Action

Automates actions across instances when the node is reached. The supported actions depend on the instance selected to execute the action.

When User Defined Action is executed within the same instance as the workflow - You can create Requests, Announcements, Custom module records, and custom module subentities such as Tasks and Checklists.

When User Defined Action is executed in a different instance - You can create Requests, Custom module records, and Announcements.

 

Configure User Defined Action

 

Click here for more information on user-defined action.

 

 

The User Defined Action node has a single input port. The number of output ports depends on whether an action completion or an alternate path is configured.

 

UDA with single input and output port

UDA configured with action completion

UDA configured with alternate path

UDA configured with action completion and alternate path

 

Timer

Executes time-delayed actions on records. You can pause the record for a specific time duration and execute actions when the timer is active or after it ends.

 

The number of timer node ports depends on whether the abort criteria is configured.

When the Timer node is reached, the configured actions are executed based on the defined schedule or duration.

 

Branch Nodes

Manages complex workflows by handling multiple scenarios simultaneously. There are two types of branch nodes.

Fork

Splits the workflow into multiple parallel paths, allowing different actions to run simultaneously.

 

The Fork node has a single input port and a single output port.

 

 

You can add up to 15 forks in the workflow.
Nested forking is not supported.
State nodes cannot be added in forked paths.

 

Join

Merges multiple parallel paths into a single workflow path.

The workflow must contain an equal number of Fork and Join nodes.

 

The Join node has a single input port and two output ports (Success & Failure).

 

 

Link Nodes

After adding nodes, connect the nodes to specify the workflow direction. The link used to connect two nodes is called a connector.

 

Connector Actions

 

Node Actions

Right-click on a node to perform the following actions:

 

Workflow Editor Actions

You can perform the following actions from the workflow editor.

Collapse the Stencil - click on top of the stencil panel to expand or collapse it.

Edit Workflow Details - Click the workflow name on the header or go to the Details tab in the stencil to edit the basic details of the workflow.

View Associated Records - Click Associated <custom_module> on the header to view the records associated with the workflow.

On the associated records list view,

Multi-select and Move Nodes - Use the Select Tool icon on the header to select multiple nodes and reposition them in the editor.

Reset Workflow - Use the Reset  icon on the header to reset a workflow to its default state. If the workflow was previously saved, it will be restored to its last updated state.

Export Workflow - Click > Export as PDF on the header to export saved workflows as PDF documents.

View Workflow History - Click > View History on the header to view the log of all operations performed on the workflow.

View Help Card - Click > Help to view the help card.

Zoom In/Zoom Out Workflow - Use the zoom handle on the editor's left corner to view the graph in a large/small scaled view.

Save Workflow - Click Save on the header to save the workflow.