PhaseDataList

The
PhaseDataList
 item lists information about all of the phases in the system. The
PhaseDataList
 item exposes a large amount of data for each phase. This can cause a significant processing load on the data server,
FactoryTalk Batch
 Server, and client. The
PhaseIDPhaseData
 item can be used in place of the
PhaseDataList
 item, only returning data for a specific phase.
Disable the
PhaseDataList
 item and the
PhaseErrs
 item by this setting in the
FactoryTalk Administration Console
FactoryTalk Batch Services Properties
Advanced
 tab:
DisablePhaseDataList = YES
If the items are disabled, the
FactoryTalk Batch
 Server does not return any data if issued a request for either of these items. If the
DisablePhaseDataList
 item is set to
YES
, the
Alarm Summary
 and
Phase/Operation Summary
 windows in
FactoryTalk Batch View
 will not display any data.
This table shows the input and output formats for this item.
Input and output formats
Format
Description
Input Format
Request:
PhaseDataList
Output Format
The PhaseDataList returns in this format:
<PhaseDataList>
is
<Phase>
\crlf |
<Phase>
\crlf
<PhaseDataList>
<Phase>
is
<PhaseID>
\t
<PhaseName>
\t
<PhaseState>
\t
<Pausing>
\t
<Mode>
\t
<ArbMask>
\t
<CmdMask>
\t
<UnitID>
\t
<UnitName>
\t
<Owner>
\t
<BatchID>
\t
<FailMsg>
\t
<PhaseMsg>
\t
<StepIndex>
\t
<ValidUList>
\crlf
where <Phase> is:
Field Name
Format
Description
<PhaseID>
ASCII – String
Equipment ID of phase.
<PhaseName>
ASCII – String
Name of phase configured in
FactoryTalk Batch Equipment Editor
.
<PhaseState>
ASCII – String
Current state of the phase.
<Pausing>
ASCII – Integer
Pause and Paused attributes:
  • 0 = not significant
  • 1 = Pausing – Pause && !Paused
  • 2 = Paused – Paused
<Mode>
ASCII - String
Mode of the phase.
When recipe control is used, these are the valid values:
  • O-AUTO
  • P-AUTO
  • S-AUTO
  • MANUAL
When manual control is used, these are the valid values:
  • PH-AUTO
  • PH-SEMI
If the phase is not part of a running recipe or owned by the operator, a blank character is returned.
<ArbMask>
ASCII - String
Arbitration mask.
<CmdMask>
ASCII - String
Command mask.
<UnitID>
ASCII - Integer
Identifier for the unit.
<UnitName>
ASCII - String
Name of the unit.
<Owner>
ASCII - String
Current owner:
  • NONE
  • PROGRAM
  • OPERATOR
  • EXTERNAL
<BatchID>
ASCII - String
User-entered identifier for the batch.
<FailMsg>
ASCII - String
Failure message.
<PhaseMsg>
ASCII - String
Phase message.
<StepIndex>
ASCII - Integer
Value of the
Step Index
 tag in the process-connected device.
<ValidUList>
Variable list
List of the valid units.
where:
<ValidUList>
is
<UnitName>
|
<UnitName>
\t
<ValidUList>
Field Name
Format
Description
<UnitName>
ASCII - String
Name of the valid unit.
This is an example of the return on this request.
A request on
object
.
GetItem(PhaseDataList)
 could return:
5 \t WP_ADD_CREAM_M1 \t IDLE \t 0 \t \t 1 \t 0 \t 0 \t \t UNKNOWN \t \t \t \t 0 \t WP_MIXER1 \crlf
6 \t WP_ADD_CREAM_M2 \t IDLE \t 0 \t \t 1 \t 0 \t 0 \t \t UNKNOWN \t \t \t \t 0 \t WP_MIXER2 \crlf
...
104 \t MP_DUMP_MF2 \t IDLE \t 0 \t \t 1 \t 0 \t 0 \t \t UNKNOWN \t \t \t \t 0 \t MP_MIXERFREEZER2 \crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal