Adobe Sign for Salesforce

Transcription

1 for Salesforce Developer Guide (v18) 2016 Adobe Systems Incorporated. All Rights Reserved. Last Updated: October 20, 2016

2 Table of Contents Salesforce Consumer Integration Documentation Apex Services... 3 Agreement Template Service... 3 API Service Methods... 4 Inner Classes... 5 Apex Batch Services... 7 Action Batch Service... 7 Agreement Template Batch... 8 Agreement Template Service Batch... 9 REST Services Agreement Template Service Background Service Adobe Sign for Salesforce Developer Documentation 2

3 Salesforce Consumer Integration Documentation This document is designed to provide the services available to Salesforce developers when coding custom solutions using the Adobe Sign application. Apex Services Agreement Template Service The agreement template service is exposed as a 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 to allow such access. The Apex service is exposed through the following invocation class: echosign_dev1.agreementtemplateservice Note: Loading an agreement template with esign Library Templates is currently not supported. Move the document templates to a Salesforce document library. Methods static Id load() Loads an agreement using an agreement template marked as default and which has no master object type. static Id load(string templateid) Loads an agreement using the specified agreement template ID, which has no master object type. static Id load(string templateid, String masterid) Loads an agreement using the specified agreement template ID and the specified master record ID, whose type must match the master object type configured in the specified agreement template. static Id load(string templateid, String masterid, Map<String,AgreementTemplateVariable> agreementtemplatevariables) Loads an agreement using the specified agreement template ID and the specified master record ID, whose type must match the master object type configured in the specified agreement template. Also passes in the specified runtime variables as name value pairs. Runtime Variables The echosign_dev1.agreementtemplatevariable class has two fields. name : The variable name, which must match a runtime variable name configured in the agreement template. Adobe Sign for Salesforce Developer Documentation 3

4 value : The value of that variable which will be 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 . For a document variable, it must be an attachment record ID. Result Every method either return the ID of the newly created agreement record or throws an exception with a detailed error message if something went wrong during the load operation. API Service The Adobe esign API template service is exposed as a Apex service by the managed package. This allows Apex code outside of the managed package to invoke a set of Adobe esign 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 esign 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 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 Methods static void canceldocument(id agreementid) Cancels the agreement with the specified agreement ID. static void delegatesigner(id agreementid, String delegated ) static void delegatesigner(id agreementid, String delegated , String message) static echsign_dev1.echosignapiservice.documentinfo getdocumentinfo(id agreementid) Delegate signing to the provided . Delegate signing to the provided with the specified message. Retrieves detailed information for the specified agreement ID. static List getsigningurls(id agreementid) Retrieves all signing URL's for the specified agreement ID. Adobe Sign for Salesforce Developer Documentation 4

5 static void removedocument(id agreementid) Cancels the agreement with the specified agreement ID and deletes the agreement record in Salesforce (the agreement is not removed from the Adobe esign account). static void replacesigner(id replacementrecipientid) static void replacesigner(id replacementrecipientid, String message) static echsign_dev1.echosignapiservice.sendd ocumentresult senddocument(id agreementid) Replaces the specified signer. Replaces the specified signer with the specified message. Sends out the agreement with the specified agreement ID, returns the result with the document key and URL's. static void sendreminder(id agreementid) Sends a reminder to the current signer for the specified agreement ID. Inner Classes class DocumentHistoryEvent Properties (2) Name String eventtype String participant Constructors (1) Signature DocumentHistoryEvent() class DocumentInfo Properties (5) Name Map<string,list> historyby Map participantsby Map participantsbyname String sender String status Adobe Sign for Salesforce Developer Documentation 5

6 Constructors (1) Signature DocumentInfo() class ParticipantInfo Properties (5) Name String company String String name String status String title Constructors (1) Signature ParticipantInfo() class SendDocumentResult Properties (3) Name String documentkey Exception error String url Constructors (1) Signature SendDocumentResult() Adobe Sign for Salesforce Developer Documentation 6

7 class SigningUrl Properties (3) Name String String esignurl String simpleesignurl Constructors (1) Signature Global Apex Batch Services Action Batch Service Exposes the main esign 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 The following parameters must be specified to initialize a batch operation. A list of the agreement record ID's on which to perform the provided action. The action to perform, one of the following supported values: Remind Send Cancel Adobe Sign for Salesforce Developer Documentation 7

8 Delete Update Current user session ID. Only required for an update action type. Submitter user record, used to notify this user through an once the bulk processing completes. Usage Example User submitteruser = UserInfo.getUserId(); EchoSignActionBatch batch = new EchoSignActionBatch( agreementids, 'Remind', UserInfo.getSessionId(), submitteruser); 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 The following parameters must be specified to initialize a batch operation. SOQL query to execute, must contain the record ID as a selected field. Any other field is optional. Agreement template record ID, which will be used in conjunction 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'; Adobe Sign for Salesforce Developer Documentation 8

9 AgreementTemplateBatch batch = new AgreementTemplateBatch(soqlQuery, agreementtemplateid); 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 The following parameters must be specified to initialize a batch operation. List of master record ID's. Master object name to query for the master records. Agreement template record ID, which will be used in conjunction with the master records to load an agreement. Usage Example String agreementtemplateid = [SELECT Id from echosign_dev1 Agreement_Template c where Name = 'Default Template']; AgreementTemplateBatch batch = new AgreementTemplateServiceBatch(new List<Id>{'01p HoMB'}, 'Contact', agreementtemplateid); syncprocessid = Database.executeBatch(batch, 5); Adobe Sign for Salesforce Developer Documentation 9

10 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: d>?masterid=<master_id>&varname1=var Value1&varName2=varValue2 Note: The instance name will vary depending on your org instance. 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 template 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: Adobe Sign for Salesforce Developer Documentation 10

11 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 which is part of the esign 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. Adobe Sign for Salesforce Developer Documentation 11