蜜豆视频

DocuSign modules

The 蜜豆视频 Workfront Fusion DocuSign modules enable you to monitor and retrieve envelope status, search and retrieve envelopes, or download and send a document to sign in your DocuSign account.

For instructions on creating a scenario, see the articles under Create scenarios: article index.

For information about modules, see the articles under Modules: article index.

Access requirements

Expand to view access requirements for the functionality in this article.

You must have the following access to use the functionality in this article:

table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
蜜豆视频 Workfront package Any
蜜豆视频 Workfront license

New: Standard

Or

Current: Work or higher

蜜豆视频 Workfront Fusion license**

Current: No Workfront Fusion license requirement

Or

Legacy: Workfront Fusion for Work Automation and Integration

Product

New:

  • Select or Prime Workfront package: Your organization must purchase 蜜豆视频 Workfront Fusion.
  • Ultimate Workfront package: Workfront Fusion is included.

Or

Current: Your organization must purchase 蜜豆视频 Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

For information on 蜜豆视频 Workfront Fusion licenses, see 蜜豆视频 Workfront Fusion licenses.

Prerequisites

To use DocuSign modules, you must have a DocuSign account.

DocuSign API information

The DocuSign connector uses the following:

API tag
1.18.11

Connect DocuSign to Workfront Fusion connect-docusign-to-workfront-fusion

To create a connection for your DocuSign modules:

  1. Click Add next to the Connection box when you begin configuring the first DocuSign module.

  2. Enter the following:

    table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
    Connection name Enter a name for the new DocuSign connection.
    Environment Select whether you are connecting to a production on non-production environment.
    Connection name Select whether you are connecting to a service account or a personal account.
    Account type Select whether you the account you want to connect to is a production account or a demo account.
  3. Click Continue to save the connection and return to the module.

DocuSign modules and their fields

When you configure DocuSign modules, Workfront Fusion displays the fields listed below. Along with these, additional DocuSign fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.

Map toggle

Triggers

Watch envelopes

This trigger module starts a scenario when an envelope is sent, delivered, signed, completed, or declined.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect Docusign to Workfront Fusion in this article.
Account
Select the account that contains the records you want to watch.
Event type

Select the type of event that you want to watch.

  • Document completed
  • Document declined
  • Document sent
  • Document signed
  • New document in Inbox
Outputs
Select the fields that you want to include in the module output.
Limit
Enter or map the maximum number of records you want the module to work with during each scenario execution cycle.

Actions

Add a custom field

This action module adds a custom field to the document

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Select the account that contains the document where you want to add a custom field.
Envelope ID
Enter or map the ID of the envelope that contains the document where you want to add a custom field.
Field name
Enter or map a name for the new field that you want to add.
Required
Enable this option if you want the added field to be a required field.
Show field
Enable this option if you want the field to be visible.
Value
Enter or map the value (contents) of the added field.

Add Recipient to Envelope

This action module adds one or more recipients to an existing envelope. If the envelope has already been sent, the recipient is sent an email. This module is not valid for envelopes that have already been completed.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Create a connection - Basic instructions.
Account
Select the account that contains the envelope where you want add recipients.
Envelope ID
Select the or map the ID of the envelope where you want to add the recipient.
Recipient type

Select the type of recipient that you want to add to the envelope.

  • Agent

  • Carbon copy

  • Certified delivery

  • In-person signer

  • Intermediary

  • Signer

Email
Enter or map the email address of the recipient you want to add to the envelope.
Name
Enter or map the name of the recipient you want to add to the envelope.
Routing order
Enter or map the routing number for the recipient. Routing number determines the order in which recipients receive and sign your documents.
Email body
Enter or map the body (content) of the email that is sent to the recipent.
Email subject
Enter or map the subject of the email that is sent to the recipient.
Private message

If you want to send a private message to the recipient, enter or map the text of the message.

Only the selected recipient sees the private message, as well as the general message. The private message is limited to 1000 characters.

Authentication

Select the authentication method that you want to use to confirm the recipient's identity.

  • None

  • Access code

    Enter or map the access code.

  • Phone

    Enter or map the phone number.

  • SMS

    Enter or map the phone number.

Create a new envelope

This action module creates a new envelope from a template. It returns the new envelope鈥檚 ID, as well as the status of the new envelope.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see the articles under Create a connection - Basic instructions.
Account
Select the account that contains the envelope where you want to upload a file.
Template
Select the template that you want to create the new envelope from. Templates are available based on the Account you selected.
After creation
Select whether you want to save the envelope as a draft or send it for signing.
Template recipients

