Command

The
COMMAND
execute commands a procedure to a desired state or mode.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[COMMAND(
Item,UserID,ProcedureID,Cmd
)]
where:
Item
Item name as specified by the client.
UserID
User identification entered into the event journal associated with this event.
ProcedureID
Unique hierarchical path name to the procedure, unit procedure, operation or phase:
Procedure: CreateID
Unit Procedure: CreateID \t UnitProcIDName
Operation: CreateID \t UnitProcIDName \t OperIDName
Phase: CreateID \t UnitProcIDName \t OperIDName \t PhaseIDName
Cmd
Command either to change the state or mode. Commands which may be issued are:
  • STARTSTOPAUTO-MODE
  • PAUSEHOLDRESTART
  • MAN-MODERESUMEABORT
  • RESETDOWNLOADCLEAR_FAILURES
  • DISCONNECTSEMIAUTO-MODE
  • TIMER-CompleteTIMER-Reset
The command must be valid for the procedure level being commanded.
where:
<FullPath>
is
<CreateID>
|
<CreateID>
/t
<Path>
<Path>
is
<StepIdentifier>
|
<StepIdentifier>
/t
<Path>
where:
Field
Format
Description
<CreateID>
ASCII - Integer
Unique batch ID assigned by the
FactoryTalk Batch
 Server.
<StepIdentifier>
ASCII – String
Step identifier (for example, Mix:1)
Action
A successful COMMAND execute results in either the command being issued to the specified procedure element, or in the command being queued pending completion of the confirmation signature.
A COMMAND execute results in a failure message when the Command sent is equal to the current batch state.
Example: If a batch is running and a START or RESTART execute is issued, the command will return a failure message.
Return Format
The item populates with this data:
SUCCESS: | SUCCESS:
<ActionID>
| FAIL:
<message>
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.
Example:
An execute string consisting of:
COMMAND(Item,Station2/View,36,START)
Could return:
SUCCESS:997
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal