User Guide Cancel

Adobe Acrobat Sign Document Builder for Salesforce: User Guide

  1. Adobe Acrobat Sign Integrations
  2. What's New
  3. Product Versions and Lifecycle
  4. Acrobat Sign for Salesforce
    1. Installation Guide
    2. User Guide
    3. Developer Guide
    4. Advanced Customization Guide
    5. Field Mapping and Templates Guide
    6. Process Builder Guide
    7. Document Builder Guide
    8. Upgrade Guide
    9. Release Notes
    10. Troubleshooting Guide
    11. Additional Articles
  5. Acrobat Sign for Microsoft
    1. Acrobat Sign for Microsoft 365
      1. Installation Guide
    2. Acrobat Sign for Outlook
      1. User Guide
    3. Acrobat Sign for Word/PowerPoint
      1. User Guide
    4. Acrobat Sign for Teams
      1. User Guide
      2. Release Notes
      3. Microsoft Teams Approvals
    5. Acrobat Sign for Microsoft PowerApps and Power Automate
      1. User Guide
      2. Release Notes
    6. Acrobat Sign Connector for Microsoft Search
      1. User Guide
    7. Acrobat Sign for Microsoft Dynamics 
      1. Overview
      2. Dynamics Online: Installation Guide 
      3. Dynamics Online: User Guide 
      4. Dynamics On-Prem: Installation Guide 
      5. Dynamics On-Prem: User Guide
      6. Dynamics Workflow Guide
      7. Dynamics 365 for Talent
      8. Upgrade Guide
      9. Release Notes
    8. Acrobat Sign for Microsoft SharePoint 
      1. Overview
      2. SharePoint On-Prem: Installation Guide
      3. SharePoint On-Prem: Template Mapping Guide
      4. SharePoint On-Prem: User Guide
      5. SharePoint On-Prem: Release Notes
      6. SharePoint Online: Installation Guide
      7. SharePoint Online: Template Mapping Guide
      8. SharePoint Online: User Guide
      9. SharePoint Online: Web Form Mapping Guide
      10. SharePoint Online: Release Notes
  6. Acrobat Sign for ServiceNow
    1. Overview
    2. Installation Guide
    3. Release Notes
  7. Acrobat Sign for HR ServiceNow
    1. Installation Guide
  8. Acrobat Sign for SAP SuccessFactors
    1. Cockpit Installation Guide
    2. Recruiting Installation Guide
    3. Recruiting User Guide
    4. Cloud Foundry Installation Guide
  9. Acrobat Sign for Workday
    1. Installation Guide
    2. Quick Start Guide
    3. Configuration Tutorial
  10. Acrobat Sign for NetSuite
    1. Installation Guide
    2. Release Notes
  11. Acrobat Sign for SugarCRM
  12. Acrobat Sign for VeevaVault
    1. Installation Guide
    2. User Guide
  13. Acrobat Sign for Coupa BSM Suite
    1. Installation Guide
  14. Acrobat Sign Developer Documentation
    1. Overview
    2. Webhooks
    3. Text Tags
Note:

With the release of V 1.0.2, Adobe Acrobat Sign Document Builder for Salesforce package includes the following enhancements:

  • Improved image merging feature: You can now seamlessly merge images into a document template using DocGen API tags.
  • Fixed the issue in Related object field mapping: With the current release, you can seamlessly map a related object via a lookup relationship. It allows you to generate a document from a master object (such as WorkOrder) and include child line items (such as WorkOrder related lists) in the document.
  • Fixed the issue in filtering standard objects: The current release resolves the related object filter issue where a custom object was filtered out when a child custom object relationship is added. The added custom objects now show up in the related object list.

See how to Upgrade the Document Builder base package to the latest version.

Overview

Document Builder is an Adobe Acrobat Sign for Salesforce feature that provides the ability to automatically generate documents using Salesforce data. It is a part of the existing Sign Agreement Template functionality. Salesforce admins can enable teams or individual team members to use Document Builder for creating documents, such as proposals, quotes, or agreements. The generated document is sent as an attachment with the Acrobat Sign Agreement template and can be easily tracked and managed in Salesforce.

Document Builder is an extension package to the Adobe Acrobat Sign for Salesforce base package and does not require any additional purchase. The feature provides a step-by-step wizard for creating rules for merging data from salesforce object fields into a Word document template.

Adobe Acrobat Sign for Salesforce: Document Builder User Guide helps you understand how to:

Note:

Document Builder is supported only on the Salesforce Lightning platform.

Prerequisites

Before installing the Document Builder extension package, you must:

  • Log in to the Salesforce account using your admin credentials. You must sign-up for a new account if you do not already have a Salesforce account.
  • Install (or upgrade) and configure Acrobat Sign for Salesforce v 24.0 or later.
  • Authorize Adobe Acrobat Sign account to Salesforce using the Set Up Wizard. For details, refer to the Adobe Acrobat Sign for Salesforce: Installation Guide.

