HP Application Lifecycle Management Software Version: 11.00 Administrator Guide Document Release Date: October 2010 Software Release Date: October 2010 Legal Notices Warranty The only warranties for HP 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. HP 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 Legend Confidential computer software. Valid license from HP 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 Notices © Copyright 1992 - 2010 Hewlett-Packard Development Company, L.P. Trademark Notices Adobe® is a trademark of Adobe Systems Incorporated. JavaTM is a US trademark of Sun Microsystems, Inc. Microsoft®, and Windows® are U.S registered trademarks of Microsoft Corporation. Oracle® is a registered trademark of Oracle Corporation and/or its affiliates. 2 Documentation Updates The title page of this document contains the following identifying information: (cid:129) Software Version number, which indicates the software version. (cid:129) Document Release Date, which changes each time the document is updated. (cid:129) 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: http://h20230.www2.hp.com/selfsolve/manuals This site requires that you register for an HP Passport and sign-in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html Or click the New users - please register link on the HP Passport login page. You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details. 3 Support Visit the HP Software Support web site at: http://www.hp.com/go/hpsoftwaresupport This web site provides contact information and details about the products, services, and support that HP Software offers. HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your business. As a valued support customer, you can benefit by using the support web site to: (cid:129) Search for knowledge documents of interest (cid:129) Submit and track support cases and enhancement requests (cid:129) Download software patches (cid:129) Manage support contracts (cid:129) Look up HP support contacts (cid:129) Review information about available services (cid:129) Enter into discussions with other software customers (cid:129) Research and register for software training Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html To find more information about access levels, go to: http://h20230.www2.hp.com/new_access_levels.jsp 4 Table of Contents Welcome to This Guide.......................................................................11 How This Guide is Organized..............................................................12 Documentation Library.......................................................................13 Documentation Library Guides...........................................................14 Additional Online Resources...............................................................17 PART I: SITE ADMINISTRATION Chapter 1: Site Administration at a Glance........................................21 Starting Site Administration................................................................21 Understanding Site Administration....................................................23 Defining Site Administrators...............................................................26 Chapter 2: Creating Projects...............................................................29 About Creating Projects.......................................................................30 Understanding the Project Structure...................................................31 The ALM Optimized Project Repository..............................................32 Creating Domains...............................................................................34 Creating Projects ................................................................................36 Copying Projects.................................................................................45 Importing Projects...............................................................................49 Creating Template Projects.................................................................52 Linking a Template to Projects............................................................66 Updating Project Details.....................................................................68 Assigning Users to Projects..................................................................74 Enabling Extensions for a Project.......................................................77 5 Table of Contents Chapter 3: Managing Projects............................................................81 About Managing Projects....................................................................82 Querying Project Tables......................................................................82 Exporting Projects...............................................................................84 Deactivating and Activating Projects..................................................85 Enabling and Disabling Version Control for a Project.......................86 Pinging Projects...................................................................................87 Renaming Projects...............................................................................87 Removing Projects...............................................................................88 Deleting Projects..................................................................................88 Deleting Domains................................................................................89 Editing the Connection String............................................................89 Restoring Access to Projects................................................................91 Renaming the Defects Module for a Project.......................................93 Chapter 4: Upgrading Projects...........................................................95 About Upgrading Projects...................................................................96 Verifying Domains and Projects.........................................................99 Repairing Domains and Projects.......................................................104 Upgrading Domains and Projects.....................................................109 Defining an Exception File................................................................114 Backing Up Projects...........................................................................116 Restoring Projects..............................................................................117 Repository Migration.........................................................................120 Chapter 5: Managing ALM Users......................................................125 About Managing Users......................................................................126 Adding a New User............................................................................126 Importing Users from LDAP..............................................................128 Updating User Details.......................................................................137 Deactivating and Activating Users....................................................138 Changing Passwords..........................................................................140 Enabling LDAP Authentication for Users..........................................141 Assigning Projects to Users................................................................143 Exporting User Data..........................................................................146 Deleting Users....................................................................................146 Chapter 6: Managing User Connections and Licenses.....................147 About Managing User Connections and Licenses............................147 Monitoring User Connections .........................................................148 Managing ALM Licenses....................................................................151 6 6 Table of Contents Chapter 7: Configuring Servers and Parameters..............................155 About Configuring Servers and Parameters......................................155 Configuring Server Information.......................................................156 Defining New Database Servers.........................................................159 Modifying Database Server Properties...............................................162 Configuring Text Search....................................................................165 Setting ALM Configuration Parameters............................................171 Setting the ALM Mail Protocol..........................................................197 Chapter 8: Analyzing Site Usage.......................................................199 About Analyzing Site Usage..............................................................199 Monitoring Site Usage.......................................................................200 Filtering Site Usage............................................................................201 Exporting Site Analysis Data to a File...............................................203 Customizing the Site Analysis Line Chart Graph.............................204 Chapter 9: PPT Calculations..............................................................205 About PPT Calculations.....................................................................205 Scheduling Calculations for a Site.....................................................206 Enabling or Disabling Automatic Calculations for a Project............206 Launching Calculations for a Project Manually...............................207 Project Planning and Tracking Tab...................................................207 Chapter 10: QCSense.......................................................................211 About QCSense.................................................................................211 QCSense Configuration....................................................................213 Generating and Viewing QCSense Reports......................................220 QCSense Schema..............................................................................221 PART II: PROJECT CUSTOMIZATION Chapter 11: Project Customization at a Glance...............................237 Starting Project Customization.........................................................238 Understanding the Project Customization Window........................241 Saving Customization Changes........................................................244 Chapter 12: Managing Users in a Project.........................................247 About Managing Users in a Project...................................................247 Adding a User to a Project.................................................................248 Assigning Users to a User Group.......................................................250 Removing a User from a Project........................................................252 7 7 Table of Contents Chapter 13: Managing User Groups and Permissions......................253 About Managing User Groups and Permissions...............................254 Adding User Groups..........................................................................255 Assigning Users to Groups................................................................256 Setting User Group Permissions........................................................258 Setting Transition Rules....................................................................262 Hiding Data for a User Group...........................................................264 Renaming User Groups.....................................................................266 Deleting User Groups........................................................................266 Understanding Permission Settings..................................................267 Customizing Module Access for User Groups...................................287 Chapter 14: Customizing ALM Projects............................................289 About Customizing ALM Projects.....................................................289 Customizing Project Entities.............................................................290 Customizing Project Requirement Types..........................................302 Customizing Project Lists..................................................................309 Chapter 15: Configuring Automail...................................................315 About Setting Automail.....................................................................315 Designating Automail Fields and Conditions...................................316 Customizing the Subject of Defect Mail...........................................318 Chapter 16: Customizing Risk-Based Quality Management............321 About Customizing Risk-Based Quality Management......................322 Customizing Risk-Based Quality Management Criteria....................323 Customizing Risk Calculations.........................................................330 Customizing Risk-Based Quality Management Constants...............331 Chapter 17: Activating Alert Rules....................................................335 About Activating Alert Rules.............................................................335 Setting Alert Rules.............................................................................337 Chapter 18: Cross Project Customization.........................................339 About Cross Project Customization..................................................339 Cross Project Customization Overview.............................................340 Updating Linked Projects..................................................................342 The Cross Project Customization Report..........................................350 Updating Linked Template Details...................................................352 8 8 Table of Contents Chapter 19: Customizing Project Planning and Tracking KPIs.........355 About Customizing PPT KPIs............................................................356 Project Planning and Tracking Page ................................................357 Project Planning and Tracking - General Tab...................................359 Configure Transitions Dialog Box ....................................................362 Project Planning and Tracking - KPI Analysis Tab ...........................364 Chapter 20: Project Report Templates.............................................367 About Project Report Templates........................................................367 Managing Project Report Templates.................................................368 Working with Report Template Files................................................374 Chapter 21: Configuring Sprinter.....................................................387 About Configuring Sprinter..............................................................387 Sprinter Page .....................................................................................388 Chapter 22: Generating Workflow Scripts.......................................391 About Generating Workflow Scripts.................................................392 Customizing Defects Module Field Lists...........................................393 Customizing Defects Module Dialog Boxes......................................396 PART III: WORKFLOW CUSTOMIZATION Chapter 23: Workflow Customization at a Glance...........................403 Chapter 24: Working with the Workflow Script Editor....................405 About Working with the Workflow Script Editor.............................405 The Script Editor................................................................................406 Creating a Workflow Script...............................................................411 Adding a Button to a Toolbar............................................................414 Setting the Properties of the Script Editor.........................................417 Chapter 25: Workflow Event Reference............................................421 About ALM Events.............................................................................421 Naming Conventions for ALM Event Procedures.............................423 Reference for ALM Events.................................................................425 9 9 Table of Contents Chapter 26: Workflow Object and Property Reference....................457 About ALM Objects and Properties...................................................457 Actions Object...................................................................................460 Action Object....................................................................................460 Fields Objects.....................................................................................462 Field Object.......................................................................................464 Lists Object........................................................................................466 TDConnection Object.......................................................................467 User Object........................................................................................467 ALM Properties..................................................................................468 Chapter 27: Workflow Examples and Best Practices........................471 About the Workflow Examples.........................................................472 Best Practices for Writing Workflow Scripts.....................................473 Example: Customizing a Defects Module Dialog Box......................482 Example: Changing Tab Names........................................................486 Example: Adding a Template to a Memo Field.................................487 Example: Changing One Field Based on Another Field....................488 Example: Changing a Field Based on the User Group......................489 Example: Object Validation..............................................................490 Example: Field Validation.................................................................491 Example: Presenting a Dynamic Field List........................................492 Example: Changing Field Properties when a Field Changes............494 Example: Controlling User Permissions............................................495 Example: Adding Button Functionality............................................496 Example: Error Handling...................................................................496 Example: Obtaining Session Properties.............................................498 Example: Sending Mail......................................................................499 Example: Storing the Last Values Entered........................................501 Example: Copying Field Values to Another Object..........................504 PART IV: APPENDIX Appendix A: Upgrade Preparation Troubleshooting.......................507 Quick Warning Reference.................................................................507 General Validation............................................................................513 Schema Validation............................................................................518 Data Validation.................................................................................533 Changing the Database User Schema...............................................537 Definitions.........................................................................................540 10 10