Skip to main content
Matrix42 Self-Service Help Center

Workflow Instances Activity Monitoring

Overview

The Workflow Instances section offers the possibility to monitor and control workflows that were designed with the new version of the workflow engine.

The Workflows → Services & Processes → Workflows→  Workflow Instances search page lists all instances of workflows that were created with the new version of the workflow engine and provides the search criteria for filtering them (Workflow, Version, State, Last Update, Start, and End). Click the name of the column, e.g. Workflow or State, to filter the grid by this column, A-Z; click it again to filter the grid by this column Z-A.

The grid layout displays the following information:

  • Quick Filter:
    • Red rectangle = Activation failed, Terminated or Canceled; 
    • Yellow = Running or Suspended;
    • Light blue = Completed;
  • Name of the workflow instance (same as the used workflow)
  • Version of the workflow instance
  • State of the workflow instance
  • Last Update 
  • Start 
  • End 

WorkflowInstances.jpg

Object Preview (when a workflow instance is selected) displays the following information:

  • Name of the workflow instance
  • Instance Progress
  • State
  • Version 
  • Last Update 
  • Start
  • End
  • Summary
  • Affected Objects

wf_instance_preview1.png

Status of Workflow Instances

Statuses of workflow instances can be divided into two groups:

Running Instances:
  • Active – The workflow is executing some logic.
  • Suspended – The workflow is waiting for some user input.
Finished Instances:
  • Completed – The workflow has been completed successfully.
  • Failed – The workflow failed because of error during the execution.
  • Terminated – The workflow has been terminated explicitly by the user.
  • Canceled – The workflow has been canceled explicitly by the user.

The following diagram shows the possible status transitions:

FAQ_Workflows_002.png

Configuration Item "Workflow Process Instance"

Instance Progress

Visual progress that was defined in the workflow.

InstanceProgress.jpg

General

Name Name of the workflow instance.
State Current state of the instance (e.g., Suspended, Active, Completed, etc.).
Start Start date and time of the execution.
End Finish date and time of the execution.
Summary Detailed information about errors in case of a failed workflow instance.
Last Update Date and time information from the last update of the instance.

Affected Objects

Process Instance Related Object: A list with the affected objects of the workflow instance, e.g., a provisioning workflow instance displays the service booking which initialized the workflow execution (Type, Relation Type, Name).

Actions

Delete

The Delete action performs the delete operation for the selected instances. The system asks for a simple confirmation before the final deletion.

Cancel Workflow

This action will be used to stop the workflow execution and run compensation logic that is defined in the corresponding workflow. As an example, compensation logic for a workflow that creates a user in Active Directory can be removal of the created account. The system asks for a simple confirmation before it finally cancels the instance.

Terminate Workflow

This action will be used to stop the workflow execution without any cleanup (compensation) logic. The system asks for a simple confirmation before it finally terminates the instance.

Suspend Workflow

This action will be used to suspend the workflow execution. The system asks for a simple confirmation before it finally suspends the instance.

Resume Workflow

This action will be used to resume a suspended workflow execution. The system asks for a simple confirmation before it finally resumes the instance.

Visual Tracking

This action launches the Workflow Studio in the Visual Tracking mode for the selected workflow instance, where the user can follow up the detailed progress of the instance:

WF_Instances_visual_tracking_Matrix42_WFStudio.png

  • The Flow Chart area shows successfully finished activities marked with a green background and a checkmark.
  • The Events section provides detailed information about the executed activity, processing time and passed variables so that the workflow progress and each processing stage can be easily traced back and analyzed.