Click or drag to resize

CFX.Materials.Transport Namespace

Messages used for the transportation of raw materials from one location in the factory to another location
Classes
 ClassDescription
Public classCheckpointReached Sent when a group of materials or production units that is being transported through the factory environment arrives at a way point along its path source to destination.
Copy
{
  "TransportOrderId": "TR329483249830000",
  "Comments": "Arrived SMT Production Area",
  "Status": "InTransit",
  "TrackedBy": {
    "OperatorIdentifier": "BADGE4486",
    "ActorType": "Human",
    "LastName": "Doe",
    "FirstName": "John",
    "LoginName": "john.doe@domain1.com"
  },
  "RelatedWorkOrderId": "WO2384702937403280032",
  "Checkpoint": "SMT STAGING AREA 1",
  "FinalDestination": "LINE 1",
  "NextCheckpoint": "LINE 1"
}
Public classCreateTransportOrderRequest

** NOTE: ADDED in CFX 2.0 **

Message request to create transport order; it shall contain all necessary data for one or more transports while leaving sufficient flexibility to make use of different Fleet Manager capabilities.
Copy
{
  "TransportOrderId": "T123456",
  "RelatedWorkOrderId": "WO000123",
  "Materials": {
    "TransportedTools": [
      {
        "UniqueIdentifier": "ID000234",
        "Name": "Tool 1"
      },
      {
        "UniqueIdentifier": "ID000567",
        "Name": "Tool 2"
      }
    ],
    "TransportedMaterialPackages": [
      {
        "UniqueIdentifier": "ID0AB123C",
        "InternalPartNumber": "PN12345",
        "InternalPackageName": "Package components type 1",
        "Quantity": 100000.0,
        "LeadingMaterialPackage": null,
        "BatchId": "B123",
        "BatchMaterialPackage": null,
        "GreyZone": 0.0
      },
      {
        "UniqueIdentifier": "ID0ZW234X",
        "InternalPartNumber": "PN67890",
        "InternalPackageName": "Package components type 2",
        "Quantity": 120000.0,
        "LeadingMaterialPackage": null,
        "BatchId": "B567",
        "BatchMaterialPackage": null,
        "GreyZone": 0.0
      }
    ]
  },
  "Source": "Location 1",
  "FinalDestination": "Location 2",
  "StartedBy": "MaterialTower1",
  "Priority": 2,
  "TargetDeliveryTime": "2024-11-12T15:13:54.4355998+01:00"
}
Public classCreateTransportOrderResponse

** NOTE: ADDED in CFX 2.0 **

Message response for a corresponding transport order request.
Copy
{
  "TransportOrderId": "T123456",
  "FleetManagerTransportOrderId": "FL12345",
  "Result": {
    "Result": "Success",
    "ResultCode": 0,
    "Message": "Ok"
  }
}
Public classGetTransportOrderStatusRequest A request to an endpoint (such as an upper level system, MES, ERP, etc.) to check the status of a particular transport order. A transport order is a directive to move materials / WIP / production units from one location to another.
Copy
{
  "TransportOrderId": "TR329483249830000"
}
Public classGetTransportOrderStatusResponse A response to a request to an endpoint (such as an upper level system, MES, ERP, etc.) to check the status of a particular transport order.
Copy
{
  "Result": {
    "Result": "Success",
    "ResultCode": 0,
    "Message": "OK"
  },
  "TransportOrderId": "TR329483249830000",
  "FinalDestination": "LINE 1",
  "Status": "Delivered",
  "History": [
    {
      "EventDateTime": "2017-11-01T11:55:00",
      "Status": "Kitting",
      "Operator": {
        "OperatorIdentifier": "BADGE4485",
        "ActorType": "Human",
        "LastName": "Smith",
        "FirstName": "Bill",
        "LoginName": "bill.smith@domain1.com"
      },
      "Location": "STOCK ROOM 1",
      "Comments": null
    },
    {
      "EventDateTime": "2017-11-01T14:25:00",
      "Status": "Kitted",
      "Operator": {
        "OperatorIdentifier": "BADGE4485",
        "ActorType": "Human",
        "LastName": "Smith",
        "FirstName": "Bill",
        "LoginName": "bill.smith@domain1.com"
      },
      "Location": "STOCK ROOM 1",
      "Comments": null
    },
    {
      "EventDateTime": "2017-11-01T15:45:00",
      "Status": "InTransit",
      "Operator": {
        "OperatorIdentifier": "BADGE4485",
        "ActorType": "Human",
        "LastName": "Smith",
        "FirstName": "Bill",
        "LoginName": "bill.smith@domain1.com"
      },
      "Location": "STOCK ROOM 1",
      "Comments": null
    },
    {
      "EventDateTime": "2017-11-01T16:55:00",
      "Status": "InTransit",
      "Operator": {
        "OperatorIdentifier": "BADGE4486",
        "ActorType": "Human",
        "LastName": "Doe",
        "FirstName": "John",
        "LoginName": "john.doe@domain1.com"
      },
      "Location": "SMT STAGING AREA 1",
      "Comments": null
    },
    {
      "EventDateTime": "2017-11-01T17:22:00",
      "Status": "Delivered",
      "Operator": {
        "OperatorIdentifier": "BADGE4487",
        "ActorType": "Human",
        "LastName": "Dolittle",
        "FirstName": "Mike",
        "LoginName": "mike.dolittle@domain1.com"
      },
      "Location": "LINE1",
      "Comments": null
    }
  ]
}
Public classStartTransferRequest

