RecipeParmsInfo

The
RECIPE_PARMS_INFO
execute retrieves information about the specified recipe's batch creation parameters.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute string with the PARMS keyword. The execute string’s format:
[RECIPE_PARMS_INFO (
Item,UserID,RecipeFileName
)]
where:
Item
Item name as specified by the client.
UserID
User identification associated with this execute.
RecipeID
Recipe filename.
Action
A RECIPE_PARMS_INFO execute returns the parameter information needed to create a batch using the specified recipe.
Return Format
The RECIPE_PARMS_INFO execute returns data n this format:
SUCCESS <ParameterInfo> | FAIL <Message>
where:
<ParameterInfo>
is
<Null List> | <Parameter List>
<Parameter List>
is
<Parameter> | <Parameter> /crlf <Parameter List>
<Parameter>
is
<Name> /t <PackedData> /t <ParmEdit> /t
<EngUnits> /t <High> /t <Low> /t <Default>
<PackedData>
is
bitmasked fields:
bits 0..3: <Response type>
bit 4: <Binding Relevance>
<ParmEdit>
is
obsolete field used to mark recipe parameters as having values that could be edited or not. It always returns the value "1"
<EngUnits>
is
Engineering Units for the recipe parameter or the enumeration set name. for an enumeration parameter.
<High>
is
High limit for the recipe parameter. For parameters of type String and Enumeration, this field contains no data.
<Low>
is
Low limit for the recipe parameter. For parameters of type String and Enumeration, this field contains no data.
<Default>
is
Default value for the recipe parameter.
Field Name
Format
Description
<Response Type>
ASCII - Integer
Data type for the response:
  • 1=real
  • 2=integer
  • 3=string
  • 5=enumeration
<Binding Relevance>
ASCII - String
Parameter relevance to unit binding. When a Parameter is marked as Relevant to Unit Binding, a value for that parameter is required as an input to an INFOTRIMMED2 execute. Any BATCH execute sent using result data from an INFOTRIMMED2 execute should be passed the same value for the parameter.
0-Not relevant
1=Relevant.
This table shows an example of the return on this execute.
An execute string consisting of:
RECIPE_PARMS_INFO(Item,Station2,CLS_FRENCHVANILLA.BPC)
Could re
tu
rn:
SUCCESS:MILK_AMOUNT \t 1 \t 1 \t KG \t 5000 \t 0 \t 1999 \crlf
\crlf
CREAM_AMOUNT \t 1 \t 1 \t KG \t 5000 \t 0 \t 2001 \crlf
\crlf
FLAVOR_AMOUNT \t 1 \t 1 \t KG \t 100 \t 0 \t 50 \crlf
\crlf
EGG_AMOUNT \t 1 \t 1 \t KG \t 500 \t 0 \t 200 \crlf
\crlf
SUGAR_AMOUNT \t 1 \t 1 \t KG \t 1500 \t 0 \t 750 \crlf
\crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal