ProcessMaker 4.2
ProcessMaker API Documentation
ProcessMaker Examples
Deprecation Notices
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
This example demonstrates how to administer a DocuSign eSignature account with the DocuSign service. DocuSign eSignature provides a service to digitally sign legally-binding documents including contracts, account openings, and invoices.

Prerequisites

To use DocuSign eSignature with the DocuSign package, you require the following from the DocuSign platform:
  • 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
ProcessMaker 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:
  1. 1.
    Prepare the document for the DocuSign platform: From the DocuSign platform, upload your document, create a DocuSign template, and then add at least one role in that template. This template dictates which signers are required to sign this document. See Prepare the Document for the DocuSign Platform.
  2. 2.
    Create a DocuSign app for this document: From the DocuSign platform, create a DocuSign app. Get both the DocuSign integration key and the generated secret key from the DocuSign platform, and then add the redirect URI for the callback after DocuSign authenticates a valid DocuSign app in ProcessMaker. See Create a DocuSign App for This Document.
  3. 3.
    Configure ProcessMaker Settings with Your DocuSign App: From your ProcessMaker instance settings, add the DocuSign app's integration and secret key acquired from the DocuSign platform. This step may require the assistance of a ProcessMaker Administrator. See Configure ProcessMaker Settings with Your DocuSign App.
  4. 4.
    Configure the DocuSign Connector for this Document: From your Process model, ensure that a DocuSign connector is in the Process to manage acquisition of the digital signatures for the document, and then configure that DocuSign connector. See Configure the DocuSign Connector for This Document.

Prepare the Document for the DocuSign Platform

Follow these guidelines to prepare your document for the DocuSign platform:

Upload This Document to the DocuSign Platform

Follow these steps to prepare the document for the DocuSign platform as described in this example:
  1. 1.
    Finalize your source document in its native format.
  2. 2.
    Log on to DocuSign using your DocuSign account credentials. The Home menu displays in the DocuSign eSignature platform.
  3. 3.
    Upload your document that requires signatures by clicking the Start button or placing the document into the DocuSign platform.
    Your document displays in the DocuSign platform.

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).
Follow these steps to create a DocuSign template for this document for this example:
  1. 2.
    Click the Templates menu. The My Templates page displays.
  2. 3.
    Click the New button, and then select the Create Template option.
  3. 4.
    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.
  4. 5.
    In the Template description setting, optionally enter a description for this template.
    After creating your DocuSign eSignature template, it displays on the My Templates page on the DocuSign eSignature platform. This example uses a template called Vendor Agreement.

Add the Role(s) for This DocuSign Template

Roles in a DocuSign template dictuate the potential signers for any document that uses that template. A role is a recipient for that document to sign or othewise interact with that document.
Follow these steps to add the role(s) to the DocuSign template described in this example:
  1. 2.
    Click the drop-down arrow within the Use button for that template, and then select the Edit option.
    Settings for that template display.
  2. 3.
    Locate the Add recipients section of the template. This template section shows the configured potential signers for any document that uses this template.
  3. 4.
    Click the Add Recipient button that displays below the configured recipients for this template. Settings display to add a new recipient.
  4. 5.
    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.
  5. 6.
    Ensure that the Needs to Sign option is selected for this role. This is the default option.
  6. 7.
    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.

Create a DocuSign App for This Document

