The SystemWeaver Jira integration is a plugin that offers a solid integration between your SystemWeaver database and your Jira tool making it easy to switch between the two applications with just one click. In this article, we'll describe how to use the SystemWeaver Jira extension view. It provides the following functionality:
- Viewing all Linked Jira Issues
- Redirect to Issue in Jira
- Viewing All Linked SystemWeaver Items in Jira
- Redirect to Item in SystemWeaver
- Working with Jira Issues in SystemWeaver
- Searching for an Issue
- Opening an Issue
- Creating an Issue
- Linking an Issue to SystemWeaver Items
- Removing Items from a Jira Issue
- Including Jira Issues List in a SystemWeaver Report
Loading the Jira View
The Jira extension view is configured by your SystemWeaver Architect to be used with a specific item type or types. To get started, select an item of the type for which the Jira extension has been configured. When you do this, the Jira menu option will become available on the Items ribbon. In the below example, an item of type "Function requirement" is selected so the option is available. If you select an item of a type for which the Jira extension is not configured, the menu option will be grayed out.
You can also access the view using the View drop-down under Extensions.
Not seeing the Jira menu option? First verify that you have the SWExtension.Jira2.dll extension file in your client installation. You can confirm this by navigating to Welcome>About and looking in the Extensions section. The file must be located there for the extension to be available:
If it is there and you still do not see the menu option, check with your system's Architect to ensure that it has been activated.
When you select the Jira option, the view will display. There are two tabs in the Jira view - Current Issues and Jira. These tab will be explained further down in this article.
The status of your login to Jira will always be clearly displayed at the bottom of the view to the right of the Login Settings button. In the above example, the user is not logged in to Jira. If the view is configured to allow access to multiple instances of Jira and you are logged in to multiple instances, these will be listed and separated by a comma:
Logging In to Jira
There are three options for logging in to Jira via the view - one-time login, save your password, and stay logged in. For all options, you will first select a Jira Server. The server options that users see in the Select Active Jira dialog are those that have been configured for use with the Jira plugin.
To log in without saving your login credentials, simply enter your Jira username and password and click Login. Your credentials will not be saved, therefore, you will need to enter them each time that you want to use the Jira view.
The Save password option will save your Jira password for future logins. To apply this setting, enter your Jira username and password, select Save password and then click Apply Setting. With this setting applied, your password will be pre-populated for you in the future and you will just need to click Login to log in to Jira and use the view.
Stay Logged In
The Stay logged in option will keep you logged in to Jira. To apply this setting, enter your Jira username and password, select Save password and Stay logged in and then click Apply Setting. Click Login. In this way, each time you want to use the Jira view, you will already be logged in to Jira via the view. The setting applies for your current and future SystemWeaver sessions.
Clearing Saved Login Credentials
To log out of Jira for the extension view, you will need to clear your Jira login credentials and login settings.
- Click Login Settings.
- Select the Jira instance from which you want to log out or clear the settings for.
- Remove your Jira username and password values.
- If you had also applied Save password or Stay logged in settings, clear Save password as well.
- Click Apply Setting.
If you clear your credentials during your session, you will be logged out of Jira. Although the Jira issues may still display during your current session, once you close the application, i.e., X out, the issues will no longer display until you log in again.
Note: If you attempt to access the Jira extension view via SystemWeaver and receive a "Forbidden" error, it may be that your login to Jira is not being accepted, e.g., due to too many unsuccessful login attempts.
To resolve the problem, navigate to your Jira login screen and complete a CAPTCHA login to verify your login.
Once you complete the CAPTCHA login successfully, you should have no troubles logging in via the view.
Viewing all Linked Jira Issues
When you load the Jira view for an item type for which it is configured, you will be taken directly to the Current Issues tab. This tab will provide a list of all Jira issues linked to the selected item for the Jira instances that you are currently logged in to. The following issue information is retrieved from Jira and displayed:
- Jira (The name of the Jira instance)
Current Issues for Selected Item
You can sort the issues by clicking on the column headers and can rearrange the columns. However, all sorting and column order changes apply only to your current session and are not saved.
In the above example, the user is logged in to two Jira instances - Jira1 and Jira2. And the selected requirement item "No drag" has Jira issues from both instances linked to it. Note that if the user was only logged in to Jira1, they would only see the issues from Jira1. The issues from Jira2 would be hidden from view.
Tip: If your organization has more than one instance of Jira configured for use with the extension, be sure you are logged in to all instances if you wish to make sure that you are seeing all of the linked issues.
Redirect to Issue in Jira
Viewing All Linked SystemWeaver Items in Jira
To view the linked SystemWeaver items for a particular issue in Jira, click on the SystemWeaver tab in the Activity section. A list of all linked items will display along with information such as name, and, e.g., version, status, etc. (With R33 or later, the type of item information provided is, to some degree, configurable by a system administrator.) In the below example, the "Low speed emergency braking" issue has four linked items in SystemWeaver.
Don't see a SystemWeaver tab? Contact your system administrator to confirm configuration.
Redirect to Item in SystemWeaver
Redirecting from an issue in Jira to a linked item in SystemWeaver is simple. There are two options depending on whether you wish to view the item in a specific context or not.
To simply open the linked item in a new tab in SystemWeaver, click on the hyperlinked Name on the SystemWeaver tab in Jira. You will be redirected to the item in SystemWeaver.
If you are already logged in to SystemWeaver and working in a structure and would like to view the item in the context of the structure, you can right-click on the Name hyperlink in Jira and copy the URL for the item to your clipboard.
Then, you can do Ctrl+G in the structure to find the item there.
Working with Jira Issues in SystemWeaver
The Jira extension view enables you to search for, open, create and link items to Jira issues directly from SystemWeaver. This is done from the Jira tab in the view. The information in the top section of the tab is retrieved directly from Jira. The Items section in the bottom half of the tab displays a list of the items that are currently linked to the issue Id displayed in the top half.
Tip: When you are working from this tab, it is helpful to treat it as if you are working directly in the Jira application. The focus of the tab is the Jira issue and not the SystemWeaver item. For example, although the user has the "Break for obstacle" requirement selected in the tree shown below, it is unrelated/not linked to the "ADLV3-127" issue that is in focus on the Jira tab. The "ADLV3-127" issue has only one item linked to it and it is not the selected item in the tree.
Whether you want to search for, open, create or link items to a Jira issue, you must first select a Jira instance in the Current Jira drop-down field. The operations are only conducted against one instance of Jira.
Searching for an Issue
To search for an issue in the selected Current Jira instance, enter a Jira Issue ID in the Select Jira Issue text box and click Select Issue. The issue information will load as shown in the above example.
Your search is across the entire Jira instance and is not restricted by which item you have selected in the tree.
Opening an Issue
After searching for an issue, you then have the option to open the issue in the Jira application. To do this, click Open Issue. Again, you must first have the issue "loaded" to the Jira tab like "AD-LV3" shown below. You will be redirected to the full record display of the issue in the Jira application.
Creating an Issue
The Jira extension view enables you to create Jira issues from directly within SystemWeaver. While searching and opening issues via the view is unrelated to which item you have selected in the tree, the Create Issue option will create an issue and link it to the selected item.
With release R33 and later, users may have a Floating option configured. Floating means that a Jira issue will be linked to the selected version of a SystemWeaver item and will also float forward to later versions. Depending on the Jira integration configuration being used, users may be able to choose to create a floating relationship or not in the provided UI for creating Jira issues via SystemWeaver. If floating is not available in your installation, the option will be grayed out.
- Select the item for which you want to create an issue.
- On the Jira tab, click Create Issue.
- In the pop-up dialog, enter an Issue Name. By default, it will pre-populate with the name of the selected item in the tree, but it can be modified.
- Choose a Jira Project and Issue type.
Note: Only projects configured for use with SystemWeaver will be available for selection if you are running version R33 or later. With earlier versions, if you have issues selecting a project, contact your system administrator.
- If the Floating option is available and you want the issue to also float forward and be linked to new versions of the selected item that may get created, check the Floating box to turn floating on for this issue.
- Click Create Issue. An Updating Jira issue progress bar indicates that your request is being processed. The newly created issue will load to the Jira tab.
Changing the Floating Option
You can change the Floating setting on a Jira issue at any time.
- Search for the Jira issue so that it is loaded to the Jira tab.
- Make your change to the Floating setting.
- Click Update Issue.
Linking an Issue to SystemWeaver Items
When creating a new Jira issue, you are simultaneously linking it to the selected item in the tree. The view also enables you to link an existing Jira issue to one or more items.
- Search for the Jira issue so that it is loaded to the view as ADLV3-146 in the above example.
- Next, select the SystemWeaver item that you want to link the issue to. When you do this, the item will appear in yellow in the Items section of the view. In the below example, ADLV3-146 is loaded to the view (it already has one item linked to it called "Brake for obstacle") and the "Emergency braking" item has been selected in the tree:
- Additional items can also be selected in the same way.
- When you are ready to perform the link of the items to the issue, click Update Issue to the far right. The items staged for linking are now linked to the issue in Jira. You will receive a confirmation that the issue was updated.
Removing Items from a Jira Issue
At any time, you can remove one or more items from an issue. To do this, right-click on the item(s) and select Remove from list, and then clicking Update Issue.
Multi-select is supported by clicking while holding down the Shift key (for selecting adjacent items) or Ctrl key (for selecting non-adjacent items).
Note: It is currently not possible to delete issues in Jira using the SystemWeaver extension view.
Including Jira Issues List in a SystemWeaver Report
With the use of an extension tag called <Extension name="JiraTag"/>, you can include a list of associated Jira issues in a SystemWeaver report. In order to do this, you must be logged in to Jira via the view. Below is a simple example report.
Example Report Definition
Example Report Result
Not seeing the Jira issues in your report?
Check to make sure you are logged in to Jira via the view.