eSign Custom Issue Fields | eSign Documentation and Support

The eSign app includes and automatically populates read-only issue fields in Jira. These can be used to enhance search and filter capabilities to locate Jira issues with signatures and display within search results. Enable these fields within Jira Issue Configuration - Custom Fields, and then add to appropriate screens.

These custom fields can also be included Jira filters, exports (to Microsoft Word and XML), and third party apps like Xporter.

For more search examples, see Advanced Issue Search

Custom Fields

Custom Field	Example	Description
Signature Count	3	Count of signatures on this issue
Signature Pending	2	Count of pending signatures (open invites) on this issue.
Signature Export	<see below>	Summary of all signatures with name, title, date/time and meaning. Compatible with Xporter and built in Jira Cloud Excel CSV Export.
Signed By	John Hancock, James Smith, Winston Churchill	List of signee names
Signed On	Jan 15, 2020 3:15 PM	Date/time of most recent signature
eSignPendingUsers (index)	`eSignPendingUsers = currentUser()`	JQL searchable index that can be added to Jira JQL search filters. This example returns issues where the current user is invited to sign. Note this field is not renderable by Jira and can not be added to the search display results.

Custom Field - Signature Export Example

1, John Hancock, Historical Figure, Jan 15 2020 3:15 PM, Author, Review, 
2, James Smith, Historical Figure, Jan 16 2020 11:35 AM, Approval, Review, 
3, Winston Churchill, Prime Minister, Jan 16 2020 11:36 AM, Approval, Final Review,

Note that date and time formats will vary based on the Jira user settings for the signees.

Atlassian Automation Integration

Extract eSign Custom Fields with Smart Values

You are able to use Jira Smart Values to retrieve data from the eSign custom (issue) fields. Any automation rule with an issue/work item in context can access values. This is also useful in rules triggered from eSign Webhook Events.

eSign Custom Field	Smart Value Syntax
Signature Count	{{issue.Signature Count}}
Signature Pending	{{issue.Signature Pending}}
Signature Export	{{issue.Signature Export}}
Signed By	{{issue.Signed By}}
Signed On	{{issue.Signed On}}
eSignPendingUsers	{{issue.eSignPendingUsers}}

Automation Rule with Smart Value Example

Automation rules can be set up as follows, resulting in a comment like this:

Extract Signature Metadata with Automation Smart Values

It is also possible to use Automation Smart Values to extract information from the signature metadata stored as issue entity property “esign.digitalrose.dev”.

This is a more advanced topic that will require some technical expertise to implement. Refer to https://support.atlassian.com/cloud-automation/docs/smart-values-in-jira-automation/ for a technical guide.

Download samples of the signature metadata (.json) from the Signatures Panel > […] > Signature Admin dialog on any issue with signatures.

Note that the signature metadata stored in the “esign.digitalrose.dev” issue property is internal application data. Fields may change without notice.

Signature Metadata - Automation Smart Value Examples
Extract All signature metadata. This may be useful for initial development and to confirm the issue has some signature data. `{{issue.properties."esign.digitalrose.dev"}}`
Iterate through executed signatures `{{#issue.properties."esign.digitalrose.dev".lines}} {{#if(not(voided))}} {{name}} signed for {{meaning}} on {{date}} {{/}} {{/}}`
Filter and display only a signature name, date and time matching “QA Approval” meaning `{{#issue.properties."esign.digitalrose.dev".lines}} {{#if(and(equals(meaning,"QA Approval"),not(voided)))}} {{name}} {{date}} {{time}} {{/}} {{/}}`

Signature Metadata - Automation Smart Value Examples

Extract All signature metadata. This may be useful for initial development and to confirm the issue has some signature data.

{{issue.properties."esign.digitalrose.dev"}}

Iterate through executed signatures

{{#issue.properties."esign.digitalrose.dev".lines}}
  {{#if(not(voided))}}
    {{name}} signed for {{meaning}} on {{date}}
  {{/}}
{{/}}

Filter and display only a signature name, date and time matching “QA Approval” meaning

{{#issue.properties."esign.digitalrose.dev".lines}}
  {{#if(and(equals(meaning,"QA Approval"),not(voided)))}}
    {{name}} {{date}} {{time}}
  {{/}}
{{/}}

External App Integrations

Exporting via Xporter

In general is is possible to include eSign custom fields in an Xporter templates. For example: ${Signature Export} or ${Signed By}.

For information on adding custom fields like “Signature Export” to X porter templates, see documentation here: Custom Field Mappings - Xporter Documentation