Payload Structure in JSON Format
Event: Operation Clocked On
{
"workOrderName":"",
"operation":"",
"laborType":"",
"operatorName":"",
"clockedOnTime":"",
"clockedOnBy":"",
"lotIdentifier":[],
"unitName":"",
"productionLine":"",
"kafkaConsumerId":"",
"publishedDate":"
"}
Event: Operation Clocked Off
{
"workOrderName":"",
"operation":"",
"operatorName":"",
"lotIdentifier":[],
"clockedOnTime":"",
"clockedOffTime":"",
"clockedOffBy":"",
"unitName":"",
"productionLine":"",
"kafkaConsumerId":"",
"publishedDate":""
}
Event: Operation Skipped
{
"schemaVersion": 1,
"workOrderName": "WOID6-ROUTE-JSON-SNOWBIKES",
<!-- Produced LotIdentifier Name & Properties -->
"lotIdentifier": {
"name": "SERNUM1",
"properties": [
{
"propertyName": "materialLot_Integer_Property",
"propertyValue": "10"
},
{
"propertyName": "materialLot_boolean_Property",
"propertyValue": "false"
}
]
},
<!-- Route Name & Properties -->
"routeInfo": {
"name": "Route Level",
"properties": [
{
"propertyName": "Some-Integer-Property-Name",
"propertyValue": "10"
},
{
"propertyName": "Some-Boolean-Property-Name",
"propertyValue": "true"
}
]
},
"operationInfo": {
"name": "FrameAssembly",
"skippedOnTime": "2021-04-12T09:02:05Z",
"unitName": "FrameMountingStation",
"productionLine": "Bikes_Assembly_Line",
"status": "Skipped",
"skippedBy": "mesadmin",
"producedMaterial": "SNOWBIKE-NONSERIALIZED",
"unitOfMeasure": "EA",
"skippedQuantity": 10,
"billOfMaterials": [],
<!-- Operation Properties -->
"properties": [
{
"propertyName": "work_order_import_prop_group_prop_2",
"propertyValue": "workorderimportgroupproperty2"
},
{
"propertyName": "work_order_import_prop_group_prop_3",
"propertyValue": "workorderimportgroupproperty3"
}
]
},
"kafkaConsumerId": "00000178c5511118-02420a0006db0000",
"publishedDate": "2021-04-12T07:29:07Z",
"sddSchemaVersion": 8
}
Event: Operation Completed
{
"schemaVersion": "2",
"workOrderName": "WO-Bike",
"lotIdentifier": {
"name": "Lot1",
"properties": [
{
"propertyName": "lotIdentifierProperty1",
"propertyValue": "10"
}
]
},
"routeInfo": {
"name": "Route Level",
"properties": [
{
"propertyName": "routeProperty1",
"propertyValue": "20"
},
{
"propertyName": "routeProperty2",
"propertyValue": "30"
}
]
},
"operationInfo": {
"name": "SIT Op1",
"startTime": "2021-02-03T12:29:28Z",
"endTime": "2021-02-03T12:31:52Z",
"unitName": "FrameMountingStation",
"productionLine": "Bikes_Assembly_Line",
"status": "Complete",
"completedBy": "mesadmin",
"producedMaterial": "PR1",
"unitOfMeasure": "EA",
"completedQuantity": 200,
"billOfMaterials": [
{
"name": "RawMaterial001",
"quantity": 4,
"unitOfMeasure": "EA",
"quantityPrecision": 1,
"lowerTolerance": 2.2,
"upperTolerance": 1,
"lowerTolerancePrecision": 1,
"upperTolerancePrecision": 1,
"scrapFactor": 1,
"defaultStorageUnit": "AlignmentJig",
"lotIdentifier": {
"name": "Lot1",
"properties": [
{
"propertyName": "consumedLotIdentifierProperty1",
"propertyValue": "10"
},
{
"propertyName": "consumedLotIdentifierProperty2",
"propertyValue": "30"
}
]
},
"properties": [
{
"propertyName": "bomItemProperty1",
"propertyValue": "10"
},
{
"propertyName": "bomItemProperty2",
"propertyValue": "20"
}
]
},
{
"name": "RawMaterial002",
"quantity": 444,
"unitOfMeasure": "EA",
"quantityPrecision": 1,
"lowerTolerance": 2.2,
"upperTolerance": 1,
"lowerTolerancePrecision": 1,
"upperTolerancePrecision": 1,
"scrapFactor": 1,
"defaultStorageUnit": "AlignmentJig",
"lotIdentifier": {
"name": "Lot2",
"properties": [
{
"propertyName": "consumedLotIdentifierProperty3",
"propertyValue": "10"
},
{
"propertyName": "consumedLotIdentifierProperty4",
"propertyValue": "30"
}
]
},
"properties": [
{
"propertyName": "bomItemProperty1",
"propertyValue": "Test1"
},
{
"propertyName": "bomItemProperty2",
"propertyValue": "Test2"
}
]
}
],
"properties": [
{
"propertyName": "operationProperty1",
"propertyValue": "1"
},
{
"propertyName": "operationProperty2",
"propertyValue": "2"
}
]
},
"kafkaConsumerId": "0000017767e0a822-02420a0002a40000",
"publishedDate": "2021-01-31T06:18:12Z",
"sddSchemaVersion": 8
}
Note: Only the properties that are specific to the operation are included in the message for
an operation-complete event. Properties specific to the route, material, etc. are not
included.
Event: Operation Cancelled
{
"schemaVersion":"1",
"workOrderName":"ERPWOID6-CANCELLED-JSON-SNOWBIKES",
<!-- Produced LotIdentifier Name & Properties -->
"lotIdentifier":{
"name":"SERNUM1",
"properties":[
{
"propertyName":"materialLot_Integer_Property",
"propertyValue":"10"
},
{
"propertyName":"materialLot_boolean_Property",
"propertyValue":"false"
}
]
},
<!-- Route Name & Properties -->
"routeInfo":{
"name":"Route Level",
"properties":[
{
"propertyName":"Some-Integer-Property-Name",
"propertyValue":"10"
},
{
"propertyName":"Some-Boolean-Property-Name",
"propertyValue":"true"
}
]
},
"operationInfo":{
"name":"FrameAssembly",
"cancelledOnTime":"2021-02-03T12:29:28Z",
"unitName":"FrameMountingStation",
"productionLine":"Bikes_Assembly_Line",
"status":"Cancelled",
"cancelledBy":"mesadmin",
"producedMaterial":"SNOWBIKE-NONSERIALIZED",
"unitOfMeasure":"EA",
"cancelledQuantity":20,
<!-- Operation Properties -->
"properties":[
{
"propertyName":"work_order_import_prop_group_prop_2",
"propertyValue":"workorderimportgroupproperty2"
},
{
"propertyName":"work_order_import_prop_group_prop_3",
"propertyValue":"workorderimportgroupproperty3"
}
]
},
"kafkaConsumerId":"0000017767e0a822-02420a0002a40000",
"publishedDate":"2021-01-31T06:18:12Z",
"sddSchemaVersion":8
}
Event: Route Released
{
"routeDefinitionID": 40500,
"name": "TestRoute",
"revision": 2,
"producedMaterialName": "Prod1",
"plannedLineName": "Line1",
"createdOn": "2022-02-05T13:05:29.929Z",
"lastModifiedOn": "2022-02-05T13:08:06.940Z",
"publishedDate": "2022-02-05T13:08:07Z",
"kafkaConsumerId": "0000017ec9ffbaa1-0242ac1200250000"
}
Note: The content in
mes.erp.outbound.messages
route release message has been
modified in Plant Applications 2022. It is recommended to subscribe to
mes.route.releasedRoutes
and then use the routeID
to
leverage the route service to obtain data about the route. Within the route service you can
use:GET /routes/{routeID}
to get information about the route (e.g., name, revision, last modified on, last modified by, etc.)GET /routes/{routeID}/exportSegments
to retrieve the route definition, including:- produced material
- production line
- route behaviors
- operations sequences, names and descriptions
- BOM item names, quantity, precision, etc.
- documents
- property names and values
- operation behaviors
Event: Material Lot Status Changed
{
"kafkaConsumerId": "",
"publishedDate": "",
"materialLot": [
{
"lotIdentifier": "",
"productName": "",
"status": "",
"productionUnit": "",
"quantity": ,
"productionLine": "",
"unitOfMeasure": "",
"properties": [
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
}
],
"materialSubLot": [
{
"lotIdentifier": "",
"productName": "",
"status": "",
"productionUnit": "",
"quantity": ,
"productionLine": "",
"unitOfMeasure": "",
"properties": [
{
"propertyName": "",
"propertyValue": ""
}
]
},
{
"lotIdentifier": "",
"productName": "",
"status": "",
"productionUnit": "",
"quantity": ,
"productionLine": "",
"unitOfMeasure": "",
"properties": [
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
},
{
"propertyName": "",
"propertyValue": ""
}
]
}
]
}
]
}
Event: Material Lot Status Changed
{
"kafkaConsumerId": "00000177b58e3610-0242ac12001a0000",
"publishedDate": "2021-02-18T14:22:43Z",
"materialLot": [
{
"lotIdentifier": "ERP_NS_20210218_24_JSON",
"productName": "MCU",
"status": "Receiver Complete",
"productionUnit": "Receiver",
"quantity": 4,
"productionLine": "Received Material Lots",
"unitOfMeasure": "EA",
"properties": [
{
"propertyName": "statusUpdatedBy",
"propertyValue": "comxclient"
},
{
"propertyName": "statusUpdatedTime",
"propertyValue": "2021-01-27T11:53:41Z"
},
{
"propertyName": "isSerialized",
"propertyValue": "false"
},
{
"propertyName": "SCRAP",
"propertyValue": "1"
},
{
"propertyName": "RTV",
"propertyValue": "1"
},
{
"propertyName": "ACCEPT",
"propertyValue": "2"
}
],
"materialSubLot": [
{
"lotIdentifier": "ERP_NS_20210218_24_JSON_LOT2",
"productName": "MCU",
"status": "Accept",
"productionUnit": "Received Material Lot-Kilograms",
"quantity": 2,
"productionLine": "Received Material Lots",
"unitOfMeasure": "EA",
"properties": [
{
"propertyName": "Accept",
"propertyValue": "2"
}
]
},
{
"lotIdentifier": "ERP_NS_20210218_24_JSON_LOT1",
"productName": "MCU",
"status": "Scrap",
"productionUnit": "Received Material Lot-Kilograms",
"quantity": 2,
"productionLine": "Received Material Lots",
"unitOfMeasure": "EA",
"properties": [
{
"propertyName": "OrgCode",
"propertyValue": "BCO"
},
{
"propertyName": "SCRAP",
"propertyValue": "1"
},
{
"propertyName": "RTV",
"propertyValue": "1"
}
]
}
]
}
]
}
Event: Process Order Created
{
"schemaVersion": 2,
"processOrderName": "POIDXML-100-2020-C",
"processOrderRouteInfo": {
"plannedStartTime": "2020-12-08T09:22:17.017Z",
"plannedEndTime": "2020-12-09T09:22:17.017Z",
"plannedQuantity": 234,
"actualStartTime": null,
"actualEndTime": null,
"line": "JuiceLine",
"product": "PulpyJuice",
"status": "Pending",
"path": "Path1",
"bomFormulation" : "REG_JUICE_FORMULA",
"controlType": "QUANTITY",
"orderType": "SCHEDULE",
"impliedSequence": 978409984,
"extendedInfo": "",
"engineeringUnit": "ml",
"entryOn": "2020-12-08T09:22:17.017Z",
"sourceProcessOrder": null,
"parentProcessOrder": "POIDXML-100-2020",
"productionRate": 33.89,
"blockNumber": "BN-123",
"userGeneral1": "",
"userGeneral2": "",
"userGeneral3": "",
<!-- ProcessOrder Custom properties if it is Process order -->
<!-- Workorder Route properties if it is Work order -->
"properties": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "someliteral"
}
]
},
"kafkaConsumerId": "00000177b5ddd690-0000000004d20000",
"publishedDate": "2020-12-09T09:22:17.017Z"
}
Event: Process Order Updated
{
"schemaVersion": 2,
"processOrderName": "POIDXML-100-2020-C",
"processOrderRouteInfo": {
"plannedStartTime": "2020-12-08T09:22:17.017Z",
"plannedEndTime": "2020-12-09T09:22:17.017Z",
"plannedQuantity": 234,
"actualStartTime": "2020-12-08T09:30:17.017Z",
"actualEndTime": null,
"line": "JuiceLine",
"product": "PulpyJuice",
"status": "Active",
"path": "path1",
"bomFormulation" : "REG_JUICE_FORMULA",
"controlType": "QUANTITY",
"orderType": "SCHEDULE",
"impliedSequence": 978409984,
"extendedInfo": "",
"engineeringUnit": "ml",
"entryOn": "2020-12-08T09:22:17.017Z",
"sourceProcessOrder": null,
"parentProcessOrder": "POIDXML-100-2020",
"productionRate": 33.89,
"blockNumber": "BN-123",
"userGeneral1": "",
"userGeneral2": "",
"userGeneral3": "",
<!-- ProcessOrder Custom properties if it is Process order -->
<!-- Workorder Route properties if it is Work order -->
"properties": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "someliteral"
}
]
},
"kafkaConsumerId": "00000177b5ddd690-0000000004d20000",
"publishedDate": "2020-12-09T09:22:17.017Z"
}
Event: Process Order Deleted
{
"schemaVersion": 2,
"processOrderName": "POIDXML-100-2020-C",
"processOrderRouteInfo": {
"plannedStartTime": "2020-12-08T09:22:17.017Z",
"plannedEndTime": "2020-12-09T09:22:17.017Z",
"plannedQuantity": 234,
"actualStartTime": null,
"actualEndTime": null,
"line": "JuiceLine",
"product": "PulpyJuice",
"status": "Pending",
"path": "path1",
"bomFormulation" : "REG_JUICE_FORMULA",
"controlType": "QUANTITY",
"orderType": "SCHEDULE",
"impliedSequence": 978409984,
"extendedInfo": "",
"engineeringUnit": "ml",
"entryOn": "2020-12-08T09:22:17.017Z",
"sourceProcessOrder": null,
"parentProcessOrder": "POIDXML-100-2020",
"productionRate": 33.89,
"blockNumber": "BN-123",
"userGeneral1": "",
"userGeneral2": "",
"userGeneral3": "",
"properties": [ ]
},
"kafkaConsumerId": "00000177b5ddd690-0000000004d20000",
"publishedDate": "2020-12-09T09:22:17.017Z"
}
Event: Process Order Completed
{
"schemaVersion": 2,
"processOrderName": "POIDXML-100-2020-C",
"processOrderRouteInfo": {
"plannedStartTime": "2020-12-08T09:22:17.017Z",
"plannedEndTime": "2020-12-09T09:22:17.017Z",
"plannedQuantity": 234,
"actualStartTime": "2020-12-09T09:22:17.017Z",
"actualEndTime": "2020-12-09T09:30:17.017Z",
"line": "JuiceLine",
"product": "PulpyJuice",
"status": "Complete",
"path": "Automation-Line",
"bomFormulation" : "REG_JUICE_FORMULA",
"controlType": "QUANTITY",
"orderType": "SCHEDULE",
"impliedSequence": 982863901,
"extendedInfo": "",
"engineeringUnit": "ml",
"entryOn": "2021-02-22T18:52:37Z",
"sourceProcessOrder": null,
"parentProcessOrder": "POIDXML-100-2020",
"productionRate": 33.89,
"blockNumber": "BN-123",
"userGeneral1": "",
"userGeneral2": "",
"userGeneral3": "",
<!-- ProcessOrder Custom properties if it is Process order -->
<!-- Workorder Route properties if it is Work order -->
"properties": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "someliteral"
}
],
"actualBadQuantity": 0,
"actualGoodQuantity": 220
},
"kafkaConsumerId": "00000177cb163a2c-0000000004d20003",
"publishedDate": "2020-12-09T09:22:17.017Z",
<!-- Produced Material lot Properties -->
"materialLots": [
{
"lotIdentifier": "Production_event1",
"unit": "Unit1",
<!-- Production Event Dimension details -->
"dimensionalQuantities": [
{
"dimension": "X",
"dimensionName": "Litres",
"producedQuantity": 10,
"unitOfMeasure": "lts"
},
{
"dimension": "Y",
"dimensionName": "Weight",
"producedQuantity": 10,
"unitOfMeasure": "kg"
},
{
"dimension": "Z",
"dimensionName": "Count",
"producedQuantity": 40,
"unitOfMeasure": "EA"
},
{
"dimension": "A",
"dimensionName": "Cases",
"producedQuantity": 4,
"unitOfMeasure": "EA"
}
],
"properties": [
{
"propertyName": "Lot_Prop_Int",
"propertyValue": "10"
},
{
"propertyName": "Lot_Prop_String",
"propertyValue": "Test"
}
]
},
{
"lotIdentifier": "Production_event2",
"unit": "Unit1",
<!-- Production Event Dimension details -->
"dimensionalQuantities": [
{
"dimension": "X",
"dimensionName": "Litres",
"producedQuantity": 10,
"unitOfMeasure": "lts"
},
{
"dimension": "Y",
"dimensionName": "Weight",
"producedQuantity": 10,
"unitOfMeasure": "kg"
},
{
"dimension": "Z",
"dimensionName": "Count",
"producedQuantity": 40,
"unitOfMeasure": "EA"
},
{
"dimension": "A",
"dimensionName": "Cases",
"producedQuantity": 4,
"unitOfMeasure": "EA"
}
],
"properties": [
{
"propertyName": "Lot_Prop_Int",
"propertyValue": "20"
},
{
"propertyName": "Lot_Prop_String",
"propertyValue": "Test 2"
}
]
}
]
}