Docusign Connector Configuration

Sales Engineering Quick Guide on how to configure the Docusign connectors for e-signature POCs.

Valid for PM Connectors as available on Enterprise editions 3.1.x through 3.3.x

Instructions


On Docusign

URL.- https://appdemo.docusign.com/home

Admin Configuration

A. Create and configure an OAth application from inside DocuSign developers console.

  1. Login to your Docusign developer account. (https://account-d.docusign.com/)
  2. On the top menu go to Settings, then in the sub menu go to Integration → API and Keys.
  3. Click on  Add APP / Integrator Key. (Note: If a key already exists, you may be able to use it). Name it ProcessMaker.
  4. Copy the Integration Key for later
  5. Choose Authorization  Code Grant
  6. Add a Secret Key, copy the Secret Key for later
  7. Add a redirect URI like: https://your.processmaker.server/docusign/authorization
  8. Save the application

B. Configure DocuSign in ProcessMaker

  1. Go to Admin menu
  2. Click on  DocuSign Configuration sub menu
  3. Paste the previously copied Integration Key
  4. Paste the previously copied Secret Key
  5. Save the configuration

C. Grant Access Code from Admin menu (Optional)

  1. From DocuSign Configuration click on GRAN DOCUSIGN ACCESS
  2. Click on Authorize access
  3. Login with you docusign accound (the owner of your docusign documents and templates)
  4. Done

Template Configuration

You could use any template you have in DocuSign or create a new one. To create a new template follow the following steps:

  1. From your DocuSign account go to Templates
  2. Create a New Template
  3. Set the name an a brief description
  4. Upload a document to be signed
  5. Setup the recipients
  6. Save and exit

 


Connectors Use

A. Send Envelope

PropertyAccept mustache?Description
name
Name of the task.
Email subject{M}The subject of the email used to send the envelope.
Content type
  • HTML Define the body content of the document in html format
  • Screen Define the body content of the document using an screen
Content{M}
  • HTML with mustache syntax
  • Screen You could select a display screen
Recipients variable

Request variable that will contain the list of recipients. You could view the complete structure definition if the DocuSign documentation (recipients)

It could be for example a variable recipients,  this variable could be loaded with an Script task with a value like (see script example below):

recipients = {
    "signers": [
        {
            "recipientId": "1",
            "roleName": "signer",
            "routingOrder": "1",
            "email": "tester@processmaker.com",
            "name": "James Tremblay"
        }
    ]
}

Wait sign completed

If enabled the connector will wait until the envelope status changes to "completed"

If not enabled, the connector will continue with the process after the envelope is sent

Output variable
Request variable that will receive the response from the connector

PHP Script Example to prepare the variable recipients:

DS Script
<?php 
return [
    'recipients' => [
        'signers' => [
            [
                "recipientId" => "1",
                "roleName" => "signer",
                "routingOrder" => "1",
                "email" => "tester@processmaker.com",
                "name" => "James Tremblay",
            ],
        ],
    ],
];



A. Send Template


PropertyAccept mustache?Description
name
Name of the task.
Template ID

ID of a DocuSign template  (see the section Template Configuration)

You could paste here the ID of the template to use.

Or use the  dropdown button to select an template (To use this button you previously  must be Grant Access Code from Admin menu)

Template roles variable

Request variable that should contain the roles of the template. You could find an example in DocuSign documentation (Signature by email using a template)

It could be for example a variable template_roles,  this variable could be loaded with an Script task (see script example below):

Wait sign completed

If enabled the connector will wait until the envelope status changes to "completed"

If not enabled, the connector will continue with the process after the envelope is sent

Output variable
Request variable that will receive the response from the connector

PHP Script Example to prepare the variable recipients:

DS Script
<?php 
return [
    'template_roles' => [
        [
            "email": "tester@processmaker.com",
            "name": "James Tremblay",
            "roleName": "signer"
        ]
    ],
];



C. Authorize connector

If you need to use and individual DocuSign Connection by user requestor, instead of configure a global connection, you could use this Authorize connector

Ex.



You could find a complete documentation about the DocuSign Signature Concepts here