This guide will show you how to create custom fields in Jira Cloudand how to add them to new or existing Jira projects. VERA requires two the following custom fields to work: VERA Sync ID and Pending Tasks.
- Click on the Jira Settings option on the left hand side of the screen
...
and Pending Tasks. VERA also allows for the following custom fields: Revision Number, Revision and Signatures. Once the fields have been initially created, they still need to be added to each VERA integrated project. Skip to the Add VERA Custom Fields to Jira Projects section if you are enabling the VERA Approval Route after the initial VERA Jira integration with Tx3.
Step-by-Step Guide to Create VERA Custom Fields
The following steps only need to be completed once to create the VERA custom fields.
- Navigate to the Jira Administration Settings > Issues > Custom fields
- Click on the Add custom field button on the top right of the screen
- Click on the Advanced tab on the left and select the Text Field (read only) option and click Next
- Fill in the Name field with VERA Sync ID and click Create
Create the following required custom fields:
Field Type Field Name Renderer Advanced: Text Field (read only) VERA Sync ID Default Text Renderer Advanced: Text Field (read only) Pending Tasks Default Text Renderer Create the following optional custom fields as needed:
Field Type Field Name Renderer Advanced: Text Field (single line) Revision Default Text Renderer Advanced: Text Field (read only) Revision Number Default Text Renderer Advanced: Text Field (read only) Signatures Wiki Style Renderer Note title Signatures Field The VERA integration with Jira utilizes Jira Read-Only custom fields. VERA will attempt to write the entire approval route to the Jira Signatures field if the field is present in the Jira project. If the approval route contains over 255 characters the Approval will fail since VERA is attempting to write over 255 characters to the field. The Signatures field should be removed as a workaround.
- Follow the directions starting at step #4 in the below section to complete the custom field setup for the first VERA enabled Jira project
Step-by-Step Guide to Add VERA Custom Fields to Jira Projects
The following steps must be completed for each VERA custom field (VERA Sync ID, Pending Tasks, Revision Number, Revision Reason, Signatures) to enable the VERA Approval Route on the Jira project. These steps must be completed again with each VERA to Jira project integration.
- Navigate to the Jira Administration Settings > Issues > Custom fields
- Locate the VERA custom fields
- In the Actions column, select the Screens option
- Select the screens associated with the project that you want to enable the VERA custom fields on and click Update
- Generally, this will be the project's bug screen and the issue screen
- Generally, this will be the project's bug screen and the issue screen
- In the Actions column > Configure > Edit Configuration
- In the Choose Applicable Context section, select either Global Context if the field should be applied to all Jira issues or Apply to issues under selected projects if you'd like to specify which projects the field should be a part of.
If using Apply to issues under selected projects, select the applicable VERA project and click Modify.
Note Clicking on a new project in the Projects box will deselect the other previously selected projects. Be sure you CTRL + click to add new projects to the selection
- Click the pop up to Perform a Re-Index to apply the changes after these steps are completed for all VERA custom fields
Step-by-Step Guide to Update
...
Renderer for Signatures Field in Jira
The following steps must be completed for the Signatures field to enable Jira to display the signatures table in a readable format. These steps must be completed again with each VERA to Jira project integration.
Info | ||
---|---|---|
| ||
The following steps assume that the Signatures field has been added to the necessary Jira Projects. See the Step-by-Step Guide to Add VERA Custom Fields to Jira Projects section above for assistance in creating the field. |
- Navigate to the Jira Administration Settings > Issues > Field Configurations
- Locate the Field Configuration that the Signatures field will be a part of
- In the Actions column for the Field Configuration, select Configure
- Locate the Signatures field
- In the Actions column, select the Renderers option
- In the Active Renderer dropdown, select Wiki Style Renderer and then select Update
- If prompted again, select Update to confirm the change
Info |
---|
If you have multiple Field Configurations that need the Signatures field, repeat this process to add them to each needed Field Configuration. |