ReqView Beta - Requirements Management for Jira

  Libor Buš news share

We are happy to announce the first beta of ReqView 2.13.0, introducing integration with Jira. Try our new document-based requirements management solution for Jira!

Manage Requirements for SW & HW Products in ReqView and Development in Jira

We have good news! You can connect ReqView and Atlassian Jira Cloud and benefit from an integrated application/product lifecycle management (ALM/PLM) solution.

Manage the development of your SW/HW product using the following workflow:

  1. Capture and manage requirements, risks, and tests in ReqView
  2. Export requirements from ReqView into a Jira Cloud project
  3. Trace requirements between ReqView and Jira issues in both directions
  4. Manage product development in Jira Cloud using an agile development process
  5. Synchronize back the implementation status from Jira issues into ReqView

How to Configure Integration With Jira

Enable ReqView integration with Jira to export requirements from one or more ReqView documents to a Jira Cloud project. The integration supports Jira Software Cloud service hosting Scrum or Kanban team-managed (next-gen) and company-managed (classic) projects.

ReqView Connector for Jira

We have created a new Atlassian Marketplace application ReqView Requirements Management Connector for Jira making integration between ReqView and Jira easier.

ReqView Requirements Management Connector for Jira

We recommend installing this application because it enables some features (such as tracing ReqView requirements from Jira issues) and improves the performance of requirements synchronization between ReqView and Jira. On the other hand, you do not need this application for testing the basic functionality of the integration.

To install this application:

  1. Log into your Jira Cloud instance (as an administrator).
  2. Click Apps and choose Find new apps in the top bar.
  3. Search for "reqview" in the Atlassian Marketplace and then click ReqView Requirements Management Connector for Jira result.
  4. Click Get app in the app details screen.

Configuration of Jira Integration in ReqView

Because the integration is disabled by default, click Edit, select Preferences, and tick Integrate with Jira to enable the integration.

To configure the integration for the current document, click File, select Jira and then Configure Synchronization:

Configuration of Jira Synchronization in ReqView

