DocuSign Package Example
Follow an example that demonstrates how to configure the DocuSign package to integrate with the DocuSign eSignature platform.
Overview
Intended audience: Administrators, Process designers
Tags: DocuSign; Process design
Prerequisites
a DocuSign eSignature account
at least one document template with at least one defined role from which to use with your document requiring signatures
a DocuSign app to manage authentication and integration with ProcessMaker Platform
ProcessMaker Platform does not provide a DocuSign eSignature account. However, this example describes how to design a DocuSign eSignature template and DocuSign app.
Overview of the Example
This example contains the following procedures in this order:
Prepare the Document for the DocuSign Platform
Follow these guidelines to prepare your document for the DocuSign platform:
Upload Your Document to the DocuSign Platform
Finalize your source document in its native format.
Log on to DocuSign using your DocuSign account credentials. The Home menu displays in the DocuSign eSignature platform.
Your document displays in the DocuSign platform.
The Manage menu displays.
Create a DocuSign Template for This Document
A DocuSign eSignature template's purpose is to dictate the document signers (called "roles" in DocuSign) or for similar document types (such as non-disclosure agreements).
Click the Templates menu. The My Templates page displays.
In the Template name setting, enter a name for this template. DocuSign shows this template name from the DocuSign connector. This example uses a template named Vendor Agreement.
In the Template description setting, optionally enter a description for this template.
Add the Role(s) for This DocuSign Template
Roles in a DocuSign template specify the potential signers for any document that use that template. A role is a recipient for that document to sign or otherwise interact with that document.
Settings for that template display.
Click the Add Recipient button that displays below the configured recipients for this template. Settings display to add a new recipient.
In the Role setting, enter the name for this role. DocuSign shows this role when selecting this template from the DocuSign connector. This example uses one role named Vendor.
Create one role for each signer required for your document. For example, create another role in this template called Customer for another signer in this document.
Click the Save and Close button in the lower-right of the DocuSign platform. The Templates menu displays.
Create a DocuSign App for This Document
Click Settings from the DocuSign eSignature platform. Settings for your account display.
Select the Apps and Keys option in the Integration settings. The Apps and Keys page in the DocuSign eSignature platform displays.
Locate the Apps and Integration Keys section below the My Account Information section.
In the App Name setting, enter a name for this app's integration key.
This example uses the name Vendor Onboarding.
To edit an existing template, follow these steps:
Locate the new app and its integration key in the Apps and Integration Keys section.
In the General Info section, locate the Integration Key setting, and then copy it. Paste the app's integration key into a separate document for later reference.
Click the Add Secret Key button below it. A new secret key generates. Copy this secret key and then paste it into the same document you placed the integration key for later reference.
Click the Add URI button, and then enter the URL for the callback after DocuSign authenticates a valid DocuSign app in ProcessMaker Platform. Use the following format for this URI:
https://<ProcessMakerPlatformURL>/docusign/authorization
where
<ProcessMakerPlatformURL>
is the URL to your ProcessMaker Platform instance.Click Save.
Configure ProcessMaker Platform Settings with Your DocuSign App
Click the Admin option from the top menu. The Users page displays.
Click the DocuSign tab.
Enter the DocuSign app's integration key you stored for later reference, and then click Save.
Enter the DocuSign app's secret key you stored for later reference, and then click Save.
Enter
https://account-d.docusign.com
as the DocuSign server name, and then click Save.Click the Authorize Access DocuSign button to grant the DocuSign eSignature platform access to your ProcessMaker instance after it authenticates your DocuSign app.
Click the Allow Access button.
Configure the DocuSign Connector for This Document
Expand the Document for Signature panel. Settings for this panel display.
After selecting the DocuSign template, roles populate from the selected template. Select each role that is a recipient of the document for signing, and then configure the email recipient and message that displays to each role when this document sends to each recipient's email for signing. Configuring the email recipient associates the vendor with one of the following ProcessMaker Platform participant types that would receive the document to provide a signature: