Info
The
INFO
execute obtains information about a recipe.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[INFO( <Item>,<UserID>,<RecipeID><PhaseMaterialData> )] | ||
where: | Item | Item name 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: | |||
<PhaseMaterialList> | is | <PhaseMaterialRecord> | <PhaseMaterialRecord>, <PhaseMaterialList> | |
<PhaseMaterialRecord> | is | <PhasePathname>,<MaterialName> | |
where: | |||
<Phase Pathname> | Full recipe pathname to the phase. (for example, PROC_1\UNITPROC_1:1\OPER_1:3\ADD:4) | ||
<Material Name> | Name of a material configured in the Material Server (for example, MILK). | ||
Action | A successful INFO execute places the recipe information into the item field. | ||
Return Format | The item populates with this data: <RecList> \crlf | ||
where: | |||
<RecList> | is | <StepList> PARMS \crlf <ParmList> | |
<StepList> | is | <Step> | <Step> <StepList> | |
<Step> | is | <Alias> \t <BindData> \t <BindFlag> \crlf | |
<BindData> | is | <Class> | <UnitBindList> | |
<UnitBindList> | is | $UNITLIST \t <UnitList> \t$END | |
<UnitList> | is | <UnitName> | <UniName> \t <UnitList> | |
<ParmList> | is | <ParmInfo> | <ParmInfo> <ParmList> | |
<ParmInfo> | is | <Parameter> \t <ResponseType> \t <ParmEdit> \t <EngUnits> \t <MaxValue> \t <MinValue> \t <Default> \crlf | |
where: | |||
Field Name | Format | Description | |
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:
Bit1 = PROMPT
Bit2 = FIRST AVAILABLE | |
<Class> | ASCII - String | Unit Class the previous step was configured to use. | |
$UNITLIST | ASCII-String | Indicates the beginning of the unit names list that contains references to material-based phases. | |
$END | ASCII-String | Indicates the end of the unit names list that contains 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 parameters as having values that could be edited or not. It always returns the value "1". | |
<EngUnits> | ASCII - String | Engineering units for the parameter. | |
<MaxValue> | ASCII - String | High range for the parameter. For parameters of type String and Enumeration, this field contains no data. | |
<MinValue> | ASCII - String | Low range for the parameter. For parameters of type String and Enumeration, this field contains no data. | |
<Default> | ASCII - String | Default value for the parameter. | |
The following table shows an example of the return on this execute for a non-material based recipe.
Example: | An execute string consisting of: [INFO(RCPINFO,STATION5/operator2,CLS_FRENCHVANILLA.BPC)] Would place this data in the item RCPInfo for the client: FREEZER \t FREEZER_CLS \t 0 \ r \ n MIXER \ t MIXER_CLS \t 0 \ crlf PARMS \crlf MILK_AMOUNT \ t 1 \ t 1 \ t KG \ t 5000 \ t 0 \ t 1999 \ crlf SUGAR_AMOUNT \ t 1 \ t 1 \ t KG \ t 1500 \ t 0 \ t 750 \ crlf CREAM_AMOUNT \ t 1 \ t 1 \ t K G \ t 5000 \ t 0 \ t 2001 \ crlf EGG_AMOUNT \ t 1 \ t 1 \ t KG \ t 500 \ t 0 \ t 200 \ crlf
FLAVOR_AMOUNT \ t 1 \ t 1 \ t KG \ t 100 \ t 0 \ t 50 \ crlf |
The following table shows an example of the return on this execute for a material-based recipe.
Example: | An execute string consisting of: [INFO(RCPINFO,STATION5/operator2,MCLS_FRENCHVANILLA.BPC)] Would place this data in the item RCPInfo for the client: FREEZER \t $UNITLIST \t NP_FREEZER1 \t NP_FREEZER2 \t $END \t 0 \crlf
PARMS \crlf
MILK_AMOUNT \t 1 \t 1 \t KG \t 5000 \t 0 \t 1999 \crlf
SUGAR_AMOUNT \t 1 \t 1 \t KG \t 1500 \t 0 \t 750 \crlf
CREAM_AMOUNT \t 1 \t 1 \t KG \t 5000 \t 0 \t 2001 \crlf
EGG_AMOUNT \t 1 \t 1 \t KG \t 500 \t 0 \t 230 \crlf
FLAVOR_AMOUNT \t 1 \t 1 \t KG \t 100 \t 0 \t 20 \crlf |
The following table shows an example of the return on this execute for a optional phase-material list.
Example: | An execute string consisting of: [INFO(item,STATION5/operator2,ADD_SWEET.UOP,
ADD_SWEET\MBR_ADD:1,SUGAR_GRANULATED)] Would return: ALIAS_MBR_MIXER_CLS\t$UNITLIST\tNP_MIXER1\tNP_MIXER2\t$END\t0\\crlf PARMS\\crlf |
Provide Feedback