In the Configure Synchronization With Jira dialog, configure the Jira integration in JSON format using the following properties:

  • jiraSiteUrl — URL of your Jira site; open your Jira project in a web browser and copy the URL with the domain name only (e.g. https://MYCOMPANY.atlassian.net)
  • jiraProjectKey — key of your Jira project; open the list of all projects in Jira and copy the Key value of a selected project (e.g. MYPROJECT)
  • jiraIssueType — definition of how to set the type of exported Jira issues
    • reqviewAttribute — ReqView custom attribute used for mapping to Jira issue types (e.g. "type" corresponding to an enumeration attribute)
    • mapping — JSON object describing how Jira issue types are mapped to ReqView documents objects
      • key — Jira issue type (e.g. "Epic", "Story", or "Task")
      • value — the value of the ReqView custom attribute specified in reqviewAttribute property (e.g. "EPIC", "STORY", or "TASK")
  • jiraFields — optional JSON object describing how the integration sets Jira issue fields
    • key — Jira issue field, only "Description" is supported now
    • value — ReqView custom attribute or template column, (e.g. "text" to set the Jira issue field from the ReqView system attribute storing the requirements description)
  • reqviewAttributes — optional JSON object describing how the integration sets custom attributes from Jira issue fields
    • key — ReqView custom attribute (e.g. "jiraStatus" corresponding to a string attribute)
    • value — Jira issue field (e.g., "Status") or "$URL" for the URL link

Notes:

  • Jira allows only parent-child relationships between certain issue types (e.g., a Story can be created in an Epic; however, a Story cannot be created in a Task).
  • Jira issue fields and their values should be specified in English.
  • Jira issue type cannot be changed after export. We will try to enable the change of Jira issue type later.
  • Jira Subtasks cannot be exported.

Example: Configure the integration to export the NEEDS document in the Example Project:

{
"action": "export",
"jiraSiteUrl": "https://mycompany.atlassian.net",
"jiraProjectKey": "MYPROJECT",
"jiraIssueType": {
"mapping": {
"Epic": "EPIC",
"Story": "STORY"
},
"reqviewAttribute": "type"
}
}

The integration will export epics and user stories from the NEEDS document into Jira project MYPROJECT hosted at Jira Cloud site https://mycompany.atlassian.net.

It will set the type of Jira issues according to the value of ReqView enumeration attribute type as follows:

  • If type attribute equals to "EPIC" then the integration creates an Epic issue in Jira.
  • If type attribute equals to "STORY" then the integration creates a Story issue in Jira.
  • Else, the document object is not exported.

How to Set Up Jira Credentials

For security reasons, ReqView uses Jira API tokens to access Jira projects (not passwords). See Manage API tokens for your Atlassian account documentation page for more information on creating and managing Jira API tokens.

You can enter your Jira login email and API token in the Jira Credentials dialog during the first synchronization with the given Jira Cloud site:

Set Jira Credentials in ReqView

Tick Remember checkbox to save the Jira credentials into the secure application storage persistently. To erase saved Jira credentials any time, click File select Jira, and then Clear Credentials.

How to Export Requirements to Jira

To export the current document into Jira, click File, select Jira, and then Export Document. The integration iterates the document, creates Jira issues, and sets the following issue fields:

  • Type — issue type defined by jiraIssueType configuration property
  • Summary — stores heading and id attributes of the document object exported from ReqView
  • Description — stores text attribute in plain text format or a custom attribute or template column defined in jiraFields configuration property
  • Parent — the parent issue corresponding to the parent object in the exported ReqView document, e.g. it preserves Epic / Story parent-child relationship
Detail view of a Jira issue exported from ReqView

ReqView is the owner of these Jira issue fields for the exported requirements. Jira users should not change them in Jira because the integration will overwrite these fields with the following export from ReqView.

However, you can use other issue fields to plan requirements and manage the development in Jira, e.g., Status, Assignee, or Sprint.

You can repeat requirements export to Jira for each updated document version. The process will update Jira issues created earlier or create new issues for new requirements created since the last export.

Requirements deleted (or purged) in ReqView will be marked as deleted in Jira using "[Deleted]" prefix of issue summary. You can query such issues based on the prefix to remove them permanently from Jira or invalidate them using an issue field.

Example: Configure the integration to export the NEEDS document in the Example Project so that the Description field of the exported Jira issues is set to user story description computed by ReqView template column Story:

{
...
"jiraFields": {
"Description": "Story"
},
...
}

How to Display Jira Issue Fields in ReqView

In ReqView 2.13, we introduce a new concept of external custom attributes to enable non-persistent storage of information fetched from Jira (such as issue URL, status, assignee, sprint, etc.) or other tools. External attributes are set by the integration and are not saved to Project Files or Folders.

To define a custom attribute as external, set its external flag to true. You can also set the attribute readOnly flag to true to disable editing by the user.

Example: In the Document Attributes dialog, define new external read-only custom attributes jiraUrl and jiraStatus to fetch the URL link and status of exported Jira issues:

{
...
"jiraUrl": {
"external": true,
"name": "Jira URL",
"readOnly": true,
"type": "xhtml"
},
"jiraStatus": {
"external": true,
"name": "Jira Status",
"readOnly": true,
"type": "string"
},
...
}

Example: In the Configure Synchronization With Jira dialog, add reqviewAttributes property to store the URL link and status of exported Jira issues in ReqView jiraUrl and jiraStatus document attribute:

{
...
"reqviewAttributes": {
"jiraUrl": "$URL",
"jiraStatus": "Status"
}
...
}

To fetch values of external attributes for the current document, click File, select Jira and then Update Document Attributes.

How to Trace Requirements Between ReqView and Jira

If you enable the ReqView Connector for Jira, you will be able to trace requirements between ReqView and Jira in both directions by URL links.

Jira issues exported from ReqView contain a ReqView URL in a hidden property. To navigate from an exported Jira issue to the corresponding requirement in ReqView, click Open ReqView Connector in the Details right side pane and click Open <requirement ID> in ReqView. In the Choose application to open the reqview link dialog, select ReqView Beta application, optionally tick Always use this application to open reqview links, and finally click Open Link. For more information about ReqView URL links, see Share URL Links.

To navigate from a ReqView requirement to the corresponding Jira issue, define in the exported ReqView document a custom attribute jiraUrl of xhtml type as described in the previous section How to Display Jira Issue Fields in ReqView.

Try ReqView Integration With Jira

You can try the new exciting feature easily. We have configured the Example Project for exporting epics and users stories from the NEEDS document into your test project at Jira cloud.

  1. Download ReqView Beta 2.13.0-beta for Windows, Linux or Mac and install it.
  2. Download the Example Project project
  3. Open the project in ReqView Beta, open NEEDS document, open the Configure Synchronization With Jira dialog (File > Jira > Synchronization), and replace "MYCOMPANY" and "MYPROJECT" to match your test project at Jira cloud.
  4. Optionally enable the ReqView Connector for Jira at your Jira cloud site
  5. Export the requirements (File > Jira > Export Document)

Get a unique opportunity to be one of the first users trying ReqView Beta with Jira Integration. Let us know how we can adjust the feature to fit your use case. Just contact us!

  Give Us Feedback