PhaseIDPhaseData

The
PhaseIDPhaseData
 item returns current status information for a phase or equipment operation sequence denoted by the PhaseID.
The
PhaseIDPhaseData
 item was created to be used in place of the
PhaseDataList
 item. The
PhaseDataList
 item returns data on all phases or equipment operation sequences within an equipment database, where the
PhaseIDPhaseData
 item returns data only for the specified phase or equipment operation sequence.
This table shows the input and output formats for this item.
Input Format
Advise:
PhaseIDPhaseData
PhaseID
is
Unique equipment ID corresponding to the phase or equipment operation sequence.
Output Format
The PhaseIDPhaseData item returns in this format:
<PhaseIDPhaseData>
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>
where <Phase> is:
Field Name
Format
Description
<PhaseID>
ASCII - Integer
Unique equipment ID corresponding to the phase or equipment operation sequence.
<PhaseName>
ASCII - String
Name of the phase or equipment operation sequence configured in
FactoryTalk Batch Equipment Editor
.
<PhaseState>
ASCII - String
Current state of the phase or equipment operation sequence.
<Pausing>
ASCII - Integer
Pause and Paused attributes with the following valid values:
  • 0 = Not significant
  • 1 = Pausing – Pause && !Paused
  • 2 = Paused – Paused
<Mode>
ASCII - String
Mode of the phase or equipment operation sequence.
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:
  • PS-AUTO
  • PS-SEMI
If the phase or equipment operation sequence 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 valid units.
where:
<ValidUList>
is
<UnitName>
|
<UnitName>
\t
<ValidUList>
Field Name
Format
Description
<UnitName>
ASCII - String
Name of the unit.
This table shows an example of the return on this request.
Example:
A request on
object
.
GetItem(68PhaseData)
could return:
68 \ t NP_ADDDAIRY_M1 \t COMPLETE \t 0 \t P_AUTO \t 1 \t 32 \t 55 \t NP_MIXER1 \t PROGRAM \t BATCH_ID \t \t FEED_COMPLETE NOT COMPLETE. \t 10 \t NP_MIXER1\crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal