| Table of Contents |
|---|
Workflows
It is possible to integrate eSign with Jira workflows through advanced workflow configuration.
Required Signatures Validator
The eSign addon includes a custom workflow Validator that can be leveraged to control workflow. It can be used to require a certain number of signatures in the current status (or total) before a transition to the next status is allowed.
Add the eSign: Signatures Required validator in the desired transition using the Jira workflow editor:
...
Select the minimum number of signatures required and indicate if current status or any status. Also indicate if the condition should block issues with Pending Signatures.
...
Reset Signatures Post Function
There is an optional post function that can be enabled in Jira to automatically clear signatures from an issue. This could be used to reset/restart signatures based on a specific workflow transition. To enable this, add the eSign: Reset Signatures post function to the appropriate transition(s) in the workflow.
...
Prevent Signature Changes on Closed Issues,
To sign an issue, the user must have view access to the issue and the issue must be editable (unless the Advanced Security option is enabled). When an issue is closed, it is possible to prevent new signatures by setting the issue to be read-only through workflow status property jira.issue.editable=false.
See this link for more information: https://confluence.atlassian.com/jirakb/issues-are-editable-in-closed-state-218268664.html
Addon Issue Fields
The eSign addon The eSign app includes and automatically populates read-only issue fields Signature Count, Signature Export, Signed By and Signed Onin 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.
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 |
John Hancock, Historical Figure, Jan 15, 2020 3:15 PM, Approval
James Smith, Historical Figure, Jan 16, 2020 11:35 AM, Approval
Winston Churchill, Prime Minister, Jan 16, 2020 11:36 AM, Approval
<see below> | Summary of all signatures with name, title, date/time and meaning. |
eSign will omit titles and truncate if necessary to fit within a Jira limit of 256 characters for this field type. | ||
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 |
| JQL searchable index that can return issues where the current user is invited to sign. |
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.
External Integrations
Exporting via XPorter
For information on adding custom fields like “Signature Export” to Xporter templates, see documentation here: https://confluence.xpand-it.com/display/public/XPORTER/Mappings#Mappings-CustomFieldMappings
...