Work Order Manager Plugin

8min
This plugin will interpret the current event and, if required, it will update an existing WorkOrder.
Use case
Single leg - Update the work order status based on job updates.
Input
tenantId
orderId
workOrderId
workOrderPickupLocation
workOrderDeliveryLocation
jobStatus
eventCode
reasonCode
location
callback
Output
UpdateWorkOrderStateEvent (status = IN_PROGRESS)
UpdateWorkOrderStateEvent (status = COMPLETED)
Logic
jobStatus == IN_PROGRESS && location == workOrderPickupLocation → UpdateWorkOrderStateEvent (status = IN_PROGRESS)
jobStatus == COMPLETED && location == workOrderDeliveryLocation && reasonCode == “R-0065” → UpdateWorkOrderStateEvent (status = COMPLETED)
Current Configuration
Rules
Job Complete Success Rule
Job Complete Success Rule
{
    "name": "Complete Job Success",
    "event": "CompleteJobEvent",
    "pluginWorkflowId": "plugin-workflow:6e33bb8f-7ca2-5a7a-add5-fc651c5048af",
    "serviceName": "orchestrator",
    "logic": {
        "==": [
            "$.reason",
            "R-0065"
        ]
    }
}
{
    "name": "Complete Job Success",
    "event": "CompleteJobEvent",
    "pluginWorkflowId": "plugin-workflow:6e33bb8f-7ca2-5a7a-add5-fc651c5048af",
    "serviceName": "orchestrator",
    "logic": {
        "==": [
            "$.reason",
            "R-0065"
        ]
    }
}
﻿
Job Complete Failure Rule
Job Complete Failure Rule
{
    "name": "Job Started",
    "event": "JobStartedEvent",
    "pluginWorkflowId": "plugin-workflow:6e33bb8f-7ca2-5a7a-add5-fc651c5048af",
    "serviceName": "orchestrator"
}
{
    "name": "Job Started",
    "event": "JobStartedEvent",
    "pluginWorkflowId": "plugin-workflow:6e33bb8f-7ca2-5a7a-add5-fc651c5048af",
    "serviceName": "orchestrator"
}
﻿
Plugin Workflow
JSON
{
    "name": "CompleteJobWorkflow",
    "description": "workflow for job completion",
    "tag": [
        {
            "name": "workOrderManager",
            "value": "workflow"
        },
        {
            "name": "containerManager",
            "value": "workflow"
        }
    ],
    "pre": {
        "plugins": [
            "fetchData"
        ]
    },
    "main": {
        "plugins": [
            "workOrderManagerPlugin",
            "containerManagerPlugin"
        ]
    }
}
{
    "name": "CompleteJobWorkflow",
    "description": "workflow for job completion",
    "tag": [
        {
            "name": "workOrderManager",
            "value": "workflow"
        },
        {
            "name": "containerManager",
            "value": "workflow"
        }
    ],
    "pre": {
        "plugins": [
            "fetchData"
        ]
    },
    "main": {
        "plugins": [
            "workOrderManagerPlugin",
            "containerManagerPlugin"
        ]
    }
}
﻿
Plugin
JSON
{
    "name": "workOrderManagerPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/workOrderManager/",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "workOrderManager"
    },
    "httpRequestBodyTemplate": [
            {
                "outputJsonPath": {
                    "tenantId": "$.tenantId",
                    "orderId": "$.orderId",
                    "jobStatus": "$.status",
                    "reason": "$.reason"
                }
            },
            {
                "entity": "order",
                "input": {
                    "tenantId": "$.tenantId",
                    "id": "$.orderId"
                },
                "outputJsonPath": {
                    "workOrderId": "$.workOrders[0].id",
                    "workOrderPickupLocation": "$.workOrders[0].pickupDetails.location",
                    "workOrderDeliveryLocation": "$.dropDetails.location",
                    "workOrderStatus": "$.workOrders[0].status"
                }
            },
            {
                "entity": "job",
                "input": {
                    "tenantId": "$.tenantId",
                    "id": "$.jobId"
                },
                "outputJsonPath": {
                    "location": "$.objectives[1].location",
                    "workOrderId": "$.workOrderId"
                }
            }
        ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
{
    "name": "workOrderManagerPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/workOrderManager/",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "workOrderManager"
    },
    "httpRequestBodyTemplate": [
            {
                "outputJsonPath": {
                    "tenantId": "$.tenantId",
                    "orderId": "$.orderId",
                    "jobStatus": "$.status",
                    "reason": "$.reason"
                }
            },
            {
                "entity": "order",
                "input": {
                    "tenantId": "$.tenantId",
                    "id": "$.orderId"
                },
                "outputJsonPath": {
                    "workOrderId": "$.workOrders[0].id",
                    "workOrderPickupLocation": "$.workOrders[0].pickupDetails.location",
                    "workOrderDeliveryLocation": "$.dropDetails.location",
                    "workOrderStatus": "$.workOrders[0].status"
                }
            },
            {
                "entity": "job",
                "input": {
                    "tenantId": "$.tenantId",
                    "id": "$.jobId"
                },
                "outputJsonPath": {
                    "location": "$.objectives[1].location",
                    "workOrderId": "$.workOrderId"
                }
            }
        ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
﻿
Try Work Order Manager Plugin API.
Updated 03 Aug 2023
Did this page help you?
Container Manager Plugin
Workflow Manager Plugin
Docs powered by Archbee
TABLE OF CONTENTS
Current Configuration
Rules
Plugin Workflow
Plugin