The messages supported by each equipment profile capability are shown in the following table.

Event triggers

In the following descriptions of the CFX messages supported by the CFX Gateway, the diagrams showing the device tags required to support a CFX message include a generic "trigger" tag that represents the event triggers necessary to implement the desired handshake.

Each supported message may define four event triggers:

• xxTxTriggerSet
• xxRxTriggerSet
• xxTxTriggerReset
• xxRxTriggerReset

For example, for the CFX RecipeActivated message, the event triggers are:

• RATxTriggerSet

• RARxTriggerSet
• RATxTriggerReset
• RARxTriggerReset

CFX RecipeActivated message

Image Modified

Example 1
A single value on the device "recipename" identifies the recipe name, and a change in this value is required to trigger the CFX Gateway to issue this CFX message.

RARecipeName                         =TAG(recipename)
RATxTriggerSet                       =TAG(recipename) IS NOT NULL

RARxTriggerSet                       =
RATxTriggerReset                     =
RARxTriggerReset                     =

A single handshake is utilized.

Example 2
A value on the device "recipename" identifies the recipe name plus a second value is used for handshake purposes. A change in this handshake value to a value greater than zero is required to trigger the CFX Gateway to issue this CFX message.

RARecipeName                         =TAG(recipename)

RATxTriggerSet                       =TRIGGER(recipetrigger,0)>0
RARxTriggerSet                       =
RATxTriggerReset                     =
RARxTriggerReset                     =

A single handshake is utilized.

Example 3
A value on the device "recipename" identifies the recipe name, plus four values used for handshake purposes. A change in handshake value 1 (the TxTrigger) to a value greater than zero is required to trigger the CFX Gateway to read the data for this CFX message. A change in handshake value 1 (the TxTrigger) to a value of zero is required to trigger the CFX Gateway to send this CFX message. A second handshake value (the RxTrigger) is required to be set to a value of one to inform the device that the CFX Gateway has successfully received the message data, and to zero to inform the device that the CFX Gateway has successfully processed the message data.

RARecipeName                         =TAG(recipename)

RATxTriggerSet                       =TRIGGER(recipetxtrigger)>0
RARxTriggerSet                       =TRIGGERSET(reciperxtrigger,1)
RATxTriggerReset                     =TRIGGER(recipetxtrigger)=0
RARxTriggerReset                     =TRIGGERSET(reciperxtrigger,0)

A double handshake is utilized.

CFX ValidateUnitsRequest message

Image Modified

• The ValidationTypes identified in the CFX message result are UnitRouteValidation and UnitStatusValidation.
• If VURqPrimaryIdentifier is present in the equipment profile and VURqUnitIdentifier is not, and the VURqPrimaryIdentifier value is not present when this message is triggered, the CFX Gateway will not issue a CFX message. Rather, it immediately triggers the ValidateUnitsResponse response to the device with a result of ValidationStatus Failed.
• If VURqPrimaryIdentifier is not present in the equipment profile and VURqUnitIdentifier is, and not all the VURqPrimaryIdentifier values are present when this message is triggered, the CFX Gateway will not issue a CFX message. Rather, it immediately triggers the ValidateUnitsResponse response to the device with a result of ValidationStatus Failed.
• If VURqPrimaryIdentifier and VURqUnitIdentifier are both present in the equipment profile and one or more values are not present when this message is triggered, the CFX Gateway will not issue a CFX message. Rather, it immediately triggers the ValidateUnitsResponse response to the device with a result of ValidationStatus Failed.

CFX ValidateUnitsResponse message

Image Modified

It may be necessary to convert the VURsPrimaryResult value from a CFX Status value to one that the device understands. For example, a device may simply expect a result of zero when the validation fails, or a value of 1 when the validation is successful. To handle this value transformation, the VURsPrimaryResult message property should be defined using the ENUM function, as follows (assuming a result of Skipped will be treated as Passed by the device):

=ENUM(primaryresult,Passed:1|Failed:0|Skipped:1)

Example 1
The CFX Gateway receives the result of a validation request from the CFX recipient and needs to communicate this back to the device. Both trigger tags are zero by default, being set to 1 in order to trigger.

VURsPrimaryResult                  =ENUM(primaryresult, Passed:1| Failed:0| Skipped:1)

