ProcedureIDStatus
The
ProcedureIDStatus
item returns data regarding the status of a specified procedure level. Query each recipe level to get complete recipe details.This table shows the input and output formats for this item.
Format | Description | ||
|---|---|---|---|
Input Format | Request: ProcedureIDStatus | ||
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 | <ProcIDStatus> | is | <SVRSignal> \crlf <ElemList> |
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 <ElemList> is: | |||
<ElemList> | is | <ParentStep> \crlf <ChildElemList> | |
<ParentStep> | is | <RegularStep> | |
<RegularStep> | is | <ID> \t <Name> \t <SP88Type> \t <KeyPName> \t <KeyValue> \t <State> \t <Mode> \t <UnitName> \t <Control> \t <Index> \t <Paused> \t <Msg> \t
<Rqst> \t <Fail> \t <ParmList> \t <RptParmList> \t <OwnerID> \t <OwnerName> \t <CmdMask> | |
<ChildElemList> | is | <RecipeElement> \crlf | <RecipeElement> \crlf <ChildElemList> | |
<RecipeElement> | is | <InitialStep> | <TerminalStep> | <Transition> | <RegularStep> | |
<InitialStep> | is | <ElemID> \t <ElemState> \t <FailureMsg> | |
<TerminalStep> | is | <ElemID> \t <ElemState> \t <FailureMsg> | |
<Transition> | is | <ElemID> \t <ElemState> \t <FailureMsg> \t <RqstAcquire> \t <Paused> | |
where <InitialStep> is: | |||
Field Name | Format | Description | |
<ElemID> | ASCII - Integer | Element ID (defined by ProcedureIDData data item). | |
<ElemState> | ASCII - String | Element state | |
<FailureMsg> | ASCII - String | Failure message, single space if not active or if there are no failures. | |
where <TerminalStep> is: | |||
Field Name | Format | Description | |
<ElemID> | ASCII - Integer | Element ID (defined by ProcedureIDData data item). | |
<ElemState> | ASCII - String | Element state | |
<FailureMsg> | ASCII - String | Failure message, single space if not active or if there are no failures. | |
where <Transition> is: | |||
Field Name | Format | Description | |
<ElemID> | ASCII - Integer | Element ID (defined by ProcedureIDData data item). | |
<ElemState> | ASCII - String | Element state | |
<FailureMsg> | ASCII - String | Failure message, single space if not active or if there are no failures. | |
<RqstAcquire> | ASCII - Integer | Displays a string that equates to the value of the transition’s Firing Attribute: 0 = " " 4 = "Stopping"
1 = "Acquiring" 5 = "Resetting"
2 = "Binding" 6 = "Pending"
3 = "Committed" 7 = "Paused" | |
<Paused> | ASCII - Integer | Not used, replaced with the firing attribute and only supported for legacy systems. | |
where <RegularStep> is: | |||
Field Name | Format | Description | |
<ID> | ASCII - Integer | Element ID (defined by ProcedureIDData data item). | |
<Name> | ASCII - String | Element name. | |
<SP88Type> | ASCII - Integer | Step type:
| |
<KeyPName> | ASCII - String | Key parameter name; may contain a single space if the step does not have a key parameter value. | |
<KeyValue> | ASCII - String | Step key value; may contain a single space if the step does not have a key parameter value | |
<State> | ASCII - String | Element state; the value can be a single space character if the step is not an active element. | |
<Mode> | ASCII - String | Returns the step mode when the step is active or inactive. | |
<UnitName> | ASCII - String | Unit step runs under; the value can be a single space character if the step is not associated with a single unit. For example, BPC batch step. | |
<Control> | ASCII - String | Who controls the Step
This field may contain a single space character if the step is not an active recipe element. | |
<Index> | ASCII - Integer | Step Index; the value may be a single space character if the step is not an active recipe element. | |
<Paused> | ASCII - Integer | 0 = not paused, 1 = paused | |
<Msg> | ASCII - String | Step Message | |
<Rqst> | ASCII- integer | Step Request, contents of request register; the value may be a single space character if the step is not an active recipe element or is not a phase level step. | |
<Fail> | ASCII - String | Fail Message; the value may contain a single space character if there is no failure associated with the step. | |
<ParmList> | Variable | List of recipe parameters | |
<RptParmList> | Variable | List of report parameters | |
<OwnerID> | ASCII - Integer | ElemOwner ID
only for phase steps, otherwise blank space character. | |
<OwnerName> | ASCII - String | Owner Name
only for phase steps, otherwise blank space character. | |
<CmdMask> | ASCII - Integer | Command masks | |
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 <CurrentValue> | |
where <Parameter> is: | |||
Field Name | Format | Description | |
<ParmName> | ASCII - String | Parameter name $BINDCONTAINER - for container only. $BINDEQMODULE - for phase only | |
<CurrentValue> | ASCII - Integer | Current value of parameter in recipe. Could also be the name of the container or the phase. | |
where <RptParmList> is: | |||
<RptParmList> | is | <NullRPList> | <RPList> | |
<NullRPList> | is | $REPORT \t <sp> \t $END | |
<RPList> | is | $REPORT \t <RList> \t $END | |
<RList> | is | <ReportParm> | <ReportParm> \t <RList> | |
<ReportParm> | is | <ParmName> \t <ParmValue> | |
where <ReportParm> is: | |||
Field Name | Format | Field Name | |
<ParmName> | ASCII - String | Report parameter name | |
<ParmValue> | ASCII - Integer | The value of the report parameter. This value displays ??? if the value is not yet assigned. | |
This is an example of the return on this request.
A request on
object.GetItem(17Status)
could return:0\crlf124\tBATCH_ID\t1\t\t \tHELD\tO_AUTO\t \tPROGRAM\t \t0\t \t \t
\t$PARM\tMILK_AMOUNT\t1999\tSUGAR_AMOUNT\t750 \tCREAM_AMOUNT\t2001\tEGG_AMOUNT\t200
\tFLAVOR_AMOUNT\t50\t$END\t$REPORT\t \t$END\t \t \t2341\crlf129\t \t
\crlf125\tCLS_FRENCHVANILLA_UP:1\t2 \tFLAVOR_AMOUNT\tWP_FREEZER1\t \tP_AUTO\tWP_FREEZER1\t
\t \t0\t \t \t \t$PARM\tFLAVOR_AMOUNT\t50\t \t$END\t$REPORT\t \t$END\t \t
\t32768\crlf126\tCLS_SWEETCREAM_UP:1\t2\t\tWP_MIXER1 \tHELD\tP_AUTO\tWP_MIXER1\tPROGRAM\t
\t0\t \t \t \t$PARM\tMILK_AMOUNT\t1999\t \tSUGAR_AMOUNT\t750\t \tCREAM_AMOUNT\t2001\t
\tEGG_AMOUNT\t200\t \t$END\t$REPORT\t \t$END\t \t
\t2080\crlf127\tCLS_TRANSFER_IN_UP:1\t2\t\tWP_FREEZER1 \t \tP_AUTO\tWP_FREEZER1\t \t \t0\t
\t \t \t$PARM\t \t$END\t$REPORT\t \t$END\t \t \t32768\crlf128\tCLS_TRANSFER_OUT_UP:1\t2
\t\tWP_MIXER1\t \tP_AUTO\tWP_MIXER1\t \t \t0\t \t \t \t$PARM\t \t$END\t$REPORT\t \t$END\t
\t \t0\crlf130\t \t \crlf131\tIDLE\t \t0\t0\crlf132 \tHELD\t \t0\t0\crlf133\tIDLE\t
\t0\t0\crlf134\tIDLE\t \t0\t0\crlf
A request on
object.GetItem(17 \t MCLS_SWEETCREAM_UP:1 \t
MCLS_SWEETCREAM_OP:1Status)
could return:0 \crlf 162 \t MCLS_SWEETCREAM_OP:1 \t 3 \t \t \t HELD \t P_AUTO \t NP_MIXER1 \t
PROGRAM \t \t 0 \t \t \t FEED_COMPLETE NOT COMPLETE. \t $PARM \t MILK_AMOUNT \t 1999 \t
SUGAR_AMOUNT \t 750 \t CREAM_AMOUNT \t 2001 \t EGG_AMOUNT \t 230 \t $END \t $REPORT \t \t
$END \t \t \t 2080 \crlf 167 \t \t \crlf 171 \t AGITATE:1 \t 4 \t SPEED_RATE \t 25 \t
COMPLETE \t P_AUTO \t NP_MIXER1 \t PROGRAM \t 10 \t 0 \t \t 0 \t \t $PARM \t SPEED_RATE \t
25 \t $END \t $REPORT \t MIX_SPEED \t 0 \t $END \t -1112 \t
28:MCLS_FRENCHVANILLA\MCLS_SWEETCREAM_UP:1\MCLS_SWEETCREAM_OP:1 \t 32 \crlf 184 \t
MBR_ADD:1 \t 4 \t \t \t \t \t NP_MIXER1 \t \t 0 \t \t \t \t \t $PARM \t MATERIAL \t
EGG_YOLK \t AMOUNT \t 230 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE \t \t $END
\t $REPORT \t ACTUAL_AMOUNT \t 0 \t FEED_COMPLETE \t NO \t $END \t \t \t 262144 \crlf 185
\t MBR_ADD:2 \t 4 \t \t \t \t \t NP_MIXER1 \t \t 0 \t \t \t \t \t $PARM \t MATERIAL \t
SUGAR_GRANULATED \t AMOUNT \t 750 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE \t
\t $END \t $REPORT \t ACTUAL_AMOUNT \t 0 \t FEED_COMPLETE \t NO \t $END \t \t \t 262144
\crlf 180 \t MBR_ADD:3 \t 4 \t \t \t \t \t NP_MIXER1 \t \t 0 \t \t \t \t \t $PARM \t
MATERIAL \t CREAM \t AMOUNT \t 2001 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE
\t \t $END \t $REPORT \t ACTUAL_AMOUNT \t 0 \t FEED_COMPLETE \t NO \t $END \t \t \t 262144
\crlf 176 \t MBR_ADD:4 \t 4 \t \t \t COMPLETE \t P_AUTO \t NP_MIXER1 \t PROGRAM \t 10 \t 0
\t FEED_COMPLETE NOT COMPLETE. \t 0 \t FEED_COMPLETE NOT COMPLETE. \t $PARM \t MATERIAL \t
MILK \t AMOUNT \t 1999 \t $BINDCONTAINER \t DAIRY_WEST1 \t $BINDEQMODULE \t NP_ADDDAIRY_M1
\t $END \t $REPORT \t ACTUAL_AMOUNT \t 0 \t FEED_COMPLETE \t NO \t $END \t -1112
\t28:MCLS_FRENCHVANILLA\MCLS_SWEETCREAM_UP:1\MCLS_SWEETCREAM_OP:1 \t 32 \crlf 186 \t
TEMP_CTL:1 \t 4 \t TEMP_SP \t 71.1 \t \t \t NP_MIXER1 \t \t 0 \t \t \t \t \t $PARM \t
HOLD_TIME \t 5 \t TEMP_SP \t 71.1 \t $END \t $REPORT \t TEMPERATURE \t 0 \t TIME_HELD
\t
0 \t $END \t \t \t 0 \crlf 175 \t \t \crlf 169 \t IDLE \t \t 0 \t 0 \crlf 182 \t
IDLE \t \t 0 \t 0 \crlf 178 \t IDLE \t \t 0 \t 0 \crlf 173 \t HELD \t \t 0 \t 0
\crlf
Provide Feedback