User Guide Cancel

Adobe Acrobat Sign for Salesforce: Upgrade Guide

  1. Adobe Acrobat Sign Integrations
  2. What's New
  3. Product Versions and Lifecycle
  4. Acrobat Sign for Salesforce
    1. Install the package
    2. Configure the package
    3. User Guide
    4. Developer Guide
    5. Advanced Customization Guide
    6. Field Mapping and Templates Guide
    7. Mobile App User Guide
    8. Flows Automation Guide
    9. Document Builder Guide
    10. Configure Large Documents
    11. Upgrade Guide
    12. Release Notes
    13. FAQs
    14. Troubleshooting Guide
    15. 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. Live Sign Guide
      3. Mobile User Guide
      4. Release Notes
      5. 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
      2. Release Notes
    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. User Guide
    4. Release Notes
  7. Acrobat Sign for HR ServiceNow
    1. Installation Guide (Deprecated)
  8. Acrobat Sign for SAP SuccessFactors
    1. Cockpit Installation Guide (Deprecated)
    2. Recruiting Installation Guide (Deprecated)
    3. Recruiting User Guide
    4. Cloud Foundry Installation Guide
    5. Release Notes
  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
    3. Upgrade Guide
    4. Release Notes
  13. Acrobat Sign for Coupa BSM Suite
    1. Installation Guide
  14. Acrobat Sign Developer Documentation
    1. Overview
    2. Webhooks
    3. Text Tags

Overview

The Adobe Acrobat Sign for Salesforce: Upgrade Guide provides instructions on how to upgrade the Adobe Acrobat Sign for Salesforce package from an older version to the latest released version.

Adobe requires you to upgrade to the latest version of Adobe Acrobat Sign for Salesforce because:

  • Each version of Adobe Acrobat Sign for Salesforce has new features and enhancements that can provide key improvements to your document workflows. 
  • Adobe Acrobat Sign for Salesforce provides support only for the latest version (N) and two major versions before the latest version (N-1 and N-2). Unsupported versions have elevated security risks and are denied API access to the Adobe Acrobat Sign service.

Important upgrade notes 

  • Don’t uninstall your existing Adobe Acrobat Sign for Salesforce package as it may result in the loss of your Acrobat Sign data at Salesforce.
  • If you have users in your Salesforce org who belong to multiple Acrobat Sign accounts, before upgrading contact your Adobe client success manager or Adobe Customer Care.
  • Before upgrading your production account, you must upgrade and test in your sandbox environment.
    Make sure that your email address in the sandbox environment is one that you have access to if you must change the email for your Acrobat Sign account.
  • Ensure that the 'Lock sessions to the IP address from which they originated' setting is disabled. To configure, go to Setup > Settings > Security > Session Settings.
  • Review the What's New sections below to determine if there are options that must be manually configured.
    Each release has many new features and settings that may require a manual update.
  • To learn about the latest features in Adobe Acrobat Sign for Salesforce, see Adobe Acrobat Sign for Salesforce: Release Notes.
  • If you’re installing a new instance of the package, see the Adobe Acrobat Sign for Salesforce: Installation Guide.
  • Starting version 24.14, Adobe Acrobat Sign for Salesforce doesn’t support the SOAP API-based push model for triggering automatic status updates. The automatic agreement status updates will be triggered using only the REST API-based pull model.
    If you installed Adobe Acrobat Sign for Salesforce package version 20.x or lower, test the upgrade in your sandbox org. If the agreement status upgrade doesn’t work, then go to the Admin tab on your Adobe Acrobat Sign for Salesforce page, and rerun Enable Automatic Status Update.
  • Users upgrading to Adobe Acrobat Sign for Salesforce V 24.14 need to manually add the new picklist values for setting reminders in agreements. However, the new picklist values are available by default for users who do a clean install of the package v 24.14. 

Verify the current version

Before upgrading, find the version of the currently installed package:

  1. Log into Salesforce using your admin credentials.
  2. Navigate to Setup > Platform Tools > Apps > Packaging Installed Packages and then check the version number for the Adobe Acrobat Sign package.
Verify the version of installed Adobe Acrobat Sign for Salesforce app.

