The DocuSign Module
  • 22 May 2024
  • 3 Minutes to read
  • Dark
    Light

The DocuSign Module

  • Dark
    Light

Article summary

Module Details

Installation LocationCore 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 pre-built 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. 

Once a document is sent to DocuSign via a Decisions workflow, the Wait On External Event step monitors DocuSign so the document can be pulled back into the workflow once fully executed. 



Configuration

  1. Navigate to System > Settings: Right-click DocuSign Settings and select Edit.
  2. In the Edit DocuSign Settings window, fill in the necessary credentials and click SAVE when done.
    SettingDescription
    Base Url (Production)Allows a user to input the server base URL (displays when UseDemoEnvironment is selected).
    API Account IDAPI Account ID is located in the Apps and Keys section in Settings in DocuSign.
    LoginEmailUser's email to log in to DocuSign.
    User IDThe API Username. This can be found under the Users and Groups section of the Account screen in the DocuSign website.
    IntegratorKeyIntegration Key associated with the created app in DocuSign. This can be found under the Apps and Keys section in DocuSign.
    App PasswordThe App Key needs to be created within DocuSign.
    UseDemoEnvironmentEnabling this setting will send requests to DocuSign's demo environment (demo.docusign.net) instead of docusign.net.

  3. To find the values for the settings, navigate to DocuSign in a browser and select Settings.
  4. 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

  1. 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.
  2. Under Additional Security, select GENERATE APP PASSWORD.
  3. 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.

DocuSign Flow Steps

After the Module has been installed and DocuSign settings have been configured, Flow steps will be made available to users and listed under INTEGRATION > DOCUSIGN.


Deserialise DocuSign Envelope Information

The Deserialise DocuSign Envelope Information takes in XML String and will deserialize it to DocuSign Envelope Information output.

Input ParameterDescription
XMLEnvelope 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 ParameterDescription
EnvelopeIdThe EnvelopeId is the DocuSign identifier for a group of signed or unsigned documents.
Override CredentialsThis 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 ParameterDescription
EnvelopeIdThe EnvelopeId is the DocuSign identifier for a group of signed or unsigned documents.
Override CredentialsThis 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 ParameterDescription
CCWill send the documents to this list of emails after completing the signing.
DocumentList of documents that need to be signed. DocuSign Module supports the following documents.
  • PDF (.pdf)
  • Word (.docx)
Document TitleTitle of document.
Email BlurbThe input of the email message that will be sent out to the recipient.
Override CredentialsThis optional input allows the Decisions Developer to override the DocuSign settings configured in the System Settings.
RecipientsThe input expects the email address of whom the documents will be sent. There are two ways that the user can determine where the recipient will sign on the document:
  • Absolute Position: uses the position in the document.
  • Anchor Tabs: uses Anchor Strings to place the sign here field.
    • For example: an Anchor String would be "Please sign here" and the x offset would be +10 pixels.
Respect Signing OrderWill send the document to the recipients in the order they are listed.
RemindersAllows a user to set reminders and document expirations.
SubjectEmail subject line.
Transform PDF FieldsThis allows PDF Fields to be automatically converted to signable objects when uploaded to DocuSign.


For further information on Modules, visit the Decisions Forum.



Was this article helpful?

What's Next