CancelSignature
The
CANCELSIGNATURE
execute allows a client to cancel a signature request on an incomplete signature, excluding those that were generated by private interfaces.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[CANCELSIGNATURE( Item, UserID, SignatureID )] | |
where: | ||
Field | Format | Description |
Item | ASCII - String | Name of the response item, as specified by the client. |
UserID | ASCII - String | User Identification entered into the event journal associated with this event. |
SignatureID | ASCII - Integer | Unique ID of the signature to be cancelled. |
Action | A successful CANCELSIGNATURE request cancels the specified signature if it is in the incomplete state and not generated by a private interface. | |
Return Format | The response item populates with this data: SUCCESS: | FAIL: <message> | |
where: | ||
Field | Format | Description |
<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: CancelSignature(Item,Station2/View,993) Could return: SUCCESS: |
Provide Feedback