- 15 Nov 2024
- 3 Minutes to read
- Print
- DarkLight
The DocuSign Module
- Updated on 15 Nov 2024
- 3 Minutes to read
- Print
- DarkLight
Module Details | |
Installation Location | Core module |
Step Location | Integration > DocuSign |
Settings Location | System > Settings > DocuSign Settings |
Prerequisites |
|
The DocuSign module allows users to send documents to DocuSign to capture electronic signatures and initials. The module provides Flow steps that use X and Y positions on the document to mark where to sign. Additionally, it enables the use of DocuSign's "Tag" feature to indicate areas in the document that require signatures.
Users should also take a look at the DocuSign Enhancer accelerator project that makes using the DocuSign module much easier.
Configuration
- Navigate to System > Settings: Right-click DocuSign Settings and select Edit. In the Edit DocuSign Settings window, fill in the necessary credentials and click SAVE when done.
Setting Description Base Url (Production) Allows a user to input the server base URL (displays when UseDemoEnvironment is selected). API Account ID API Account ID is located in the Apps and Keys section in Settings in DocuSign. LoginEmail User's email to log in to DocuSign. User ID API Username; can be found under the Apps and Keys section in Docusign. IntegratorKey Integration Key associated with the created app in Docusign. This can be found under the Apps and Keys section in Docusign. App Password The App Key needs to be created within DocuSign. UseDemoEnvironment Enabling this setting will send requests to DocuSign's demo environment (demo.docusign.net) instead of docusign.net. - To find the values for the settings, navigate to DocuSign in a browser and select Settings.
- Navigate to Integration > Apps and Keys. The values for the API Account ID, User ID, and Integration Key can be found here.
Create an App Key
- Navigate to https://account-d.docusign/me/privacy-security or https://account.docusign.com/me/privacy-security, depending on whether the environment is a demo or production environment.
- Go to the top right corner of the page and click your profile and select Manage Profile. Under Additional Security, select GENERATE APP PASSWORD.
- Provide a name, then select GENERATE APP PASSWORD. A new popup will appear, displaying the password. Enter the value in the App Password field for the Module in Decisions.
Deserialize DocuSign Envelope Information
The Deserialize DocuSign Envelope Information takes in XML string and will deserialize it to DocuSign Envelope Information output.
Input Parameter | Description |
---|---|
XML | Envelope of a DocuSign document. |
Get Document Status
The Get Document Status step retrieves the status of the DocuSign documents by outputting a String data type value. It also contains the same inputs as the Get Certificate step.
Input Parameter | Description |
---|---|
EnvelopeId | The EnvelopeId is the DocuSign identifier for a group of signed or unsigned documents. |
Override Credentials | This optional input allows the developer to override the DocuSign settings configured in the System Settings. |
Get Signed Documents
The Get Signed Documents step will use the same inputs as the previous step, but the output returns a list of documents.
Input Parameter | Description |
---|---|
EnvelopeId | The EnvelopeId is the DocuSign identifier for a group of signed or unsigned documents. |
Override Credentials | This optional input allows the developer to override the DocuSign settings configured in the System Settings. |
Send Documents for Signing
The Send Documents For Signing step is used to send documents that need to be signed by a user. If the step runs successfully, an Envelope Id will be output by the step.
Input Parameter | Description |
---|---|
CC | Will send the documents to this list of emails after completing the signing. |
Document | List of documents that need to be signed. DocuSign Module supports the following documents.
|
Document Title | Title of document. |
Email Blurb | The input of the email message that will be sent out to the recipient. |
Override Credentials | This optional input allows the Decisions Developer to override the DocuSign settings configured in the System Settings. |
Recipients | The input expects the email address of whom the documents will be sent. |
Respect Signing Order | Will send the document to the recipients in the order they are listed. |
Reminders | Allows a user to set reminders and document expirations. |
Subject | Email subject line. |
Transform PDF Fields | This allows PDF Fields to be automatically converted to signable objects when uploaded to DocuSign. |
Get Document Status Changes
Only available in v9.4+, the Get Document Status Changes step provides a list of all the status changes, the envelope ID those changes belong to, and a time stamp of when the change occurred. Which status changes are returned depends on how the inputs are used.
Input Parameter | Description |
---|---|
For Email | Returns document status changes for a particular email address. |
For User Name | Returns document status changes for a specific user name. |
Override Credentials | |
Status Changed Since | Returns all status changes after a specific date. |
Statuses To Return | Users can add a list of status types to return, rather than all statuses. |
Feature Changes
Description | Version | Release Date | Developer Task |
---|---|---|---|
Added the Get Document Status Changes step. | 9.4 | November 2024 | [DT-041750] |