Remove

The
REMOVE
 execute removes a batch from the batch list.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[REMOVE(
Item,UserID,CreateID
)]
where:
Item
Response item name as specified by the client.
UserID
User identification entered into the event journal associated with this event.
CreateID
Unique identification number for a batch.
Action
A successful REMOVE execute results in the removal of the specified batch from the batch list, or in the queuing of the removal pending a signature. In order to be successfully removed, a batch cannot be in Manual mode and must be in one of these states:
  • READY
  • COMPLETE
  • STOPPED
  • ABORTED
Return Format
The item populates with this data:
SUCCESS: | SUCCESS:
<ActionID>
| FAIL:
<message>
where:
Field
Format
Description
<ActionID>
ASCII – Integer
Action 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:
[REMOVE(Item,Station5/Operator,235)]
Could return:
SUCCESS:997
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal