Batch

The
BATCH
 execute creates a control recipe and adds an entry in the batch list.
The format and return for this execute includes:
Format and return
Execute Format
A
FactoryTalk Batch
Server supports an execute with this format:
[BATCH(
<Item>,<UserID>,<RecipeID>,<BatchID>,<Scale>,
<Description>,<UnitReqList>, <ParmData>,<Mtrl_InfoList>,<FormulationData>
 )]
where:
<Item>
Item name as specified by the client.
<UserID>
User identification associated with this event.
<RecipeID>
  • For binary recipes: File name, including the extension, for the recipe to use.
  • For XML recipes: File name, with binary extension (.bpc for procedures, .upc for unit procedures, .uop for operations), for the recipe to use.
<BatchID>
Operator-entered batch identification. The BatchID can be comprised of any character except: the defined list separator, single or double quotes, brackets, parentheses, the percent sign (%), the tab character (\t), the carriage return character (\r), or the new line character (\n).
<Scale>
Scale factor in percent.
<Description>
Description of the recipe.
<UnitReqList>
List of unit requirements and their associated units.
<ParmData>
List of parameters and their associated values.
<Mtrl_InfoList>
Optional list of Phase Material Records that begins with
$MTRL_INFO
 and ends with
$END
.
<FormulationData>
Optional Formulation data to record in the event journal for successful batch creation.
where:
<UnitReqList>
is
<NullList> | <UnitReqPair>,<UnitReqList>
<UnitReqPair>
is
<UnitReq>,<Unit>
<UnitReq>
is
Name of the unit requirement for which binding data is specified.
<Unit>
is
Unit to which the step is bound:
> 0
 value indicates the Unit ID
0
,
-1
, or
< -2
 value indicates the Operator Prompt binding type.
-2
 value indicates the First Available binding type.
IMPORTANT: The zero and negative number values are only legal when creating a batch using a batch procedure. The
Batch
 execute fails when specifying a unit operation or unit procedure recipe.
where:
<ParmData>
is
PARMS
,<ParmList>
<ParmList>
is
<NullList> | <ParmPair>,<ParmList>
<ParmPair>
is
<ParmName>,<Value>
<ParmName>
Parameter name required by the recipe. Must be all upper case.
<Value>
Value associated with the parameter.
where:
<Mtrl_InfoList>
is
<NullList>
| $MTRL_INFO,
<PhaseMaterialList>
,$END
<PhaseMaterialList>
is
<PhaseMaterialRecord>
<PhaseMaterialRecord>,
<PhaseMaterialList>
<PhaseMaterialRecord>
is
<PhasePathName>
,
<MaterialName>
<PhasePathName>
Full recipe pathname to the phase.
<MaterialName>
Name of a material configured in the Material Server.
where:
<FormulationData>
is
<NullList> | $FORMDATA, <FormulationName>,
<FormulationDesc>
<FormulationName>
Name of the formulation from which default parameter values were obtained and presented to the operator during batch creation.
<FormulationDesc>
Description of the formulation from which default parameter values were obtained and presented to the operator during batch creation.
Action
A successful BATCH execute creates a control recipe from the specified master recipe. If the recipe was based upon one or more unit classes and "At Batch Creation" binding was specified, the recipe will be "bound" to the specified units or binding will be deferred to later, as specified in the execute. If the recipe required one or more parameter values, the values that were entered will be inserted into the control recipe. The PARMS statement must not include any spaces.
Return Format
The item populates with this data:
SUCCESS:
<CreateID>
| FAIL:
<message>
| FAILED
where:
<CreateID>
 specifies the Unique CreateID of the control recipe, and
<message>
 specifies why the
FactoryTalk Batch
 Server could not create a control recipe.
The following table lists examples of the return on this execute for different recipe types.
Examples of the return on this execute for different recipe types
Recipe
Example execute string
Material-based recipe
[BATCH(Item,STATION5/operator2,MCLS_FRENCHVANILLA.BPC,BATCH_100,100,French Vanilla Premium - class based/material based,MIXER,84,FREEZER,85,PARMS,CREAM_AMOUNT,2001,EGG_AMOUNT,230,FLAVOR_AMOUNT,20,MILK_AMOUNT,1999,SUGAR_AMOUNT,750)]
Class-based recipe
[BATCH(Item,STATION5/operator2,CLS_FRENCHVANILLA.BPC,BATCH_ID,100,FRENCH VANILLA PREMIUM - CLASS BASED,FREEZER,4,MIXER,3,PARMS, CREAM_AMOUNT,2001,EGG_AMOUNT,200,FLAVOR_AMOUNT,50,MILK_AMOUNT,1999,SUGAR_AMOUNT, 750)]
Material class-based recipe
[BATCH( Item, STATION5/operator2, VANILLA_ICE_CREAM.BPC, BATCH_100,100,French Vanilla Premium - class based/material based, MIXER, 84, FREEZER, 85, PARMS, CREAM_AMOUNT, 2001, EGG_AMOUNT, 230, FLAVOR_AMOUNT, 20,MILK_AMOUNT, 1999, SUGAR_AMOUNT, 750, $MTRL_INFO, PROC_1\UNITPROC_1:1\OPER_1:3\ADD:4, MILK, PROC_1\UNITPROC_1:1\OPER_2:1\ADD:1, SUGAR, $END )]
Material class-based recipe
[BATCH(Item,UserID,CLS_FRENCHVANILLA.BPC,BATCH_ID,100,FRENCH VANILLA PREMIUM - CLASS BASED ,FREEZER,4,MIXER,2,PARMS,CONTAINER_SIZE,3,CREAM_AMOUNT,2001,EGG_AMOUNT,200,FLAVOR_AMOUNT,50,LABEL_DATA,100% PURE,MILK_AMOUNT,1999,MILK_TYPE,TWO_PERCENT,SUGAR_AMOUNT,750,VANILLA_FLAVOR,FRENCH_VANILLA,$FORMDATA,SKIM,Makes Vanilla Ice Cream with Skim Milk)]
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal