HPE ALM Synchronizer User Guide

120 Pages·2017·0.9 MB·English

ALM Synchronizer
SoftwareVersion:12.55SyncPack1
User Guide
Go to HELP CENTER ONLINE
http://admhelp.microfocus.com/alm
DocumentRelease Date:May2018 |Software Release Date:February2018
UserGuide
ALM Synchronizer
Legal Notices
Disclaimer
Certainversionsofsoftwareand/ordocuments(“Material”)accessibleheremaycontainbrandingfrom
Hewlett-PackardCompany(nowHPInc.)andHewlettPackardEnterpriseCompany. AsofSeptember1,
2017,theMaterialisnowofferedbyMicroFocus,aseparatelyownedandoperatedcompany. Any
referencetotheHPandHewlettPackardEnterprise/HPEmarksishistoricalinnature,andtheHPand
HewlettPackardEnterprise/HPEmarksarethepropertyoftheirrespectiveowners.
Warranty
TheonlywarrantiesforproductsandservicesofMicroFocusanditsaffiliatesandlicensors(“MicroFocus”)
aresetforthintheexpresswarrantystatementsaccompanyingsuchproductsandservices.Nothingherein
shouldbeconstruedasconstitutinganadditionalwarranty.MicroFocusshallnotbeliablefortechnicalor
editorialerrorsoromissionscontainedherein.Theinformationcontainedhereinissubjecttochangewithout
notice.
Restricted RightsLegend
ContainsConfidentialInformation.Exceptasspecificallyindicatedotherwise,avalidlicenseisrequiredfor
possession,useorcopying.ConsistentwithFAR12.211and12.212,CommercialComputerSoftware,
ComputerSoftwareDocumentation,andTechnicalDataforCommercialItemsarelicensedtotheU.S.
Governmentundervendor'sstandardcommerciallicense.
Copyright Notice
©Copyright2002-2018MicroFocusoroneofitsaffiliates.
TrademarkNotices
Adobe™isatrademarkofAdobeSystemsIncorporated.
Microsoft®andWindows®areU.S.registeredtrademarksofMicrosoftCorporation.
UNIX®isaregisteredtrademarkofTheOpenGroup.
OracleandJavaareregisteredtrademarksofOracleand/oritsaffiliates.
ALM Synchronizer(12.55 SyncPack1) Page 2 of120
Contents
ALM Synchronizer 1
WelcometoThisGuide 6
GettingStarted 7
StartingandStoppingtheSynchronizerService 8
StartingtheSynchronizerClient 9
ConnectingtotheSynchronizerServer 10
TheSynchronizerClientWindow 10
SynchronizerClientWindowToolbarButtonsandMenuOptions 11
ManagingUsers 14
SynchronizingataGlance 17
AboutSynchronizingataGlance 18
SynchronizationLinks 18
TimeStamp,IdentityMappings,andRecordVersions 19
CycleRedundancyChecks 19
IntegrityChecks 20
ChecksPerformedonGeneralLinkSettings 20
ChecksPerformedonLinkFieldMappings 22
IncrementalSynchronization 23
IncrementalSynchronization 24
FullSynchronization 25
FullSynchronization 26
WorkingwithALMVersionControl 26
CreatingSynchronizationLinks 29
AboutCreatingSynchronizationLinks 30
CreatingLinks 31
SettingGeneralLinkProperties 32
Setting ALMEndpointConnectionProperties 32
Connecting toALMWhileCreatingaLink 34
Settingthe OtherEndpoint'sConnectionProperties 34
SettingEntityTypesforBoth Endpoints 35
SettingLinkProperties 36
GuidelinesforDefininganAlternateRootFolderinALM 37
SettingSchedulingOptions 38
SettingFilterOptions 39
CreatingRequirementTypeMappings 41
ConfiguringSynchronizationRules 42
ConfiguringRulesforDefectSynchronization 42
ConfiguringRulesforRequirementSynchronization 43
CreatingFieldMappings 46
ALM Synchronizer(12.55 SyncPack1) Page 3 of120
UserGuide
MappingEndpointFields 46
MappingFieldValues 54
MappingConstantValues 57
MappingAttachmentFields 58
MappingComments(JIRAOnly) 59
GuidelinesforMappingReleaseandCycleFields 60
SettingAdvancedLink Settings 61
SettingMailNotifications 61
SettingConnectionTimeout(JIRAOnly) 62
SettingAdapterParameters 62
IgnoreChangestoParentRequirements 62
WorkingwithALMSynchronizer 63
ViewingLinkDetails 64
ViewingDetailsforAllLinks 64
ViewingDetailsforaSpecificLink 64
TheLinkFields 65
RunningLinkTasks 68
RunningLinkTasksinAutomaticMode 68
RunningLinkTasksManually 69
ViewingTaskRunHistory 71
ViewingTaskRunReports 72
EditingSynchronizationLinkSettings 75
ResettingaLink 76
EnablingandDisablingSynchronizationLinks 77
DeletingSynchronizationLinks 78
AutomaticBackupoftheSynchronizerDatabase 79
RestoringtheSynchronizerDatabase 79
ExportingandImportingLinkDefinitions 80
ExportingLinkDefinitions 80
ImportingLinkDefinitions 80
ExportingandImportingLinkData 81
ExportingLinkData 81
ImportingLinkData 81
ConfiguringtheSynchronizerOptions 82
ConfiguringtheClientOptions 82
ConfiguringtheServerOptions 82
ChangingYourPassword 84
WorkingwithJIRA 85
GuidelinesforWorkingwithJIRA 86
General 86
Localization 86
Linkcreation 86
ALM Synchronizer(12.55 SyncPack1) Page 4 of120
UserGuide
Synchronization 87
Comments 88
RequiredJIRAPermissions 88
JIRAUserPermissions 88
ConnectingtoJIRA 88
IntegrityCheckPermissions 89
SynchronizingComments 90
AdministrativePermissions 90
JIRAConnectionProperties 91
JIRADataTypes 92
JIRAHierarchy 92
JIRATroubleshooting 94
WorkingwithRationalClearQuest 95
GuidelinesforWorkingwithRationalClearQuest 96
ConfiguringthePermissibleStateChanges 97
SettingClearQuestDefectsasDuplicate 98
SynchronizerSettingsforClearQuest 99
ClearQuestConnectionProperties 100
ClearQuestMandatoryandRecommendedFields 100
ClearQuestAdapterParameters 100
WorkingwithRationalRequisitePro 103
GuidelinesforWorkingwithRationalRequisitePro 104
RequisiteProConnectionProperties 104
WorkingwithRationalTeamConcert(RTC) 107
GuidelinesforWorkingwithRTC 108
Synchronization 108
Mapping 108
RTCConnectionProperties 109
SupportedRTCWorkItemFieldTypes 109
WorkingwithTeamFoundationServer(TFS) 111
GuidelinesforWorkingwithTFS 112
TFSConnectionProperties 112
ConnectionPropertiesforTFSOn-premise 112
ConnectionPropertiesforTFS2018intheCloud 113
RequirementSynchronizationwithTFS 113
EnablingFolderSynchronization 113
RequirementSynchronizationwithTFSWorkItems 114
ConfiguringtheTFSProperties 115
FieldTypeMapping 117
Send UsFeedback 119
ALM Synchronizer(12.55 SyncPack1) Page 5 of120
Welcome to This Guide
Welcome to ALMSynchronizer.Synchronizerenablesyou to synchronize Application
Lifecycle Management(ALM)data with data in anotherapplication.
Thisguide describeshow to create and manage synchronization links,and how to run
taskson these links.
Forinformation on systemrequirements,supported environments,and technical
specifications,see ALMSynchronizerTechnical Specifications.
Note:The usage of ALMSynchronizeror ALMSynchronizerAdapterSPI to
develop an adapterfor ALMisnotsupported.
ALM Synchronizer(12.55 SyncPack1) Page 6 of120
Getting Started
Thischapterexplainshow to startALMSynchronizerand introducesthe
Synchronizerwindow.
Thischaptercontainsthe following topics:
• StartingandStoppingtheSynchronizerService 8
• StartingtheSynchronizerClient 9
• TheSynchronizerClientWindow 10
• SynchronizerClientWindowToolbarButtonsandMenuOptions 11
• ManagingUsers 14
ALM Synchronizer(12.55 SyncPack1) Page 7 of120
UserGuide
Getting Started
Starting and Stopping the Synchronizer Service
Thissection describeshow to startand stop the Synchronizerservice.
To start the Synchronizer service:
1. Prerequisites:
a. You startthe Synchronizerservice fromthe Synchronizerservermachine.
The Synchronizerservice mustbe running to workwith the Synchronizer
client.
b. Ifyou encounterproblemsstarting the Synchronizerservice,referto the
Micro FocusALMSynchronizerInstallation Guide fortroubleshooting
suggestions.
2. On the Synchronizerservermachine,choose Start> Programs > ALM
Synchronizer > StartSynchronizer.
Note:The Synchronizerservice isstarted in the background.Itmaytake
a few minutesbefore the Synchronizerclientcan connectto the server.
To stop the Synchronizer service:
1. Prerequisite.You stop the Synchronizerservice fromthe Synchronizerserver
machine.
2. Make sure thatno tasksare running foranylink.You can checkwhetherlink
tasksare currentlyrunning fromthe Runningfield in the LinksGrid.Formore
information on the LinksGrid,see "Viewing LinkDetails" on page 64.
Tip:To ensure thatno taskscan run on anylink,disable all linksbefore
you stop the Synchronizerservice.Formore information on disabling
links,see "Enabling and Disabling Synchronization Links" on page 77.
3. On the Synchronizerservermachine,choose Start> Programs > ALM
Synchronizer > StopSynchronizer.
ALM Synchronizer(12.55 SyncPack1) Page 8 of120
UserGuide
Getting Started
Starting the Synchronizer Client
Afteryou have installed the Synchronizerserverand client,and started the server,
you can startthe Synchronizerclientand connectto the server.
Notes
You can workwith more than one clientconnected to the serveratthe
l
same time.To avoid unexpected results,ifyou workwith more than one
client,you mustmake sure thatno linkisworked on bymore than one
clientatthe same time.
The Synchronizerclientisautomaticallydisconnected fromthe
l
Synchronizerserverafteran extended period ofinactivity.Forinformation
on reconnecting,see "Connecting to the SynchronizerServer" on the next
page.
To startthe Synchronizerclient:
1. On the Synchronizerclientmachine,choose Start> Programs > ALM
Synchronizer Client> ALM Synchronizer Client.The Connectto Synchronizer
Serverdialog boxopens.
2. In the Server nameand Portboxesrespectively,type the machine name and
portofthe Synchronizerserverto which you wantto connect.
Tip:To connectto a Synchronizerserverinstalled on yourlocal machine,
type localhost.
3. Selectthe UseHttps checkboxifyou wantto use HypertextTransferProtocol
Secure (HTTPS)fora secure connection between the Synchronizerserverand
the Synchronizerclient.
4. In the User Namebox,type yourusername.
The firsttime you connectto a Synchronizerserver,you mustlog in asthe
Synchronizeradministrator,with the username admin.Afteryou connect,you
can create additional users.Formore information,see "Managing Users" on
page 14.
5. In the Passwordbox,type yourpassword.The initial password isblank.
Note:To increase the securityofyourSynchronizerdata,change the
password fromthe defaultblankpassword assoon aspossible.For
ALM Synchronizer(12.55 SyncPack1) Page 9 of120
UserGuide
Getting Started
more information on changing the serverpassword,see "Changing Your
Password" on page 84.
6. ClickConnect.The Synchronizerconnectsto the serveryou specified and the
Synchronizerclientopens.
Tip:To close the Synchronizerclient,choose Connection> Exit.
Connecting to the Synchronizer Server
You can disconnectfromthe Synchronizerservermanuallywhen needed.For
example,you maywantto connectto a differentserver.Additionally,ifyou receive
a warning thatthe Synchronizerclientisnotconnected to the server,you need to
manuallydisconnectfromthe Synchronizerserver.Thiscan occur,forexample,
afteran extended period ofinactivity.
Afteryou disconnectfroma server,you mustconnectto anotherserveror
reconnectto the same serverto continue working with the Synchronizer.
To disconnectfrom,and reconnectto,a Synchronizerserver:
1. SelectConnection> Disconnect,orclickthe Disconnect button.The Connect
to SynchronizerServerdialog boxopens.
2. Clickthe Disconnectbutton.The Server name,User Name,and Passwordboxes
become editable.
3. Enterthe logon credentialsasdescribed in step 2 in "Starting the Synchronizer
Client" on the previouspage.
4. Clickthe Connectbutton.The Synchronizerconnectsto the serveryou
specified and the Synchronizerclientopens.
The Synchronizer Client Window
The Synchronizerclientenablesyou to manage the synchronization linksstored in
the Synchronizerdatabase.Formore information on starting the Synchronizer
client,see "Starting the SynchronizerClient" on the previouspage.
The Synchronizerclientwindow containsthe following keyelements:
Synchronizer menubar.Containsdrop-down menusofthe Synchronizer
l
commands.Fordetails,see "SynchronizerClientWindow ToolbarButtonsand
Menu Options" on the nextpage.
Synchronizer toolbar.Containsbuttonsofcommandscommonlyused when
l
managing synchronization links.Fordetails,see "SynchronizerClientWindow
ALM Synchronizer(12.55 SyncPack1) Page 10 of120