Phase execute command

The
PHASE
execute commands a phase or an equipment operation sequence to a specified state.
The operator must own the phase or equipment operation sequence in order to change it.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[PHASE(
Item,UserID,EquipmentID,Cmd,BatchID,Unit
)]
where:
Item
Item name as specified by the client.
UserID
User identification entered into the event journal associated with this event.
EquipmentID
Unique equipment ID for the phase or equipment operation sequence.
Cmd
Command for the phase or equipment operation sequence. Valid commands are:
START, STOP, RESET, RESUME, HOLD, RESTART, PAUSE, ABORT, DOWNLOAD, DISCONNECT, AUTO-MODE, SEMIAUTO-MODE, CLEAR_ FAILURES
BatchID
Identifier for the batch that is required for journals associated with this phase or equipment operation sequence.
Unit
Name of the unit to use with the phase or equipment operation sequence.
Action
A successful PHASE execute results in the specified command either being queued pending a signature confirmation, or being issued to the specified phase or equipment operation sequence.
If the command is valid and a batch does not already exist for manual control of the phase or equipment operation sequence, then a batch is created using the specified
BatchID
 and
Unit
.
A failure message is generated when the following occurs:
  • The command was not legal based on the current state or properties of a phase or equipment operation sequence.
  • The phase or equipment operation sequence is under external control.
  • The equipment ID that is passed does not match the ID of a phase or equipment operation sequence.
Return Format
The item populates with this data:
SUCCESS: | SUCCESS:
<ActionID>
| FAIL:
<message>
| FAILED
where:
Field
Format
Description
<ActionID>
ASCII – Integer
Identifier associated with the signature(s) generated in response to the execute.
<message>
ASCII - String
Error message appropriately formatted for operator display.
The following table shows an example of the return on this execute.
Example:
An execute string consisting of:
PHASE(Item,Station2/View,29,START,MAKESTUFF,BIGMIXER)
Could return:
SUCCESS:997
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal