Child pages
  • Installation Guide for Latest Version
Skip to end of metadata
Go to start of metadata

Go2Group synapseRT for JIRA 5 - Installation Guide for Latest Version
 

Go2Group synapseRT displays requirements based on projects and releases, providing a comprehensive view into your entire development environment. Go2Group synapseRT provides a dashboard within JIRA to track requirements against specific releases. In addition, synapseRT displays charts related to specific requirements due dates across projects.

This document applies to version 5.x.

Grab the PDF Here (3MB)

 

Go2Group synapseRT for JIRA 5 - Installation Guide for Latest Version

Overview

Go2Group synapseRT displays requirements based on projects and releases, providing a comprehensive view into your entire development environment. Go2Group synapseRT provides a dashboard within JIRA to track requirements against specific releases. In addition, synapseRT displays charts related to specific requirements due dates across projects.

By simply clicking on the Go2Group synapseRT link in the JIRA menu bar, the Go2Group synapseRT dashboard appears. From here, selecting a project and release from the dropdown menus, then clicking the Query button displays the requirements data in a dashboard.

Additional functionality includes drilling down on specific requirements / issues by clicking a requirement in the matrix. The information from that requirement / issue can be displayed by clicking on the defect link.

 

Architecture

Go2Group synapseRT leverages JIRA 5's architecture, including Google Gadgets and custom issue types, allowing all test management activity to be captured within JIRA.

 

Use Case

The Test and Development phases of the software development life cycle process are seen as key indicators to the success and efficiency of a product being available to the general public on time. Here's a usage scenario of how Go2Group synapseRT can add value to your workflow.

Questions Being Answered

  • What test case is associated with a requirement?
  • What defect is associated with a test case?
  • What is the requirement burndown chart?
  • How many defects are related to the requirement?
  • What's the relational matrix between requirements and test cases?

Use Case Example

  • Project manager defines a new version for project release.
  • Project manager/Quality Assurance (QA) creates requirements associated to the version and estimates the effort in time.
  • Project manager/QA creates test suites and test cases for each requirement.
  • QA team creates issues when the tests fail.
  • Project manager monitors the project in synapseRT dashboard using the traceability and planning tabs.

For more information, please review the Usage Guide.

 

Requirements

What's Needed

To successfully install and configure Go2Group synapseRT for JIRA 5, you will need to verify that you have satisfactory versions of several programs, and the appropriate permissions for installation and configuration.

Atlassian JIRA

  • The plugin is compatible with JIRA 5.0
    • Version 2.3 of the plugin is not compatible with JIRA version 3.x
    • Version 4.0 of the plugin is not compatible with JIRA version 4.x
    • For more information on Atlassian JIRA, please visit the Atlassian JIRA website at: www.Atlassian.com/JIRA

Java 6

Administrative permissions

  • You will need access to the JIRA server
  • You will need administrative access to JIRA

In addition, before you read this guide, you should be familiar with the following JIRA concepts:

  • Projects
  • Issues
  • Custom fields

Where to Get Help

Go2Group provides support for its entire line of products by telephone, email, and a product-specific customer support ticket system:

 

By telephone

877 442 4669

By email

support@Go2Group.com

By ticket

jira.Go2Group.com

 

The support site above is self-administered - feel free to create and manage your account. For additional support information, please review the synapseRT for JIRA 5 support page.

For support with JIRA, please contact your Atlassian representative.

 

What's New in This Version

Go2Group is excited to announce the availability of version 5.x of Go2Group synapseRT for JIRA 5! For a full list of updates, please visit the Go2Group synapseRT for JIRA 5 Updates page.

 

Installation

Installation Overview

This installation guide explains how to install the plugin using the provided installer. For details on manual installation, please contact us.

 

Installation Assumptions

Before you begin, please make sure that you have obtained:

  • Internet access during installation in order to download plugin installer within JIRA from Atlassian plugin Exchange. (Or you need a local copy of the Go2Group synapseRT for JIRA 5 installation file, available from the Go2Group download site)
  • A license key for Go2Group synapseRT. Evaluation license keys may be obtained by using the Go2Group Contact Form on the Go2Group website|http://www.go2group.com].
  • Appropriate privileges for JIRA.
  • Privileges to install software on the JIRA server and restart the application.

 

