Skip to content

View Workflow Information and Perform Workflow Steps

Krish Majumdar edited this page Jan 10, 2023 · 3 revisions

This page allows users to view information about a single workflow and perform workflow steps. A particular workflow's information page may be accessed by either clicking on any hyperlinked workflow ID, or entering the workflow's ID into any workflow ID search box.

A workflow's information page looks similar to the following:

View-Workflow-Information

The top section of the page always shows common information about the workflow regardless of its type - its type name, ID, current status, and details about when and by who the workflow's information was last modified.

The second section of the page, denoted by the top green-outlined form, displays the type form corresponding to the workflow's type, populated by any existing user-defined information. However, at the time of this writing (January 2023), none of the workflow types currently being used in the database actually require any user-defined information - hence the type form is empty (as seen in the image above).

The workflow path - that is, the series of steps associated with this workflow's type - is shown in the green-outlined table below the type form box. Each row in the table is a single step in the workflow, with the step number, associated component or action type form name, and current status or result shown. If a step has been completed, the displayed result will be either a full UUID (if the step is associated with creating a component) or an action ID (if it is associated with performing an action). Uncompleted steps will show a status message indicating as such.

Below the workflow path table is an expandable list of all versions of this workflow (collapsed by default), each of which can be viewed by clicking the corresponding hyperlink. Finally, this section of the page also includes buttons for editing the workflow's information and viewing the workflow's full JSON record.

Performing Workflow Steps

To perform the next uncompleted workflow step in sequence, a user only needs to press the blue button on that step's row in the workflow path table. Workflow steps must be performed in sequence - that is, for example, a user cannot perform step 4) if step 3) has not yet been completed. This is indicated in the workflow path table by only the first incomplete step having the blue button available, whereas all other uncompleted steps will show a red Perform Previous Steps First label.

Pressing the button will redirect the user to the corresponding page for creating a new component or performing a new action. When accessing these interface pages from a workflow, the user will be automatically redirected back to the workflow's information page upon submitting the new component or action. The workflow path will also automatically be updated, with the current step now registering as completed (with a corresponding result being displayed), and the next step will become available to perform.

Please note that components and actions that are created via workflows may still be edited afterwards, outside of the workflow - i.e. they behave identically to standalone components and actions. Editing such entities does not change any connection they have to an originating workflow.

Once the final step in the workflow has been performed, the workflow's overall status (shown in the top section of the workflow's information page) will automatically change from 'In Progress' to 'Complete'.

Clone this wiki locally