Support for Jira wiki markup

Jira stores rich text fields using a proprietary markup language (opens in new tab). In previous versions, Vera did not display the markup language in a rendered form, but instead displayed the raw text of the field. As of 2024.1, Vera now displays the rendered version of the field value.

Vera relies on the Rendered Fields expansion of the Jira Rest API, which converts the wiki data into HTML. Vera doesn't t do the actual conversion of the field data. The conversion may not appear exactly as it does in Jira, but the appearance is very similar. For more information on the Jira REST API, check out the Atlassian Developer documentation (opens in new tab).

The following limitations with the Jira REST API rendered fields expansion have been observed:

  • Panel icons are missing.

  • Emojis are displayed in text form but not converted to images.

All records routed with Vera 2024.1 and later will automatically import the rendered field data and no changes need to be made to the system.

Support for previously routed records

If you have a record that was routed in a previous version, the easiest way to display the rendered view of the field is to withdraw or revise the record and route it again. Once it has been rerouted, then any fields with the Jira markup language will be displayed in their rendered HTML view.

If you have a record that was routed in a previous version, but you cannot or will not re-route the record, you can still have the Tricentis Vera Web Portal convert the raw Jira markup to HTML “on the fly” by updating the Records Management policy. To convert a field in the Web Portal, follow these steps:

  1. Identify the field that is displaying Jira markup.

    Example: Description field is typically in the Jira markup format.

  2. Open the Records Management policy for that domain associated with the Jira project.

  3. Find the Record Type(s) and Field(s) that need to be updated:

    Copy 
    {
                    "Name": "Jira XRay Manual Test",
                    "Base Record Type": "Jira Issue",
                    ...
                    "Fields": [
                        {
                            "Name": "Description",
                            ...
                            "Format": "Jira Wiki",
                            ...
                        },
                       ...
                    ],
                    "Default Route Template": null,
                    "Allow Verify Signatures": true,
                    "Author": null
                },

  1. Update the Format value to “Jira Wiki”.

  2. Upload the new version of the Records Management policy.

    For more information, check out Policy management.

  3. View the record in the Web Portal.

The Jira markup text is now displayed in an HTML rendered format.

Note: This will not change the underlying data stored in the Vera database. The record will be stored in the old, wiki format until it is routed for approval again with Vera 2024.2 or later.

Jira wiki to HMTL limitations

The following limitations are currently present when decoding the Jira wiki to HTML:

  • Citations are not supported.

  • Markup items that are not supported by Jira wiki markup, but are supported by the Atlassian document format (opens in new tab) will not be converted – e.g. tables with merged cells.

  • Other limitations may exist, such as markup that starts or ends within a string.