Adding a State to your Workflow

How-to Guide

Author:

Fluent Commerce

Changed on:

26 Sept 2023

Key Points

It’s possible to add a new state into an existing WorkFlow by adding a new status to the
```
`Statuses array`
```
of the workflow JSON.

Statuses within the workflow are represented by the white rounded rectangles with a border color matching the lifecycle phase they belong to.

For example, within the Booking phase, the Order status could be:

Similarly, within each of the other phases, there could be multiple different states in which the entity might travel.

Tip

While all Fluent Entities begin their lifecycle at the

`CREATED`

state, all other statuses are configurable and in line with your specific workflow logic.

Note

You can only add new States to a Workflow via the JSON document.

To add a State to a Workflow JSON, you must add a new Status to the

`statuses`

array of the Workflow JSON that matches the schema outlined below.

JSON Key	Value Type	Mandatory	Description
name	String	YES	Name of the status.
entityType	String	YES	Name of the entity the status belongs to.
category	String	YES	Name of the category the status belongs to.

1 {
2  "statuses": [
3    {
4      "name": "{{name}}",
5      "entityType": "{{entityType}}",
6      "category": "{{category}}"
7    }
8  ]
9}

Language: json

Name: Status sample

Description:

[Warning: empty required content area]

Tip

States will not appear in the Workflow graph until they are referenced by a Ruleset.