Go2Group JaM Plugin€¦ · Your Productivity Force Multiplier Go2Group Go2Group, Inc. • 138...

Your Productivity Force Multiplier

Go2Group

Go2Group, Inc. • 138 North Hickory Avenue • Bel Air, MD 21014 • (877) 442-4669 www.Go2Group.com

Go2Group JaM Plugin Atlassian JIRA add-on for HP Quality Center

Installation and Usage Guide

Version 5.0 February 2009

2

www.Go2Group.com


Go2Group

Table of Contents

Section 1 – Go2Group JaM Plugin Requirements ....................................................................4

What’s Needed .......................................................................................................4 Where to Get Help ...................................................................................................5

Section 2 – Go2Group JaM Plugin Overview .........................................................................6

Use Cases ..............................................................................................................8 Use Case Example ....................................................................................................8

Section 3 – Go2Group JaM Plugin Installation .......................................................................9

Installation Assumptions ............................................................................................9 Go2Group JaM Plugin Installation................................................................................ 10

The Quality Center SOAP Service............................................................................. 10 Installing in Bundled Standalone Tomcat Application Server ......................................... 11 Installing in Existing Tomcat Application Server ........................................................ 14 Installing in Existing JBoss Application Server .......................................................... 16

The Quality Center Kit Plugin for JIRA....................................................................... 18 For Weblogic, WebSphere Server or Linux environment............................................... 18 For Microsoft Windows Environments..................................................................... 19

The Quality Center Sync Service.............................................................................. 22 The Quality Center Sync Listener............................................................................. 24 Quality Center SOAP Service Requires Repository Permission ........................................... 25

Section 4 – Go2Group JaM Plugin Configuration .................................................................. 26

mercury.properties file outline .................................................................................. 27 fieldlist in mercury.properties ................................................................................... 31

Replicating Comments ......................................................................................... 35 Replicating comments into different fields.............................................................. 35 Replicating comments in the comment field directly.................................................. 37

Attachment Replication........................................................................................ 39 Replication with HTML format (comments and descriptions) ............................................ 39

Mapping each project with its own rule ........................................................................ 40

Section 5 – Go2Group JaM Plugin Usage............................................................................ 41

Defect Replication Strategy ...................................................................................... 41 Using the Go2Group JaM Plugin .................................................................................. 43 Forcing replication from Quality Center to JIRA .............................................................. 48 Forcing replication from JIRA to Quality Center .............................................................. 48 Attachment Replication ........................................................................................... 49 Deleted Defects .................................................................................................... 50 Replicate All ........................................................................................................ 50

3

www.Go2Group.com


Go2Group

Section 6 - Go2Group JaM Plugin Tips and Troubleshooting .................................................... 51

General Suggestions ............................................................................................... 51 Updates and Upgrades............................................................................................. 51 Frequently Asked Questions ...................................................................................... 52

Section 7 – Go2Group JaM Plugin Additional Information ....................................................... 54

Technical Support .................................................................................................. 54 Sales Support........................................................................................................ 55 Learn More .......................................................................................................... 55

Appendix ................................................................................................................ 56

How to define bugfield and field ................................................................................ 56 Tomcat Windows Service – Additional Configuration ......................................................... 58 Transition ID – An Example........................................................................................ 58

4

www.Go2Group.com


Go2Group

Section 1 – Go2Group JaM Plugin Requirements

What’s Needed To install the Go2Group JaM Plugin, you will need the following:

• Atlassian JIRA Enterprise, v3.11 or later

• HP Quality Center v9.0 or later

• J2EE Application Server

• Tomcat 5.5 (Go2Group recommends Tomcat)

• JBoss 4.2.2

• JDK 1.5 or later

In addition to the technical requirements above, you will need administrator-level permissions for Atlassian JIRA, HP Quality Center, and the Application Server.

5

www.Go2Group.com


Go2Group

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:

• For the Americas and EMEA: +1 877 442 4669

• For Japan: +81 3 5326 3073

• For the rest of APAC and Australia: +886 2 2708 8473

• By email:

• [email protected]

• By ticket:

• support.Go2Group.com

A customer account is required to access the support site above. Please contact Go2Group for your login credentials.

For support with JIRA, please contact your Atlassian representative.

For support with Quality Center, please contact your HP representative.

6

www.Go2Group.com


Go2Group

Section 2 – Go2Group JaM Plugin Overview

The Go2Group JIRA add-on for HP Quality Center (JaM) Plugin allows developers in JIRA to display a list of available Quality Center (QC) test cases in a JIRA window. When viewing a JIRA issue, each associated test case will be displayed in the JIRA issue tab panel, allowing developers to quickly review associated test cases. (See image below)

From the QC side, the JaM service runs automatically - there is no direct user interaction needed. The JaM service tells QC which JIRA issues are associated with a test case, and displays this information in a custom field. (See image below)

7

www.Go2Group.com


Go2Group

The bi-directional nature of Go2Group's JaM Plugin provides several valuable points:

• Developers no longer need to periodically export the issue status from JIRA to update management

• Quickly finds test cases related to specific JIRA issues

• Quickly finds requirements related to specific JIRA issues

• Provides a free flow of information between developers and testers, including attachment synchronization between the two systems and teams (See images below)

8

www.Go2Group.com


Go2Group

Use Cases Actors - All members of the Test and Development Teams including:

• Test engineers using QC

• Developers using JIRA

• Code/peer review participants

Products Involved:

• Atlassian JIRA

• HP Quality Center

Questions Being Answered:

• Which developer is working on which defect?

• What state is a specific defect in?

• What comments are available?

• What attachments were available for validation?

• Who reviewed the changes?

Use Case Example

• Defect logged in QC

• Developer is assigned the issue in JIRA

• Developer performs work on issue

• Developer marks the issue as 'resolved' and transitions the issue to QC

• Tester resumes work on defect testing

9

www.Go2Group.com


Go2Group

Section 3 – Go2Group JaM Plugin Installation

The installation and configuration of the Go2Group JaM Plugin is fairly involved, as it involves installing services on two servers. Basically, you have two servers involved - the Quality Center server and the JIRA server, the JaM Plugin is installed on the JIRA server". If you are using QC on Linux, then you need to run the Quality Center SOAP service on a Windows machine.

The packaged installer can be run using the installer on Windows or install.sh on Linux. The installer will perform some of the installation steps for JIRA, the web service, or both. You can run the installer in both the JIRA server and the Quality Center server to do the appropriate parts of the installation on both servers.

The instructions below indicate which parts of the installation will be done by the installer, and which have to be performed manually.

Installation Assumptions The following installation steps assume has completed the following:

• A local copy of the Go2Group JaM Plugin installation file has been downloaded from the Go2Group website (www.Go2Group.com).

• A license key has been requested / received from Go2Group.

• The installer has the appropriate privileges to the JIRA and QC servers, along with the connected database(s).

• You have coordinated with the appropriate administrators to obtain support and recycle the servers.

10

www.Go2Group.com


Go2Group

Go2Group JaM Plugin Installation The installation process consists of four sections:

• The Quality Center SOAP Service

• The Quality Center Kit Plugin for JIRA

• The Quality Center Sync Service

• The Quality Center Sync Listener

Each of these sections is explained in detail below.

The Quality Center SOAP Service The SOAP service is a Java web service that is installed on a windows server and we strong recommend that install SOAP Service on our bundle Tomcat Server.

You must have the Quality Center API libraries on the Quality Center server; these are automatically installed by logging in to Quality Center from a web browser. Log in to Quality Center at least once from the Quality Center server, in order to download the necessary libraries.

We suggest you install our Quality Center SOAP Service on the Quality Center server. The Quality Center SOAP Services should not be installed on Quality Center’s JBoss Server.

If you have Quality Center in a Linux environment, our Quality Center SOAP Service can only be installed on a Windows machine, which then can log in to Quality Center from a web browser.

Specific instructions are provided below for Tomcat and JBoss

11

www.Go2Group.com


Go2Group

Installing in Bundled Standalone Tomcat Application Server

Run the file Mercury_SOAP_Service.exe found in the Go2Group JaM Plugin package.

Select the component Tomcat 5.5.26 Server and Mercury SOAP Service for Tomcat.

Specify the installation directory for Tomcat and port number (default 8080).

12

www.Go2Group.com


Go2Group

Start Tomcat by starting Go2Group Mercury SOAP Service in window service:

Verify that the web service is available by accessing the following URL in a web browser:

http://server:port/MercuryInterface/MercuryInterface?wsdl

For example (see image below):

http://localhost:8080/MercuryInterface/MercuryInterface?wsdl

Make sure to log in to Quality Center at least once from the Quality Center server, in order to download the necessary libraries.

Logging is controlled by the standard log4j properties file, log4j.properties, which is located under the web application's WEB-INF/classes directory.

13

www.Go2Group.com


Go2Group

14

www.Go2Group.com


Go2Group

Installing in Existing Tomcat Application Server If you have already a Tomcat Server, you can also install the Quality Center SOAP Service on the existing Tomcat Server.


Select the component Mercury SOAP Service for Tomcat.

Next, specify the location of Tomcat.

15

www.Go2Group.com


Go2Group

Start Tomcat by running the command:

<TOMCAT HOME>/bin/startup.bat

Tomcat will automatically expand and deploy the WAR file. The web service will then be available from the URL:

<TOMCAT ROOT>/MercuryInterface/MercuryInterface

Verify that the web service is available by accessing the following URL in a browser:

<TOMCAT ROOT>/MercuryInterface/MercuryInterface?wsdl

For example (see image below):

http://localhost:8080/MercuryInterface/MercuryInterface?wsdl



16

www.Go2Group.com


Go2Group

Installing in Existing JBoss Application Server If you have already a Tomcat Server, you can also install the Quality Center SOAP Service on an existing Tomcat Server.


Select the component Mercury SOAP Service for JBoss only.

Next, specify the location of JBoss.

17

www.Go2Group.com


Go2Group

Restart JBoss. JBoss will automatically expand and deploy the WAR file. The web service will then be available from the URL:

<JBOSS ROOT>/MercuryInterface/MercuryInterface

Verify that the web service is available by accessing the following URL in a browser (see image below):

<JBOSS ROOT>/MercuryInterface/MercuryInterface?wsdl



18

www.Go2Group.com


Go2Group

The Quality Center Kit Plugin for JIRA The following steps describe how to install the Quality Center Kit Plug-in on a JIRA server. For Weblogic, WebSphere Server or Linux environment Untar Mercury_Kit_JIRA_Plug-in_unix.tar.gz. There are three files under atlassian-jira folder.

atlassian-jira\WEB-INF\lib\ mercury_kit-*.jar

atlassian-jira\WEB-INF\classes\lasttime.txt

atlassian-jira\WEB-INF\classes\mercury.properties

Copy atlassian-jira/WEB-INF folder into your JIRA WEB-INF directory.

To verify whether the JaM Plugin successfully loaded, check JIRA’s Plugin repository (see image below).

Before continuing, ensure the Quality Center SOAP service is installed and configured on the Quality Center server (see previous section).

19

www.Go2Group.com


Go2Group

For Microsoft Windows Environments Install the plugin JAR file by running the Mercury_Kit_JIRA_Plug-in_windows.exe file. Specify the location of JIRA.

Next, configure the mercury.properties file through the configuration screen (see image, below-left). Note – if the mercury.properties file already exists, the configuration screen will not be displayed.

Once the fields are filled in using the table below, click the Next button.

This portion of the installation is finished.

For additional configuration, please set the appropriate values in the mercury.properties file, which by default is installed on the JIRA server at: WEB-INF/Classes or configure through the JaM configuration under System in the Administration. A description of these values can reference here.

Field Description

QC login user name This field defines the Quality Center user name used to authenticate with QC.

QC login password This field defines password used to authenticate with QC.

QC host This field defines the QC URL.

QC soapport This field defines the address of the SOAP service, as it is deployed in an application server on QC.

JaM License License key provided by Go2Group.

20

www.Go2Group.com


Go2Group

After the Quality Center Kit Plug-in has been installed on JIRA, please create the following custom fields (as needed).

1. Create the custom field called QcBugId of type Text Field. This field should not be visible on any screen; it merely holds the ID of the Quality Center defect that corresponds to the issue in JIRA. Make sure the QcBugId is applied to the project you want to replicate.

2. If you want to link test case with issues, create the custom field called TestCases of type MercuryField, and place it on the default screen. Make sure the TestCases is applied to project you want to replicate.

3. If you want to link requirement with issues, create the custom field called Requirements of type Requirement Field, and place it on the default screen. Make sure the Requirement is applied to project you want to replicate.

21

www.Go2Group.com


Go2Group

Test case information is displayed automatically on the issue tab panel in JIRA when the issue is displayed, and on the project tab panel in JIRA when browsing the project (see image, below).

Defect attachment information and linkedSteps are displayed automatically on the defect tab panel in JIRA (see image, below).

Requirements and attachment information is displayed automatically on the requirements tab panel in JIRA (see image, below).

22

www.Go2Group.com


Go2Group

The Quality Center Sync Service The service is included in the Mercury Kit jar file, so it simply needs to be configured. In Quality Center, add a Quality Center custom field to hold JIRA issues. The field should hold strings. The name is not important, since Quality Center uses an internal identifier for custom fields; but a descriptive name like ‘LinkedIssues’ is appropriate. This field name (e.g TS_USER_06) should be the same as field in the mercury.properties.

If you need to review the process of creating a custom field in Quality Center, please click here.

Create the JIRA user denoted by the syncuser property, and give the user permission to create and update issues in the JIRA projects affected by replication.

23

www.Go2Group.com


Go2Group

Use JIRA's Administration page to add the new service of class:

com.go2group.jira.services.MercuryService

Set the service to run at an appropriate interval, perhaps every five minutes.

24

www.Go2Group.com


Go2Group

The Quality Center Sync Listener The listener is included in the Quality Center Kit jar file, so you simply need to configure it. In Quality Center, add a Quality Center custom field to hold a corresponding JIRA issue key. The field should hold strings. The name is not important, since Quality Center uses an internal identifier for custom fields; but a descriptive name like JIRA ID is appropriate. This field name (e.g BG_USER_06) should be the same as bugfield in the mercury.properties.

If you need to review the process of creating a custom field in Quality Center, please click here.

Use JIRA's Administration page to add the new listener of class:

com.go2group.jira.listeners.MercuryListener

25

www.Go2Group.com


Go2Group

Quality Center SOAP Service Requires Repository Permission For attachments download, our Quality Center SOAP Service needs to access Quality Center’s repository. If your QC’s repository is on the local hard drive, then you can skip this permission check. If your QC’s repository is on a NAS or other network share system, you have to use the same account that is used to start Quality Center to startu our Quality Center SOAP Service. You can get QC’s repository information through Site Administration. In this example, your repository is on a NAS.

Start Quality Center SOAP Service with the same account as starting Quality Center, or login with that account and start up Quality Center SOAP Service by command.

26

www.Go2Group.com


Go2Group

Section 4 – Go2Group JaM Plugin Configuration

The following information is a summary for the mercury.properties file and configuration screen. The introduction of JaM 5.0 provides a GUI screen to configure the properties file. You can

access through Administration/System/JaM Configuration (see image, below-left) with Administration privilege. When you save the settings through the last step, it will affect JaM immediately so you don’t need to restart the JIRA Server.

27

www.Go2Group.com


Go2Group

mercury.properties file outline

Field Description Value

user This value defines the QC user name used to authenticate with QC. Please make sure this account can login into QC project and has authorization to create and modify defects.

User name

password This value defines the password used to authenticate the user with QC. Password

host This value defines the QC URL. server/TDBIN

field

This value defines the QC custom field of test case used to contain the list of linked issues. Please note that Quality Center maintains a field name for custom fields, besides the field label. This property should be the field name, which the Quality Center administrator can find. If you don’t know how to create this custom field in QC, you can read our appendix for reference.

TS_USER_06

bugfield

This value defines the Quality Center custom field of defect used to contain the JIRA ID that corresponds to a Quality Center defect. Please note that Quality Center maintains a field name for custom fields, besides the field label. This property should be the field name, which the Quality Center administrator can find. If you don’t know how to create this custom field in QC, you can read our appendix for reference.

BG_USER_00

bugproj

This value defines which JIRA projects should have their issues replicated to QC, and which QC projects the replicated defects will be created in. The value is a comma-delimited list of tuples. Each tuple contains three values, delimited by the “|” character. The first value is the key of the JIRA project. The second value is the domain of the corresponding QC project, and the final value is the name of the corresponding QC project.

jiraProj|mercuryDomain|mercuryProject

mercproj

This value defines which Quality Center pro jects should have their issues replicated to JIRA, and which JIRA projects the replicated defects will be created in. The value is a comma-delimited list of tuples. Each tuple contains three values, delimited by the “|” character. The first value is the key of the JIRA project. The second value is the domain of the corresponding QC project, and the final value is the name of the corresponding QC project.


testproj

This value defines which JIRA projects can link issues to test cases, and which Quality Center projects the test cases can come from. The value is a comma-delimited list of tuples. Each tuple contains three values, delimited by the “|” character. The first value is the key of the JIRA project. The second value is the domain of the corresponding QC project, and the final value is the name of the corresponding QC project.


28

www.Go2Group.com


Go2Group

lasttimefile

This value defines the location of the file that the synchronization service can use to store the last synchronization time. This file should preferably be located in a controlled directory, as the value stored in the file is critical to the proper operation of the defect replication.

<JIRA_HOME>/atlassian-jira/WEB-INF/classes/lasttime.txt (default)

syncuser

This value defines the JIRA user name used to create or update defects replicated from Quality Center. It is critical that this JIRA account not be used for any other purpose. It should have access to create and update issues in the JIRA projects affected by replication.

syncuser

soapport This value defines the address of the SOAP service, as it is deployed in an application server on the Quality Center server.

http://MyHost:8080/MercuryInterface/MercuryInterfaceService

license This value holds the Go2Group license key for the JaM Plugin. license key

db This value indicates what kind of database JIRA uses. You can set this to MYSQL, POSTGRES, or SQLSERVER. If you use SQL Server, you must also set the next property, dbschema.

database type

dbschema This value indicates the name of the JIRA database schema. This property is only required if you use SQL Server.

database schema name

fieldlist

This value defines which fields should be synchronized during defect replication. The value is a comma-delimited list of tuples. Each tuple contains three values, delimited by the “|” character. The first value is the key of the JIRA project. The second value is the domain of the corresponding QC project, and the final value is the name of the corresponding QC project.

jiraFieldName|mercuryFieldName|type

jiraField_map_jira

This value holds value mappings for one field. The name of the property is the name of the field in JIRA, followed by _map_jira. The property value is a comma-delimited list of mapping pairs. In each pair, the first item is a value in JIRA; the second item is the corresponding value for the field in Quality Center. If this entry exists for a field, it will be used to translate JIRA values into Quality Center values whenever data is sent from JIRA to Quality Center, and every possible JIRA value should be mapped to a Quality Center value.

jiraValue|mercuryValue

mercuryField_map_mercury

This value holds value mappings for one field. The name of the property is the name of the field in Quality Center, followed by _map_mercury. The property value is a comma-delimited list of mapping pairs. In each pair, the first item is a value in Quality Center; the second item is the corresponding value for the field in JIRA. If this entry exists for a field, it will be used to translate Quality Center values into JIRA values whenever data is sent from Quality Center to JIRA, and every possible Quality Center value should be mapped to a JIRA value.

mercuryValue|jiraValue

cacheTimeoutInSec Defect Test Case and Requirement information in issue tabs are cached in memory for performance. This value holds time out in seconds. Default will be one hour, if you don't specify this value.

29

www.Go2Group.com


Go2Group

port This value holds the port of the JIRA Server. If you leave this field empty, default 80 will be used. Since JaM 4.3 80

context

This value holds the URL context of JIRA. If you use apache proxy redirect to JIRA, you need to specify different context. Ex: http://xxx/jira to your JIRA server. Then you have to specify context=/jira here, otherwise leave this field empty. Since JaM 4.3

syncIssueType

You can specify what kind of issue in JIRA will be synced to Quality Center. You can also specify multiple types if you want. If you put syncIssueType=Task,Feature in the properties, the plugin will only sync Task and Feature to Quality Center. And defects created in QC will create Tasks in JIRA because of Task is the first one you specify in this field. If you leave this field empty, all kinds of issue will be synced with QC. Since JaM 4.3

JiraIssueType,JiraIssueType

transition

Basically JaM only replicates the data from Mercury to JIRA for you without executing the workflow action when status is changed. You can specify what transition (workflow action) you want to execute when status change because of QC. Please note that this has to be match with your workflow. EX: transition=Resolved|Closed|701,Resolved|Reopened|3 If you don’t know how to find the transition id, please reference here. If you configure any conditions or validators, please make sure the syncuser has the permission to execute the transition (workflow action). Since JaM 4.3

fromStatus|toStatus|transitioned

autoExecuteTransition

Basically JaM only replicates the data from Mercury to JIRA for you without executing the workflow action when status is changed. You can specify if workflow action need to be executed automatically when status change because of QC. Please note that

• syncuser must have the permission to execute the workflow action.

• Since you are allowed to change defects to any status in QC, you need to prevent making transition in QC which is not allowed in JIRA or you need to fixed manually in JIRA.

Since JaM 5.0

Y or empty

executeTransitionAsAssignee

All the transition (Workflow action) you specify in transition or autoExecuteTransition will be executed as Assignee. Please note that all the changes will also be recorded as assignee. If transition fail to execute, all the changes will still be recorded as syncuser. Since JaM 5.0

Y or empty

excludeDefectStatus

You can specify what kind of defect status in Quality Center you want to ignore, for example, you do not want QC defects with status “New” to be replicated in JIRA unless someone verifies it and change the status to “Open” EX: excludeDefectStatus=New Since JaM 5.0

defectStatus,defectStatus

30

www.Go2Group.com


Go2Group

excludeIssueStatus

You can specify what kind of status in JIRA you want to ignore, for example, you do not want issue with status “In Progress” to be replicated to QC. EX: excludeIssueStatus=In Progress Since JaM 5.0

defectStatus,defectStatus

commentDateFormat

You can specify what kind of date formats are used in comment field in Quality Center. You only need to specify this when you have different time formats then default. If you leave this field empty then default comment date formats “yyyy/MM/dd” and “MM/dd/yyyy” will be used. For example: commentDateFormat=yyyy/MM/dd,dd/MM/yyyy. Since JaM 5.0.

yyyy/MM/dd,yyyy/dd/MM,yyyy/MM/dd

testFolder

This value holds the folder of the test case in Quality Center. If you want to display test case under specific folder, you can use this field. Please note that the path separator is “\\” For example: testFolder= Subject\\Flight Reservation,Subject\\Flight Application Since JaM 5.0

Folder\\subFolder, Folder\\subFolder

reqproj

This value defines which JIRA projects can link issues to requirements, and which Quality Center projects the requirements can come from. The value is a comma-delimited list of tuples. Each tuple contains three values, delimited by the “|” character. The first value is the key of the JIRA project. The second value is the domain of the corresponding QC project, and the final value is the name of the corresponding QC project. Since JaM 5.0


filter

This value holds filter name in JIRA. You can define your own filter and only issue fulfills this filter will be replicated to QC. This feature can replace excludeDefectStatus, excludeIssueStatus and syncIssueType, but performance will a little bit slower than others. Since JaM 5.0

filterName

jirahost

This value holds the domain name or ip of the JIRA Server and will be used in attachment url in Mercury. If you leave this field empty, ip will be used instead of domain name. Since JaM 4.3.2

www.jira.company.com

31

www.Go2Group.com


Go2Group

fieldlist in mercury.properties There are several field types you can specify fieldlist in the mercury.properties file.

Field Type Description

string

number

date Will be translated using a standard date format.

version Single Version Picker, Version Picker custom fields in JIRA. Since JaM 5.0.

multi Used for Multi Select, Multi Checkboxes custom fields in JIRA. Since JaM 5.0.

cascade Used for Cascading Select custom field in Jira and replicate to a List field in QC. Since JaM 5.0.

comment Used for replicate comments. Since JaM 5.0.

html Used for replicate field and keep html format from Quality Center. You can use this type for Description and comment. Since JaM 5.0.

32

www.Go2Group.com


Go2Group

There are several JIRA issue fields you can specify fieldlist in the mercury.properties file.

JIRA Field Name Description Type

AffectedVersions Support multiple Components after JaM 5.0 string

Assignee If user names in JIRA and Quality Center do not match, be sure to provide a value map. string

Comments JIRA comments can be replicated to Quality Center. string comment html

Components Support multiple Components after JaM 5.0 string

CreateTime date

Description string html

DueDate date

Environment string

FixVersions Support multiple FixVersions after JaM 5.0 string

IssueType Most likely requires a value map string

Priority Most likely requires a value map string

Reporter If user names in JIRA and Quality Center do not match, be sure to provide a value map. string

Resolution Most likely requires a value map. string

SecurityLevel Most likely requires a value map. string

Status Most likely requires a value map. string

Summary string

UpdateDate date

33

www.Go2Group.com


Go2Group

There are several Quality Center defect fields you can specify fieldlist in the mercury.properties file.

Defect Name Description Type

AssignedTo(BG_RESPONSIBLE) If user names in JIRA and Quality Center do not match, be sure to provide a value map. string

DetectedBy(BG_DETECTED_BY) If user names in JIRA and Quality Center do not match, be sure to provide a value map. string

Priority(BG_PRIORITY) Most likely requires a value map. string

Status(BG_STATUS) Most likely requires a value map. string

Summary(BG_SUMMARY) string

BG_DESCRIPTION Description string html

BG_DEV_COMMENTS Environment or developer notes string html

BG_SEVERITY Most likely requires a value map. string

BG_DETECTION_DATE Creation date date

BG_DETECTION_VERSION Most likely requires a value map. string

BG_PLANNED_CLOSING\_VER Most likely requires a value map. string

BG_ESTIMATED_FIX_TIME number

BG_ACTUAL_FIX_TIME number

BG_CLOSING_DATE date

BG_CLOSING_VERSION Most likely requires a value map. string

34

www.Go2Group.com


Go2Group

Custom fields

You can also specify custom field to map between JIRA and Quality Center. Custom fields should be identified by their user-visible custom field names, prefixed by CF_; for example, if you have a custom field called Customers in JIRA, you should identify it in the property file as CF_Customers. For example:

CF_Customers|BG_USER_07|multi

Value Map

Fields with lists of available values will most likely need a value map definition in the property file, in order to allow the kit to translate values from one system to another. For example, consider translating priority in JIRA into severity inQuality Center; the property file may include entries that look like:

• fieldlist=Summary|Summary|string,Status|Status|string,Priority|BGfiSEVERITY|string

• Priority_map_jira=Blocker|5-Urgent,Critical|4-Very High,Major|3-High,Minor|2-Medium,Trivial|1-Low

• BG_SEVERITY_map_mercury=1-Low|Trivial,2-Medium|Minor,3-High|Major,4-Very High|Critical,5-Urgent|Blocker

Custom fields with spaces must be handled carefully. You will not need to escape the space when listing the field in the fieldlist, but you will have to escape the space with a backslash if you provide a value map for the field. For instance, consider a custom field called The Field. Example entries are given bellow; note the backslash (\) in the second entry.

• fieldlist=CF_The Field|BG_USER_09|string

• CF_The\ Field_map_jira=value1|value1,value2|value2

For fields that may have no value initially, like Resolution, you can use the placeholder value NULL. For example:

• Resolution_map_jira=NULL|Unresolved,Fixed|Resolved

• BG_USER_09_map_mercury=Unresolved|NULL,Resolved|Fixed

In this example, the resolution field in JIRA is mapped to a user field in Quality Center. If the JIRA resolution has no value, it will be set to Unresolved in Quality Center. A value of Unresolved in Quality Center will be ignored in JIRA.

35

www.Go2Group.com


Go2Group

Replicating Comments

