BatchList
The
BatchList
item returns a list of all batches in the system.This table shows the input and output formats for this item.
Format | Description | ||
|---|---|---|---|
Input Format | Request: BatchList | ||
Output Format | The BatchList item returns in this format: | ||
<BatchList> | is | <NullList>
|
<BList> | |
<BList> | is | <Batch>
\crlf |
<Batch>
\crlf
<BList> | |
<Batch> | is | <BatchID>
\t
<RecipeName>
\t
<BatchDesc>
\t
<StartTime>
\t
<ElapsedTime>
\t
<State>
\t
<Mode>
\t
<Failures>
\t
<CreateID>
\t
<CmdMask>
\t
<BatchType>
\t
<ProcCellList>
\t
<UnitList>
\t
<PhaseList> | |
where <Batch> is: | |||
Field Name | Format | Description | |
<BatchID> | ASCII - String | Operator-entered batch identification number. | |
<RecipeName> | ASCII - String | Procedure identifier from FactoryTalk Batch Recipe Editor . | |
<BatchDesc> | ASCII - String | Procedure description from FactoryTalk Batch Recipe Editor . | |
<StartTime> | ASCII - String | Starting time for the batch, formatted according to Control Panel. May be a
single space character. | |
<ElapsedTime> | ASCII - String | Time elapsed since batch started. If batch has not yet, started zero length
string returns: 0:00:00. | |
<State> | ASCII - String | Current state of the batch. (Localized) | |
<Mode> | ASCII - String | Current mode of the recipe. (Localized) | |
<Failures> | ASCII - String | Describes failure message. | |
<CreateID> | ASCII - Integer | Unique batch ID assigned by the FactoryTalk Batch Server. | |
<CmdMask> | ASCII - Integer | Command masks | |
<BatchType> | ASCII - Integer | Type of control: 1 = Recipe 2 = Manual Phase control | |
<ProcCellList> | Variable | Process Cell(s) in which batch is running. | |
<UnitList> | Variable | Unit(s) in which batch is running. | |
<PhaseList> | Variable | List of active phases in the recipe at this time. | |
where <ProcCellList> is: | |||
<ProcCellList> | is | <NullList>
|
<PCList> | |
<NullList> | is | $PRCL \t
<sp>
$END | |
<PCList> | is | $PRCL \t
<ProcessCells>
\t $END | |
<ProcessCells> | is | <PCellName>
|
<PCellName>
\t
<ProcessCells> | |
where: | |||
Field Name | Format | Description | |
<PCellName> | ASCII - String | Procedure cell’s name | |
where <UnitList> is: | |||
<UnitList> | is | <NullList>
|
<UList> | |
<NullList> | is | $UNIT \t
<sp>
$END | |
<UList> | is | $UNIT \t
<Units>
\t $END | |
<Units> | is | <UnitName>
|
<UnitName>
\t
<Units> | |
where: | |||
Field Name | Format | Description | |
<UnitName> | ASCII - String | Unit’s Name | |
where <PhaseList> is: | |||
<PhaseList> | is | <NullList>
|
<PHList> | |
<NullList> | is | $PHASE \t
<sp>
$END | |
<PHList> | is | $PHASE \t
<Phases>
\t $END | |
<Phases> | is | <PhaseName>
|
<Phasename>
\t
<Phases> | |
where: | |||
Field Name | Format | Description | |
<PhaseName> | ASCII - String | Phase’s Name | |
This is an example of the return on this request.
TIP:
A request on the
object.GetItem(Batchlist)
could return:BATCH_98 \t CLS_FRENCHVANILLA \t FRENCH VANILLA PREMIUM - CLASS BASED \t \t 0:00:00 \t READY \t O_AUTO \t \t 15 \t 18976 \t 1 \t $PRCL \t SOUTH_PARLOR \t $END \t $UNIT \t SP_MIXER1 \t SP_FREEZER1 \t $END \t $PHASE \t $END \crlf
BATCH_99 \t CLS_FRENCHVANILLA \t FRENCH VANILLA PREMIUM - CLASS BASED \t \t 0:00:00 \t READY \t O_AUTO \t \t 16 \t 18976 \t 1 \t $PRCL \t SOUTH_PARLOR \t $END \t $UNIT \t SP_MIXER1 \t SP_FREEZER1 \t $END \t $PHASE \t $END \crlf
BATCH_100 \t MCLS_FRENCHVANILLA \t FRENCH VANILLA PREMIUM - CLASS BASED/MATERIAL BASED \t \t 0:00:00 \t READY \t O_AUTO \t \t 17 \t 18976 \t 1 \t $PRCL \t NORTH_PARLOR \t $END \t $UNIT \t NP_MIXER2 \t NP_FREEZER2 \t $END \t $PHASE \t $END \crlf
Provide Feedback