42Q-MES0085-C Conduit Command Appendix

From 42Q
Revision as of 23:57, 30 October 2020 by Marisol vargas (talk | contribs)
Jump to navigation Jump to search

42Q Home > Conduit > Conduit Command Appendix
Sanmina logo.png

 

Conduit
Conduit Command Appendix
Version MES15 Portal 1.10
Work Instruction

 

This Work Instruction is 42Q's corporate standard.
This document is under revision control. The latest revision is located on Intranet.
Once printed it is an uncontrolled copy. All alterations to this work instruction require approval.
Contact the IT Global Education and Training Department to submit suggested alterations and or updates.

 

This edition applies to MES15 Portal 1.0 and all subsequent releases and modifications until otherwise indicated in new revisions.

Contents

 

 

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

AddNontrackedComponent is very similar to ADCMP2 command in SFDC, in that an assembly record is not used. It adds the component and only updates the old component record from 'removed' to 'replaced' if it finds a removed nontracked component with the same ref_designator on the serial.

AddNontrackedComponentTo

Adds a non-tracked component to the specified unit. It is exactly the same as AddNonTrackedComponent, except that it does not require a scanned unit, only a serial number.

Warning: Using either of these AddNontrackedComponent/To commands multiple times for a given serial and ref_designator can result in multiple active components with the same ref_designator. In order to remove and replace an existing component for a serial/ref_designator, so that only one is active, you must use the ReplaceNontrackedComponent/To the version of these commands. 

AddToLot

Adds the scanned unit serial number to the specified lot.

AddTrackedComponent

'A'ddTrackedComponent is very similar to ADCMP3 command in SFDC, in that an assembly record is not used. It adds the component and only updates the old component record from 'removed' to 'replaced' if it finds a removed tracked component with the same ref_designator on the serial.

AddTrackedComponentTo

Adds a tracked component to the specified unit. It is exactly the same as AddTrackedComponent, except that it does not require a scanned unit, only a serial number.

Warning: Using either of these AddTrackedComponent/To commands multiple times for a given serial and ref_designator can result in multiple active components with the same ref_designator. In order to remove and replace an existing component for a serial/ref_designator, so that only one is active, you must use theReplaceTrackedComponent/To the version of these commands. 

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.

AssignUnitsToNextShopOrder

Assign the specified set of unit serial numbers to the oldest eligible shop orders.

 

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.

D

DeallocateStationMaterial

Deallocate any material for the specified part number at the specified location or the scanning location.

E

END

End is effectively identical to END in SFDC.

F

FindActiveShopOrder

Identify the active shop order for the mfg line associated with the location.

FindClientStations

Finds client stations.

FindNextStationUnit 

Finds the oldest unit at a station matching an optional part number and shop order number. The most recent unit at a station can be returned if LIFO (Last in, First out) is specified for the final parameter. 

FindPrinters

Identify the printers currently available to the label engine.

FindUnitActivity

Attempts to find the unit activity for the provided serial number and optional part number.

FindUnitAttribute

Find an attribute matching the specified name for the scanned unit. By default not finding the attribute is an ERROR condition but that can be overridden via parameter

L

LinkMedia

Links a media reference identifier to an existing activity for a serial 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

PrepareUnitContainer

Depending on the type of unit provided either create a container and add the specified unit to it or open the container in preparation for adding more units. This command can be supplied in place of a transaction unit. 

PrintDemoLabel

Print a demo label name for the currently scanned unit serial number to the specified print queue.

PrintLabel

Print HPE label.

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.

RecordMedia

Records a media activity against the scanned unit with the specified media reference identifier.

RegexMatch

Applies the provided regular expression to the specified value returning OK if it matches and either or NO-OP as specified.

RegexReplace

Replaces substrings that match the regular expression with the replacement string.

RejectIfDefective

Moves scanned unit to the relevant failure location if any unrepaired defects exist on that unit at all, otherwise, do nothing. 

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.

RenderLabel

Signal the label engine service to render a printable label and download it to a local temporary file. Note: the downloaded file is only guaranteed to exist for the duration of the request session.

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.

StoreMedia

Uploads the contents of the specified media file or parameter to the media service for long-term storage.

U

UnitActivity

Returns the unit history for the scanned unit.

V

ValidateDate

Validate the specified date within the specified date range.

ValidateTimeStamp

Validate the specified timestamp is within the date range.

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 Corrected and updated Revision History to reflect current convention.
04/03/18 Elaine Fonaro Technical Writer B Applied new Template for the format.
05/06/19 Mildred Rodriguez Technical Writer B1 RejectIfDefective command added.
05/26/2020 Marisol Vargas  Technical Writer  B3

Added the following New commands: AssignUnitsToNextShopOrderDeallocateStationMaterial, FindActiveShopOrder, FindPrinters, FindUnitAttribute, LinkMedia, PrepareUnitContainer, PrintLabel, RecordMedia, RegexMatch, RegexReplace, RenderLabel, StoreMedia, ValidateDate, ValidateTimeStamp

09/28/2020 Marisol Vargas  Technical Writer B4 Added the following New commands: AddToLot and FindNextStationUnit
10/15/2020 Marisol Vargas  Technical Writer B5

Updated AddNontrackedComponent and AddNontrackedComponentTo and Warning added

10/30/2020 Marisol Vargas Technical Writer C Updated Revision History
Retrieved from "https://42qrpt1.42-q.com/mes_wiki/index.php?title=42Q-MES0085-C_Conduit_Command_Appendix&oldid=35337"