DocuSign integrates with SmartSimple to enable electronic signature collection on documents generated within Web Page View custom fields. The integration requires a DocuSign account with API access and an integration key configured in SmartSimple's Global Settings. New integrations start in a sandbox environment, and production requires 20 successful test signatures. The Enable E-Signature and Enable Save to Server settings on a Web Page View custom field then allow signers to complete and store documents within the system. For definitions of DocuSign tags, see DocuSign Tags Reference.
Who: Global administrators and system administrators
When to Use DocuSign
Use DocuSign when:
- A document requires a signature for approved grantees.
- A document requires a signature for an executive change.
- A document requires a signature to approve the release of funds.
- A document requires a signature to acknowledge receipt of case files.
Prepare DocuSign for the SmartSimple Integration
DocuSign as a signature provider in SmartSimple requires a DocuSign account with API access. DocuSign requires a sandbox account to create an integration key.
After the DocuSign sandbox account provides an integration key, create the integration key in SmartSimple to get the Redirect URL, and then add that URL as a Redirect URI in DocuSign.
Obtain the Integration Key and Secret Key from DocuSign
DocuSign provides the Integration Key and Secret Key to enter in SmartSimple. To obtain them in DocuSign:
- Log in to DocuSign.
- Click Admin in the top navigation bar.
- Locate the Integrations section in the left panel, and click Apps and Keys.
- Click Actions for the SmartSimple app, and select Edit from the drop-down menu.
- Locate the General Info section and click the Copy to clipboard [pages] icon for the Integration Key.
- Save this information. This key will be added to SmartSimple as described in the Create the Integration Key in SmartSimple section.
- Save this information. This key will be added to SmartSimple as described in the Create the Integration Key in SmartSimple section.
- Locate the User Application section, and click +Add Secret Key.
- Click the Copy to clipboard [pages] icon for the Secret Key.
-
Save this information. This key will be added to SmartSimple as described in the Create the Integration Key in SmartSimple section.
-
Create the Integration Key in SmartSimple
To create the integration key in SmartSimple and copy the Redirect URL:
- Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Integrations tab.
- Locate the Services Settings section, and click Integration Key Management.
- Click New Integration Key [+].
- Click the Type field, and select DocuSign from the drop-down menu.
- Toggle Is Sandbox on.
- A new integration requires Is Sandbox to be toggled on.
- Click the Integrator Key field and the Secret Key field, and then paste the keys copied from DocuSign in the Obtain the Integration Key and Secret Key from DocuSign section.
- Click Save.
- Copy the Redirect URL.
- This URL will be pasted in DocuSign as described in the Add the Redirect URI in DocuSign section.
- This URL will be pasted in DocuSign as described in the Add the Redirect URI in DocuSign section.
Add the Redirect URI in DocuSign
To add the Redirect URL from SmartSimple as a Redirect URI in DocuSign:
- Log in to DocuSign.
- Click Admin in the top navigation bar.
- Locate the Integrations section in the left panel, and click Apps and Keys.
- Click Actions for the SmartSimple app, and select Edit from the drop-down menu.
- Locate the Additional settings section, and then click the + Add URI button.
- Paste the Redirect URL copied from SmartSimple, and click Save.
https://youralias.smartsimple.com/OAuthsp/callback2.jsp
Verify DocuSign Access in SmartSimple
Once the keys are configured, verify DocuSign access from the Integrations tab in SmartSimple.
To verify DocuSign access:
- Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Integrations tab.
- Locate the E-Signature Settings section, click the E-Signature Provider field, select DocuSign from the drop-down menu, and then click Save.
- Click Check DocuSign Access.
-
Click Allow Access.
A window will open stating access authorization was successful.
Configure the Web Page View for E-Signature
DocuSign collects signatures on documents generated within a Web Page View custom field. Once e-signature is enabled, an E-Signature button displays in the field. To configure the field, first create a role for signees and add the intended person as a Contact with this role. The field must contain list syntax that specifies the role ID, which SmartSimple uses to determine to whom the e-signature request is sent.
To enable e-signature on a Web Page View custom field:
Navigate to the relevant Web Page View custom field.
Click the edit [pencil] icon.
Click the General Settings tab.
-
Locate the Document section, and toggle Enable E-Signature on.
Enable E-Signature enables a new button in the Web Page View custom field labeled E-Signature.
-
Toggle Enable Save to Server on, and then click Save.
Enable Save to Server saves a copy of the signed PDF document within SmartSimple.
Optionally, create an Upload field to store the signed PDF file. Use the Store-To Value option in the Web Page View custom field to point to this additional field.
For DocuSign to retrieve signatory emails and names, embed them in the Web Page View custom field HTML. DocuSign then uses them in the emails sent to signatories.
Example
This list syntax retrieves the contacts with the signee role and embeds their signature information:
[#(?object=contact;criteria=roleid='12527';orderby=firstname) <!--SignatureFlow P--><!--signature ~email~;SIGNER;~firstname~;~lastname~;~Index~;~companyname~-->#]
Example
With three signatories assigned to Level 1, the HTML in the Web Page View custom field is embedded with the information for all three:
<!--signature ttest@smartsimple.com;SIGNER;Tony;Test;1;SmartSimple Software --> <!--signature fake@smartsimple.com;SIGNER;Fake;Man;2;Fake Co. --> <!--signature fake2@smartsimple.com;SIGNER;Fake2;Mann;3;Fake2 Co. -->
For additional tags that configure the email content, expiration, signing order, and document field placement, see DocuSign Tags Reference.
Move the DocuSign Integration to Production
DocuSign requires 20 successful test signatures to move from the DocuSign sandbox to production. DocuSign monitors the document submission and signing workflow during this process.
Each time the E-Signature window opens or refreshes, it sends a real-time polling request to DocuSign. DocuSign limits these polling requests during the go-live evaluation period. If DocuSign detects polling, DocuSign rejects the go-live request, and the process must start again.
To test the DocuSign integration and request that DocuSign move it to production:
- Send a signature request.
- Wait for the DocuSign email notifications.
- Complete the signing process when the emails arrive.
- Complete 20 successful test signatures in SmartSimple.
- Submit a ticket to DocuSign to request that the integration go live.
After signing finishes, SmartSimple receives an update from DocuSign. If the Web Page View custom field has a multi-file field configured as its save-to option, SmartSimple automatically downloads the signed documents to that field.
To update the integration in SmartSimple after DocuSign moves the account to production:
- Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and click the Integrations tab.
- Click Integration Key Management.
- Click the edit [pencil] icon for DocuSign.
- Compare the Integration Key and Secret Key in the DocuSign production account with the Integrator Key and Secret Key fields in SmartSimple. The keys sometimes change when the account moves to production. If the keys differ, enter the new keys in the Integrator Key and Secret Key fields.
- Toggle Is Sandbox off, and then click Save.
- Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and click the Integrations tab.
- Locate the E-Signature Settings section, click Check DocuSign Access.
- Enter the DocuSign login credentials for the DocuSign production site.
- The email address used at sign-in becomes the from email address for documents sent for e-signature via DocuSign.
DocuSign Integration Troubleshooting: Frequently Asked Questions
What Causes the Access Not Enabled or Authentication Not Verified Error?
An access not enabled or authentication not verified error appears during e-signature testing when DocuSign access verification is incomplete in SmartSimple. This is the most common DocuSign integration error.
To verify DocuSign access and resolve the error:
- Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and click the Integrations tab.
- Locate the E-Signature Settings section, and then click Check DocuSign Access.
- Click Allow Access.