Add Vera custom fields to Jira projects

Learn 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 the following custom fields: Revision Number, Revision, and Signatures. 

Once the fields are 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 Tricentis. 

Create Vera custom fields

To create Vera custom fields, follow these steps:

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

  2. Select Add custom field.

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


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

    Signatures

    Wiki Style Renderer

  5. To complete the custom field setup for the first Vera enabled Jira project, see Add Vera custom fields to Jira projects (starting from step 4).

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

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. 

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 Jira Administration Settings > Issues > Custom fields.

  2. Locate the Vera custom fields.

  3. In the Actions column, select Screens.

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

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

  5. In the Actions column, navigate to 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. 

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

    Note: Clicking on a new project in the Projects box will deselect the other previously selected projects. To add new projects to the selection, use CTRL + click.

  7. Click the pop up to Perform a Re-Index to apply the changes after these steps are completed for all Vera custom fields.

Configure Vera Sync ID fields for Vera enabled projects

To ensure Vera custom fields only appear in projects that are integrated with Vera, configure the field context to apply only to Vera enabled projects. This prevents the fields from appearing in projects that are not connected to Vera.

When you configure the field context, select Apply to issues under selected projects instead of Global context. This allows you to specify which projects should have access to the Vera custom fields.

In the Projects dropdown, select only the projects that are enabled for Vera integration.

For detailed information about configuring custom field contexts in Jira, check out Configuring custom field contexts (opens in new tab).

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.

Prerequisite

The following steps assume that the Signatures field has been added to the necessary Jira Projects. For assistance in creating the field, see Add Vera custom fields to Jira projects

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 is part of.

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

  4. Locate the Signatures field.

  5. In the Actions column, select Renderers.

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

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

Note: If you have multiple Field Configurations that need the Signatures field, repeat this process to add them to each needed Field Configuration.