Update the package

  1. Go to the Salesforce AppExchange to access the latest Adobe Acrobat Sign for Salesforce package and then select Get It Now.

  2. Select Log in to the AppExchange and enter your credentials to continue.

  3. In the dialog that appears:

    • Select Install in Production to install the package in the production environment.
    • Select Install in Sandbox to install the package in a sandbox environment.

    We suggest that you test each install in the sandbox environment first.

  4. Review the installation information and terms and conditions, confirm that you have read and agree to the conditions, and then select Confirm and Install!

  5. When prompted to log in to your Salesforce organization, enter your user credentials, and then select Login to Salesforce.

  6. On the Upgrade Adobe Acrobat Sign page that appears, select Install for All Users and then select Upgrade.

    Note: Installation can take a few minutes.

    Upgrade the package version of Adobe Acrobat Sign for Salesforce.

  7. If the Approve Third-Party Access dialog displays:

    • Check Yes, grant access to these third-party websites.
    • Select Continue to start the installation.
  8. On the message that says the installation may take some time, select Done and wait to receive the email notifying you that the package has been installed successfully.

    Once you receive the confirmation email, the Installed Package page displays the current package version.

    To configure your new package, see post-install configurations.

    Upgrading Adobe Acrobat Sign for Salesforce package version.

Configure the updated package

You must refresh the OAuth connection between Adobe Acrobat Sign and Salesforce. 

Adobe Acrobat Sign for Salesforce objects may change as the package evolves so you must verify your workflows. If you build a custom solution that depends on the changed objects, you may be required to update your customization.

  1. Navigate to Setup > Platform Tools > Apps > Packaging > Installed Packages.

  2. For the Adobe Acrobat Sign package, select Configure.

    It launches the Adobe Acrobat Sign for Salesforce Setup Wizard.

    Note: If the Setup wizard doesn’t launch automatically, navigate to the Adobe Acrobat Sign Admin tab and select Launch Setup Wizard.

    Launch setup

  3. In “Step 1: Link your Adobe account to Salesforce” of the Setup wizard:

    1. Select Sign in to Adobe. 
    2. Log in to Adobe Acrobat Sign using your admin credentials.
    3. When prompted, select Allow Access.

    It displays a message saying Success! You have successfully authorized your Adobe account.

  4. On the successful step 1 notification, select Next.

  5. In “Step 2: Enable Adobe Sign Automatic Status Updates”:

    1. Select Enable.
    2. When asked to allow access to Adobe Acrobat Sign, select Allow.

    It displays a message saying Success! You have successfully enabled Automatic Status Updates for your account.

  6. Select Next.

  7. When the Setup wizard displays Congrats! Your setup is complete, select Done.

  8. Configure any manual updates listed in the What's New section, as required.

Note:

Once the installation and configuration of the new package are complete, you should see the appropriate sections in Acrobat Sign for Salesforce: Upgrade Guide for information on which settings and fields were added in previous versions.

Manually enable these new settings and field values in your org for the new package to work correctly. For example, if you’re upgrading from v19 to v23, you should enable any manual edits listed for versions v20, v21, and v22.

What’s new

Package version 24.26

Add the 'Email OTP' picklist value

For mobile users upgrading from version 24.26, the Email OTP option isn't enabled by default. You must manually enable it as follows:

  1. Go to Setup > Object Manager > Recipient > Fields & Relationships > Signer Verification Method.
  2. Scroll down to the Values section and then select New.
  3. Enter Email OTP.
  4. Select Save.

Package version 24.14

  • Adobe Acrobat Sign for Salesforce V 24.14 includes new picklist values (as shown in the image below) for setting reminders in Agreement Template and in an Agreement. 
    When upgrading to package V 24.14, Salesforce admins must manually add the following picklist values to the 'Automatic Reminders' custom field in Agreement Template and to the 'Remind recipient to sign' custom field in the Agreement:
    • Every Business Day, Until Signed
    • Every Other Day, Until Signed
    • Every Third Day, Until Signed
    • Every Fifth Day, Until Signed
Adobe Acrobat Sign for Salesforce V 24.14 adds new picklist values for sending reminders to recipients or generating automatic reminders for agreement templates.
Adobe Acrobat Sign for Salesforce V 24.14 adds new picklist values for sending reminders to recipients or generating automatic reminders for agreement templates.

  • To enable the Acrobat Sign verification method, Salesforce admins must add the new 'Acrobat Sign' picklist value to the 'Signer Verification Method' (API name echosign_dev1_Signer_Verification_Methodc) field in the Recipient (API name echosign_dev1SIGN_Recipients_c) object.
NewSignerVerificationPickListValue.png

  • V 24.14 supports the recipient's name-locking feature that mandates the recipient name for KBA authentication for all agreements. To successfully implement the KBA name required setting, admins must add the new picklist value 'Acrobat Sign authentication' to the 'Internal Signers Verification Method' in Agreement and Agreement Template objects, as shown below. 
AgreementTemplateInternalSignerVerificationMethod.png

AgreementTemplateNewPicklistValue.png

  • Starting v 24.14, Adobe Acrobat Sign for Salesforce does not support the SOAP API-based push model for triggering automatic status updates. The automatic agreement status updates are now triggered using only the REST API-based pull model.