Installation Steps for plugin Installation with Atlassian Plugin Exchange.

  1. Go to the Jira Administration screen.
  2. Open the Plugins link in the Plugins section.
  3. Login page will appear. In order to have access to requested page you have to login as an Administrator with temporary access using Login form.
  4. Universal Plugin Manager (UPM) plugin page will appear. Click the Install tab of UPM.
  5. Put synapseRT in search field in order to find synapseRT plugin in the Atlassian Plugin Exchange. Press Search button.
  6. In search results will be Go2Group synapseRT card. Open details by mouse click.Press Try/Buy button in the frame that will appear to install synapseRT plugin from Atlassian Plugin Exchange.
  7. After installation is complete, an confirmation message will appear. It proposes to get evaluation/commercial license (new type license that differs from old type synapseRT licenses) for synapseRT in My Atlassian. If you do not have an license, you can get it rigth after plugin installation, just follow MyAtlassian steps. Of course you can get license later. In this example we decline this proposal in order to see another ways to get/input license.
  8. You will see synapseRT plugin in Manage My Plugins plugins tab. Here you can manually put synapseRT license (new type license) in the input field or open web-resources to get evaluation (Try button) or commercial (Buy button) license. Configure button will lead you to synapseRT Installation page. But we will open JIRA Administration screen to show synapseRT Installation (Configuration) link on that screen.

    If you have an old type synapseRT license, see Base Configuration section for more information.

  9. Here you can see synapseRT section with configuration links.
    Now you have to re-index your data. Corresponding message will appear on the page. Follow the Indexing link.
  10. Re-index Jira data.
  11. When re-indexing complete go to JIRA Administration screen. Open the synapseRT Configuration link.
  12. Installation Synapse page will open.

Installation Steps for plugin Installation with uploading file from a local machine.

  1. Open following URL in your Web Browser: http://doc.go2group.com/display/SRT4/01.+Download
  2. Download the Go2Group synapseRT Plugin page will open.

Open Download link and save plugin file on your local machine. In this example file was saved on local drive C: with name g2g-synapse-jira-4.4.jar so that path to file was C:\g2g-synapse-jira-4.4.jar

Upload file via UPM
  1. Go to the Jira Administration screen.
  2. Open the Plugins link in the Plugins section.
  3. Login page will appear. In order to have access to requested page you have to login as an Administrator with temporary access using Login form.
  4. Universal Plugin Manager (UPM) plugin page will appear. Click the Install tab of UPM.
  5. Open the Upload Plugin link.
  6. In the Upload Plugin Dialog window browse path to your plugin file on local machine.
  7. Press Upload button.
  8. You will see synapseRT plugin in Manage My Plugins plugins tab after Installation is complete. Here you can put synapseRT license in the input field or open web-resources to get evaluation (Try button) or commercial (Buy button) license. Configure button will lead you to synapseRT Installation page. But we will open JIRA Administration screen to show synapseRT Installation (Configuration) link on that screen.

    If you have an old type synapseRT license, see Base Configuration section for more information.

  9. Here you can see synapseRT section with configuration links.
    Now you have to re-index your data. Corresponding message will appear on the page. Follow the Indexing link.
  10. Re-index Jira data.
  11. When re-indexing complete go to JIRA Administration screen. Open the synapseRT Configuration link.
  12. Installation Synapse page will open.
Upload file manually
  1. Place plugin *.jar file into JIRA_Application_folder\plugins\installed-plugins directory.
  2. Restart JIRA.
  3. Go to the Jira Administration screen.
  4. Open the synapseRT Configuration link.
  5. Installation Synapse page will open.

 

 

Configuration

Overview

The configuration of Go2Group synapseRT is straight-forward:

  • Add license key
  • Create custom fields
  • Create custom issue types
  • Create links