Comments are handled very differently in JIRA and Quality Center. In JIRA, comments are stored as a log of individual entries. In Quality Center, comments are stored in one field as one block of text, with HTML markup used to format the field's appearance. And in Quality Center comments are only recorded in day format without hours and minutes. For this reason, comments cannot be synchronized like regular fields. We provide two different ways for you to replicate comments.

Replicating comments into different fields

Comments can be displayed in both systems. The Quality Center comment field, BG_DEV_COMMENTS, can be synchronized like a normal text field with any suitable JIRA field, such as Environment or a text custom field. With this approach, comments from Quality Center can be displayed in JIRA. (Updates made to this comment field in JIRA will be replicated to Quality Center)

JIRA comments can be sent to any suitable Quality Center field. All comments in a JIRA issue will be aggregated into one formatted block of text when stored in Quality Center. In other words, all JIRA comments for an issue will be stored in one field in Quality Center. Updates made to that field in Quality Center will be ignored during replication, and overwritten if more JIRA comments are sent over later.

After JaM 5.0, we provide replication with html format. To enable this feature, html support in Wiki Render Macros Plugin must be enables (see image below).

36

www.Go2Group.com


Go2Group

For example you want to map comments from Quality Center to a QC Comment custom field in JIRA. In addition, comments in JIRA to the BG_USER_11 field in Quality Center. The following is a setting to complete this comment synchronization:

CF_QC Comment|BG_DEV_COMMENTS|html,Comments|BG_USER_11|string

To enable html formatting, the enable html support in Wiki Render Macros Plugin must be enabled. Please reference here for more information.

An example screenshot for comments within JIRA from Quality Center is below:

Please note, if the comments are mapped such as:

Comments|BG_DEV_COMMENTS|string or Comments|BG_DEV_COMMENTS|html

The above mapping entry will cause JIRA comments to be aggregated and replicated to Quality Center's BG_DEV_COMMENTS field. Any updates made in Quality Center to the BG_DEV_COMMENTS field will be ignored and potentially overwritten as new JIRA comments are replicated.

37

www.Go2Group.com


Go2Group

Replicating comments in the comment field directly

The introduction of JaM 5.0 provides an additional path for comment replication. Comments between JIRA’s comment field and QC’s comments are directly synced while preserving HTML formatting in Quality Center.

Please review the following restrictions:

• First, in order to parse the correct comments in Quality Center, you need to keep the default comment format in Quality Center, such as the horizontal line、username and date format. If you change the format of the comment, then that comment won’t be replicated to JIRA.

• Second, since we need to parse the comment’s date. If you have different time format other than “yyyy/MM/dd”(2008/11/16) or “MM/dd/yyyy”(11/16/2008), you need to configure commentDateFormat in the mercury.properties.

• Third, deleting a comment in JIRA won’t trigger the comment to be deleted in Quality Center.

• Forth, if you update the comment that was replicated from JIRA to Quality Center, it won’t sync back to JIRA, and vice versa.

Item Precautions Note

Create comment in JIRA Comments will be replicated into QC.

Update comment in JIRA Comments will be replicated in QC. We don’t support comment updates being replicated to QC.

Delete comments in JIRA N/A We don’t support comment deletes. If you delete a comment in JIRA, please delete the comment in Quality Center manually.

Create comment in QC Comments will be replicated to JIRA.

Update comment in QC The previous comment in JIRA will be deleted and a new comment will be created in JIRA.

We don’t support comment updates being replicated to JIRA.

Remove comment in QC Comment will be deleted in JIRA.

38

www.Go2Group.com


Go2Group

You need to configure comments by comment type as below:

Comments|BG_DEV_COMMENTS|comment

Comments from Quality Center will be replicated into JIRA with a prefix of Quality Center before the user name (see image, below).

Comments from JIRA will be replicated into Quality Center with a prefix of JIRA before the user name (see image, below).

39

www.Go2Group.com


Go2Group

Attachment Replication

If you want to enable Attachment Replication, you have to specify the following in the fieldlist in the mercury.properties file:

Attachments|Attachments|string

Remember – if you install Quality Center SOAP Service on a separate Windows machine, downloading defect attachments from QC will take more time than when it is installed on QC’s box directly.

Replication with HTML format (comments and descriptions)

With the introduction of JaM 5.0, field replication can occur with HTML formatting. In order to take advantage of this feature, the Wiki Render Macros Plugin module must be enabled. To enable this module, follow the instructions below: First, enable html support in Wiki Render Macros Plugin (see image, below).

Second, you need to use Wiki Style Render for the field (like QC Comment custom, Description field). You can configure this by entering Field Configurations | Default Field Configuration | QC Comment in the Administration console (see image, below).

40

www.Go2Group.com


Go2Group

Mapping each project with its own rule With JaM 5.0 you are allowed to define multiple settings for replication. You only need to define multiple properties file with filename start with mercury and end up with properties. You can use the copy operation in our configuration.

For example, you can define another properties file called mercury_demo.properties for DEMO project. Please note that do not define duplicate mappings for the same project.

41

www.Go2Group.com


Go2Group

Section 5 – Go2Group JaM Plugin Usage

Defect Replication Strategy When performing defect replication, a strategy is required to avoid double replications. That is, unless precautions are taken, an issue replicated from Quality Center to JIRA may trigger a reverse replication from JIRA to Quality Center.

The following table lists the precautions taken to avoid this problem in the four replication scenarios.

Scenario Precautions Notes

New JIRA issue created

Will not be replicated to Quality Center if the project is not marked for replication; if the issue already has a Quality Center ID stored with it; or if the issue's creator is the special synchronization JIRA account.

JIRA issue ID is stored with the replicated Quality Center issue, and the JIRA issue is updated with the ID of the corresponding Quality Center defect.

