In this section:
| Table of Contents | ||
|---|---|---|
|
Introduction
This artifact is shipped with the Parasoft Traceability Pack. It adds two widgets that show issues from the connected Jira system. Both widgets are pie charts that organize issues by status or by priority. One widget has settings for querying Jira. The other widget allows you to manually enter a JQL to find issues.
Requirements
- At least one project set up in a Jira.
| Note | ||
|---|---|---|
| ||
By default, the search API for Jira will return a maximum of up to 1000 issues. This is an intentional limitation set by Atlassian to avoid any possible OutOfMemory exceptions. See the following Jira documentation for information on changing this limit: |
Installation
This artifact is installed as part of the Parasoft Traceability Pack.
- Choose Extension Designer from the settings menu (gear icon).
- Click the Configuration tab to open Artifact Manager.
- Click Upload Artifact and browse for the traceability-pack-<version>.zip archive (also see Downloading and Installing Artifacts).
- Click Install and a collection of assets and configuration files for enabling traceability will be installed.
Deploying the Widgets
After installing the Traceability Pack, you can use Extension Designer to deploy the artifact to a service, which will add the widgets to your DTP environment. The following instructions also appear in the Downloading and Installing Artifacts section.
- Open Extension Designer and click on the Services tab.
- Choose an existing service to deploy the artifact or create a new service in the DTP Workflows category. Refer to Working with Services for additional information on organizing services and artifacts.
- If you are adding the artifact to an existing service, add a new Flow tab (see Working with Flows) and choose Import from the ellipses menu.
- Choose Local> Flows> Workflows> Traceability Pack> JIRA Issues Widget and click Import.
- Click anywhere in the open area to drop the artifact into the service.
- Double-click the Set JIRA URL node and specify the location of you Jira server.
Double-click the Get JIRA Projects node and click the edit button for the Jira REST API Configuration field.
Enter your Jira credentials and click Update. The user credentials must have access to all projects. Users will be able to add the widget to their dashboard and specify JQL, but the queries will fail without access to the project(s).
Info title Create a Dedicated JIRA User for Extension Designer If Jira detects that a user is making requests from multiple machines, it may lock the user out. We recommend creating a dedicated user for Extension Designer to avoid being locked out by Jira.
- Click Deploy.
Adding and Configuring the Widgets
Both widgets are added to a new Jira category when the artifact is deployed. See Adding Widgets for instructions on how to add widgets in DTP.
Configuring JIRA Issues - Pie Widget
You can configure the following settings
| Scroll Table Layout | ||
|---|---|---|
|
| Title | Enter a new title to replace the default title that appears on the dashboard. |
|---|---|
| JIRA Project | Choose a project from the drop-down menu. |
| Component | Choose a component of the project from the drop-down menu. |
| Issue Type | Choose an issue type from the drop-down menu. |
| Field | Choose Status or Priority from the drop-down menu. |
Configuring the JIRA Issues with JQL - Pie Widget
You can configure the following settings
| Scroll Table Layout | ||
|---|---|---|
|
| Title | Enter a new title to replace the default title that appears on the dashboard. |
|---|---|
| JQL | Specify your custom query. See the Jira documentation for instructions on creating JQL strings. |
| Field | Choose Status or Priority from the drop-down menu. |
Using the Widgets
You can add multiple instances of the widget to create several views of the data stored in Jira.
Click on the widget to view the issue in Jira.