Add VERA Custom Fields to Jira Projects

Owned by HB Farris
Jan 03, 2024
3 min read

This guide will show you how to create custom fields in Jira and how to add them to new or existing Jira projects. VERA requires the following custom fields to work: VERA Sync ID 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.

  1. Navigate to the Jira Administration Settings > Issues > Custom fields

  2. Click on the Add custom field button

  3. Create the following required custom fields: 



  4. Create the following optional custom fields as needed:

Field Type

Field Name

Renderer

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: Vera Read Only Custom Field

Signatures

Wiki Style Renderer

New to the Jira Server App in 2023.3! A custom read only field was added to the app and you can use this for the Signatures field to overcome the character limit in the built-in read only field. When you create the Signatures field, search for Vera in the Advanced field search.

Vera Custom Field in the New Custom Field Dialog

Signatures Field

If you use the built-in Text Field (Read Only) from Jira, the field has a limit of 255 characters. 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 Vera will write a link to the signatures in Vera instead. 

  1. 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.

  1. Navigate to the Jira Administration Settings > Issues > Custom fields

  2. Locate the VERA custom fields

  3. In the Actions column, select the Screens option

  4. Select the screens associated with the project that you want to enable the VERA custom fields on and click Update

    1. Generally, this will be the project's bug screen and the issue screen

  5. In the Actions column > Configure > Edit Configuration

  6. 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. 

    1. If using Apply to issues under selected projects, select the applicable VERA project and click Modify.



  7. 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.

Pre-Requisite

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.

  1. Navigate to the Jira Administration Settings > Issues > Field Configurations

  2. Locate the Field Configuration that the Signatures field will be a part of

  3. In the Actions column for the Field Configuration, select Configure

  4. Locate the Signatures field

  5. In the Actions column, select the Renderers option

  6. In the Active Renderer dropdown, select Wiki Style Renderer and then select Update

  7. If prompted again, select Update to confirm the change