Broadleaf Microservices
  • v1.0.0-latest-prod

Workflow Services Data Model

Data Model

Workflow Services Data Model
Figure 1. The following model shows the key tables and their relationships within the Workflow Service.

Workflows

Workflows Represents a single execution of a SimpleWorkflow bean.

BLC_WORKFLOW

Field Definition

ID

Unique row ID

LAUNCH_TOKEN

Token associated with the workflow to correlate with messaging. See Informational#getLaunchToken().

REFERENCE

Optional. A reference value to which this workflow is correlated. The system will not start more than one workflow for a given reference value. The value must be less than or equal to 36 chars in length. Usually a ULID primary key for an entity.

NAME

The name of the workflow. Must match the Spring bean name.

DESCRIPTION

Short description of the purpose of the workflow.

WORKFLOW_STATUS

The status of execution of the workflow.

LAST_STEP_TIMEOUT

The timestamp of when the most recently executing step will time out.

LAST_STEP_NAME

The name of the most recently executing step in this workflow execution.

LAST_EXCEPTION

The most recent exception that took place during a previous workflow execution.

Side Effects

Side Effects represent a non-deterministic element in a workflow that, upon replay, should be utilized to re-establish workflow state, rather than re-executing the non-deterministic function used to originally acquire the element.

Field Definition

ID

Unique row ID

TYPE_INFORMATION

The type of side effect being applied.

VALUE

The serialized value of the side effect.

WORKFLOW_ID

The id of the workflow to which this side effect belongs

Context Values

Context Values represent a single key/value pair passed to the workflow execution during the WorkflowEndpoint#start(ContextInfo, String, Map) call.

Field Definition

ID

Unique row ID

NAME

The key of the context item

VALUE

The value of the context item

VALUE_TYPE

The type of value being stored

WORKFLOW_ID

The id of the workflow to which this side effect belongs

Activity Logs

Activity Logs represent Arbitrary log entry made during the execution of an activity in a workflow.

Field Definition

ID

Unique row ID

LOG_NAME

The key name for the log entry

LOG_VALUE

The value of the log entry

ACTIVITY_NAME

The name of the activity in which the log entry was made

WORKFLOW_ID

The id of the workflow to which this side effect belongs