42Q-MES0085-C Conduit Command Appendix
42Q Home > Conduit > Conduit Command Appendix
This edition applies to MES15 Portal 1.0 and all subsequent releases and modifications until otherwise indicated in new revisions.
Contents
- 1 Command Appendix Registry
- 1.1 A
- 1.1.1 AddAttribute
- 1.1.2 AddAttributeTo
- 1.1.3 AddComment
- 1.1.4 AddCommentTo
- 1.1.5 AddDefinedAttribute
- 1.1.6 AddMeasurementKey
- 1.1.7 AddMeasurementKeyTo
- 1.1.8 AddNontrackedAssemblyComponent
- 1.1.9 AddNontrackedComponent
- 1.1.10 AddNontrackedComponentTo
- 1.1.11 AddTrackedComponent
- 1.1.12 AddUniqueComponent
- 1.1.13 AddUniqueAssemblyComponent
- 1.1.14 AddUnitToContainer
- 1.1.15 AddUnitToLot
- 1.1.16 AdvancedShopOrderUnits
- 1.1.17 ApplyMeo
- 1.2 C
- 1.2.1 ChangePartNumber
- 1.2.2 ChangeRevision
- 1.2.3 ChangeSerialNumber
- 1.2.4 ClearMatchingAttributes
- 1.2.5 ClearNonmatchingAttributes
- 1.2.6 CloseContainer
- 1.2.7 CloseLot
- 1.2.8 ConsumeNonSerialized Batch
- 1.2.9 ConsumeSitBatch
- 1.2.10 CreateBatchSerial
- 1.2.11 CreateContainer
- 1.2.12 CreateGeneratedBatchSerial
- 1.2.13 CreateLot
- 1.2.14 CreateUnit
- 1.3 E
- 1.4 F
- 1.5 M
- 1.6 O
- 1.7 P
- 1.8 R
- 1.8.1 ReconcileComponentMFGHolds
- 1.8.2 RecordDefect
- 1.8.3 RejectIfMissingAttribute
- 1.8.4 RejectIfMissingAttributes
- 1.8.5 RejectIfMissingComponents
- 1.8.6 RejectIfMissingProcessAttributes
- 1.8.7 RemoveAllComponents
- 1.8.8 RemoveAttribute
- 1.8.9 RemoveComponent
- 1.8.10 RemoveComponentFrom
- 1.8.11 RemoveProcesAttributes
- 1.8.12 RemoveProcessComponents
- 1.8.13 RemoveUnitFromContainer
- 1.8.14 RemoveUnitFromLot
- 1.8.15 RepairDefect
- 1.8.16 ReplaceAttribute
- 1.8.17 ReplaceAttributeOn
- 1.8.18 ReplaceComponent
- 1.8.19 ReplaceComponentAt
- 1.8.20 ReplaceConsumedNonSerializedBatch
- 1.8.21 ReplaceNontrackedAssemblyComponent
- 1.8.22 ReplaceNontrackedComponent
- 1.8.23 ReplaceNontrackedComponentAt
- 1.8.24 ReplaceNontrackedComponentOn
- 1.8.25 ReplaceTrackedAssemblyComponent
- 1.8.26 ReplaceTrackedComponent
- 1.8.27 ReplaceTrackedComponentAt
- 1.8.28 ReplaceUniqueComponent
- 1.8.29 ReplaceUniqueComponentAt
- 1.9 S
- 1.10 U
- 1.11 V
- 1.1 A
- 2 Conduit Command Listing
- 3 Document Revision History
Command Appendix Registry
The commands defined within the Conduit Command Registry represent the core functionality of the Conduit system. Unlike with legacy systems, Conduit commands are full words, generally Pascal case (though technically command names are case insensitive.)
In addition to the more extensive names, Conduit Commands tend to be more focused toward a single concept. Most Conduit commands expect all of their data to be provided up front, leaving the work of gathering that data to the various client implementations in conjunction with the CCRS.
The commands referencing Assembly or Defined components and attribute respectively are designed for use with the Scanning Template mechanism in Conduit. The basic concept is that the actual command to use (tracked, unique, nontracked, etc.) will be provided by Conduit. Individual clients only need to prompt for the appropriate piece of data to satisfy the scan template then construct a Client Command from the Scan Template + user input.
The full list of commands and a short explanation of each are given below:
A
AddAttribute
Add Attribute does not have an equivalent in SFDC. It is effectively the equivalent of ADCMP2 but for an attribute. It allows adding an attribute for which a definition did not already exist.
AddAttributeTo
Adds an attribute to the specified unit serial number. This command will produce an error if the attribute already exists, no replacement will occur. Similar to ADCMP2 for non-tracked components in SFDC this command does not require an existing attribute definition
AddComment
Adds a comment checked against an optional mask to the scanned unit. Add Comment is equivalent to ADCOMMENT in SFDC.
AddCommentTo
Adds a comment checked against an optional mask to the specified unit. Equivalent to ADCOMMENT in SFDC.
AddDefinedAttribute
Add Defined Attribute is equivalent to ATTADD in SFDC. Unlike SFDC it is designed to be used with the Conduit “Scanning Template” construct for units that have active / unreconciled Assembly / Attr_Def entries. AddMeasurementKey Add Measurement Key is equivalent to MEASKEY in SFDC.
AddMeasurementKey
Adds a measurement key to the scanned unit. Equivalent to MEASKEY in SFDC.
AddMeasurementKeyTo
Adds a measurement key to the specified unit. Equivalent to MEASKEY in SFDC.
AddNontrackedAssemblyComponent
Add Nontracked Assembly Component is a “Scanning Template” specific command for adding a non-tracked component based on an unreconciled assembly record for a unit. It is equivalent to ADCMP
AddNontrackedComponent
Add Nontracked Component is effectively identical to ADCMP2 AddTrackedAssemblyComponent Add Tracked Assembly Component is the tracked version of the Scanning Template enabled ADCMP command in SFDC.
AddNontrackedComponentTo
Adds a non-tracked component to the specified unit. Unlike Add Non-Tracked Component this does not require a scanned unit. This command will not replace an existing unremoved component with that component id but it will mark a previously removed component as replaced.
AddTrackedComponent
Add Tracked Component is equivalent to ADCMP3 in SFDC.
AddUniqueComponent
Adds a non-tracked component to the specified unit. Unlike Add Non-Tracked Component this does not require a scanned unit. This command will not replace an existing unremoved component with that component id but it will mark a previously removed component as replaced.
AddUniqueAssemblyComponent
Add Unique Assembly Component is the unique component version of the Scanning Template enabled ADCMP command in SFDC. AddUniqueComponent Add Unique Component has no corollary in SFDC today. It is designed to add a unique component without a predefined assembly record just like ADCMP2 (non-tracked) or ADCMP3 (tracked). AddUnitToContainer Add Unit To Container has no equivalent command in SFDC. SFDC Containerization essentially does the same thing via complicated mini-sessions executed after NEWCNTNR / OPENCNTNR.
AddUnitToContainer
Adds provided unit serial number to the scanned container serial.
AddUnitToLot
Add Unit To Lot has no equivalent command in SFDC. SFDC “Lotization” is handled via cumbersome sessions within NEWLOT / OPENLOT.
AdvancedShopOrderUnits
Ends up to <unit limit> units for the supplied shop order number at the provided workstation. Units are chosen in FIFO order for the specified workstation. This command can be executed without a transaction unit.
ApplyMeo
Apply Meo is equivalent to ADMEO.
C
ChangePartNumber
Change Part Number is equivalent to CHGPN.
ChangeRevision
Change Revision is equivalent to CHGREV.
ChangeSerialNumber
Change Serial Number is equivalent to CHGID.
ClearMatchingAttributes
Clear Matching Attributes is designed to remove attributes that match a particular input. It is equivalent to CLRATT.L.
ClearNonmatchingAttributes
Clear Non-Matching Attributes is designed to remove attributes that do NOT match a particular input. It is equivalent to CLARATT.R.
CloseContainer
Close Container is equivalent to CLOSECNTNR.
CloseLot
Close Lot is equivalent to CLOSELOT.
ConsumeNonSerialized Batch
Consume non serialized batch consumes non serialized batches.
ConsumeSitBatch
Consume the specified quantity from the provided Sit Batch serial and add a non-tracked component matching the sit batch serial number to the scanned unit at the specified reference designator.
CreateBatchSerial
Creates a Batch Serial number with the provided serial number, batch quantity and shop order number. Can be executed in place of a transaction unit. Roughly equivalent to CRE8BSN in SFDC.
CreateContainer
Create Container creates a container serial number. Unlike NEWCNTNR it does not immediately initiate prompting for container units. It only creates a container.
CreateGeneratedBatchSerial
Creates a batch serial using the supplied quantity and shop order number. The actual batch serial number will be generated using provided algorithm. Can be executed in place of a transaction unit.
CreateLot
Create Lot creates a lot serial number. Unlike NEWLOT it does not initiate prompting for lot units. It only creates a lot.
CreateUnit
Create Unit is a command used to create a new unit.
E
END
End is effectively identical to END in SFDC.
F
FindClientStations
Finds client stations.
FindUnitActivity
Attempts to find the unit activity for the provided serial number and optional part number.
M
MergeBatchSerial
Merge the provided batch serial number into the scanned batch unit.
MOVE
Effectively identical to MOVE in SFDC.
O
OpenContainer
Changes the status of a container to Open. Does not initiate container serial scanning like OPENCNTR.
OpenLot
Changes the status of a lot to Open. Does not initiate lot serial scanning like OPENLOT.
P
PrintDemoLabel
Print a demo label name for the currently scanned unit serial number to the specified print queue.
Print Label
Prints labels. Tied to the label set up in Production --> Label Engine Labels.
Print Legacy Label
Prints MES labels.
R
ReconcileComponentMFGHolds
Traverses the entire component tree and checks to see if a component serial is on hold. RecordDefect Records a defect against a unit. Equivalent to RCDFC in SFDC.
RecordDefect
Records a defect against the scanned unit. Equivalent to RCDFC in SFDC.
RejectIfMissingAttribute
Fails a unit that is missing the provided attribute. Equivalent to VERATT.LIST.
RejectIfMissingAttributes
Fails a unit that is missing any configured attributes. Equivalent to VERATT.ALL.
RejectIfMissingComponents
Fails a unit that is missing any assembly components. Unlike VERCMP this command has to be provided with a failure location just like Reject if Missing Attribute[s] (VERATT).
RejectIfMissingProcessAttributes
Fails a unit that is missing any attributes matching the current scanning location’s process. Effectively equivalent to VERATT.PROC.
RemoveAllComponents
Removes all components from a unit. Equivalent to RMCMPALL.
RemoveAttribute
Removes an attribute. Similar to ATTREMOVE but the specific attribute must be provided.
RemoveComponent
Removes a component. Similar to RMCMP2.
RemoveComponentFrom
Removes a component of any type matching the provided <component id> from the specified unit.
RemoveProcesAttributes
Removes any attributes defined for addition at the provided process from the scanned unit.
RemoveProcessComponents
Removes any components defined for addition at the provided process from the scanned unit.
RemoveUnitFromContainer
Removes a unit from a container. Equivalent to RMVFRMCNTNR.
RemoveUnitFromLot
Removes a unit from a lot. Equivalent to RMVFRMLOT.
RepairDefect
Repair a defect on a unit. Similar to RCRPR but the defect sequence to be repaired must be provided.
ReplaceAttribute
Replace an existing attribute with a new attribute.
ReplaceAttributeOn
Replaces an attribute (if one exists) and adds one to the specified unit serial number. Similar to ADCMP2 for non-tracked components in SFDC this command does not require an existing attribute definition.
ReplaceComponent
Replaces a component at the provided <component id> on the scanned unit with a new component. Equivalent to RPCMP2 in SFDC.
ReplaceComponentAt
Replaces a component at the provided <reference designator> on the scanned unit with a new component.
ReplaceConsumedNonSerializedBatch
Replaces consumed non serialized batches.
ReplaceNontrackedAssemblyComponent
Replace a previously existing “Scanning Template” non-tracked component with a new one.
ReplaceNontrackedComponent
Replace a previously existing non-tracked component; equivalent to RPCMP2.
ReplaceNontrackedComponentAt
Replaces an existing non-tracked component with a matching <reference designator> (if one exists) and adds a new non-tracked component.
ReplaceNontrackedComponentOn
Replaces an existing non-tracked component on the specified unit serial number with a matching <component id> (if one exists) and adds a new non-tracked component.
ReplaceTrackedAssemblyComponent
Replace a preexisting “Scanning Template” tracked component with a new one.
ReplaceTrackedComponent
Replace a previously existing tracked component, effectively equivalent to RPCMP2.
ReplaceTrackedComponentAt
Replaces an existing tracked component with a matching <reference designator> (if one exists) and adds a new tracked component.
ReplaceUniqueComponent
Replace a preexisting unique component. SplitPanel Effectively equivalent to SPLTP. ViewComponents Equivalent to VWCMP. ViewDefects Effectively equivalent to VWDFC. ViewHistory Effectively equivalent to VWHST.
ReplaceUniqueComponentAt
Replaces an existing unique component with a matching <reference designator> (if one exists) and adds a new unique component. Because these are unique components the associated serial records will be deleted / created during this operation.
S
SampleUnit
Samples a unit based upon a configured sample master / plan. The unit will either be moved to the sample location if eligible or Ended (passed / failed) to the next location in the route.
SplitBatchSerial
Splits the provided quantity number of components from the scanned batch unit. The split batch will be created using the supplied serial number.
SplitGeneratedBatchSerial
Splits the provided quantity number of components from the scanned batch unit. The split batch will be created using a serial number generated from the supplied algorithm.
SplitPanel
Splits the scanned unit (panel) using the provided serial number and quantity. Equivalent to SPLTP in SFDC.
U
UnitActivity
Returns the unit history for the scanned unit.
V
ViewComponents
SFDC data collector formatted components for the scanned unit.
ViewDefects
SFDC data collector formatted unrepaired defects for the scanned unit.
ViewHistory
SFDC data collector formatted unit history for the scanned unit.
Conduit Command Listing
Every command currently available can be found at the following URL:
https://42qconduit1.42-q.com:18006/ccr
Document Revision History
Date | Author | Title | Version | Change Reference |
01/26/17 | Benjamin Cavanaugh | Technical Writer | A | This is the first version of the Conduit Command Appendix. |
04/21/17 | Benjamin Cavanaugh | Technical Writer | A1 | Command list updated and URL fixed. |
06/14/17 | Elaine Fonaro | Technical Writer | A2 | Deleted LegacyCustomCommand. |
11/06/17 | Lucas Hopkins | Technical Writer | A3 | Updated Conduit Command Appendix Link |