Menu

storeESignature

Stores data of an e-signature process initiated through sendToDocuSign into Salesforce as a new record. The record will be of type "Dynamo_ESignature__c", so be sure to have this Dynamo e-signature custom object type defined in your organization before using this command. The created record will receive status updates as the signing process progresses if the related DocuSign account is properly configured to send updates to Dynamo.

This command will set field values for the created record as follows:

  • ESignature_DocumentId__c: Set to the resolved value of the documentId attribute.
  • ParentId__c: Set to the resolved value of either fileId or parentId attribute, depending on which one is defined. If both are defined, fileId takes priority.
  • Sent_By__c: Set to the resolved value of the sentBy attribute.
  • Sent_To__c: Set to a string containing the e-mail addresses of the signers, as defined with the signer child commands of sendToDocuSign.
  • Date_Sent__c: Set to the moment of this command's evaluation.
  • Status__c: Set to "pending".
  • Field defined by parentIdFieldName: Set to the resolved value of parentId. Will not be set if parentIdFieldName is undefined.

Attributes

documentId

Required
Value type
EL-evaluated
Yes String Yes
Defines the ID of the DocuSign envelope whose data is to be recorded into Salesforce. This can be acquired from the sendToDocuSign command through its "envelopeIdVar" attribute.
fileId

Required
Value type
EL-evaluated
No String Yes
Defines that the signed document should be uploaded into Salesforce as a new version of a specified file record. The resolved value is expected to be the ID of a ContentDocument record.

Either this or the parentId attribute has to defined. Both being undefined produces an error.
parentId

Required
Value type
EL-evaluated
No String Yes
Defines that the signed document should be uploaded into Salesforce as an attachment for a specified record. The resolved value is expected to be the ID of a record that can accept Attachment records.

The resolved value of this attribute will also be set on the created Dynamo_ESignature__c record as the value of the field defined by parentIdFieldName, if that attribute is defined.

Either this or the fileId attribute has to defined. Both being undefined produces an error.
parentIdFieldName

Required
Value type
EL-evaluated
No String Yes
Defines the name of a field on the Dynamo e-signature custom object whose value for the created record will be set to the resolved value of the parentId attribute. The resolved value is expected to be the API name of the field.  
sentBy

Required
Value type
EL-evaluated
Yes String Yes
Defines the value for the Sent_By__c field on the created Dynamo_ESignature__c record. 

Signature status custom object definition

API name: Dynamo_ESignature__c

Field Label Field Name (API Name) Data Type
Created By
 CreatedById
Lookup(User)
Date Sent
 Date_Sent__c
Date/Time
Date Signed
Date_Signed__c
Date/Time
Dynamo ESignature Name
Name
Text(80)
ESignature_DocumentId
ESignature_DocumentId__c
Text(64)
Last Modified By
LastModifiedById
Lookup(User)
Owner
OwnerId
Lookup(User,Group)
Sent By
Sent_By__c
Email
Sent To
Sent_To__c
Long Text Area(32768)
Status
Status__c
Text(64)
ParentId
ParentId__c
Text(64)
Optional lookup field(s) defined with the parentIdFieldName attribute. Record ID is set using parentId attribute.
If status record should be related to Opportunity, use following field definition (parentIdFieldName="Opportunity__c")
Opportunity
 Opportunity__c
Lookup(Opportunity)

Examples

The storeESignature command requires the ID of a DocuSign envelope, which is provided by sendToDocuSign. Therefore this command can generally be placed right after sendToDocuSign. Use the parentIdFieldName attribute to have the created Dynamo_ESignature__c record be linked to some other record, such as an Opportunity in this example's case.

<sendToDocuSign value="${documentPDF}"
                username="signatureseeker@dyndynamo.dyn"
                password="alwaysbesigning"
                integratorKey="11111111-2222-3333-4444-555555555555"
                emailSubject="${documentPDF.title}"
                environment="DEMO"
                envelopeIdVar="envelopeId">
  <signer email="${firstSigner.email}" name="${firstSigner.name}" />
<storeESignature documentId="${envelopeId}" parentId="${opportunity.Id}" parentIdFieldName="Opportunity__c" sentBy="${UserInfo.email}" />  

Comments

0 comments