The following steps provide details for configuration Go2Group synapseRT.

 

Before continuing, please ensure you have administrator rights to JIRA!

 

Base configuration

The Go2Group synapseRT plugin configuration is fully automatic. It includes needed issue types creation, enabling required JIRA functions if they are not active.

On synapseRT installation page synapseRT Configuration panel is default and you have to specify next parameters: Custom Field names, issue types assigned to synapseRT.

  1. You can create/delete the synapseRT Test project using checkboxes in the first section.
  2. You have to specify Custom Fields names provided by synapseRT in the second section of the page.
  3. Next, you have to configure issue types used by synapseRT. You can read more about these issue types in usage documentation.
  4. In Go2Group synapseRT plugin testing scenario all issue types may be requirements or defects. You should configure this function. The issue types assigned as synapseRT Requirement are in the left list, the issue types assigned as synapseRT Bug are in the right list. Unassigned issue types are in the middle list. You can move issue types using arrow buttons. The page does not let to make one list empty when you save changes, there will be always at least one issue type.
  5. Save settings.
License

From v4.4 synapseRT uses new type licenses, which can be obtained by MyAtlassian. Configuration page contains the link to the page with license input form.

On the page you can put synapseRT license in the input field or open web-resources to get evaluation (Try button) or commercial (Buy button) license.

If you have an old license, you can put it on the configuration page using an input field.

Statuses

1. Follow the Workflows link on the Administration screen.

2. Login page will appear. In order to have access to the requested page you have to login as an Administrator with temporary access using Login form.

3. You will see three new automatically created workflows on the opened page. Automatic workflows will be active.

4. Open the Design link of the Test Case Automatic workflow.

5. You will see the Design diagram. Three new statuses were created automatically.

If you have not Adobe Flash installed, a message will be displayed. Install Adobe Flash and reload page.

 

Custom Fields

1. Open the Custom Fields link on the Administration screen.

2. You will see the Custom Fields page. Seven custom fields were created automatically.

3. Follow the Projects link on the Administration screen.

4. You will see that one new project was created automatically by synapseRT.

5. Follow the Projects categories link on the Administration screen.

6. You will see that one new project category was created automatically by synapseRT.

Feel free to review the Usage Guide to better understand how to manage test cases, requirements, and test suites within JIRA using Go2Group synapseRT.

 

Test Suites Management

Open the synapseRT Test Suites Management link in Administration to access the Test Suites Management panel.

Test Suites Management panel allows you to operate with Test Suites and to see the lists of issues which are linked to the Test Suites. The panel allows you to operate with Test Suites:

1. You can add a new Test Suite using the form which includes Jira Container field and Test Suite Name field.

2. The Jira Container specifies which type of the Test Suite will be created. It can be Global, Category, Project.
Global Test Suite will be available to be linked to an issue in all Jira Projects. This is default option in Jira Container option list.

So Category Test Suite will be available in those Jira Projrects which are assigned to the Project Category.

One more Jira Container is Project Container. It allows you to make a Test Suite available only in the choosen Project. You can find more information about Project Category and Poject Jira Containers below in this section.

3. The table of existing Test Suites and their Test Cases. This table displays only the Test Suites of current Jira Container. The table includes the list of Test Cases which are linked to a Test Suite. Actions section displays three links and allows you to operate with existing Test Suites. You can find more information about Actions below in this section of the Installation Guide.

The synapseRT Test Suites Management page for Category Jira Container shown below. There is the Jira Category option list in which you should specify the Project Category which defines projects for a Test Suite.

The synapseR Test Suites Management page for Project Jira Container shown below. There is the Jira Project option list in which you should specify the Project for a Test Suite.

Actions

Edit Action displays Test Suite name change menu. Specify new Test Suite name in the field and press Update to rename the Test Suite.

Delete Action allows to delete the Test Suite.

More Action link displays following Actions: Merge Test Suite, Split Test Suite and Copy Test Suite.

Merge Action allows to merge the Test Suite to more inclusive Jira Container.

Split Action allows to split the Test Suite to less inclusive Jira Container.

