CreateIDBatchStepDataList
The
CreateIDBatchStepDataList
item returns a list of all the steps in a recipe batch, and each step’s status.This table shows the input and output formats for this item.
Input Format | Request: CreateIDBatchStepDataList | ||
CreateID | is | ASCII – Integer, INTERNAL identifier assigned by the FactoryTalk Batch Server to a batch when it is created. Obtained from the BatchList item. | |
Output Format | The CreateIDBatchStepDataList item returns in this format: | ||
<BSList> | is | <NullList> | <StepList> | |
<StepList> | is | <Step> \crlf | <Step> \crlf <StepList> | |
<Step> | 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 <RepParmList> \t <OwnerID> \t <OwnerName> \t <CmdMask> | |
where: | |||
Field Name | Format | Description | |
<ID> | ASCII - Integer | Element ID (defined by ProcedureIDData 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’s Key Value: may contain a single space if the step does not have a key parameter value. | |
<State> | ASCII - String | Element State | |
<Mode> | ASCII - String | Step’s Mode:
| |
<UnitName> | ASCII - String | Unit under which the Step runs. | |
<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 | Indicates if the step is Paused.
Only a Phase can have Paused = True. All others are False. | |
<Msg> | ASCII - String | Step Message | |
<Rqst> | ASCII - Integer | Step Request, contents of request register | |
<Fail> | ASCII- String | Fail Message, single space if not active or no failures | |
<ParmList> | Variable list | List of recipe parameters | |
<RepParmList> | Variable list | List of report parameters | |
<OwnerID> | ASCII - Integer | Element Owner ID, single space if step not of phase | |
<OwnerName> | ASCII - String | Owner Name, single space if step not of phase | |
<CmdMask> | ASCII - Integer | Command masks | |
where <KeyValue> is: | |||
<KeyValue> | is | <ValueAndEU> | <EquipmentID> | |
<ValueAndEU> | is | <DefaultValue> <sp> <EngUnits> | |
where <ValueAndEU> is: | |||
Field Name | Format | Description | |
<EquipmentID> | ASCII – String | Unique ID corresponding to the step. | |
<DefaultValue> | ASCII – String | Default value of display parameter | |
<EngUnits> | ASCII – String | Engineering units associated with default value | |
where <ParmList> is: | |||
<ParmList> | is | $PARM \t <Parameters> \t $END | |
<Parameters> | is | <NullList> | <PList> | |
<PList> | is | <Parameter> | <Parameter> \t <PList> | |
<Parameter> | is | <ParmName> \t <Value> | |
Field Name | Format | Description | |
<ParmName> | ASCII – String | Parameter Name | |
<Value> | ASCII – String | Current batch value. ??? indicates that there is no value assigned. | |
where <RepParmList> is: | |||
<RepParmList> | is | $REPORT \t <Parameters> \t $END | |
<Parameters> | is | <NullList> | <RList> | |
<RList> | is | <Parameter> | <Parameter> \t <RList> | |
<Parameter> | is | <ParmName> \t <Value> | |
Field Name | Format | Description | |
<ParmName> | ASCII – String | Report Parameter Name | |
<Value> | ASCII – String | Current batch value | |
This table shows an example of the return on this request.
TIP:
The BatchList contains a batch with the CreateID of 21. Use this Request to see a list of steps for this batch: object.GetItem(21BatchStepDataList), which could return:
627 \t BATCH_ID \t 3 \t \t MP_MIXERFREEZER2 \t RUNNING \t O_AUTO \t MP_MIXERFREEZER2 \t PROGRAM \t \t 0 \t \t \t \t $PARM \t \t $END \t $REPORT \t \t $END \t \t \t 2087 \crlf
661 \t MBR_ADD:1 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t MATERIAL \t SUGAR_GRANULATED \t AMOUNT \t 800 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t 700 \t FEED_COMPLETE \t YES \t $END \t \t \t 262144\n662 \t AGITATE:1 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t SPEED_RATE \t 5 \t $END \t $REPORT \t MIX_SPEED \t 30 \t $END \t \t \t 0 \crlf
632 \t MBR_ADD:2 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t MATERIAL \t EGG_YOLK \t AMOUNT \t 180 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t 150 \t FEED_COMPLETE \t YES \t $END \t \t \t 262144\n636 \t MBR_ADD:3 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t MATERIAL \t CREAM \t AMOUNT \t 2000 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t 2000 \t FEED_COMPLETE \t YES \t $END \t \t \t 262144 \crlf
660 \t TEMP_CTL:1 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \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
659 \t AGITATE:2 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t SPEED_RATE \t 5 \t $END \t $REPORT \t MIX_SPEED \t 30 \t $END \t \t \t 0 \crlf
658 \t MBR_ADD:4 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t MATERIAL \t MILK \t AMOUNT \t 2000 \t $BINDCONTAINER \t NULL_CONTAINER \t $BINDEQMODULE \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t 2000 \t FEED_COMPLETE \t YES \t $END \t \t \t 262144\n640 \t AGITATE:3 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t \t \t \t \t $PARM \t SPEED_RATE \t 5 \t $END \t $REPORT \t MIX_SPEED \t 30 \t $END \t \t \t 0 \crlf
644 \t MBR_ADD:5 \t 4 \t \t \t RUNNING \t P_AUTO \t MP_MIXERFREEZER2 \t PROGRAM \t 10 \t 0 \t \t 0 \t \t $PARM \t MATERIAL \t VANILLA \t AMOUNT \t 20 \t $BINDCONTAINER \t TEMPFLAVOR_VANILLA \t $BINDEQMODULE \t MP_ADDFLAVOR_MF2 \t $END \t $REPORT \t ACTUAL_AMOUNT \t \t FEED_COMPLETE \t \t $END \t -1142 \t 21:FRENCH_VANILLAPREMIUM1_MEGA_PARLOR_OPT_1_O1 \t 32 \crlf
TIP:
Continued
657 \t TEMP_CTL:2 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \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 \t
TIME_HELD \t \t $END \t \t \t 0\n648 \t RECIRC:1 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t
\t 0 \t \t \t \t \t $PARM \t RECIRC_RATE \t 50 \t $END \t $REPORT \t FINAL_RECIRC_RATE
\t \t $END \t \t \t 0\n652 \t MBR_DUMP:1 \t 4 \t \t \t \t \t MP_MIXERFREEZER2 \t \t 0 \t
\t \t \t \t $PARM \t MATERIAL \t IC_FRENCH_VANILLA \t AMOUNT \t -5000 \t $BINDCONTAINER
\t \t $BINDEQMODULE \t \t $END \t $REPORT \t ACTUAL_AMOUNT \t \t FEED_COMPLETE \t \t
$END \t \t \t 262144 \crlf
Provide Feedback