HP ALM Sync InstallGuide 1

5/25/2018 HP ALM Sync InstallGuide 1

1/34

HP Synchronizer

Software Version: 1.50

Installation Guide

Document Release Date: March 2014

Software Release Date: March 2014


2/34

Legal Notices

Warranty

The only warr anties for HP products and services are set forth i n the express warr anty statements accompanying such products and services. Nothing herein should be

construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

The information contained herein is subject to change without notice.

Restricted Rights Legend

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer

Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial

license.

Copyright Notice

Copyright 2002 - 2014 Hewlett-Packard Development Company, L.P.

Trademark Notices

Adobe is a trademark of Adobe Systems Incorporated.

Intel is a trademark of Intel Corporation in the U.S. and other countries.

Java is a registered trademark of Oracle and/or its affiliates.

Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation.

Oracle is a registered trademark of Oracle and/or its affiliates.

UNIX is a registered trademark of The Open Group.

Documentation Updates

The title page of this document contains the followi ng identifying information:

l Software Version number, which indicates the software version.

l Document Release Date, which changes each time the document, is updated.

l Software Release Date, which indicates the release date of this version of the software.

To check for recent updates or to ver ify that you are using the most recent edition of a document, go to: www.hp.com/go/livenetwork. 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 theNew users - please registerli nk on the HP Passport login page.

Support

This document describes HP Live Network Community Content. Hewlett Packard Software does not test, certify or support Community Content. Please use the

Community Content discussion forums on HP Live Network or contact the original submitter of the Community Content directly if any support, configuration or usability

questions arise. Please back up all appropriate Synchronizer files before applying Community Content in your environment.

HP Synchronizer (1.50) Page 2 of 34
http://h20229.www2.hp.com/passport-registration.htmlhttp://www.hp.com/go/livenetwork


3/34

Contents

Welcome to This Guide 5

How This Guide is Organized 5

Documentation Set 5

Chapter 1: Installing HP ALM Synchronizer 7

The Installation Process 8

The HP ALM Synchronizer System 8

System Configurations 9

Server System Configurations 9

Client System Configurations 10

Supported Endpoints 11

Installing the HP ALMSynchronizer Server 12

Server Installation Notes and Guidelines 12

Installing the HP ALM Synchronizer Server 13

Verifying User Permissions for Service Logon 18

Configuring Secure Access for HP ALM Synchronizer 19

Installing the HP ALM Synchronizer Client 20

Starting and Stopping the HP ALM Synchronizer Service 21

Starting the HP ALM Synchronizer Service 21

Stopping the HP ALM Synchronizer Service 21

Starting the HP ALM Synchronizer Client 22

Disconnecting from and Reconnecting to the HP ALMSynchronizer Server 23

Uninstalling HP ALM Synchronizer 24

Uninstalling the HPALM Synchronizer Server 24

Uninstalling the HP ALM Synchronizer Client 25

Uninstalling PostgreSQL 25

Upgrading HP ALM Synchronizer 26

Chapter 2: Installation Troubleshooting 29

Previous HP ALM Synchronizer Uninstall Incomplete 30

HP ALM Synchronizer Server Configuration Errors 30



4/34

HP ALM Synchronizer Service Does Not Start 32

Cannot Connect to an Endpoint 32

We appreciate your feedback! 33

Installation Guide



5/34

Welcome to This Guide

Welcome to the HP ALM Synchronizer. Synchronizer enables you to synchronize HP Application

Lifecycle Management (ALM) data in another application. You can:

l Synchronize defect data between ALM and Rational ClearQuest or Microsoft Team Foundation

Server.

l Synchronize requirement data between ALM and Rational RequisitePro or Microsoft Team

Foundation Server.

l Synchronize defect data between two ALM projects.

This guide describes how to install and configure Synchronizer.

Note: The usage of HP ALM Synchronizer or HP ALM Synchronizer Adapter SPI to develop anadapter for ALM is not supported.

How This Guide is Organized

The HP ALM Synchronizer Installation Guidedescribes the system requirements and installation

process for HP ALM Synchronizer.

It contains the following:

"Installing HP ALM

Synchronizer" on

page 7

Describes how to install and configure HP ALM Synchronizer, how to

start HP ALM Synchronizer, and how to uninstall HP ALM Synchronizer.

"Installation

Troubleshooting" on

page 29

Troubleshooting suggestions for dealing with issues related to the HP

ALM Synchronizer installation.

Documentation Set

The HP ALM Synchronizer documentation set includes the following guides and references:

l HP ALM Synchronizer User Guideexplains how to create and manage synchronization links to

synchronize data between ALM and other applications.

l HP ALM SynchronizerInstallation Guideexplains how to install and configure HP ALM

Synchronizer.

l Readmeprovides last-minute news and information about HP ALM Synchronizer.



6/34

To access the documentation set:

l To access the HP ALM Synchronizer User Guide, from the HP ALM Synchronizer client, select

Help> User Guide. Alternatively, select Start>Programs > HP ALM Synchronizer Client

> User Guide.

l For the most up-to-date versions of these documents, see the HP Application Lifecycle

Management Add-ins page. From the main ALM window, select Help > Add-ins.

l All documents are available on the ALM installation DVD in the HP ALM Synchronizerfolder.

Installation Guide



7/34

Chapter 1: Installing HP ALM Synchronizer

This chapter describes how to install HP ALM Synchronizer.

This chapter includes:

The Installation Process 8

The HP ALM Synchronizer System 8

System Configurations 9


Installing the HP ALM Synchronizer Client 20

Starting and Stopping the HP ALM Synchronizer Service 21

Starting the HP ALM Synchronizer Client 22

Uninstalling HP ALM Synchronizer 24

Upgrading HP ALMSynchronizer 26



8/34

The Installation Process

Installing and starting HP ALM Synchronizer involves the following steps:

l Review the HP ALM Synchronizer system structure to plan the installation in your network. For

details, see "The HP ALM Synchronizer System" below.

l Make sure that your system meets the minimum requirements. For more information on the

minimum requirements for the HP ALM Synchronizer server and client machines, and the

supported endpoint versions, see "System Configurations" on the next page.

l Install the HP ALM Synchronizer server on the server machine. For details, see "Installing the

HP ALM Synchronizer Server" on page 12.

l Install the HP ALM Synchronizer client on the client machine. For details, see "Installing the HP

ALM Synchronizer Client" on page 20.

l Start the HP ALM Synchronizer server. For details, see "Starting and Stopping the HP ALM

Synchronizer Service" on page 21.

l Start the HP ALM Synchronizer client and log in. For details, see "Starting the HP ALM

Synchronizer Client" on page 22.

The HP ALM Synchronizer System

This section describes how the HP ALM Synchronizer system is structured, and how

synchronization link data is stored.

The following diagram illustrates the HP ALM Synchronizer network configuration:

Installation Guide



9/34

HP ALM Synchronizer contains the following components:

l HP ALM 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 HP

ALM Synchronizer server. Communicates with the HP ALM Synchronizer server using the

SOAP protocol over HTTP.

l HP ALM Synchronizer Server.Synchronizes data between HP Application Lifecycle

Management (ALM) 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 HP ALM 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

This section describes the minimum server and client system configurations for installing HP ALM

Synchronizer, as well as the supported endpoints.

This section includes:

Server System Configurations 9

Client System Configurations 10

Supported Endpoints 11

Server System Configurations

You must install the HP ALM Synchronizer server on a dedicated server machine that meets the

following requirements:

l The HP ALM Synchronizer server machine must not be used as an ALM Platform, ClearQuest,

RequisitePro, or TFS server.

l The HP ALM Synchronizer server cannot be installed on a machine that already has a separate

PostgreSQL installation. The HP ALM Synchronizer server works only with the PostgreSQL

instance that is installed with the HP ALM Synchronizer server.

Following are the minimum server system configurations for the HP ALM Synchronizer.

CPU Pentium IV or equivalent x86 compatible processor minimum

Installation Guide



10/34

Memory (RAM) 1 GB minimum

Free Disk Space 500 MB minimum

Operating System Both 32-bit and 64-bit operating systems are supported:

l Microsoft Windows XP with Service Pack 2

l Microsoft Windows 2003 Server with Service Pack 2

l Microsoft Windows Server 2008 R2

l Microsoft Windows Server 2008

l Windows Vista

Client System Configurations

Following are the system requirements for the HP ALM Synchronizer client.

CPU Pentium III or equivalent x86 compatible processor minimum

Memory (RAM) 512 MB minimum

Free Disk Space 5 MB minimum

Operating System l Microsoft Windows 2000 with Service Pack 4

l Microsoft Windows XP with Service Pack 2

l Microsoft Windows 2003 Server with Service Pack 2

l Microsoft Windows Vista

l Microsoft Windows Server 2008 R2

l Microsoft Windows Server 2008

l Microsoft Windows 7

Client Software Microsoft .NET Framework 2.0 or later

Installation Guide



11/34

Supported Endpoints

Synchronization is supported between the following endpoint applications:

Type of Entity

Synchronized

Endpoint

Type 1

Endpoint Type 2

efects HP ALM12.00

HP ALM

11.52

HP ALM

11.50

HP ALM

11.00

Rational ClearQuest 2003.06.15; 2003.06.16; 7.0;

7.0.1; and 7.1

Microsoft TFS 2008, 2010, and 2012

equirements HP ALM12.00

HP ALM

11.52

HP ALM

11.50

HP ALM

11.00

Rational RequisitePro 2003.06.15; 2003.06.16; 7.0;

7.0.1; and 7.1

Microsoft TFS 2010 and 2012

efects HP ALM12.00

HP ALM

11.52

HP ALM

11.50

HP ALM

11.00

HP ALM 12.00

HP ALM 11.52

HP ALM 11.50

HP ALM 11.00

Note:

For the most up-to-date list of supported endpoint versions, see the HP Application Lifecycle

Management Add-ins page (ALM Help> Add-ins).

Defect synchronization between two HP ALM 11.50 endpoints is not supported for HP ALM

Essentials Edition, HP Quality Center Enterprise Edition, HP Quality Center Essentials

Edition, or HP ALM Performance Center Edition.

Installation Guide



12/34

Installing the HP ALM Synchronizer Server

This section explains how to install and configure the HP ALM Synchronizer server.

Note: HP ALM Synchronizer requires the use of the ALM API. To enable use of the ALM API

and work with HP ALM Synchronizer, you must run the HP ALM Client Registration add-in

on the HP ALM Synchronizer server machine, available from the HP Application Lifecycle

Management Add-ins page. From the main ALM window, select Help > Add-ins.

This section includes the following topics:

Server Installation Notes and Guidelines 12


Verifying User Permissions for Service Logon 18

Configuring Secure Access for HP ALM Synchronizer 19

Server Installation Notes and Guidelines

Review the following notes and guidelines before installing the HP ALM Synchronizer server:

l If you are upgrading from a previous version of HP ALM Synchronizer, see "Upgrading HP ALM

Synchronizer" on page 26.

l You must remove any applications that use ports 1098 or 1099.

l By default, HP ALM Synchronizer uses port 7064. You must remove any applications that use

this port or change the port used by HP ALM Synchronizer. For information on changing the HP

ALM Synchronizer port, refer to HP Software Self-solve knowledge base article KM306335

