Module workflow

Source
Expand description

The workflow module contains the structs and functions relating to the Workflow object and job object.

The Workflow struct is a 1:1 representation of the Workflow class we have defined currently within the system. The Job struct is a representation of a Workflow when it is being processed by the execution engine.

The Job struct implements the Iterator trait and this contains the logic for moving from node to node during execution.

Structs§

Job
Job represents the workflow whilst it is running.
Message
Message is the struct transmitted to the executor to signal the job can make progress
Parameter
A generic Parameter which is a 1:1 representation of a Parameter in the existing system.
Pointer
A pointer indicates which other nodes a node is pointing to.
Workflow
A 1:1 representation of the Workflow class in our existing codebase.
WorkflowNode
A struct representing each Node within a Workflow where a node is simply an item to be executed or an instruction on how to execute the Workflow.

Enums§

JobStatus
A definition for the current running state of a Job struct.
NodeStatus
Indicates whether a node has succeeded or failed
WorkflowNodeStatus
The status representing the state any Node can find itself in
WorkflowNodeType
Definition for each type of node that can appear in a Workflow/Job