Follow these steps to configure your DocuSign account for this document as described in this example:
  1. 2.
    Click Settings from the DocuSign eSignature platform. Settings for your account display.
  2. 3.
    In the left-side panel, locate the Integrations settings.
  3. 4.
    Select the Apps and Keys option in the Integration settings. The Apps and Keys page in the DocuSign eSignature platform displays.
  4. 5.
    Locate the Apps and Integration Keys section below the My Account Information section.
  5. 6.
    Click the Add App and Integration Key button. The Add Integration Key screen displays.
  6. 7.
    In the App Name setting, enter a name for this app's integration key.
    This example uses the name Vendor Onboarding.
  7. 8.
    Click the Create App button. The new app displays in the Apps and Integration Keys section of the Apps and Keys page.
  8. 9.
    Locate the new app and its integration key in the Apps and Integration Keys section.
  9. 10.
    Click the Actions button for your DocuSign app, and then select the Edit option.
    Settings for your DocuSign app display.
  10. 11.
    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.
  11. 12.
    In the Authentication section, locate the Secret Keys setting. This setting displays all secret keys generated for this DocuSign app.
  12. 13.
    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.
  13. 14.
    From the Additional settings section, locate the Redirect URIs setting.
  14. 15.
    Click the Add URI button, and then enter the URL for the callback after DocuSign authenticates a valid DocuSign app in ProcessMaker. Use the following format for this URI:
    https://<ProcessMakerURL>/docusign/authorization
    where <ProcessMakerURL> is the URL to your ProcessMaker instance.
  15. 16.
    Configure other settings for your DocuSign app as necessary. See DocuSign Developer App documentation for more information.
  16. 17.
    Click Save.

Configure ProcessMaker Settings with Your DocuSign App

Package Required

The DocuSign package must be installed.

Permission Required

Your user account or group membership must have the "Settings: View Settings" permission to view DocuSign settings unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
Follow these steps to configure ProcessMaker settings with your DocuSign account information for this document as described in this example:
  1. 2.
    Log on to ProcessMaker.
  2. 3.
    Click the Admin option from the top menu. The Users page displays.
  3. 4.
    Click the Settings icon
    from the left sidebar. The Settings tab displays all ProcessMaker Administrator settings.
  4. 5.
    Click the DocuSign tab.
  5. 6.
    Click the Edit icon
    for the Integration Key setting. The Integration Key screen displays.
  6. 7.
    Enter the DocuSign app's integration key you stored for later reference, and then click Save.
  7. 8.
    Click the Edit icon
    for the Secret setting. The Secret screen displays.
  8. 9.
    Enter the DocuSign app's secret key you stored for later reference, and then click Save.
  9. 10.
    Click the Edit icon
    for the Server setting. The Server screen displays.
  10. 11.
    Enter https://account-d.docusign.com as the DocuSign server name, and then click Save.
  11. 12.
    Click the Grant DocuSign Access button. A Task displays with a button labeled Authorize Access DocuSign.
  12. 13.
    Click the Authorize Access DocuSign button to grant the DocuSign eSignature platform access to your ProcessMaker instance after it authenticates your DocuSign app. If a DocuSign error displays, ensure that the redirect URI configured in your DocuSign app is correct.

Configure the DocuSign Connector for This Document

Package Required

The DocuSign package must be installed.

Permissions Required

Your user account or group membership must have the following permissions to configure a DocuSign connector unless your user account has the Make this user a Super Admin setting selected:
  • Processes: Edit Processes
  • Processes: View Processes
See the Process permissions or ask your Administrator for assistance.
Follow these steps to configure the DocuSign conector for this document this document as described in this example:
  1. 1.
    View your Processes, and then click the Open Modeler icon
    to edit the selected Process model model to use DocuSign to manage signatures for this document.
  2. 2.
    Add a DocuSign connector in the Process model.
  3. 3.
    Expand the Document for Signature panel. Settings for this panel display.
  4. 4.
    From the Template ID setting, select the DocuSign template that references the document to send for eSignature. The template list populates from the DocuSign server specified in the DocuSign Settings. For this example, use the template named Vendor Agreement since this is the name of the template created for this example.
  5. 5.
    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 message that displays to each role when this document sends to each recipient's email for signing.
Start a Request for the Process.

Related Topics

Export as PDF
Copy link
Edit on GitHub
On this page
Overview
Prerequisites
Overview of the Example
Prepare the Document for the DocuSign Platform
Upload This Document to the DocuSign Platform
Create a DocuSign Template for This Document
Add the Role(s) for This DocuSign Template
Create a DocuSign App for This Document
Configure ProcessMaker Settings with Your DocuSign App
Configure the DocuSign Connector for This Document
Related Topics