Cancellation Manager Plugin

12min
Cancellation manager contains 3 plugins that have the following functions:
WorkOrderCancelled: This plugin decides whether the order/workOrder and the corresponding job are eligible to be canceled. If yes, then it cancels the Order/WorkOrder and the corresponding job. If not, then it triggers an event in the Order service to fail the cancellation of the WorkOrder.
JobCancelled: This plugin gets triggered when a job is successfully canceled. It will go ahead and cancel the corresponding WorkOrder.
JobCancellationFailed: This plugin is used to trigger WorkOrder cancellation failure in case of a job cancellation failure.
Use case
These plugins enable the tenant to percolate the cancellation functionality from the Order-service to Dispatch-service and vice-versa.
Input
WorkOrderCancelled:
tenantId
orderState
orderSubState
orderId
workOrderId
jobId
jobState
jobSubState
Callback
JobCancelled:
tenantId
orderId
workOrderId
jobId
callback
JobCancellationFailed:
tenantId
orderId
workOrderId
jobId
callback
Output
JobCancellationRequest
WorkOrderCancelFailedEvent
WorkOrderCancelledEvent
Logic
WorkOrderCancelled
This plugin uses order and job config files to check if the state and subState of the order allow the WorkOrder to be canceled. The config files are tenant-specific and contain a list of strings that contains the possible states and subStates for which the cancellation is allowed.
Output: JobCancellationRequest/WorkOrderCancelFailedEvent
JobCancelled
When a job is canceled, this plugin goes ahead and cancels the corresponding task. order.
Output: WorkOrderCancelledEvent
JobCancellationFailed
When the tenant tries to cancel a job but it fails, this plugin will go ahead and fail the work order cancellation.
Output: WorkOrderCancellationFailedEvent
Current Configuration
Rule
WorkOrderCancelled
WorkOrderCancelled
{
	"name": "Cancel job",
	"event": "WorkOrderCancellationRequestedEvent",
	"pluginWorkflowId": "plugin-workflow:64b087eb-8139-5a15-a01c-0b1fd86c0ca3",
	"serviceName": "orchestrator"
}
{
	"name": "Cancel job",
	"event": "WorkOrderCancellationRequestedEvent",
	"pluginWorkflowId": "plugin-workflow:64b087eb-8139-5a15-a01c-0b1fd86c0ca3",
	"serviceName": "orchestrator"
}
﻿
JobCancelled
JobCancelled
{
	"name": "Cancel work order",
	"event": "JobCancelledEvent",
	"pluginWorkflowId": "plugin-workflow:a9f7e6dd-c167-5155-8fd6-5db75322426f",
	"serviceName": "orchestrator"
}
{
	"name": "Cancel work order",
	"event": "JobCancelledEvent",
	"pluginWorkflowId": "plugin-workflow:a9f7e6dd-c167-5155-8fd6-5db75322426f",
	"serviceName": "orchestrator"
}
﻿
JobCancellationFailed
JobCancellationFailed
{
	"name": "Fail workOrder cancellation",
	"event": "JobCancelFailedEvent",
	"pluginWorkflowId": "plugin-workflow:ea025666-65be-5f88-8079-632e1447536e",
	"serviceName": "orchestrator"
}
{
	"name": "Fail workOrder cancellation",
	"event": "JobCancelFailedEvent",
	"pluginWorkflowId": "plugin-workflow:ea025666-65be-5f88-8079-632e1447536e",
	"serviceName": "orchestrator"
}
﻿
Plugin Workflow
WorkOrderCancelled
WorkOrderCancelled
{
	"name": "CancelJob",
	"description": "workflow for cancelling a job",
	"tag": [{
		"name": "WorkOrderCancellationRequested",
		"value": "workflow"
	}],
	"pre": {
		"plugins": [
			"fetchData"
		]
	},
	"main": {
		"plugins": [
			"workOrderCancelledPlugin"
		]
	}
}
{
	"name": "CancelJob",
	"description": "workflow for cancelling a job",
	"tag": [{
		"name": "WorkOrderCancellationRequested",
		"value": "workflow"
	}],
	"pre": {
		"plugins": [
			"fetchData"
		]
	},
	"main": {
		"plugins": [
			"workOrderCancelledPlugin"
		]
	}
}
﻿
JobCancelled
JobCancelled
{
	"name": "CancelWorkOrderWorkflow",
	"description": "workflow for putting cancelling workOrder",
	"tag": [{
		"name": "JobCancelledEvent",
		"value": "workflow"
	}],
      "pre": {
		"plugins": [
			"fetchData"
		]
	},
	"main": {
		"plugins": [
			"jobCancelledPlugin"
		]
	}
}
{
	"name": "CancelWorkOrderWorkflow",
	"description": "workflow for putting cancelling workOrder",
	"tag": [{
		"name": "JobCancelledEvent",
		"value": "workflow"
	}],
      "pre": {
		"plugins": [
			"fetchData"
		]
	},
	"main": {
		"plugins": [
			"jobCancelledPlugin"
		]
	}
}
﻿
JobCancellationFailed
JobCancellationFailed
{
	"name": "FailingWorkOrderCancellation",
	"description": "workflow for failing work order cancellation",
	"tag": [{
		"name": "JobCancellationFailedEvent",
		"value": "workflow"
	}],
      "pre": {
		"plugins": [
			"fetchData"
		]
	},
	"main": {
		"plugins": [
			"jobCancellationFailedPlugin"
		]
	}
}
{
	"name": "FailingWorkOrderCancellation",
	"description": "workflow for failing work order cancellation",
	"tag": [{
		"name": "JobCancellationFailedEvent",
		"value": "workflow"
	}],
      "pre": {
		"plugins": [
			"fetchData"
		]
	},
	"main": {
		"plugins": [
			"jobCancellationFailedPlugin"
		]
	}
}
﻿
Plugin
WorkOrderCancelled 
WorkOrderCancelled
{
    "name": "workOrderCancelledPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/cancellationManager/workOrderCancelled",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "cancellationManager"
    },
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {
                "tenantId": "$.tenantId",
                "orderState": "$.state",
                "orderSubState": "$.subState",
                "orderId": "$.orderId",
                "workOrderId": "$.workOrderId",
                "jobState": "$.fetchData.jobState",
                "jobSubState": "$.fetchData.jobSubState",
                "jobId": "$.fetchData.jobId"
            }
        },
        {
            "entity": "job",
            "input": {
                "tenantId": "$.tenantId",
                "workOrderId": "$.workOrderId"
            },
            "outputJsonPath": {
                "jobId": "$.id",
                "jobState": "$.status",
                "jobSubState": "$.subStatus"
            }
        }
    ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
{
    "name": "workOrderCancelledPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/cancellationManager/workOrderCancelled",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "cancellationManager"
    },
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {
                "tenantId": "$.tenantId",
                "orderState": "$.state",
                "orderSubState": "$.subState",
                "orderId": "$.orderId",
                "workOrderId": "$.workOrderId",
                "jobState": "$.fetchData.jobState",
                "jobSubState": "$.fetchData.jobSubState",
                "jobId": "$.fetchData.jobId"
            }
        },
        {
            "entity": "job",
            "input": {
                "tenantId": "$.tenantId",
                "workOrderId": "$.workOrderId"
            },
            "outputJsonPath": {
                "jobId": "$.id",
                "jobState": "$.status",
                "jobSubState": "$.subStatus"
            }
        }
    ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
