Retrieve Workflow Activity Records

Last modified: April 24, 2024

1 Introduction

A Retrieve workflow activity records activity can be used to retrieve a list of System.WorkflowActivityRecord objects sorted by activity start time. It needs the System.Workflow instance object as its input. It will break at Runtime if the passed workflow object is empty.

The System.WorkflowActivityRecord entity represents a snapshot of workflow activity attributes taken at a certain execution moment. If the activity is finished, the snapshot will have workflow activity attributes at the moment when the activity ends (completed, aborted, or failed). If the activity is still in progress, the snapshot will have the current activity attributes.

The most common use case for the retrieved list of System.WorkflowActivityRecord objects is to build an activity timeline for a specific workflow. Each System.WorkflowActivityRecord object is linked to the previously executed activity through the System.WorkflowActivityRecord_PreviousActivity association (except for the Start event). It can be used to visualize the order in which each activity finishes.

The image below shows an example of how an activity timeline can look like using the data returned from the Retrieve workflow activity records activity:

2 Properties

An example of retrieve workflow context properties is presented in the image below:

Retrieve Workflow Activity Records properties

There are two sets of properties for this activity, those in the dialog box on the left, and those in the properties pane on the right.

The Retrieve workflow activity records properties pane consists of the following sections:

3 Action Section

The Action section of the properties pane shows the action associated with this activity.

You can open a dialog box to configure this action by clicking the ellipsis () next to the action.

You can also open the dialog box by double-clicking the activity, or right-clicking the activity and selecting Properties.

3.1 Workflow Object

A workflow object of the System.Workflow entity available from the microflow parameters.

3.2 Variable Name

The name of the list variable returned by the activity.

4 Common Section

For more information on properties in this section, see Common Properties.