CFX. |
Root namespace for all data structures referenced by CFX messages.
Classes| Class | Description | |
|---|---|---|
 | ActiveRecipe | ** NOTE: ADDED in CFX 1.7 ** Represents a recipe active on a certain lane inside of a machine. This is equivalent to the information present in a RecipeActivated message but represented as a structure so that it can be included in the Heartbeat message. |
| Activity | Dynamic structure base class. Describes an activity that was performed in the course of processing one or more production units. Different endpoints may produce more specific structures derived from this generic Activity structure. |
| BadElectricalTestRejectionDetails | Describes details on an bad electrical test of a component |
| BadOpticalTestRejectionDetails | Describes details on a bad optical test |
| BadPressureTestRejectionDetails | Describes details on a bad pressure test |
| BadVisionTestRejectionDetails | Describes details on a bad vision test |
| BooleanMeasurement | Describes a measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit in which the result of the measurement is a boolean (true / fales) value. |
| Calibration | A dynamic structure describing a calibration event. |
| Camera | ** NOTE: ADDED in CFX 1.3 ** Camera resource in an Endpoint. It may have a lifecycle independent from the Endpoint where it is located (e.g. maintenance operations) |
| Characteristic | A singular characteristic that has been applied to a production unit |
| ComponentDesignator | Represents and identifies a particular component (instance of a part) on a production unit, or a particular aspect of a particular component, such as an individual pin of an electronic component. |
| ComponentElectricalTest | Describes details on an electrical test of a component |
| ComponentOpticalTest | Describes details on an optical test of a component |
| ComponentPressureTest | Describes details on a pressure test of a component |
| ComponentVisionTest | Describes details on a vision test of a component |
| ConsumedMaterial | Describes an event where material is consumed in the course of production. |
| Conveyor | ** NOTE: ADDED in CFX 1.3 ** Conveyor resource in an Endpoint. It may have a lifecycle independent from the Endpoint where it is located (e.g. maintenance operations) |
| Defect | Describes a defect that was discovered on a production unit |
| DimensionalConstraints | Describes the maximum and mininum dimensions and weight that a production unit is permitted to be in order to be processed at a particular endpoint. |
| ElectricCard | ** NOTE: ADDED in CFX 1.3 ** Electric card resource in an Endpoint. It may have a lifecycle independent from the Endpoint where it is located (e.g. maintenance operations) |
| Endpoint | Describes the details of a particular Endpoint that is participating in a CFX network. This is a dynamic structure. |
| EnvironmentalCondition | Describes an environmental condition that was in place when an action was performed. |
| Fault | A dynamic structure which describes a fault that has occurred in the course of production. May be one of: Fault, SMTPlacementFault, SMTSolderPastePrintingFault, or THTInsertionFault |
| FiducialInfo | ** NOTE: ADDED in CFX 1.4 ** This structure represents a Fiducial element. It is used to enrich the Unit information (e.g., CFX.Structures.UnitInfo){
"FiducialX": "10.2",
"FiducialY": 1.3,
"FiducialRXY": "0.5",
} |
| File | ** NOTE: ADDED in CFX 1.4 ** A data structure that represents a data file of any type. The file may be of a known MIME type, or a specialized type defined by CFX (like IPC-2581 / DPMX, for example). |
| Gantry | ** NOTE: ADDED in CFX 1.3 ** Gantry resource in an Endpoint. It may have a lifecycle independent from the Endpoint where it is located (e.g. maintenance operations) |
| GenericParameter | Structure that represents a generic named value parameter. |
| Head | Represents a generic head on an automated endpoint. This is the base class of a dynamic structure, permitting for specialized heads derived from this class. Examples of heads are SMT placement heads used in the placement of electronic components on PCB's, or a dispensing head, used in the dispensing of fluids or glues. |
| HermesInformation | Structure that contains information related to an Endpoint's support of the Hermes standard. |
| HermesUnit | ** NOTE: ADDED in CFX 1.3 ** Structure that contains information related to a Unit (Board) according to the Hermes standard. |
| Humidity | A type of environmental condition indicating moisture level |
| Image | A data structure that representing a two dimensional image, in the designated MIME format. |
| InspectedPanel | ** NOTE: ADDED in CFX 1.6 ** Describes the results of a series of inspections performed on a panel. |
| InspectedUnit | Describes the results of a series of inspections performed on a single production unit. |
| Inspection | Describes a single step in a series of steps that an inspector makes (both human or automation) in the course of inspecting a production unit. |
| InstalledComponent | Describes a particular location on a production unit where materials / parts were installed. |
| InstalledMaterial | Describes a single lot of material that was installed on a production unit, possibly in specific locations on the production unit. |
| LocationDetail | ** NOTE: ADDED in CFX 1.7 ** Describes detailed information about a particular location. This is a dynamic structure |
| LogEntryAdditionalData | ** NOTE: ADDED in CFX 1.4 ** A dynamic structure describing additional data for the LogEntryRecorded message |
| Magazine | ** NOTE: ADDED in CFX 1.3 ** Structure that contains information related to a magazine. |
| MaintenanceStatus | Maintenance status provides the information about the condition of a resource in a resource / machine. |
| MaintenanceTask | Represents a task that was performed during a maintenance operation. |
| MaterialCarrier | A dynamic structure which describes a device that is mounted at a process endpoint which contains source materials that are then consumed by the endpoint. An SMD Tape Feeder would be an example of a MaterialCarrier. This base MaterialCarrier structure is used to describe a generic carrier, when a more specific carrier location class is not available, such as SMDTapeFeeder, SMDTubeFeeder, and SMDTubeFeeder. |
| MaterialCarrierLocation | Describes a specific location on an endpoint where a material carrier may be loaded. When applicable, also contains information about the currently loaded carrier, and the material package(s) loaded to that carrer. |
| MaterialLocation | Describes a specific location on an endpoint where material may be loaded. Also includes information about the current contents of this location (if applicable). |
| MaterialPackage | Describes a specific, single handling unit of a particular material, such as a reel of SMT parts, a bag of parts, bin of parts, etc. |
| MaterialPackageData | An abstract base class from which dynamic material data structures derive. For example, MaterialPackageMSDData |
| MaterialPackageDetail | Describes detailed information about a particular material package (instance of material that is tracked, stocked, and used within the factory environment. |
| MaterialPackageMSDData | Describes addition detail for material packages containing moisture sensitive devices |
| MaterialSetupRequirement | Describes a single, specific material setup requirement at a particular process endpoint. Includes the material / part that must be loaded at the endpoint, along with the specific location where the material must be loaded (where applicable), valid alternate part numbers that may be substituted for the primary part, and any applicable AML (Approved Manufacturer List) restrictions. |
| Measurement | Abstract base class for dynamic data structure which describes a measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit |
| NamedObject | An object that can be identified by its name. |
| NonInstalledComponent | Describes a particular location on a production unit where materials / parts were not installed. |
| NumericMeasurement | Describes a numeric (floating point) measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit |
| NumericValue | A data structure that represents a numeric value with defined units and thresholds |
| OperatingRequirements | Structure that specifies the operating requirements (environmental, etc.) of a given endpoint. |
| Operator | Represents an operator who performs a function |
| PackagingInfo | ** NOTE: ADDED in CFX 1.5 ** Describes the packaging information of a material package. Abstract base class. |
| Parameter | An abstract base class for the Parameter dynamic structure. |
| PerformanceImpact | ** NOTE: ADDED in CFX 1.6 ** Performance impacts of a machine (i.e., in case of lower-than-expected performance) It shall be "null" or not sent at all if the machine doesn't support the PerformanceImpact attribute. An empty list indicates that the machine is running at "best-performance" |
| PersonalizedUnit | Describes how a particular production unit has been personalized |
| ProcessData | Dynamic data structure representing data that was collected during the processing of a production unit or collection of units. |
| ProcessedUnit | Structure representing a production units that has been processed at an endpoint involved in the processing of production units. |
| Reading | A data structure that represents a reading that was taken against a production unit or piece of equipment |
| Recipe | Represents a collection of instructions used by a piece of automated equipment to perform a function (typically upon a production unit) during production. |
| RecipeIdentifier | ** NOTE: ADDED in CFX 1.4 ** Represents a collection of instructions used by a piece of automated equipment to perform a function (typically upon a production unit) during production. The RecipeLean does not deliver the Recipe data but RecipeName and Revision only. For the full Recipe data, please see Recipe. |
| RecipeStageInformation | ** NOTE: ADDED in CFX 1.2 ** Describes some information about a recipe for a specific stage |
| Region | Describes a planar, 2 dimensional region as defined by a series of X, Y coordinates that when plotted, form the region. |
| Repair | ** NOTE: ADDED in CFX 1.4 ** Describes a single repair that was performed on a production unit in the course of rework and/or repair. |
| RepairedUnit | ** NOTE: ADDED in CFX 1.4 ** Describes the results of repairs performed on a single production unit. |
| RequestResult | A structure which indicates whether or not a CFX request to an endpoint was successful. If not successful, information about the nature of the failure is provided. |
| Resource | ** NOTE: ADDED in CFX 1.3 ** Describes the details of a particular Resource. This is a dynamic structure. |
| ResourceInformation | ** NOTE: ADDED in CFX 1.3 ** Dynamic structure that contains information related to the resources / sub-resources in an Endpoint. It may be used to model, among the others: camera, conveyor, gantries and other parts that may require traceable operations (i.e. maintenance) |
| ResourceLocation | ** NOTE: ADDED in CFX 1.7 ** Describes a resource location |
| RotationAxis | ** NOTE: ADDED in CFX 1.3 ** Rotation axis of the resource, typically the head in an Endpoint. It may have a meaning for the lifecycle of the resource, which may be independent from the Endpoint where it is located (e.g. maintenance operations) |
| SamplingInformation | Describes the sampling strategy to be employed on a particular lot of material / units during test or inspection |
| ScheduledWorkOrder | A data structure representing a Work Order that has been scheduled to be executed at a particular work area within the factory at a particular time. Includes all of the physical resources, tools, personnel, and materials that are required to execute the Work Order. |
| ScheduledWorkOrderIdentifier | Data structure which identifies a Work Order that has already been scheduled for production. |
| Segment | An X/Y coordinate that is used to define a planar region. |
| ShelfLocation | ** NOTE: ADDED in CFX 1.7 ** Describes a shelf location |
| SleepState | ** NOTE: ADDED in CFX 1.3 ** Definition of Sleep State |
| SMTRecipeStageInformation | ** NOTE: ADDED in CFX 1.5 ** Describes some information about a recipe for a specific stage, with more information for an SMT machine |
| Stage | A data structure that represents a work area or step within a production related endpoint through which production units flow |
| StageInformation | Describes a stage (zone) for an endpoint that is in a machine. |
| StationSetupRequirements | Describes the material setup requirements for a particular process endpoint to perform a particular operation on one or more partiuclar products. Also includes information on where specifically the materials should be loaded (when applicable), AML (where applicable), and alternate part information (where applicable). |
| SupportedTopic | A data structure that represents a CFX message topic that is supported by a particular CFX endpoint |
| Symptom | Describes a situation where a problem is identified via one or more failed tests. A symptom does not identify the actual cause of the failure(s), only that there is a problem that needs to be investigated. |
| Temperature | A type of environmental condition that represents thermal level |
| Test | Describes a single test in a series of test that an tester makes (both human or automation) in the course of testing a production unit. |
| TestedUnit | A data structure that represents a unit under test |
| TextMeasurement | Describes a measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit in which the result of the measurement is a text based value. |
| Tool |
Describes a tool that is used in production
{
"UniqueIdentifier": "UID23890430",
"Name": "SQUEEGEE234324"
} |
| ToolHolder | Describes a location on a process endpoint where a tool may be stored. |
| ToolSetupRequirement | Describes a single, specific tool that must be setup a particular process endpoint to execute a particular process. Includes the part number of the tool, along with the specific location where the tool loaded (when applicable). |
| ToolUsed | A data structure representing an occurrence where a Tool is utilized when processing a specific production unit |
| TransportOrderHistory | Describes a single event in the history of a transport order. A transport order is a directive to move materials / WIP / production units from one location to another. |
| UninstalledMaterial | Describes when single lot of material that is uninstalled from a production unit, possibly from specific locations on the production unit. |
| UnitAlignmentActivity | A specialized type of Activity that occurs when a unit is aligned (located / positioned) within a stage of an endpoint prior to the commencement of work. |
| UnitConveyingActivity | A specialized type of Activity that occurs when a unit is conveyed in an endpoint. |
| UnitInfo | ** NOTE: ADDED in CFX 1.4 ** This structure contains detailed information (e.g., BadMarks, Fiducials) about a one of a set of production units that are processed simultaneously under a single transaction by an endpoint. Units may be identified in one of two ways: 1. The UnitIdentifier property represents the actual unique identifier of the production unit. 2. The UnitIdentifier property represents the unique identifier of the "carrier" or "PCB panel" AND the PositionNumber property represents the position of the unit within the carrier/panel. PositionNumber's are established as defined in the CFX Standard.{
"UnitIdentifier": "CARRIER5566",
"PositionNumber": 1,
"PositionName": "CIRCUIT1",
"X": 0.254,
"Y": 0.556,
"Rotation": 0.0,
"FlipX": false,
"FlipY": false,
"BadMark": 0,
"FiducialCount": 2,
"Fiducials": [
{
"FiducialX": "10.2",
"FiducialY": 1.3,
"FiducialRXY": "0.5"
},
{
"FiducialX": "20.8",
"FiducialY": 7.3,
"FiducialRXY": "0.0"
}
],
"CRDs" : []
} |
| UnitLoadActivity | A specialized type of Activity that occurs when a unit is loaded into an endpoint. |
| UnitPosition |
This structure contains information about a one of a set of production units that are processed simultaneously under a single transaction by an endpoint.
Units may be identified in one of two ways:
1. The UnitIdentifier property represents the actual unique identifier of the production unit.
2. The UnitIdentifier property represents the unique identifier of the "carrier" or "PCB panel"
AND the PositionNumber property represents the position of the unit within the carrier/panel.
PositionNumber's are established as defined in the CFX Standard.
{
"UnitIdentifier": "CARRIER5566",
"PositionNumber": 1,
"PositionName": "CIRCUIT1",
"X": 0.254,
"Y": 0.556,
"Rotation": 0.0,
"FlipX": false,
"FlipY": false,
"Status": "Pass"
} |
| UnitUnloadActivity | A specialized type of Activity that occurs when a unit is unloaded from an endpoint. |
| VacuumPump | ** NOTE: ADDED in CFX 1.3 ** Vacuum pump resource in an Endpoint. It may have a lifecycle independent from the Endpoint where it is located (e.g. maintenance operations) |
| ValidationResult | Indicates the result of a validation that was performed on a given production unit (typically by a line or factory level control system) |
| WorkOrder | A structure that describes an order to produce a specifified quantity of units of a particular part number / part revision within the factory environment. |
| WorkOrderIdentifier | Uniquely identifies a particular Work Order (or Work Order sub-batch) |
Interfaces| Interface | Description | |
|---|---|---|
 | RejectionDetails | Describes details on a rejection of a component |
