InfoTrimmed

Execute Format

A

FactoryTalk Batch

Server supports an execute with this format:

[INFOTRIMMED(

<Item>,<UserID>,<RecipeID><PhaseMaterialData>

)]

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.

where:

<PhaseMaterialData>

is

<PhaseMaterialList>

is

<PhaseMaterialRecord>

is

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).

Action

A successful INFOTRIMMED 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>

is

<Step>

is

<UnitBindList>

is

<UnitList>

<ParmList>

is

<ParmInfo>

is

<FailData>

is

<ZeroTargets>

is

<ZeroTargsList>

is

<ZeroTargs>

is

<UnitErrList>

is

<UnitErr>

is

<ReasonData>

is

<LegalReason>

is

<FPathReason>

is

<FPathRqmReason>

is

<FPathMatReason>

is

<BindReqReason>

is

<MaterialReason>

is

<NotRecordedReason>

is

<InvalidReason>

is

<BindReqList>

is

<BindReq>

is

<ExprDataList>

is

<ExprData>

is

<ExpressionValues>

is

<LeafValuePairs>

is

<LeafValueList>

is

<LeafPair>

is

where:

Field Name

Format

Description

FAIL:

ASCII - String

Keyword to indicate the InfoTrimmed execute encountered an error.

ASCII - String

Error message formatted appropriately for operator display.

PARMS

ASCII - String

Keyword to separate the Steps from the parameters in the return result.

<Alias>

ASCII - String

Unit alias which requires binding.

<BindFlag>

ASCII - Integer

Integer value containing bits indicating what types of late binding are permitted:

$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.

<Parameter>

ASCII - String

Parameter name required to create the batch.

<Response Type>

ASCII - Integer

Data type for the response:

<ParmEdit>

ASCII - Integer

1 = obsolete field used to mark recipe parameters as having values that could be edited or not. It always returns the value "1".

<EngUnits>

ASCII - String

Engineering units for the recipe parameter.

<Max>

ASCII - String

High range for the recipe parameter. For parameters of type String and Enumeration, this field contains no data.

<Min>

ASCII - String

Low range for the recipe parameter. For parameters of type String and Enumeration, this field contains no data.

<Default>

ASCII - String

Default value for the recipe parameter.

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.

Example: