Micro Focus ALM Synchronizer User Guide

112 Pages·2017·0.89 MB·English

by  Micro Focus

ALM Synchronizer
SoftwareVersion:12.60
User Guide
Go to HELP CENTER ONLINE
http://admhelp.microfocus.com/alm
DocumentRelease Date:March 2019 |Software Release Date:August2018
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.60) Page 2 of112
Contents
ALM Synchronizer 1
WelcometoThisGuide 6
GettingStarted 7
StartingandStoppingtheSynchronizerService 7
StartingtheSynchronizerClient 8
ConnectingtotheSynchronizerServer 9
TheSynchronizerClientWindow 9
SynchronizerClientWindowToolbarButtonsandMenuOptions 10
ManagingUsers 13
SynchronizingataGlance 15
AboutSynchronizingataGlance 15
SynchronizationLinks 15
TimeStamp,IdentityMappings,andRecordVersions 16
CycleRedundancyChecks 16
IntegrityChecks 17
ChecksPerformedonGeneralLinkSettings 18
ChecksPerformedonLinkFieldMappings 19
IncrementalSynchronization 21
FullSynchronization 22
WorkingwithALMVersionControl 22
CreatingSynchronizationLinks 25
AboutCreatingSynchronizationLinks 25
CreatingLinks 26
SettingGeneralLinkProperties 27
Setting ALMEndpointConnectionProperties 28
Connecting toALMWhileCreatingaLink 30
Settingthe OtherEndpoint'sConnectionProperties 30
SettingEntityTypesforBoth Endpoints 31
SettingLinkProperties 32
GuidelinesforDefininganAlternateRootFolderinALM 33
SettingSchedulingOptions 34
SettingFilterOptions 35
CreatingRequirementTypeMappings 37
ConfiguringSynchronizationRules 38
ConfiguringRulesforDefectSynchronization 38
ConfiguringRulesforRequirementSynchronization 39
CreatingFieldMappings 42
MappingEndpointFields 42
MappingFieldValues 50
ALM Synchronizer(12.60) Page 3 of112
UserGuide
MappingConstantValues 53
MappingAttachmentFields 54
MappingComments(JIRAOnly) 55
GuidelinesforMappingReleaseandCycleFields 56
SettingAdvancedLink Settings 57
SettingMailNotifications 57
SettingConnectionTimeout(JIRAOnly) 58
SettingAdapterParameters 58
IgnoreChangestoParentRequirements 58
WorkingwithALMSynchronizer 59
ViewingLinkDetails 59
ViewingDetailsforAllLinks 59
ViewingDetailsforaSpecificLink 60
TheLinkFields 61
RunningLinkTasks 64
RunningLinkTasksinAutomaticMode 64
RunningLinkTasksManually 65
ViewingTaskRunHistory 67
ViewingTaskRunReports 68
EditingSynchronizationLinkSettings 71
ResettingaLink 72
EnablingandDisablingSynchronizationLinks 73
DeletingSynchronizationLinks 74
AutomaticBackupoftheSynchronizerDatabase 75
RestoringtheSynchronizerDatabase 75
ExportingandImportingLinkDefinitions 76
ExportingLinkDefinitions 76
ImportingLinkDefinitions 76
ExportingandImportingLinkData 77
ExportingLinkData 77
ImportingLinkData 77
ConfiguringtheSynchronizerOptions 78
ConfiguringtheClientOptions 78
ConfiguringtheServerOptions 78
ChangingYourPassword 80
WorkingwithJIRA 81
GuidelinesforWorkingwithJIRA 81
General 81
Localization 81
Linkcreation 81
Synchronization 82
Comments 83
ALM Synchronizer(12.60) Page 4 of112
UserGuide
RequiredJIRAPermissions 83
JIRAUserPermissions 83
ConnectingtoJIRA 84
IntegrityCheckPermissions 84
SynchronizingComments 85
AdministrativePermissions 85
JIRAConnectionProperties 86
JIRADataTypes 87
JIRAHierarchy 88
JIRATroubleshooting 89
WorkingwithRationalClearQuest 91
GuidelinesforWorkingwithRationalClearQuest 91
ConfiguringthePermissibleStateChanges 92
SettingClearQuestDefectsasDuplicate 93
SynchronizerSettingsforClearQuest 94
ClearQuestConnectionProperties 95
ClearQuestMandatoryandRecommendedFields 95
ClearQuestAdapterParameters 95
WorkingwithRationalRequisitePro 97
GuidelinesforWorkingwithRationalRequisitePro 97
RequisiteProConnectionProperties 98
WorkingwithRationalTeamConcert(RTC) 99
GuidelinesforWorkingwithRTC 99
Synchronization 99
Mapping 99
RTCConnectionProperties 100
SupportedRTCWorkItemFieldTypes 100
WorkingwithTeamFoundationServer(TFS) 103
GuidelinesforWorkingwithTFS 103
TFSConnectionProperties 103
ConnectionPropertiesforTFSOn-premise 104
ConnectionPropertiesforTFS2018intheCloud 104
RequirementSynchronizationwithTFS 104
EnablingFolderSynchronization 105
RequirementSynchronizationwithTFSWorkItems 105
ConfiguringtheTFSProperties 106
FieldTypeMapping 108
Send UsFeedback 111
ALM Synchronizer(12.60) Page 5 of112
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.60) Page 6 of112
Getting Started
Thischapterexplainshow to startALMSynchronizerand introducesthe
Synchronizerwindow.
Thischaptercontainsthe following topics:
• StartingandStoppingtheSynchronizerService 7
• StartingtheSynchronizerClient 8
• TheSynchronizerClientWindow 9
• SynchronizerClientWindowToolbarButtonsandMenuOptions 10
• ManagingUsers 13
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 59.
ALM Synchronizer(12.60) Page 7 of112
UserGuide
Getting Started
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 73.
3. On the Synchronizerservermachine,choose Start> Programs > ALM
Synchronizer > StopSynchronizer.
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
ALM Synchronizer(12.60) Page 8 of112
UserGuide
Getting Started
can create additional users.Formore information,see "Managing Users" on
page 13.
5. In the Passwordbox,type yourpassword.The initial password isblank.
Note:To increase the securityofyourSynchronizerdata,change the
password fromthe defaultblankpassword assoon aspossible.For
more information on changing the serverpassword,see "Changing Your
Password" on page 80.
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.
ALM Synchronizer(12.60) Page 9 of112
UserGuide
Getting Started
The Synchronizerclientwindow containsthe following keyelements:
Synchronizer menubar.Containsdrop-down menusofthe Synchronizer
l
commands.Fordetails,see "SynchronizerClientWindow ToolbarButtonsand
Menu Options" below.
Synchronizer toolbar.Containsbuttonsofcommandscommonlyused when
l
managing synchronization links.Fordetails,see "SynchronizerClientWindow
ToolbarButtonsand Menu Options" below.
Links list.Containsa listofthe synchronization linksavailable on the
l
Synchronizerserver.Located on the leftofthe Synchronizerclientwindow.
Link Details pane.Containsinformation aboutyoursynchronization links.Located
l
on the upperrightofthe Synchronizerclientwindow.
Executionpane.Containsinformation aboutlinktaskexecution.Located on the
l
bottomrightofthe Synchronizerclientwindow.
Fordetailson how to workwith the Synchronizerclientwindow,see "Viewing Link
Details" on page 59.
Synchronizer Client Window Toolbar Buttons and
Menu Options
Thissection describesthe menusand buttonsavailable in the Synchronizerclient
window.
Userinterface elementsare described below (unlabeled elementsare shown in
angle brackets):
UI Element (A -
 Z) Menu Description
Connection Connect/Disconnect.Connectsordisconnects
the Synchronizerclientto/fromthe
Synchronizerserver.
Link RefreshAll orRefreshSelected.Refreshesthe
displayofall,orselected,links.
Link Create.Enablesyou to create a linkusing the
Create Linkwizard.Fordetails,see "Creating
Links" on page 26.
Link Enable.Enablesthe selected link.Fordetails,
see "Enabling and Disabling Synchronization
Links" on page 73.
ALM Synchronizer(12.60) Page 10 of112