GetLegalEqModules
The
GETLEGALEQMODULES
execute retrieves a list of phase-container-lot entries to be considered for manually binding or rebinding a phase step.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[GETLEGALEQMODULES( Item,UserID,PhaseName )] | ||
where: | Item | Item name as specified by the client. | |
UserID | User identification associated with this event. | ||
PhaseName | Unique hierarchical path name to the phase: Procedure Level: CreateID \t ProcedureName \t UnitProcName \t OperName \t PhaseName Unit Procedure Level: CreateID \t UnitProcName \t OperName \t PhaseName Operation Level: CreateID \t OperName \t PhaseName | ||
Action | A successful GETLEGALEQMODULES execute returns the alias name along with a list of names of the legal binding phase-container-lot entries for a phase step’s manual binding or rebinding. | ||
Return Format | The item populates with this data: SUCCESS:[ <StepData>, <EqModuleList>,<UseAutoBind> ] | FAIL: <message> | ||
where: | |||
<StepData> | is | <Material>,<Amount>,<MaterialEU>,<FeedType> | |
<EqModuleList> | is | <EqModule> | <EqModule>,<EqModuleList> | |
<EqModule> | is | <EqModuleName> , <ContainerName>, <Capacity> , <ContainerEU> , <LotName>, <Label> | |
<UseAutoBind> | is | "AUTOMATIC,,0,,,,PROMPT,,0,,,," | |
where: | |||
Field Name | Format | Description | |
<Material> | ASCII-String | Material name from the phase’s MATERIAL parameter. | |
<UseAutoBind> | ASCII-String | Data passed to client applications permitting the operator to manually instruct the phase to use Automatic Phase Binding. | |
<Amount> | ASCII-Integer | Material quantity to process from the phase’s AMOUNT parameter. This value is positive for a material addition and negative for a material distribution. | |
<MaterialEU> | ASCII-String | Engineering units for measuring the quantities of material. | |
<FeedType> | ASCII-String | String "ADD" or "DUMP" | |
<EqModule
Name> | ASCII-String | Phase name that could be selected for binding. | |
<ContainerName> | ASCII-String | Container name that could be selected for binding. | |
<Capacity> | ASCII-String | Material Addition: Material quantity available in the container. Material Distribution: Remaining storage capacity in a container. | |
<ContainerEU> | ASCII-String | Engineering units for measuring a container’s volume. | |
<LotName> | Name of the lot assigned to a specific material sublot in a container (if defined or known) - could be blank. | ||
<Label> | String label assigned to a sublot (if defined or known) - could be blank. | ||
The following table shows an example of the return on this execute.
Example: | An execute string consisting of: GETLEGALEQMODULES(Item, Station5\Operator,42 \t MCLS_SWEETCREAM_UP:1 \t MCLS_SWEETCREAM_OP:1 \t MBR_ADD:2) Requesting data from Item could return: SUCCESS:EGG_YOLK,750,KG,ADD,NP_ADDSWEET_M1,SUGAR_SHACK1,66625366,KG,SUGARCANELOT3, ,AUTOMATIC, ,0, , , ,PROMPT, ,0, , , , |
Provide Feedback