Copy Action allows to copy the Test Suite to another Project.

You can find more information about Test Suites in our Usage Guide in the Test Suites section .

 

Dashboard

By default Go2Group synapseRT dasboard is available for project administrators. You can add the other groups that will have access to synapseRT dashboard.
Go to the Administration section and follow the link Dashboard configuration from synapseRT section, as on the image below


On this configuration screen we can configure plugin interface settings.

1. This parameter defines the maximal number of requirements for requirement tree level in Traceability matrix.

2. In this field you can specify which number of test cases will be displayed in the Traceability table.

3. and 4. define the  number of issues which will be displayed in the Release Planning Dashboard.

5. This parameter represent the number of issues which will be available on the minipages of custom fields. Image below show Requirement custom field for parameter value 1.

6. Here you can configure the number of issues on a tree level for requirement tree and the number of test cases that will be shown in issue tabs.

7.This field controls the number Test Plans to display on Test Plan project tab.

8. Check this option to enable synapseRT Fisheye integration. You can find more information about the configuration of Fisheye integration in the Fisheye section .

9. Mark this option if you want to enable extended mode for Test Case inrofmation blocks in the Test Suites Project tab (see corresponding Usage Guide for more information).

10. This option holds the list of Test Plans linked to a Test Case on Test Case State field so that the list will be always expanded (see corresponding Usage Guide section for more information).

11. If this option is checked then synapseRT will remove the test case Status information from all panels and tabs.

12. Enable this option to use Subtests in place of Test Cases in Test Plan management. This option also affects to the visibility of Create Bug option in More actions menu: the enabled feature hides the option from the menu of Test Cases.

13. This option enables the simple design of issue items on synapseRT tabs, panels and custom fields, see images below:


The users from the groups in the right listbox have access to SYNAPSE dashboard. You can select groups in the left listbox and grant them permission to access synapseRT dashboard by pressing the button at the bottom of the listbox. To revoke granted permission select groups at the right listbox and press the button at the bottom of the listbox.

Test Case State Automation

This section describes how to automate Test Case State change.

You will find more information about Test Case State visiting the Test Case State section of the Usage documentation.

To link Test Case State change to your existing workflow you should do the following:

1. Create draft workflow from your existing workflow

You can either create new transactions or modify existing. To create new transaction

2a. Follow add transition link at 'Operations' column opposite to step name you want to start with

2b. Put the name, description and destination step for that transition. Then press 'Add' button

2c. New transition was created

3. Select a transition you want to modify

4. Select Post Functions tab

5. Follow 'Add a new post function ...' link. You will see postfunction selection screen

6. Select 'Change synapseRT Test Case State field from custom list' option and press add button. You will see postfunction configuration screen

7. Select Test Case State you want to enter during that transition and press 'Add' button

8. You will see selected postfunction in the list

This postfunction is not orderable and unic

9. You can select Test Case Results screen that was created during synapseRT setup. To do that follow Edit this transition link

10. Select Synapse Test Case Results screen for transition view and press update button

9 and 10 are optional. Repeat 2-10 if needed for all transitions you want to modify

11. Publish the workflow: follow 'Publish' link on the panel then save a backup copy (or not) and press Update button

Your workflow was configured to workk with Test Case State

To use that feature just use workflow transition you've been edited. Test Case State will update automatically, and Test Case Result will track the changes and put additional information if you selected the custom screen for a transition.

 

Test plan workflow

This section belongs to the Test Plan section of the Usage manual.
If you upgrade synapseRT from previous version, synapseRT will create Test Plan workflow and you have to assign this workflow to your workflow schemes.
To do this follow steps below.
1. Open Jira Administration section and follow the Workflows link. You will see that synapseRT Test Plan Workflow was created but now is inactive. Then open the Workflow Schemes link.

2. You will see existing workflow schemes. If the scheme which you want to change is active then you should disassociate projects from the scheme. In this example SYNAPSETEST Project associated to synapseRT Automatic Workflow Scheme.
In this example we make the copy of active Workflow scheme, then associate Test Plan Workflow to new Scheme. Then we will associate the project from old scheme to new scheme.
So copy Workflow Scheme.

3. Open the Workflows link.

4. Open the Assign a workflow link.

5. Assign Test Plan workflow to the scheme.

6. Now workflow assigned to the scheme. Come back to workflow schemes.

7. We will edit our scheme name to new. Then we will open associated project.

8. On the Project page open the More link in the Workflows section.

9. Open the Actions menu and choose the Use a different scheme option.

10. Choose new workflow scheme and press the Associate button.

11. Associate statuses from the old scheme to the new one.

12. After process is complete your workflow scheme with synapseRT Test Plan is active.

FishEye integration

From Go2Group synapseRT v4.1 integration with Fisheye is available. You can map your Jira projects to Fisheye repositories during synapseRT configuration.

What's Needed

To successfully configure Go2Group synapseRT integration with Fisheye, you will need to verify that your Jira instance and FishEye + Crucible installation configured and connected together according to the Atlassian Guide .

Configuration

First that we have to do it is to enable Fisheye integration. Open synapseRT Dashboard configuration and mark corresponding checkbox, press Set button.

After reloading page Fisheye connection options will become available. Here we have to put the link to Fisheye instance and Fisheye user account parameters.

Specify the values of these fields and press Set button.

After reloading page we can map Fisheye repositories to Jira projects. Use repository name in Fisheye system on this step.

Now we have Go2Group synapseRT integration with Fisheye configured. See the Fisheye section of Usage Guide for more information.

Uninstallation

Manual Plugin Uninstallation.

If synapseRT was installed manually, you can also use manual uninstallation method.
1. Stop JIRA.
2. Delete plugin *.jar file from JIRA_Application_folder\plugins\installed-plugins directory.

3. Start JIRA.
4. Go to JIRA System Dashboard. The login form will be on the page. Log in to JIRA.

5. Follow the Administration link in the top menu.

6. Open the Plugins link on the Administration screen.

7. Login page will appear. In order to have access to requested page you have to login as an Administrator with temporary access using Login form.

8. UPM without synapseRT plugin will open.

Plugin uninstallation with Universal Plugin Manager.

1. Open the Plugins link on the Administration screen.

2. Login page will appear. In order to have access to requested page you have to login as an Administrator with temporary access using Login form.

3. Universal Plugin Manager (UPM) plugin page will appear. SynapseRT plugin will be in the User-installed Plugins list.

6. Open details by mouse click on the plugin frame to open details. Press Uninstall button.

7. A confirmage message will appear. You have to confirm plugin uninstallation.

8. Uninstallation progress message will appear.

9. After uninstallation process synapseRT uninstalled from Jira.

Tips and Troubleshooting

General Suggestions

Go2Group provides technical support for its entire line of products. If you run into any issues when installing or configuring the Go2Group Perforce Plugin for JIRA, please contact us.

 

Updates and Upgrades

Go2Group provides regular updates to its products. These updates include performance enhancements and minor bug fixes.

To review previous, current, and upcoming updates and upgrades, please visit the Go2Group support site.

 

Frequently Asked Questions

Go2Group provides an updated list of frequently asked questions.

 

Additional Information

Technical Support

Go2Group provides technical support for its entire line of products.

Go2Group technical support is available by telephone, email, and a specific customer support ticket system for the Perforce Plugin for JIRA:

  • By telephone: +1 877 442 4669
  • By email: support@Go2Group.com
  • By ticket: jira.go2group.com
    • The support site above is self-administered - feel free to create and manage your account. For additional support information, please review our Perforce Plugin for JIRA support page.

 

Sales Support

Go2Group provides sales support for its entire line of products, including the Go2Group Perforce Plugin for JIRA.

Go2Group sales support is available by telephone and email:

 

Learn More

For more information on Go2Group, its products, and its services, please visit our website at www.Go2Group.com.

For more information on JIRA, please visit the Atlassian website at www.Atlassian.com.

 

 

 

JICVAQ


 

  • No labels