Enumerations| Enumeration | Description | |
|---|---|---|
 | AccessType | The Access Type is giving an indication for the line engineer if the fault, error or warning messages in the fault object can be handled via a remote terminal session to the equipment |
| ActivityState | Describes the state of an activity. |
| ActorType | Types of Operators |
| BlockReason | Reasons why a unit is blocked |
| CalibrationType | ** NOTE: ADDED in CFX 1.3 ** Types of calibrations |
| ComponentElectricalTestUnit | Unit used for an electrical test |
| DataType | Types of data |
| DisqualificationReason | Describes the reason why a production units was disqualified (scrapped) |
| FaultCause | Possible causes of a fault that may causes a stoppage in production |
| FaultSeverity | The severity of a fault |
| FileTransferDirection | ** NOTE: ADDED in CFX 1.4 ** Specifies the mode of file transfer. |
| FileTransferMode | ** NOTE: ADDED in CFX 1.4 ** Specifies the method of file transfer. [CLICK HERE](https://en.wikipedia.org/wiki/Out-of-band_data) for more information on transfer modes |
| FileType | ** NOTE: ADDED in CFX 1.4 ** Specifies the type of a file. |
| HazardousMaterialType | Specifies whether or not a material is hazardous, and if so, the regulatory directive that controls the use of this substance in production. |
| IdentiferUniquenessType | ** NOTE: ADDED in CFX 1.3 ** An enumeration indicating the type of unique identifier for the specified endpoint / resource / sub-resource Values: GloballyPersistent, LocallyPersistent, UnserializedLocation or Unknown |
| InspectionMethod | Method of testing |
| IssueStatus | ** NOTE: ADDED in CFX 1.4 ** An enumeration which describes the lifecycle of an issue, such as a Defect or Symptom |
| LockReason | Reason for a production lock condition |
| LogImportance | Importance of an event log entry |
| MaintenanceState | Possible Maintenance status. It is used in the response message, after the endpoint / resource has sent a status info request |
| MaintenanceType | Types of Maintenance |
| MaterialModifyReason | Reason why the attributes of a material package were modified |
| MaterialStatus | Status of a material package |
| MSDLevel | Levels of Moisture Sensitivity (for electronic devices) |
| MSDState | Possible states of packages of moisture sensitive devices |
| NonInstalledComponentLocation | Location of a non installed component |
| OperatingSystem | ** NOTE: ADDED in CFX 1.2 ** An enumeration indicating a computer operating system |
| OperatingSystemPlatform | ** NOTE: ADDED in CFX 1.2 ** An enumeration indicating the platform of a computer operating system |
| OperationStatus | Status of a performed operation, for example Calibration |
| PerformanceImpactCause | ** NOTE: ADDED in CFX 1.6 ** Possible causes of lower-than-expected performance, which a machine may be able to report as performance impacts |
| ProcessingResult | The overall result of processing performed on a production unit in the course of production. |
| RecipeModificationReason | Reasons why a recipe was modified at an endpoint |
| RejectionReason | Rejection reason |
| RepairResult | ** NOTE: ADDED in CFX 1.4 ** The result of a repair |
| ResourceState | Endpoint state model. Based on SEMI E10 and E58. |
| ResourceType | ** NOTE: ADDED in CFX 1.7 ** Describes a resource type |
| SamplingMethod | Describes a particular sampling methodology. |
| ShelfSideLocation | ** NOTE: ADDED in CFX 1.7 ** A Shelf side location |
| SideLocation | The Side location is giving an indication for the operator from which side in transport direction of the PCB unit the fault or error can be accessed and fixed. |
| StageType | An enumeration indicating different types of stages that might exist at an endpoint. |
| StatusResult | Result of an operation |
| SupportedTopicQueryType | Enumeration used for matching an endpoint's capabilities to a list of CFX topics. |
| Surface | ** NOTE: ADDED in CFX 1.3 ** For use two-dimensional production (as in the case of PCBA production). Identifies the surface of the unit under production (product) that is relevant for a given process or situation. |
| TestMethod | Method of testing |
| TestResult | The result of a test |
| TopicSupportType | Indicates the type of support an endpoint has for a particular topic. |
| TransportOrderStatus | The status of an order to transport goods |
| UninstalledReason | Reason why a component or material was uninstalled from a production unit |
| UnitStatus | ** NOTE: ADDED in CFX 1.5 ** The status condition of a Unit. |
| ValidationStatus | The result of a validation operation |
| ValidationType | Types of validations |
| ValueAddType | An enumeration describing the value-add nature of an activity or process. |
| VerificationResult | There is a certain workflow after the detection of a defective board. Usually a defective board has to be classified, i.e. an operator or process engineer has to confirm whether the inspection result is a real defect or a false fail (false call) error. The Verification Result is |
| WorkOrderActionState | ** NOTE: ADDED in CFX 1.2 ** Describes the state of a work order action. |
| WorkOrderActionType | ** NOTE: ADDED in CFX 1.2 ** Describes the type of action of a work order action. |
| WorkOrderStatus | Indicates the current status of a Work Order |
| WorkResult | The result of an operation where work was performed on a production unit |
| WorkStagePauseReason | Types of WorkStage pause reasons |