RecipeList
The
RecipeList
item returns information about the recipes available within FactoryTalk Batch View. The RecipeList
execute must be run once prior to advising or requesting on this item. This table shows the input and output formats for this item.
Format | Description | |
|---|---|---|
Input
Format | Request: RecipeList | |
Output
Format | The RecipeList item returns in this format: | |
<RecipeList> | is | <RecipeInfo>
|
<RecipeInfo> <RecipeList> |
<RecipeInfo> | is | <ProductVersion>
\t
<FileName> \t
<RecipeID>
\t
<RecipeDesc>
\t
<ProductName>
\t
<ProductCode> \t <RecipeVersion>
\t
<RecipeVersTime>
\t <Author>
\t
<ApprovedBy>
\t
<RecipeLevel>
\t
<RecipeType> \t <Abstract>
\t
<MinBatchSize>
\t
<DefBatchSize>
\t
<MaxBatchSize>
\t <UOM>
\t
<EstDuration> \t <Released>
\t
<AreaModel>
\t
<AreaModelTime>
\t <Unit>
\t
<VerifyDate> \cr |
<RecipeList> | is | <RecipeInfo> |
<RecipeInfo>
<RecipeList> |
where <RecipeInfo>
is | ||
Field Name | Format | Description |
<ProductVersion> | ASCII - String | The version of the product as defined in the recipe
header. |
<FileName> | ASCII - String | The filename of the recipe. |
<RecipeID> | ASCII - String | The recipe identifier as defined in the recipe header. |
<RecipeDesc> | ASCII - String | A recipe description as defined in the recipe header. |
<ProductName> | ASCII - String | The product name as defined in the recipe header. |
<ProductCode> | ASCII - String | The product code as defined in the recipe header. |
<RecipeVersion> | ASCII - String | The recipe version as defined in the recipe header. |
<RecipeVersTime> | ASCII - String dd/mm/yy hh:mm | The date/time that the recipe was saved. The format is in
accordance with the date/time as set in the Control Panel. |
<Author> | ASCII - String | The recipe author as defined in the recipe header. |
<ApprovedBy> | ASCII - String | The approved by name as defined in the recipe header. |
<RecipeLevel> | ASCII - String | The level of the recipe: PROCEDURE, UNIT PROCEDURE, or
OPERATION. |
<RecipeType> | ASCII - String | The type of equipment requirements for the recipe: CLASS or
INSTANCE. |
<Abstract> | ASCII - String | The recipe abstract as defined in the recipe header. |
<MinBatchSize> | ASCII - String | The minimum batch size, as defined in the recipe header. |
<DefBatchSize> | ASCII - String | The default batch size, as defined in the recipe header. |
<MaxBatchSize> | ASCII - String | The maximum batch size, as defined in the recipe header. |
<UOM> | ASCII - String | The unit of measure, as defined in the recipe header. |
<EstDuration> | ASCII - String | The estimated duration of the batch, as defined in the recipe
header. |
<Released> | ASCII - String | Indicates if the recipe has been released to production. Always
TRUE. (Only recipes which have been released to production are
included in the RecipeList item.) |
<AreaModel> | ASCII - String | The area model file and path name against which the recipe was
verified. |
<AreaModelTime> | dd/mm/yy hh:mm | The date/time of area model file against which the recipe was
verified. The format will be in accordance with the date/time as set
in the Control Panel. |
<Unit> | ASCII - String | The name of the unit or alias to which the recipe is bound. Will
return an empty string for PROCEDURE level recipes. |
<VerifyDate> | ASCII - String dd/mm/yy hh:mm | The latest modification date/time for the recipe. The format will
be in accordance with the date/time as set in the Control
Panel. |
This is an example of the return on this request.
Example
: A request on
object.GetItem(RecipeList)
could return: 3.0 \t FRENCH_VANILLAPREMIUM1_MEGA_PARLOR_OPT_2_U1.UPC \t
FRENCH_VANILLAPREMIUM1_MEGA_PARLOR_OPT_2_U1 \t French Vanilla IceCream \t French Vanilla \t
FVP-101 \t Premium 1 \t 2/24/2022 10:11:33 AM \t Administrator \t rpmServer
(STAGE1\rpmServer) on computer STAGE1 \t UNIT PROCEDURE \t Instance \t The general recipe
French_Vanilla, Variant= Premium, Version= 1 is successfully converted to master recipe
FRENCH_VANILLAPREMIUM1_MEGA_PARLOR \t 25 \t 50 \t 100 \t KG \t \t TRUE \t \\STATION5\PROGRAM
FILES\ROCKWELL SOFTWARE\BATCH\SAMPLEAPP\RECIPES\ICE_CREAM.CFG \t 2/24/2022 10:05:16 AM \t
MP_MIXERFREEZER1 \t 2/24/2022 10:11:27 AM \crlf
...
3.0 \t CLS_STRAWBERRY_ICEMILK.BPC \t CLS_STRAWBERRY_ICEMILK \t Strawberry Ice Milk -
Reduced Fat Ice Cream - class based \t Strawberry Ice Milk \t SIM-101 \t 1.0 \t 2/24/2022
10:11:34 AM \t Mark Shepard \t MSS \t PROCEDURE \t Class \t \t 3000 \t 5000 \t 7000 \t KG \t
45 \t TRUE \t \\STATION5\PROGRAM FILES\ROCKWELL
SOFTWARE\BATCH\SAMPLEAPP\RECIPES\ICE_CREAM.CFG \t 2/24/2022 10:05:16 AM \t \t 2/24/2022
10:11:27 AM \crlf
Provide Feedback