(http://h20230.www2.hp.com/selfsolve/document/KM306335).

l If you change the port used by HP ALM Synchronizer and you are working securely with HTTPS

connections, do the following:

n Change the port number in the JBoss configuration.

n Change the WEBAPP_NON_HTTPS_URLHP ALM Synchronizer parameter. For details,

contact HP Software Support.

l To enable synchronization between Rational ClearQuest and ALM, you must install a

ClearQuest client on the HP ALM Synchronizer server machine.

l To enable synchronization between Rational RequisitePro and ALM, you must install a

RequisitePro client on the HP ALM Synchronizer server machine.

Installation Guide

http://h20230.www2.hp.com/selfsolve/document/KM306335


13/34

l To enable synchronization between Microsoft Team Foundation Server (TFS) and ALM, you

must do the following:

n Prerequisite: Before installation, you must have Microsoft Visual Studio Team Explorer 2008

or 2010 installed, depending on the TFS version with which you are working.

If working with TFS 2012, you must have Microsoft Visual Studio Team Explorer 2010 or later

installed.

n After installing the HP ALM Synchronizer server, you must register the TFS assembly file.

For details, see step 19 under "Installing the HP ALM Synchronizer Server" below.

l If you encounter problems during the HP ALM Synchronizer installation process, see

"Installation Troubleshooting" on page 29for troubleshooting suggestions.

Installing the HP ALM Synchronizer Server

You can install the HP ALM Synchronizer server from the HP Application Lifecycle Management

Add-ins page. You can also install the HP ALM Synchronizer from the ALM installation DVD.

To install the HP ALM Synchronizer server from the Add-ins page:

1. Uninstall any previous versions of the HP ALM Synchronizer server. For more information, see

"Uninstalling HP ALM Synchronizer" on page 24.

2. Open your Web browser and type your ALM URL:

http://[]/qcbin

The HP Application Lifecycle Management Options window opens.

Installation Guide



14/34

3. Click the Toolslink. The HP Application Lifecycle Management Tools page opens.

4. Click theMore HP ALM Add-inslink. The HP Application Lifecycle Management Add-ins

page opens.

5. Click the HP ALM Synchronizer link. The HP ALM Synchronizer page opens.

6. Right-click the Download HP ALM Synchronizer Serverlink and click Save Target As. The

Save As dialog box opens.

7. In the Save As dialog box, select a location on your HP ALM Synchronizer server machine to

save the installation file and click Save.

8. Unzip the saved file to a location on your HP ALM Synchronizer server machine and run the

setup.exefile. 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.

Installation Guide



15/34

10. The Installation Location dialog box opens.

In the Directory Namebox, specify the location where you want to install HP ALM

Synchronizer. You can click the Browsebutton, select a location, and click Open.

Click Next.

11. The Summary Information dialog box opens. Click Nextto start the installation process.

12. When the installation process completes, the Installation Complete dialog box opens. Click

Finishto proceed to the server configuration process.

Installation Guide



16/34

13.

The HP ALM Synchronizer Server Configuration wizard opens.

The configuration wizard installs and configures the PostgreSQL database management

system, and creates a service on the HP ALM Synchronizer server machine. Click Next.

14. The HP ALM Configuration dialog box opens.

Select the vALM version with which you are working. Click Next.

15. The Service Configuration dialog box opens.

Installation Guide



17/34

To allow the service to run using the Windows Local System account, leave all fields empty.

Note: This does not apply to RequisitePro. To work with RequisitePro, you must f ill in the

fields. Enter theUser Name, Password, and Domainfor a Windows domain 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 the next page.

For more information on endpoint connectivity, refer to the appropriate appendix in theHP ALM

Synchronizer User Guide.

Click Next.

16. If you have been working with a previous version of HP ALM Synchronizer, the DatabaseConfiguration 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 backup file is created in theC:\postgresdirectory in the

following format: SAVEDBACKUP.backup.

For example, SAVEDBACKUP_2008_12_31_11_45_1.3.backup.

Delete Existing Database. Deletes the existing database and creates a new database.

Caution: Deleting the database permanently deletes all HP ALM Synchronizer link data.

Click Next. If you selected to delete the existing database, click OKin the confirmation box.

17. The Configuration Information dialog box opens. Click Nextto start the configuration.

18. When the configuration completes, the Configuration Status dialog box opens.

n To start the HP ALM Synchronizer service and exit the wizard, click Finish.

n To start the HP ALM Synchronizer service later, clear the Start HP ALM Synchronizer

service checkbox. You will need to start the service manually to begin working with HP

ALM Synchronizer.

19. To enable synchronization between Microsoft Team Foundation Server (TFS) and ALM, you

must register the TFS assembly file.

n TFS 2008 users: In the \adapters\net

directory, and run the Register-TFS-Adapter.exe file.

Installation Guide



18/34

n TFS 2010 users: In the \adapters\net2010directory, and run the Register-TFS-Adapter.exe file.

n TFS 2012 users: In the \adapters\net2012directory, and run the Register-TFS-Adapter.exe file.

To install the HP ALM Synchronizer server from the ALM installation DVD:

1. Uninstall any previous versions of the HP ALM Synchronizer server. For more information, see


2. Check the HP ALM Synchronizer Add-in page to ensure you are installing the most up-to-date

version of the HP ALM Synchronizer. For information on opening the HP ALM Synchronizer

Add-in page, see step 2 of the installation procedure from the Add-ins page.

3. To install HP ALM Synchronizer from the ALM installation DVD, in theALMHP ALM

Synchronizerfolder, unzip the HP-ALM-Sync-Server.zip file to a location on your HP ALM

Synchronizer server machine. Run the setup.exefile and continue installation from step 9 of

the installation procedure from the Add-ins page.

Verifying User Permissions for Service Logon

The user account you enter during server configuration must have permissions to log on as a

service. For details, see "Installing the HP ALM Synchronizer Server" on page 12.

To verify user permissions for service logon:

1. From the Start menu, selectRunand type secpol.msc.

2. Click OK. The Local Security Settings dialog box opens.

Installation Guide



19/34

3. Under Security Settings, expand Local Policiesand 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 Groupto add it to the list.

Configuring Secure Access for HP ALM Synchronizer

The following procedure describes how to configure a Secure Socket Layer (SSL) connection when

ALM HP ALM Synchronizer is installed on a Windows system.

To configure SSL:

1. Verify that all Synchronizer clients are disconnected from the Synchronizer server, and stop

the HP ALM Synchronizer Service by selecting Start > All Programs > HP ALM HP ALM

Synchronizer > Stop HP ALM Synchronizer.

2. Back up the file: \jboss\server\default\deploy\jbossweb.sar\server.xml.

3. Enable the HTTPS connector. Edit the

\jboss\server\default\deploy\jbossweb.sar\server.xml file.

n Un-comment the SSL/TLS Connector configuration section.

n Make sure to replace your_keystoreand your_passwordwith your keystore file absolute

location and keystore file password.

n The truststore you specify as the truststoreFilevalue should contain trusted certificates,

such as trusted Certificate Authority (CA) certificates. If the server certificate was issued byCA, import the trusted certificate to into this truststore or the location of cacerts in the

default java installation.

Installation Guide



20/34

Caution: Do not disable HTTP connections, because HP ALM Synchronizer uses HTTP

for internal communication between its various server modules. Leave the HTTP port

open. This does not compromise security because communication between the HP ALM

Synchronizer server and client is secure using HTTPS.

4. If you are not using the default port for HP ALM Synchronizer (7064), change the WEBAPP_

NON_HTTPS_URLSynchronizer parameter to the correct port number. For details, contact

HP Software Support.

5. Restart the HP ALM Synchronizer service.

For instructions on using HTTPS connections after configuration, see "Starting the HP ALM


Installing the HP ALM Synchronizer Client

After you install the HP ALM Synchronizer server, you can install the HP ALM Synchronizer client.

You download and install the HP ALM Synchronizer client from the HP ALM Add-ins page. You can

also install the HP ALM Synchronizer client from the ALM installation DVD.

Note: If you have been working with a previous version of the HP ALM Synchronizer, you do

not need to first uninstall the client. During installation, the previous version is detected, and

you can choose to uninstall it at that t ime.

To install the HP ALM Synchronizer client from the Add-ins page:

1. Open the HP ALM Synchronizer Add-in page. For more information on opening the HP ALMSynchronizer Add-in page, see "Installing the HP ALM Synchronizer Server" on page 13.

2. Click the Download HP ALM Synchronizer Client link.

Note: If a previous version of the HP ALM Synchronizerclient is installed on your

computer, select the Removeoption when prompted to remove the previous version.

When complete, run the client installation file again to install the new version.

3. Follow the instructions on your screen to complete the installation of the HP ALM Synchronizer

client.

To install the HP ALM Synchronizer client from the ALM installation DVD:

1. Check the HP ALM Synchronizer Add-in page to ensure you are installing the most up-to-date

version of the HP ALM Synchronizer client. For more information on opening the HP ALM

Synchronizer Add-in page, see "Installing the HP ALM Synchronizer Server" on page 13.

2. To install the HPALM Synchronizer client from the ALM installation DVD, in the ALMHP ALM

Installation Guide



21/34

Synchronizerfolder, double-click the HP-ALM-Sync-Client.msi file.

Note: If a previous version of the HP ALM Synchronizerclient is installed on your

computer, select the Removeoption when prompted to remove the previous version.

When complete, run the client installation file again to install the new version.

3. Follow the instructions on your screen to complete the installation of the HP ALM Synchronizer

client.

Starting and Stopping the HP ALM Synchronizer Service

This section describes how to start and stop the HP ALM Synchronizer service.

Starting the HP ALM Synchronizer Service 21

Stopping the HP ALM Synchronizer Service 21

Starting the HP ALM Synchronizer Service

You start the HP ALM Synchronizer service from the HP ALM Synchronizer server machine. The

HP ALM Synchronizer service must be running to work with the HP ALM Synchronizer client.

If you encounter problems starting the HP ALM Synchronizer service, see "HP ALM Synchronizer

Service Does Not Start" on page 32for troubleshooting suggestions.

To start the HP ALM Synchronizer service:

On the HP ALM Synchronizer server machine, choose Start > Programs > HP ALM

Synchronizer > Start HP ALM Synchronizer.

Note: The HP ALM Synchronizer service is started in the background. It may take a few

minutes before the HP ALM Synchronizer client can connect to the server.

Stopping the HP ALM Synchronizer Service

You stop the HP ALM Synchronizer service from the HP ALM Synchronizer server machine.

To stop the HP ALM Synchronizer service:

1. Make sure that no tasks are running for any link. You can check whether link tasks are

currently running from the Runningfield in the Links Grid. For more information on the Links

Grid, refer to the HP ALM Synchronizer User Guide.

Installation Guide



22/34

Note: To ensure that no tasks can run on any link, disable all links before you stop the HP

ALM Synchronizer service. For more information on disabling links, refer to theHP ALM


2. On the HP ALM Synchronizer server machine, choose Start > Programs > HP ALM

Synchronizer > Stop HP ALM Synchronizer.

Starting the HP ALM Synchronizer Client

After you have installed the HP ALM Synchronizer server and client, and started the server, you

can start the HP ALM 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 avoidunexpected results, if you work with more than one client, you must make sure that no link is

worked on by more than one client at the same time.

The HP ALM Synchronizer client is automatically disconnected from the HP ALM

Synchronizer server after an extended period of inactivity. For information on reconnecting, see

"Disconnecting from and Reconnecting to the HP ALM Synchronizer Server" on the next page.

To start the HP ALM Synchronizer client:

1. On the HP ALM Synchronizer client machine, choose Start > Programs > HP ALM

Synchronizer Client > HP ALM Synchronizer Client. The Connect to HP ALM

Synchronizer Server dialog box opens.

2. In the Server nameand Portboxes respectively, type the machine name and port of the HP

ALM Synchronizer server to which you want to connect.

The default port, 7064, is displayed.

Installation Guide



23/34

Tip: To connect to a HP ALM Synchronizer server installed on your local machine, type

localhost.

3. Select the Use Httpscheckbox if you want to use Hypertext Transfer Protocol Secure(HTTPS) for a secure connection between the HP ALM Synchronizer server and the HP ALM

Synchronizer client.

For details on setting up secure connections, see "Configuring Secure Access for HP ALM

Synchronizer" on page 19

4. In the User Namebox, type your user name.

The first time you connect to a HP ALM Synchronizer server, you must log in as the HP ALM

Synchronizer administrator, with the user name admin. After you connect, you can create

additional users. For details, refer to the HP ALM Synchronizer.

5. In the Passwordbox, type your password. The initial password is blank.

Note: To increase the security of your HP ALM Synchronizer data, change the password

from the default blank password as soon as possible. For more information on changing

the server password, refer to the HP ALM Synchronizer.

6. Click Connect. HP ALM Synchronizer connects to the server you specified and the HP ALM

Synchronizer client opens.

Tip: To close the HP ALM Synchronizer client, choose Connection > Exit.

Disconnecting from and Reconnecting to the HP ALM

Synchronizer Server

You can disconnect from the HP ALM Synchronizer server manually when needed. For example,

you may want to connect to a different server. Additionally, if you receive a warning that the HP

ALM Synchronizer client is not connected to the server, you need to manually disconnect from the

HP ALM 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 HP ALM Synchronizer.To disconnect from and reconnect to a HP ALM Synchronizer server:

1. Select Connection > Disconnect, or click the Disconnect button. The Connect to HPALM Synchronizer Server dialog box opens.

Installation Guide



24/34

2. Click the Disconnectbutton. The Server name, User Name, and Passwordboxes become

editable.

3. Enter the logon credentials as described in step 2 under "Starting the HP ALM Synchronizer

Client" on page 22.

4. Click the Connectbutton. The HP ALM Synchronizer connects to the server you specif ied and

the HP ALM Synchronizer client opens.

Uninstalling HP ALM Synchronizer

This section describes how to uninstall the HP ALM Synchronizer server and client. It also

describes how to uninstall the PostgreSQL database management system.

This section includes:

Uninstalling the HP ALM Synchronizer Server 24

Uninstalling the HP ALM Synchronizer Client 25

Uninstalling PostgreSQL 25

Uninstalling the HPALM Synchronizer Server

This section describes how to uninstall the HP ALM Synchronizer server.

To uninstall the HP ALM Synchronizer server:

1. Stop the HP ALM Synchronizer service. For details, see "Stopping the HP ALM Synchronizer

Service" on page 21.

2. On the HP ALM Synchronizer server machine, choose Start > Settings > Control Panel >

Add or Remove Programs.

3. In the Currently installed programslist, select HP ALM Synchronizer.

4. Click Removeand follow the instructions on your screen.

Installation Guide



25/34

5. If you have no other applications that use PostgreSQL, uninstall PostgreSQL.

Caution: Do not uninstall PostgreSQL if you are uninstalling the HP ALM 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 details, see "Uninstalling PostgreSQL" below.

Uninstalling the HP ALM Synchronizer Client

This section describes how to uninstall the HP ALM Synchronizer client.

Note: If you are upgrading the HP ALM Synchronizer, you do not need to uninstall the HP ALM

Synchronizer client. The previous version is detected and uninstalled as part of the client

installation process.

To uninstall the HP ALM Synchronizer client:

1. On the HP ALM Synchronizer client machine, choose Start > Settings > Control Panel >


2. In the Currently installed programslist, select HP ALM Synchronizer Client.


Uninstalling PostgreSQL

This section describes how to uninstall the PostgreSQL database management system and delete

the PostgreSQL user.

Caution:

Uninstalling the PostgreSQL database deletes all HP ALM 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 HP ALM Synchronizer server machine, choose Start > Settings > Control Panel >


2. In the Currently installed programslist, select the appropriate PostgreSQLversion.

Installation Guide



26/34


4. Delete the PostgreSQL installation directory. By default, this is C:\postgres.

To delete the PostgreSQL user:

1. On the HP ALM Synchronizer server machine, right-click My Computerand 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. ClickYes to confirm.

Upgrading HP ALM SynchronizerIf a previous version of the HP ALM Synchronizer is installed, you must upgrade to work with HP

ALM Synchronizer 1.50. Consider the following when upgrading:

l When upgrading from a previous version, you can choose to upgrade the existing database.

Upgrading the database enables you to continue working with your existing HP ALM

Synchronizer links and maintains link data. For details, see "Installing the HP ALM Synchronizer

Server" on page 13(step 16).

l If you are working with an earlier version of HP ALM Synchronizer using PostgreSQL 8.1, the

PostgreSQL database version is upgraded to PostgreSQL 8.3.

To upgrade from a previous version of HP ALM Synchronizer:

1. Make sure that your system meets the minimum requirements. For more information on the

minimum requirements for the HP ALM Synchronizer server andclient machines, and the

supported endpoint versions, see "System Configurations" on page 9.

2. Uninstall the previous version of the HP ALM Synchronizer server. For details, see


3. Download and install the HP ALM Synchronizer server from the HP Application Lifecycle

Management Add-ins page. During installation, select the option to upgrade the existing

database. For details, see "Installing the HP ALM Synchronizer Server" on page 12.

4. Install the HP ALM Synchronizer client on the client machine from theHP Application Lifecycle

Management Add-ins page. You do not need to first uninstall the HP ALM Synchronizer client.

During installation, the previous version is detected, and you can choose to uninstall it at that

time. For details, see "Installing the HP ALM Synchronizer Client" on page 20.

5. Start the HP ALM Synchronizer server. For details, see "Starting and Stopping the HP ALM

Installation Guide



27/34

Synchronizer Service" on page 21.

6. Start the HP ALM Synchronizer client and log in. For details, see "Starting the HP ALM


Installation Guide



28/34Page 28 of 34HP Synchronizer (1.50)

Installation Guide


29/34

Chapter 2: Installation Troubleshooting

This chapter contains troubleshooting suggestions for dealing with issues related to the HP ALM

Synchronizer installation.

This chapter includes:

Previous HP ALM Synchronizer Uninstall Incomplete 30

HP ALM Synchronizer Server Configuration Errors 30

HP ALM Synchronizer Service Does Not Start 32

Cannot Connect to an Endpoint 32



30/34

Previous HP ALM Synchronizer Uninstall Incomplete

During installation, an error message displays indicating that the previous HP ALM Synchronizer

version was not uninstalled. This can occur even whenHP ALM Synchronizerin not listed in

Windows Add or Remove Programs.

This may indicate that a previous HP ALM Synchronizer installation was not completely

uninstalled. References to the previous installation may remain in the vpd.propertiesfile, located

in the Windows system root folder.

To remove all remaining references to a previous installation:

1. Verify that the HP ALM Synchronizer was uninstalled by checking that it is not listed in

Windows Add or Remove Programs.

2. Navigate to the Windows system root (%systemroot%) folder and backup the vpd.properties

file.

3. In a text editor, open the vpd.propertiesfile and delete all rows containing references to HP

ALM Synchronizer.

HP ALM Synchronizer Server Configuration Errors

During installation of the HP ALM Synchronizer server, the HP ALM Synchronizer Server

Configuration wizard installs and configures the PostgreSQL database management system, and

creates a service on the HP ALM Synchronizer server machine. 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 25.

To rerun the server configuration, navigate to the \bindirectory and run

the run_config_tool.batfile.

If the above steps do not resolve the problem, run install_

postgre.batlocated in the \bindirectory. Then rerun the server

configuration.

Installation Guide



31/34

Problem Suggested Solution

Unable to create the HP ALM

Synchronizer schema on the

PostgreSQL database

management system.

Verify that PostgreSQL access is not locked by another

user, and rerun the server configuration.

To rerun the server configuration, navigate to the \bindirectory and run

the run_config_tool.batfile.

Installation of the HP ALM

Synchronizer service does not

complete successfully.

Verify the following:

l The user account you enter during server configuration

has administrator permissions.

l The user account you enter during server configuration

has permissions to log on as a service. For details, see

"Verifying User Permissions for Service Logon" on page

18.

l The user running the installation has administrator

permissions on the machine on which the HP ALM

Synchronizer is being installed.

Then run the following files located in the \bindirectory:

1. To uninstall any previousversion of the service, run

stop_and_remove_synchronizer_service.bat.

2. To install the service, run sync_service_install.bat.

Upgrade of the HP ALM

Synchronizer database does not

complete successfully.

Resolve any problem that caused the upgrade to fail. Then

run the following files located in the \bindirectory:

1. To restore the HP ALM Synchronizer database to its

previous state, run run_recovery_tool.bat.

2. To rerun the server configuration, run run_config_

tool.bat.

Installation Guide



32/34

HP ALM Synchronizer Service Does Not Start

If the HP ALM Synchronizer service does not start, verify the following:

Description Action

The service was

installed with

appropriate

permissions.

To verify service properties:

1. From the Startmenu, select Runand type services.msc. Click OK.

2. Right-click HP ALM Synchronizerand select Properties. In the

Log Ontab, verify that the account listed is an administrator user.

3. Verify that the password was typed correctly.

The service account

has appropriatepermissions.

Verify that the user account you entered during server configuration has

permissions to log on as a service. For details, see "Verifying UserPermissions for Service Logon" on page 18.

PostgreSQL is

installed.

Verify that PostgreSQL is listed in Windows Add or Remove Programs.

PostgreSQL is

running.

To verify that the PostgreSQL service is running:

1. From the Startmenu, select Runand type services.msc. Click OK.

2. Verify that PostgreSQL DatabaseServer 8.3 is listed.

Cannot Connect to an EndpointIf the HP ALM Synchronizer cannot connect to one of the endpoints, you can use script files

provided by the HP ALM Synchronizer to check that the endpoints API is functioning properly.

To check connectivity to an endpoint:

1. Navigate to the\bindirectory and locate the

appropriate file for the endpoint. The following files are available:

n checkCqConnectivity.vbsfor a Rational ClearQuest endpoint

n checkQcConnectivity.vbsfor an HP ALM Synchronizer endpoint

n checkRpConnectivity.vbsfor a Rational RequisitePro endpoint

2. Edit the relevant script file to include the connection properties for the endpoint. For more

information on connection properties, see the appropriate appendix in the HP ALM


3. Double-click the script file. If connection is successful, a confirmation message displays.

Installation Guide



33/34

We appreciate your feedback!

If you have comments about this document, you can contact the documentation teamby email. If

an email client is configured on this system, click the link above and an email window opens withthe following information in the subject line:

Feedback on Installation Guide (Synchronizer 1.50)

Just add your feedback to the email and click send.

If no email client is available, copy the information above to a new message in a web mail client,

and send your feedback to [email protected].

mailto:[email protected]?subject=Feedback%20on%20Installation%20Guide%20(Synchronizer%201.50)


34/34

Documents

HP ALM Sync InstallGuide 1