Click or drag to resize

CFX.Materials.Storage Namespace

Related to events that occur when materials are stored, including consumption. This includes not only stock areas, but also point-of-use workstations where materials are loaded during production.
Classes
 ClassDescription
Public classGetLoadedMaterialsRequest A request to a material storage endpoint to obtain a list of all the materials currently stored within the endpoint.
Copy
{
  "LocationIdentifiers": null
}
Public classGetLoadedMaterialsResponse A response to a request to a material storage endpoint to obtain a list of all the materials currently stored within the endpoint.
Copy
{
  "Result": {
    "Result": "Success",
    "ResultCode": 0,
    "Message": "SETUP OK"
  },
  "Materials": [
    {
      "LocationIdentifier": "5555646453",
      "LocationName": "SLOT45",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566556456",
        "InternalPartNumber": "IPN47788",
        "Quantity": 887.0
      },
      "CarrierInformation": {
        "UniqueIdentifier": "1233333",
        "Name": null
      }
    },
    {
      "LocationIdentifier": "5555646454",
      "LocationName": "SLOT50",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566554543",
        "InternalPartNumber": "IPN48899",
        "Quantity": 748.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": "123334",
        "BaseName": null,
        "LaneNumber": 1,
        "TapeWidth": 8.0,
        "TapePitch": 8.0,
        "UniqueIdentifier": "1233334",
        "Name": "TAPEFEEDER8mm1233334"
      }
    },
    {
      "LocationIdentifier": "5555646457",
      "LocationName": "92.1",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566589856",
        "InternalPartNumber": "IPN45577",
        "Quantity": 151.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTrayFeeder, CFX",
        "CellDimensionX": 17.0,
        "CellDimensionY": 17.0,
        "CellCountX": 8,
        "CellCountY": 3,
        "CellPitchX": 0.0,
        "CellPitchY": 0.0,
        "UniqueIdentifier": "1233337",
        "Name": "MATRIXTRAY1233337"
      }
    }
  ]
}
Public classMaterialCarriersLoaded Sent when a material carrier (typcially containing 1 or more material packages) is loaded at an endpoint.
Copy
{
  "Carriers": [
    {
      "LocationIdentifier": "5555646453",
      "LocationName": null,
      "CarrierInformation": {
        "UniqueIdentifier": "1233333",
        "Name": null
      }
    },
    {
      "LocationIdentifier": "5555646455",
      "LocationName": "LANEA",
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": "123335",
        "BaseName": "MULTILANEFEEDER123335",
        "LaneNumber": 1,
        "TapeWidth": 8.0,
        "TapePitch": 4.0,
        "UniqueIdentifier": "1233335A",
        "Name": "TAPEFEEDER8mm1233335A"
      }
    },
    {
      "LocationIdentifier": "5555646455",
      "LocationName": "LANEB",
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": "123335",
        "BaseName": "MULTILANEFEEDER123335",
        "LaneNumber": 2,
        "TapeWidth": 8.0,
        "TapePitch": 4.0,
        "UniqueIdentifier": "1233335B",
        "Name": "TAPEFEEDER8mm1233335B"
      }
    }
  ]
}
Public classMaterialCarriersUnloaded Sent when a material carrier (typcially containing 1 or more material packages) is unloaded at an endpoint.
Copy
{
  "CarrierIdentifiers": [
    "1233334",
    "1233334"
  ]
}
Public classMaterialsEmpty Sent when one or more material packages stored at a particular location become fully exhausted / depleted.
Copy
{
  "EmptyMaterials": [
    {
      "LocationIdentifier": "3245434554",
      "LocationName": "SLOT22",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT238908348903",
        "InternalPartNumber": "IPN-1222-55555",
        "Quantity": 0.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": null,
        "BaseName": null,
        "LaneNumber": 1,
        "TapeWidth": 8.0,
        "TapePitch": 8.0,
        "UniqueIdentifier": "234232432424",
        "Name": "FEEDER2245465"
      }
    },
    {
      "LocationIdentifier": "3245435784",
      "LocationName": "SLOT28",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT238908323434",
        "InternalPartNumber": "IPN-1222-11111",
        "Quantity": 0.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": null,
        "BaseName": null,
        "LaneNumber": 1,
        "TapeWidth": 8.0,
        "TapePitch": 4.0,
        "UniqueIdentifier": "234232432424",
        "Name": "FEEDER2245465"
      }
    }
  ]
}
Public classMaterialsLoaded Sent when a material package (potentially contained within a material carrier) is loaded at an endpoint.
Copy
{
  "Materials": [
    {
      "LocationIdentifier": "5555646453",
      "LocationName": "SLOT45",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566556456",
        "InternalPartNumber": "IPN47788",
        "Quantity": 887.0
      },
      "CarrierInformation": {
        "UniqueIdentifier": "1233333",
        "Name": null
      }
    },
    {
      "LocationIdentifier": "5555646454",
      "LocationName": "SLOT44",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566554543",
        "InternalPartNumber": "IPN48899",
        "Quantity": 748.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": "123334",
        "BaseName": null,
        "LaneNumber": 1,
        "TapeWidth": 8.0,
        "TapePitch": 8.0,
        "UniqueIdentifier": "1233334",
        "Name": "TAPEFEEDER8mm1233334"
      }
    },
    {
      "LocationIdentifier": "5555646455",
      "LocationName": "SLOT45",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566553421",
        "InternalPartNumber": "IPN45577",
        "Quantity": 151.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": "123335",
        "BaseName": "MULTILANEFEEDER123335",
        "LaneNumber": 1,
        "TapeWidth": 8.0,
        "TapePitch": 4.0,
        "UniqueIdentifier": "1233335A",
        "Name": "TAPEFEEDER8mm1233335A"
      }
    },
    {
      "LocationIdentifier": "5555646455",
      "LocationName": "SLOT45",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566555547",
        "InternalPartNumber": "IPN45577",
        "Quantity": 151.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
        "BaseUniqueIdentifier": "123335",
        "BaseName": "MULTILANEFEEDER123335",
        "LaneNumber": 2,
        "TapeWidth": 8.0,
        "TapePitch": 4.0,
        "UniqueIdentifier": "1233335B",
        "Name": "TAPEFEEDER8mm1233335B"
      }
    },
    {
      "LocationIdentifier": "5555646456",
      "LocationName": "SLOT46",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566588751",
        "InternalPartNumber": "IPN45577",
        "Quantity": 151.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTubeFeeder, CFX",
        "BaseUniqueIdentifier": "123336",
        "BaseName": null,
        "LaneNumber": 0,
        "Width": 12.0,
        "Pitch": 24.0,
        "UniqueIdentifier": "1233336",
        "Name": "TUBE1233336"
      }
    },
    {
      "LocationIdentifier": "5555646457",
      "LocationName": "92.1",
      "MaterialPackage": {
        "UniqueIdentifier": "MAT4566589856",
        "InternalPartNumber": "IPN45577",
        "Quantity": 151.0
      },
      "CarrierInformation": {
        "$type": "CFX.Structures.SMTPlacement.SMDTrayFeeder, CFX",
        "CellDimensionX": 17.0,
        "CellDimensionY": 17.0,
        "CellCountX": 8,
        "CellCountY": 3,
        "CellPitchX": 0.0,
        "CellPitchY": 0.0,
        "UniqueIdentifier": "1233337",
        "Name": "MATRIXTRAY1233337"
      }
    }
  ]
}
Public classMaterialsUnloaded Sent when a material package (potentially contained within a material carrier) is unloaded at an endpoint.
Copy
{
  "MaterialPackageIdentifiers": [
    "MAT4566556456",
    "MAT4566554543",
    "MAT4566553421",
    "MAT4566555547"
  ]
}
Public classSplicePointDetected Sent when an endpoint detects a splice point. A splice point is a juncture between two different material packages of the same part that have been pre-joined prior to loading at the material location, or were joined-in-place during production. Though the two materials are of the same part number, they may be of differing lots.
Copy
{
  "DepletedMaterial": {
    "LocationIdentifier": "3245434554",
    "LocationName": "SLOT22",
    "MaterialPackage": {
      "UniqueIdentifier": "MAT238908348903",
      "InternalPartNumber": "IPN-1222-55555",
      "Quantity": 0.0
    },
    "CarrierInformation": {
      "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
      "BaseUniqueIdentifier": null,
      "BaseName": null,
      "LaneNumber": 1,
      "TapeWidth": 8.0,
      "TapePitch": 8.0,
      "UniqueIdentifier": "234232432424",
      "Name": "FEEDER2245465"
    }
  },
  "NewlyActiveMaterial": {
    "LocationIdentifier": "3245435784",
    "LocationName": "SLOT28",
    "MaterialPackage": {
      "UniqueIdentifier": "MAT238908348904",
      "InternalPartNumber": "IPN-1222-55555",
      "Quantity": 1000.0
    },
    "CarrierInformation": {
      "$type": "CFX.Structures.SMTPlacement.SMDTapeFeeder, CFX",
      "BaseUniqueIdentifier": null,
      "BaseName": null,
      "LaneNumber": 1,
      "TapeWidth": 8.0,
      "TapePitch": 8.0,
      "UniqueIdentifier": "234232432424",
      "Name": "FEEDER2245465"
    }
  }
}
Public classValidateStationSetupRequest Request to a process endpoint to validate that the currently loaded materials comply with the setup requirements supplied in this request.
Copy
{
  "SetupRequirements": {
    "Lane": null,
    "Stage": null,
    "SetupName": "COMMONSETUP1",
    "MaterialSetupRequirements": [
      {
        "Position": "B1.F.45",
        "PartNumber": "IPN1123",
        "ApprovedAlternateParts": [
          "IPN2343",
          "IPN3432"
        ],
        "ApprovedManufacturerParts": [
          "MOT4329",
          "SAM5566"
        ]
      },
      {
        "Position": "B1.F.47",
        "PartNumber": "IPN1124",
        "ApprovedAlternateParts": [
          "IPN3344",
          "IPN3376"
        ],
        "ApprovedManufacturerParts": [
          "JP55443",
          "TX554323"
        ]
      }
    ],
    "ToolSetupRequirements": [
      {
        "Position": "MODULE1.BEAM1",
        "PartNumber": "HEADTYPE5566",
        "ToolIdentifier": null
      },
      {
        "Position": "MODULE1.BEAM2",
        "PartNumber": "HEADTYPE5577",
        "ToolIdentifier": null
      }
    ]
  }
}
Public classValidateStationSetupResponse Response to a request to a process endpoint to validate that the currently loaded materials comply with the setup requirements supplied by the request.
Copy
{
  "Result": {
    "Result": "Success",
    "ResultCode": 0,
    "Message": "SETUP OK"
  }
}