** NOTE: ADDED in CFX 2.0 **

This message informs a machine that an AMR has arrived at its location and materials can be transferred from/to the AMR to/from the machine
Copy
{
  "TransportOrderId": "T789012",
  "RelatedWorkOrderId": "WO000567",
  "Materials": {
    "TransportedTools": [
      {
        "UniqueIdentifier": "ID000234",
        "Name": "Tool 1"
      },
      {
        "UniqueIdentifier": "ID000567",
        "Name": "Tool 2"
      }
    ],
    "TransportedMaterialPackages": [
      {
        "UniqueIdentifier": "ID0AB123C",
        "InternalPartNumber": "PN12345",
        "InternalPackageName": "Package components type 1",
        "Quantity": 100000.0,
        "LeadingMaterialPackage": null,
        "BatchId": "B123",
        "BatchMaterialPackage": null,
        "GreyZone": 0.0
      },
      {
        "UniqueIdentifier": "ID0ZW234X",
        "InternalPartNumber": "PN67890",
        "InternalPackageName": "Package components type 2",
        "Quantity": 120000.0,
        "LeadingMaterialPackage": null,
        "BatchId": "B567",
        "BatchMaterialPackage": null,
        "GreyZone": 0.0
      }
    ]
  },
  "StartedBy": "Jon Doe"
}
Public classStartTransferResponse

** NOTE: ADDED in CFX 2.0 **

This message is the response to the corresponding StartTransferRequest
Copy
{
  "TransportOrderId": "T789012",
  "Result": {
    "Result": "Failed",
    "ResultCode": 99,
    "Message": "Failed to transfer - operation error"
  }
}
Public classTransportOrderCompleted Sent when a transport order has arrived at its final destination.
Copy
{
  "TransportOrderId": "TR329483249830000",
  "Comments": "Received at Line 1",
  "AcceptedBy": {
    "OperatorIdentifier": "BADGE4487",
    "ActorType": "Human",
    "LastName": "Dolittle",
    "FirstName": "Mike",
    "LoginName": "mike.dolittle@domain1.com"
  },
  "RelatedWorkOrderId": "WO2384702937403280032",
  "FinalDestination": "LINE 1"
}
Public classTransportOrderStarted Sent when a new transport order is initiated. A transport order is a directive to move materials / WIP / production units from one location to another.
Copy
{
  "TransportOrderId": "TR329483249830000",
  "StartedBy": {
    "OperatorIdentifier": "BADGE4485",
    "ActorType": "Human",
    "LastName": "Smith",
    "FirstName": "Bill",
    "LoginName": "bill.smith@domain1.com"
  },
  "Comments": "Initiating new transport order.  Waiting to be kitted.",
  "Status": "Pending",
  "RelatedWorkOrderId": "WO2384702937403280032",
  "Source": null,
  "FinalDestination": "LINE1",
  "NextCheckpoint": "SMT STAGING AREA 1",
  "Materials": []
}
Public classTransportOrderStatusChanged Sent when the status of an existing transport order has changed.
Copy
{
  "TransportOrderId": "TR329483249830000",
  "Comments": "Kitting Underway...",
  "Status": "Kitting",
  "UpdatedBy": {
    "OperatorIdentifier": "BADGE4485",
    "ActorType": "Human",
    "LastName": "Smith",
    "FirstName": "Bill",
    "LoginName": "bill.smith@domain1.com"
  },
  "RelatedWorkOrderId": "WO2384702937403280032",
  "Source": null,
  "FinalDestination": "LINE 1",
  "NextCheckpoint": "SMT STAGING AREA 1"
}