SignoffSignature

The
SIGNOFFSIGNATURE
 execute allows a client to sign a signature request on an incomplete signature, excluding those generated by private interfaces.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[SIGNOFFSIGNATURE(
Item, UserID, SignatureID, SignoffNumber, Domain, Comment, SignerID, Password
)]
where:
Item
Response item name as specified by the client.
UserID
User Identification entered into the event journal associated with this event.
SignatureID
Unique ID of the signature for which the signoff is intended.
SignoffNumber
Signoff number for which the signoff is intended
(1 or 2).
Comment
Comment string being passed with signoff. The locale-specific list separator character should be escaped from the comment argument as follows:
The client application shall replace all instances of the
‘/’ character with ‘/FS’.
The client application shall then replace all instances of the list separator character with ‘/LS’.
The tab character shall be considered illegal for the comment argument. If a tab character is detected in the comment string, the execute shall fail.
Domain
Domain to be used when authenticating the SignerID parameter.
SignerID
Security-related User ID of the user attempting the signoff (not the full name).
Password
Security-related password of the User attempting the signoff.
Action
A successful SIGNOFFSIGNATURE fulfills a signoff on an incomplete signature.
Return Format
The response item populates with this data:
SUCCESS:
<ActionID>
| FAIL:
<message>
Where action ID = integer value; the Action ID of the action that required the signature. (Only the final sign-off of a Signature returns an Action ID.)
where:
Field
Format
Description
<ActionID>
ASCII – Integer
Action identifier associated with signature(s) generated as a result of the potential parameter value change. The parameter value will not actually change unless all signatures are successfully signed.
<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:
SIGNOFFSIGNATURE(Item,Station2/View,993,1,Italy,What is this,LDVinci, helicopter)
Could return:
SUCCESS: or SUCCESS:Action ID
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal