Adobe Acrobat Sign for Salesforce: Developer Guide

Adobe Acrobat Sign for Salesforce: Developer Guide is designed to help Salesforce developers learn about the objects and parameters that are required to integrate your Salesforce package with Adobe Acrobat Sign.

Refer to the topics on this document to learn about:

• Developer guidelines
• Update Order
• Apex Services
• API Services
• Apex Batch Services
• Agreement Template Batch
• Agreement Template Service Batch
• REST Services
• Background Services
• Backward Compatibility Changes

• If you need to know when the agreement is fully signed, implement an Apex trigger on the echosign_dev1__SIGN_Agreement__c object, after or before update (depending on the use case and requirements). When the echosign_dev1__Status__c field changes to Signed or Approved or other final statuses, the agreement is completed. 
• If you need to know when each individual signed PDF is inserted, if for example you need to get each intermediate signed PDF, then implement an Apex trigger on the Attachment or ContentVersion objects, after insert, and watch for a parent agreement and a name which ends in "- signed.pdf" or "- approved.pdf" or other final status
• If you need to know when an individual recipient has signed or approved, implement an Apex trigger on the echosign_dev1__SIGN_Recipients__c object, after or before update (depending on the use case and requirements). When the echosign_dev1__Status__c field changes Signed or Approved or other final statuses, the recipient is completed.  
• If you need to know when a particular event which is part of the signing process occurs, such as an agreement being sent for signature or a reminder being sent, a trigger can be created on agreement events object (echosign_dev1__SIGN_AgreementEvent__c) and check for the type of the event
• The Final Agreement Status names for a completed agreement are: "Signed", "Approved", "Accepted", "Form-Filled", and "Delivered"
  
• The Final Agreement Status names for a terminated agreement are: "Cancelled / Declined", "Canceled / Declined", "Expired"

Order of updates

In v21 the order of updates has changed. Below is the sequence 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 

Apex Services

Apex Method in use

Starting Acrobat Sign for Salesforce V 21.0, all asynchronous processes (including automatic updates and data mappings) use the Queueable method instead of the Future method, as recommended by Salesforce.
With this change, all customization jobs that are added to the Salesforce queue for auto-update or data mapping process will fail with this error: "System.LimitException: Too many queueable jobs added to queue:2."

The failure happens because a queueable process can only add one child queueable job, which is already taken up by Acrobat Sign. For details, refer to Queueable Apex Limits. 

When the agreement status does not change, or the data mapping does not run correctly, it may display this error: "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."

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 for later.

Agreement Template Service

The agreement template service is exposed as a global Apex service by the managed package. This allows Apex code outside of the managed package to load agreements based on existing agreement templates. The class and all exposed methods are marked as global to allow such access.

The Apex service is exposed via this invocation class: echosign_dev1.AgreementTemplateService

Methods

 Constructors

Global Class properties

Runtime Variables

The echosign_dev1.AgreementTemplateVariable global class has the following two global fields:

• name: The variable name, which must match a runtime variable name configured in the agreement template.
• value: The variable value used during the template load. The value depends on where the variable was used. For example, for a recipient, it has to be a contact, lead, or user record ID or an email. For a document variable, it must be an attachment record ID.

Result

Every method either returns the ID of the newly created agreement record or throws an exception with a detailed error message if something goes wrong during the load operation.

API Services

The Adobe e-Sign API template service is exposed as a global Apex service by the managed package. This allows Apex code outside of the managed package to invoke a set of Adobe e-Sign API's through these wrappers. The wrappers greatly simplify the API invocation because consumers do not need to create request and response data model. Also consumers do not need to handle the transformation of Salesforce data into e-Sign data models. Most of the complexity is abstracted from the consumer. For example, to send an agreement the consumer just passes in the agreement record ID, the service will handle querying it, extracting all of the relevant data, passing it on the API and parsing the result.

The class and all exposed methods are marked as global to allow such access.

• v17 and below invokes SOAP API's
• v18 and above invokes REST API's

The Apex service is exposed through the following invocation class: echosign_dev1.EchoSignApiService

Apex API Enhancement for Alternate Recipients

Starting version 24.14 or later, the updated Apex API allows you to replace or add alternate recipients and is accessible within the global class "EchoSignApiService," two new elements have been introduced:

• A global function:
  

  /**

  * Input params:

  * toBeChangedRecipientId: SIGN_Recipient__c Id

  * newRecipientStr: JSON string of SIGN_Recipient__c of a new recipient for recipient replacement or alternate

  * changeType: REPLACE or ALTERNATE

  */

  global static void changeRecipient(Id toBeChangedRecipientId, String newRecipientStr, RECIPIENT_CHANGE_TYPE changeType )

• A global enumeration: RECIPIENT_CHANGE_TYPE {REPLACE, ALTERNATE}

Sample code to call this API for recipients (recipient type as Email)

// first query all the recipients associated with the agreement

List<SIGN_Recipients__c> recipients = [SELECT Id, echosign_dev1__Agreement__c, echosign_dev1__Email_Address__c, echosign_dev1__ParticipantSet__c, echosign_dev1__Recipient_Type__c, echosign_dev1__Order_Number__c FROM echosign_dev1__SIGN_Recipients__c where echosign_dev1__Agreement__c = 'a0P7X000008Cc1GUAS'];

SIGN_Recipients__c newRecipient = null;

SIGN_Recipients__c replacedRecipient = null;

// find the recipient that needs to be replaced or an alternate

// in this case, find the recipient by its email.

// More conditions can be added to find the recipient that is to be replaced or needs an alternate.

for(SIGN_Recipients__c recipient: recipients) {

    if (rep.echosign_dev1__Email_Address__c == 'someUser@example.com') {

         newRecipient = recipient.clone(false, true, false, false);

         replacedRecipient = recipient;

    }

}

// update emal address for new recipient

newRecipient.echosign_dev1__Email_Address__c = ''someNewUser@abc.com';

// serialize it to json string

String newRecipientStr = JSON.serialize(newRecipient);

Try {

    echosign_dev1.EchoSignApiService.changeRecipient(replacedRecipient.Id, newRecipientStr, EchoSignApiService.RECIPIENT_CHANGE_TYPE.REPLACE);

} catch (Exception ex) {

    // handle the exception and rethrow if needed

}

Methods

Inner Classes

• Global Class: DocumentHistoryEvent

• Global Class: DocumentInfo
  

• Global Class: ParticipantInfo

• Global Glass: SendDocumentResult

• Global Class: SigningUrl
  

Apex Batch Services

Exposes the main e-Sign agreement actions on a bulk level, allowing an operation to be performed on a set of agreements. This class implements the Salesforce Database.Batchable interface. It can process any number of records, which will be broken down into sets of 5 and processing each set as an individual transaction, which allows governor limits to be respected.

The Apex batch service is exposed through the following invocation class: echosign_dev1.EchoSignActionBatch

Parameters

You must specify the following parameters to initialize a batch operation:

• A list of the agreement record IDs on which to perform the provided action: The action can have any of the following supported values: Remind, Send, Cancel, Delete, or Update.
• Current user session ID: Required only for an update action type.
• Submitter user record: It's used to notify the user through an email once the bulk processing completes.

Usage Example

User submitterUser = UserInfo.getUserId();

EchoSignActionBatch batch = new EchoSignActionBatch( agreementIds, 'Remind', UserInfo.getSessionId(), submitterUser); Id syncProcessId = Database.executeBatch(batch, 5);

Agreement Template Batch

Takes in a SOQL query and an agreement template record ID. The query is executed to get a set of master object records, each of which is then run through the provided agreement template to generate an agreement record. This class implements the Salesforce Database.Batchable interface. It can process any number of records, which will be broken down into sets of 5 and processing each set as an individual transaction, which allows governor limits to be respected.

