Adding a Ruleset to your Workflow

The Ruleset defines the Rules that are executed when a matching event is produced.

Adding a Ruleset via the UI

You can add new Rulesets via either an existing Ruleset list or via the Entity Workflow Swimlane.

The green icons represent one or more Rulesets.

Rulesets inside of the Status rectangles are triggered on that State, while those outside of a status transition the entity to the state in which it's line and arrow indicate.

Clicking on the green icon reveals a list of Rulesets configured within that state or transition.

Each Ruleset displays a Name, the Statuses for which the Ruleset applies, and a Trigger Description. In the above example, the Ruleset name is Create, and the current status is Created.

The Ruleset Name is required as part of the Event that would Trigger the Ruleset to run.

Clicking on a Ruleset Name brings up the Ruleset details on a slide-out panel from the right-hand side of the screen.

The Edit Ruleset screen has three sections:

• Triggers
• User Actions
• Rules

Each of these sections can expand or collapse by clicking on the section header.

Adding a Ruleset via JSON

To add a Ruleset to a Workflow JSON, you must add a new Ruleset to the `Rulesets` Array of the Workflow Json that matches the Ruleset schema outlined below.

Ruleset schema

Ruleset sample

1{
2  "rulesets": [
3    {
4      "name": "{{rulesetName}}",
5      "description": "",
6      "type": "{{entity}}",
7      "eventType": "{{eventType}}",
8      "subtype": "{{subtype}}",
9      "rules": [],
10      "triggers": [
11        {
12          "status": "{{statusName}}"
13        }
14      ],
15      "userActions": []
16    }
17  ]
18}