For each recipient that you want to add to this envelope, click Add item and enter the following details:

  • Access code

    Enter or map the code that the recipient uses to access the envelope.

  • Email

    Enter or map the email address of the recipient.

  • Name

    Enter or map the name of the recipient.

  • Role name

    Enter or map the role name of the recipient.

  • Routing order

    Enter or map the routing number for the recipient. Routing number determines the order in which recipients receive and sign your documents.

Allow Print and Sign
Enable this option to allow the recipient to print the document and sign the paper.
Allow Reassign
Enable this option if you want the recipient to be able to reassign the documents to another user.
Allow Recipient Recursion
Enable this option to allow recipient recursion.
Authoritative copy
Enable this option to mark the documents in this envelope as authoritative copies.
Auto Navigation
Enable this option to set auto navigation for the recipient.
Brand ID
Enter or map the ID of the brand.
Markup Enabled
Enable this option to enable Document Markup.
Expire Enabled

Enable this option to set an expiration for this envelope. If you enable this option, fill in the following fields:

  • Expire After

    Enter or map the number of days after which this envelope expires.

  • Expire Warning

    Enter or map the number of days before expiration that a reminder email is sent to the recipient.

Body
Enter or map the body (content) of the email that accompanies this envelope.
Subject
Enter or map the subject of the email that accompanies this envelope.

Custom API Call

This action module allows you to perform a custom API call.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Enter or map the account that you want to use to access the DocuSign API.
URL
Enter or map a path relative to https://<BASE_URI>/v2/accounts/<ACCOUNT_ID>.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods.
Headers

Add the headers of the request in the form of a standard JSON object. This determines the content type of the request.

For example, {"Content-type":"application/json"}

Note: If you're getting errors and it's difficult to determine their origin, consider modifying headers based on the Workfront documentation. If your Custom API Call returns a 422 HTTP Request Error, try using a "Content-Type":"text/plain" header.

Query String

Add the query for the API call in the form of a standard JSON object.

For example: {"name":"something-urgent"}

Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Limit
Enter or map the maximum number of results to be worked with during one execution cycle.
recommendation-more-help

Example: List Envelopes

The following API call returns envelopes from the specified date in your DocuSign account:

URL: /v2.1/accounts/{accountId}/envelopes/

Method: GET

Query String:

  • Key: from_date

  • Value: YYYY-MM-DD

Specifies when the request begins checking for status changes for envelopes in the account.

Example Docusign setup

The result can be found in the module鈥檚 Output under Bundle > Body > envelopes.

In our example, 6 envelopes were returned:

Example docusign output

Download a document

This action module downloads a single document.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Select the account that contains the document you want to download.
Envelope ID
Enter or map the ID of the envelope you want to download.
Document ID
Enter or map the ID of the document you want to download.
Certificate
Enable this option to include the envelope signing certificate in the download.
Documents by User ID
Enable this option to allow recipients to retrieve documents by User ID. For example, if a user is included in two different routing orders with different visibilities, using this option returns all of the documents from both routings.
Encrypt
Enable this option if you want the PDF bytes returned in the response to be encrypted for all the key managers configured on your DocuSign account.
Language
Select the language.
Show Changes
Enable this option to highlight any changed fields for the returned PDF are highlighted in yellow, and outline optional signatures or initials in red.
Watermark
Enable this option to enable the watermark feature.

Modify custom field

This action module modifies a custom field using the field name.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Select the account that contains the document where you want to modify a custom field.
Envelope ID
Enter or map the ID of the envelope that contains the document where you want to modify a custom field.
Field ID
Enter or map the ID聽of the field you want to modify.
Field name
Enter or map the name of the field you want to modify.
Required
Enable this option if you want the modified field to be a required field.
Show field
Enable this option if you want the field to be visible.
Value
Enter or map the value (contents) of the modified field.

Read an envelope

This action module reads information about an envelope in DocuSign using the envelope ID.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Select the account that contains the document you want to read information from.
Envelope ID
Enter or map the ID of the envelope that contains the document you want to read information from.
Outputs
Select the properties that you want to appear in the module's output.

Send envelope

This action module sends a draft envelope to its recipients.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Select the account that contains the draft envelope that you want to send to its recipients.
Envelope ID
Enter or map the ID of the draft envelope that you want to send to its recipients.

Upload a file to an envelope

This module uploads a specified file to an existing envelope in DocuSign.

Connection
For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.
Account
Select the account that contains the envelope where you want to upload a file.
Envelope ID
Enter or map the ID of the envelope where you want to upload a file.
Source file
Select a source file from a previous module, or enter the source file's name and data.
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3