ProcedureIDData
The
ProcedureIDData
item returns detailed data regarding the specified level of a procedure. Query each recipe level to get complete recipe details. The data returned by this item is static. Obtain this item again to reflect any updates.This table shows the input and output formats for this item.
Input Format | Request: ProcedureIDData | ||
ProcedureID | is | ASCII - String, the unique path to the recipe step. This path begins with the CreateID. Use BLCreateID_x item to retrieve the CreateID. | |
Procedure Level | is | CreateID | |
Unit Procedure Level | is | CreateID \t UnitProcedureName | |
Operation Level | is | CreateID \t UnitProcedureName \t OperationName | |
Output Format | The ProcedureIDData item returns in this format: | ||
<ProcData> | is | <SVRSignal> \crlf <DataList> | |
where: | |||
Field Name | Format | Description | |
<SVRSignal> | ASCII - Integer | 0 = continue update of data for this advise
1 = discontinue update of data for this advise | |
where <DataList> is: | |||
<DataList> | is | <RecipeDat> \crlf <RecipeElemList> <RecipeElemList> expanded after <RecipeDat> | |
<RecipeDat> | is | <RecpAbstr> \crlf <RecpDesc> \crlf <RecpID> \crlf <RecpCode> \crlf <RecpVersion> \crlf <RecpAuthor> \crlf <RecpDate> \crlf <DocDim> \crlf <AreaName> \crlf <ProcCellList> \crlf <BoundUnit> | |
where <RecipeDat> is: | |||
Field Name | Format | Description | |
<RecpAbstr> | ASCII - String | Recipe abstract. | |
<RecpDesc> | ASCII - String | Recipe description. | |
<RecpID> | ASCII - String | Recipe identifier. | |
<RecpCode> | ASCII - String | Recipe product code. | |
<RecpVersion> | ASCII - String | Recipe version. | |
<RecpAuthor> | ASCII - String | Recipe author. | |
<RecpDate> | ASCII - String | Date recipe was last saved with the format in accordance with the date and time as set in Control Panel . | |
<DocDim> | Variable List | Recipe drawing dimensions. | |
<AreaName> | ASCII - String | Equipment database name. | |
<ProcCellList> | ASCII - String | Currently always a blank space character. | |
<BoundUnit> | ASCII - String | Unit name to which the step is bound. | |
where <DocDim> is: | |||
<DocDim> | is | <Xdim> \t <Ydim> | |
Field Name | Format | Description | |
<Xdim> | ASCII - Integer | Always returns zero. Reserved for future use. | |
<Ydim> | ASCII - Integer | Always returns zero. Reserved for future use. | |
where <RecipeElemList> is:
<ParentStep> is always the first element in a <RecipeElemList> and only appears once in that list. | |||
<RecipeElemList> | is | <RecipeElem> | <RecipeElem> \crlf <RecipeElemList> | |
<RecipeElem> | is | <ParentStep> | <InitialStep> | <TerminalStep> | <RegularStep> | <Transition> | <EqModLink> | <OrDiverg> | <OrConverg> | <AndDiverg> | <AndConverg> | |
<ParentStep> | is | <ElemType> \t <ElemID> \t <RecipeLink> \t <ParmList> | |
<InitialStep> | is | <ElemType> \t <ElemID> \t <DrawXCord> \t <DrawYCord> | |
<TerminalStep> | is | <ElemType> \t <ElemID> \t <DrawXCord> \t <DrawYCord> | |
<RegularStep> | is | <ElemType> \t <ElemID> \t <DrawXCord> \t <DrawYCord> \t <StepName> \t <ControllingProc> \t <ParmList> \t <RptParmList> | |
<Transition> | is | <ElemType> \t <ElemID> \t <DrawXCord> \t <DrawYCord> \t <ConditionExpression> | |
<EqModLink> | is | <ElemType> \t <ElemID> \t <PrevElemID> \t <NextElemID> | |
<OrDiverg> | is | <ElemType> \t <ElemID> \t <PrevElemIDList> \t <NextElemIDList> | |
<OrConverg> | is | <ElemType> \t <ElemID> \t <NextElemIDList> \t <PrevElemIDList> | |
<AndDiverg> | is | <ElemType> \t <ElemID> \t <PrevElemIDList> \t <NextElemIDList> | |
<AndConverg> | is | <ElemType> \t <ElemID> \t <NextElemIDList> \t <PrevElemIDList> | |
where <RecipeElemList> is: | |||
Field Name | Format | Description | |
<ElemType> | ASCII - Integer | Recipe Element Type
0 = Parent Step
1 = Initial Step
2 = Terminal Step
3 = Regular Step
4 = Transition
5 = Link
6 = OR Divergence
7 = OR Convergence
8 = AND Divergence
9 = AND Convergence | |
<ElemID> | ASCII - Integer | Element identifier. | |
<RecipeLink> | ASCII - Integer | Path to the recipe file and recipe. | |
<DrawXCoord> | ASCII - Integer | X coordinate for drawing the element. | |
<DrawYCoord | ASCII - Integer | Y coordinate for drawing the element. | |
<ParmList> | Variable List | Parameters associated with the procedure. | |
<StepName> | ASCII - String | Name of a step element. | |
<ControllingProc> | ASCII - String | Name of the procedure a step element controls. | |
<RptParmList> | Variable List | Report parameters associated with the procedure. | |
<Condition
Expression> | ASCII - String | Condition expression’s text of a transition element. | |
<PrevElemID> | ASCII - Integer | Element identifier appearing IN FRONT of a phase link. | |
<NextElemID> | ASCII - Integer | Element identifier appearing BEHIND a phase link. | |
<PrevElemIDList> | Variable List | List of elements appearing ABOVE a divergence or convergence. | |
<NextElemIDList> | Variable List | List of elements appearing BELOW a divergence or convergence. | |
where <ParmList> is: | |||
<ParmList> | is | $PARM \t <Parameters> \t $END | |
<Parameters> | is | <NullParmList> | <PList> | |
<NullParmList> | is | <sp> | |
<PList> | is | <Parameter> | <Parameter> \t <PList> | |
<Parameter> | is | <ParmName> \t <ParmType> \t <ParmKind> \t <EUs> \t <MaxValue> \t <MinValue> \t <DefaultValue> | |
where <Parameter> is: | |||
Field Name | Format | Field Name | |
<ParmName> | ASCII - String | Parameter name $BINDCONTAINER - for container only.
$BINDEQMODULE - for phase only | |
<ParmType> | ASCII - Integer | Data type
| |
<ParmKind> | ASCII - Integer | Kind of parameter. 1: Value 2: UnAcked Prompt 3: Deferred 4: Static or the target of a deferred MATERIAL parameter. 5: Material Data | |
<EUs> | ASCII - String | Eng Unit
If <ParmType> = 5, then this is the enumeration set
If <ParmType>=3, then a space | |
<MaxValue> | ASCII - String | Maximum value
Single space for strings and enumerations | |
<MinValue> | ASCII - String | Minimum value
Single space for strings and enumerations | |
<DefaultValue> | <ParmType> | Default value assigned to parameter | |
where <RptParmList> is: | |||
<RptParmList> | is | <NullRPList> | <RPList> | |
<NullRPList> | is | $REPORT \t $END | |
<RPList> | is | $REPORT \t <RList> \t $END | |
<RList> | is | <ReportParm> | <ReportParm> \t <RList> | |
<ReportParm> | is | <RptName> \t <EUs> | |
where <ReportParm> is: | |||
Field Name | Format | Field Name | |
<RptName> | ASCII - String | Report parameter name | |
<EUs> | ASCII - String | Engineering units for report parameter | |
where <PrevElemIDList> is: | |||
<PrevElemIDList> | is | <ElemIDList> | |
where <NextElemIDList> is: | |||
<NextElemIDList> | is | <ElemIDList> | |
where <ElemIDList> is: | |||
<ElemIDList> | is | <ElemID> | <ElemID> \t <ElemIDList> | |
Field Name | Format | Field Name | |
<ElemID> | ASCII - Integer | Element identifier | |
This table shows an example of the return on this request.
Example: | A request on object.GetItem(17Data) (Procedure Level of MCLS_FRENCHVANILLA) could return:0 \crlf \crlf French Vanilla Premium - class based/material based \crlf MCLS_FRENCHVANILLA \crlf FV-101 \crlf 1.0 \crlf Mark Shepard \crlf 2/24/2022 10:11:30 AM \crlf 30000 \t 30000 \crlf AREA1 \crlf \crlf \crlf 0 \t 572 \t MCLS_FRENCHVANILLA.BPC \t $PARM \t MILK_AMOUNT \t 1 \t 1 \t KG \t 5000 \t 0 \t 1999 \t SUGAR_AMOUNT \t 1 \t 1 \t KG \t 1500 \t 0 \t 750 \t CREAM_AMOUNT \t 1 \t 1 \t KG \t 5000 \t 0 \t 2001 \t EGG_AMOUNT \t 1 \t 1 \t KG \t 500 \t 0 \t 230 \t FLAVOR_AMOUNT \t 1 \t 1 \t KG \t 100 \t 0 \t 20 \t $END \crlf 1 \t 573 \t 700 \t 100 \crlf 5 \t 574 \t 573 \t 575 \crlf 4 \t 575 \t 800 \t 398 \t TRUE \crlf 5 \t 576 \t 575 \t 577 \crlf 3 \t 577 \t 600 \t 598 \t MCLS_SWEETCREAM_UP:1 \t MCLS_SWEETCREAM_UP.UPC \t $PARM \t MILK_AMOUNT \t 1 \t 3 \t KG \t 5000 \t 0 \t 0 \t SUGAR_AMOUNT \t 1 \t 3 \t KG \t 1500 \t 0 \t 0 \t CREAM_AMOUNT \t 1 \t 3 \t KG \t 5000 \t 0 \t 0 \t EGG_AMOUNT \t 1 \t 3 \t KG \t 500 \t 0 \t 0 \t $END \t $REPORT \t $END \crlf 5 \t 578 \t 577 \t 579 \crlf 4 \t 579 \t 800 \t 898 \t MCLS_SWEETCREAM_UP:1.STATE = COMPLETE \crlf 8 \t 580 \t 579 \t 590 \t 581 \crlf 3 \t 590 \t 200 \t 1300 \t MCLS_TRANSFER_OUT_UP:1 \t MCLS_TRANSFER_OUT_UP.UPC \t $PARM \t \t $END \t $REPORT \t $END \crlf 3 \t 581 \t 900 \t 1300 \t MCLS_TRANSFER_IN_UP:1 \t MCLS_TRANSFER_IN_UP.UPC \t $PARM \t \t $END \t $REPORT \t $END \crlf 4 \t 583 \t 800 \t 1800 \t MCLS_TRANSFER_IN_UP:1.STATE = COMPLETE AND MCLS_TRANSFER_OUT_UP:1.STATE = COMPLETE \crlf 9 \t 582 \t 583 \t 590 \t 581 \crlf 5 \t 584 \t 583 \t 585 \crlf 3 \t 585 \t 600 \t 2000 \t MCLS_FRENCHVANILLA_UP:1 \t MCLS_FRENCHVANILLA_UP.UPC \t $PARM \t FLAVOR_AMOUNT \t 1 \t 3 \t KG \t 100 \t 0 \t 0 \t $END \t $REPORT \t $END \crlf 5 \t 586 \t 585 \t 587 \crlf 4 \t 587 \t 800 \t 2400 \t MCLS_FRENCHVANILLA_UP:1.STATE = COMPLETE \crlf 5 \t 588 \t 587 \t 589 \crlf 2 \t 589 \t 800 \t 2700 \crlf |
Example: | A request on object. GetItem(17 \t MCLS_SWEETCREAM_UP:1 \t MCLS_SWEETCREAM_OP:1DATA) (Operation Level of MCLS_FRENCHVANILLA) could return:0 \crlf \crlf Sweetcream operation - class based/material based \crlf MCLS_SWEETCREAM_OP \crlf SWC-101 \crlf 1.0 \crlf Mark S. Shepard \crlf 2/28/2022 7:14:07 AM \crlf 30000 \t 30000 \crlf AREA1 \crlf \crlf NP_MIXER1 \crlf 0 \t 162 \t MCLS_SWEETCREAM_OP.UOP \t $PARM \t MILK_AMOUNT \t 1 \t 3 \t KG \t 5000 \t 0 \t 0 \t SUGAR_AMOUNT \t 1 \t 3 \t KG \t 1500 \t 0 \t 0 \t CREAM_AMOUNT \t 1 \t 3 \t KG \t 5000 \t 0 \t 0 \t EGG_AMOUNT \t 1 \t 3 \t KG \t 500 \t 0 \t 0 \t $END \crlf 1 \t 167 \t 700 \t 100 \crlf 5 \t 168 \t 167 \t 169 \crlf 4 \t 169 \t 800 \t 398 \t TRUE \crlf 8 \t 170 \t 169 \t 184 \t 185 \t 171 \crlf 3 \t 184 \t 600 \t 698 \t MBR_ADD:1 \t \t $PARM \t MATERIAL \t 5 \t 4 \t MATERIALS \t \t \t NULL_MATERIAL \t AMOUNT \t 1 \t 3 \t \t 5000 \t 0 \t 0 \t $BINDCONTAINER \t 3 \t 5 \t \t \t \t \t $BINDEQMODULE \t 3 \t 5 \t \t \t \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t ENG. UNITS \t FEED_COMPLETE \t YES_NO \t $END \crlf 3 \t 185 \t 1400 \t 698 \t MBR_ADD:2 \t \t $PARM \t MATERIAL \t 5 \t 4 \t MATERIALS \t \t \t NULL_MATERIAL \t AMOUNT \t 1 \t 3 \t \t 5000 \t 0 \t 0 \t $BINDCONTAINER \t 3 \t 5 \t \t \t \t \t $BINDEQMODULE \t 3 \t 5 \t \t \t \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t ENG. UNITS \t FEED_COMPLETE \t YES_NO \t $END \crlf 3 \t 171 \t 2500 \t 700 \t AGITATE:1 \t \t $PARM \t SPEED_RATE \t 1 \t 1 \t RPM \t 50 \t 0 \t 5 \t $END \t $REPORT \t MIX_SPEED \t RPM \t $END \crlf 4 \t 182 \t 800 \t 1096 \t MBR_ADD:2.STATE = COMPLETE AND MBR_ADD:1.STATE = COMPLETE \crlf 9 \t 183 \t 182 \t 184 \t 185 \crlf 8 \t 181 \t 182 \t 180 \t 186 \crlf 3 \t 180 \t 600 \t 1396 \t MBR_ADD:3 \t \t $PARM \t MATERIAL \t 5 \t 4 \t MATERIALS \t \t \t NULL_MATERIAL \t AMOUNT \t 1 \t 3 \t \t 5000 \t 0 \t 0 \t $BINDCONTAINER \t 3 \t 5 \t \t \t \t \t $BINDEQMODULE \t 3 \t 5 \t \t \t \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t ENG. UNITS \t FEED_COMPLETE \t YES_NO \t $END \crlf 3 \t 186 \t 1400 \t 1400 \t TEMP_CTL:1 \t \t $PARM \t TEMP_SP \t 1 \t 1 \t DEG C \t 100 \t 0 \t 71.1 \t HOLD_TIME \t 1 \t 2 \t MINUTES \t 60 \t 0 \t 5 \t $END \t $REPORT \t TEMPERATURE \t DEG F \t TIME_HELD \t MIN \t $END \crlf 4 \t 178 \t 800 \t 1794 \t TEMP_CTL:1.STATE = COMPLETE AND MBR_ADD:3.STATE = COMPLETE \crlf 9 \t 179 \t 178 \t 180 \t 186 \crlf 5 \t 177 \t 178 \t 176 \crlf 3 \t 176 \t 600 \t 1994 \t MBR_ADD:4 \t \t $PARM \t MATERIAL \t 5 \t 4 \t MATERIALS \t \t \t NULL_MATERIAL \t AMOUNT \t 1 \t 3 \t \t 5000 \t 0 \t 0 \t $BINDCONTAINER \t 3 \t 5 \t \t \t \t \t $BINDEQMODULE \t 3 \t 5 \t \t \t \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t ENG. UNITS \t FEED_COMPLETE \t YES_NO \t $END \crlf 4 \t 173 \t 800 \t 2500 \t MBR_ADD:4.STATE = COMPLETE \crlf 9 \t 172 \t 173 \t 176 \t 171 \crlf 5 \t 174 \t 173 \t 175 \crlf 2 \t 175 \t 800 \t 2700 \crlf |
Provide Feedback