Support & Operations Activities

An introduction: Activities

• Plugin Management
• Workflow Versioning 
• Audit Events

Plugin Management

• Uploading plugins
• Activating plugins
• Viewing the active/inactive version of plugins
  • Checking which version of the plugin is active
  • Rolling back/forward between the previous and new versions
• Retrieving all the rules that are currently available in an account
• Managing custom rules on custom plugins

Using the Plugin API

• Authentication: Required
• Permissions: PLUGIN_VIEW permission required for the ACCOUNT context.
• Responses: Response Content Type- application/json

• Authentication: Required
• Permissions: PLUGIN_VIEW permission is required for the ACCOUNT context.
• Responses: Response Content Type - application/json

Understanding Workflow Versions

• A major version represents a major change in the flow, such as adding a new state transition and new business logic.
• A minor change involves changing parameters, such as changing the email template for customer notifications or updating the expiry time of articles.

Activities

• Submit a new version of the workflow
• Check what different workflow versions exist
• Get an extract of all the workflows that are currently available
• Go back and retrieve a particular workflow version

• Return the latest current and historical workflows
• Return the latest version of the workflow declared in the URL
• Return a specific version of a workflow as declared in the URL

Audit events

Orchestration Audit Events

• Event API (e.g. using Postman)
• Event Search (see Insights in Fluent OMS web app)
• Activity tab (inside Order detail view in Fluent OMS web app)

• Why is it useful? : To see the state of the entity before the process is executed.

• Why is it useful? : To trace the workflow path taken by the entity during that event or process.

• Why is it useful? : To trace all rules executed in sequence within a process and determine what the last rule executed was in the case of an exception or interruption in processing. It can also be used to capture an audit of each entity's status change or webhook sent by filtering to those rules.

• Why is it useful? : To validate if an expected Action was produced during processing.

• Why is this useful? : To debug 'what exception has occurred' and 'why'. More importantly, it will log the stack trace of the exception. Therefore, it's important for Rule writers to make sure the real source exception is thrown or included as the cause of the exception being thrown from the Rule.

Audit Event Structure

1{
2      “id”: “a3f154c0-3e19-11ed-a11c-198b938d27af”,
3      “name”: “Change State”,
4      “type”: “ORCHESTRATION_AUDIT”,
5      “accountId”: “FCTRAINAU1000",
6      “retailerId”: “1",
7      “category”: “ACTION”,
8      “context”: {
9        “sourceEvents”: [
10          “a37c24c0-3e19-11ed-b70a-0f9894474e93”
11        ],
12        “entityType”: “FULFILMENT_OPTIONS”,
13        “entityId”: “5c40405c-d647-4b11-825f-7d53aacc7983”,
14        “entityRef”: “FO_6081”,
15        “rootEntityType”: “FULFILMENT_OPTIONS”,
16        “rootEntityId”: “5c40405c-d647-4b11-825f-7d53aacc7983”,
17        “rootEntityRef”: “FO_6081”
18      },
19      “eventStatus”: “SUCCESS”,
20      “attributes”: [
21        {
22          “name”: “toStatus”,
23          “value”: “OPTIONS_PROVIDED”,
24          “type”: “STRING”
25        },
26        {
27          “name”: “startTimer”,
28          “value”: 1664251536270,
29          “type”: “STRING”
30        },
31        {
32          “name”: “stopTimer”,
33          “value”: 1664251536366,
34          “type”: “STRING”
35        }
36      ],
37      “source”: “94862882.CREATE”,
38      “generatedBy”: “Rubix User”,
39      “generatedOn”: “2022-09-27T04:05:36.366+0000"
40    }