﻿
JobCancelled
JobCancelled
{
    "name": "JobCancelledPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/cancellationManager/jobcancelled",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "cancellationManager"
    },
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {
                "tenantId": "$.tenantId",
                "orderId": "$.orderId",
                "workOrderId": "$.workOrderId",
                "jobId": "$.jobId",
                "clientId": "$.fetchData.workOrderId",
                "clientOrderId": "$.fetchData.clientOrderId"
            }
        },
        {
            "entity": "order",
            "input": {
                "tenantId": "$.tenantId",
                "id": "$.orderId"
            },
            "outputJsonPath": {
                "clientId": "$clientDetails.clientId",
                "clientOrderId": "$.clientDetaild.clientOrderId"
            }
        }
    ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
{
    "name": "JobCancelledPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/cancellationManager/jobcancelled",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "cancellationManager"
    },
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {
                "tenantId": "$.tenantId",
                "orderId": "$.orderId",
                "workOrderId": "$.workOrderId",
                "jobId": "$.jobId",
                "clientId": "$.fetchData.workOrderId",
                "clientOrderId": "$.fetchData.clientOrderId"
            }
        },
        {
            "entity": "order",
            "input": {
                "tenantId": "$.tenantId",
                "id": "$.orderId"
            },
            "outputJsonPath": {
                "clientId": "$clientDetails.clientId",
                "clientOrderId": "$.clientDetaild.clientOrderId"
            }
        }
    ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
﻿
JobCancellationFailed
JobCancellationFailed
{
    "name": "jobCancellationFailedPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/cancellationManager/jobCancellationFailed",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "cancellationManager"
    },
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {
                "tenantId": "$.tenantId",
                "orderId": "$.orderId",
                "workOrderId": "$.workOrderId",
                "jobId": "$.jobId",
                "clientId": "$.fetchData.workOrderId",
                "clientOrderId": "$.fetchData.clientOrderId"
            }
        },
        {
            "entity": "order",
            "input": {
                "tenantId": "$.tenantId",
                "id": "$.orderId"
            },
            "outputJsonPath": {
                "clientId": "$clientDetails.clientId",
                "clientOrderId": "$.clientDetaild.clientOrderId"
            }
        }
    ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
{
    "name": "jobCancellationFailedPlugin",
    "httpUrl": "https://delhivery.preprod.fxtrt.io/core/api/v1/cancellationManager/jobCancellationFailed",
    "httpMethod": "POST",
    "httpHeaders": {
        "plugin": "cancellationManager"
    },
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {
                "tenantId": "$.tenantId",
                "orderId": "$.orderId",
                "workOrderId": "$.workOrderId",
                "jobId": "$.jobId",
                "clientId": "$.fetchData.workOrderId",
                "clientOrderId": "$.fetchData.clientOrderId"
            }
        },
        {
            "entity": "order",
            "input": {
                "tenantId": "$.tenantId",
                "id": "$.orderId"
            },
            "outputJsonPath": {
                "clientId": "$clientDetails.clientId",
                "clientOrderId": "$.clientDetaild.clientOrderId"
            }
        }
    ],
    "dlqOnFailure": true,
    "requestTimeout": 5,
    "callbackTimeout": 5,
    "responseType": "ASYNC",
    "secretKey": "SECRET_KEY",
    "protocol": "HTTP"
}
﻿
Try Cancellation Manager Plugin APIs.
Updated 03 Aug 2023
Did this page help you?
Workflow Manager Plugin
Workflow Service