Software Version: 12.53
HP ALM Synchronizer
Document Release Date: May 2016 | Software Release Date: May 2016
WarrantyThe only warranties for Hewlett Packard Enterprise Development LP products and services are set forth in the express warranty
statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty.
HPE 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 LegendConfidential computer software. Valid license from HPE 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 - 2016 Hewlett Packard Enterprise Development LP
Trademark NoticesAdobe is a trademark of Adobe Systems Incorporated.
Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation.
UNIX is a registered trademark of The Open Group.
This product includes an interface of the 'zlib' general purpose compression library, which is Copyright 1995-2002 Jean-loup Gailly
and Mark Adler.
Documentation UpdatesThe title page of this document contains the following 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 verify that you are using the most recent edition of a document, go to:
This site requires that you register for an HPE Passport and sign in. To register for an HPE Passport ID, go to
https://softwaresupport.hpe.com and click Register.
SupportThis document describes HPE Live Network Community Content. Hewlett Packard Enterprise does not test, certify or support
Community Content. Please use the Community Content discussion forums on HPE 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 ALM
Synchronizer files before applying Community Content in your environment.
HP ALM Synchronizer (12.53) Page 2 of 114
HP ALM Synchronizer 1HP ALM Synchronizer User Guide 6
How This Guide is Organized 6
Documentation Set 7
Getting Started 9
Starting and Stopping the Synchronizer Service 10
Starting the Synchronizer Client 10
Disconnecting from, and Reconnecting to, the Synchronizer Server 12
The Synchronizer Client Window 13
Synchronizer Client Window Toolbar Buttons and Menu Options 14
Managing Users 16
Synchronizing at a Glance 19
About Synchronizing at a Glance 20
Synchronization Links 20
Time Stamp, Identity Mappings, and Record Versions 21
Cycle Redundancy Checks 21
Integrity Checks 22
Checks Performed on General Link Settings 22
Checks Performed on Link Field Mappings 24
Incremental Synchronization 25
Incremental Synchronization 25
Full Synchronization 26
Full Synchronization 26
Working with ALM Version Control 27
Creating Synchronization Links 29
About Creating Synchronization Links 30
Creating Links 30
Setting General Link Properties 32
SettingALM Endpoint Connection Properties 33
Connectingto ALM While Creating a Link 34
Setting theOther Endpoint's Connection Properties 36
Setting Entity Types for BothEndpoints 37
Setting Link Properties 38
Guidelines for Defining an Alternate Root Folder in ALM 40
Setting Scheduling Options 41
Setting Filter Options 42
Creating Requirement Type Mappings 45
Configuring Synchronization Rules 46
Configuring Rules for Defect Synchronization 46
Configuring Rules for Requirement Synchronization 47
HP ALM Synchronizer (12.53) Page 3 of 114
Creating Field Mappings 50
Mapping Endpoint Fields 50
Mapping Field Values 58
Mapping Constant Values 60
Mapping Attachment Fields 61
Mapping Comments (JIRA Only) 61
Guidelines for Mapping Release and Cycle Fields 62
Setting Advanced LinkSettings 63
Setting Mail Notifications 63
Setting Adapter Parameters 64
Working with HP ALM Synchronizer 65
Viewing Link Details 66
Viewing Details for All Links 66
Viewing Details for a Specific Link 67
The Link Fields 68
Running Link Tasks 70
Running Link Tasks in Automatic Mode 70
Running Link Tasks Manually 71
Viewing Task Run History 73
Viewing Task Run Reports 74
Editing Synchronization Link Settings 77
Resetting a Link 78
Enabling and Disabling Synchronization Links 79
Deleting Synchronization Links 80
Automatic Backup of the Synchronizer Database 81
Restoring the Synchronizer Database 81
Exporting and Importing Link Definitions 81
Exporting Link Definitions 82
Importing Link Definitions 82
Exporting and Importing Link Data 82
Exporting Link Data 82
Importing Link Data 83
Configuring the Synchronizer Options 83
Configuring the Client Options 84
Configuring the Server Options 84
Changing Your Password 86
Working with JIRA 87
Guidelines for Working with JIRA 88
Link creation 88
User GuideHP ALM Synchronizer
HP ALM Synchronizer (12.53) Page 4 of 114
Required JIRA Permissions 90
JIRA User Permissions 90
Connecting to JIRA 90
Integrity Check Permissions 90
Synchronizing Comments 91
Administrative Permissions 91
JIRA Connection Properties 92
JIRA Data Types 92
JIRA Troubleshooting 93
Working with Rational ClearQuest 95
Guidelines for Working with Rational ClearQuest 96
Configuring the Permissible State Changes 96
Setting ClearQuest Defects as Duplicate 98
Synchronizer Settings for ClearQuest 100
ClearQuest Connection Properties 100
ClearQuest Mandatory and Recommended Fields 100
ClearQuest Adapter Parameters 101
Working with Rational RequisitePro 103
Guidelines for Working with Rational RequisitePro 104
RequisitePro Connection Properties 104
Working with Team Foundation Server (TFS) 105
Guidelines for Working with TFS 106
TFS Connection Properties 106
Connection Properties for TFS (Including TFS 2015 On-premise) 106
Connection Properties for TFS 2015 in the Cloud (as of TFS 2015) 106
Requirement Synchronization with TFS 107
Enabling Folder Synchronization 107
Requirement Synchronization with TFS Work Items 107
Configuring the TFS Properties 109
Field Type Mapping 111
Send Us Feedback 113
User GuideHP ALM Synchronizer
HP ALM Synchronizer (12.53) Page 5 of 114
HP ALM Synchronizer User GuideWelcome toHP ALM Synchronizer. Synchronizer enables you to synchronize HP Application LifecycleManagement (ALM) data with data in another application.
You can synchronize between ALM and the following products:
Endpoints that synchronize with ALM Defects Requirements
Atlassian JIRA issues (including default, customized, and user-defined).
This includes both on-premise and the Atlassian Cloud version of JIRA(JIRAon Demand).
IBM Rational ClearQuest
IBM Rational Requisite Pro
Microsoft Team Foundation Server (TFS).
This includes both on-premise and TFS in the cloud (certified VisualStudio Team Services).
ALM defects and requirements
Note: For information on system requirements, supported environments, and technicalspecifications, see HP ALM Synchronizer Technical Specifications on HP Live Network.
This guide describes how to create and manage synchronization links, and how to run tasks on theselinks.
Note: The usage of HP ALM Synchronizer or HP ALM Synchronizer Adapter SPIto develop anadapter for HP ALM is not supported.
How This Guide is OrganizedThe HP ALM Synchronizer User Guide contains the following chapters:
"Getting Started" on page 9 How to start Synchronizer and introduces the Synchronizerwindow.
"Synchronizing at a Glance" onpage 19
Overview of working with Synchronizer.
HP ALM Synchronizer (12.53) Page 6 of 114
"Creating SynchronizationLinks" on page 29
How to create synchronization links for synchronizing databetween ALM and other applications, or between two ALMprojects.
"Working with HP ALMSynchronizer" on page 65
How to run tasks on synchronization links, manage synchronizationlinks, and configure Synchronizer.
"Working with JIRA" on page87
Notes and limitations specific to synchronizing defects andrequirements between ALM and JIRA.
"Working with RationalRequisitePro" on page 103
Notes and limitations specific to synchronizing requirementsbetween ALM and Rational RequisitePro.
"Working with TeamFoundation Server (TFS)" onpage 105
Notes and limitations specific to synchronizing requirementsbetween ALM and Microsoft Team Foundation Server.