Install and configure Document Builder package

  1. Go here to access the Adobe Acrobat Sign for Salesforce Document Builder package on the Salesforce AppExchange.
  2. Log in to the Salesforce account with your admin credentials.

    login to salesforce

    Note:

    The email address that you use for installing the Document Builder extension package should be the same as the one used for installing the Acrobat Sign for Salesforce base package. 

  3. In the Install Acrobat Sign Document Builder page that displays: 

    1. Select Install for All Users.
    2. Select the checkbox to acknowledge the installation.
    3. Select Install.
    4. In the Approve Third-Party Access dialog that appears, select the consent checkbox and then select Continue.

    It displays a notification saying that the installation process will take some time.

    document-builder-install

  4. Select Done to continue.
    After the installation is complete, you receive an email notification that the package is installed.
  5. To verify the installation, go to Setup > Platform Tools > Apps > Packaging Installed Packages.
  6. To authenticate user credentials, select App center and search for Document Builder. From the list of results that appear, select Document Builder Admin.

    select-doc-builder-admin

  7. In the Document Builder Admin page that opens, select Connect.

    connect-document-builder

  8. In the Adobe Acrobat Sign account page that opens, enter your account credentials and select Sign In.

    You can log in using your account credentials for the Adobe Acrobat Sign base package.

    connect-sign-account

  9. In the dialog that appears, select Allow Access.

    allow access

  10. In the Salesforce login page that opens, enter your Salesforce account credentials and select Login.

    It displays a message confirming that your Adobe Acrobat Sign account is linked to Document Builder for Adobe Acrobat Sign in Salesforce.

    document-builder-sign-linked

  11. Select Done
    The Document Builder Admin page displays a message confirming that the Document Builder extension is connected to your user account.

    document-builder-connected-to-account

Add 'Document Builder Template' Picklist Value

To support Document Builder templates, the Type__c field of the Attachment_Template__c object now includes a new picklist value called 'Document Builder Template'. For the Document Builder templates to function properly after upgrading the base package to v24.x, Salesforce admins must add Document Builder Template picklist value to the existing picklist for the Type__c field of the Attachment_Template__c object.

Note:

All existing users of Adobe Acrobat Sign for Salesforce who upgrade to v24 must add the 'Document Builder Template' Picklist Value using the instructions below.

In case of a clean install of Adobe Acrobat Sign for Salesforce v24, users do not need to add the 'Document Builder Template' Picklist Value. 

  1. Navigate to Setup > Platform Tools > Object and Fields > Object Manager.

  2. Select Add File Attachment from the list. It opens the 'Add File Attachment' object.

    picklist object manager

  3. From the left panel, select Fields & Relationships.

    picklist add file attachment

  4. Select Attachment Type field (with Field Name as echosign_dev1__Type__c).

  5. Scroll down the page to the Values section and check the list. If the list does not include the 'Document Builder Template' value, select New.

    picklist value new

  6. Enter the new Attachment Type value “Document Builder Template”.

    Add attachment type value

  7. Select Save.

  8. To localize the new Attachment Type value through the translation workbench:

    1. Navigate to Setup > Platform Tools > User Interface > Translation Workbench > Translate.
    2. If prompted to enable the translation workbench, select Enable.
    3. Select the Language that you want to localize to.
    4. Select the Setup Component as Picklist Value.
    5. Select Object as Add File Attachment.
    6. Under Master Picklist Value Lable, select + Attachment Type to expand the menu. 
    7. Next, double-click the column space next to Document Builder Template to open the text field where the translation can be entered, and enter the appropriate localized value.
    8. Select Save when done.
    enable translation

    picklist-translate

Create Document Builder templates

Once the Document Builder extension package is installed and connected to the Adobe Acrobat Sign account, authorized users can access it within Agreement Templates under the Attachment tab. Salesforce admins can create a new Document Builder template or use an existing template as an attachment to their Agreement template.

