InfoTrimmed2
The
INFOTRIMMED2
execute retrieves the information necessary to format a Batch execute that is used to instantiate a batch. InfoTrimmed2
supports recipes with creation parameters from which MATERIAL, LOT, or LABEL parameters of material enabled phase steps were deferred.The format and return for this execute includes:
Execute Format | A FactoryTalk Bach Server supports an execute with this format: INFOTRIMMED2 (<Item>,<UserID>,<RecipeID><PhaseMaterialData> $PARMS<DeferredParameterValues>) | ||
where: | Item | Name of the response item as specified by the client. | |
UserID | User identification associated with this event. | ||
RecipeID | File name of the recipe. | ||
PhaseMaterialData | Optional list of Phase-Material pair data. | ||
$PARMS | The string literal "$PARMS", used as a separator between the PhaseMaterialData and DeferredParameterValue records. | ||
DeferredParameterValues> | List of parameter values for all recipe parameters to which MATERIAL, LOT, or LABEL parameters were deferred from material enabled phase steps. | ||
where: | |||
<PhaseMaterialData> | is | <NullList>
|,
<PhaseMaterialList> | |
<PhaseMaterialList> | is | <PhaseMaterialRecord>
|
<PhaseMaterialRecord>
,
<PhaseMaterialList> | |
<PhaseMaterialRecord> | is | <PhasePathName>
,
<MaterialName> | |
<DeferredParameterValues> | is | <NullList> | ,<ParameterValueList> | |
<ParameterValueList> | is | <ParameterValue> | <ParameterValue>,<ParameterValueList> | |
<ParameterValue> | is | <ParameterName>,<ParameterValue> | |
where: | |||
Field | Format | Description | |
PhasePathName | ASCII - String | Full recipe pathname to the phase. (for example, PROC_1\UNITPROC_1:1\OPER_1:3\ADD:4) | |
MaterialName | ASCII – String | Name of a material configured in the Material Server (for example, Milk). | |
ParameterName | ASCII – String | The name of a recipe parameter to which MATERIAL, LOT, or LABEL parameters were deferred from material enabled phase steps. | |
ParameterValue | ASCII – String | The value of the parameter to be assumed when processing the INFOTRIMMED2 execute. | |
Action | A successful INFOTRIMMED2 execute places the recipe information into the item field. | ||
Return Format | The response item populates with this data: <RecList>
| FAIL:
<FailData> | ||
where: | |||
<RecList> | is | <StepList> | |
<StepList> | is | <Step>
|
<Step> <StepList> | |
<Step> | is | <Alias>
\t
<UnitBindList>
\t
<BindFlag>
\crlf | |
<UnitBindList> | is | $UNITLIST \t
<UnitList>
\t $END | |
<UnitList> | <UnitName>
|
<UnitName>
\t
<UnitList> | ||
<FailData> | is | <message>
|
<ZeroTargets> | |
<ZeroTargets> | is | <ZeroTargsMarker>
\crlf
<ZeroTargsList> | |
<ZeroTargsList> | is | <ZeroTargs>
|
<ZeroTargs>
\crlf
<ZeroTargsList> | |
<ZeroTargs> | is | <ZeroTargsText> '
:'
<Alias>
\crlf
<UnitErrList>
\crlf
<EndUnitErrList>
\crlf
<BindReqList>
\crlf
<EndBindReqList>
\crlf
<ExprDataList>
\crlf
<EndZeroTargsData> | |
<UnitErrList> | is | <UnitErr>
|
<UnitErr>
/crlf
<UnitErrList> | |
<UnitErr> | is | <UnitIdLabel>
':'
<UnitID>
\t
<UnitNameLabel>
':'
<UnitName>
\t
<ReasonData> | |
<ReasonData> | is | <LegalReason>
|
<FPathReason>
|
<FPathRqmReason>
|
FPathMatReason>
|
<BindReqReason>
|
<MaterialReason>
|
<NotRecordedReason>
|
<InvalidReason> | |
<LegalReason> | is | <ReasonCodeLabel>
':'
<ReasonCode>
\t
<ReasonTextLabel>
':'
<ReasonText> | |
<FPathReason> | is | <ReasonCodeLabel>
':'
<ReasonCode>
\t
<ReasonTextLabel>
':'
<ReasonText> | |
<FPathRqmReason> | is | <ReasonCodeLabel> '
:'
<ReasonCode>
\t
<ReasonTextLabel> '
:'
<ReasonText> | |
<FPathMatReason> | is | <ReasonCodeLabel> '
:'
<ReasonCode>
\t
<ReasonTextLabel> '
:'
<ReasonText> | |
<BindReqReason> | is | <ReasonCodeLabel>
':'
<ReasonCode>
\t
<ReasonTextLabel>
':'
<ReasonText>'
:'
<BindRqmtID> | |
<MaterialReason> | is | <ReasonCodeLabel>
':'
<ReasonCode>
\t
<ReasonTextLabel> '
:'
<ReasonText>
\t
<MaterialLabel> '
:'
<Material>
\t
<LotLabel>
':'
<Lot>
\t
<LabelLabel>
':'
<Label>
\t
<UseCodeLabel>
':'
<UseCode>
\t
<UseTextlabel>
':'
<UseText>
\t
<StepLabel>
':'
<StepPath> | |
<NotRecordedReason> | is | <ReasonCodeLabel> ':' <ReasonCode> \t <ReasonTextLabel> ':' <ReasonText> | |
<InvalidReason> | is | <ReasonCodeLabel> ':' <ReasonCode> \t <ReasonTextLabel> ':' <ReasonText> | |
<BindReqList> | is | <BindReq> | <BindReq> /crlf <BindReqList> | |
<BindReq> | is | <BindReqID> ':' <BindReqText> | |
<ExprDataList> | is | <ExprData> | <ExprData> /crlf <ExprDataList> | |
<ExprData> | is | <ExprDataUnitIDLabel> ':' <ExprDataUnitID> /t <ExprDataUnitNameLabel> ':' <ExprDataUnitName> /t <ExprBindSpecIDLabel> ':' <ExprBindSpecID> /t <ExpressionValues> | |
<ExpressionValues> | is | <ExpressionValue> <LeafValuePairs> | |
<LeafValuePairs> | is | <NullList> | /t <LeafValueList> | |
<LeafValueList> | is | <LeafPair> | <LeafPair> /t <LeafValueList> | |
<LeafPair> | is | <LeafName> /t <LeafValue> | |
where: | |||
Field Name | Format | Description | |
FAIL: | ASCII - String | Keyword to indicate the InfoTrimmed2 execute encountered an error. | |
ASCII - String | Error message formatted appropriately for operator display. | ||
<Alias> | ASCII - String | Unit alias which requires binding. | |
<BindFlag> | ASCII - Integer | Integer value containing bits indicating what types of late binding are permitted: Bit1 = PROMPT Bit2 = FIRST AVAILABLE | |
$UNITLIST | ASCII - String | Indicates the beginning of the list of unit names that contain references to material-based phases. | |
$END | ASCII - String | Indicates the end of the list of unit names that contain references to material-based phases. | |
<UnitName> | ASCII - String | Name of the unit. | |
ZeroTargsMarker | ASCII - String | String constant "$ZEROLEGALBINDTARGSDATA" used to indicate that the response item contains data elaborating the reasons why there are zero legal bind targets for one or more Unit Requirements. | |
ZeroTargsText | ASCII - String | Localized displayable error message, indicating that the specified unit requirement (following the ':' character) has zero legal bind targets. | |
EndUnitErrList | ASCII - String | String constant "$ENDUNITDATA" marks the end of the set of Unit Instance legality records. | |
EndBindReqList | ASCII - String | String constant "$ENDBINDREQDATA" marks the end of the set of Binding Requirement records. | |
EndZeroTargsData | ASCII - String | String constant "$ENDUNITRQMTDATA" marks the end of a Unit Requirements expression data records (and the end of the Unit Requirement's data). | |
UnitIdLabel | ASCII - String | Non-localized English string label for the Unit ID that follows. | |
UnitId | ASCII - Integer | Integer value identifier of the Unit for which bind illegality describes. | |
UnitNameLabel | ASCII - String | Non-localized English string label for the Unit name that follows. | |
UnitName | ASCII - String | Name of the unit or which bind illegality describes. | |
ReasonCodeLabel | ASCII - String | Non-localized English string label for the Reason Code field that follows. | |
ReasonCode | ASCII - Integer | Integer field describing the legality of the Unit Instance for binding. Possible values are: 0 - Unit is a legal binding target 1 - Unit invalid due to material requirement 2 - Unit invalid due to binding requirement 3 - Unit invalid due to material requirement on flowpath 4 - Unit Invalid due to static binding requirement on flowpath 5 - Unit Invalid due to flowpath analysis 6 - Invalid reason code 7 - Unit invalidity reason not recorded | |
ReasonTextLabel | ASCII - String | Non-localized English string label for the Reason Text field that follows. | |
ReasonText | ASCII - String | Non-localized English string that describes the reason the unit is an illegal bind target. | |
MaterialLabel | ASCII - String | Non-localized English string label for material name field that follows. | |
Material | ASCII - String | Name of the material associated with the material requirement that made the unit instance an illegal bind target. | |
LotLabel | ASCII - String | Non-localized English string label for the Lot field that follows. | |
Lot | ASCII - String | LOT specifier associated with the material requirement that made the unit instance an illegal bind target. | |
LabelLabel | ASCII - String | Non-localized English string label for the Label field that follows. | |
UseCodeLabel | ASCII - String | Non-localized English string label for the Use Code field that follows. | |
UseCode | ASCII - Integer | Integer value indicating the usage type defined by the material requirement that made the unit instance an illegal bind target. Possible values are: 0 - Distribution 1 - Addition | |
UseTextLabel | ASCII - String | Non-localized English string label for the Use Text field that follows. | |
UseText | ASCII - String | Localized string describing the usage type defined by the material requirement that made the unit instance an illegal bind target. | |
StepLabel | ASCII - String | Non-localized English string label for the Step Path field that follows. | |
StepPath | ASCII - String | Full path to the step associated with the material requirement that made the unit instance an illegal bind target. | |
BindReqID | ASCII - Integer | Integer value identifier of the Binding Requirement exposed in this record. | |
BindReqText | ASCII - String | Non-localized string that is a "readable" description of the binding requirement. Note, this may contain the ':' character. | |
ExprDataUnitIDLabel | ASCII - String | Non-localized English string label for the Unit ID field that follows. | |
ExprDataUnitID | ASCII - Integer | Integer value identifier of the Unit Resource associated with this data record. | |
ExprDataUnitNameLabel | ASCII - String | Non-localized English string label for the Unit Name field that follows. | |
ExprDataUnitName | ASCII - String | Name of the Unit Resource associated with this data record. | |
ExprBindSpecIDLabel | ASCII - String | Non-localized English string label for the Bind Specifier ID field that follows. | |
ExprBindSpecID | ASCII - Integer | Integer value identifier of the Binding Specifier associated with this data record. | |
ExpressionValue | ASCII - Variable | Evaluated value of the expression. | |
LeafName | ASCII - String | Name of the leaf from the expression. | |
LeafValue | ASCII - Variable | Value of the leaf from the expression. | |
This table shows an example of the return on this execute.
Example: | An execute string consisting of: INFOTRIMMED2(Item,Station2,CLS_FRENCHVANILLA.BPC,$PARMS) Could return: FREEZER \t $UNITLIST \t WP_FREEZER1 \t WP_FREEZER2 \t $END \t 0 \crlf
\crlf MIXER \t $UNITLIST \t WP_MIXER1 \t WP_MIXER2 \t $END \t 0 \crlf
\crlf |
Provide Feedback