JIRA issue updated Will not be replicated to Quality Center if the project is not marked for replication, or if the updating user is the special synchronization JIRA account.

JIRA issue deleted Deleting a defect in JIRA will cause the corresponding defect in Quality Center to be deleted.

New Quality Center issue created

Will not be replicated to JIRA if the project is not marked for replication, or if the issue already has a JIRA ID stored with it.

Replicated JIRA issue ID is stored with the original Quality Center issue, and the JIRA issue is updated with the ID of the original Quality Center defect. The synchronization user account is used to create the issue in JIRA.

Quality Center issue updated

Will always be replicated in JIRA, but the JIRA listener will ignore that update since it comes from the synchronization user account.

The synchronization user account is used to update the issue in JIRA.

Quality Center issue deleted

Deleting a defect directly in Quality Center will not affect the corresponding JIRA defect; currently we have no way to monitor defects deleted manually in Quality Center. Generally, deleting defects is a rare event. We recommend that defects be deleted, if required, in JIRA rather than Quality Center.

42

www.Go2Group.com


Go2Group

43

www.Go2Group.com


Go2Group

Using the Go2Group JaM Plugin

Using the Go2Group JaM Plugin is easy. When editing an issue, JIRA will display a list of available Quality Center test cases in the custom field called TestCases. Select one or more test cases to associate with the issue.

JIRA will display a list of available Quality Center requirements in the custom field called Requirements. Select one or more requirements to associate with the issue.

When viewing an issue, JIRA will display information about each associated test case and requirement in an issue tab panel, as shown below.

44

www.Go2Group.com


Go2Group

At the same time, the link between Test Plan and defect will be update automatically in Quality Center.

So does the link between Requirement and Defect in Quality Center.

45

www.Go2Group.com


Go2Group

When browsing a project, JIRA will display information about all of the test cases linked to any issue in the project, using a project tab panel. You can also filter out some issues by filter.

46

www.Go2Group.com


Go2Group

When browsing a project, JIRA will display information about all of the Requirements linked to any issue in the project, using a project tab panel. You can also filter out some issues by filter.

You can also search for issues that contain certain test cases or Requirements, as shown in the image below.

47

www.Go2Group.com


Go2Group

On the Quality Center side, the service runs automatically with no direct user interaction. The service tells Quality Center which JIRA issues are associated with a test case, and displays this information in a custom field, usually called LinkedIssues, as shown in the image below. This field should never be modified manually, since the service will overwrite it.

48

www.Go2Group.com


Go2Group

Forcing replication from Quality Center to JIRA Occasionally it may be necessary to force a replication event to happen. For example, if replication fails when a new JIRA issue is created, that issue would never again be automatically replicated.

In order to force the replication process to pick up Quality Center defects again, simply edit the value in the file indicated by the property lasttimefile in mercury.properties (see page mercury-properties). This value is a standard Java time value (in milliseconds since 1970). Setting it to a value in the past will force the replication process to handle Quality Center defects created or updated since that time.

Forcing replication from JIRA to Quality Center In order to force JIRA issues to immediately replicate to Quality Center, use the Replicate Now issue operation. This operation is available for issues that are eligible for replication, as specified in mercury.properties. Additionally, a user must have permission to edit the issue, or the operation will not be available.

The operation will immediately attempt to replicate the JIRA issue to Quality Center. If the issue has never been successfully replicated, it will be treated as a new issue, creating a new issue in Quality Center. If it has been replicated in the past, it will be synchronized with its corresponding Quality Center issue.

When the operation is complete, the issue page will reload. You may have no indication that the replication occurred, but you should see the updates in Quality Center.

49

www.Go2Group.com


Go2Group

Attachment Replication If you want to enable Attachment Replication, you have to specify Attachments|Attachments|string in the fieldlist in the mercury.properties file. To review the attachment, simply click the URL, as shown in the images below.

50

www.Go2Group.com


Go2Group

Deleted Defects Deleting a defect in JIRA will cause the corresponding defect in Quality Center to be deleted. However, deleting a defect directly in Quality Center will not affect the corresponding JIRA defect; currently we have no way to monitor defects deleted manually in Quality Center.

Generally, deleting defects is a rare event. We recommend that defects be deleted, if required, in JIRA rather than Quality Center.

Replicate All Instead of “replicate now”, you can replicate groups of issues by choosing filters. All the matching issues will be replicated into QC immediately. You can also use this function to migration all the JIRA issues into QC. The feature will only available for users who have Project administration permission.

51

www.Go2Group.com


Go2Group

Section 6 - Go2Group JaM Plugin 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 JaM Plugin, 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 at:

support.Go2Group.com

A customer login is required to access the support site above. Please contact Go2Group for your login credentials.

52

www.Go2Group.com


Go2Group

Frequently Asked Questions This section details some common problems when installing and running the integration kit. You can find more frequently asked questions at:

support.Go2Group.com

Q: There is no communication between JIRA and Quality Center, and the JIRA log complains about bad endpoint addresses for the SOAP service.

A: Check that the value of the soapport property is set correctly in the configuration file

Q: When trying to log in to Quality Center, an RPC error message appears and you are not able to log in.

A: Run the Mercury Check program (typically called CheckTD.exe). It may indicate the problem; a common problem is if the user account that runs the Quality Center services changes its password.

Q: Does the JaM Plugin support updates?

A: The JaM Plugin supports updates in most cases. The only two exceptional cases where JaM doesn't update properly are

1. When there is only one JIRA issue tied to a test case, and that test case link is removed, the linkedIssues custom field in Mercury won’t be updated. The current solution is for the user to manually delete the reference to the JIRA ticket in QC. We are currently exploring a method of solving this issue programmatically without impacting the performance between QC and JIRA.

