Phase3

The
PHASE3
 execute commands a phase or equipment operation sequence to a specified state. This execute includes parameters that support the commanding of phases that are configured to use control strategies and those associated with a material-enabled phase class.
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:
[PHASE3(
Item,UserID,EquipmentID,Cmd,BatchID,Unit,
ControlStrategyID,ContainerName,ContainerControllerID, MaterialName,LotName,LabelName,FeedType
)]
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.
ControlStrategyID
Value of the control strategy to use with the phase.
If
Control Strategy
 is disabled, this field must contain negative one (
-1)
.
ContainerName
Container name this phase is to bind with.
For material-enabled phases, this is required data.
Container
ControllerID
Value returned by the GETCONTAINERDATA execute. This is the controller ID for the container.
For material-enabled phases, this is required data.
MaterialName
Name of the material required by the phase.
For material-enabled phases, this is required data.
LotName
Lot name to filter containers for material additions, optional for material-enabled phases.
If the phase is not material-enabled or the execute is being used to command an equipment operation sequence, this field must be blank (single blank space character).
LabelName
Label name to filter containers for material additions, optional for material-enabled phases.
If the phase is not material-enabled or the execute is being used to command an equipment operation sequence, this field must be blank (single blank space character).
FeedType
Specifies whether the phase adds material to the unit or distributes material from the unit.
If the phase is not material-enabled or the execute is being used to command an equipment operation sequence, this field must be blank (single blank space character).
These are the valid values:
  • ADDITION
  • DISTRIBUTION
Action
A successful PHASE3 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
    .
  • For a phase using a control strategy, the
    Control Strategy
     term is used.
  • For material-enabled phases, the
    ContainerName
    ,
    ContainerControllerID
    ,
    MaterialName
    ,
    LotName
    ,
    LabelName
    , and
    FeedType
     terms are all used. The PHASE3 execute does not check that the phase is configured to support the specified
    FeedType
     (addition or distribution).
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
Action ID 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 to start a material-enabled phase.
Example:
An execute string consisting of:
PHASE3(Item,Station2/View,29,START,MAKESTUFF,BIGMIXER,2,TEMP_EGG,27,EGG_YOLK, , ,ADDITION)
Could return:
SUCCESS:997
The following table shows an example of the return on this execute to start a control strategy and material-enabled phase.
Example:
An execute string:
[PHASE3(Item,STATION5/Operator,71,START, BATCH_ID, NP_MIXER1, Strategy_1,TEMP_EGG,27,EGG_YOLK, , ,ADDITION)]
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal