DocuSign

DocuSign provides electronic signature and digital transaction technology for enterprise customers. Skuid’s preconfigured Docusign data source type gives Docusign account holders insight into various DocuSign elements that manage the circulating and signing of important documents. Skuid can access data on envelopes, documents, folders, and signers, and supports the creation or upload of new items.

To take advantage of the DocuSign data source type, you’ll need to do three things:

  • Create an integrator key in DocuSign
  • Create the DocuSign authentication provider
  • Create the DocuSign data source

Configuration

In DocuSign

From within your DocuSign account:

  1. In Profile dropdown, click Go to Admin.

  2. Under Integrations, click API and Keys

  3. Click Add Integrator Key and edit:

    • App Description: Provide a descriptive name.

      Note

      For the purposes of creating a data source type, it’s not necessary to complete the other fields.

  4. In the next screen, click:

    Note

    This will be the only time this key is fully displayed, so copy it and keep in a safe place.

  5. Click Save.

To review or revise the app, click the Actions dropdown next to the app name, and select Edit.

For more information, visit the DocuSign help documentation.

In Skuid

Set up the authentication provider

  1. Navigate to Configure > Data Sources > Authentication Providers.

  2. Click New Authentication Provider.

  3. In the New Authentication Provider window:

    • Name: Give the new authentication provider a name.

    • Authentication Method: OAuth 2.0 / OpenID

    • Provider Type: DocuSign

    • Grant Type: Authorization Code.

    • Authorize Endpoint URL and Token Endpoint URL: These will be autogenerated.

      Note

      If you are working in a developer sandbox, you’ll need to add -d to the first part of these URLs:

      • https://account-d.docusign.com/oauth/auth
      • https://account-d.docusign.com/oauth/token
    • Client Credentials: Use DocuSign’s Integrator Key for the client ID and the secret key for the client secret.

  4. Click Save.

Set up the Data Source

  1. Navigate to Configure > Data Sources > Data Sources.

  2. Click New Data Source.

  3. In the New Data Source/Select Data Source Type window:

    • Data source type: DocuSign
    • Name: Give the new data source a name.
  4. Click Next Step.

    • URL: https://server.docusign.net/restapi/v2, where “server” would be replaced by the DocuSign server ID.

      • For users in North America, this will likely be na2.docusign.net
      • For users working with developer sandboxes, this will be demo.docusign.net

      More about DocuSign API Endpoints.

    • Authentication Method: Authentication Provider (OAuth)

    • Authentication Provider: Select the authentication provider you configured.

  5. Click Save.

  6. (If asked) Click OK to create the required remote site setting.

Using the DocuSign Data Source

You—or your company—may have multiple DocuSign accounts. When using the DocuSign data source type, there are six possible entities:

  • Login Accounts Information
  • Envelope
  • Document
  • Signer
  • Folder
  • Folder Item.

Obtain alphanumeric IDs for required conditions in the following entities

Five of the entities below require a model condition that identifies the specific DocuSign account using the Login Accounts Information entity’s ID. The one exception is the Login Accounts Information entity itself, which provides that ID.

Some entities also require an additional condition that designates the entity’s container, such as Document, which needs to identify which envelope to pull the entity’s data from.

To obtain these alphanumeric IDs, include the entity’s ID field in a table on a Skuid model created on the entity, and copy the ID from the table. For example, to obtain the accountId (required for five of the entities):

  1. Create a Skuid model on the Login Accounts entity.
  2. Add a table to the page, connected to that model.
  3. Add the ID field, and fields that may help distinguish accounts from one another, such as Name, to the table.
  4. Click Preview.
  5. The table displays the ID numbers that correspond to each account.
  6. Copy the ID for the desired account and use it in the required conditions for the other entities within the App Composer.

Login Accounts Information [[]]

The Login Accounts Information entity provides a listing of all accounts and associated information about the account, including the account ID. This ID is a necessary part of mandatory conditions for all the remaining entities.

Fields

Login Accounts Information has a number of fields, but the following are the most frequently used:

  • ID: The ID number for the individual account. Used to create conditions for other entities.
  • Name: The name of the account.
  • Is Default: If there is more than one account, indicates which one is the default account.

No conditions are available for this object.

Envelope [[]]

When using DocuSign to transmit documents for electronic signature, those documents are packaged in “envelopes.” A DocuSign envelope includes:

  • The document or documents
  • The fields added to the document; fields are calls to action for the recipients (“Sign,” “Initial,” “Name,” etc.)
  • Recipients, some of which may be designated as signers

Fields

Use the Envelope entity to display a list of envelopes within a selected account, which is set by the accountId model condition.

The entity includes the following fields:

  • Envelope Id: The alphanumeric ID for the envelope.

Note

You will need this to create a required condition for the Documents entity.

  • Envelope Status: The current status of the envelope (such as Sent, Signed, Declined).
  • Status Changed On: The date and time of the most recent change in the envelope’s status.

Note

The Envelope entity also offers a selection of URI fields, which can be useful for building API calls. These URI fields are not useful for row actions.

Condition

The Envelope entity has one required default condition, accountId, which limits the list of envelopes displayed to those from the account specified in the condition. Modify the condition’s Value as follows:

  • Content: Single specified value
  • Value: Use the account’s alphanumeric ID as the single specified value.

Document [[]]

Use the Document entity to display a list of documents within a selected envelope, which is set by the envelopeId model condition

Fields

Document entity has a number of fields, including the following:

  • Name: The name of the document.
  • Pages: Number of pages in the documents.
  • Type: The category of document.
  • Order: The position of the document in the envelope. For example, if this is the third document to be signed in that envelope, the order is 3.
  • Document ID: The alphanumeric ID of the document.

Conditions

The Document entity includes two required default conditions that limit the documents displayed to those documents from the specified envelope in the specified account. These conditions are the accountId (see Envelope entity conditions, above) and the envelopeId. Modify the condition’s Value as follows:

  • Content: Single specified value
  • Value: Use the envelope’s alphanumeric ID as the single specified value.

Signer [[]]

The Signer entity lists all named signers for a document.

Fields

Signer fields include:

  • Name: Signer’s name.
  • Email: Signer’s address.
  • Status: Status of signer’s document(s).
  • Recipient ID: Alphanumeric ID for the signer.
  • Note: Additional note that will be sent with the email.
  • Delivery Method: Email (default) or Fax.
  • Creation Reason: Reason the document was created.
  • Declined Reason: Reason the signer declined the document.

Conditions

Like the Document entity, the Signer entity has two required default conditions: accountId and envelopeId. These conditions limit the list of signers to those for the specified envelope in the specified account.

Using the Signer entity in Skuid

End users can add a signer to envelope by clicking fa-plus-circle Add New Signer and filling in:

  • Name
  • Email

The new Signer will receive a copy of the envelope with all included documents, using the email originally used to circulate the envelope. To create a custom email, use the Add Signer to Envelope with Custom Email data source action.

Folder [[]]

Most DocuSign accounts include four default folders (Inbox, Sent, Drafts, and Deleted). Folders store and track items in various stages of the DocuSign process.

Note

There may also be custom folders created by the account holders. This will not display using the folder entity model

The Folder entity displays a list of the existing default folders in the account.

Fields

Folder fields include:

  • Name: The folder’s name.
  • Folder ID: The alphanumeric ID of the folder.
  • Type: Type of folder.
  • Folder Owner’s User name: The owner of the folder.

Conditions

Folder has one required default condition—accountId (see Envelope entity conditions, above). This condition limits the list of folders to those from the account specified by the condition.

Folder Item [[]]

A folder item is any document or label stored within a folder.

Fields

Frequently used Folder Item fields include:

  • Owner Name: Owner of the item.
  • Created Date Time: Time and Date of the item’s creation.
  • Subject: Items are usually wrapped in an envelop, which is emailed to recipients. This is the subject line of the email message.
  • Status: The current status of the envelope (such as Sent, Signed, Declined) containing the folder item.

Conditions

Folder Item has two required default conditions—accountId (see Envelope entity conditions, above) and folderId. These conditions limit the list of displayed folder items to those from the specified folder in the specified account. Modify the condition’s Value as follows:

  • Content: Single specified value
  • Value: Use the folder’s alphanumeric ID as the single specified value.

Data Source Actions

Add Signer to Envelope with Custom Email

The Signer entity (see above) allows end users a quick way to add a signer to the envelope. The new signer then receives the envelope via the original email message.

To use a data source action to add a new Signer with a custom message, see the tutorial How to Add a Signer with a Custom Email in DocuSign.

Download Envelope/Document Row

Note

Using the Download data source action to create a row action works in context. This means that, if the row action is added …

  • to rows of documents, the action will download the individual document as a PDF.
  • to rows of envelopes, the action will download everything contained in that envelope (documents and images) bundled in a PDF.

To configure a Table for downloading DocuSign documents:

  1. In the Table associated with the Envelope or Document entity model, click fa-plus-circle Add Row Action.
  2. Click the new action, and in the Basic tab, edit:
    • Action type: Run Multiple Actions
    • Action Name: Use a name that will serve as a call-to-action for the end user.
    • Action icon: Select an icon to display in the row.
  3. In the Actions tab, click fa-plus-circle Add New Action.
  4. Click the newly-created action and then click the Actions tab.
  5. Click fa-plus-circle Add action.
  6. Click the new action and edit:
    • Action type: Run data source action.
    • Data source: DocuSign
    • Action: Download Envelope/Document Based on Context.

Troubleshooting

Not getting the data you expect? Check the entity conditions. [[]]

Each entity in DocuSign is reliant upon the correct conditions:

  • To display a list of envelopes, you need to specify which account the envelopes belong to.
  • To display a list of documents, you need to specify which account, and which envelope within the account, the documents are associated with.
  • To display a list of signers, you need to specify which account, and which envelope within the account, the signers are associated with.
  • To display a list of folders, you need to specify which account the folders belong to.
  • To display a list of folder items, you need to specify which account, and which folder within the account, the items are associated with.