VURsTxTriggerSet                   =TRIGGERSET(vurstxtrigger,1,0)
VURsRxTriggerSet                   =
VURsTxTriggerReset                 =
VURsRxTriggerReset                 =

A single handshake is utilized.

Example 2
The CFX Gateway receives the result of a validation request from the CFX recipient and needs to communicate this back to the device. Both trigger tags are zero by default, being set to 1 in order to trigger.

VURsPrimaryResult                  =ENUM(primaryresult, Passed:1| Failed:0| Skipped:1)

VURsTxTriggerSet                   =TRIGGERSET(vurstxtrigger,1,0)
VURsRxTriggerSet                   =TAG(vursrxtrigger)>0
VURsTxTriggerReset                 =TRIGGERSET(vurstxtrigger,0,0)
VURsRxTriggerReset                 =TAG(vursrxtrigger)=0

A double handshake is utilized.

CFX WorkStarted message

This message can be used in a variety of ways depending on whether production is serialized, in panels or within a carrier, and what start and/or finish time information is provided. The following message properties may or may not be present in an equipment profile depending on the WIP settings.

Image Modified

CFX WorkStageStarted message

Image Modified

CFX UnitsTested message

This capability is only available under the following conditions:

• The WIP Tracking capability is selected.
• The Production Transaction Mode is Start and Finish.
• Either the Has Primary Identifier On Start option or the Has Unit Identifiers On Start option is selected.
• The Units Per Transaction value is greater than zero.

When an equipment profile for a device reporting test results is defined, the equipment profile identifies the number of tests to be captured (per unit) plus the number of measurements to be captured for each test. The number of tests that may be captured for a unit tested is any number from zero upward. The number of measurements that may captured for a test is any number from zero upward. The number of measurements captured for one test is independent from the number of measurements captured for another test.

Image Modified

• For tag names ending with "#", the "#"denotes the number of the unit for which test results are being captured.
• For tag names ending with "#-#", the first "#"denotes the number of the unit for which test results are being captured. The second "#"denotes the number of the test for a unit.
  For tag names ending with "###", the first "#"denotes the number of the unit for which test results are being captured. The second "#"denotes the number of the test for a unit, with the third "#" denoting the number of the measurement for a test.
• All "#" numbers are auto-assigned integer values, starting with "1" for the first unit, for the first test for a specific unit, and for the first measurement associated to a specific test.
• The UnitsTested message has result properties for a unit at three levels: an overall result, a result for each test, and a result for each measurement within a test. It is possible that a device may not be able to supply all these values, however, for a device to be turned Active all message properties are defined.

• Should a result not be available from the device (either as a tag value or as a logical expression based upon other result values such as determining the test result from a logical expression based upon the results of the measurements associated to the test), the default test result should be "hard-coded" in the tag expression as follows:
  
  

  =VALUE(Passed)

  
  

• If, when configuring a measurement, the UTMeasurementCRDs value can neither be sourced from the device nor hardcoded to a particular value it can be set to a NULL value by setting the tag expression as follows:
  
  

  =VALUE()

  
  

  Note
  icon false title Note:
  An expression must be defined if a tag is not able to be mapped by name, otherwise, the device cannot be activated.

  
  

CFX UnitsInspected message

This capability is only available under the following conditions:

• The WIP Tracking capability is selected.
• The Production Transaction Mode is Start and Finish.
• Either the Has Primary Identifier On Start option or the Has Unit Identifiers On Start option is selected.
• The Units Per Transaction value is greater than zero.

When an equipment profile for a device reporting inspection results is being defined, the equipment profile identifies the maximum number of defects to be captured (per unit). 

Image Modified

• For tag names ending with "#", the "#"denotes the number of the unit for which inspection results are being captured.
• For tag names ending with "#-#", the first "#"denotes the number of the unit for which inspection results are being captured. The second "#"denotes the number of the inspection for a unit.
• For tag names ending with "###", the first "#"denotes the number of the unit for which inspection results are being captured. The second "#"denotes the number of the inspection for a unit, with the third "#" denoting the number of the defect for an inspection.
• All "#" numbers are auto-assigned integer values, starting with "1" for the first unit, for the first inspection for a specific unit, and for the first defect associated to a specific inspection.
• The UnitsInspected message has result properties for a unit at three levels – an overall result, a result for each inspection, and a result for each defect within an inspection. It is possible that a device may not be able to supply all these values, however, for a device to be turned Active all message properties are defined.