Package version 23.x

This feature has been put in place to allow Adobe Sign to collect usage data to improve the product. This data is used only for development and not for marketing purposes.

Admins can enable or disable this feature on the Adobe Sign Admin tab or by running the set-up wizard.

Starting in v23 of the Adobe Sign for Salesforce package, the Files document storage object will be the primary object used in development.

Customers upgrading from versions v23.0 or older will have their existing default storage type exempted from their upgrade (attachments usually) to ensure no breakage of the process is experienced.

Admins should evaluate the impact of changing the document storage type to Files to best take advantage of future features.

To support the admin control of the document storage type, a new control has been added to the Custom Settings > Adobe Sign Settings set of controls.

This user interface maps to the custom object:  Agreement_Document_Storage_Type__c

Viable setting values are:

  • {empty} - If the value is empty, the default behavior is based on the install version of the package
    • Version 23.0 or later will default to Files as the default storage type
    • Versions 23.0 or older default to Attachments as the default storage type
  • Files - Strongly defines Files as the default storage object for Adobe Sign document
  • Attachments - Strongly defines Attachments as the default storage object for Adobe Sign document
Doc Type Setting

Package version 22.x

The introduction of Workflows into the Salesforce package requires other access permissions to be enabled.

If you intend to use workflows, then you must refresh the OAuth links.

No manual configurations or system changes are required.

Package version 21.5.11
A required installation package for all versions that pre-date v21.5.9

Any existing installation that upgrades from version 21.5.9 or older must install the 21.5.11 package first.

After v21.5.11 is installed, the current package can be installed.

Any existing installation that upgrades from version 21.5.9 or older must install the 21.5.11 package first. After v21.5.9+ is installed, the current package can be installed.

Chatter must be enabled to install the v21.5.11 package.

Before you start the upgrade process, verify that Chatter is enabled:

  1. Navigate to Setup > Platform Tools > Feature Settings > Chatter > Chatter Settings.
  2. If Chatter is Disabled, select Edit.
  3. Select the Enabled check box.
  4. Select Save.
Enable Chatter

Package version v21.x

Note:

v21.x brings several updates to the way Adobe Sign for Salesforce operates. 

It’s strongly recommended that you install v21.x into your sandbox environment first, to verify that all aspects of the application work as you expect. 

Developers should take care to review the changes to the update order, and the change in apex method. 

