Adding a State to your Workflow with User Action

Statuses within the workflow are represented by white rounded rectangles whose border colour matches the lifecycle phase they belong to.

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

• Created
• Awaiting Payment
• Fraud Check
• Booked

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

Adding a State via the Workflow JSON

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.

Status schema

Status sample

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

Here is an example of how to add a new manager Hold status to an Order:

Step 1: go to the workflow modeller to view the CC order workflow. In the statuses section, add a new status called CS_HOLD

1
2    {
3      "name": "HOLD",
4      "entityType": "FULFILMENT",
5      "category": "BOOKING"
6    },

Step 2: Add a new ruleset that provides the user action to the OMS Webapp, which allows moving the fulfilment to CS_HOLD status if the fulfilment status has not passed the AWAITING_WAVE stage:

1{
2    "name": "CSHOLD",
3    "type": "FULFILMENT",
4    "subtype": "CC_PFS",
5    "eventType": "NORMAL",
6    "rules": [
7        {
8            "name": "{{AccountId}}.core.SetState",
9            "props": {
10                "status": "CS_HOLD"
11            }
12        }
13    ],
14    "triggers": [
15        {
16            "status": "AWAITING_WAVE"
17        }
18    ],
19    "userActions": [
20        {
21            "context": [
22                {
23                    "label": "Hold the Fulfilment",
24                    "type": "PRIMARY",
25                    "modules": [
26                        "adminconsole"
27                    ],
28                    "confirm": true
29                }
30            ],
31            "attributes": []
32        }
33    ]
34},

Step 3: Logon to OMS, then go to order -> fulfilment screen. User should able to see a new user action "HOLD THE FULFILMENT" button on the top right-hand corner: