ProcedureIDStatus2
The
ProcedureIDStatus2
item returns data regarding the status of a specified procedure level. Each recipe level must be queried to get the complete picture of the recipe.This table shows the input and output formats for this item.
Input Format | Request: ProcedureIDStatus2 | ||
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 | <ProcIDStatus2> | 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 <KeyValueStatus> \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 | |
<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 | |
<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 Firing Attribute. Supported for legacy systems only. | |
where <RegularStep> is: | |||
Field Name | Format | Description | |
<ID> | ASCII - Integer | Element ID (defined by ProcedureIDData data | |
<Name> | ASCII - String | Element Name. | |
<SP88Type> | ASCII - Integer | Step Type:
0 = Null 3 = Operation
1 = Procedure 4 = Phase
2 = Unit Procedure | |
<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’s Key Value;may contain a single space if the step does not have a key parameter value | |
<KeyValueStatus> | ASCII - Integer | Step’s Key Value Status of an expression: 0 or blank = "OK or not an expression" 1= "Override" 2="Exception" 3="Override", "Exception" 4="Out of Range" 5="Override", "Out of Range" 6="Exception","Out of Range" 7="Override", "Exception", "Out of Range" The field may contain a single space character if the step does not have a key parameter value or if the key parameter is not a parameter expression. | |
<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’s 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
NONE PROGRAM
EXTERNAL
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> \t <CurrentStatus> | |
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. | |
<CurrentStatus> | ASCII - Integer | Current status of value if parameter is an expression: 0 or blank = "OK or not an expression" 1= "Override" 2="Exception" 3="Override", "Exception" 4="Out of Range" 5="Override", "Out of Range" 6="Exception","Out of Range" 7="Override", "Exception", "Out of Range" The field may contain a single space character if the parameter is not a parameter expression. | |
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 table shows an example of the return on this request.
Example: | A request on object . GetItem(17Status) could return:0\crlf124\tBATCH_ID\t1\t\t \t \tHELD\tO_AUTO\t \tPROGRAM\t \t0\t \t \t \t$PARM\tMILK_AMOUNT\t1999\t \tSUGAR_AMOUNT\t750\t \tCREAM_AMOUNT\t2001\t \tEGG_AMOUNT\t200\t \tFLAVOR_AMOUNT\t50\t \t$END\t$REPORT\t \t$END\t \t \t2341\crlf129 \t \t \crlf125\tCLS_FRENCHVANILLA_UP:1\t2 \tFLAVOR_AMOUNT\tWP_FREEZER1\t \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 \t \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 \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 \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 |
Example: | A request on object . GetItem(17 \t MCLS_SWEETCREAM_UP:1 \t MCLS_SWEETCREAM_OP:1Status) could return:0/crlf422/tCLS_SWEETCREAM_OP:1/t3/t/t /t /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/crlf436/t /t /crlf431/tADD_CREAM:1/t4/tADD_AMOUNT/t2001/tKG/t /t /tP_AUTO/tWP_MIXER1/t /t /t0/t /t /t /t$PARM/tADD_AMOUNT/t2001/t /t$END/t$REPORT/tAMOUNT_ADDED/t???/t$END/t /t /t0/crlf432/tADD_EGG:1/t4/tADD_AMOUNT/t200/tKG/t /tHELD/tP_AUTO/tWP_MIXER1/tPROGRAM/t10/t0/t/t0/t /t$PARM/tADD_AMOUNT/t200/t /t$END/t$REPORT/tAMOUNT_ADDED/t???/t$END/t-1042/t36:CLS_FRENCHVANILLA\CLS_SWEETCREAM_UP:1\CLS_SWEETCREAM_OP:1/t32/crlf433/tADD_MILK:1/t4/tADD_AMOUNT/t1999/tKG/t /t /tP_AUTO/tWP_MIXER1/t /t /t0/t /t /t /t$PARM/tADD_AMOUNT/t1999/t /t$END/t$REPORT/tAMOUNT_ADDED/t???/t$END/t /t /t0/crlf434/tADD_SUGAR:1/t4/tADD_AMOUNT/t750/tKG/t /tHELD/tP_AUTO/tWP_MIXER1/tPROGRAM/t10/t0/t/t0/t /t$PARM/tADD_AMOUNT/t750/t /t$END/t$REPORT/tAMOUNT_ADDED/t???/t$END/t-1042/t36:CLS_FRENCHVANILLA\CLS_SWEETCREAM_UP:1\CLS_SWEETCREAM_OP:1/t32/crlf435/tAGITATE:1/t4/tSPEED_RATE/t25 RPM/t /tHELD/tP_AUTO/tWP_MIXER1/tPROGRAM/t10/t0/t/t0/t /t$PARM/tSPEED_RATE/t25/t /t$END/t$REPORT/tMIX_SPEED/t???/t$END/t-1042/t36:CLS_FRENCHVANILLA\CLS_SWEETCREAM_UP:1\CLS_SWEETCREAM_OP:1/t32/crlf437/tTEMP_CTL:1/t4/tTEMP_SP/t71.1/tDEG C/t /t /tP_AUTO/tWP_MIXER1/t /t /t0/t /t /t /t$PARM/tHOLD_TIME/t5/t /tTEMP_SP/t71.1/t /t$END/t$REPORT/tTEMPERATURE/t???/tTIME_HELD/t???/t$END/t /t /t0/crlf438/t /t /crlf439/tIDLE/t /t0/t0/crlf440/tHELD/t /t0/t0/crlf441/tIDLE/t /t0/t0/crlf442/tHELD/t /t0/t0/crlf |
Provide Feedback