2. The link between test case and defect or requirement and defect in JIRA will be updated when the corresponding issue in Mercury is modified. JaM use the modified time in Mercury to decide which issue should be replicated to JIRA and the modified time won’t be updated when you modify a link in Quality Center.

Q: I receive the message "com.go2group.mercury.MercuryInterface] ezjcom.JComException: Failed to Connect Project" in the mercury.log. What is happening?

A: Make sure the user account in mercury.properties(user=xxxx) can login into the specified Project, create and modify defects in QC. Don't forget to log in to Quality Center at least once from the Quality Center server, in order to download the necessary libraries.

53

www.Go2Group.com


Go2Group

Q: The JIRA and QC do not appear to be synchronizing.

A: All JIRA required must be either populated in QC or a default value must be provided in a value map. Otherwise the QC->JIRA synchronization might fail.

Q: How can I make all of JaM’s Log messages going into another file.

A: You can add the following lines in log4j.properties, please find someone who is familiar with log4j to help you. log4j.appender.R=org.apache.log4j.RollingFileAppender log4j.appender.R.File=c:/jira/log/JIRA-JAM-Plug-In.log log4j.appender.R.MaxFileSize=10MB log4j.appender.R.MaxBackupIndex=10 log4j.appender.R.layout=org.apache.log4j.PatternLayout log4j.appender.R.layout.ConversionPattern=%d %t %p [%c{4}] %m%n log4j.category.com.go2group = DEBUG, console, filelog, R log4j.additivity.com.go2group = false c:/jira/log/JIRA-JAM-Plug-In.log is where you want the log. please note the in the "log4j.category.com.go2group = DEBUG, console, filelog, R" , DEBUG is the bug level. This line maybe you already have it. Just add ",R" in the line. Restart JIRA. Try to see if you can see all the JaM's log into another log file.

Q: I try to configure a transition in the mercury.properties file, but it didn’t work when the status changed. Why?

A: Please make sure that if you configure any condition and validator in the workflow, syncuser has the right to execute the transition.

Q: Jira workflow violation. When an item is closed in QC, after synchronizing it is closed in Jira as well, but the workflow actions "resolve" and "Close Issue" are still possible. According to the JIRA adminstration interface the built-in workflow only allows "Reopen Issue" from status "Closed".

A: Basically JaM will replicate issue value between Mercury and JIRA without executing the workflow in JIRA. The reason is you can change issue to any status in Mercury but in JIRA you need to trigger workflow action and then you can change status. Prevent user from changing the wrong status and cause replication fail, we try to only update the value and not execute the workflow for the normal scenario. That's why you will see the wrong workflow action, because we only update the issue data for you.

When you define "tranisition=Resolved|Closed|701" or “autoExecuteTransition=Y” in the mercury.properties. For instance, you have an issue with status "Resolved" in JIRA. And QA want to close this issue in Mercury. So, QA change this issue to “Closed” status and then JaM tries to replicate this issue from Mercury to JIRA. First, it will only update the status value to Close in JIRA. Then it will execute the transition(701) which is "Close Issue" workflow action for you because the status is changed from "Resolved" to "Closed". Finally Reopen will be the only workflow action.

54

www.Go2Group.com


Go2Group

Section 7 – Go2Group JaM Plugin Additional Information

Technical Support Go2Group provides technical support for its entire line of products, including the Go2Group JaM Plugin. Go2Group technical support is available by telephone, email, and a Go2Group JaM Plugin specific customer support ticket system:

• By telephone: +1 877 442 4669

• By email: [email protected]

• By ticket: support.Go2Group.com


To help resolve your issue quickly, please provide the log from the Go2Group JaM Plugin, as follows;

• mercury.properties

• atlassian-jira.log (<JIRA_HOME>/atlassian-jira/WEB-INF/classe/mercury.properties). Please change log level by adding "log4j.category.com.go2group=DEBUG, console, filelog" and “log4j.additivity.com.go2group = false“ in log4j.properties. Restart JIRA and run some test cases. You can find log4j.properties in <JIRA_HOME>/atlassian-jira/WEB-INF/classe

• qc.log (<TOMCAT_HOME or JBOSS_HOME>/logs/qc.log).

55

www.Go2Group.com


Go2Group

Sales Support Go2Group provides sales support for its entire line of products, including the Go2Group JaM Plugin. Go2Group sales support is available by telephone, email, and a Go2Group JaM Plugin specific customer support ticket system:

• By telephone: +1 877 442 4669

• By email: [email protected]

• By ticket: support.Go2Group.com


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

For more information on Quality Center, please visit the HP website at:

www.HP.com

56

www.Go2Group.com


Go2Group

Appendix

How to define bugfield and field 1. Log in into Quality Center

2. Select Tools | Customize (right top corner)

57

www.Go2Group.com


Go2Group

3. Select Project Entities | Defect | User Fields. Then, create a new field. The Field Name (BG_USER_06 in this example) would be the bugfield in mercury.properties.

4. Create LinkedIssue. Within the Test project, select Test | User Fields. Then, create a new field for linkedIssues. The Field Name (TS_USER_05 in this example) would be the field in mercury.properties.

58

www.Go2Group.com


Go2Group

Tomcat Windows Service – Additional Configuration

If you want to configure Tomcat as an NT Service, you can reference Tomcat Web Site. In summary:

Installing Services

Install the service named 'Tomcat5'

C:<TOMCAT_HOME>/bin> service.bat install

Removing Services

C:<TOMCAT_HOME>/bin> tomcat5 //DS//Tomcat5

Transition ID – An Example

Go2Group JaM Plugin€¦ · Your Productivity Force Multiplier Go2Group Go2Group, Inc. • 138...

Documents

Transcript of Go2Group JaM Plugin€¦ · Your Productivity Force Multiplier Go2Group Go2Group, Inc. • 138...