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
- Gain access to a test Docusign developer account.
- Get the account ID from the top-right menu
- Get an Integrator Key for that Docusign account.
- From the top right menu, click on Go to Admin and navigate to Integration → API and Keys.
- Click on Add APP / Integrator Key. (Note: If a key already exists, you may be able to use it). Name it ProcessMaker, all other fields can remain blank.
- Note the UUID key that is generated.
Template Configuration
- Create a New Template.
- Note the Template ID which you can review in the URL when opening the template, as shown here: https://appdemo.docusign.com/templates/details/xxx-yyy-this-is-the-id
- Upload a Word or PDF file by clicking on Add Documents to the Envelope.
- Configure the Recipients List by clicking on Add Recipients to the Envelope.
- Only the Role is needed -other fields (name, email) will be provided by PM.
- In the next screen, drag fields from Docusign's field menu (left) onto the document. These will match against form and signature data.
- Note that there are distinct field selections for each Recipient Role.
- Note to include at least one Signature field.
On ProcessMaker
Connector Configuration
- Find and Edit the PM Connector 'CreateAndSendEnvelope'. This connector will send Docusign the necessary information and request the creation of an Envelope (a signature process).
- If there is none, simply create a new one using the config options listed here.
- The URL for this call is https://demo.docusign.net/restapi/v2/accounts/XXXXXXX/envelopes called with method POST.
- Note to replace the account id in the URL with the one from your test account, retrieved as detailed above.
- The request takes two Headers, ensure they exist or add them:
- Header: Content-type Value: application/json
- Header: X-DocuSign-Authentication Value: {"Username":"xx@yy.com","Password":"XXXYYY", "IntegratorKey":"UUID-Key"}
- Replace values for those from your account. Be sure to include the Integrator Key, retrieved as detailed above.
Connector Use
- Design a Process with a form task that captures necessary Recipient information (name, email).
- The request will be expecting a Body with the following JSON structure:
{
"status" :"sent",
"emailSubject" :@@Subject,
"templateId" :@@Template,
"templateRoles":@=SignersList
}
- You'll need thus to create these variables prior to calling the connector.
- emailSubject can be either hard-coded or read from a variable. It is a plain text field.
- templateId is the ID for the template you will request signing. It can be hard-coded or read from a variable.
- templateRoles is a JSON array with details for each Recipient. Each element in the array will follow this structure:
- "roleName"=> "rolename",
"name"=> "name"
"email"=> "email",
"recipientId"=> "id",
"tabs"=> { {"textTabs" => $textTabs } - Here you will replace these values with form data. See the following sample script that builds this payload:
- "roleName"=> "rolename",
Once you have these variables set, you can use the Service Task with the createSendEnvelope connector:
- Configure Body type as JSON
- Add the JSON object in the body, as follows:
{
"status" :"sent",
"emailSubject" :@@Subject,
"templateId" :@@Template,
"templateRoles":@=SignersList
}- Profit!
Related articles