Blueprint ALM Integration Configuration Guide

16 Pages·2016·0.29 MB·English

by  Blueprint Software Systems

http://documentation.blueprintcloud.com
ALM Integration with Blueprint 7.3
Configuration Guide
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 8/24/2016
Contents
Overview 3
SystemRequirements 4
ApplicationRequirements 4
UserRequirements 4
MicrosoftTFS Integration 4
HPALMIntegration 4
Configuration 5
Step1:ConfiguretheALM systemsoBlueprintcanaccessit 5
ConfiguringALM Integration(withBlueprintCloud) 5
ConfiguringHPALMIntegration(withOn-PremiseBlueprintInstallation) 6
ConfiguringMicrosoftTFSIntegration(withOn-PremiseBlueprintInstallation) 6
Step2:ConfigureBlueprinttoconnecttotheALMsystem 8
AddingALM TargetstoBlueprint 8
GrantingaccesstoALMTargets 12
Appendix 13
VerifyingtheALMIntegrationConfiguration 13
ConfiguringtheBlueprintDeletedfieldinyourALM system 14
CreatingtheBlueprintDeletedfieldinHPALM 14
CreatingtheBlueprintDeletedfieldinTFS 14
Blueprint.DeletedField 15
Blueprint.FolderField 15
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 2of16
Overview
ThisALMIntegrationConfigurationGuideisapplicableifyouwanttointegrateBlueprintwithanApplication
LifecycleManagement(ALM)system,suchasHPALM,orMicrosoftTeamFoundation Server(TFS).
ThisguideprovidesinstructionsforconfiguringALMintegrationsouserscanexportartifactsfromBlueprinttothe
ALMsystem.
Note:ALMintegrationisaseparatelylicensedcomponent.Pleasecontactcustomersupportifyouwishto
purchasealicensetousethisfunctionality.
Important:AsofBlueprint5.1.1,ALMadapterlicensinghaschangedtoprovidelicenseenforcement
basedonyourspecificlicensedetails.PleasecontactBlueprintcustomersupportifyouexperienceissues
withALM integrationafterupgradingtoBlueprint5.1.1.
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 3of16
System Requirements
Application Requirements
Note:IntegrationwiththefollowingversionsofHP ALM isonlyavailableifthe HP legacy32-bitconnector
hasbeeninstalled.
BlueprintsupportsintegrationwiththefollowingALMsystems:
HPALM11
Note:TheBlueprintREST API doesnotsupportHP ALM version11.NativesupportforHP ALM 11
isavailablethroughtheCOM libraryandCloudConnect.
HPALM 11.5
HPALM 11.52
HP ALM 12
MicrosoftTeamFoundationServer2010
MicrosoftTeamFoundationServer2012
MicrosoftTeamFoundationServer2013
User Requirements
Microsoft TFS Integration
IfyouwanttointegrateBlueprintwithTFS,theBlueprintServerUsermusthaveread/writepermissionstothe
followinglocation:
C:\ProgramData\Microsoft\Team Foundation
Note:ThesepermissionsarerequiredbecausetheMicrosoftTFSAPIsrequireaccesstothisfolder.
HP ALM Integration
Noadditionaluserrequirementshavebeenidentifiedatthistime.
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 4of16
Configuration
ALMIntegrationwith BlueprintrequiressomeconfigurationofboththeALMsystemandBlueprint:
Step1:ConfiguretheALM systemsoBlueprintcanaccessit
Step2:ConfigureBlueprinttoconnecttotheALMsystem
Step 1: Configure the ALM system so Blueprint can access it
TheconfigurationoftheALM systemdiffersslightlydependingonwhetheryouareusingthehostedBlueprint
cloudsolutionoranon-premiseinstallationofBlueprint:
ConfiguringALM Integration(withBlueprintCloud):Followtheseconfigurationinstructionsifyouuse
blueprintcloud.com.TheseconfigurationinstructionsareapplicableforintegrationwithHPALMandTFS.
ConfiguringHPALMIntegration(withOn-PremiseBlueprintInstallation):Followtheseconfiguration
instructionsifyouhaveanon-premiseinstallationofBlueprintandyouwanttointegrateBlueprintwithHP
ALM.
ConfiguringMicrosoftTFSIntegration(withOn-PremiseBlueprintInstallation):Followtheseconfiguration
instructionsifyouhaveanon-premiseinstallationofBlueprintandyouwanttointegrateBlueprintwithTFS.
Configuring ALM Integration (with Blueprint Cloud)
TheonlywaytointegrateyourALMsystemwith BlueprintcloudistoopenyourfirewalltoallowBlueprintcloudto
accessyourinternalALM server.
Important:TheHPALMlibrariesarewebserverspecific.ThedefaultBlueprintCloudserversare
currentlyconfiguredtoONLYworkwithHPALM11.
ToconfigureALMIntegrationwithBlueprintCloud:
Note:Thesechangesrequiremodificationstothefirewallandneedtobeperformedbyyournetwork
administrator.
1. ObtainapublicaccessibleInternetIP addressforyourorganization.
2. CreateaNATruleontheexternalfirewalltoallowaccessfromexternalIPaddressestoyourinternal
ALM server.
AllowtheALM port(default: 8080)accesstotheinternalALM server.
3. TestyourconnectionfromanExternalIP.
4. (Optional)Inordertosecuretheconnection(whilemaintainingcommunicationbetweentheBlueprint
CloudserverstoyourALM server),changethefirewallruletoonlyallowBlueprintCloudIPaddressaccess
throughtheNATrule.YoucanobtaintheBlueprintCloudexternalIP addressbypingingthesitename
(example:pingcustomer.blueprintcloud.com).
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 5of16
Configuring HP ALM Integration (with On-Premise Blueprint
Installation)
Tointegrateanon-premiseinstallationofBlueprintwithHPALM,youmustinstallsomeDLL filesthatfacilitate
communicationbetweentheBlueprintserverandyourALM server.
ToconfigureHPALM,installtheDLL filesbyperformingthefollowingsteps:
1. Right-clickInternetExplorerandselectRunAsAdministrator.
2. LaunchtheHPclientsitefromtheBlueprintwebserver.Example:http://<servername>/almbin/
3. ClickTools.
Note:OntheHPALM version11clientsite,clickAdd-inspage.
4. ClickHPALM Connectivity.
Note:ForHP ALM version11,clickHPQualityCenterConnectivity.
5. ClicktheDownloadlink.
6. DownloadandinstallTDConnect.exe.
Configuring Microsoft TFS Integration (with On-Premise Blueprint
Installation)
Tointegrateanon-premiseinstallationofBlueprintwithTFS,youmustinstallsomeDLLfilesthatfacilitate
communicationbetweentheBlueprintserverandTFSserver.
ToconfigureTFS,installtheDLL filesbyperformingthefollowingsteps:
1. InstallVisualStudioTeamExplorer.ThispackagecontainstheDLLfilesthatarerequiredforexporting
BlueprintartifactstoTFS.
2. InstallVisualStudioTestManager.Thisadd-incontainstheDLLfilesthatarerequiredforexporting
generatedteststoTFS.
3. (Recommended)TurnofftheJust-In-Time(JIT)debugger:
Note:AfteryouinstallTeamExplorer,theJIT debuggerisenabledbydefault.Wehighly
recommendthatyoudisablethisfeature.IftheJIT debuggerisenabled,itattemptstocatchand
debuganyUnhandledExceptions,sometimescausingtheprocesstohang.
1. LaunchVisualStudioTeamExplorerastheAdministrator(thatis,usingtheRunasadministrator
option).
2. ClicktheDebugmenuandselectOptionsandSettings.
3. UnderDebugging,selectJust-In-Time.
4. Clearthefollowingoptions:
Managed
Native
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 6of16
Script
5. ClickOKtosaveyourchanges.
4. CompletethefollowingifyouarerunningVisualStudio2012TeamExplorerontheBlueprintWeb
ApplicationServer:
Important:TheseadditionalstepsareonlyrequiredifyouareonlyrunningVisualStudio2012
TeamExplorerontheBlueprintWebApplicationServer.Thesestepsarenotrequiredifyouare
runningbothVisualStudio2010TeamExplorerandVisualStudio2012TeamExploreronthe
BlueprintWebApplicationServer.
1. StoptheBlueprintapplicationpoolandBlueprintwebsite.
Note:YourBlueprintapplicationpoolandBlueprintwebsitemayhavedifferentnames,
dependingonwhatyouchoseduringinstallation.
2. OpentheBlueprintWeb.configfileinatexteditorandverifythatyouhavepermissionstoedit
thefile.
Note
TheWeb.configfileislocatedintheWebfolderwhereyouinstalledBlueprint.The
defaultpathis:
C:\Program Files\Blueprint Software
Systems\Blueprint\Web\Web.config
3. Uncommenttheelementsinthe<runtime>sectionatthebottomofthefilebyremovingthe<!--
and-->textshownbelow:
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="log4net"
publicKeyToken="1b44e1d426115821" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-1.2.10.0"
newVersion="1.2.11.0" />
</dependentAssembly>
<!--Enable the code block below to use TFS version 2012 instead
of version 2010-->
<!--
<dependentAssembly>
<assemblyIdentity name="Microsoft.TeamFoundation.Client"
publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="10.0.0.0-10.65535.65535.65535"
newVersion="11.0.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.TeamFoundation.Common"
publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="10.0.0.0-10.65535.65535.65535"
newVersion="11.0.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity
name="Microsoft.TeamFoundation.VersionControl.Client"
publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="10.0.0.0-10.65535.65535.65535"
newVersion="11.0.0.0" />
</dependentAssembly>
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 7of16
<dependentAssembly>
<assemblyIdentity
name="Microsoft.TeamFoundation.TestManagement.Common"
publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="10.0.0.0-10.65535.65535.65535"
newVersion="11.0.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity
name="Microsoft.TeamFoundation.TestManagement.Client"
publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="10.0.0.0-10.65535.65535.65535"
newVersion="11.0.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity
name="Microsoft.TeamFoundation.WorkItemTracking.Client"
publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="10.0.0.0-10.65535.65535.65535"
newVersion="11.0.0.0" />
</dependentAssembly>
-->
</assemblyBinding>
</runtime>
4. SavetheWeb.configfile.
5. FirststarttheBlueprintapplicationpoolandthenstarttheBlueprintwebsite.
Step 2: Configure Blueprint to connect to the ALM system
ProjectadministratorswiththeapplicableprivilegescanconfigureALMtargetssouserscanexportBlueprint
artifactstootherApplicationLifecycleManagement(ALM)systems.
ProjectadministratorswiththeapplicableprivilegescansettheALMsecuritysettingstocontrolwhichusershave
accesstoALMtargets.
WhenusersareperforminganALMExportorgenerateaTestPlan,theycanchoosefromapre-populatedlistof
ALM Targets.TheALMTargetsthatappearinthelistisdifferentforeachuser,dependingonwhethertheyhave
accesstothetargets.ALMSecurityallowsprojectadministratorstocontrolwhichALMTargetsappearforeach
user.
SettingupALM TargetsinBlueprintisatwostepprocess:
1. AddtheALMtargettoBlueprint
2. GrantusersaccesstotheALM target
Adding ALM Targets to Blueprint
TocreateanewALM target:
1. OpentheALMTargetstab.
1. OpentheProjectAdministrationConsole.
2. ClickALM>ALM Targetsontheribbon(ProjectAdmintab,Projectgroup).
2. ClicktheNewbuttonontheribbon(ProjectAdmintab,Actionsgroup)andthenselectoneofthefollowing
options:
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 8of16
HPALM-COM:CreatesanewtargetconnectingBlueprinttoHP ALM versions11andlater.
HP ALM-REST: CreatesanewtargetthatallowsyoutoconnectBlueprinttoHP ALM versions11.5
andlaterusingtheBlueprintREST API.
TFSTarget:CreatesanewTFStarget.
FromExistingProject:CreatesanewALMtargetbasedonanexistingtargetinanotherproject.If
youselectthisoption,youmustchooseaspecifictargetfromanotherproject.
eitheror.
AnewALMTargetisadded.Thedetailsappearontherightmostsideofthescreen.
3. TypeaNameforthenewtarget.
4. SetthetargetLocation:
1. Clickthe button.TheALM ConnectionEditordialogappears.
2. TypetheURLoftheALM server(example:http://bps-alm10:8080/almbinor
http://vmdev:8080/tfs)
Note:IfyouareaccessingtheALM serverfromtheBlueprintCloud,ensurethatyou
specifytheexternalIP address(insteadoftheinternalIP).
3. SpecifyavalidUserName.
4. SpecifyavalidPassword.
5. ClicktheConnectbutton.
IfyouarecreatinganHPALMTarget,theConnectbuttonpre-populatestheDomainandProject
fieldswithvalidoptions.
IfyouarecreatingaTFSTarget,theConnectbuttonpre-populatestheTeamProjectCollectionand
TeamProjectfieldswithvalidoptions.
6. Performoneofthefollowingactions:
IfyouarecreatinganHP ALM Target:
SelecttheappropriateDomainandProject
Selectyourdesiredbehaviorfordeletedartifacts:
HowdoyouwantBlueprinttohandleartifactsthataredeletedwhen
exportingtoHPALM?:Therearetwooptions:
Flagthemonly(via'BlueprintDeleted'):ThisoptionsetstheBlueprint
DeletedfieldtoYinyourALM systemifitemsaredeletedinBlueprint.
Inotherwords,artifactsarenotdeletedinyourALMsystemevenif
theyaredeletedinBlueprint.
Note:ThisoptionrequiresthatyouhaveaBlueprintDeleted
fieldconfiguredinyourALM system.Formoreinformation,
refertothesectiontitled'ConfiguringtheBlueprintDeleted
fieldinyourALM system'.
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 9of16
Deletethem:ThisoptiondeletesartifactsinyourALM systemwhen
artifactsaredeletedinBlueprintandthechangesareexportedtothe
ALM system.
IfyouarecreatingaTFSTarget:
SelecttheappropriateTeamProjectCollectionandTeamProject
7. ClickOK.
5. ConfigureyourtargetoptionsbyclickingtheTargetOptionsbutton.
ThefollowingoptionsareavailableforHPALMTargets:
HowdoyouwantBlueprinttohandleartifactsthataredeletedwhenexportingtoHPALM?:
Therearetwooptions:
Flagthemonly(via'BlueprintDeleted'):ThisoptionsetstheBlueprintDeletedfieldtoYin
yourALM systemifitemsaredeletedinBlueprint.Inotherwords,artifactsarenotdeletedin
yourALMsystemeveniftheyaredeletedinBlueprint.
Note:ThisoptionrequiresthatyouhaveaBlueprintDeletedfieldconfiguredin
yourALM system.Formoreinformation,refertothesectiontitled'Configuringthe
BlueprintDeletedfieldinyourALM system'.
Deletethem:ThisoptiondeletesartifactsinyourALM systemwhenartifactsaredeletedin
BlueprintandthechangesareexportedtotheALM system.
DoyouwantBlueprinttocreateahyperlinkforeachBlueprintrelationshipsoyoucaneasily
accessrelatedBlueprintartifactsfromtheALM system?:Ifenabled,eachexportedartifactwill
containahyperlinktoeachrelatedartifactinBlueprint.Ifdisabled,theexportedartifactswillstill
containahyperlinkbacktotheartifactinBlueprint,butwillnotcontainhyperlinkstorelated
artifacts.
DoyouwantBlueprinttoexportthefullartifacthierarchyfromtherootlevel?:Ifenabled,
Blueprintexportsallfoldersneededtoshowtheartifacthierarchyfromtherootleveltoeach
exportedartifact.
DoyouwanttheChangeSummarytoonlyreportconflictsrelatedtoartifactsthatarebeing
exportedtotheALMsystem?:Ifenabled,conflictsareonlyreportedifyouareexportingthat
particularartifacttotheALMsystem.
DoyouwantBlueprinttomaintaintheBlueprinthierarchyofartifactsafterexportingtoHP
ALM?:Ifenabled,BlueprintexportsartifactswithoutimpactingamodifiedartifacthierarchyinALM.
Inotherwords,youcanmoveoralterthehierarchyofartifactsinALMandmaintainthatstructure
afterre-exportingtheartifactsfromBlueprint.Thisfeatureallowsyoutomaintainacustom
structureinALMandstilltakeadvantageofBlueprint’sabilitytoexportartifactchanges.
DoyouwanttoexporttextfieldswithRichTextformatting?:Ifenabled,Blueprintexportstext
fieldswithfullrichtextformatting.Ifthisoptionisnotenabled,Blueprintexportsplaintextonly.
Whatwouldyoulikethe"ExportPath"settobydefaultintheExportWizard?:Allowsyouto
maketheexporteasierforusersbysettingadefaultexportpath.Iftheuserdoesnotexplicitlyset
anexportpath,thisdefaultwillbeusedfortheexport.
ThefollowingoptionsareavailableforTFSTargets:
©2016BlueprintSoftwareSystemsInc.Allrightsreserved 10of16