You are here:
Use the DocuSign Signature Action to Sign Documents From Within an Omniscript (Managed Package)
For the managed package runtime, after you prepare the DocuSign template and map the fields from the Omniscript to the template using an Omnistudio Data Mapper Transform, you can create a DocuSign Signature Action in the Omniscript. When the action runs, a DocuSign window opens containing the prefilled document. The user must sign or decline to sign the document before continuing the Omniscript.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Before you begin:
To create a DocuSign Signature Action:
-
From the Omniscript Designer Build tab, drag a DocuSign Signature
Action element from the Actions section into a Step or block element,
where it renders as a button.
NoteEdit Block doesn't support the DocuSign Signature action.
- In the DocuSign Signature Action properties, click Add Template. The Edit Template window opens.
- Select your DocuSign Template.
- Select a template Role. Roles are defined in the DocuSign template.
- In the DR Interface field, enter the name of the Data Mapper Transform.
- Click Save. The Edit Template window closes.
-
Enter a Signer Name and Signer
Email.
The Signer Name and Signer Email fields support merge fields. For example
%FirstName% %LastName%merges the contents of the FirstName and LastName fields into the Signer Name field during runtime. - Add an Email Subject and Email Body that recipients receive after signing.
- If needed, enter a DocuSign Return Url that replaces the DocuSign window after signing is complete.
To use an Omniscript with a DocuSign Signature Action in an Experience Cloud site, add the OmniScriptLwcDocuSignViewPdf Visualforce page permission to any profiles using the Omniscript.
When the DocuSign window opens, a node is written to the Omniscript data JSON in this format:
"DocuSignElementName": [
{
"status": "Declined",
"envelopeId": "xyz123"
},
{
"status": "Completed",
"envelopeId": "xyz123"
}
]A new status and envelopeId are generated every time the DocuSign window launches. Statuses
include Completed, Declined, and In Process.
If you’re a developer overriding the OmniScriptDocuSignReturnPage in your Omniscript, post the DocuSign Return Page status back to the Omniscript using window.parent.postMessage. For example:
window.addEventListener('DOMContentLoaded', function(event){
var domClass = '';
var searchStr = event.currentTarget.location.search;
searchStr = searchStr.substring(searchStr.indexOf('&event='), searchStr.length);
searchStr = searchStr.substring(searchStr.indexOf('=') + 1,searchStr.length);
if(searchStr === 'signing_complete') {
domClass = document.getElementById('signing_complete');
domClass.style.display = 'block';
} else {
domClass = document.getElementById('signing_failed');
domClass.style.display = 'block';
}
_window.parent.postMessage(searchStr, '');_*
});