To create a new Document Builder template:

  1. From the Agreements Templates tab in the Adobe Acrobat Sign for Salesforce lightning page, open an existing agreement template.

    Or, select Agreement Templates > New Agreement Template to initiate the process of  creating an agreement template. For more details, see how to Create an Agreement Template.

  2. Under the Template Details tab:

    1. Provide a name for the agreement template.
    2. In the Salesforce Object field, select an object. 

      Note: The Document Builder template uses the selected Salesforce object as the main data source. So, you must select the Salesforce master object before using Document Builder.

    3. Fill in the other details, as required.
    4. Select the Attachment tab.
    agreement-details-tab

  3. Select Create a New Template.

    Note:

    You must set the Salesforce master object in the Template Details tab before starting to create a Document Builder template. 

    attachment-tab

    Note: You can search and select any previously created templates from the 'Select an existing Document Builder template' search field. 

  4. In the dialog that appears, enter a template name and then select Create.

    cb template name

  5. In the page that opens, select a Sample Record Data from the drop-down list. Then, select Next.

    The sample record data helps you preview the fields in the template data.

    cb select record

  6. To add the fields that you want to include in your agreement template, select + Add and select a field name from the drop-down list. After you have added and verified all the required fields, select Next.

    add fields contract builder

  7. From the Tag Document tab, copy the anchor text for each field and paste it into your Word template. Or, select Download JSON to download the entire JSON file. 

    Once the file is downloaded, you see a message confirming the download. You can use the downloaded JSON file to import all the tags into your Microsoft Word template using the free Adobe Document Generation Tagger add-in. 

    CB tag document

    JSON file

  8. Select Next.

  9. To tag the template, open the Microsoft Word document and generate tags using Document Generation add-on.

    See how to install and use the Adobe Document Generation add-in for Microsoft Word.

    See how to add text tags to MS Word template using the Adobe Document Generation Tagger.

    document tagger

  10. Once you tag the document, return to the Document Builder wizard page and select Upload File to upload your tagged word template. Once the file is uploaded, select Done to close the dialog.

    The uploaded file is automatically assigned a template name. You may edit the Generated File Name field to rename the template file. 

    CB Template Output

  11. Once done, select Next. In the page that appears, select Preview.

    Note: You may select a different record data or modify information in the previous steps, if needed.

    CB template preview

    It opens a preview of your template with the sample data from the Salesforce sample record that you selected earlier.  

    cb template preview

  12. Verify your template with the selected sample record data, and select Save and close.

    It returns to the Agreement Template page and displays a notification that the Document Builder template is successfully created and added to the Agreement template.

  13. Go to the Attachment tab to view the Document Builder template. 

    Note: When a Document Builder template is added to an Agreement template, you cannot create or select another Document Builder template.

    CB template added

Send agreements using Document Builder templates

Once you create and add a Document Builder template, you can further configure the Agreement Template to send it to the recipients for signature. You can send an agreement with the Document Builder template for signature via:

  • The Agreements tab
  • The Agreements panel in an object record

To send agreements via the Agreements tab:

Once you create and add a Document Builder template to an agreement using the instructions above, follow the steps below to send that agreement for signature from the Agreements tab:

  1. From the top menu in the Adobe Acrobat Sign for Salesforce lightning page, select Agreements.

    agreements-tab-new

  2. In the Agreements page, select New

    It opens the Agreement Draft window, as shown below.

    agreements-tab-recipients

  3. In the new agreement draft page that opens, fill in the following information as required:

    1. Under Recipients, select a recipient role from the  Signer drop-down menu.
    2. In the Search Contacts field, search for the recipient's contact. Else, select Email from the drop-down menu and add the recipient's email address.
    3. Select I need to sign to add yourself as a signer. Select Sign Last or Sign First to set the signing order for yourself. Select Host signing for the first signer if needed.
    4.  To add more recipients, select Add Recipient.
    5. To set a password for identity verification of the recipients, select Password from the drop-down menu under Identity Verification. Next, enter and confirm your password. 
      Note: The recipient's email id is the default method of identity verification.
    6. Optionally, add a message for the agreement recipients.
    7. To add the Document Builder agreement template, select Add Files. In the Add Files dialog that opens, select the checkbox for the file that you want to include and then select Add Files.
      Alternatively, to add files from your computer, select Upload from My Computer and follow the workflow.
    agreements-tab-add-files

  4. Under Options:

    1. To password protect your signed document, select Password protect signed document. Next, assign a password in the password fields that appear.
    2. To set a Completion Deadline, select the calendar icon and chose a completion date. 
    3. To send reminders to the signers, select an appropriate option from the Create Reminders drop-down menu.  
    4. Optionally, select an alternate recipient language for the agreement.
    5. Select the Signature Type as E-Signature or Written Signature, as required.
    agreements-tab-options

  5. To send the agreement without previewing, select Send

    agreements-tab-options-preview

  6. To preview the agreement and add signature fields, select Preview & Add Signature Fields checkbox. Then, select Next to open the preview.

    agreements-tab-preview

  7. In the Preview window that opens, do one or more of the following actions, as required:

    • To add the signature fields for all recipients, select each recipient and then drag-and-drop the fields from Signature Fields menu in the right panel.
    • To add signer's title, company name, or other related fields, open Signer Info Fields drop-down menu and add the appropriate field.
    • To add data fields, open the Data Fields drop-down menu and add the desired data field type.
    • To insert a file attachment, open More Fields drop-down menu and drag-and-drop File Attachment. Double-click the File Attachment field and fill in the required details in the dialog. You may add Hyperlink if required.
    • To include a Participation Stamp or add a Transaction number, open Transaction Fields drop-down menu and add the desired option.
  8. Once you add all the required fields and preview the agreement, select Send.
    You may select Save as template to save the template for sending it later.

    It displays a message confirming that your agreement has been send for signature, as shown below. Select OK to return to the Agreements page.

    agreements-tab-sent-message

