ESignLive v1.2
This package provides capabilities that extend the Avoka Transact platform for users wishing to include eSignature services in their forms using the OpenSpan eSignLive service. Signing experiences available include:
-
Embedded Signing
Signing will occur within the form, before final submission of the form.
-
Remote Signing
Signing will occur after the form has been submitted, with signing invitations being sent to signatories via email.
To support signing capability this package provides the following components
-
E-Signature
A single E-Signature, this will be used as an anchor on the file form receipt to indicate to eSignLive where to place signatures onto the document.
-
Date Stamp
A date stamp to be linked to signatures to indicate when a signatory has completed that signature
-
Embedded Signing Ceremony
Used when providing an embedded signing experience, it is recommended that this component is placed onto the last page of the form.
Using Signatures
Placing a signature block is as simple a placing it on the form. The signature block must then be configured with its signers details. Signer details are provided through field references available on the E-Signature widget. Date Stamps can be placed in the same way as E-Signatures and are configured by linking the signature they will display the timestamp for.
NOTE : Currently E-Signatures may only have a single date stamp.
Positioning Signatures & Date Stamps
Positioning the Signature & Date Stamp widgets can be done one of two ways :
-
Relative
The block will be placed onto the pdf receipt where the tab was placed onto the form
-
Absolute
The block will be placed onto the pdf receipt at the pixel location of the page number specified by the parameters "Page Number", "Position X" and "Position Y"
Embedding the signing ceremony
The embedded signing ceremony required minimal configuration, and can simply be placed on the form. The following rules are provided on the form to allow customisation of the signing experience :
-
On Complete
Allows the form designer to specify a script to run when the signing ceremony has been completed.
-
On Failure
Allows the form designer to specify a script to run if the signing ceremony fails (usually due to a signer opting out or declining to sign)
NOTE : The signing ceremony will begin as soon as the signing ceremony is visible
WARNING : Once the Signing Ceremony has been created it cannot be changed, as changing the contents of the documents would void the signing package.
Using an alternative document for signing
By default, the document presented to a user for signing will be the submission receipt PDF generated by Transact Manager.
Sometimes however a document other than the submission receipt is required to be signed, such as a pre-defined contract document.
The EsignLive - Create Package service can be configured to retrieve a PDF document from another location, to be used in place of the receipt PDF.
The Document Service Name service parameter can be set to any Fluent Groovy service that will return a byte array containing a PDF document.
The service must include the following method signature:
byte[] invoke(SvcDef svcDef, HttpServletRequest request, User user, Map params) {...}
For example, a Fluent Groovy service may be written that returns a previously uploaded document from an Organisation (or Form) property in Transact Manager. Alternatively, a 3rd party REST API may be utilised to provide a custom PDF containing data from the submission XML.
Delivering the Signed Documents
The EsignLive - Delivery Process is provided so completed eSignLive Packages will be attached to their respective transactions once all signers have completed their signing. The delivery process may be customised by configuring this service to call another delivery service once it has finished see the service help documentation for details.
Licensing
Clients must ensure they are appropriately licenses in order to use this package. Organisations who wish to use this package are required to establish a commercial relationship with eSignLive directly.
Compatibility
This package has the following compatibility requirements:
| Module | Compatibility | Notes |
|---|---|---|
| Transact Manager | 5.0.2 or above | |
| Transact Maestro | 5.0.2 or above |
Release Notes
Version 1.2 January 28, 2026
- Implemented OAuth 2.0 authentication
Updating to this version is mandatory, and requires following these steps:
- Login to the OneSpan Sign dashboard with account admin credentials and:
- Select "API Access" from the "Admin" dropdown
- Select "OAuth 2.0 Client Credentials" radio button
- Click OAuth 2.0 in the left nav panel
- Click the +ADD link to add a new OAuth 2.0 Client
- Add the new client and save the Client Id and Client Secret values
- Edit the eSignLive Service Connection in JM and:
- Enter the saved Client Id and Client Secret values into the Username and Password fields respectively
Version 1.1 Sep 05, 2019
- Fix JavaScript errors on ceremony page.
- Fix error handling for create package.
- Fix create package unit test.
Version 1.0 January 09, 2017
- Fluent SDK 5.1.0 update, documentation updates, resolved type-check error using groovy with closure
Installation Instructions
To install this package please walk through the following proceedure:
- Unzip the package to a directory on your computer
- Import each zip archive found in the services folder to Transact Manager under the Services >> All Services menu item.
- Review the Help Doc tab for each of the imported services and make any required adjustments to service parameters.
- Review the Service Connection requirements under the same Help Doc tab for each of the imported services and make any required configurations to the Service Connection. Service Connections can be configured in Transact Manager under the Services >> Service Connections menu item.
- Import each archive found in the libraries folder to Maestro. Importing these into the Organisation level libraries folder is recommended as this will make the components available to all projects, however they can be imported at the Project level if required.
- Also follow additional setup instructions in Release Notes
Release Notes
Maestro Assets
A datestamp for displaying the date a given signature field was signed
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Signature Field | Configuration | Signature field that this date stamp will be connected to | fieldRef | |
| Position | Position | How the signature block will be placed on the form
Options:
|
option |
RELATIVE
|
| Page Number (Absolute) | Position | The receipt page number to place the signature | integer | |
| Position X (Absolute) | Position | Absolute X position of the signature (pixels) | integer | |
| Position Y (Absolute) | Position | Absolute Y position of the signature (pixels) | integer | |
| Width | Position | The width of the signature block | integer |
100
|
| Height | Position | The height of the signature block | integer |
50
|
A widget for embedding the eSignLive signing ceremony into the form
Rule Templates
You may add your own logic to handle the following rule types triggered by this component:
- On Complete : A script to run when all signers have completed their signing
- On Failure : A script to run when the signing ceremony has failed and cannot be complete
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Height | Configuration | The height of the signing ceremony | integer |
300
|
| Progress Message | Configuration | Message to show while waiting on eSignLive response | text |
Please wait while we prepare your agreement
|
An eSignature widget for placing a eSignLive signature field on the receipt of the form
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Signature Type | Signature | Select the Signature type
Options:
|
option |
CAPTURE
|
| First Name Field | Signer Details | Form element that contains the signer's first name | fieldRef | |
| Last Name Field | Signer Details | Form element that contains the signer's last name | fieldRef | |
| Email Field | Signer Details | Form element that contains the signer's email address | fieldRef | |
| Mobile Field (Optional) | Signer Details | Form element that contains the signer's mobile number (optional) | fieldRef | |
| Auth Field (Optional) | Signer Details | Field Reference for signers authentication preference | fieldRef | |
| Position | Position | How the signature block will be placed on the form
Options:
|
option |
RELATIVE
|
| Page Number (Absolute) | Position | The receipt page number to place the signature | integer | |
| Position X (Absolute) | Position | Absolute X position of the signature (pixels) | integer | |
| Position Y (Absolute) | Position | Absolute Y position of the signature (pixels) | integer | |
| Width | Position | The width of the signature block | integer |
250
|
| Height | Position | The height of the signature block | integer |
50
|
Services
Service Connection
Service Parameters
| Name | Description | Required | Default |
|---|---|---|---|
| Access Code Email From | The email address access codes for secure signing sessions will appear from | No | |
| Access Code Email Subject | The email address access codes for secure signing sessions will appear from | Yes |
Your passcode for signing $formName
|
| Access Code Email Template | The email template for access codes sent for secure signing sessions | Yes |
|
| Document Service Name | The Fluent groovy service name for retrieving the document to sign. Leave blank to use the submission receipt | No |
Outputs
| Name | Description |
|---|---|
| executionStatus | The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ]. Successful execution will be denoted by a |
| errorMessage | When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error. |
Service Connection
Service Parameters
| Name | Description | Required | Default |
|---|---|---|---|
| Access Code Email From | The email address access codes for secure signing sessions will appear from | No | |
| Access Code Email Subject | The email address access codes for secure signing sessions will appear from | Yes |
Your passcode for signing $formName
|
| Access Code Email Template | The email template for access codes sent for secure signing sessions | Yes |
|
| Final Delivery Process | The name of the final delivery process to run after the Docusign delivery process | No |
Service Connection
Service Connection
Service Parameters
| Name | Description | Required | Default |
|---|---|---|---|
| responseContentType | The type of the returned content (Read-Only) | Yes |
text/html
|
| Page Template | The template of the callback page | Yes |
null
|
Service Connections
The following service connections are used by this package.
| Property Name | Description | Required |
|---|---|---|
| Type | HTTP Endpoint | Yes |
| Endpoint | Must point to the eSignLive API endpoint | Yes |
| Auth Key | Should contain your API key to access the service | Yes |