• Should a result not be available from the device (either as a tag value or as a logical expression based upon other result values such as determining the inspection result from a logical expression based upon the results of the defects associated to the inspection), the default inspection result should be "hard-coded" in the tag expression as follows:
  
  

  =VALUE(Passed)

  
  

• If, when configuring a defect, the UIDefectCRDs value can neither be sourced from the device nor hardcoded to a particular value it can be set to a NULL value by setting the tag expression as follows:
  
  

  =VALUE()

  
  

• Any numbered defect where the device reports a defect code of empty string (when leading and trailing spaces are removed) results in that numbered defect not being included in the CFX generated and broadcast by the CFX Gateway.
  
  

  Note
  icon false title Note:
  Remember, an expression must be defined if a tag cannot be mapped by name, otherwise, the device isn't able to be activated.

  
  

CFX UnitsDisqualified message

This capability is only available under the following conditions:

• The WIP Tracking capability is selected.
• The Production Transaction Mode is Start and Finish.
• Either the Has Primary Identifier On Start option or the Has Unit Identifiers On Start option is selected.
• The Units Per Transaction value is greater than zero.

Image Modified

If two or more units are to be disqualified with different reasons, separate data transfers from the device are required: one data transfer per reason for disqualification, with each transfer identifying the units to which the disqualification reason applies.

CFX WorkStageCompleted message

Image Modified

CFX WorkCompleted message

Image Modified

Example 1

WIP settings (in Edit Device dialog):

Image Modified

• A device comprises a simple counter that is incremented as each "good' unit passes its sensor. As a trigger based on every change in this counter value would result in too many triggers of the CFX Gateway, the TIMER() function is used to trigger at a regular interval.
  
  

  WCUnitCount                          =TAG(counter,true,255) WCResult                             =0 WCTxTriggerSet                       =TIMER(10) WCRxTriggerSet                       = WCTxTriggerReset                    = WCRxTriggerReset                    =

  A single handshake is utilized.

  
  

Example 2

WIP settings (in Edit Device dialog):

WCPrimaryIdentifier                   =TAG(identifier)
WCResult                              =ENUM(status,Passed:0|Failed:1-20|Aborted:100|Skipped:-1)

CTxTriggerSet                         =TRIGGER(wipfinishtrigger,0)>0
WCRxTriggerSet                        =
WCTxTriggerReset                      =
WCRxTriggerReset                      =

A single handshake is utilized.

CFX ReadingsRecord message

Image Modified

• Any ReadingsRecorded CFX message issued by the CFX Gateway may or may not be associated with a WIP transaction.
• If a device triggers this message during a WIP transaction, the readings are recorded against the units in that WIP transaction.
• If a device triggers this message outside of a WIP transaction, the readings are recorded against the device.

CFX FaultOccurred message

Image Modified

All faults reported by the CFX Gateway are cached by the CFX Gateway so that they may cleared. This cache is not persistent.

Example 1
A simple device on a line exists to allow an operator to stop the line. This device comprises a single value used for handshake purposes. A change in this handshake value, to a value greater than zero, is required to trigger the CFX Gateway to issue this CFX message.

FOFaultSeverity                        =1
FOFaultCause                           =3
FOFaultCode                            =Operator-Actioned Line Stop

FOTxTriggerSet                         =TRIGGER(linestop,0)>0
FORxTriggerSet                         =
FOTxTriggerReset                       =
FORxTriggerReset                       =

A single handshake is utilized.

Each time this message is triggered, a CFX FaultOccurred message is issued where the Severity is Warning, the Cause is Safety Stop and the Code of "Operator-Actioned Line Stop".

Example 2
A device on a line reports faults that specify the severity, cause and a description, with a single value used for handshake purposes. A change in this handshake value to a value greater than zero is required to trigger the CFX Gateway to issue this CFX message.

FOFaultSeverity                        = ENUM(severity,

                                              Information:1|

                                              Warning:11-31|
                                              Error:0|
                                              Alarm:2-10,32-40)