To send agreements from the Agreements panel in Object record:

A Document Builder template uses the Salesforce object that you select while creating an Agreement template. You can use the same Salesforce master object to send agreements with the Document Builder template to recipients for signature.

Follow the steps below to send agreements from the Agreements panel in an object record:

  1. In the Adobe Acrobat Sign for Salesforce lightning page, select the Apps icon and search for the object that you used to create the Document Builder template.

    To create a Document Builder template in the instructions above, we used the Opportunity object.

    object-record-search

  2. From the search result, select Opportunities to open the Opportunities object page.

  3. Under Recently Viewed, double-click the opportunity that you created to open the opportunity record.

    object-record-recenty-viewed

    It opens the selected opportunity page, as shown below.

    object-record-page

  4. In the Agreements panel, open the Send Agreement for Signature drop-down menu and select the agreement that you want to send for signature.

    object-record-select-agreement

    It opens the Agreement in draft mode, as shown below. Note that agreement includes the files from the agreement template that you selected in the step above.

    object-record-agreement-draft

    Note:

    If you do not see the Agreements panel in the Object record page, you can add the panel using the steps below:

    1. From the Opportunity object record page, select Setup > Edit Page.
    2. In the left panel of the page that opens, scroll down the Components list to locate Custom-Managed components.
    3. From the Custom-Managed list of components, select AgreemnetPanel and drag-n-drop to a desired location on the page. 
    4. From the top-right corner, select Activation.
    5. In the dialog that opens, follow through the workflow.
    6. Select Save.
  5. In the Agreement draft, fill in the required details and send the agreement for signature.

    Note: For details, follow the steps 3 to 8 in the instructions for Sending agreements via Agreements panel. 

Upgrade Document Builder base package to a later version

You can upgrade the Adobe Acrobat Sign Document Builder package from the Salesforce AppExchange. This section provides instructions on how to upgrade Adobe Acrobat Sign for Document Builder from an older version to the latest version.

Each version of Adobe Acrobat Sign Document Builder has new features and enhancements that can provide key improvements to your document workflows. We strongly recommend that you upgrade to the latest release since Adobe discontinues support of older versions over time.

To find the package version of the Adobe Acrobat Sign Document Builder that is currently installed:

  1. Log in to Salesforce using your admin credentials.
  2. Navigate to Setup > Platform Tools > Apps > Packaging > Installed Packages.
upgrade-check-current-version

To upgrade Adobe Acrobat Sign Document Builder package:

  1. Go here to access the current Adobe Acrobat Sign Document Builder package on the Salesforce AppExchange.

  2. Log in to the AppExchange using your Salesforce account credentials.

  3. Select Get It Now.

    upgrade-db-app-get-it-now

  4. In the dialog that appears, select one of the following options:

    • Install in Production
    • Install in Sandbox

    Note: We strongly suggest that you first test every installation or upgrade in the sandbox environment.

    upgrade-choose-environment

  5. Review the installation information and the terms and conditions. Then, select the checkbox for I have read and agree to the terms and conditions, and then select Confirm and Install.

  6. In the dialog that appears, log in to the Salesforce account using your credentials.

  7. In the Upgrade Acrobat Sign Document Builder page that appears, select Install for All Users and then select Upgrade.

    upgrade-doc-builder

  8. If the Approve Third Party Access popup displays, select Yes, grant access to these third-party websites, and then select Continue.

    upgrade-db-approve-3rd-party

  9. If you see a message saying this app is taking a long time to upgrade, select Done to continue.

    upgrade-db-in-progress

  10. Once the upgrade is complete, the Installed Packages page is displayed. You may check the listing of Acrobat Sign Document Builder to verify the installed version.

    upgrade-db-installed

Troubleshoot common problems

  • I get an 'Invalid refresh token' error when I try to sign in to Adobe Acrobat Sign for Salesforce. How do I fix the error?

To troubleshoot the 'Invalid refresh token' error, the Salesforce admin must ensure that OAuth to Sign is performed properly for the Document Builder package.

  • I get an error while uploading the Word template file for creating the Document Builder template. Why am I unable to upload the Word file?

The Word template used in the Document Builder template cannot exceed ~4.4MB. Depending on the mapping rules set in the Document Builder template and the data pulled from the Salesforce org, the allowed Word template size might be even smaller. So, you must ensure that the Word template file size is not larger than the limit. 

Adobe logo

Sign in to your account