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 two the following custom fields to work: VERA Sync ID and  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 two new 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

   
   

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

   
   

5. 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  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 fieldfields
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 click Update
   1. Generally, this will be the project's bug screen and the issue screen
      Image Removed
      
5. In the Actions column > Configure > Edit Configuration
6. In the Choose Applicable Context section, select the applicable VERA project by CTRL + clicking to add it to the list and click Modifyeither 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.

      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

      Image Removed

      
      

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.

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