FOFaultCause                           = ENUM(fault,

                                              SafetyStop:1|

                                              PowerFailure:0|
                                              ServicesFailure:2-10)
FOFaultCode                            =TAG(faultmessage)

FOTxTriggerSet                         =TRIGGER(faulttrigger,0)>0
FORxTriggerSet                         =
FOTxTriggerReset                       =
FORxTriggerReset                       =

A single handshake is utilized.

CFX FaultCleared message

The CFX standard is designed with the expectation that if a device reports a fault, it also explicitly reports when that fault has been cleared. The CFX Gateway is designed to allow a device to report multiple faults with a single notification from the device to signify that all faults have been cleared. Therefore, when a device reports a fault, the CFX Gateway issues the FaultOccurred message and cache the fault reported by a device.
When the faults-cleared notification is received, the CFX Gateway issues a FaultCleared message for each fault cached for the device, and then clear the faults cached for the device.

CFX LogEntryRecorded message

CFX StationStateChanged message

Example 1
A single value on the device "state" identifies its state, and a change in this value is required to trigger the CFX Gateway to issue this CFX message.

SSCState                                  = ENUM(state,

                                                 PRD:1|
                                                 SBY:0|
                                                 SBY_NoProduct:3|
                                                 SBY_NoProductBlocked:2|
                                                 SBY_NoProductStarved:8|
                                                 SDT:10-20|
                                                 USD:22)

SSCTxTriggerSet                          = TAG(state) IS NOT NULL
SSCRxTriggerSet                          =
SSCTxTriggerReset                        =
SSCRxTriggerReset                        =

A single handshake is utilized.

CFX UnitsTested message

The numbering of the measurement properties is denoted as:

<Circuit Position#><Test#><Measurement#>

...

where the number of the first measurement in a test is always 1.

• Initially, the configuration user interface is presented as follows:

Image Modified

• For a device where the Units Per Transaction value is set to 1, when you select the Image Modified  button, one test is added to the UI:

Image Modified

• For a device where the Units Per Transaction value is set to 2, when you select the Image Modified button, one test per unit is added to the UI:
  
  
  Image Modified
  
  

  Note
  icon false title Note:
  The ability to add and remove tests and measurements is restricted to those displayed for unit 1. This is intentional, in part to convey how the list of tests and measurements do not vary from unit to unit.

  
  

Examples

The following examples are for a device where the Units Per Transaction value is set to 1.

• When you select the Image Modifiedbutton (to the right of the Measurements label), one measurement is added to the first test:
  
  Image Modified
  

• When you select the Image Modifiedbutton again (to add another measurement), a second measurement is added to the first test:
  
  Image Modified
  
  
• When you select the Image Modifiedbutton again (to add another test), a second test is added after the measurements of the first test:
  
  Image Modified
  
  
• When you select the Image Modifiedbutton (to the right of the Measurements label under Test 2), one measurement is added to the second test:
  
  Image Modified
  
  
• When you select the Image Modified button beside a TestName, that test is deleted from the equipment profile, including all measurements of that test.
• When you select the Image Modified button beside a MeasurementName deletes that measurement from the test in which it is defined.
• When you delete a test or measurement, the numbering of the remaining tests and measurements is adjusted. Consider a situation where two tests were identified, and the first test was subsequently deleted. In this scenario, Test 2 is renamed to Test 1.

CFX UnitsInspected message

The numbering of the defect properties is denoted as:

<Circuit Position#>-<Defect#>

where the number of the first defect for a unit is always 1.

• Initially, the configuration user interface is presented as follows:
  
  Image Modified

• For a device where the Units Per Transaction value is set to 1, when you select the Image Modified button, one defect is added to the UI:
  
  Image Modified

• For a device where the Units Per Transaction value is set to 2, when you select the Image Modified button, one test per unit is added to the UI:
  
  Image Modified 
  
  
  

  Note
  icon false title Note:
  The ability to add and remove defects is restricted to those displayed for unit 1—this is intentional, in part to convey how the list of defects does not vary from unit to unit.

  
  

• This example pertains to a device where the Units Per Transaction value is set to 1. When you select the Image Modified button (to the right of the Defects label), one defect is added to each unit:
  
  Image Modified