Table Of ContentWeb User Guide
Version 2018.4
Copyrights
©1996-2018PerforceSoftware,Inc.anditssubsidiaries.Allrightsreserved.
DefectScribe,HelixALM,HelixALMSuite,HelixIssueManagement,HelixRequirementsManagement,HelixTestCaseManagement,
QAWizardPro,ResourceThief,SoloBug,SoloSubmit,SurroundSCM,andTestTrackaretrademarksorregisteredtrademarksof
PerforceSoftware,Inc.anditssubsidiariesintheUnitedStatesandothercountries.
AcrobatReaderisaregisteredtrademarkofAdobe,Inc.intheUnitedStatesandothercountries.
UNIXisaregisteredtrademarkintheUnitedStatesandothercountries,licensedexclusivelythroughX/OpenCompanyLimited.
Apple,Mac,MacOS,macOS,Macintosh,Objective-C,andSafariareregisteredtrademarksofAppleComputer,Inc.
ChromeisaregisteredtrademarkofGoogleInc.
DebianisaregisteredtrademarkofSoftwareinthePublicInterest,Inc.
FirefoxisaregisteredtrademarkoftheMozillaFoundation.
LinuxisatrademarkofLinusTorvalds.
Microsoft,Windows,WindowsServer,WindowsVista,MSWindows,ActiveDirectory,InternetExplorer,Outlook,SQLServer,Visual
SourceSafe,andVisualStudioareeitherregisteredtrademarksortrademarksofMicrosoftCorporationintheUnitedStatesand/or
othercountries.
openSUSEandSUSEareregisteredtrademarksofNovellInc.intheUnitedStatesandothercountries.
OracleandJavaareregisteredtrademarksofOracleand/oritsaffiliates.
RedHat,RedHatEnterpriseLinux,andFedoraareregisteredtrademarksofRedHat,Inc.intheUnitedStatesandothercountries.
UbuntuisaregisteredtrademarkofCanonicalLtd.
Allotherproductnamesmentionedhereinarethetrademarksoftheirrespectiveowners.Allothertrademarksarethepropertyoftheir
respectiveowners.
Nopartofthispublicationmaybereproduced,transmitted,transcribed,storedinaretrievalsystem,ortranslatedintoanylanguagein
anyformbyanymeanswithoutthewrittenpermissionofPerforceSoftware,Inc.anditssubsidiaries.
YourlicenseagreementwithPerforceSoftware,Inc.oranyofitssubsidiaries,whichisincludedwiththeproduct,specifiesthepermitted
andprohibitedusesoftheproduct.Anyunauthorizedduplicationoruseofthissoftware,inwholeorinpart,inprint,orinanyother
storageandretrievalsystemisforbidden.
InformationinthisdocumentissubjecttochangewithoutnoticeanddoesnotrepresentacommitmentonthepartofPerforceSoftware,
Inc.oranyofitssubsidiaries.Unlessotherwisenoted,allcompanies,products,streetaddresses,andpersonscontainedhereinare
purelyfictitious.Mentionofthird-partycompaniesandproductsisforinformationalpurposesonlyanddoesnotconstitutean
endorsement.
PerforceSoftware,Inc.anditssubsidiaries
400N1stAvenue
Suite200
Minneapolis,Minnesota55401
USA
+1510.864.7400
[email protected]
Contents
Welcome to Helix ALM 1
What's New 3
Getting Started 5
Loggingin 5
Switchingprojects 6
Usingmultiplebrowsertabs 6
Changingyourlocale 7
Changingyourpassword 7
Enteringelectronicsignatures 8
Loggingout 8
Interface Basics 11
Usingdashboards 13
Dashboardwidgettypes 16
Usingitemlists 21
Customizingitemlists 24
Changingitemlistcolumns 25
Usingitemlisttabs 26
Savingthecurrentitemlisttab 26
Openingsavedandshareditemlisttabs 28
Renamingthecurrentitemlisttab 29
Updatingsaveditemlisttabs 29
Managingsaveditemlisttabs 30
Addingsaveditemlisttabs 31
Duplicatingsaveditemlisttabs 33
Sharingsaveditemlisttabs 33
Changingasaveditemlisttabowner 34
Settingdefaultitemlisttabsforsecuritygroups 35
Exportingsaveditemlisttabs 36
Importingsaveditemlisttabs 36
Editinganddeletingsaveditemlisttabs 37
Aboutitemstatusindicators 37
Copyingitemnumbers 38
Finding Items 39
Goingtoarecentlyaccesseditem 39
Searchingforitems 40
i
Performingadvancedsearches 41
Searchexamples 42
Searchingalltextfields 43
UsingBooleanoperatorsinfilterandsearchrestrictions 43
Applyingfilters 44
Selectinginteractivefiltercriteria 45
Addingfilters 46
Usingrestrictionstonarrowfilterandsearchresults 47
Addingtextrestrictions 48
Addingversionrestrictions 50
Addingdaterangerestrictions 51
Addingintegerrestrictions 53
Addingdecimalnumberrestrictions 54
Addingsinglelistvaluerestrictions 55
Addingmultiplelistvaluesrestrictions 56
Addingconditionrestrictions 57
Addinguserrestrictions 58
Addingfolderrestrictions 60
Addingrequirementdocumentrestrictions 61
Addingtestvariantvaluerestrictions 63
Editingrestrictions 64
Deletingrestrictions 64
Editingfilters 64
Deletingfilters 65
Filteringlistcolumns 65
CreatingRSSfeeds 66
Searchingforusersandcustomersinfields 67
Managing Requirements 69
UsingtheRequirementDocumentslist 70
UsingtheRequirementslist 71
Addingrequirementdocuments 72
Addingrequirements 74
Defaultrequirementtypes 76
Movingrequirementsanddocumentsthroughtheworkflow 77
Defaultrequirementsanddocumentsworkflows 77
ii
Workingwithrequirementdocuments 78
Requirementanddocumentindicators 81
Usingrequirementdocumentviews 82
Savingthecurrentrequirementdocumentview 82
Applyingsavedrequirementdocumentviews 84
Updatingsavedrequirementdocumentviews 84
Managingsavedrequirementdocumentviews 85
Addingsavedrequirementdocumentviews 86
Duplicatingsavedrequirementdocumentviews 88
Sharingsavedrequirementdocumentviews 88
Changingasavedrequirementdocumentviewowner 89
Settingdefaultrequirementdocumentviewsforsecuritygroups 89
Exportingsavedrequirementdocumentviews 90
Importingsavedrequirementdocumentviews 91
Editinganddeletingsavedrequirementdocumentviews 91
Viewingrequirementdocumentdetails 92
Viewingrequirementdocumentsnapshots 94
Viewingallchangesbetweenrequirementdocumentsnapshots 95
Modifyingrequirementdocuments 96
Addingrequirementstodocuments 97
Addingnewrequirementstodocuments 97
Addingexistingrequirementstodocuments 98
Appendingrequirementstodocuments 99
Editingrequirementsdirectlyindocuments 99
Removingrequirementsfromdocuments 100
Unsharingrequirements 101
Viewingrequirements 101
Viewinghistoricalrequirementversions 104
Viewingallchangesbetweenrequirementversions 105
Viewingdocumentsthatrequirementsareincludedin 106
Reviewingrequirementsanddocuments 107
Addingrequirementanddocumentreviewnotes 108
Editinganddeletingrequirementanddocumentreviewnotes 109
Analyzingtheimpactofrequirementchanges 109
Performingimpactanalysis 110
iii
Editingrequirements 111
Changingrequirementtypes 113
Rollingbackrequirements 114
Duplicatingrequirements 114
Editingrequirementdocumentdetails 115
Duplicatingrequirementdocuments 118
Creatingrequirementdocumentsnapshots 119
Creatingissuesfromrequirements 120
Generatingtestcasesfromrequirements 121
Creatingnewrequirementsfromexistingrequirements 122
Deletingrequirements 123
Deletingrequirementdocuments 124
Managing Tests 125
UsingtheTestCaseslist 127
Addingtestcases 128
Enteringtestcasesteps 131
Enteringtestcasestepsingridview 131
Enteringtestcasestepsintextview 133
Testcaseandtestrunmarkupcodes 134
Addingattachmentstotestcasesteps 136
Addingsharedstepsfromothertestcases 136
Validatingtestcasesteps 137
Attachingautomatedtestscriptstotestcases 139
Managingtestvariants 140
Addingtestvariantstotestcases 141
Editingandremovingtestvariantsintestcases 142
Usingtestsuites 143
Settinguptestsuites 144
Addingtestsuites 146
Orderingitemsintestsuites 147
Managingtestsuites 148
Generatingtestrunsuites 149
Viewingthecompletionstatusoftestrunsuites 151
Movingtestcasesthroughtheworkflow 151
Defaulttestcasesworkflow 152
iv
UsingtheTestRunslist 153
Generatingtestruns 154
Resolvingtestrungenerationerrors 156
Regeneratingtestruns 156
Viewingtestruns 158
Runningtests 160
Enteringtestresultsingridview 160
Enteringtestresultsindetailgridview 161
Enteringtestresultsintextview 164
Addingrun-timetestvariantvalues 166
Editinganddeletingrun-timetestvariantvalues 166
Enteringoveralltestrunresults 167
Movingtestrunsthroughtheworkflow 168
Defaulttestrunsworkflow 168
Creatingissuesfromtestruns 169
Viewingtestrunstatus 170
Editingtestruns 171
Duplicatingtestruns 173
Deletingtestruns 174
Viewingtestcases 174
Editingtestcases 177
Duplicatingtestcases 179
Deletingtestcases 180
Managing Issues 181
UsingtheIssueslist 182
Addingissues 183
Addingadditionalissuereports 184
Movingissuesthroughtheworkflow 185
Defaultissuesworkflow 185
Viewingissues 186
Editingissues 188
Editinganddeletingadditionalissuereports 190
Duplicatingissues 190
Mergingissues 192
Creatingtestcasesfromissues 192
v
Creatingrequirementsfromissues 193
Deletingissues 193
Working with Related Items 195
Linkingexamples 195
Addinglinks 197
Defaultlinkdefinitions 198
Addingitemstoexistinglinks 198
Workingwithitemlinks 199
Viewinglinkediteminformationinitemlists 200
Editinganddeletinglinks 202
Workingwithsuspectitems 202
Markingitemsassuspect 202
Markingalldependentitemsassuspect 203
Investigatingsuspectdependencies 204
Clearingsuspectitems 205
Moving Items Through the Workflow 207
Addingworkfloweventstoitems 208
Assigningitems 209
Commentingonitems 210
Lockingitems 211
Viewingitemlockinformation 213
Viewingworkfloweventhistory 213
Viewingworkfloweventdetails 214
Viewingitemworkflowhistorydiagrams 215
Viewingworkitemhistory 216
Editinganddeletingworkfloweventsonitems 217
Watchingitemstobenotifiedaboutchanges 217
Viewingthewatcheditemslistandchangenotifications 218
Managinguserswatchingitems 219
Viewing ItemHistory 221
Viewingchangereports 221
Emailing fromHelix ALM 223
Viewingemail 224
Replyingtoemail 225
vi
Attaching Files 227
Viewinganddownloadingfileattachments 228
Viewingsourcefilesattachedtoitems 228
Formatting TextFields 231
Insertingimagesintextfields 232
Insertingtablesintextfields 233
Insertinghyperlinksintextfields 235
Insertingstampsintextfields 236
Organizing Items with Folders 237
Folderusageexamples 237
UsingtheFolderslist 238
Folderstree 239
Listtab 241
TaskBoardtab 245
Detailstab 246
Addingfolders 248
Enteringreleaseplanninginformationforfolders 249
Editingfolderdetails 250
Managingaccesstofolders 252
Lockingandunlockingfolders 257
Settingfolderpermissions 258
Addingitemstofolders 260
Movingitemsbetweenfolders 262
Viewingitemsinfolders 263
Editingitemsinfolders 264
Rankingitemsinfolders 264
Removingitemsfromfolders 265
Gettingstartedwithtaskboards 265
Taskboardcomponents 266
Usingtaskboards 269
Settingthetaskboardforafolder 272
Changingtaskboardswimlanegroupings 272
Viewingfolderhistory 277
Duplicatingafolderstructure 278
Movingfolders 278
vii
Deletingfolders 279
Running Reports 281
UsingtheReportslist 281
Reporttypes 282
Workingwithsecuritygroupcomparisonreports 283
Exporting Items to MicrosoftWord 287
ConfiguringMicrosoftWordexporttemplates 289
CreatingMicrosoftWordexporttemplates 290
UsingadvancedlogicinMicrosoftWordtemplates 296
SampleMicrosoftWordexporttemplates 298
AddingMicrosoftWordexporttemplatestoHelixALM 302
PreviewingMicrosoftWordexports 304
TroubleshootingMicrosoftWordexportimageissues 304
CorrectingMicrosoftWordexporttemplateerrors 305
EditingMicrosoftWordexporttemplates 306
DuplicatingMicrosoftWordexporttemplates 306
ExportingMicrosoftWordexporttemplates 307
ImportingMicrosoftWordexporttemplates 307
DeletingMicrosoftWordexporttemplates 307
Administering Helix ALM 309
Managingusersandcustomers 310
UsingtheUserslist 310
UsingtheCustomerslist 311
Addingusersandcustomers 313
Assigninglicensestousersandcustomers 316
Managinguserandcustomercontactinformation 317
SearchingUsersandCustomerslists 318
Retrievingglobalusersandcustomers 319
Promotingusersandcustomers 320
Viewingusersandcustomers 321
Editingusersandcustomers 322
Duplicatingusersandcustomers 323
Changinguserstocustomers 324
Changingcustomerstousers 324
Inactivatingandactivatingusersandcustomers 324
viii
Description:Depending on your role, you may use one or more areas of Helix ALM. Attach files to items, workflow events, issue Found by records, test case steps, and actual results in test run steps. Log in using an API key for more secure authentication. Helix ALM supports integration with Atlassian Jira.