As of v21.0, the SIGN_Signed_Agreement__c object (label name: Signed Agreement") has been deprecated.

Customers that would like to obtain the signed agreement URL should use the REST API agreement call GET /agreements/{agreementId}/combinedDocument/url

Note: The returned URL from the API call is secured, and only viable for a limited time.

Below is the new sequence (as of v21.0) in which the agreement and its related objects are updated:

  1. Attachments 
  2. Recipients 
  3. Agreement (status and its other attributes)
  4. Agreement events 
  5. Chatter feeds 

Starting v21.x, all asynchronous processes that include automatic updates and data mappings are switched from future methods to queuebale, a new approach recommended by Salesforce.

Due to this change, any customizations in the subscriber org which add jobs to the Salesforce queue as part of the auto-update and/or data-mapping process fails with an error "System.LimitException: Too many queueable jobs added to the queue: 2"

This happens because a queuebale process can only add one child queueable job, which is already taken up by Adobe Sign (refer to the "Queueable Apex Limits" section here).

"When chaining jobs, you can add only one job from an executing job with System.enqueueJob, which means that only one child job can exist for each parent queueable job. Starting multiple child jobs from the same queueable job isn’t supported."

The symptom of this error is that the agreement status does not change and/or the data mapping does not run correctly. 

To resolve this error, look for the offending trigger, process builder, or workflow and deactivate it or switch it to use a synchronous call or schedule it in the future, for example 1 hr later.

  • The agreement status is now updated after the documents and recipients are updated.
    For V 21 or earlier, the status was set before.
  • Agreement event descriptions now match the description as returned by Sign API and with the audit reports.
  • The update process now runs as a native Apex batch process, which is an asynchronous process, within Salesforce.
    Earlier it was an update using API calls from outside Salesforce. Triggers off these status updates which kick off async processes no longer work because Salesforce limits calling another async process from an already running async process.
  • The agreement object is now updated all in one transaction.
    Before v21, the agreement attribute updates were split up into separate update calls.
  • Now updates are more reliable as the Sign back end automatically retries failed events for a specified number of times.
    Before v21, failed agreements could be only retried by doing a manual update from within Salesforce
  • Manual updates now update all aspects of agreements including the related objects.
  • Push agreements now run in async mode, the same as regular updates, and other attributes are updated, the same as regular updates.
  • There are new settings introduced to enable and disable updates of different aspects of the agreement.
  • When a signed PDF is stored in Salesforce, there will no longer be a descriptor (-signed or -approved) appended to the end of the PDF filename.

 

Once the upgrade is complete, follow the below steps to re-establish an OAuth connection to Acrobat Sign:

  1. Select Adobe Acrobat Sign Admin tab.
  2. Select Enable Automatic Status Updates.
  3. Select Enable.
  4. Select Allow.

In v20, the Callback user at Salesforce wasn’t required to be an Adobe Sign licensed user. 

Push Mapping improvements in v21 require that the Callback user have an active user ID in the Acrobat Sign account that is connected to the Salesforce organization.

v20 customers using Push Mapping must ensure that the Callback user is already provisioned in Adobe Acrobat Sign before upgrading. Otherwise, the Push Mapping will stop functioning (until the user is provisioned) after upgrading to v21.

The Push mapping functionality that automatically linked related objects using the setting ‘Copy contact Account/Opportunity’ has been expanded to include agreements sent from Salesforce.

  • e.g. Agreements sent from Salesforce will automatically copy the first contact recipient’s Opportunity lookup to the Agreement’s Opportunity lookup and first Contact recipient’s Account lookup to the Agreement’s Account lookup, if the agreements sent do not have any linked Account/Opportunity

Prior to v21, Chatter feeds were only populated when the agreement was sent from within Salesforce.

This update expands the Chatter feed to include agreements sent from outside Salesforce (Push agreements)

Prior to v21, the Agreement View only updated the PDF image and URL after the first recipient completed their action.

The image and URL now update earlier, when in a Prefill status, or when Out for Signature to the first recipient.

 

No configuration is required to enable this functionality.

A new Agreement status of Waiting for My Delegation is being introduced to reflect when an agreement is waiting for the Sender to delegate the current recipient authority.

 

No configuration is required to enable this status.

The Agreement Template has a "Days Until Expiration" field (echosign_dev1__Days_Until_Expiration__c).  This is a numeric field, and has been deprecated in v21.

A new "Days Until Expiration" field (api name: echosign_dev1__Days_Until_Expiration2__c) has been added, but is a text field, allowing it to reference other fields in the Master Object (for example{!Expiry_Date__c})

When upgrading from a previous version, any form data mapped to the legacy expiration field is automatically copied to the new field, so no direct action is required.

The Account, Opportunity, and Contract fields are no longer available on the template page.

Admins can configure these fields in the template using the Map Data into Agreement Fields feature

Previously, senders could define their absolute position in the signature stack as "Sender Signs First" or "Sender Signs Last".

This field is no longer available on the New template pages. Senders have the option to insert themselves in any position of the signature stack.

The toggle to control the overall signature flow as "Sequential" or "Parallel" has been removed.

The new template style allows a fully configurable workflow that can be wholly sequential (Signer index 1 through 1+N), parallel (all Signer indexes are 1) or a mixture of sequential and parallel where the signature index is configured to the specific workflow.

Five settings have been deprecated in v21. All settings were in the Adobe Sign Settings section of Custom Settings.

The five settings are:

  • Add Audit PDF to Attachment List—Enable this setting to attach the PDF of the audit trail to the Agreement record after the agreement is signed.
  • Add Signed PDF as Separate Attachments—Enable this setting to attach the PDF of the signed agreements as separate attachments when there are multiple documents sent in a single transaction. To stop receiving the signed agreement as a merged PDF, please contact Adobe Customer Care for assistance. 
  • Add Supporting Files to Attachment List—Enable this setting to attach the PDFs of the supporting documents to the Agreement record after the agreement is signed. Through the supporting document fields in the agreement, the signers upload and attach the supporting documents to the agreement transaction.
  • Add Signed PDF Link for Pushed Agreements (enabled by Default)—This setting applies only for pushed agreements sent outside Salesforce. Enable this setting to add a link for signed PDF to the agreement record.
  • Add Signed PDF for Pushed Agreements (enabled by Default)—The setting applies to agreements sent from outside Salesforce and pushed into Salesforce. Enable this setting to attach the signed PDF to the agreement record. 

Customers that are using the above settings can configure the new setting under Adobe Sign Agreement Update Settings.

Deprecated Setting (under Adobe Sign Settings)

New Setting (under Adobe Sign Agreement Update Settings)

Add Audit PDF to Attachment List

Add Audit Report

Add Signed PDF as Separate Attachments

Add Signed PDF as Separate Attachments

Add Supporting Files to Attachment List

Add Supporting Files

Add Signed PDF Link for Pushed Agreements

Add Signed PDF URL

Add Signed PDF for Pushed Agreements 

Add Signed PDF

 Adobe

Get help faster and easier

New user?

Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online