DocuSign Actions
Contact your sales representative if you are interested in obtaining a license for the DocuSign Connector Module for your SmartIQ environment.
To use DocuSign in a project use the DocuSign Actions, most likely "Create DocuSign Envelope". Add values to the mandatory inputs of the action, these are: Recipient Name, Recipient Email, Email Subject, and Email Blurb
The DocuSign actions reflect the DocuSign's REST API endpoints, which the connector interfaces with internally, and the action inputs either match the endpoint inputs or provide some level of additional control over the action.
For all DocuSign actions there are two optional Account Settings inputs
| Input | Description |
|---|---|
| Account Id | Optional value, used where the default account id for the global Admin API Username is not the one needed for the project and an alternative account id is entered here. (Note that this needs to be a guid value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) rather than an integer ID.) |
| Admin API Username | Optional value, used where the default Admin API Username in the Global Connector Settings is not the one needed for the project, an alternative Admin API Username is entered here. If an Account Id is also supplied, it needs to be a valid account id for this User. This value will override the global Admin API Username only for this project. |
Create DocuSign Envelope
While the action extensions are installed, they will not be called until a project is set up in SmartIQ with one or more of the DocuSign actions, with action attributes that instruct the action providers on how to behave.
Action attributes can be set up with fixed values within Design, or they can be set up to refer to values collected via the question set during the generation process.
The Create DocuSign Envelope action supports most of the fields to create and send an envelope using the DocuSign REST API.
Note that since the structure of the action attributes are closely aligned with a DocuSign Create Envelope’s Json request or as when you use the DocuSign REST API Explorer, most of the action attributes’ definition can be found here.
| Input | Description |
|---|---|
| Joint Agreement Network Id | exclusive to only Carbon Copy recipient types. It also corresponds to the LinkedAccountConfigurationId property within a DocuSign payload's Carbon Copy recipients array. Only one instance of this input can be added per recipient. |
| Excluded Document Name | supports inputs containing either a single document name or a list of document names. These lists support commas, semi-colons, and pipe delimiters ( ',', ';', '|'). Multiple instances of the input is also still supported. |
Anchor Tags
If you use DocuSign Anchor Tags in your documents, the Tags must be unique across all documents as when anchor tabs are used, all documents in the envelope are searched by DocuSign for the AnchorTabString.
You can find SmartIQ sample projects Click Here
DocuSign Notary
SmartIQ supports DocuSign Notary. This is done by providing the action input value on Recipient Type - Notary Recipient and Tab Type - Notary Seal in the Create Envelope action. However, the signing recipient must have a Client User Id.
Things to note:
- DocuSign Notary is a feature that might not be available for all customers. Contact DocuSign support for more information.
- The following should be set up in DocuSign:
- The user defined in "Admin Api Username" must have organization_read, notary_read, and notary_write permissions, in addition to the existing signature, and impersonation permissions.
- There should be existing organisations, notaries, and organisational invites and already set up.
- The first notary signing request should have been performed and tested on the DocuSign site.
Create DocuSign Embedded Signing URL
Once you’ve added the Create DocuSign Embedded Signing URL action to your project, either on the Finish page, a workflow transition, or action button, configure any action attributes that you require.
The action has an output URL which returns the URL that was created by the action, so it can be used by other Actions. Automatic redirect is optional through an Input Redirect, which defaults to true. The Redirect option only applies outside of an Action Button.
If you use DocuSign Templates this action has the ability to use a SmartIQ-native DocuSign template as an Action Document. This action then redirects to signing instead of sending the form to email.
map the Client User Id to a unique identifier and provide Return URL values, Delete the Envelope Id.
| Name | Description |
|---|---|
| Envelope Id | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
| Client User Id | To perform embedded signing ceremony, the Create DocuSign Embedded Signing URL action requires that you specify which person will be signing by provide the Client User Id that uniquely identify that person. Note: The Client User Id provided in this action must be the exact same as what you used in the Create DocuSign Envelope action. |
| Return Url | The URL that the signer’s browser will be re-directed to after the signer has finished. This value could also be set globally across all projects in the DocuSign Connector Settings. |
Client User ID
When using a DocuSign Template, the Client User ID input can be omitted, as SmartIQ will automatically retrieve the Client User ID value that was mapped to the template. For this reason the action input is not marked as mandatory - but it still must be supplied if the Embedded Signing URL action is used in conjunction with the Create Envelope Action.
Once all the action attributes are configured, the Create DocuSign Embedded Signing URL action will create an embedded signing URL and immediately redirect the user to that URL to perform a signing ceremony.
Get DocuSign Document
There's a new action included with DocuSign Connector that allows to include DocuSign Documents into SmartIQ in other words, it will allow to include signed documents (individually selected or combined) and the certificate of completion in subsequent Actions and Connectors, for example, storing those documents into Microsoft SharePoint.
Certificate of Completion generation is done using the Get DocuSign Document action
Defining the envelope id input by referencing the original envelope id generated in the create envelope action '[DocuSign Create Envelope.Envelope Id]', and defining the Document id as "certificate", generates a certificate.
| Input | Description |
|---|---|
| Envelope Id | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
| Document Id | The ID of the document being accessed. You can query this value using the Connector Datasource Get Envelope Documents. If no document ID is provided, the action will default to combined option, where all DocuSign Documents included in the envelope are stitched and returned as a PDF. |
| Document Display Name | Name of the downloaded document, this value will be used by SmartIQ. |
| Certificate Language | Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified, Chinese Traditional, Dutch, English US, French, German, Italian, Japanese, Korean, Portuguese, Portuguese (Brazil), Russian, Spanish. |
| Include Certificate | Includes the Certificate page with the documents retrieved from DocuSign. The default value is True. |
| Show Changes | When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. |
| Watermark | When set to true, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. |
Note
One action per document downloaded is required.
DocuSign Modify Envelope
Allows a user to perform the following actions on an envelope:
- Modify a particular signer’s name or email address
- Resend the envelope to all recipients
- Void Envelope
Note
Modification to signer’s name or email will automatically notify the recipient that was modified, however you can also include the Resend Envelope flag to resend the envelope to all signers, not just the ones that had to be modified. However, if an envelope has to be voided, the action needs to be done by itself.
Action Inputs
| Input | Description |
|---|---|
| Envelope Id (required) | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
| Recipient Email, Name, Recipient Id | The Email, Name or recipient id that needs to be modified. |
| Resend Envelope | Resends the envelope to all recipients. Can be used independently if you need to notify all recipients, or along with modifications to recipients names or email addresses to include notifying the other recipients that were not modified. |
| Void Envelope (Yes/No) | Cancels all signing activities. A Void Reason must be provided. Note: Voiding the envelope has to be done by itself, without modifications to user email or name, or resend envelope. |
| Void Reason | Provide a reason why the signing activities for the envelope must be cancelled. |
Setup DocuSign Connect Auto-trigger
This action can be used to setup the DocuSign connect auto triggering parameters after the envelope is created. For example, if multiple signers are required but a review process is required in between,
this can be used to change what DocuSign Connect triggers after the second signature is completed.
| Name | Description |
|---|---|
| Envelope Id (required) | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
| DocuSign Connect | This hierarchical input then allows the user to setup the Submit Workflow, Generate or Prepare form instructions. See the relevant sections below for documentation regarding these parameters and what combination to use for each trigger type. |
If this action is dragged onto a workflow transition, the next stage guid is automatically updated in the envelope.
Important
This action will reset the Docusign Connect specific fields (those available as inputs of this action under the Docusign Connect input) in the envelope.
If the action to be triggered by Connect is the same as setup in the original envelope, the parameters that specify this action must be setup in this action again.
Updated 11 days ago