HP Quality Center Synchronizer
Software Version: 1.20
User’s Guide
Document Release Date: June 2008
Software Release Date: June 2008
Documentation Updates
This guide’s title page contains the following identifying information:
•
•
•
Software Version number, which indicates the software version.
Document Release Date, which changes each time the document is updated.
Software Release Date, which indicates the release date of this version of the software.
To check for recent updates, or to verify that you are using the most recent edition of a
document, go to:
http://h20230.www2.hp.com/selfsolve/manuals
This site requires that you register for an HP Passport and sign-in. To register for an HP
Passport ID, go to:
http://h20229.www2.hp.com/passport-registration.html
Or click the New users - please register link on the HP Passport login page.
You will also receive updated or new editions if you subscribe to the appropriate product
support service. Contact your HP sales representative for details.
3
Support
You can visit the HP Software Support web site at:
http://www.hp.com/go/hpsoftwaresupport
This web site provides contact information and details about the products, services, and
support that HP Software offers.
HP Software Support Online provides customer self-solve capabilities. It provides a fast and
efficient way to access interactive technical support tools needed to manage your business.
As a valued support customer, you can benefit by using the HP Software Support web site to:
•
•
•
•
•
•
•
•
Search for knowledge documents of interest
Submit and track support cases and enhancement requests
Download software patches
Manage support contracts
Look up HP support contacts
Review information about available services
Enter into discussions with other software customers
Research and register for software training
Most of the support areas require that you register as an HP Passport user and sign in.
Many also require a support contract.
To find more information about access levels, go to:
http://h20230.www2.hp.com/new_access_levels.jsp
To register for an HP Passport ID, go to:
http://h20229.www2.hp.com/passport-registration.html
4
Using This Guide...................................................................................7
System Configurations ........................................................................12
Installing the Quality Center Synchronizer Server.............................15
Installing the Quality Center Synchronizer Client.............................24
Starting and Stopping the Quality Center Synchronizer Service........25
Starting the Quality Center Synchronizer Client ...............................26
Uninstalling Quality Center Synchronizer .........................................29
About Synchronizing at a Glance .......................................................33
The Quality Center Synchronizer Client Window .............................34
Synchronization Links ........................................................................35
Integrity Checks ..................................................................................37
Incremental Synchronizations............................................................41
Full Synchronizations..........................................................................42
Setting Filter Options ..........................................................................56
Creating Requirement Type Mappings ...............................................59
Setting Event Options .........................................................................61
Creating Field Mappings .....................................................................66
Setting Mail Notifications ...................................................................81
Setting Adapter Parameters .................................................................82
5
Table of Contents
Resetting a Link.................................................................................100
Deleting Synchronization Links........................................................103
Automatic Backup of the Quality Center Synchronizer Database....104
Exporting and Importing Link Definitions.......................................104
Exporting and Importing Link Data .................................................105
Changing the Quality Center Synchronizer Password .....................110
Guidelines for Working with Rational ClearQuest...........................111
Quality Center Synchronizer Settings for ClearQuest ......................115
Migrating Links from the Mercury Quality Center
Defects Synchronizer for Rational ClearQuest .............................117
Appendix B: Working with Rational RequisitePro............................121
Guidelines for Working with Rational RequisitePro.........................121
RequisitePro Connection Properties .................................................122
Migrating to the Quality Center Synchronizer.................................123
6
Welcome to This Guide
Welcome to HP Quality Center Synchronizer. Quality Center Synchronizer
enables you to synchronize Quality Center data with data in another
application. For example, you can synchronize defects with Rational
ClearQuest and synchronize requirements with Rational RequisitePro.
This guide describes how to install and configure Quality Center
Synchronizer, how to create and manage synchronization links, and how to
run tasks on these links.
Note: The usage of HP Quality Center Synchronizer or HP Quality Center
Synchronizer Adapter SPI to develop an adapter for Quality Center or to
synchronize Quality Center data with Quality Center data is not supported.
Using This Guide
This guide contains the following chapters:
Chapter 1
Chapter 2
Installing Quality Center Synchronizer
Describes how to install and configure the Quality Center Synchronizer,
how to start Quality Center Synchronizer, and how to uninstall
Quality Center Synchronizer.
Synchronizing at a Glance
Provides an overview of working with the Quality Center Synchronizer.
7
Welcome to This Guide
Chapter 3
Creating Synchronization Links
Describes how to create synchronization links for synchronizing data
between Quality Center and other applications.
Chapter 4
Working with Quality Center Synchronizer
Describes how to run tasks on synchronization links, manage
synchronization links, and configure Quality Center Synchronizer.
Appendix A Working with Rational ClearQuest
Describes notes and limitations specific to syncing defects with
Quality Center Synchronizer and Rational ClearQuest.
Appendix B Working with Rational RequisitePro
Describes notes and limitations specific to syncing requirements with
Quality Center Synchronizer and Rational RequisitePro.
8
1
Installing Quality Center Synchronizer
This chapter describes how to install Quality Center Synchronizer.
This chapter includes:
➤ Installing the Quality Center Synchronizer Client on page 24
➤ Starting and Stopping the Quality Center Synchronizer Service on page 25
➤ Starting the Quality Center Synchronizer Client on page 26
➤ Uninstalling Quality Center Synchronizer on page 29
9
Chapter 1 • Installing Quality Center Synchronizer
The Installation Process
Installing and starting Quality Center Synchronizer involves the following
steps:
network. For more information, see “The Quality Center Synchronizer
System” on page 11.
information on the minimum requirements for the Synchronizer server and
client machines, and the supported endpoint versions, see “System
Configurations” on page 12.
Add-ins page. For more information, see “Installing the Quality Center
4 Install the Synchronizer client on the client machine from the
Quality Center Synchronizer Client” on page 24.
5 Start the Synchronizer server. For more information, see “Starting and
Stopping the Quality Center Synchronizer Service” on page 25.
6 Start the Synchronizer client and log in. For more information, see “Starting
the Quality Center Synchronizer Client” on page 26.
10
Chapter 1 • Installing Quality Center Synchronizer
The Quality Center Synchronizer System
This section describes how the Synchronizer system is structured, and how
synchronization link data is stored.
The following diagram illustrates the Quality Center Synchronizer network
configuration:
Endpoint 1
(Quality Center)
Quality Center
Synchronizer Client
SOAP/HTTP
Quality Center
Synchronizer Server
Endpoint 2
11
Chapter 1 • Installing Quality Center Synchronizer
The Synchronizer contains the following components:
➤ Quality Center Synchronizer Client. Displays current links, and provides a
user interface for the user to create and manage links, and run link tasks.
Sends requests from the user to the Synchronizer server. Communicates
with the Quality Center Synchronizer server using the SOAP protocol over
HTTP.
➤ Quality Center Synchronizer Server. Synchronizes data between
Quality Center and other applications. Manages synchronization and
communication between endpoints, and retrieves and stores information in
an integrated database. In addition, the server manages connections to link
endpoints using the endpoints’ application programming interface (API),
which must be installed on the server machine.
The client and server components can reside on the same machine or on
separate machines.
When you install the Synchronizer server, the PostgreSQL 8.3 database
management system is also installed. Link data is stored in a database that is
created in PostgreSQL during the installation process. For example, the
database stores identity mappings between records in each endpoint of a
link by storing the unique IDs of corresponding records in a database table.
System Configurations
endpoints.
This section includes:
➤ “Server System Configurations” on page 13
➤ “Client System Configurations” on page 14
➤ “Supported Endpoints” on page 14
12
Chapter 1 • Installing Quality Center Synchronizer
Server System Configurations
You must install the Quality Center Synchronizer server on a dedicated
server machine that meets the following requirements:
➤ The Quality Center Synchronizer server machine must not be used as
Quality Center, Quality Center Dashboard, or other endpoint server.
➤ The Quality Center Synchronizer server cannot be installed on a machine
that already has a separate PostgreSQL installation. The Quality Center
Synchronizer server works only with the PostgreSQL instance that is
installed with the Synchronizer server.
Following are the minimum server system configurations for the
Quality Center Synchronizer.
Pentium IV or equivalent x86 compatible processor minimum
CPU
1 GB minimum
Memory (RAM)
Free Disk Space
500 MB minimum
➤ Microsoft Windows 2000 with Service Pack 4
➤ Microsoft Windows XP with Service Pack 2
➤ Microsoft Windows 2003 Server with Service Pack 2
Operating
System
13
Chapter 1 • Installing Quality Center Synchronizer
Client System Configurations
Following are the system requirements for the Quality Center Synchronizer
client.
Pentium III or equivalent x86 compatible processor minimum
CPU
512 MB minimum
4 MB minimum
Memory (RAM)
Free Disk Space
➤ Microsoft Windows 2000 with Service Pack 4
➤ Microsoft Windows XP with Service Pack 2
➤ Microsoft Windows 2003 Server with Service Pack 2
➤ Microsoft Windows Vista
Operating
System
Microsoft .NET Framework 2.0 or later
Client Software
Supported Endpoints
The following applications are supported as endpoints:
Type of Entity
Endpoint Type
Synchronized
Defects
➤ Quality Center version 9.0 and later
➤ Rational ClearQuest 2003.06.15; 2003.06.16; 7.0; and 7.0.1
Requirements
➤ Quality Center version 9.2 and later
➤ Rational RequisitePro 2003.06.15; 2003.06.16; 7.0; and 7.0.1
Note: For the most up-to-date list of supported Rational ClearQuest and
Rational RequisitePro versions, see the HP Quality Center Add-ins page
(available from the Quality Center Help menu).
14
Chapter 1 • Installing Quality Center Synchronizer
This section explains how to install and configure the Synchronizer server.
This section includes the following topics:
➤ “Server Installation Notes and Guidelines” on page 15
➤ “Installing the Synchronizer Server” on page 16
➤ “Verifying User Permissions for Service Logon” on page 22
➤ “Troubleshooting the Server Configuration” on page 23
Server Installation Notes and Guidelines
Synchronizer server:
➤ When upgrading from a previous version of the Synchronizer, you can
choose to upgrade the existing database, or delete it and create a new
database. For more information, see “Installing the Synchronizer
Server”(step 15 on page 21).
Additionally, the PostgreSQL database version is upgraded from
PostgreSQL 8.1 to PostgreSQL 8.3.
➤ You must remove any applications that use ports 1098 or 1099.
➤ By default, the Synchronizer uses port 7064. You must remove any
applications that use this port or change the port used by the Synchronizer.
For information on changing the Quality Center Synchronizer port, refer to
(http://h20230.www2.hp.com/selfsolve/document/KM306335).
➤ To enable synchronization between Rational ClearQuest and
Quality Center, you must install a ClearQuest client on the Synchronizer
server machine.
➤ To enable synchronization between Rational RequisitePro and
Quality Center, you must install a RequisitePro client on the Synchronizer
server machine.
➤ To enable use of the Quality Center API, you must install a Quality Center
client on the Synchronizer server machine.
15
Chapter 1 • Installing Quality Center Synchronizer
This section explains how to install the Synchronizer server.
To install the Synchronizer server:
1 Uninstall any previous versions of the Synchronizer server. For more
information, see “Uninstalling Quality Center Synchronizer” on page 29.
2 Open your Web browser and type your HP Quality Center URL:
http://<Quality Center server name>[<:port number>]/qcbin. The
HP Quality Center Options window opens.
16
Chapter 1 • Installing Quality Center Synchronizer
3 Click the Add-ins Page link. The HP Quality Center Add-ins page opens.
4 Click the More HP Quality Center Add-ins link. The More HP Quality Center
Add-ins page opens.
5 Under Quality Center Administrator Add-ins, under Synchronization Tool
Add-ins, click the Quality Center Synchronizer link. The Quality Center
Synchronizer page opens.
6 Right-click the Download Quality Center Synchronizer Server link and click
Save Target As. The Save As dialog box opens.
7 In the Save As dialog box, select a location on your Synchronizer server
machine to save the installation file and click Save.
8 Unzip the saved file to a location on your Synchronizer server machine and
run the setup.exe file. The installation wizard opens.
9 In the Welcome dialog box of the installation wizard, click Next. The
License Agreement dialog box opens.
To accept the terms of the license agreement, select I accept the terms of the
license agreement.
Click Next.
17
Chapter 1 • Installing Quality Center Synchronizer
10 The Installation Location dialog box opens.
In the Directory Name box, specify the location where you want to install
the Synchronizer. You can click the Browse button, select a location, and
click Open.
Click Next.
11 The Summary Information dialog box opens. Click Next to start the
installation process.
12 When the installation process completes, the Installation Complete dialog
box opens. Click Finish to proceed to the server configuration process.
18
Chapter 1 • Installing Quality Center Synchronizer
13 The Synchronizer Server Configuration wizard opens.
The configuration wizard installs and configures the PostgreSQL database
management system, and creates a service on the Synchronizer server
machine.
Click Next.
19
Chapter 1 • Installing Quality Center Synchronizer
14 The Service Configuration dialog box opens.
Enter the User Name, Password, and Domain for a user with administrator
permissions. The user must have permissions to log on as a service. This user
must also have the required settings to use endpoint connectivity.
For more information about permissions to log on as a service, see
“Verifying User Permissions for Service Logon” on page 22.
For more information on endpoint connectivity, refer to the appropriate
appendix in this guide:
➤ For Rational RequisitePro: “RequisitePro Connection Properties” on
page 122
➤ For Rational ClearQuest: “ClearQuest Connection Properties” on
page 116
Click Next.
20
Chapter 1 • Installing Quality Center Synchronizer
15 If you have been working with a previous version of the Synchronizer, a
message box opens asking you if you want to upgrade to the latest database
server version. Click Yes.
16 The Synchronizer Database Found dialog box opens.
Select a database option:
➤ Upgrade Existing Database. Upgrades the existing database. When you
upgrade, the database is first backed up, and the file
SAVEDBACKUP.backup is created in the C:\postgres directory.
➤ Delete Existing Database. Deletes the existing database and creates a new
database.
Important: Deleting the database permanently deletes all Quality Center
Synchronizer link data.
21
Chapter 1 • Installing Quality Center Synchronizer
Click Next. If you selected to delete the existing database, click OK in the
confirmation box.
17 The Synchronizer Configuration Information dialog box opens. Click Next
to start the configuration.
18 When the configuration completes, the configuration results dialog box
opens. Click Finish.
19 A message box opens asking if you want to start the Synchronizer service.
Verifying User Permissions for Service Logon
The user account you enter during server configuration must have
permissions to log on as a service. For more information, see “Installing the
Quality Center Synchronizer Server” on page 15.
To verify user permissions for service logon:
1 From the Start menu, select Run and type secpol.msc.
2 Click OK. The Local Security Settings dialog box opens.
22
Chapter 1 • Installing Quality Center Synchronizer
3 Under Security Settings, expand Local Policies and select User Rights
Assignments. In the right pane, double-click Log on as a service. The Log on
as a service Properties dialog box opens.
4 Verify that your user is listed, or click Add User or Group to add it to the list.
Troubleshooting the Server Configuration
If a problem is encountered during server configuration, an error message
displays in the configuration results dialog box. This section lists problems
that may occur and suggestions for handling them.
Problem
Suggested Solution
Installation of PostgreSQL
does not complete
successfully.
If you uninstalled a previous installation of
PostgreSQL, verify that it was removed completely,
and rerun the server configuration.
For more information on uninstalling PostgreSQL,
see “Uninstalling PostgreSQL” on page 30.
To rerun the server configuration, navigate to
<Quality Center Synchronizer installation
directory>\bin and run the run_config_tool.bat
file.
If the above steps do not resolve the problem, run
install_postgre.bat located in the <Quality Center
Synchronizer installation directory>\bin directory.
Then rerun the server configuration.
Unable to create the
Quality Center
Verify that PostgreSQL access is not locked by
another user, and rerun the server configuration.
Synchronizer schema on
the PostgreSQL database
management system.
To rerun the server configuration, navigate to the
<Quality Center Synchronizer installation
directory>\bin and run the run_config_tool.bat
file.
23
Chapter 1 • Installing Quality Center Synchronizer
Problem
Suggested Solution
Installation of the
Quality Center
Synchronizer service does
not complete successfully.
Run the following files located in the
<Quality Center Synchronizer installation
directory>\bin directory:
1 To uninstall any previous version of the service,
run stop_and_remove_synchronizer_service.bat.
2 To install the service, run
sync_service_install.bat.
Upgrade of the
Quality Center
Synchronizer database does
not complete successfully.
Resolve any problem that caused the upgrade to
fail. Then run the following files located in the
<Quality Center Synchronizer installation
directory>\bin directory:
1 To restore the Quality Center Synchronizer
database to it’s previous state, run
run_recovery_tool.bat.
2 To rerun the server configuration, run
run_config_tool.bat.
Installing the Quality Center Synchronizer Client
After you install the Synchronizer server, you can install the Synchronizer
client.
Note: If you have been working with a previous version of the
Quality Center Synchronizer client, it is detected and uninstalled as part of
the installation process.
To install the Quality Center Synchronizer client:
1 Open the Quality Center Synchronizer Add-in page. For more information
on opening the Quality Center Synchronizer Add-in page, see “Installing
the Synchronizer Server” on page 16.
2 Click the Download Quality Center Synchronizer Client link.
24
Chapter 1 • Installing Quality Center Synchronizer
3 Follow the instructions on your screen to complete the installation of the
Synchronizer client.
4 To access this user’s guide in PDF format after the installation is complete,
choose Start > Programs > HP Quality Center Synchronizer Client > User’s
Guide.
Starting and Stopping the Quality Center Synchronizer
Service
This section describes how to start and stop the Synchronizer service.
Starting the Quality Center Synchronizer Service
You start the Synchronizer service from the Synchronizer server machine.
The Synchronizer service must be running to work with the Synchronizer
client.
To start the Quality Center Synchronizer service:
On the Synchronizer server machine, choose Start > Programs > HP
Quality Center Synchronizer > Start Synchronizer.
Note: The Synchronizer service is started in the background. It may take a
few minutes before the Synchronizer client can connect to the server.
25
Chapter 1 • Installing Quality Center Synchronizer
Stopping the Quality Center Synchronizer Service
To stop the Quality Center Synchronizer service:
1 Make sure that no tasks are running for any link. You can check whether
link tasks are currently running from the Running field in the Links Grid.
For more information on the Links Grid, see “Viewing Link Details” on
page 84.
Tip: To ensure that no tasks can run on any link, disable all links before you
stop the Quality Center Synchronizer service. For more information on
disabling links, see “Enabling and Disabling Synchronization Links” on
page 102.
2 On the Synchronizer server machine, choose Start > Programs > HP
Quality Center Synchronizer > Stop Synchronizer.
Starting the Quality Center Synchronizer Client
After you have installed the Synchronizer server and client, and started the
server, you can start the Synchronizer client and connect to the server.
Notes:
➤ You can work with more than one client connected to the server at the
same time. To avoid unexpected results, if you work with more than one
client at the same time.
➤ The Synchronizer client is automatically disconnected from the
Synchronizer server after an extended period of inactivity. For
information on reconnecting, see “Disconnecting from and
Reconnecting to the Quality Center Synchronizer Server” on page 28.
26
Chapter 1 • Installing Quality Center Synchronizer
To start the Quality Center Synchronizer client:
1 On the Synchronizer client machine, choose Start > Programs > HP
Quality Center Synchronizer Client > Quality Center Synchronizer Client.
The Connect to Server dialog box opens.
2 In the Server name box, type the machine name of the Synchronizer server
to which you want to connect.
3 In the Password box, type the password for the Synchronizer server. The
initial password is blank.
Note: To increase the security of your Quality Center Synchronizer data,
change the password from the default blank password as soon as possible.
For more information on changing the server password, see “Changing the
Quality Center Synchronizer Password” on page 110.
4 Click Connect. The Synchronizer connects to the server you specified and
the Synchronizer client opens.
Tip: To close the Synchronizer client, choose Connection > Exit.
27
Chapter 1 • Installing Quality Center Synchronizer
Disconnecting from and Reconnecting to the
Quality Center Synchronizer Server
You can disconnect from the Synchronizer server manually when needed.
For example, you may want to connect to a different server. Additionally, if
you receive a warning that the Synchronizer client is not connected to the
server, you need to manually disconnect from the Synchronizer server. This
can occur, for example, after an extended period of inactivity.
After you disconnect from a server, you must connect to another server or
reconnect to the same server to continue working with the Synchronizer.
To disconnect from and reconnect to a Quality Center Synchronizer server:
1 Select Connection > Disconnect, or click the Disconnect button. The
Connect to Server dialog box opens.
2 Click the Disconnect button. The Server name and Password boxes become
editable.
3 Enter the logon credentials as described in step 2 in “Starting the
Quality Center Synchronizer Client” on page 27.
4 Click the Connect button. The Synchronizer connects to the server you
specified and the Synchronizer client opens.
28
Chapter 1 • Installing Quality Center Synchronizer
Uninstalling Quality Center Synchronizer
This section describes how to uninstall the Synchronizer server and client. It
also describes how to uninstall the PostgreSQL database management
system.
This section describes how to uninstall the Synchronizer server.
To uninstall the Quality Center Synchronizer server:
1 Stop the Synchronizer service. For more information, see “Stopping the
Quality Center Synchronizer Service” on page 26.
2 On the Synchronizer server machine, choose Start > Settings > Control
Panel > Add or Remove Programs.
3 In the Currently installed programs list, select HP Quality Center
Synchronizer.
4 Click Remove and follow the instructions on your screen.
5 If you have no other applications that use PostgreSQL, uninstall PostgreSQL.
Important: Do not uninstall PostgreSQL if you are uninstalling the
Synchronizer server as part of the upgrade process. During the server
installation you can choose to upgrade the existing database or delete it and
create a new database.
For more information, see “Uninstalling PostgreSQL” on page 30.
29
Chapter 1 • Installing Quality Center Synchronizer
Uninstalling the Quality Center Synchronizer Client
This section describes how to uninstall the Synchronizer client.
To uninstall the Quality Center Synchronizer client:
1 On the Synchronizer client machine, choose Start > Settings > Control
Panel > Add or Remove Programs.
2 In the Currently installed programs list, select HP Quality Center
Synchronizer Client.
3 Click Remove and follow the instructions on your screen.
Uninstalling PostgreSQL
This section describes how to uninstall the PostgreSQL database
management system and delete the PostgreSQL user.
Important:
➤ Uninstalling the PostgreSQL database deletes all Quality Center
Synchronizer link data.
➤ You should only uninstall PostgreSQL if there are no other applications
that are dependent on it.
To uninstall PostgreSQL:
1 On the Synchronizer server machine, choose Start > Settings > Control
Panel > Add or Remove Programs.
2 In the Currently installed programs list, select the appropriate PostgreSQL
version.
3 Click Remove and follow the instructions on your screen.
4 Delete the PostgreSQL installation directory. By default, this is C:\postgres.
30
Chapter 1 • Installing Quality Center Synchronizer
To delete the PostgreSQL user:
1 On the Synchronizer server machine, right-click My Computer and choose
Manage. The Computer Management utility opens.
2 In the Computer Management utility, under System Tools, under Local
Users and Groups, select Users.
3 In the users list in the right pane, select the postgres user.
4 Choose Action > Delete. Click Yes to confirm.
31
Chapter 1 • Installing Quality Center Synchronizer
32
2
Synchronizing at a Glance
Quality Center Synchronizer infrastructure.
This chapter includes:
➤ Synchronization Links on page 35
➤ Integrity Checks on page 37
➤ Incremental Synchronizations on page 41
➤ Full Synchronizations on page 42
About Synchronizing at a Glance
The Synchronizer enables you to synchronize data between Quality Center
and other applications.
You create synchronization links between Quality Center and another
application to manage the synchronization between them. Synchronization
links define which data is synchronized and how it is synchronized. For
more information on synchronization links, see “Synchronization Links” on
page 35.
After you create a synchronization link, you run an integrity check to
validate the link and to highlight problems that may occur during
synchronization. For more information on integrity checks, see “Integrity
Checks” on page 37.
33
|