Operating Principle
The DocuSign Watcher monitors if a document has been signed. The workflow is started as soon as a document is signed and therefore a web service call has been sent to FireStart. When configuring the DocuSign Watcher, several credentials are required in order to properly configure the watcher.
Required Parameters
EnvelopeId: Every document sent out for signature is in a specific envelope with a unique ID. You use the envelopeId to specify the envelope which should be watched.
ExpectedStatus: The expected status gives information about the operation which should be watched, e.g., signed which means that the watcher monitors whether the documents of the specified envelope have been signed. All available values for status are explained in the section Envelope Status.
IntegratorKey: Every DocuSign user has a unique integrator key which has to be entered in this field.
IsProduction: A boolean value that specifies whether the production or test environment is used.
User: Contains the username of the user who sent out the envelope for signature. Other users won't have authorization to the envelope.
Password: This field consists of the password to the user mentioned above.
Envelope Status
- authoritativecopy: The envelope is in an authoritative state. Only ‘Copy’ views of the documents will be shown.
- completed: The envelope has been completed by all the recipients.
- created: The envelope has been opened by the sender for correction. The signing process is stopped for envelopes with this status.
- correct: The envelope is in a draft state and has not been sent out for signing.
- declined: The envelope has been declined for signing by one of the recipients.
- deleted: This is a legacy status and is no longer used.
- delivered: All recipients have viewed the document(s) in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope.
- sent: An email notification with a link to the envelope has been sent to at least one recipient. The envelope remains in this state until all recipients have viewed it at a minimum.
- signed: The envelope has been signed by all the recipients. This is a temporary state during processing, after which the envelope is automatically moved to status Completed.
- template: The envelope is a template.
- timedout: This is a legacy status and is no longer used.
- transfercompleted: The envelope has been transferred out of DocuSign to another authority.
- voided: The envelope has been voided by the sender.
Configuration
To configure the DocuSign Watcher, you first need to set a Timer event as Start event. In the timer event configuration, you can now select the DocuSignWatcher under the Custom Check Routine. The Event type does not require further configuration, as this can be done over the field ExpectedStatus in the routine parameters.
After that, the input parameters need to be configured. To do that, you can first select a business entity and then click the button Routine parameter to open the dialog. If you would like to use a variable for the path, you now have all fields of the previously selected business entity available. But the credentials can also be entered manually by clicking Add text property and for example entering the name of the user. Now you have to map the entered text fields or selected business entity to the target fields. You simply have to drag and drop the source field to the target field and confirm the configuration by clicking the OK button.
Back in the Start event dialog, you have to click OK once again and the DocuSign Watcher has been configured successfully.