The record types returned by the SOQL query must match the provided agreement template master object type. For each record, the agreement template service is invoked.

The Apex batch service is exposed through the following invocation class:

echosign_dev1.AgreementTemplateBatch

Parameters

You must specify the following parameters to initialize a batch operation:

• SOQL query to execute: It must contain the record ID as a selected field. Other fields are optional.
• Agreement template record ID: It's used with the master record ID to load an agreement.

Usage Example

String agreementTemplateId = [SELECT Id from echosign_dev1__Agreement_Template__c where Name = 'Default Template']; String soqlQuery = 'SELECT Id from Contact where Account.IsActive = true';

AgreementTemplateBatch batch = new AgreementTemplateBatch(soqlQuery, agreementTemplateId); Id syncProcessId = Database.executeBatch(batch, 5);

Agreement Template Service Batch

Takes in a list of master object record ID's and the master object type, which are then queried, and each of which is then run through the provided agreement template to generate an agreement record. This class implements the Salesforce Database.Batchable interface. It can process any number of records, which will be broken down into sets of 5 and processing each set as an individual transaction, which allows governor limits to be respected.

The master object type provided must match the provided agreement template master object type. For each record, the agreement template service is invoked.

The Apex batch service is exposed through the following invocation class:

echosign_dev1.AgreementTemplateServiceBatch

Parameters

You must specify the following parameters to initialize a batch operation:

• List of master record IDs.
• Agreement template record ID: It is used with the master records to load an agreement.
• Master object name to query for the master records.

Usage Example

String agreementTemplateId = [SELECT Id from echosign_dev1__Agreement_Template__c where Name = 'Default Template'];

AgreementTemplateBatch batch = new AgreementTemplateServiceBatch(new List<Id>{'01p50000000HoMB'}, agreementTemplateId, 'Contact');
Id syncProcessId = Database.executeBatch(batch, 5);

REST Services

Agreement Template Service

The agreement template service is exposed as a Salesforce REST web service by the managed package. This allows external systems outside of the Salesforce org to load agreements based on existing agreement templates. Please refer to the Creating REST APIs using Apex REST article for more details on how to access and invoke custom REST Apex services from within Salesforce. Invocations must provide a valid session ID for authentication and authorization.

The web service is exposed from the following URL:

https://<instance_name>.salesforce.com/services/apexrest/echosign_dev1/template/load/<template_id>?masterId=<master_id>&varName1=var Value1&varName2=varValue2

Template ID

The last part of the URL is the ID of the agreement template record in the current Salesforce organization which should be used to load the agreement. This part of the URL is optional. If omitted, the agreement template marked as the default will be loaded. If the template ID is omitted and no default agreement template ID exists, an error will be returned.

The template ID can be in the 15 or 18 character format.

Master ID

The masterId parameter specifies which master record should be used to load the agreement from the specific agreement template. This parameter is optional, but must be specified for any agreement template which specifies a master object type and references that master object in the template.

The master ID can be in the 15 or 18 character format.

Runtime Variables

Any additional parameters are used as runtime variables, as name-value pairs, used to populate any runtime variables specified in the agreement template.

Result

The REST web service returns a LoadResult object which contains the following fields:

• agreementId : If the agreement load operation was successful, this contains the ID of the newly created agreement record.
• error : If there was any error during the loading of the agreement, this field will contain a detailed error message.

Background Service

The background service capability allows package consumers to invoke various actions on an agreement object by updating the Background Action (echosign_dev1 Background_Actions c) field to the corresponding value. Once the field value is changed from a blank value or another value to one of the following values, the action is kicked off from a trigger that is part of the e-Sign managed package.

• Remind
• Send
• Cancel
• Delete
• Update

All of the actions execute in an asynchronous future mode, so the status will be stored in the Error field on the agreement.

Backward Compatibility Changes