JSON Process Order Import Document (POID)
Schema versions 1, 2 and 3 are supported in a POID.
JSON POID Schema Version 5
Using schema version 5, you can import both Process Order and BOM formulation at the same time.
- bomFormulationDetails: Allows to add the BOM formulation details. Using schema version 5, you can update the new BOM Formulation details when the Process Order is in active state.
When the user wants to import a Process Order along with BOM Formulation and the BOM
Formulation does not exist in the system, then the user must do the following:
- Pass empty or null values to the bomFormulation field.
- Define the details for a BOM in the bomFormulationDetails field.
When the bomFormulationDetails field is null, the Process Order is then imported without the BOM formulation details.
{
"schemaVersion": 5,
"processOrderName": "ProcessOrder_JSON_v4",
"plannedLineName": "JuiceLine",
"producedMaterialName": "PulpyJuice",
"path": "Path1",
"plannedQuantity": 300,
"bomFormulation": "BomFormluation1", // If BomFomulationDetails object is not null then this field will be null
"plannedStartDate": "2021-11-25T21:50:58.058Z",
"plannedEndDate": "2021-11-26T00:00:00.000Z",
"productionRate": 33.89,
"blockNumber": "BN-123",
"userGeneral1": "UG-1",
"userGeneral2": "UG-2",
"userGeneral3": "UG-3",
"extendedInfo": "Extended Info",
"status": null,
"propertyValues": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "test"
}
],
"bomFormulationDetails": { // If this object is null Process order will be imported without BOM Formulation
"bomFormulationName": "TestBOM",
"effectiveDate": "2021-10-20T13:12:40.458Z",
"expirationDate": "2021-11-20T13:12:40.458Z",
"producedMaterialQuantity": 1,
"producedMaterialQuantityPrecision": 0,
"producedMaterialUnitOfMeasureName": "EA",
"bomFamilyName": "BOMFamily1",
"bomMasterName": "OpComplete",
"producedMaterialNames": [
"PulpyJuice"
],
"propertyValues": [
{
"propertyName": "ExpirationDate",
"propertyValue": "2019-10-22T12:30:45.555Z"
},
{
"propertyName": "EffectivityDate",
"propertyValue": "2019-10-22T12:30:45.555Z"
}
],
"billOfMaterials": [
{
"bomItemName": "line1",
"quantityPrecision": 2,
"scrapFactor": 1,
"lowerTolerancePrecision": 2,
"quantity": 1,
"materialName": "N-001",
"unitOfMeasureName": "EA",
"upperTolerancePrecision": 2,
"lowerTolerance": 1,
"upperTolerance": 1,
"displayOrder": 1,
"substitution": [],
"propertyValues": [
{
"propertyName": "ExpirationDate",
"propertyValue": "2019-10-22T12:30:45.555Z"
},
{
"propertyName": "EffectivityDate",
"propertyValue": "2019-10-22T12:30:45.555Z"
}
]
},
{
"bomItemName": "line2",
"quantityPrecision": 2,
"scrapFactor": 1,
"lowerTolerancePrecision": 2,
"quantity": 4,
"materialName": "5099T05G12",
"unitOfMeasureName": "LB",
"upperTolerancePrecision": 2,
"lowerTolerance": 1,
"upperTolerance": 1,
"displayOrder": 1,
"substitution": [],
"propertyValues": [
{
"propertyName": "ExpirationDate",
"propertyValue": "2019-10-22T12:30:45.555Z"
},
{
"propertyName": "EffectivityDate",
"propertyValue": "2019-10-22T12:30:45.555Z"
}
]
}
]
}
}
JSON POID Schema Version 4
Schema version 4 supports update functionality with a mandatory field of ProcessOrderName.
Updatable fields are:
- plannedStartDate
- plannedEndDate
- plannedQuantity
JSON POID Schema 4 - create
{
"schemaVersion": 4,
"processOrderName": "PO-IMPORT_SCM4_JSON",
"plannedLineName": "QALine_Singlepath",
"producedMaterialName": "ERP_Prod1",
"path": "Path1",
"plannedQuantity": 300,
"bomFormulation": "TractorBOM",
"plannedStartDate": "2005-02-25T21:50:58.058Z",
"plannedEndDate": "2005-02-26T00:00:00.000Z",
"productionRate": 45,
"blockNumber": "BN-876",
"userGeneral1": "UG-11",
"userGeneral2": "UG2",
"userGeneral3": "456",
"extendedInfo": "Extended Info",
"propertyValues": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "test"
}
]
}
JSON POID Schema 4 - update
{
"schemaVersion": 4,
"processOrderName": "ProcessOrder_JSON_v4",
"plannedLineName": null,
"producedMaterialName": null,
"path": "Path1",
"plannedQuantity": null,
"plannedStartDate": "2020-12-08T09:22:17.017Z",
"plannedEndDate": "2020-12-09T09:22:17.017Z",
"bomFormulation": "REG_JUICE_FORMULA",
"productionRate": null,
"blockNumber": null,
"userGeneral1": null,
"userGeneral2": null,
"userGeneral3": null,
"extendedInfo": null,
"propertyValues": []
}
JSON POID Schema Version 3
Schema version 3 supports a process order inbound message that also includes the following
properties:
- userGeneral1, userGeneral2 and userGeneral3
- extendedInfo
- blockNumber
- productionRate
- path (optional)
- Supports binding a process order to a line that is configured with multiple paths; if supplied, and the path is on the specified line, the process order is bound to the path
{
"schemaVersion": 3,
"processOrderName": "ProcessOrder_JSON_v3",
"plannedLineName": "JuiceLine",
"producedMaterialName": "PulpyJuice",
"path": "Path1",
"plannedQuantity": 234.89,
"plannedStartDate": "2020-12-08T09:22:17.017Z",
"plannedEndDate": "2020-12-09T09:22:17.017Z",
"bomFormulation": "REG_JUICE_FORMULA",
"productionRate": 33.89,
"blockNumber": "BN-123",
"userGeneral1": "UG-1",
"userGeneral2": "UG-2",
"userGeneral3": "UG-3",
"extendedInfo": "Extended Info",
"propertyValues": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "someliteral"
}
]
}
JSON POID Schema Version 2
Using schema version 2, you can override values of the process order properties. In addition, providing the production line is not mandatory, and you can include production lines with multiple execution paths. When a production line has multiple execution paths, the process order becomes an unbound process order. You can associate a production line with an execution path using Plant Applications Administrator or Plant Applications Web Client; or you can leave it as is.{
"schemaVersion": 2,
"processOrderName": "POIDXML-100-2020",
"producedMaterialName": "PulpyJuice",
"plannedLineName": "",
"plannedQuantity": 234.89,
"plannedStartDate": "2020-12-08T09:22:17.017Z",
"plannedEndDate": "2020-12-09T09:22:17.017Z",
"bomFormulation": "REG_JUICE_FORMULA",
"propertyValues": [
{
"propertyName": "Process_Prop_Int",
"propertyValue": "123"
},
{
"propertyName": "Process_Prop_String",
"propertyValue": "someliteral"
}
]
}
JSON POID Schema Version 1
Using schema version 1, you can import process orders containing information about the planned quantity, material, production line, and planned start and end dates.{
"schemaVersion": 1,
"processOrderName": "POIDXML-105-2020",
"producedMaterialName": "PulpyJuice",
"plannedLineName": "JuiceLine",
"plannedQuantity": 10.5,
"plannedStartDate": "2020-12-08T09:22:17.017Z",
"plannedEndDate": "2020-12-09T09:22:17.017Z",
"bomFormulation": "REG_JUICE_FORMULA"
}