Workflow Steps

Workflow steps are the core building blocks of order processing in Omnium. Each step performs a specific action on an order or shipment, such as allocating inventory, capturing payments, sending notifications, or exporting to external systems.

How Workflow Steps Work

Workflow steps are configured in Workflows and execute automatically as orders move through different statuses. Each step:

• Receives the current Order, optional Shipment, and WorkflowStep configuration
• Performs its action and returns a result (Success, Warning, or Error)
• Can optionally trigger a status change or cancel the workflow on failure

Configuration

Each workflow step can be configured with:

Step Categories

Workflow steps are organized into functional categories:

Identifying Workflow Steps

Each workflow step has a unique Key identifier used in configuration. This key is shown in the documentation for each step and matches the value in FactoryContants.OrderActions.

Example: The "Allocate to Warehouse" step has key AllocateToWarehouse.

Common Patterns

Test Mode

Most workflow steps support test mode (context.IsTest = true), which returns a simulated result without performing actual operations. This is useful for validating workflow configuration.

Market/Store Restrictions

Steps can check workflowStep.IsAvailableForMarket(order.MarketId) to skip execution for orders from non-configured markets.

Property Configuration

Steps read configuration from workflow step properties:

var warehouseCode = workflowStep.GetProperty("warehouseCode")?.Value;
var skipManual = workflowStep.GetPropertyAsBool("SkipForManualOrder", true);
var storeRoles = workflowStep.GetProperties("storeRoles")?.Select(x => x.Value).ToList();

Result Handling

When a step sets CancelWorkflow = true, remaining steps in the workflow are skipped.

When a step sets TriggerNewStatus, the order transitions to that status after the workflow completes.