HP Application Lifecycle Management (ALM) Administrator

HP ALM
Software Version: 12.50
Administrator Guide
Document Release Date: December 2015
Software Release Date: December 2015
Administrator Guide
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 Notice
© Copyright 2002 - 2015 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe™ is a trademark of Adobe Systems Incorporated.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
This product includes an interface of the 'zlib' general purpose compression library, which is Copyright © 1995-2002
Jean-loup Gailly and Mark Adler.
Documentation Updates
The title page of this document contains the following identifying information:
l
l
l
Software Version number, which indicates the software version.
Document Release Date, which changes each time the document is updated.
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:
https://softwaresupport.hp.com.
This site requires that you register for an HP Passport and sign in. To register for an HP Passport ID, go to
https://softwaresupport.hp.com and click Register.
Support
Visit the HP Software Support Online web site at: https://softwaresupport.hp.com
This web site provides contact information and details about the products, services, and support that HP Software
offers.
HP ALM (12.50)
Page 2
Administrator Guide
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:
l
l
l
l
l
l
l
l
Search for knowledge documents of interest
Submit and track support cases and enhancement requests
Download software patches
Manage support contracts
Look up HP support contacts
Review information about available services
Enter into discussions with other software customers
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: https://softwaresupport.hp.com and click Register.
To find more information about access levels, go to: https://softwaresupport.hp.com/web/softwaresupport/accesslevels.
HP Software Solutions & Integrations and Best Practices
Visit HP Software Solutions Now at https://h20230.www2.hp.com/sc/solutions/index.jsp to explore how the products
in the HP Software catalog work together, exchange information, and solve business needs.
Visit the Cross Portfolio Best Practices Library at https://hpln.hp.com/group/best-practices-hpsw to access a wide
variety of best practice documents and materials.
HP ALM (12.50)
Page 3
Administrator Guide
Contents
HP ALM Administrator Help
13
How This Guide is Organized
13
Part 1: Site Administration
15
Chapter 1: Site Administration at a Glance
17
Starting Site Administration
18
Understanding Site Administration
19
Defining Site Administrators
22
Chapter 2: Creating Projects
25
About Creating Projects
26
Understanding the Project Structure
26
Creating Domains
27
Creating Projects
29
Copying Projects
36
Importing Projects
42
Creating Template Projects
47
Creating a Template Project
49
Creating a Template from an Existing Template
53
Creating a Template from an Existing Project
58
Importing a Template Project
63
Linking a Template to Projects
66
Updating Project Details
68
Assigning Users to Projects
71
Assigning Project Administrators
Enabling Extensions for a Project
Chapter 3: Managing the Optimized Project Repository
73
74
77
Project Repository Cleanup
78
Browsing the Project Repository
78
MRealigning Repositories
80
Chapter 4: Managing Projects
83
About Managing Projects
84
Querying Project Tables
84
Exporting Projects
85
Deactivating and Activating Projects
86
Enabling and Disabling Version Control for a Project
87
Pinging Projects
88
Renaming Projects
88
HP ALM (12.50)
Page 4
Administrator Guide
Converting Projects to Unicode
89
Removing Projects
91
Deleting Projects
92
Deleting Domains
92
Editing the Connection String
93
Restoring Access to Projects
93
Renaming the Defects Module for a Project
96
Limiting Records Displayed in Grids
97
Chapter 5: Upgrading Projects to a New Version
99
About Upgrading Projects
100
Understanding the Version/Patch Numbering Scheme
100
About Upgrading Projects for Major and Minor Versions
101
Verifying Domains and Projects
104
Verifying a Project
105
Verifying a Domain
106
Repairing Domains and Projects
108
Repairing a Project
108
aRepairing a Domain
109
Upgrading Domains and Projects
111
Upgrading a Project
112
Upgrading a Domain
113
Defining an Exception File
114
Backing Up Projects
116
Restoring Projects
117
Restoring Projects from a Microsoft SQL Database Server
117
Restoring Projects from an Oracle Database Server
118
Restoring a Repository from the File System
118
Restoring LAB_PROJECT
119
Migrating the Repository
119
Repository Migration Status Window
120
Configure Migration Priority
122
LAB_PROJECT Post Upgrade Steps
123
About Upgrading Projects for Minor-Minor Versions
Setting Project Priorities for Upgrading Minor-Minor Versions
Chapter 6: Managing ALM Users
123
125
127
About Managing Users
128
Adding a New User
128
Importing Users from LDAP
130
Enabling LDAP over SSL
132
Defining LDAP Settings for Importing Users
133
Handling User Name Conflicts
136
Updating User Details
HP ALM (12.50)
137
Page 5
Administrator Guide
Deactivating and Activating Users
138
Creating and Changing Passwords
139
Locking Out Users
139
Enabling Authentication for Users
140
Assigning Projects to Users
142
Exporting User Data
144
Deleting Users
144
Chapter 7: Managing User Connections and Licenses
145
About Managing User Connections and Licenses
146
Monitoring User Connections
146
Sending Messages to Connected Users
Managing Licenses
147
148
Modifying Licenses
150
Assigning Licenses to Domains and Projects
151
Assigning Licenses to Users
152
PPU Licenses History
154
Chapter 8: Configuring Servers and Parameters
157
About Configuring Servers and Parameters
158
Configuring Server Information
158
Defining New Database Servers
160
Modifying Database Server Properties
162
Configuring Text Search
164
Enabling Text Search on Database User Schemas
164
Enabling Text Search in ALM
165
Selecting a Text Search Language for a Project
166
Defining Searchable Fields
166
Setting ALM Configuration Parameters
168
Setting the ALM Mail Protocol
169
Setting ALM Mail Restrictions
170
Chapter 9: Analyzing Site Usage
171
About Analyzing Site Usage
172
Monitoring Site Usage
172
Filtering Site Usage
173
Exporting Site Analysis Data to a File
174
Customizing the Site Analysis Line Chart Graph
175
Chapter 10: Scheduling Calculations for Project Planning and Tracking (PPT)
177
About Scheduling Calculations for PPT
178
Scheduling Calculations for a Site
178
Enabling or Disabling Automatic Calculations for a Project
178
Launching Calculations for a Project Manually
179
Project Planning and Tracking Tab
180
Chapter 11: ALM Advisor
HP ALM (12.50)
183
Page 6
Administrator Guide
About ALM Advisor
184
Collecting and Assessing ALM Data
188
Chapter 12: ALM Robot
Considerations Before Getting Started with ALM Robot
Project Upgrade Best Practices
191
192
192
Upgrading Projects Using ALM Robot
193
Undoing Checkouts Using ALM Robot
198
Customizing ALM Robot
200
Managing Environments
200
Sending Email Notices
201
Setting Site Parameters
201
ALM Robot Dashboard Actions
202
Chapter 13: QC Sense
205
About QC Sense
206
QC Sense Configuration
206
QC Sense Monitors
208
Configuring QC Sense
209
QC Sense Server Configuration Window
209
Connection String Builder Dialog Box
212
Generating and Viewing QC Sense Reports
213
QC Sense Schema
214
PERF_CLIENT_OPERATIONS
214
PERF_CLIENT_METHODS_CALLS
215
PERF_CLIENT_REQUESTS
216
PERF_SERVER_THREADS
218
PERF_SERVER_SQLS
219
PERF_SERVER_GENERAL_MEASURES
220
PERF_SERVER_THREAD_TYPES
220
Chapter 14: Installing HP ALM Tools and Add-ins
Part 2: Project Customization
Chapter 15: Project Customization at a Glance
223
225
227
Starting Project Customization
228
Understanding the Project Customization Window
230
Saving Customization Changes
232
Chapter 16: Managing Users in a Project
235
About Managing Users in a Project
236
Adding a User to a Project
236
Assigning Users to a User Group
237
Removing a User from a Project
238
Chapter 17: Managing User Groups and Permissions
HP ALM (12.50)
239
Page 7
Administrator Guide
About Managing User Groups and Permissions
240
Adding User Groups
241
Assigning Users to Groups
241
Setting User Group Permissions
242
Setting Transition Rules
245
Owning ALM Objects
247
Hiding Data for a User Group
248
Renaming User Groups
249
Deleting User Groups
250
Understanding Permission Settings
250
Customizing Module Access for User Groups
251
Chapter 18: Customizing ALM Projects
253
About Customizing ALM Projects
254
Customizing Project Entities
254
Adding User-Defined Fields
258
Modifying System and User-Defined Fields
258
Deleting User-Defined Fields
259
Defining Input Masks
260
Customizing Project Requirement Types
261
Cross Project Customization
262
Creating Requirement Types
263
Customizing Requirement Types
263
Renaming Requirement Types
265
Deleting Requirement Types
265
Customizing Project Lists
266
Cross Project Customization
267
Creating Lists
267
Renaming Lists, Items, or Sub-Items
268
Deleting Lists, Items, or Sub-Items
269
Chapter 19: Configuring Automail
271
About Setting Automail
272
Designating Automail Fields and Conditions
272
Customizing the Subject of Defect Mail
274
Chapter 20: Customizing Risk-Based Quality Management
275
About Customizing Risk-Based Quality Management
276
Customizing Risk-Based Quality Management Criteria
276
Customizing criteria and Values
278
Customizing Weight Boundaries
279
Customizing Risk Calculations
282
Customizing Risk-Based Quality Management Constants
283
Chapter 21: Activating Alert Rules
285
About Activating Alert Rules
286
HP ALM (12.50)
Page 8
Administrator Guide
Setting Alert Rules
287
Chapter 22: Cross Project Customization
289
About Cross Project Customization
290
Cross Project Customization Overview
291
Cross Project Customization Examples
Updating Linked Projects
292
292
Updating Linked Project Details
293
Verifying Cross Project Customization
294
Applying Template Customization to Linked Projects
295
The Cross Project Customization Report
297
Updating Linked Template Details
298
Chapter 23: Customizing Project Planning and Tracking KPIs
301
About Customizing PPT KPIs
302
Project Planning and Tracking Page
302
Project Planning and Tracking - General Tab
303
Configure Transitions Dialog Box
305
Project Planning and Tracking - KPI Analysis Tab
306
Chapter 24: Project Report Templates
309
About Project Report Templates
310
Managing Project Report Templates
310
Creating a New Report Template
312
Editing a Report Template
313
Duplicating a Report Template
313
Deleting a Report Template
313
Designing Report Templates
314
About Designing Report Templates
315
Designing Document Templates
315
Designing Style Templates
316
Designing History Templates
316
Designing Section Templates
318
Guidelines for Creating Full-Page and Tabular Templates
320
Full-page templates
320
Tabular templates
321
Template Creator Tab
321
Chapter 25: Business Views
323
Business Views Overview
324
Creating and Managing Business Views
324
Working with DQL
326
Advantages of DQL
326
Additions to SQL
326
Supported Functions
327
Business Views User Interface
HP ALM (12.50)
340
Page 9
Administrator Guide
Business Views Page
341
Link Properties Dialog Box
345
Add Related Entity Dialog Box
346
Chapter 26: Configuring Business Process Testing
347
About Configuring Business Process Testing
348
Business Process Test Page
348
Chapter 27: Configuring Sprinter
351
About Configuring Sprinter
352
Sprinter Page
352
Chapter 28: Generating Workflow Scripts
355
About Generating Workflow Scripts
356
Cross Project Customization
357
Customizing Defects Module Field Lists
357
Customizing Defects Module Dialog Boxes
359
Chapter 29: Managing Analysis Menus
Part 3: Workflow Customization
363
365
Chapter 30: Workflow Customization at a Glance
367
Chapter 31: Working with the Workflow Script Editor
369
About Working with the Workflow Script Editor
370
The Script Editor
370
Understanding the Script Editor Commands
372
Creating a Workflow Script
374
Adding a Button to a Toolbar
376
Setting the Properties of the Script Editor
378
Chapter 32: Workflow Event Reference
381
About ALM Events
382
Naming Conventions for ALM Event Procedures
383
Entity
383
Event
384
Reference for ALM Events
384
ActionCanExecute
386
AddComponentToTest
387
AfterPost
387
Attachment_CanDelete
388
Attachment_CanOpen
388
Attachment_CanPost
389
Attachment_New
389
CanAddComponentsToTest
389
CanAddFlowsToTest
389
CanAddTests
390
HP ALM (12.50)
Page 10
Administrator Guide
CanCustomize
390
CanDelete
390
CanDeleteGroupsFromTest
393
CanLogin
393
CanLogout
393
CanPost
393
CanReImportModels
394
CanRemoveComponentsFromTest
395
CanRemoveFlowsFromTest
395
CanRemoveTests
395
DefaultRes
396
DialogBox
396
EnterModule
396
ExitModule
397
FieldCanChange
397
FieldChange
398
GetDetailsPageName
399
GetNewBugPageName
400
GetNewReqPageName
400
GetReqDetailsPageName
401
MoveTo
401
MoveToComponentFolder
402
MoveToFolder
403
MoveToSubject
403
New
403
RemoveComponentFromTest
404
RunTests
405
RunTests_Sprinter
405
RunTestSet
405
RunTestsManually
406
Chapter 33: Workflow Object and Property Reference
407
About ALM Objects and Properties
408
Actions Object
409
Action Object
409
Fields Objects
411
Field Object
412
Lists Object
413
TDConnection Object
414
User Object
414
ActiveTreeSelection Object
415
ALM Properties
415
ActiveModule Property
HP ALM (12.50)
416
Page 11
Administrator Guide
ActiveDialogName Property
Chapter 34: Workflow Examples and Best Practices
416
419
About the Workflow Examples
420
Best Practices for Writing Workflow Scripts
420
Checking Value Types Before Use
Recommendations
Anticipating Full Evaluation of Logical Expressions
Recommendations
Defining Default Behavior for Select Case and If-Then-Else Statements
Recommendations
Setting Return Values in Functions
Recommendations
Making Sure that Entity Properties Are Set Before an Entity Comes into Focus
Recommendations
Check if a Dialog Box is Open
Recommendations
Avoid Defining Duplicate Subroutines
Recommendations
Example: Customizing a Defects Module Dialog Box
421
421
422
422
423
423
424
424
424
425
426
426
427
427
427
SetFieldApp
428
FieldCust_AddDefect
428
Example: Changing Tab Names
430
Example: Adding a Template to a Memo Field
431
Example: Changing One Field Based on Another Field
431
Example: Changing a Field Based on the User Group
432
Example: Object Validation
433
Example: Field Validation
433
Example: Presenting a Dynamic Field List
434
Example: Changing Field Properties when a Field Changes
435
Example: Controlling User Permissions
436
Example: Adding Button Functionality
436
Example: Error Handling
437
Example: Obtaining Session Properties
438
Example: Sending Mail
438
Sending Mail when a Defect is Submitted
438
Sending Mail when a Test Plan Module Field Value Changes
439
Example: Storing the Last Values Entered
440
Example: Copying Field Values to Another Object
442
Send Us Feedback
HP ALM (12.50)
443
Page 12
Administrator Guide
How This Guide is Organized
HP ALM Administrator Help
Welcome to HP Application Lifecycle Management (ALM). ALM empowers organizations to manage the
core application lifecycle, from requirements through deployment, granting application teams the
crucial visibility and collaboration needed for predictable, repeatable, and adaptable delivery of modern
applications.
Throughout the application lifecycle management process, ALM projects are accessed by many users—
including developers, testers, business analysts, and quality assurance managers. To protect, maintain,
and control information in a project, users are assigned to groups with different access privileges. Only
an ALM project administrator (belonging to the TDAdmin user group) has full privileges in an ALM
project.
As an ALM site administrator, you use Site Administration to create and maintain domains and projects;
manage users, connections, and licenses; define database servers; and modify configurations.
As an ALM project administrator, you use Project Customization to customize project entities and lists,
set up user groups and permissions, configure mail, set alert rules, and configure the workflow in the
ALM modules. You use Cross Project Customization to standardize customization across projects in your
organization.
ALM is shipped without any passwords defined. To protect your data from unauthorized access, set your
password early in the ALM process.
How This Guide is Organized
The HP Application Lifecycle Management Administrator Guide contains the following parts:
Part
Description
Describes how the site administrator uses Site Administration to manage ALM projects. This includes
"Site
Administration" maintaining projects, users, connections, licenses, servers, configuration parameters, and site analysis.
on page 15
"Project
Customization"
on page 225
Describes how the project administrator uses the Project Customization window to control access to a
project by defining the project users and their privileges. It also describes how to customize a project to
meet the specific needs of the project users.
"Workflow
Customization"
on page 365
Describes how to create workflow scripts to customize the ALM user interface and to control the actions
that users can perform.
HP ALM (12.50)
Page 13
Administrator Guide
How This Guide is Organized
HP ALM (12.50)
Page 14
Part 1: Site Administration
HP ALM (12.50)
Page 15
HP ALM (12.50)
Page 16
Chapter 1: Site Administration at a Glance
Using HP Application Lifecycle Management (ALM) Site Administration, you create and maintain projects,
users, servers, site connections, license usage, and parameters. You can also define site administrators
and change site administrator passwords.
This chapter includes:
•
•
•
Starting Site Administration
18
Understanding Site Administration
19
Defining Site Administrators
22
HP ALM (12.50)
Page 17
Administrator Guide
Chapter 1: Site Administration at a Glance
Starting Site Administration
Using Site Administration, you create and maintain your ALM projects.
To start Site Administration:
1. Select one of the following:
l
l
Open your Web browser and type:
http://<ALM server name>[<:port number>]/qcbin. The HP Application Lifecycle
Management Options window opens. Click the Site Administration link.
Alternatively, open your Web browser and type your Site Administration URL: http://<ALM
server name>[<:port number>]/qcbin/SiteAdmin.jsp.
The first time you start Site Administration, files are downloaded to your client machine. ALM then
carries out a version check on the client files installed on your client machine. If there is a newer
version on the server, updated files are downloaded to your client machine.
Note: If you run ALM over a virtual environment, such as Citrix or VMware, only the system
administrator can install a new version.
If domains or projects were previously created with locale-specific symbols in their names
on a localized ALM server’s Site Administration, you may not be able to access Site
Administration from a non-localized client machine. If this occurs, change the client
machine locale to correspond to the ALM server’s locale.
After the ALM version has been checked and updated if necessary, the HP Application Lifecycle
Management Site Administration Login window opens.
Note: If you are an external authentication user, this window is bypassed and you are
automatically logged in to Site Administration using your external authentication
credentials.
HP ALM (12.50)
Page 18
Administrator Guide
Chapter 1: Site Administration at a Glance
2. In the User Name box, type the name of a user who is defined as a site administrator. The first
time you log in to Site Administration, you must use the site administrator name that you specified
during the installation of ALM. After you log in to Site Administration, you can define additional site
administrators. For more information, see "Defining Site Administrators" on page 22.
3. In the Password box, type your site administrator password. The first time you log in to Site
Administration, you must use the site administrator password that you specified during the
installation of ALM.
To define or change the site administrator password, see "Creating and Changing Passwords" on
page 139.
4. Click Login. Site Administration opens.
Understanding Site Administration
As an ALM site administrator, you create and maintain projects, users, and servers using Site
Administration.
ALM Editions: Some functionality in Site Administration is unavailable for some editions. This
includes the following:
l
ALM template projects are not available for Quality Center Enterprise Edition.
l
Functionality related to project planning and tracking is available for ALM Edition only.
For more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
HP ALM (12.50)
Page 19
Administrator Guide
Chapter 1: Site Administration at a Glance
This section includes:
l
"Masthead" below
l
"Tools Menu" on the next page
l
"Site Administration Tabs" on the next page
Masthead
The masthead includes options you can use throughout Site Administration.
Option
Description
Tools
Includes commands that you can run from any location in Site Administration. For details, see "Tools
Menu" on the next page.
Help
Enables you to open the HP Application Lifecycle Management Help and other additional online resources.
To display version information for each ALM client component, select Help . Details appear on the right
side of the window that is displayed.
Tip: To customize the Help menu, refer to the HP Application Lifecycle Management
Installation and Upgrade Guide.
Site
Administrator:
<user>
The current Site Administrator user.
Logout. Logs you out of Site Administration.
Note: When ALM is accessed via an external authentication mode, you cannot log out
using this button. To log out, you must close the client browser.
HP ALM (12.50)
Page 20
Administrator Guide
Chapter 1: Site Administration at a Glance
Tools Menu
The Tools menu, located on the masthead, contains the following options:
Option
Description
Collect
Information
Creates the ALM_CollectedInfo_<number>.html file. This file contains diagnostic information about
the ALM system. It is useful for when you contact ALM support. The ALM_CollectedInfo_
<number>.html file is stored in the temp folder on the ALM server machine. To determine the folder
location, open the Site Administration log file and locate the java.io.tmpdir field.
Displays the status of project migration to the optimized project repository. For more information, see
Repository
Migration Status "Migrating the Repository" on page 119.
Set Project
Upgrade
Priorities
Enables you to set priorities before upgrading projects to new minor-minor versions. For information, see
"About Upgrading Projects for Minor-Minor Versions" on page 123.
Update Test
Types
Updates custom test type definitions in active projects. This is required after registering custom test types
with ALM. If your site contains many active projects, this may take some time. For more information, refer
to the HP ALM Custom Test Types Guide .
Note: When you activate a project, custom test type definitions are updated
automatically.
ALM Assessment Collects environment details to assess the current ALM deployment and recommend usage
improvements. For more information, see "ALM Advisor" on page 183.
QC Sense
Includes the following options for working with QC Sense, the internal ALM monitoring tool:
l
Reports. Enables you to generate reports based on collected data.
l
Configuration. Enables you to configure QC Sense monitors to define the scope of data collected.
For more information, see "QC Sense" on page 205.
Site Administration Tabs
Site Administration contains the following tabs:
Tab
Description
Site Projects
Manage your ALM projects and templates. This includes adding new domains and projects, enabling
extensions for projects, querying project data, restoring projects, renaming projects, and activating or
deactivating projects. For more information, see "Managing Projects" on page 83.
You can also upgrade projects from a previous Quality Center version to the current ALM version. For more
information, see "Upgrading Projects to a New Version" on page 99.
Lab
Management
Manage the LAB_PROJECT details and define Lab Management administrators.
Site Users
Add new users and define user properties, including changing passwords. For more information, see
HP ALM (12.50)
For more information, refer to the HP ALM Lab Management Guide .
Page 21
Administrator Guide
Chapter 1: Site Administration at a Glance
Tab
Description
"Managing ALM Users" on page 127.
You can also define site administrators. For more information, see "Defining Site Administrators" below.
Site
Connections
Monitor the users currently connected to an ALM server. For more information, see "Managing User
Licenses
Monitor the total number of ALM licenses in use and to modify the license key. For more information, see
Connections and Licenses" on page 145.
"Managing User Connections and Licenses" on page 145.
Servers
Modify ALM server information, such as the log file. For more information, see "Configuring Servers and
Parameters" on page 157.
DB Servers
Manage your database servers. This includes adding a new database server, editing a database's connection
string, and changing a database's default administrator user name and password. For more information, see
"Configuring Servers and Parameters" on page 157.
Site
Modify ALM configuration parameters, such as the mail protocol. For more information, see "Configuring
Configuration Servers and Parameters" on page 157.
Site Analysis
Monitor the number of licensed ALM users connected to your projects at specific points over a period of time.
For more information, see "Analyzing Site Usage" on page 171.
Project
Planning and
Tracking
Schedule project planning and tracking calculations for an ALM site. For more information, see "Scheduling
Calculations for Project Planning and Tracking (PPT)" on page 177.
Defining Site Administrators
You can define ALM users as site administrators.
To secure the information in Site Administration, ensure that each user you add as a site administrator
has a password defined. For more information, see "Creating and Changing Passwords" on page 139.
To define site administrators:
1. In Site Administration, click the Site Users tab.
2. Click the Site Administrators button Site Administrators list.
. The Site Administrators dialog box opens displaying the
To change the sort order of the Site Administrators list from ascending to descending, click the
UserName or FullName column heading. Click the column heading again to reverse the sort order.
You can search for a user in the Site Administrators list by typing the name of a user in the Find
box, and clicking the Find button
.
3. Click the Add Site Administrators button. The Users list is displayed in the right pane.
HP ALM (12.50)
Page 22
Administrator Guide
Chapter 1: Site Administration at a Glance
4. Select the users that you want to assign as site administrators. You can search for users by typing
a search string in the Find box above the Users list, and clicking the Find button .
5. Click the Add Selected Users button . Alternatively, double-click a user. The selected users are
moved to the Site Administrators list in the left pane.
6. To remove a site administrator from the Site Administrators list, select the user and click the
Remove Selected Site Administrators button. Click OK to confirm. The user is removed from the
Site Administrators list.
7. To refresh the Site Administrators list or Users list, click the Refresh button
appropriate list.
HP ALM (12.50)
above the
Page 23
Administrator Guide
Chapter 1: Site Administration at a Glance
HP ALM (12.50)
Page 24
Chapter 2: Creating Projects
You can create and configure HP Application Lifecycle Management (ALM) domains and projects in Site
Administration.
For information on managing existing projects, see "Managing Projects" on page 83. This includes
querying project data, restoring projects, renaming projects, exporting projects, and activating or
deactivating projects.
For information on upgrading projects from a previous Quality Center/ALM version, see "Upgrading
Projects to a New Version" on page 99.
This chapter includes:
•
•
•
•
•
•
•
•
•
•
•
About Creating Projects
26
Understanding the Project Structure
26
Creating Domains
27
Creating Projects
29
Copying Projects
36
Importing Projects
42
Creating Template Projects
47
Linking a Template to Projects
66
Updating Project Details
68
Assigning Users to Projects
71
Enabling Extensions for a Project
74
HP ALM (12.50)
Page 25
Administrator Guide
Chapter 2: Creating Projects
About Creating Projects
To start working in ALM, you need to create a project. A project collects and stores data relevant to the
application management process. You can select from the following:
l
create an empty project
l
create a project based on a template project
l
copy the contents of an existing project to a new project
l
import data from an exported project file
You can also create a template project. You can link a template project to other projects to enable cross
project customization. For more information, see "Cross Project Customization" on page 289.
After you create a project, you can add and remove users from the project.
Note: Users who are already logged into Lab Management need to re-enter the application to
see changes you made in Site Administration.
Projects are grouped by domain. A domain contains a group of related projects and assists you in
organizing and managing a large number of projects. Each domain contains a Projects folder and a
Template Projects folder to organize your projects and template projects.
ALM Editions: Some functionality in Site Administration is limited per edition. For example, ALM
template projects are not available with Quality Center Enterprise Edition. For more information
about ALM editions and their functionality, see the HP Application Lifecycle Management User
Guide.
Understanding the Project Structure
When you install ALM, the installation program creates a project repository on the application server's
file system. By default, the project repository is located under the application deployment directory, at
C:\ProgramData\HP\ALM\repository on Windows machines, and at /var/opt/HP/ALM/repository on UNIX
machines.
The project repository contains the sa and qc sub-folders. The sa directory stores global XML files, style
sheets, templates, and reports to be used by all projects in the project repository.
The qc directory is a working area for a group of domains that are shared by multiple users. Each
domain stores projects. When you create a new project, you can add it to the default domain or to a
user-defined domain.
The following diagram shows the structure of the repository.
HP ALM (12.50)
Page 26
Administrator Guide
Chapter 2: Creating Projects
Under the qc directory, each project directory contains the following subdirectories:
l
l
ProjRep. A subdirectory that contains a repository of all project files, such as test scripts, reports,
and attachments. For more information on the project repository, see "Managing the Optimized
Project Repository" on page 77.
dbid.xml. An initialization file that stores project information required for restoring a connection to
a project. For more information on restoring a connection to a project, see "Restoring Access to
Projects" on page 93.
Under the sa directory, the DomsInfo subdirectory contains the following information:
l
StyleSheets. A subdirectory for storing global style sheets.
l
Templates. A subdirectory for storing database templates used when creating new projects.
Creating Domains
You can add new domains to Site Administration. You organize projects in the Projects list by domain.
To create a domain:
1. In Site Administration, click the Site Projects tab.
2. Click the Create Domain button. The Create Domain dialog box opens.
3. Type a Domain Name and click OK.
The domain name cannot be longer than 30 characters, must begin with a letter, and can include
only letters, digits, and underscores.
HP ALM (12.50)
Page 27
Administrator Guide
Chapter 2: Creating Projects
Note: Support of non-English national characters depends on the database settings used
by the server. We do not recommend using non-English national characters in domain
names.
The new domain is added to the Projects list in alphabetical order. In the right pane, under
Directories, you can view the location of the domain.
4. To add a person's name as a contact when there are questions or problems with the domain or its
projects, click the Contact Name link. In the Set Contact Name dialog box, type the name of the
contact person and click OK.
5. To add the email address of the contact person for the domain, click the Contact Email link. In the
Set Contact Email dialog box, type the email address and click OK.
6. To change the number of users allowed to connect concurrently to the domain, click the User
Quota link. The Domain User Quota dialog box opens.
Choose Maximum Connections and type the maximum number of concurrent connections allowed.
Click OK.
Note: In addition to changing the number of users allowed to connect concurrently to a
domain, you can also change:
l
the number of users allowed to connect concurrently to a project. For more
information, see "Updating Project Details" on page 68.
l
the number of concurrent connections that can be opened on the database server by
ALM for each project. For more information, see "Configuring Server Information" on
page 158.
7. To select a default database server when creating projects in the domain, select a default
database server from the Default DB Server list.
HP ALM (12.50)
Page 28
Administrator Guide
Chapter 2: Creating Projects
Creating Projects
You can create ALM projects in Oracle or Microsoft SQL. You can create a project in any of the following
ways:
l
l
Create an empty project.
Create a project from a template. This option copies the customization of an existing template
project. It does not copy project data from the template project.
ALM Editions: This option is not available for Quality Center Enterprise Edition. For more
information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
l
l
Copy the contents of an existing project. For more information, see "Copying Projects" on page 36.
Import data from an exported project file. For more information, see "Importing Projects" on page
42.
For information on creating template projects, see "Creating Template Projects" on page 47.
Note:
l
For information on the Oracle or Microsoft SQL permissions required by ALM, refer to the HP
Application Lifecycle Management Installation and Upgrade Guide.
l
If your database server is connected to ALM over a WAN, the project creation process can be
very time-consuming.
To create a project:
1. In Site Administration, click the Site Projects tab.
2. Select the domain in which you want to create the project.
3. Click the Create Project button. The Create Project dialog box opens.
HP ALM (12.50)
Page 29
Administrator Guide
Chapter 2: Creating Projects
4. Select one of the following options:
l
l
Create an empty project. Creates a new project.
Create a project from a template. Creates a new project by copying the customization of an
existing template project, but not the project data.
ALM Editions: This option is not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
l
l
Create a project by copying data from an existing project. For more information, see
"Copying Projects" on page 36.
Create a project by importing data from an exported project file. For more information, see
"Importing Projects" on page 42.
5. Click Next.
If you selected Create a project from a template, the Use Template Customization dialog box
opens.
ALM Editions: This dialog box is not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
If you did not select Create a project from a template, proceed to step 7.
HP ALM (12.50)
Page 30
Administrator Guide
Chapter 2: Creating Projects
Select the domain and template you want to use to create the project.
6. Select Link the project to the selected template to link the new project to the template.
ALM Editions: This option is not available for for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
Note: After you link a project to a template, the template administrator must apply
template customization to the project. This applies the customization from the template
to the linked project, and sets the applied customization to read-only in the project. For
more information, see "Applying Template Customization to Linked Projects" on page 295.
Click Next.
HP ALM (12.50)
Page 31
Administrator Guide
Chapter 2: Creating Projects
7. The following dialog box opens:
8. In the Project Name box, type a name for your project. The project name cannot be longer than 30
characters and can include only letters, digits, and underscores.
Note: Support of non-English national characters depends on the database settings used
by the server. We do not recommend using non-English national characters in project
names.
9. In the In Domain box, select a domain.
10. Click Next. The following dialog box opens:
11. Under Database Type, select Oracle or MS-SQL.
12. By default, the default values defined for the domain are displayed for Server Name, DB Admin
User, and DB Admin Password. If additional database servers are defined, you can select another
name from the Server Name list.
13. Click Create as Unicode to create the project as Unicode.
HP ALM (12.50)
Page 32
Administrator Guide
Chapter 2: Creating Projects
Note: The Create as Unicode checkbox is only displayed when creating a new project from
an empty project in an MS-SQL server. Unicode is a feature of MS-SQL that allows multilanguage support. In Oracle, multi-language support is defined when installing the server.
14. Click Next.
If your selected database server does not have the text search feature enabled, a message box
opens. The message indicates that after this process completes, you can enable the text search
feature. For more information on enabling the text search feature, see "Configuring Text Search"
on page 164.
15. If you are creating a Microsoft SQL project, proceed to step 16. For an Oracle project, the following
dialog box opens.
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new project. You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new project.
Click Next.
16. The Add Project Administrators dialog box opens.
HP ALM (12.50)
Page 33
Administrator Guide
Chapter 2: Creating Projects
Selected Project Administrators lists users that are assigned as project administrators. Available
Users lists users available in the project. When you assign project administrators, they are moved
from the Available Users list to the Selected Project Administrators list. Project administrator users
can add and administer other users in the project.
l
l
l
Refresh. Click the Refresh button
to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button Available Users list.
to search the
Add Selected Users. Select the users you want to assign as project administrators, and click
the Add Selected Users button . Alternatively, double-click a user name. The selected users
are moved to the Selected Project Administrators list.
l
Delete. To remove a user from the Selected Project Administrators list, right-click the user
name and click Delete.
You can also assign project administrators after you have created the project. For more
information, see "Assigning Project Administrators" on page 73.
17. Click Next. You can enable extensions that are available for your site's ALM edition.
HP ALM (12.50)
Page 34
Administrator Guide
Chapter 2: Creating Projects
Select the Enable check box for the extensions you want to enable.
Note
l
You cannot disable an extension for a project after you enable it. We recommend
enabling only the extensions you need. Enabling extra extensions can affect
performance and consumes additional disk space.
l
As you navigate from one extension to another, relevant license status information is
displayed in the License Status section.
Extensions for which there is no license on the server are displayed in gray. It is possible
to enable an extension for which you do not yet have a license. You can utilize the
extension's added functionality later, after receiving the license.
l
To work with Lab Management or Performance Center, select ALM Lab Extension. For
more information, refer to the HP ALM Lab Management Guide.
l
You can also enable extensions for a project after you have created the project. For
more information, see "Enabling Extensions for a Project" on page 74.
HP ALM (12.50)
Page 35
Administrator Guide
Chapter 2: Creating Projects
18. Click Next. The following dialog box opens:
Verify the project details. To change any of the details, click Back.
19. Select Activate Project to activate the new project. Only activated projects are available to users
in the HP Application Lifecycle Management Login window when they log in to a project. For more
information, see "Deactivating and Activating Projects" on page 86.
20. Select Enable Versioning to enable version control for the project. You can also enable version
control after you have created the project. For more information, see "Enabling and Disabling
Version Control for a Project" on page 87.
21. Click Create. The new project is added to the Projects list.
Copying Projects
You can create a new project by copying the contents of an existing project.
Version Control: If you copy a version control enabled project, the new project is created with version
control enabled. Version history is also copied. Entities that are checked out in the source project are
checked out in the new project. An administrator in the new project can undo those checkouts. For more
information, see the HP Application Lifecycle Management User Guide.
Note:
l
If your ALM server becomes unavailable while copying, you can resume the copying process at
a later stage. To resume copying, reopen Site Administration and select the project from the
Projects list. In the right pane, click the Click Here link.
l
The new project inherits the Unicode or ASCII definition of the copied project.
l
Test run details are not be included in the Usage Reports in the copied project.
HP ALM (12.50)
Page 36
Administrator Guide
Chapter 2: Creating Projects
l
Timeslot information and project settings are not copied.
l
Result files associated with the original project are not copied.
To copy a project:
1. Deactivate the project you want to copy. For more information, see "Deactivating and Activating
Projects" on page 86.
2. In Site Administration, click the Site Projects tab.
3. Select the domain in which you want to create the project.
4. Click the Create Project button. The Create Project dialog box opens.
5. Choose the Create a project by copying data from an existing project option and click Next. The
following dialog box opens:
HP ALM (12.50)
Page 37
Administrator Guide
Chapter 2: Creating Projects
6. Under Select Project To Copy From, select the domain and project you want to copy and click
Next. The following dialog box opens:
7. Select Customization to copy project lists, host data, system and user-defined fields, module
access, workflow, and transition rules to the new project. If this option is selected, you can also
choose to copy any of the following:
Option
Description
Releases
Copies release data from the project.
Requirements
Copies requirement data from the project.
Risk-Based
Quality
Management
Copies risk-based quality management customization settings from the project. For more
Tests
Copies test data and test resources from the project. If this option is selected, you can also choose the
following option:
information, see "Customizing Risk-Based Quality Management" on page 275.
l
Test Sets. Copies test set data from the project. If this option is selected, you can also choose to
copy the following option:
l
Defects
Runs. Copies test run data from the project.
Copies defect data from the project.
Include History Copies history data for the options that are selected.
Public Favorite Copies public favorite view data from the project. For more information, refer to the HP Application
Views
Lifecycle Management User Guide .
Dashboard
Public Entities
Copies public analysis items and dashboard pages from the project. For more information, refer to the
Users and
Copies user and group information and permission settings. If this option is selected, you can also
choose to copy the following options:
HP ALM (12.50)
HP Application Lifecycle Management User Guide .
Page 38
Administrator Guide
Chapter 2: Creating Projects
Option
Description
Groups
l
l
l
l
Dashboard Private Entities. Copies private analysis items and dashboard pages from the
project. For more information, refer to the HP Application Lifecycle Management User
Guide .
Private Favorite Views. Copies private favorite view data and Excel report definitions
from the project. For more information, refer to the HP Application Lifecycle Management
User Guide .
Mail Conditions. Copies the mailing configuration data. For more information, see
"Configuring Automail" on page 271.
Alerts and Follow up Flags. Copies alerts and follow up flags. For more information, refer to
the HP Application Lifecycle Management User Guide .
Sprinter
Copies Sprinter data. This cannot be unselected.
Analysis
Extension
Copies Analysis data. This cannot be unselected.
Quality Center
Copies Quality Center data. This cannot be unselected.
Note:
l
If the project from which you are copying has extensions enabled, the extensions and
their associated data are also copied to the new project.
l
If the project from which you are copying contains libraries, the libraries are not copied
to the new project. For information on importing libraries, see the HP Application
Lifecycle Management User Guide.
To clear all options, click Clear All.
To select all options, click Select All.
8. Click Next.
9. In the Project Name box, type a name for your project. The project name cannot be longer than 30
characters and cannot include any of the following characters: = ~ ` ! @ # $ % ^ & * ( ) + | { } [ ] :
';"<>?,./\10. In the In Domain box, select a domain.
11. Click Next. The following dialog box opens:
HP ALM (12.50)
Page 39
Administrator Guide
Chapter 2: Creating Projects
12. Under Database Type, select Oracle or MS-SQL.
13. By default, the default values defined for the domain are displayed for Server Name, DB Admin
User, and DB Admin Password. If additional database servers are defined, you can select another
name from the Server Name list.
14. Click Next.
If your selected database server does not have the text search feature enabled, a message box
opens. The message indicates that after this process completes, you can enable the text search
feature. For more information on enabling the text search feature, see "Configuring Text Search"
on page 164.
HP ALM (12.50)
Page 40
Administrator Guide
Chapter 2: Creating Projects
15. If you are creating a Microsoft SQL project, proceed to step 16. For an Oracle project, the following
dialog box opens:
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new project. You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new project.
Click Next.
16. The Add Project Administrators dialog box opens.
HP ALM (12.50)
Page 41
Administrator Guide
Chapter 2: Creating Projects
Selected Project Administrators lists users that are assigned as project administrators. Available
Users lists users available in the project. When you assign project administrators, they are moved
from the Available Users list to the Selected Project Administrators list. Project administrator users
can add and administer other users in the project.
l
l
l
Refresh. Click the Refresh button
to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button Available Users list.
to search the
Add Selected Users. Select the users you want to assign as project administrators, and click
the Add Selected Users button . Alternatively, double-click a user name. The selected users
are moved to the Selected Project Administrators list.
l
Delete. To remove a user from the Selected Project Administrators list, right-click the user
name and click Delete.
You can also assign project administrators after you have created the project. For more
information, see "Assigning Project Administrators" on page 73.
17. Click Next. The following dialog box opens:
Verify the project details. To change any of the details, click Back.
18. Select Activate Project to activate the new project. Only activated projects are available to users
in the HP Application Lifecycle Management Login window when they log in to a project. For more
information, see "Deactivating and Activating Projects" on page 86.
19. Click Create. The new project is added to the Projects list.
Importing Projects
You can import data from exported ALM project files created in the same ALM version. You can also
import data from customized projects created by content providers. For example, you can import
HP ALM (12.50)
Page 42
Administrator Guide
Chapter 2: Creating Projects
customized tests, requirements, and test sets for SAP testing, Siebel testing, and SOX compliance
testing created by HP content providers.
If you import a project that was previously exported from the same server, ALM recognizes that the
same project already exists on the server, based on the project ID. You can choose to replace the
existing project, or cancel the import process.
Notes
l
The new project inherits the Unicode or ASCII definition of the imported project.
l
Projects greater than 2 GB cannot be imported. They must be imported in sections.
Version Control: If you import an exported version control enabled project, the project is
imported with version control enabled. Version history is also copied.
You can also import data from template projects. For more information, see "Importing a Template
Project" on page 63.
For more information on exporting projects, see "Exporting Projects" on page 85.
To import an ALM project:
1. In Site Administration, click the Site Projects tab.
2. You can do one of the following:
l
Select the domain to which you want to import a project, and click the Import Project from
Project File button l
. Alternatively, right-click the domain and choose Import Project.
Click the Create Project button. The Create Project dialog box opens.
3. Choose the Create a project by importing data from an exported project file option, and click
Next. The Select File for Import dialog box opens.
HP ALM (12.50)
Page 43
Administrator Guide
Chapter 2: Creating Projects
4. Click the browse button to the right of the Import project from box to locate the project that you
want to import. The Open dialog box opens.
5. Locate the directory and select the ALM Project Export file that you want to import. Click Open. The
selected file is displayed in the Import project from box.
Note: If the selected file is an ALM template project file, a new template project is created.
The template project is added to the Projects list under Template Projects.
ALM Editions:Template projects are not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
Click Next.
6. In the Project Name box, type a name for your project. The project name cannot be longer than 30
characters and cannot include any of the following characters: = ~ ` ! @ # $ % ^ & * ( ) + | { } [ ] :
';"<>?,./\7. In the In Domain box, select a domain.
Tip: After the project has been created, you can move it to a different domain in the
Projects list using a drag-and-drop operation.
HP ALM (12.50)
Page 44
Administrator Guide
Chapter 2: Creating Projects
8. Click Next. The following dialog box opens:
9. Under Database Type, select Oracle or MS-SQL.
By default, the default values defined for the domain are displayed for Server Name, DB Admin
User, and DB Admin Password. If additional database servers are defined, you can select another
name from the Server Name list.
Note: For more information on defining database servers, see "Defining New Database
Servers" on page 160.
10. Click Next.
If your selected database server does not have the text search feature enabled, a message box
opens. The message indicates that after this process completes, you can enable the text search
feature. For more information on enabling the text search feature, see "Configuring Text Search"
on page 164.
HP ALM (12.50)
Page 45
Administrator Guide
Chapter 2: Creating Projects
11. If you are creating a Microsoft SQL project, proceed to step 12. For an Oracle project, the following
dialog box opens:
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new project. You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new project.
Click Next.
12. In the Add Project Administrators dialog box, select project administrators.
HP ALM (12.50)
Page 46
Administrator Guide
Chapter 2: Creating Projects
Selected Project Administrators lists users that are assigned as project administrators. Available
Users lists users available in the project. When you assign project administrators, they are moved
from the Available Users list to the Selected Project Administrators list. Project administrator users
can add and administer other users in the project.
l
l
l
Refresh. Click the Refresh button to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button Available Users list.
to search the
Add Selected Users. Select the users you want to assign as project administrators, and click
the Add Selected Users button . Alternatively, double-click a user name. The selected users
are moved to the Selected Project Administrators list.
l
Delete. To remove a user from the Selected Project Administrators list, right-click the user
name and click Delete.
You can also assign project administrators after you have created the project. For more
information, see "Assigning Project Administrators" on page 73.
13. Click Next. The following dialog box opens:
Verify the project details. To change any of the details, click Back.
14. Select Activate Project to activate the new project. Only activated projects are available to users
in the HP Application Lifecycle Management Login window when they log in to a project. For more
information, see "Deactivating and Activating Projects" on page 86.
15. Click Create. The new project is added to the Projects list.
Creating Template Projects
Template projects enable you to define and maintain a common set of project customizations for
multiple projects. When you create a template, you can link it to projects. This enables the template
HP ALM (12.50)
Page 47
Administrator Guide
Chapter 2: Creating Projects
administrator to apply template customization changes to the linked projects.
You create a new template project by creating an empty template, by copying an existing template or
project, or by importing a template.
ALM Editions: Template projects are not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
This section includes:
•
•
•
•
Creating a Template Project
49
Creating a Template from an Existing Template
53
Creating a Template from an Existing Project
58
Importing a Template Project
63
HP ALM (12.50)
Page 48
Administrator Guide
Chapter 2: Creating Projects
Creating a Template Project
You can create a new template project in Oracle or Microsoft SQL.
To create a template:
1. In Site Administration, click the Site Projects tab.
2. Select the domain in which you want to create the template.
3. Click the Create Template button. The Create Template dialog box opens.
4. Select Create an empty template and click Next. The following dialog box opens.
5. In the Template Name box, type a name for the template. The template name cannot be longer
than 30 characters and cannot include any of the following characters: = ~ ` ! @ # $ % ^ & * ( ) + |
{}[]:';"<>?,./\-
HP ALM (12.50)
Page 49
Administrator Guide
Chapter 2: Creating Projects
6. In the In Domain box, select a domain.
Tip: After the template has been created, you can move it to a different domain in the
Projects list using a drag-and-drop operation.
7. Click Next. The following dialog box opens.
8. Under Database Type, select Oracle or MS-SQL.
The default values defined for the domain are displayed for Server Name, DB Admin User, and DB
Admin Password. If additional database servers are defined, you can select another name from
the Server Name list.
9. Click Create as Unicode to create the template as Unicode.
Note: The Create as Unicode checkbox is only displayed when creating a new template
from an empty template in an MS-SQL server. Unicode is a feature of MS-SQL that allows
multi-language support. In Oracle, multi-language support is defined when installing the
server.
10. Click Next.
If your selected database server does not have the text search feature enabled, a message box
opens. The message indicates that after this process completes, you can enable the text search
feature. For more information on enabling the text search feature, see "Configuring Text Search"
on page 164.
HP ALM (12.50)
Page 50
Administrator Guide
Chapter 2: Creating Projects
11. If you are creating a Microsoft SQL template, proceed to step 12. For an Oracle template, the
following dialog box opens.
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new template. You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new template.
Click Next.
12. The Add Template Administrators dialog box opens.
Selected Template Administrators lists users that are assigned as template administrators.
Available Users lists users available in the template. When you assign template administrators,
HP ALM (12.50)
Page 51
Administrator Guide
Chapter 2: Creating Projects
the users are moved from the Available Users list to the Selected Template Administrators list.
Template administrator users can customize template projects and apply template customization
to linked projects. For more information, see "Cross Project Customization" on page 289.
l
l
l
Refresh. Click the Refresh button
to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button
Available Users list.
to search the
Add Selected Users. Select the users you want to assign as template administrators, and click
the Add Selected Users button
. Alternatively, double-click a user name. The selected users
are moved to the Selected Template Administrators list.
l
Delete. To remove a user from the Selected Template Administrators list, right-click the user
name and click Delete.
You can also assign template administrators after you have created the template. For more
information, see "Assigning Project Administrators" on page 73.
13. Click Next. You can enable extensions that are available for your site's ALM edition.
Select the Enable check box for the extensions you want to enable.
Note
l
You cannot disable an extension for a project after you enable it. We recommend
enabling only the extensions you need. Enabling extra extensions can affect
performance and consumes additional disk space.
l
As you navigate from one extension to another, relevant license status information is
displayed in the License Status section.
Extensions for which there is no license on the server are displayed in gray. It is possible
to enable an extension for which you do not yet have a license. You can utilize the
extension's added functionality later, after receiving the license.
l
To work with Lab Management or Performance Center, select ALM Lab Extension. For
more information, refer to the HP ALM Lab Management Guide.
HP ALM (12.50)
Page 52
Administrator Guide
Chapter 2: Creating Projects
l
You can also enable extensions for a project after you have created the project. For
more information, see "Enabling Extensions for a Project" on page 74.
14. Click Next. The following dialog box opens.
Verify the template details. To change any of the details, click Back.
15. Select Activate template to activate the template. Only activated templates are available in the
HP Application Lifecycle Management Login window. For more information, see "Deactivating and
Activating Projects" on page 86.
16. Select Enable Versioning to enable version control for the template. You can also enable version
control after you have created the template. For more information, see "Enabling and Disabling
Version Control for a Project" on page 87.
17. Click Create. The new template is added to the Projects list under Template Projects.
Creating a Template from an Existing Template
You can create a template project by copying an existing template. This option copies both
customization and project data from the source template.
Note: The new template inherits the Unicode or ASCII definition of the copied project.
Version Control: If you copy a version control enabled template, the new template is created with
version control enabled.
To create a template from an existing template:
1. In Site Administration, click the Site Projects tab.
2. Select the domain in which you want to create the template.
3. Click the Create Template button. The Create Template dialog box opens.
HP ALM (12.50)
Page 53
Administrator Guide
Chapter 2: Creating Projects
4. Select Create a template by copying customization from an existing template and click Next.
The Copy Template dialog box opens.
5. In the Domain box, select the domain where the template you want to copy is located.
6. In the Template box, select the template you want to copy.
HP ALM (12.50)
Page 54
Administrator Guide
Chapter 2: Creating Projects
7. Click Next. The following dialog box opens.
8. In the Template Name box, type a name for the template. The template name cannot be longer
than 30 characters and cannot include any of the following characters: = ~ ` ! @ # $ % ^ & * ( ) + |
{}[]:';"<>?,./\9. In the In Domain box, select a domain.
Tip: After the template has been created, you can move it to a different domain in the
Projects list using a drag-and-drop operation.
10. Click Next. The following dialog box opens.
11. Under Database Type, select Oracle or MS-SQL.
HP ALM (12.50)
Page 55
Administrator Guide
Chapter 2: Creating Projects
The default values defined for the domain are displayed for Server Name, DB Admin User, and DB
Admin Password. If additional database servers are defined, you can select another name from
the Server Name list.
12. Click Next.
Note: If your selected database server does not have the text search feature enabled, a
message box opens. The message indicates that after this process completes, you can
enable the text search feature. For more information on enabling the text search feature,
see "Configuring Text Search" on page 164.
If you are creating a Microsoft SQL template, proceed to step 13. For an Oracle template, the
following dialog box opens.
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new template.
You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new template.
Click Next.
13. The Add Template Administrators dialog box opens.
HP ALM (12.50)
Page 56
Administrator Guide
Chapter 2: Creating Projects
Selected Template Administrators lists users that are assigned as template administrators.
Available Users lists users available in the template. When you assign template administrators,
the users are moved from the Available Users list to the Selected Template Administrators list.
Template administrator users can customize template projects and apply template customization
to linked projects. For more information, see "Cross Project Customization" on page 289.
l
l
l
Refresh. Click the Refresh button
to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button
Available Users list.
to search the
Add Selected Users. Select the users you want to assign as template administrators, and click
the Add Selected Users button
. Alternatively, double-click a user name. The selected users
are moved to the Selected Template Administrators list.
l
Delete. To remove a user from the Selected Template Administrators list, right-click the user
name and click Delete.
You can also assign template administrators after you have created the template. For more
information, see "Assigning Project Administrators" on page 73.
14. Click Next. The following dialog box opens.
HP ALM (12.50)
Page 57
Administrator Guide
Chapter 2: Creating Projects
Verify the template details. To change of the details, click Back.
15. Select Activate template to active the template. Only activated templates are available in the HP
Application Lifecycle Management Login window. For more information, see "Deactivating and
Activating Projects" on page 86.
16. Click Create. The new template is added to the Projects list under Template Projects.
Creating a Template from an Existing Project
You can create a template project by copying the customization of an existing project. This option
copies customization from the project but does not copy project data.
You can choose to link the newly created template to the project from which it is copied. This enables
the template administrator to apply template customization changes to the linked project.
Note:
l
If the project from which you create the template contains workflow scripts, the scripts must
be converted after the template is created. This enables the template administrator to apply
template workflow customization to linked projects. For more information, see HP Software
Self-solve knowledge base article KM494331
(http://h20230.www2.hp.com/selfsolve/document/KM494331).
l
Version Control: If you copy a version control enabled project, the new template is created
with version control enabled.
To create a template from an existing project:
1. In Site Administration, click the Site Projects tab.
2. Select the domain where you want to create the template.
3. Click the Create Template button. The Create Template dialog box opens.
HP ALM (12.50)
Page 58
Administrator Guide
Chapter 2: Creating Projects
4. Select Create a template by copying customization from an existing project and click Next. The
Copy from Project Customization dialog box opens.
5. In the Domain box, select the domain where the project you want to copy is located.
6. In the Project box, select the project you want to copy.
7. Select Link the selected project to this template to link the project to the newly created
template. This enables the template administrator to apply template customization changes to
the linked project.
Note: After you link a project to a template, the template administrator must apply
template customization to the project. This applies the customization from the template
to the linked project, and sets the applied customization to read-only in the project. For
more information, see "Applying Template Customization to Linked Projects" on page 295.
HP ALM (12.50)
Page 59
Administrator Guide
Chapter 2: Creating Projects
8. Click Next. The following dialog box opens.
9. In the Template Name box, type a name for the template. The template name cannot be longer
than 30 characters and cannot include any of the following characters: = ~ ` ! @ # $ % ^ & * ( ) + |
{}[]:';"<>?,./\10. In the In Domain box, select a domain.
Tip: After the template has been created, you can move it to a different domain in the
Projects list using a drag-and-drop operation.
11. Click Next. The following dialog box opens.
12. Under Database Type, select Oracle or MS-SQL.
HP ALM (12.50)
Page 60
Administrator Guide
Chapter 2: Creating Projects
The default values defined for the domain are displayed for Server Name, DB Admin User, and DB
Admin Password. If additional database servers are defined, you can select another name from
the Server Name list.
13. Click Next.
If your selected database server does not have the text search feature enabled, a message box
opens. The message indicates that after this process completes, you can enable the text search
feature. For more information on enabling the text search feature, see "Configuring Text Search"
on page 164.
14. If you are creating a Microsoft SQL template, proceed to step 15. For an Oracle template, the
following dialog box opens.
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new template. You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new template.
Click Next.
15. The Add Template Administrators dialog box opens.
HP ALM (12.50)
Page 61
Administrator Guide
Chapter 2: Creating Projects
Selected Template Administrators lists users that are assigned as template administrators.
Available Users lists users available in the template. When you assign template administrators,
the users are moved from the Available Users list to the Selected Template Administrators list.
Template administrator users can customize template projects and apply template customization
to linked projects. For more information, see "Cross Project Customization" on page 289.
l
l
l
Refresh. Click the Refresh button
to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button
Available Users list.
to search the
Add Selected Users. Select the users you want to assign as template administrators, and click
the Add Selected Users button
. Alternatively, double-click a user name. The selected users
are moved to the Selected Template Administrators list.
l
Delete. To remove a user from the Selected Template Administrators list, right-click the user
name and click Delete.
You can also assign template administrators after you have created the template. For more
information, see "Assigning Project Administrators" on page 73.
16. Click Next. The following dialog box opens.
HP ALM (12.50)
Page 62
Administrator Guide
Chapter 2: Creating Projects
Verify the template details. To change any of the details, click Back.
17. Select Activate template to activate the template. Only activated templates are available in the
HP Application Lifecycle Management Login window. For more information, see "Deactivating and
Activating Projects" on page 86.
18. Click Create. The new template is added to the Projects list under Template Projects.
Importing a Template Project
You can create a template project by importing data from an exported template project file created in
the current version. For more information on exporting projects, see "Exporting Projects" on page 85.
If you import a template that was previously exported from the same server, ALM recognizes that the
same template already exists on the server, based on the template ID. You can choose to replace the
existing template, or cancel the import process. If you choose to replace the existing template when
prompted, ALM overwrites the template, but does not overwrite connections to linked projects. The new
template remains linked to the same projects.
Note: The new template inherits the Unicode or ASCII definition of the imported template.
To import a template project:
1. In Site Administration, click the Site Projects tab.
2. Select the domain where you want to create the template.
3. Click the Create Template button. The Create Template dialog box opens.
4. Select Create a template by importing data from exported template file. The Create Template:
Select File for Import dialog box opens.
HP ALM (12.50)
Page 63
Administrator Guide
Chapter 2: Creating Projects
5. Click the browse button to the right of the Import template from box to locate the template
project that you want to import. The Open dialog box opens.
6. Locate the directory and select the ALM Project Export file that you want to import. Click Open. The
selected file is displayed in the Import template from box.
7. Click Next. The following dialog box opens.
8. Under Database Type, select Oracle or MS-SQL.
The default values defined for the domain are displayed for Server Name, DB Admin User, and DB
Admin Password. If additional database servers are defined, you can select another name from
the Server Name list.
9. Click Next.
If your selected database server does not have the text search feature enabled, a message box
opens. The message indicates that after this process completes, you can enable the text search
feature. For more information on enabling the text search feature, see "Configuring Text Search"
on page 164.
HP ALM (12.50)
Page 64
Administrator Guide
Chapter 2: Creating Projects
10. If you are creating a Microsoft SQL template, proceed to step 11. For an Oracle template, the
following dialog box opens.
In the Create in TableSpace box, select a storage location that has sufficient space to store the
new template. You should not use UNDO as the storage location.
In the Temporary TableSpace box, select a temporary storage location that has sufficient space to
store the new template.
Click Next.
11. The Add Template Administrators dialog box opens.
Selected Template Administrators lists users that are assigned as template administrators.
Available Users lists users available in the template. When you assign template administrators,
HP ALM (12.50)
Page 65
Administrator Guide
Chapter 2: Creating Projects
the users are moved from the Available Users list to the Selected Template Administrators list.
Template administrator users can customize template projects and apply template customization
to linked projects. For more information, see "Cross Project Customization" on page 289.
l
l
l
Refresh. Click the Refresh button
to refresh the list of available users.
Find. Type the name of a user in the Find box, and click the Find button
Available Users list.
to search the
Add Selected Users. Select the users you want to assign as template administrators, and click
the Add Selected Users button
. Alternatively, double-click a user name. The selected users
are moved to the Selected Template Administrators list.
l
Delete. To remove a user from the Selected Template Administrators list, right-click the user
name and click Delete.
You can also assign template administrators after you have created the template. For more
information, see "Assigning Project Administrators" on page 73.
12. Click Next. The following dialog box opens.
Verify the template details. To change any of the details, click Back.
13. Select Activate template to activate the template. Only activated templates are available in the
HP Application Lifecycle Management Login window. For more information, see "Deactivating and
Activating Projects" on page 86.
14. Select Enable Versioning to enable version control for the template. You can also enable version
control after you have created the template. For more information, see "Enabling and Disabling
Version Control for a Project" on page 87.
15. Click Create. The new template is added to the Projects list under Template Projects.
Linking a Template to Projects
You link a template to projects as part of cross project customization. The template administrator uses
cross project customization to apply template customization to the linked projects. You can link a
HP ALM (12.50)
Page 66
Administrator Guide
Chapter 2: Creating Projects
template to multiple projects, but you can link a project to only one template. For more information, see
"Cross Project Customization" on page 289.
Note: After you link a template to a project, the template administrator must apply template
customization to the project. This applies the customization from the template to the linked
project, and sets the applied customization to read-only in the project. For more information,
see "Applying Template Customization to Linked Projects" on page 295.
You can also link a template to a project when you create a project. For more information, see "Creating
Projects" on page 29. To link a template to a project when you create the template from an existing
project, see "Creating a Template from an Existing Project" on page 58.
To link a template to projects:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a template project. In the right pane, click the Linked Projects tab. The
Linked Projects list is displayed.
3. Click the Add button. The Projects list is displayed in the right pane.
4. Select projects from the Projects list, and click the Add Selected Projects button. The selected
projects are displayed in the Linked Projects list.
5. You can search for a project in the Linked Projects list by typing the name of a project in the Find
box, and clicking the Find button. You can also click on a column heading to change the sort order
of the projects in the Linked Projects list.
6. To remove a project from a template, in the Linked Projects list, select the project. To remove
more than one project, press the CTRL key and select the projects. Click Remove. Click OK to
confirm. This removes the project from the Linked Projects list, and the project is no longer linked
to the template.
7. To refresh the Linked Projects list or the Projects list, click the Refresh button above the
appropriate list.
HP ALM (12.50)
Page 67
Administrator Guide
Chapter 2: Creating Projects
Updating Project Details
You can view project details such as database type and project directory from the Project Details tab.
You can also edit various settings for the project. For example, you can edit the connection string,
change the number of users allowed to connect concurrently to the project, and enable the automatic
sending of defect email. Updated project details are written to the dbid.xml file, so that if a project is
restored, the updated project data is used. For more information, see "Restoring Access to Projects" on
page 93.
Tip: You can move a project to a different domain in the Projects list using a drag-and-drop
operation. This does not change the physical location of the project.
Cross Project Customization: If you are working with a template project, you update template details
from the Template Details tab.
ALM Editions: Template projects are not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To update project details:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project. In the right pane, select the Project Details tab. The project's
details are displayed.
Note: If a project is inactive, the project icon is displayed in red. To activate, see
HP ALM (12.50)
Page 68
Administrator Guide
Chapter 2: Creating Projects
"Deactivating and Activating Projects" on page 86.
3. Under Project Database, view the following project details:
Field
Description
Database
Type
The database type can be MS-SQL or Oracle.
Database
Name
The project name, as defined in the database.
Database
Server
The name of the database server on which the database is located.
Created From
Project
The project was copied from this project. An Empty Database value indicates that the project was not
Created From
Template
The project was copied from this template.
Restored
From Project
The project was restored from this project. For more information, see "Restoring Access to Projects"
Created From
Domain
The project was copied from this domain.
Restored
From Domain
The project was restored from this domain. For more information, see "Restoring Access to Projects"
Maintenance
State
Indicates whether a maintenance task is being performed on this project. Tasks include verifying,
repairing, upgrading, and realigning a project.
copied. For more information, see "Copying Projects" on page 36.
on page 93.
on page 93.
Possible values are:
l
Idle. No maintenance is being performed on this project.
l
Corrupted. Maintenance cannot be completed because the project is corrupted. To resume, a
backup copy of this project must be restored.
l
Under maintenance task. Maintenance is being performed on this project.
For more information on maintaining projects,see "Upgrading Projects to a New Version" on page
99.
Unicode
Supported
Indicates whether this project supports Unicode.
Connection
String
The connection string. To modify the connection string, see "Editing the Connection String" on page
DB User
Password
The user password for the Oracle server on which the database is located. To modify this password,
Project
Directory
The location of the project repository in the file system.
HP ALM (12.50)
93.
see "Modifying Database Server Properties" on page 162.
Page 69
Administrator Guide
Chapter 2: Creating Projects
Field
Description
Search
Language
Indicates the search languages for performing a text search. For more information, see "Selecting a
Exception
File
Indicates the location of the exception file to be used when running the upgrade process. For more
Text Search Language for a Project" on page 166.
information, see "Upgrading Domains and Projects" on page 111.
4. Under Repository Cleanup, promote or delay the scheduled project repository cleanup. For more
details on the project repository cleanup, see "Project Repository Cleanup" on page 78.
Click the available button:
l
l
Promote Repository Cleanup. Instructs ALM to cleanup the repository of the current project as
soon as possible.
Postpone Repository Cleanup. Instructs ALM to postpone the repository cleanup of the current
project, or to stop a cleanup that is in progress.
5. Under Project Planning and Tracking, view the following project details:
Field
Description
Indicates whether the project is included in the automatic daily project planning and tracking calculations
Automatic
Calculations of your site. For more information, see "Enabling or Disabling Automatic Calculations for a Project"
on page 178.
State
Run Now
Enables you to manually trigger project planning and tracking calculations for a project in order to
refresh its results without waiting for the next scheduled calculation. For more information, see
"Launching Calculations for a Project Manually" on page 179.
ALM Editions: Functionality related to project planning and tracking is available for ALM
Edition only. For more information about ALM editions and their functionality, see the HP
Application Lifecycle Management User Guide.
6. Under Miscellaneous, select Send mail automatically to enable the mail configuration settings for
a project. This sends email to specified users every time set defect fields are updated. If this check
box is not selected, mail configuration settings for the project have no effect and email is not sent.
For more information on configuring mail, see "Configuring Automail" on page 271.
The defect messages are sent automatically, at specified time intervals. You can edit the time
interval using the MAIL_INTERVAL parameter in the Site Configuration tab. You can also specify if
you want the email to include attachments and/or history. For more information, see "Setting ALM
Configuration Parameters" on page 168.
To manually send the defect messages that have accumulated during the current time interval,
click the Send Email Now button. If the Send mail automatically check box is not selected, defect
messages do not accumulate, so this button has no effect.
7. If you enable the Text Search link in the DB Servers tab after you have added a project to the
Projects list in the Site Projects tab (for example, after creating, upgrading, or migrating a project),
you must also click the Enable/Rebuild Text Search button. For more information, see "Enabling
HP ALM (12.50)
Page 70
Administrator Guide
Chapter 2: Creating Projects
Text Search in ALM" on page 165.
8. The Linked to Template field displays the name of the template that the project is linked to. For
more information on linked templates, see "Updating Linked Template Details" on page 298.
9. To change the number of users allowed to connect concurrently to the project, click the User
Quota link. The Project User Quota dialog box opens.
Choose Maximum connections and type the maximum number of concurrent connections allowed.
Click OK.
Note: The maximum number of users allowed to connect concurrently to the project
should not exceed the number of users allowed to connect to its domain. For more
information, see "Creating Domains" on page 27.
10. To add a description for the project, click the Description link. In the Edit Project Description dialog
box, type your description and click OK. By default, the project creation date is displayed.
11. Click the Refresh Projects List button
to refresh the projects in the selected domain. To
refresh projects in all domains, click the Refresh Projects List arrow and choose Refresh All
Domains.
12. To assign users to a project, see "Assigning Users to Projects" below.
Assigning Users to Projects
As a site administrator, you can control access to projects or template projects by defining the users
that can log on to the project. You can assign users to projects from the Users list, or copy users from
existing projects. You can also assign users as project administrators. For more information on
assigning project administrators, see "Assigning Project Administrators" on page 73.
When a user is no longer working on a project, remove the user from the project to ensure project
security. Removing a user from a project does not delete the user from the Users list. To remove the
user from the Users list, you must delete the user from the Site Users tab, as described in "Deleting
Users" on page 144.
HP ALM (12.50)
Page 71
Administrator Guide
Chapter 2: Creating Projects
Note:
l
As a project administrator, you can assign and remove users from projects, and change user
privileges from the Project Customization window. For more information, see "Managing
Users in a Project" on page 235.
l
You can assign projects to users from the Site Users tab. For more information, see
"Assigning Projects to Users" on page 142.
l
Automatic email notification is sent to project administrators when users are assigned or
removed from a project in Site Administration. You can make automatic notification
unavailable by adding the AUTO_MAIL_USER_NOTIFICATION parameter in the Site
Configuration tab. For more information, see "Setting ALM Configuration Parameters" on
page 168.
Cross Project Customization: If you are working with a template project, you assign users from the
Template Users tab.
ALM Editions: Template projects are not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To assign users to a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project. In the right pane, select the Project Users tab.
The users for the selected project are displayed.
You can click the User Name or Full Name column headers to change the sort order of user names
or full names in the Project Users list from ascending to descending. You can also click the Project
Administrator column header to group users by project administrators.
HP ALM (12.50)
Page 72
Administrator Guide
Chapter 2: Creating Projects
3. Click the Add button, and choose one of the following options:
l
Add From The Users List. The Users list is displayed to the right of the Project Users tab. Select
the users that you want to assign to the project. You can search for users by typing a search
string in the Find box above the Users list, and clicking the Find button
l
.
Copy From Another Project. The Projects list is displayed to the right of the Project Users tab.
To copy a user, click a project to expand the project directory, and select the user name check
box. To copy all users from a project, select the project's check box. To clear all selected users,
click Clear All.
4. Select users from the Users list or Projects list, and click the Add Selected Users button
.
Alternatively, double-click a user. The selected users are displayed in the Project Users list.
5. To remove a user from a project, select the user in the Project Users list and click the Remove
button. Click Yes to confirm. The user is removed from the Project Users list.
6. To refresh the Project Users list or Users list, click the Refresh button
list.
above the appropriate
Assigning Project Administrators
After you add users to projects you can assign users as project administrators (belonging to the
TDAdmin user group). Project administrators have full privileges in the project from the Project
Customization window. For more information, see "Managing User Groups and Permissions" on page
239.
When you copy users from other projects, they are added with the same user group privileges they had
in the project from which they were copied, provided the user group exists in this project. If the user
group does not exist in this project, the users are added with Viewer group privileges. If you copy a user
from another project in which the user is a project administrator, the user is automatically assigned as
a project administrator in this project.
When you add users to the project from the Users list, those users are added with Viewer group
privileges (read-only privileges).
Note: You can also assign project administrators when you create a new project. For more
information, see "Creating Projects" on page 29.
Cross Project Customization: If you are working with a template project, you assign users as template
administrators from the Template Users tab.
ALM Editions: Template projects are not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
HP ALM (12.50)
Page 73
Administrator Guide
Chapter 2: Creating Projects
To assign Project Administrator privileges to a user:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project. In the right pane, select the Project Users tab.
3. In the Project Users list, select the Project Administrator check box for each user you want to
assign as a project administrator.
4. To remove a user from the Project Administrator group, clear the Project Administrator check box,
and confirm you want to remove the user from the group.
Enabling Extensions for a Project
Extensions provide added functionality to ALM. If you have a license for an ALM extension, you can utilize
its added functionality after enabling the extension on a per project basis.
To view the list of extensions available with ALM, or to download documentation for ALM extensions,
visit the Add-ins page, available from Help > Add-ins.
Cross Project Customization: If an extension is enabled for a template project, the extension must also
be enabled for the template's linked projects. Linked projects can have additional extensions enabled.
ALM Editions: Template projects are not available for Quality Center Enterprise Edition. For
more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
You can also enable extensions for a project when you create a project. For more information, see
"Creating Projects" on page 29.
To enable extensions for a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project. In the right pane, click the Project Extensions tab.
The Extensions list displays the extensions that are enabled for the selected project.
HP ALM (12.50)
Page 74
Administrator Guide
Chapter 2: Creating Projects
3. To enable one or more extensions for the project, click the Enable Extensions button. The Enable
Extensions dialog box opens, displaying the list of extensions available for your ALM edition on the
ALM server.
Tip: Extensions for which there is no license on the server are displayed in gray. It is
possible to enable an extension for which you do not yet have a license. You can utilize the
extension's added functionality later, after receiving the license.
4. Select the Enable check box for the extensions you want to enable.
Note: You cannot disable an extension for a project after you enable it. We recommend
enabling only the extensions you need. Enabling extra extensions can affect performance
and consumes additional disk space.
As you navigate from one extension to another, relevant license status information is displayed in
the License Status section.
5. Click Enable. The selected extensions are enabled for the project, and the extension names are
displayed in the Extensions list.
HP ALM (12.50)
Page 75
Administrator Guide
Chapter 2: Creating Projects
6. To refresh the Extensions list, click the Refresh button
HP ALM (12.50)
.
Page 76
Chapter 3: Managing the Optimized Project
Repository
ALM stores all project files in a project repository located under the ProjRep directory. The files in this
directory are stored in an optimized folder structure that allows maximum storage space. In addition,
any two files with identical content are stored only once in the ProjRep directory. For example, if you
attach the same file to several ALM records, the file is stored only once in the project repository. This
results in a significant reduction in disk space, and reduced time in copy operations.
This section includes:
•
•
•
Project Repository Cleanup
78
Browsing the Project Repository
78
MRealigning Repositories
80
HP ALM (12.50)
Page 77
Administrator Guide
Chapter 3: Managing the Optimized Project Repository
Project Repository Cleanup
When you add a file to an entity, ALM checks whether an identical file exists in the project repository. If
an identical file is located, no physical file is added to the repository.
When you delete a file from an entity, the file is not immediately deleted from the project directory, as
it may still be used by other entities.
At regular intervals, the project repository is scanned for obsolete files that are no longer referenced by
any entity. If the files remain unreferenced for a specified period, they are removed from the project
repository. These intervals are set by default at seven days each. You can configure the intervals using
the site configuration parameters below.
You can promote or postpone a project's repository cleanup. For more details, see "Updating Project
Details" on page 68.
You can define the following site configuration parameters to regulate the project repository cleanup
process. For more information, see "Setting ALM Configuration Parameters" on page 168.
l
l
REPOSITORY_GC_PROJECT_CLEANUP_INTERVAL. Defines the time interval between cleanup
processes of each project repository.
REPOSITORY_GC_DELAY_CANDIDATE_TIME. Defines the time that elapses after obsolete files are
detected in a scan, and before the obsolete files are removed.
l
REPOSITORY_GC_JOB_PRIORITY. Defines the speed at which the cleanup process is performed.
l
SUSPEND_REPOSITORY_GC. Enables you to stop the project repository cleanup process.
Browsing the Project Repository
You can browse and edit files in the project repository using an FTP client. Most standard FTP clients
that support UTF-8 character encoding are compatible. The following clients are verified:
l
Filezilla
l
Total Commander Built-in FTP client
l
FlashFXP
You can configure the FTP service for a secure connection. For more information, see "Enabling Secure
FTP Connections" on the next page.
Caution: Making changes to the folders, files, or file content directly in the ProjRep directory,
not via an FTP client, will cause irreversible damage to the project repository.
HP ALM (12.50)
Page 78
Administrator Guide
Chapter 3: Managing the Optimized Project Repository
When making changes to repository files via an FTP client, consider the following:
l
It is safe to edit repository files via an FTP client. This will not damage the integrity of the optimized
repository.
l
Deleting a file will result in missing content in ALM entities.
l
Renaming folders and files may result in missing content in ALM entities.
To browse the project repository:
1. Start the FTP service. Add and configure the FTP_PORT parameter in the Site Configuration tab.
For more information, see "Setting ALM Configuration Parameters" on page 168.
2. Connect to the FTP server. In an FTP client, use the following connection values:
Field
Value
Host
The name or IP of the ALM server to which you want to connect.
Port
The FTP port. This should be the same value that you used for the FTP_PORT site parameter.
User
The username of an ALM site administrator.
Password
The password of the ALM site administrator.
3. Browse and edit repository files. After you connect to the FTP service, a list of the site domains is
displayed. Select a domain, and then select a project. The FTP client displays the project repository
directories.
Enabling Secure FTP Connections
You can connect to the FTP server using a secure connection.
To enable a secure FTP connection:
1. On the ALM server machine, generate a keystore file. Using the command line, go to C:\Program
Files\HP\HP Application LifeCycle Management <current version>\java\bin. Type keytoolgenkey-keystore keystore.jks to run the keystore utility, then follow the instructions.
2. Create an XML file, using the following format:
<ssl>
<keystore file="<keystore file path>" password="<keystore password>"/>
</ssl>
where <keystore file path> is the directory and file name of the keystore file, and <keystore
password> is the password you defined for the keystore.
Save the XML file as sslkeystore.xml.
3. Place the sslkeystore.xml file in the following directory: C:\ProgramData\HP\ALM\webapps\qcbin.
HP ALM (12.50)
Page 79
Administrator Guide
Chapter 3: Managing the Optimized Project Repository
4. Restart the FTP server by restarting the ALM service, or reconfiguring the FTP_PORT site
parameter.
5. In the FTP client, select the FTPS or SSL option. If you are using FileZilla, go to File > Site Manager
and click New Site. For Protocol, select FTP-File Transfer Protocol, and for Encryption, select
Require implicit FTP over TLs, and click connect.
MRealigning Repositories
ALM project repositories consist of the physical files that are stored in the file system, and database
tables that index the files. When you create a backup of a project that is active, the time gap between
the database and file system backups can cause discrepancies between the database file index and the
physical files.
For details on backup,see "Backing Up Projects" on page 116.
If you restore a project for online work from a backup that was performed while the project was active,
you must realign the file system and database tables.
The realigning process performs the following actions:
l
l
If a file is indexed in the database but is not located in the file system, the index of the file is
removed from the database.
If a file is stored in the file system but is not indexed in the database, the file is deleted from the file
system.
In addition, the realigning process verifies the integrity of the relationship between the logical and
physical database tables.
If an irrecoverable problem is detected, the project Maintenance State is changed to Corrupted. Check
the log for details, and examine the database tables.
By default, the realigning process runs in non-silent mode. When running the process in non-silent
mode, ALM may pause and prompt you for input when an error occurs. Instead, you can choose to run
the process in silent mode. When an error occurs, ALM will abort the process without prompting you for
input.
Note: Projects are deactivated while the realignment is in progress, and activated again after
the realignment is complete.
Realigning a Project
This section describes how to realign a single project.
To realign a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
HP ALM (12.50)
Page 80
Administrator Guide
Chapter 3: Managing the Optimized Project Repository
3. Click the Maintain Project
dialog box opens.
button and choose Realign Repository. The Realign Project
4. To run the realigning process without any user interaction, select Run in Silent Mode.
5. To start the realigning process, click the Realign Project button. If the project is active, you are
prompted to deactivate it. For more information, see "Deactivating and Activating Projects" on
page 86.
6. To save the messages displayed in the Realign Results pane to a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
7. To clear the messages displayed in the Realign Results pane, click the Clear Log button.
8. Click Close to close the Realign Project dialog box.
Realigning a Domain
This section describes how to realign all projects in a domain.
To realign a domain:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a domain.
3. Click the Maintain Domain
dialog box opens.
HP ALM (12.50)
button and choose Realign Repository. The Realign Domain
Page 81
Administrator Guide
Chapter 3: Managing the Optimized Project Repository
4. In the Realign Settings area, under Realign Mode, you can select the following options:
l
l
Run in Silent Mode. Runs the process without any user interaction.
Continue to next project if realign failed. Proceeds to the next project if the realign process
fails. This is the default option.
5. In the Realign Settings area, under After the Realign, you can select one of the following options:
l
l
Leave all projects deactivated. Leaves all projects deactivated after the realign process
completes.
Activate all projects. Activates all projects after the realign process completes.
6. To view the current version numbers of your projects, select the project names, or click Select All
to view version numbers for all projects. Click the Display Versions button.
The project version number is displayed in the Version column.
7. To realign your projects, select the project names, or click Select All to realign all projects. Click
the Realign Repository button.
8. To save the messages displayed in the Realign Results pane in a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
9. To clear the messages displayed in the Realign Results pane, click the Clear Log button.
10. Click Close to close the Realign Domain dialog box.
HP ALM (12.50)
Page 82
Chapter 4: Managing Projects
Site Administration enables you to manage and maintain HP Application Lifecycle Management (ALM)
domains and projects.
This chapter includes:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
About Managing Projects
84
Querying Project Tables
84
Exporting Projects
85
Deactivating and Activating Projects
86
Enabling and Disabling Version Control for a Project
87
Pinging Projects
88
Renaming Projects
88
Converting Projects to Unicode
89
Removing Projects
91
Deleting Projects
92
Deleting Domains
92
Editing the Connection String
93
Restoring Access to Projects
93
Renaming the Defects Module for a Project
96
Limiting Records Displayed in Grids
97
HP ALM (12.50)
Page 83
Administrator Guide
Chapter 4: Managing Projects
About Managing Projects
You manage ALM projects and template projects using Site Administration. After you create a project,
you can export the project, query the contents of the project by defining and running SQL statements,
deactivate/activate access to the project, and enable or disable version control for the project. You can
also remove a project, and restore access to an existing project.
Note: Users who are already logged into Lab Management need to re-enter the application to
see changes you made in Site Administration.
For more information on creating projects, see "Creating Projects" on page 25.
ALM Editions: ALM template projects are not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
Querying Project Tables
You can query specific data that is stored in your project or template project. You query a project by
defining and running SQL queries. The following examples show SQL queries and the results that they
return.
Query
Results
select * from BUG
where BG_STATUS = 'Open'
All defects that are open.
select * from BUG
where BG_RESPONSIBLE = 'james_alm' or BG_RESPONSIBLE =
'mary_alm'
All defects assigned to either James
or Mary.
select count (*) from BUG
where BG_RESPONSIBLE = 'mary_alm'
The number of defects assigned to
Mary.
select * from BUG
where BG_RESPONSIBLE='james_alm' and BG_STATUS='open'
All open defects assigned to James.
Using the first query example, the SQL query returns the following:
HP ALM (12.50)
Page 84
Administrator Guide
Chapter 4: Managing Projects
To query a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, double-click a project.
3. Select a table. ALM automatically runs the "SELECT *" query for this table and displays all the data
for the table in the SQL Query Results grid.
4. Define a query by typing an SQL statement in the SQL pane.
To navigate back to your previous SQL statement in the SQL pane, click the Up button
To navigate forward to your next SQL statement in the SQL pane, click the Down button
.
.
5. Click the Execute SQL button. The data returned by the query appears in the SQL Query Results
grid.
Tip: To export query results, your database administrator can run the same queries on the
project database and export the results for you. For details, see "Exporting Projects" below.
Exporting Projects
Exporting ALM projects or template projects enables you to take project data from an ALM server, and
back it up to another location or another media device. For example, you may want to create selfcontained project image files that are backed up on a USB storage device or DVD. You can send the
media device to an ALM server in another location, and import the project files. When you export a
project file, it is saved and exported in ZIP format.
Before exporting a project, consider the following guidelines:
l
l
l
If you export an ALM project that has extensions installed, all data from the project is exported,
including data for the extensions. You can only import such an exported project to a server that has
the relevant extensions installed.
You can only import ALM project files created in the same ALM version. For more information on
importing projects, see "Importing Projects" on page 42.
The project database schema and project file system repository combined should not exceed 4
gigabytes.
HP ALM (12.50)
Page 85
Administrator Guide
Chapter 4: Managing Projects
l
l
l
There must be adequate disk space available in your home directory on the ALM client machine to
temporarily store the exported project file, even if you choose an alternate location for saving the
file.
You will not be able to import the project onto the original server, if a project with the same PUID
exists on that server.
If the project was not part of Lab Management, when restoring access to the project:
l
Details about test runs will not be included in the Usage Reports.
l
Timeslot information and project settings information are lost.
To export a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project, and click the Export Project to Project File or Export
Template to Project File button
. Alternatively, right-click the project and choose Export
Project or Export Template. If the project is active, you are prompted to deactivate it. For more
information, see "Deactivating and Activating Projects" below.
3. The Save As dialog box opens. Select the directory where you want to save the project data. Type a
name for the project in the File name box. By default, the data is saved as an ALM Project Export
file (.qcp).
4. Click Save to save the project data as an ALM Project Export file.
Deactivating and Activating Projects
You can deactivate or activate a project or template project. When you deactivate a project, the project
name is removed from the Projects box in the ALM Login window. The project is not deleted from the
server. Any users currently connected to the project are forced to log out when you deactivate.
Note: It is recommended that you deactivate a project before you change any data that may
cause inconsistency for connected users.
To deactivate a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Deactivate Project or Deactivate Template button
connected users will be disconnected.
. A message box indicates that all
4. Click OK to confirm. The project is deactivated and the project icon is changed in the Projects list.
HP ALM (12.50)
Page 86
Administrator Guide
Chapter 4: Managing Projects
To activate a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Activate Project or Activate Template button
project icon is changed in the Projects list.
. The project is activated and the
Enabling and Disabling Version Control for a Project
You can enable version control for a project or template project. For more information on version
control, refer to the HP Application Lifecycle Management User Guide.
You can also disable version control for a project. When you disable version control for a project, ALM no
longer stores previous versions, and deletes all version history for the project. If you enable version
control for the project again, previous history is not available.
Note: After enabling version control for a project, you should review all its workflow scripts and
make adjustments for each checked in entity. This includes the following entities: Req, Test,
Resource, and Component. For each checked in entity that includes a Post function in its script,
you must modify the script. To modify, add a Checkout function before every Post function.
Making this modification prevents the Check Out dialog box from opening each time a call to a
Post function is made. For more information, see "Workflow Event Reference" on page 381.
To enable version control for a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Enable Versioning button
.
4. If the project is active, click Yes to deactivate it. Click OK to confirm.
5. When the process completes, click OK. Version control is enabled. ALM displays a lock icon
to the project name in the Projects list.
next
To disable version control for a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Disable Versioning button
.
4. If the project is active, click Yes to deactivate it. Click OK to confirm.
HP ALM (12.50)
Page 87
Administrator Guide
Chapter 4: Managing Projects
5. A message displays, indicating that when you disable version control, ALM deletes all version
history. Click OK to confirm.
6. Click Yes to disable version control. Version control is disabled. ALM removes the lock icon next to
the project name in the Projects list.
Pinging Projects
You can check whether a project database or template project database is accessible from Site
Administration.
To ping a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Ping Project or Ping Template button
.
4. Click OK when prompted with a message that the ping was successful.
Renaming Projects
You can rename a project or template project in the Projects list.
To rename a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Rename Project or Rename Template button. If the project is active, you are prompted
to deactivate it. For more information, see "Deactivating and Activating Projects" on page 86.
4. In the Rename Project dialog box, type the new name for the project and click OK.
The project name cannot be longer than 30 characters and can include only letters, digits, and
underscores.
Note: Support of non-English national characters depends on the database settings used
by the server. We do not recommend using non-English national characters in project
names.
The project is renamed in the Projects list.
HP ALM (12.50)
Page 88
Administrator Guide
Chapter 4: Managing Projects
Converting Projects to Unicode
This section describes how to convert projects to Unicode. You can select a specific project to convert,
or you can select a domain and convert its projects to Unicode.
Unicode is a feature of MS-SQL that allows multi-language support. In Oracle, multi-language support is
defined when installing the server.
You can convert the following types of projects to Unicode:
l
Projects that are version 11.5 or above.
l
Projects created on an MS SQL server.
l
Projects created in ASCII.
Caution: Unicode increases the memory required for the database server.
To convert projects in a domain to Unicode:
1. In Site Administration, click the Site Projects tab and select the domain whose projects you want to
convert.
2. Click the Maintain Domain
button and select Convert to Unicode in Domain. The Convert to
Unicode Domain dialog box opens.
Note: Convert to Unicode in Domain is only available if projects that can be converted to
Unicode exist in the selected domain.
3. Select the project or projects you want to convert and click Convert to Unicode. Under Convert to
Unicode Results, a log is displayed.
HP ALM (12.50)
Page 89
Administrator Guide
Chapter 4: Managing Projects
Tip: Click Display Versions to display the versions of the selected projects.
Note: Projects with columns whose length is greater than 4000 cannot be converted to
Unicode. The validation process fails and an error message is generated.
To fix the problem, either reduce the column length to 4000 or add the columns to the
alm_i18n_exceptions.xml exception file before converting. System defined columns and
system defined user fields must be reduced and cannot be added to the exception file.
4. To pause the conversion process, click the Pause button. To continue, click the Resume button.
5. To abort the conversion process, click the Abort button. Click Yes to confirm.
6. After the process has completed successfully or stopped due to failure, you can select one of the
following:
l
l
Clear Log. Clears the text displayed in the Convert to Unicode Results area. This disables the
Export Log button.
Export Log. Enables you to save the log as a .txt file. In the Export Log to File dialog box, select
a location and type a name for the file. Click Save.
7. Click Close to close the Convert to Unicode Domain dialog box.
To convert a project to Unicode:
1. In Site Administration, click the Site Projects tab and select the project you want to convert.
2. Click the Maintain Project
Unicode dialog box opens.
button and select Convert Project to Unicode. The Convert to
3. Click Convert to Unicode. Under Convert to Unicode Results, a log is displayed.
HP ALM (12.50)
Page 90
Administrator Guide
Chapter 4: Managing Projects
Note: Projects with columns whose length is greater than 4000 cannot be converted to
Unicode. The validation process fails and an error message is generated.
To fix the problem, either reduce the column length to 4000 or add the columns to the
alm_i18n_exceptions.xml exception file before converting. System defined columns and
system defined user fields must be reduced and cannot be added to the exception file.
4. To pause the conversion process, click the Pause button. To continue, click the Resume button.
5. To abort the conversion process, click the Abort button. Click Yes to confirm.
6. After the process has completed successfully or stopped due to failure, you can select one of the
following:
l
l
Clear Log. Clears the text displayed in the Convert to Unicode Results area. This disables the
Export Log button.
Export Log. Enables you to save the log as a .txt file. In the Export Log to File dialog box, select
a location and type a name for the file. Click Save.
7. Click Close to close the Convert to Unicode dialog box.
Removing Projects
You can remove a project or a template project from the Projects list in Site Administration. This does
not delete the project from the server and you can restore the project if necessary. For more
information on restoring access to a project, see "Restoring Access to Projects" on page 93.
Note: If the project is currently in use, it cannot be removed. For information about how to
manually remove a project, see HP Software Self-solve knowledge base article KM1457081
(http://h20230.www2.hp.com/selfsolve/document/KM1457081).
To remove a project from the Projects list:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Remove Project or Remove Template button
.
4. Click OK to confirm. If the project is still active, you are prompted to deactivate it. For more
information, see "Deactivating and Activating Projects" on page 86.
5. Click OK.
HP ALM (12.50)
Page 91
Administrator Guide
Chapter 4: Managing Projects
Deleting Projects
You can delete a project or template project from the Projects list in Site Administration. This deletes
the contents of the project from the server and you cannot restore the project.
Note: If the project is currently in use, it cannot be deleted. For information about how to
manually delete a project, see HP Software Self-solve knowledge base article KM1457081
(http://h20230.www2.hp.com/selfsolve/document/KM1457081).
To delete a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Delete Project or Delete Template button.
4. Click OK to confirm. If there are active users connected to the project, you are prompted to
disconnect them.
The Database Admin Password dialog box opens. If you did not specify a database administrator
user name or password, enter the database administrator's user name and password and click OK.
If you previously specified a database administrator user name or password, these credentials are
already entered in the dialog box.
5. Click OK.
Deleting Domains
You can delete a domain. It is removed from the Projects list, and its contents are deleted from the
server.
Note: You cannot delete a domain if it contains projects or template projects. To delete the
domain, you must first delete the projects. For more information, see "Deleting Projects" above.
To delete a domain:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a domain.
3. Click the Delete Domain button.
4. Click Yes to confirm.
HP ALM (12.50)
Page 92
Administrator Guide
Chapter 4: Managing Projects
Editing the Connection String
You can edit the connection string of a project or a template project.
To edit the connection string:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Edit Connection String button
or the Connection String link. If the project is still
active, you are prompted to deactivate it. For more information, see "Deactivating and Activating
Projects" on page 86.
The Connection String Editor dialog box opens.
4. In the Connection String box, modify the attributes of the connection string, such as the database
server name and port number.
5. To test the connection string, click Test Connection. In the Ping Database Server dialog box, type
the database administrator user name and password and click OK. If the connection is successful,
a confirmation message displays. Otherwise, an error message displays.
6. Click OK to save your connection string modification and close the Connection String Editor.
Restoring Access to Projects
You can restore access to an ALM project or template project that is not in your current Projects list in
Site Administration. For example, you may want to access a project from another server. After you
restore access to a project, it is added to the Projects list in Site Administration.
Note:
HP ALM (12.50)
Page 93
Administrator Guide
Chapter 4: Managing Projects
l
Before restoring the project, make sure that the database where the project resides exists in
the DB Servers tab in Site Administration on your ALM server. The ALM server needs to
access the contents of the restored project from the project's database. For more
information, see "Upgrading Projects to a New Version" on page 99.
l
When restoring a project, you should select the dbid.xml file located in the project
repository. This ensures that the project retains its original ID. If a project does not have its
original ID, the following cross project features may not function properly: cross project
customization, importing and synchronizing libraries, and cross project graphs.
l
If you are restoring your project from a different directory, or if you renamed your schema or
restored it to a different database, you must update the dbid.xml file accordingly. For
details, see "Updating the dbid.xml file" on the next page.
l
You must first restore and upgrade any template projects before restoring and upgrading
other projects. If the template project and its linked projects are in different databases,
ensure that the template project’s database is accessible when restoring any linked projects.
l
If you were previously working with Performance Center 11.00 or later, you must first
restore and upgrade LAB_PROJECT, and then any Performance Center template projects,
before restoring and upgrading other Performance Center projects. For details, see
"Restoring LAB_PROJECT" on page 119.
To restore access to an ALM project:
1. In Site Administration, click the Site Projects tab.
2. Click the Restore Project or Restore Template button
. The Restore Project dialog box opens.
3. To locate the file that includes the project that you want to restore, click the browse button to the
right of the dbid.xml file location box. The Open File dialog box opens.
4. Locate the file. For information on the location of the dbid.xml file, see "Understanding the Project
Structure" on page 26.
5. Select the dbid.xml file and click Open. The Restore Project dialog box opens and displays the
database type, name, server, and the directory path of the project.
HP ALM (12.50)
Page 94
Administrator Guide
Chapter 4: Managing Projects
6. In the Restore Into Domain box, select the domain in which you want the restored project to be
located.
7. Click Restore.
8. If your database server does not have the text search feature enabled, a message box opens. You
can enable the text search feature before or after this process completes.
l
l
Click Yes to continue this process. After the process completes, you can enable the text search
feature.
Click No to stop this process. Enable the text search feature and then restart the process.
For more information on enabling the text search feature, see "Configuring Text Search" on page
164.
9. When the restore process completes, click OK.
10. Click Close to close the Restore Project dialog box and view the restored project in the Projects list.
Updating the dbid.xml file
If you are restoring your project from a different directory, or if you renamed your schema or restored
it to a different database, for example, as part of the upgrade process, you must update the following
values:
l
l
l
l
l
DB_NAME. Update to the database schema name as it appears in the database server.
DB_CONNSTR_FORMAT. Update to the value of the the empty project created in ALM12.50. See the
note for details.
DBSERVER_NAME. This is the name of the database server as defined in the DB Servers tab in Site
Administration.
DB_USER_PASS.Update if the encrypted passphrase differs between the previous installation and
ALM 12.50.
PHYSICAL_DIRECTORY. Update to the new location of the project repository.It must contain a
backslash (\) at the end of the path.
HP ALM (12.50)
Page 95
Administrator Guide
Chapter 4: Managing Projects
Note:
l
In order to identify the values of DB_CONNSTR_FORMAT and DB_USER_PASS, it is
recommended to create a new, empty project in ALM 12.50 Site Administration, open the
project's dbid.xml file, and copy these values. You can later delete the empty project.
l
Make sure not to copy/paste or change the value for PR_SMART_REPOSITORY_ENABLED.
l
If you are restoring LAB_PROJECT or Performance Center projects as part of the upgrade
process, make sure not to edit the PROJECT_UID value. You must restore these projects with
their original PROJECT_UID value in order to maintain the links between LAB_PROJECT and its
associated Performance Center projects, important for shared data, such as timeslots, runs,
and so on.
Renaming the Defects Module for a Project
You can rename the Defects module for a specific project or template project. For example, you can
change the name of the Defects module from Defects to Bugs. You rename the Defects module by
adding a parameter to the DATACONST table of the project. For more information on modifying project
tables, see "Querying Project Tables" on page 84.
Note: You can rename any ALM module for all your projects by adding the REPLACE_TITLE
parameter in the Site Configuration tab. For more information, see "Setting ALM Configuration
Parameters" on page 168.
To rename the Defects module for a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, double-click the project for which you want to rename the Defects module.
3. Select the DATACONST table.
4. In the SQL pane, type an SQL INSERT INTO statement to insert a row into the table with the
following values:
l
l
In the DC_CONST_NAME column, insert the parameter name REPLACE_TITLE.
In the DC_VALUE column, insert a string that defines the new name for the Defects module, in
the following format:
original title [singular];new title [singular];original title [plural];new
title [plural]
For example, to change the name of the module from Defects to Bugs, type the following SQL
statement into the SQL pane:
insert into dataconst values ('REPLACE_TITLE', 'Defect;Bug;Defects;Bugs')
HP ALM (12.50)
Page 96
Administrator Guide
Chapter 4: Managing Projects
5. Click the Execute SQL button. The new row is added to the DATACONST table. The ALM project
displays the new Defects module name.
Limiting Records Displayed in Grids
To optimize performance, the number of records retrieved and displayed in ALM grids is limited. The
limits include:
l
Maximum number of records displayed in a grid.
l
Maximum number of records displayed for each group when a group by filter is applied to a grid.
To bypass the limit and display all relevant records, users can click the Retrieve all <x> results link in
the window or dialog box.
You can change the default limits for all site projects, or individually for each project. When you change
the limits for a project, they override default limits, or the values defined by the FETCH_LIMIT or
GROUP_FETCH_LIMIT parameters.
To change the default number of records displayed in grids for all site projects:
Add and configure the FETCH_LIMIT and GROUP_FETCH_LIMIT parameters in the Site Configuration
tab. For more information, see "Setting ALM Configuration Parameters" on page 168.
To change the default number of records displayed in grids per project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, double-click the project for which you want to change the default limits for
records displayed in a grid.
3. Select the DATACONST table.
4. In the SQL pane, type an SQL INSERT statement to insert a row into the table with the following
values:
l
l
In the DC_CONST_NAME column, insert the parameter name FETCH_LIMIT or GROUP_FETCH_
LIMIT.
In the DC_VALUE column, insert a value for the parameter.
For example, to change the value of the FETCH_LIMIT parameter to 50, type the following SQL
statement into the SQL pane:
insert into dataconst values ('FETCH_LIMIT', '50')
5. Click the Execute SQL button. The new row is added to the DATACONST table.
HP ALM (12.50)
Page 97
Administrator Guide
Chapter 4: Managing Projects
HP ALM (12.50)
Page 98
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
Chapter 5: Upgrading Projects to a New Version
To work in HP Application Lifecycle Management (ALM) 12.50 with projects created in previous Quality
Center and ALM versions, you must upgrade your projects to align them with the required configurations
of the current version of ALM.
To update multiple projects concurrently, use ALM Robot. For details, see "ALM Robot" on page 191.
Performance Center: To work with projects created in Performance Center versions 9.52 or
earlier, you must migrate your projects to align them with the required configurations of ALM.
For details, see the HP ALM Performance Center Installation Guide.
This chapter includes:
•
•
•
•
About Upgrading Projects
100
Understanding the Version/Patch Numbering Scheme
100
About Upgrading Projects for Major and Minor Versions
101
About Upgrading Projects for Minor-Minor Versions
123
HP ALM (12.50)
Page 99
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
About Upgrading Projects
This section describes the process required for performing:
l
l
Full upgrades of:
l
ALM projects from previous major and minor versions
l
Performance Center projects from ALM/Performance Center 11.00
Upgrades of ALM projects from previous ALM 11.5x minor-minor versions
For details on understanding whether a version is major, minor, or minor-minor, see the information
about understanding version numbering in "Understanding the Version/Patch Numbering Scheme"
below.
This chapter includes:
l
"Understanding the Version/Patch Numbering Scheme" below
l
"About Upgrading Projects for Major and Minor Versions" on the next page
l
"About Upgrading Projects for Minor-Minor Versions" on page 123
Understanding the Version/Patch Numbering Scheme
Version numbering follows the format: (Major)(Major).(Minor)(Minor-Minor).(Build)(Build)(Build)(Build)
Examples
Major version 11: 11.00.0000
Minor version 11.5: 11.50.0000
Minor-minor version 11.52: 11.52.0000
Patch 3 for major version 11: 11.00.0003
For details on this format, see the information about the Obsolescence Policy on the HP Support Site. To
access the site from within ALM, choose Help > Software Support Online. Alternatively, access the URL:
www.hp.com/go/hpsoftwaresupport.
HP ALM (12.50)
Page 100
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
About Upgrading Projects for Major and Minor Versions
This section describes the process required for working with:
l
Quality Center or ALM projects from previous versions
l
Performance Center projects from previous versions
Before upgrading, verify and repair your projects to detect and correct errors in your database user
schema and data.
Note:
l
Upgrade Methodology: To upgrade from a previous Quality Center version with the minimum
possible interruption to your system operations, you should be familiar with the
considerations and recommendations involved in the upgrade process. For information on
upgrade methodology, see the HP Application Lifecycle Management Upgrade Best Practices
Guide.
l
Product Feature Movie: To view a movie that presents the methodologies for upgrading to
HP ALM from a previous version, choose Help > Movies in the ALM main window.
l
This process describes upgrading projects for major and minor version upgrades. For details
on understanding whether a version is major or minor, see the information about
understanding version numbering in the "Understanding the Version/Patch Numbering
Scheme" on the previous page.
l
For details on minor-minor version upgrades, see "About Upgrading Projects for Minor-Minor
Versions" on page 123.
This section includes:
l
"Upgrade Versions" below
l
"Project Upgrade Considerations" on the next page
l
"Repository Migration Considerations" on page 103
l
"Upgrade Steps" on page 104
Upgrade Versions
The following table describes how to upgrade projects from previous Quality Center and ALM versions.
Note that not all projects can be upgraded directly to ALM 12.50.
From version:
To ALM 12.50:
ALM 11.52 - 12.20
Upgrade projects directly to ALM12.50.
Performance Center
Upgrade projects directly to ALM12.50.
HP ALM (12.50)
Page 101
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
From version:
To ALM 12.50:
11.52 - 12.20
Note: You must first upgrade LAB_PROJECT, and then any Performance Center
template projects, before upgrading Performance Center projects.
ALM 11.00
Projects must first be migrated to ALM 11.52. For details, see the HP ALM 11.52 Installation and
Upgrade Guide .
Performance Center
11.00
Projects must first be migrated to ALM 11.52. For details, see the HP ALM 11.52 Installation and
Upgrade Guide .
Note: You must first upgrade LAB_PROJECT, and then any Performance Center
template projects, before upgrading Performance Center projects.
Quality Center 10.00
Projects must first be migrated to ALM 11.52. For details, see the HP ALM 11.52 Installation and
Upgrade Guide .
Quality Center 9.2
Projects must first be upgraded to ALM 11.00.
Quality Center 9.0
Projects must first be upgraded to Quality Center 10.00.
Caution: Before performing any upgrade, the current repository must be moved to the correct
location for the new version.
Note: If you are upgrading from Quality Center 10.00, 9.2, or 9.0, you must convert the rich text
mechanism from Microsoft Word to HTML. For more information, see HP Software Self-solve
knowledge base article KM1116588
(http://h20230.www2.hp.com/selfsolve/document/KM1116588). (Requires HP Passport sign-in
credentials.)
Project Upgrade Considerations
Review the following before you upgrade projects to ALM 12.50:
l
Version Control:
l
l
Upgrading Quality Center 10.00 and ALM 11.00 or later version control enabled projects.
Version control enabled projects from Quality Center 10.00 or ALM 11.00 or later cannot be
upgraded to ALM 12.50 while there are checked out entities. All entities must be checked in to the
corresponding version of Quality Center or ALM. To determine if there are checked out entities,
see HP Software Self-solve knowledge base article KM00470884
(http://h20230.www2.hp.com/selfsolve/document/KM00470884). (Requires HP Passport sign-in
credentials.)
Upgrading from legacy version control projects. To work with projects from Quality Center 9.0
HP ALM (12.50)
Page 102
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
or Quality Center 9.2 that use version control, you must first upgrade to ALM11.00, migrate legacy
version control data, and then upgrade to ALM 12.50.
l
l
Server Locales: Before upgrading a project, ensure that the system locale on the ALM server,
database, and file servers, all match.
Performance Center: If you were working with Performance Center 11.00 or later, before upgrading
other Performance Center projects, you must first upgrade LAB_PROJECT, and then any Performance
Center template projects. For details, see "Restoring LAB_PROJECT" on page 119.
Repository Migration Considerations
When upgrading projects from Quality Center 10.00, the project file repositories are migrated to a new
optimized folder structure. Review the following to ensure that the file repositories are migrated
successfully to the new structure:
l
l
Allow for approximately twenty percent more space on the database.
Before running the upgrade tool, make sure that all project files are saved in the default project
directory.
To find out whether project files, such as tests and test resources, are outside the default project
directory, log in to Site Administration. In the Site Projects tab, expand each project and click the
DATACONST table. For each of the *_directory entries in the DC_CONST_NAME column, verify that
the corresponding DC_VALUE is a folder name in the default project directory, and not a path to
another directory. For example, verify that the DC_VALUE for tests_directory is set as tests, and
the DC_VALUE for resources_directory is set as resources.
l
l
l
l
l
l
l
l
Move any folders or files from the project repository that are not connected to ALM (for example,
backup folders, and scripts that are not part of workflow) to a directory outside the repository. Any
unrelated files remaining in the repository will be accessible via FTP only after the migration is
completed. For more details, see "Browsing the Project Repository" on page 78.
Make sure the ALM server has full permissions to the file server.
For information on configuring the resources allocated to building the index, see
http://h20230.www2.hp.com/selfsolve/document/KM862600.
Make sure there is no folder on the file system named ProjRep.
During and after the repository migration, no direct access to the file system is allowed. After the
migration is completed, you can browse and edit the optimized file system using an FTP client. For
more details, see "Browsing the Project Repository" on page 78.
To backup a project during and after the repository migration, follow the guidelines in
http://h20230.www2.hp.com/selfsolve/document/KM1373517.
When restoring a project to the new version of ALM, be sure not to change the <PR_SMART_
REPOSITORY_ENABLED> property in the dbid.xml file.
The space saving and performance benefits of the optimized repository are realized only after the
repository is fully migrated. Therefore, you should resolve any errors or warnings that occur during
the migration, and ensure the migration is complete.
HP ALM (12.50)
Page 103
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
l
If the ALM, database or file servers are over WAN, the migration process takes many times longer
than over LAN.
Upgrade Steps
The upgrade workflow consists of the following steps:
1. Verify project. Detects problems in your environment, schema structure, and data integrity that
could cause the project upgrade to fail.
The verification process generates a report which indicates problems that can be repaired by ALM
and problems that you should repair manually. For more information, see "Verifying Domains and
Projects" below.
2. Repair project. Fixes data and schema issues found by the verification process. If the verification
process finds problems that can cause data loss, the repair process does not fix them
automatically. You need to repair these problems manually. For more information, see "Repairing
Domains and Projects" on page 108.
Before you start the repair process, you should back up your project. For more information, see
"Backing Up Projects" on page 116.
In the event that the repair fails, you must restore backed up projects before trying the repair
process again. For more information, see "Restoring Projects" on page 117.
3. Upgrade project. Upgrades your project to the current version of ALM. For more information, see
"Upgrading Domains and Projects" on page 111.
Before you upgrade the project, back up your project. For information, see "Backing Up Projects" on
page 116.
In the event that the upgrade fails, you must restore backed-up projects before trying the upgrade
process again. For information, see "Restoring Projects" on page 117.
4. Manage project repository migration. After upgrading a project from Quality Center 10.00 to ALM
12.50, ALM migrates the project repository directories to a new file structure in the default project
repository location. If the migration process fails, you must fix the problems manually in the
project repository. You can also configure the speed at which the migration is performed. For more
information, see "Migrating the Repository" on page 119.
For detailed information on the problems detected and fixed by the verification and repair
processes, and help with repairing problems that cannot be fixed by ALM, refer to the Upgrade
Preparation Troubleshooting appendix in the HP Application Lifecycle Management Installation and
Upgrade Guide.
Verifying Domains and Projects
Before you upgrade a project, you run the verification process to check the correctness of your
database user schema and data. Although your database user schema and data may be correct for your
previous Quality Center or ALM version, they may not be consistent with the specifications for the
current version of ALM.
HP ALM (12.50)
Page 104
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
The verification process detects problems in your environment, settings, schema structure, and data
integrity that could cause the upgrade to fail. It generates a verification report which alerts you to
problems that can be repaired by ALM and problems that you should manually repair.
By default, the verification report is saved on the ALM server machine. To change this default location,
use the VERIFY_REPORT_FOLDER site parameter.
After the project has been verified, you can still use it with a previous version of Quality Center or ALM.
For detailed information on the problems detected by the verification process, see the HP Application
Lifecycle Management Installation and Upgrade Guide.
You can define an exception file to instruct ALM to ignore errors detected while running the verification,
repair, or upgrade process. For more information, see "Defining an Exception File" on page 114.
This section includes:
•
•
Verifying a Project
105
Verifying a Domain
106
Verifying a Project
This section describes how to verify a single project.
To verify a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. Click the Maintain Project
opens.
HP ALM (12.50)
button and choose Verify Project. The Verify Project dialog box
Page 105
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
4. Click the Verify Project button to start the verification process. In the Verify Results pane, log
messages are displayed.
If an error occurs while running the process, a message box opens. Click the Abort or Retry buttons
accordingly.
5. To pause the verification process, click the Pause button. To continue, click the Resume button.
6. To abort the verification process, click the Abort button. Click Yes to confirm.
7. To save the messages displayed in the Verify Results pane to a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
8. To clear the messages displayed in the Verify Results pane, click the Clear Log button.
9. When the verification process completes, the Verify Results pane displays the location of the
verification report. By default, the file is located in the following directory: <ALM Repository
Path>\sa\DomsInfo\MaintenanceData\out\<Domain Name>\<Project Name>.
10. Analyze the verification report. The report indicates both problems that can be repaired by ALM
automatically, and the problems that you need to repair manually.
11. Click Close to close the Verify Project dialog box.
Verifying a Domain
This section describes how to verify all projects in a domain.
To verify a domain:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a domain.
3. Click the Maintain Domain button
opens.
HP ALM (12.50)
and choose Verify Domain. The Verify Domain dialog box
Page 106
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
4. To view the current version numbers of your projects, select the project names, or click Select All
to view version numbers for all projects. Click the Display Versions button.
The project version number is displayed in the Version column.
5. To verify your projects, select the project names, or click Select All to verify all projects. Click the
Verify Projects button.
If an error occurs while running the process, a message box opens. Click the Abort or Retry buttons
accordingly.
6. To pause the verification process, click the Pause button. To continue, click the Resume button.
7. To abort the verification process, click the Abort button. Click Yes to confirm.
8. To save the messages displayed in the Verify Results pane to a text file, click the Export Log
button. In the Export Log to File dialog box, choose the location and type the name for the file. Click
Save.
9. To clear the messages displayed in the Verify Results pane, click the Clear Log button.
10. When the verification process completes, the Verify Results pane displays the location of each
verification report. By default, the files are located in the following directory: <ALM Repository
Path>\repository\sa\DomsInfo\MaintenanceData\out\<Domain Name>\<Project Name>.
11. Analyze the verification report. The report indicates problems that can be repaired by ALM and the
problems that you need to repair manually.
12. Click Close to close the Verify Domain dialog box.
HP ALM (12.50)
Page 107
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
Repairing Domains and Projects
The repair process fixes most data and schema issues found by the verification process. If the
verification process finds problems that can cause data loss, the repair process does not fix these
automatically. You need to repair these problems manually. To find out whether a particular issue is
handled automatically or manually, refer to the verification report.
By default, the repair process runs in non-silent mode. When running the process in non-silent mode,
ALM may pause and prompt you for input when an error occurs. Instead, you can choose to run the
process in silent mode. When an error occurs, ALM aborts the process without prompting you for input.
After the project has been repaired, you can still use it with a previous Quality Center or ALM version.
For detailed information on the problems fixed by the repair process, and help with repairing problems
that cannot be fixed by ALM, refer to the Upgrade Preparation Troubleshooting appendix in the HP
Application Lifecycle Management Installation and Upgrade Guide.
This section includes:
•
•
Repairing a Project
108
aRepairing a Domain
109
Repairing a Project
This section describes how to repair a single project.
To repair a project:
1. Back up your project. For more information, see "Backing Up Projects" on page 116.
2. Repair problems that cannot be fixed by ALM, as indicated in your verification report (see Step 9 of
"Verifying a Project" on page 105).
3. In Site Administration, click the Site Projects tab.
4. In the Projects list, select a project.
5. Click the Maintain Project
opens.
HP ALM (12.50)
button and choose Repair Project. The Repair Project dialog box
Page 108
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
6. To run the repair process without any user interaction, select Run in Silent Mode.
7. To start the repair process, click the Repair Project button. If the project is active, you are
prompted to deactivate it. For more information, see "Deactivating and Activating Projects" on
page 86.
If an error occurs while running the process in non-silent mode, a message box opens. Click the
Abort or Retry buttons accordingly.
8. To pause the repair process, click the Pause button. To continue, click the Resume button.
9. To abort the repair process, click the Abort button. Click Yes to confirm.
10. To save the messages displayed in the Repair Results pane to a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
11. To clear the messages displayed in the Repair Results pane, click the Clear Log button.
12. Click Close to close the Repair Project dialog box.
aRepairing a Domain
This section describes how to repair all projects in a domain.
To repair a domain:
1. Back up your projects. For more information, see "Backing Up Projects" on page 116.
2. Repair problems that cannot be fixed by ALM, as indicated in your verification report (see Step 10
of "Verifying a Domain" on page 106).
3. In Site Administration, click the Site Projects tab.
HP ALM (12.50)
Page 109
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
4. In the Projects list, select a domain.
5. Click the Maintain Domain
opens.
button and choose Repair Domain. The Repair Domain dialog box
6. In the Repair Settings area, under Repair Mode, you can select the following options:
l
l
Run in Silent Mode. Runs the process without any user interaction.
Continue to next project if repair failed. Proceeds to the next project if the repair process
fails. This is the default option.
7. In the Repair Settings area, under After the Repair, you can select one of the following options:
l
l
l
Leave all projects deactivated. Leaves all projects deactivated after the repair process
completes.
Activate only currently active projects. Reactivates previously-activated projects after the
repair process completes. This is the default option.
Activate all projects. Activates all projects after the repair process completes.
8. To view the current version numbers of your projects, select the project names, or click Select All
to view version numbers for all projects. Click the Display Versions button.
The project version number is displayed in the Version column.
9. To repair your projects, select the project names, or click Select All to verify all projects. Click the
Repair Projects button.
If an error occurs while running the process in non-silent mode, a message box opens. Click the
Abort or Retry buttons accordingly.
10. To pause the repair process, click the Pause button. To continue, click the Resume button.
11. To abort the repair process, click the Abort button. Click Yes to confirm.
HP ALM (12.50)
Page 110
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
12. To save the messages displayed in the Repair Results pane in a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
13. To clear the messages displayed in the Repair Results pane, click the Clear Log button.
14. Click Close to close the Repair Domain dialog box.
Upgrading Domains and Projects
After the project has been verified and repaired, you can proceed to upgrade your project to the current
version of ALM.
For more information on the overall upgrade process, including prerequisites, see "About Upgrading
Projects" on page 100.
By default, the upgrade process runs in non-silent mode. When running the process in non-silent mode,
ALM may pause and prompt you for input when an error occurs. Instead, you can choose to run the
process in silent mode. When running the process in silent mode, ALM aborts the process without
prompting you for input.
After the project has been upgraded, you can no longer use the project with a previous version of
Quality Center.
Note:
l
During the upgrade process, the project directory must be accessible. For example, if your
project directory is located on a file server, ensure that the server is running.
l
Version Control: Version control enabled projects from Quality Center 10.00 or ALM 11.00
cannot be upgraded to ALM 12.50 while there are checked out entities. All entities must be
checked in in the corresponding version of Quality Center or ALM.
l
Performance Center: If you were working with Performance Center 11.00, before upgrading
other Performance Center projects, you must first upgrade LAB_PROJECT, and then any
Performance Center template projects. For details on LAB_PROJECT, refer to the HP ALM Lab
Management Guide.
This section includes:
•
•
Upgrading a Project
112
Upgrading a Domain
113
HP ALM (12.50)
Page 111
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
Upgrading a Project
This section describes how to upgrade a single project.
To upgrade a project:
1. If you have backed up your project during the repair process (see "Repairing Domains and Projects"
on page 108), proceed to step 3.
2. Back up your projects. For more information, see "Backing Up Projects" on page 116.
3. In Site Administration, click the Site Projects tab.
4. In the Projects list, select a project.
5. Click the Maintain Project
box opens.
button and select Upgrade Project. The Upgrade Project dialog
6. To run the upgrade process without any user interaction, select Run in silent mode.
7. To start the upgrade process, click the Upgrade Project button. If the project is active, you are
prompted to deactivate it. For more information, see "Deactivating and Activating Projects" on
page 86"Deactivating and Activating Projects" on page 86.
If an error occurs while running the process in non-silent mode, a message box opens. Click the
Abort or Retry buttons accordingly.
If the upgrade fails, ALM displays an error message with reasons for the failure and refers you to
the log file. You must restore the backed up project before you try to upgrade again. For more
information, see "Restoring Projects" on page 117.
8. To pause the upgrade process, click the Pause button. To continue, click the Resume button.
HP ALM (12.50)
Page 112
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
9. To abort the upgrade process, click the Abort button. Click Yes to confirm.
10. To save the messages displayed in the Upgrade Results pane to a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
11. To clear the messages displayed in the Upgrade Results pane, click the Clear Log button.
12. Click Close to close the Upgrade Project dialog box.
Upgrading a Domain
This section describes how to upgrade all projects in a domain.
To upgrade a domain:
1. If you have backed up your project during the repair process (see "Repairing Domains and Projects"
on page 108), proceed to step 3.
2. Back up your projects. For more information, see "Backing Up Projects" on page 116.
3. In Site Administration, click the Site Projects tab.
4. In the Projects list, select a domain.
5. Click the Maintain Domain
box opens.
button and select Upgrade Domain. The Upgrade Domain dialog
6. In the Upgrade Settings area, under Upgrade Mode, you can select the following options:
l
l
Run in Silent Mode. Runs the process without any user interaction.
Continue to next project if upgrade failed. Proceeds to the next project if the upgrade
process fails. This is the default option.
HP ALM (12.50)
Page 113
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
7. In the Upgrade Settings area, under After the Upgrade, you can select one of the following
options:
l
l
l
Leave all projects deactivated. Leaves all projects deactivated after the upgrade process
completes.
Activate only currently active projects. Reactivates previously-activated projects after the
upgrade process completes. This is the default option.
Activate all projects. Activates all projects after the upgrade process completes.
8. To view the current version numbers of your projects, select the project names, or click Select All
to view version numbers for all projects. Click the Display Versions button.
The project version number is displayed in the Version column.
9. To upgrade your projects, select the project names, or click Select All to verify all projects. Click
the Upgrade Projects button.
If an error occurs while running the process in non-silent mode, a message box opens. Click the
Abort or Retry buttons accordingly.
If the upgrade fails, ALM displays an error message with reasons for the failure and refers you to
the log file. You must restore the backed up projects before you try to upgrade again. For more
information, see "Restoring Projects" on page 117.
10. To pause the upgrade process, click the Pause button. To continue, click the Resume button.
11. To abort the upgrade process, click the Abort button. Click Yes to confirm.
12. To save the messages displayed in the Upgrade Results pane in a text file, click the Export Log
button. In the Export Log to File dialog box, choose a location and type a name for the file. Click
Save.
13. To clear the messages displayed in the Upgrade Results pane, click the Clear Log button.
14. Click Close to close the Upgrade Domain dialog box.
Defining an Exception File
If you have made changes to the schema such as the addition of tables or columns, the upgrade process
may fail. You can define an exception file for objects that are added manually to the database user
schema, and are not defined in the schema configuration file. This instructs ALM to ignore these
changes during the upgrade process.
You can use the exception file to ignore warnings for extra tables, views, columns, and sequences. For
any other problem that requires manual repair, consult with your database administrator.
You must use the same exception file when running the verification, repair, or upgrade process.
You can set an exception file for a single project or for all projects in Site Administration.
Caution: Using the exception file to ignore warnings for objects that are added manually to the
schema may compromise the stability of your project upgrade and the validity of the database
HP ALM (12.50)
Page 114
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
user schema.
To define an exception file:
1. Copy the SchemaExceptions.xml file from the ALM installation directory. By default, the file is
located in <ALM installation path>\data\sa\DomsInfo\MaintenanceData.
2. Create the exception file, for example, my_exceptions.xml, and define the exceptions as follows:
Examples
l
For an extra table:
<TableMissing>
<object pattern="MY_Table" type="extra"/>
</TableMissing>
l
For an extra view:
<ViewMissing>
<object pattern="MY_VIEW" type="extra"/>
</ViewMissing>
l
For an extra column:
<ColumnMissing>
<object pattern="MY_COLUMN" type="extra"/>
</ColumnMissing>
l
For an extra sequence:
<SequenceMissing>
<object pattern="MY_SEQUENCE" type="extra"/>
</SequenceMissing>
3. To set an exception file for a single project:
a. In Site Administration, click the Site Projects tab.
b. In the Projects list, select a project. In the right pane, select the Project Details tab. The
project's details are displayed.
c. Under Project Database, click Exception File. The Edit Exception File dialog box opens.
d. Type the file location. The file is located under
<ALM deployment path>\sa\DomsInfo\MaintenanceData.
4. To set an exception file for all projects:
a. In Site Administration, click the Site Configuration tab.
b. Add the UPGRADE_EXCEPTION_FILE parameter to the list of parameters and define the
exception file location. The file is located under
HP ALM (12.50)
Page 115
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
<ALM deployment path>\sa\DomsInfo\MaintenanceData.
For more information on setting parameters, see "Setting ALM Configuration Parameters" on
page 168.
Backing Up Projects
When you run the repair or upgrade process, ALM performs changes on your projects to align them with
the specifications for the current version of ALM. You must back up your projects before you start to
repair or upgrade them.
We strongly recommend that you deactivate projects before backing them up. If you must back up while
your project is still active, you must back up the database before the file system. We also recommend
backing up the file system as soon as possible after backing up the database.
To make sure the Garbage Collector does not delete obsolete files while the file system is pending
backup, there is a one week grace period before deletion. For details, see the REPOSITORY_GC_DELAY_
CANDIDATE_TIME site parameter.
Note:
l
The repair process makes changes to the project database schema only. Before running the
repair process, you should back up the project database schema on the database server, but
you do not need to back up the project data in the file system.
l
Before you run the upgrade process, perform a full backup of your projects that includes the
project database schema and the project data.
To back up the project database schema on the database server:
l
l
Microsoft SQL database. For information on backing up a schema on a Microsoft SQL database, see
HP Software Self-solve knowledge base article KM169526
(http://h20230.www2.hp.com/selfsolve/document/KM169526).
Oracle database. For information on backing up a schema on an Oracle database, see HP Software
Self-solve knowledge base article KM205839
(http://h20230.www2.hp.com/selfsolve/document/KM205839).
To back up the project data in the file system:
l
l
In the file system, ensure that all data, including automated tests scripts and results, and
attachments, is saved in the project directory under the repository defined during the installation of
ALM. Make a copy of this project directory including all subdirectories and files.
For upgrade from Quality Center 10.00: If your automated tests are stored outside the project
directory, make a copy of them.
HP ALM (12.50)
Page 116
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
Tip: To find out whether your tests are outside the project directory, log in to Site
Administration. In the Site Projects tab, expand the project you want to back up and click the
DATACONST table. Select the DC_CONST_NAME parameter with the value tests_directory
and verify the corresponding DC_VALUE. If it is not set as tests but is set instead to some
other location, then your tests are outside of the project folder.
Restoring Projects
If the repair or upgrade process fails, you must restore the backed up projects before trying the
process again. You can restore projects that were backed up on an Oracle or Microsoft SQL database
server, and in the file system. A project you restore can be used only in the ALM/Quality Center version
from which it was backed up.
If you are restoring projects as part of your overall upgrade process, for example -- if you are moving to
a new server or database, you must update the dbid.xml file accordingly. For details, see "Restoring
Access to Projects" on page 93.
If you were previously working with Performance Center 11.00, see "Restoring LAB_PROJECT" on page
119.
This section includes:
•
•
•
•
Restoring Projects from a Microsoft SQL Database Server
117
Restoring Projects from an Oracle Database Server
118
Restoring a Repository from the File System
118
Restoring LAB_PROJECT
119
Restoring Projects from a Microsoft SQL Database Server
This section describes how to restore a project backed up on a Microsoft SQL database server.
For more information, see HP Software Self-solve knowledge base article KM169526
(http://h20230.www2.hp.com/selfsolve/document/KM169526).
To restore a project from a Microsoft SQL database server:
1. From the SQL Server Enterprise Manager, navigate to the database and select Tools > Restore
Database.
2. Navigate to the backup file, and follow the restore procedure to complete the data restore
process.
3. In Site Administration, restore the project. If you are restoring your project from a different
directory, or if you renamed your schema, you must update the dbid.xml file accordingly. For
details, see "Restoring Access to Projects" on page 93.
HP ALM (12.50)
Page 117
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
4. If the backup was performed while the project was active, realign the project repository. For more
information, see "MRealigning Repositories" on page 80.
Restoring Projects from an Oracle Database Server
This section describes how to restore a project backed up on an Oracle database server.
For more information, see HP Software Self-solve knowledge base article KM205839
(http://h20230.www2.hp.com/selfsolve/document/KM205839).
To restore a project from an Oracle database server:
1. Copy the backup file to the Oracle server machine.
2. Using the SQL*Plus utility, log in to the Oracle server using the system account.
3. Create a user for the ALM project. Make sure you create it with the same name as the project
name (or the Oracle user name) when the project was exported.
Use these SQL statements:
CREATE USER [<project name>] IDENTIFIED BY tdtdtd DEFAULT TABLESPACE TD_data
TEMPORARY TABLESPACE TD_TEMP;
GRANT CONNECT,RESOURCE TO [<project name>];
4. On the ALM installation DVD, locate the \Utilities\Databases\Scripts directory. Open the qc_
project_db___oracle.sql file and follow the instructions.
5. Using the command line, type imp to run the import utility.
6. Follow the prompt, and log in to the Oracle server using the system account. Make sure you import
all the dump files.
After all tables have been successfully imported, a confirmation message displays.
7. In Site Administration, restore the project. If you are restoring your project from a different
directory, or if you renamed your schema, you must update the dbid.xml file accordingly. For more
information on restoring access to projects, see "Restoring Access to Projects" on page 93.
8. If the backup was performed while the project was active, realign the project repository. For more
information, see "MRealigning Repositories" on page 80.
Restoring a Repository from the File System
This section describes how to restore a repository backed up in the file system.
To restore a repository from the file system:
1. Copy the backed up repository to the ALM repository.
2. In Site Administration, restore the project. If you are restoring your project from a different
directory, or if you renamed your schema, you must update the dbid.xml file accordingly. For more
information on restoring access to projects, see "Restoring Access to Projects" on page 93.
3. If the backup was performed while the project was active, you must restore the database and the
file system from a backup that was created after the database backup was created, realign the
HP ALM (12.50)
Page 118
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
project, and then activate the project. This procedure must always be performed during disaster
recovery. For more information, see "MRealigning Repositories" on page 80. If this process is done
in order to recover certain files or directories, you can skip the realignment.
Restoring LAB_PROJECT
If you were previously working with Performance Center 11.52, and ALM 12.50 is installed on a new
server, you must restore your backed up projects on the new server. Before restoring and upgrading
other Performance Center projects, you must first restore and upgrade LAB_PROJECT, and then any
Performance Center template projects.
You restore LAB_PROJECT from the Lab Management tab in Site Administration. For details, refer to the
HP ALM Lab Management Guide.
Restoring Performance Center 11.52 projects includes the following steps:
1. If a new Site Administration schema was created during installation, a new LAB_PROJECT was
created. To restore your Performance Center 11.52 LAB_PROJECT, you must first remove the new
LAB_PROJECT from the ALM 12.50 server.
2. In ALM 12.50 Site Administration, restore your Performance Center 11.52 LAB_PROJECT.
3. Proceed with the verify, repair, and upgrade of your LAB_PROJECT. For details, see "About
Upgrading Projects" on page 100.
If the verification process fails and you receive an error message that project fields cannot be
decrypted using the Confidential Data Passphrase, refer to the Encrypted Values section in the
Upgrade Preparation Troubleshooting appendix in the HP Application Lifecycle Management
Installation and Upgrade Guide.
4. Restore, verify, repair, and upgrade any Performance Center 11.52 template projects.
Note: Performance Center 11.52 template projects must be restored to the
DEFAULT domain.
5. Restore, verify, repair, and upgrade your Performance Center 11.52 projects.
Migrating the Repository
ALM versions 11.00 and later use a new project repository architecture, that is optimized to allow
maximum storage space. For details on the new repository, see "Managing the Optimized Project
Repository" on page 77.
When upgrading projects from Quality Center 10.00 to ALM 11.52, the project repository is automatically
upgraded to the optimized repository format. This is carried out in two stages:
1. The first stage is performed during the upgrade of the project. In this stage, all files in the
repository are scanned, and their names are stored in a project table.
2. After upgrade is completed, the project is reactivated. The repository files are gradually migrated
HP ALM (12.50)
Page 119
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
to the new system. In this stage, the files are moved from their old location to their new location in
the optimized repository. Depending on various factors, such as the size of the repository and the
network speed, the file migration may take up to several days.
This second phase of the repository migration is carried in the background. Users can work in the
project even while it is in progress. New files that you add to a project after upgrade are saved in
the new project repository.
Note:
l
Until the migration process for a project is complete, you cannot export or copy the project.
l
To back up a project before its migration is complete, you must suspend the migration
process. For more details, see "Configure Migration Priority" on page 122.
Monitor the migration progress in the Repository Migration Status window, and troubleshoot any
problems that may occur.
In Site Administration, you can track the status of file migration for each project, and configure the
number of resources allocated to performing the migration.
This section includes:
•
•
Repository Migration Status Window
120
Configure Migration Priority
122
Repository Migration Status Window
This window lists all the site projects and displays the status of their migration to the optimized project
repository.
HP ALM (12.50)
Page 120
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
To access In Site Administration, select Tools > Repository Migration Status.
See also
l
"Migrating the Repository" on page 119
l
"Configure Migration Priority" on the next page
l
"Managing the Optimized Project Repository" on page 77
User interface elements are described below:
UI Element
Description
Instructs ALM to resume the migration of the selected project.
If an error or warning was detected during the migration of the selected project, fix the problem as
described in the Additional Information field, and click Resume.
Note: If the migration process stopped due to missing files, after clicking Resume,
you can no longer restore missing files.
Downloads a log of the migration events associated with the selected project.
Refresh. Refreshes the display with the most up-to-date information.
Note: The grid updates automatically after the migration of every 1000 files.
Domain Name
The domain to which the selected project belongs.
Project Name
The name of the selected project.
Project Status
Indicates the selected project's status in Site Administration. For example, Active or
Deactivated .
Note: Deactivating a project does not affect its repository migration.
Migration Status
The migration status of a project can be one of the following:
l
None. Project is not upgraded to ALM 12.50, and will not be migrated.
l
Pending. File migration is pending.
l
Migrating. File migration is in progress.
l
Done. File migration is complete.
l
l
Error. An error occurred during file migration, and migration could not be completed. See the cause
of the error in the Additional Information panel. Fix the error, and click Resume.
Warning. A warning occurred during file migration.
For details of the warning, and the actions you must take to resolve the problem, download the log
files listed in the Additional Information panel. Resolve the problems as necessary, and click
Resume to complete the migration.
There are several possible causes for warnings:
l
HP ALM (12.50)
One or more project files were not found in the project repository. This can result from missing or
Page 121
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
UI Element
Description
renamed files.
l
Redundant files are found in the repository. The migration cannot complete until the legacy
repository is empty of files. Redundant files can be one of the following:
l
Duplicate project files that could not be deleted. This can result from insufficient permissions.
l
Files unrelated to ALM that were manually saved in the project repository.
l
Unidentified project files.
Migration Progress The number of project files migrated to the new repository, as a percentage of the total number of
project files.
Additional
Information
If a problem was detected, displays the cause of the problem, and links to log files. The log files
describe the actions you must take to resolve the problem.
Site Administrator
Automail Options
ALM sends automail to Site Administrators upon events connected to repository migration. Select the
following options:
l
Send mail on success. Sends mail when the migration of a project repository completes
successfully.
l
Send mail on warning. Sends mail when a warning is detected during the migration of a project
repository.
l
Send mail on error. Sends mail when an error is detected during the migration of a project
repository.
l
Summary
Include logs as attachments. Attaches detailed log files to automail messages.
Summary information of the migration status of all site projects.
Configure Migration Priority
While the migration process does not interfere with your work on projects, the process may affect
system performance as a whole. Use the following site configuration parameters to control the amount
of system resources used by the migration process. For more information on setting parameters, see
"Setting ALM Configuration Parameters" on page 168.
l
l
REPOSITORY_MIGRATION_JOB_PRIORITY. Determines the speed at which files are copied from the
old to the new project repository.
SUSPEND_REPOSITORY_MIGRATION. Stops the repository migration on the entire site. Use this
parameter temporarily, and only in special circumstances. For example, if you suspect that the
migration process disrupts your system.
Additional parameters are available for configuring the resources allocated to the migration process.
For more information, see HP Software Knowledge base article KM862600
(http://h20230.www2.hp.com/selfsolve/document/KM862600).
Consider the following when configuring the migration priority:
l
Allocating more resources to the migration process may slow down other processes.
l
Allocating less resources extends the time in which the process is completed.
HP ALM (12.50)
Page 122
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
l
Projects that are pending migration or in the process of migration cannot be exported or copied.
LAB_PROJECT Post Upgrade Steps
If you have upgraded a Performance Center 11.00 project, perform the following steps in the staging
and production environments:
For more information regarding these steps, refer to the HP ALM Lab Management Guide.
1. Log into Lab Management.
2. Configure the external URL:
a. On the Lab Management sidebar, under Servers, select PC Servers.
b. On the toolbar, click the ALM Connection button. The ALM Connection dialog box opens.
c. Enter external URL information.
3. Add a Performance Center Server:
a. On the PC Servers toolbar, click the New PC Server button. The New PC Server dialog box
opens.
b. Define new server information.
c. Click OK.
4. Update license details:
a. On the Lab Management sidebar, under Performance Center, select PC Licenses.
b. Define new license information.
5. Add, remove, or reconfigure hosts:
a. On the Lab Management sidebar, under Lab Resources, select Hosts.
b. Add, remove, or reconfigure hosts as needed.
About Upgrading Projects for Minor-Minor Versions
This section describes the process for upgrading projects for minor-minor versions, including setting
project priorities. Minor-minor versions can include changes to database schema.
Note: For details on understanding whether a version is major, minor, or minor-minor, see
"Understanding the Version/Patch Numbering Scheme" on page 100.
Automatic upgrades for minor-minor versions start when the ALM Server is restarted after installation
of the new minor-minor version.
While a project is being upgraded, users cannot access the project.
HP ALM (12.50)
Page 123
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
This section includes:
l
"Candidates for Automatic Upgrades" below
l
"Project Priority" below
l
"How to Upgrade Minor-Minor Versions" below
Candidates for Automatic Upgrades
The automatic upgrade processes projects that meet all of the following criteria:
l
l
Lab Management projects
Projects whose major and minor version are identical to the major and minor version installed on the
server, yet whose minor-minor version is less than the minor-minor version installed on the server.
Examples
Assume ALM version 15.25 is installed on the server:
l
Version 15.21, 15.22, 15.23, and 15.24 projects are automatically upgraded.
l
Version 15.25 and 15.26 projects are not automatically upgraded.
l
Version 14.00 projects are not upgraded.
Project Priority
The upgrade processes projects in the following order:
l
Template and Lab Management projects
l
Projects with the highest priority, as set by the user
l
Most active projects
l
Most recent modification date
l
Highest number of users
How to Upgrade Minor-Minor Versions
1. Before upgrading the minor-minor version on the ALM Server, you can optionally set priorities to
determine the order in which projects are upgraded using the Project Update Prioritization dialog
box in Site Administration. For user interface details, see "Setting Project Priorities for Upgrading
Minor-Minor Versions" on the next page.
2. Back up the database.
3. Install the new minor-minor version on the ALM Server by following the instructions:
l
l
On the HP Software Support Web site. Choose Help > Software Support Online. The URL for this
Web site is www.hp.com/go/hpsoftwaresupport.
In the HP Application Lifecycle Management Installation and Upgrade Guide.
HP ALM (12.50)
Page 124
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
After the ALM Server is restarted, projects are upgraded automatically according to the defined
priorities.
Setting Project Priorities for Upgrading Minor-Minor Versions
The Project Update Prioritization dialog box enables you to set project priorities for upgrading minorminor versions.
To access
Important
information
In Site Administration, select Tools > Set Project Upgrade Priorities.
l
Projects are listed in order of priority. Highest priority projects are at the top of the list.
l
Lab and Template projects are always highest priority. You cannot change the priority for these projects.
l
You can set priorities at any time. The changes affect the next minor-minor version upgrade. If such an
upgrade is in progress, the changes affect only projects with Pending Upgrade status.
See also
l
"Upgrading Projects to a New Version" on page 99
l
HP Application Lifecycle Management Installation and Upgrade Guide
User interface elements are described below:
UI Element
Description
Restore Defaults. Resets project priorities to the default value 100.
Note: Restore Defaults does not affect the priority of Lab or Template projects.
Find. Enables you to navigate to a project in the grid using the adjacent Project Name text box.
Domain Name
HP ALM (12.50)
Lists the domains.
Page 125
Administrator Guide
Chapter 5: Upgrading Projects to a New Version
UI Element
Description
Project Name
Lists the projects.
Priority
Displays the priority for the project for the next upgrade. 1 is highest priority. 100 is lowest priority.
HP ALM (12.50)
Page 126
Chapter 6: Managing ALM Users
You manage HP Application Lifecycle Management (ALM) users in Site Administration. You can add new
users, define user details, change user passwords, and define site administrators. You can also import
users from LDAP and enable LDAP or external authentication for users. After you add users, you can
assign projects to users.
This chapter includes:
•
•
•
•
•
•
•
•
•
•
•
About Managing Users
128
Adding a New User
128
Importing Users from LDAP
130
Updating User Details
137
Deactivating and Activating Users
138
Creating and Changing Passwords
139
Locking Out Users
139
Enabling Authentication for Users
140
Assigning Projects to Users
142
Exporting User Data
144
Deleting Users
144
HP ALM (12.50)
Page 127
Administrator Guide
Chapter 6: Managing ALM Users
About Managing Users
You use Site Administration to manage the users connected to your ALM projects. You begin by adding
or importing new users to the Users list in Site Administration. You can then define user details and
change or override a user's password. You can also enable users to log in to ALM using their LDAP
passwords.
For each ALM user, you can select projects that the user can access. You can also define ALM users as
site administrators. For more information, see "Defining Site Administrators" on page 22.
Note: You can monitor the users currently connected to an ALM server. For more information,
see "Managing User Connections and Licenses" on page 145.
Adding a New User
You can add new users to the Users list in Site Administration. After the user is added, you can view
users and define user details. For more information on updating user details, see "Updating User
Details" on page 137.
You can also import new users from LDAP directories. For more information, see "Importing Users from
LDAP" on page 130.
Note: Creating a new user for an ALM project consists of two steps:
l
Adding the user to the Users list in Site Administration (as described in this section).
l
Assigning the user to a user group using Project Customization. Each user group has access
to certain ALM tasks. For more information, see "Managing Users in a Project" on page 235
and "Managing User Groups and Permissions" on page 239.
HP ALM (12.50)
Page 128
Administrator Guide
Chapter 6: Managing ALM Users
To add a new user:
1. In Site Administration, click the Site Users tab.
2. Click the New User button
. The New User dialog box opens.
3. Type a User Name (maximum length 60 characters). A user name cannot include the following
characters: ( ) @ \ / : * ? " ` < > | + = ; , %
4. Type additional user information: Full Name, E-mail, Phone Number, and a Description. The email
information is important, as it enables users to receive project information directly to their
mailboxes.
Note: For smart card authentication, enter the email from the smart card in E-mail and
the common name (CN) from the smart card in Description. For single sign-on (SSO)
authentication, enter the email and the user name in Description.
You can update user information in the User Details tab. For more information, see
"Updating User Details" on page 137.
5. If LDAP Authentication is activated, select the LDAP server from the LDAP Authentication Server
dropdown list. Domain Authentication is automatically valued with the LDAP distinguished name,
but can be updated as needed.
Note: If Domain Authentication is valued incorrectly or is empty, it is automatically
updated after the user successfully logs in.
6. Click OK. The new user is added to the Users list.
7. Assign the new user a password. For task details, see "Creating and Changing Passwords" on page
HP ALM (12.50)
Page 129
Administrator Guide
Chapter 6: Managing ALM Users
139.
Note: A new user is created with a blank password.
Importing Users from LDAP
You can import users from an LDAP directory to the Users list in Site Administration.
Notes:
l
Verify that the LDAP import settings are defined. For more information, see "Defining LDAP
Settings for Importing Users" on page 133.
l
Working with LDAP through SSL requires that you perform additional steps. For more
information, see "Enabling LDAP over SSL" on page 132.
l
The LDAP_TIMEOUT parameter enables you to define a connection time-out between ALM
and an LDAP server. By default, the value is set to 10 minutes. For more information, see
"Setting ALM Configuration Parameters" on page 168.
You select users either by filtering and browsing the LDAP directory base, or by searching for users by
keyword.
To browse the LDAP directory base:
1. In Site Administration, click the Site Users tab.
2. Click the Import LDAP Users button
, and select Import Users from LDAP Directory Tree. The
Import Users from LDAP Directory Tree dialog box opens.
HP ALM (12.50)
Page 130
Administrator Guide
Chapter 6: Managing ALM Users
3. In the Server box, select the LDAP server you want to browse.
The LDAP directory base is filtered according to the filter set in the LDAP Settings dialog box. For
details, see "Defining LDAP Settings for Importing Users" on page 133.
4. To view LDAP details for a user, select an item and click the Show LDAP Details button
LDAP User Details dialog box opens and displays the user attributes.
. The
5. You can use the following options to import users:
l
l
l
To import a user, expand a directory and mark the user name by selecting the check box.
To import a group of users, use CTRL or SHIFT to highlight users to be included. Click the Mark All
Items arrow and choose Mark Selected Items to select the check boxes of the highlighted
users.
To import all users, click Mark All Items.
6. To clear the check boxes of highlighted users, click the Mark All Items arrow and choose Clear
Selected Items. To clear all check boxes, click the Mark All Items arrow and choose Clear All.
7. Click Import. A confirm message box opens. Click Yes to continue.
l
l
If the users were imported successfully, a message box opens. Click OK and then click Close to
close the Import Users from LDAP Directory Tree dialog box.
If the same user names exist in the Users list, the Handle Conflict dialog box opens. For more
information, see "Handling User Name Conflicts" on page 136.
8. Click Close to close the Import Users from LDAP Directory Tree dialog box.
To search for users by keyword:
1. In Site Administration, click the Site Users tab.
2. Click the Import LDAP Users arrow
, and select Import LDAP Users by Keyword. The Import
LDAP Users by Keyword dialog box opens.
3. In the Server box, select the LDAP server you want to search.
HP ALM (12.50)
Page 131
Administrator Guide
Chapter 6: Managing ALM Users
4. In the Find box, type a keyword, and click the Find button
.
ALM searches for the keyword in the following fields: User Name, Full Name, Group, Description,
Email, Phone.
Tip: To broaden your search, enter partial values. For example, enter Mi to search for
Michael and Mikhael.
5. Click Import. A confirm message box opens. Click Yes to continue.
l
l
If the users were imported successfully, a message box opens. Click OK and then click Close to
close the Import LDAP Users by Keyword dialog box.
If the same user names exist in the Users list, the Handle Conflict dialog box opens. For more
information, see "Handling User Name Conflicts" on page 136.
6. Click Close to close the Import LDAP Users by Keyword dialog box.
Enabling LDAP over SSL
ALM supports LDAP communication transfer over secure sockets (SSL). This ensures that users'
credentials (passwords) are not sent over the network in an unsecured way.
This section describes the configuration steps needed to enable LDAP communication over SSL.
LDAP Server Configuration:
To use SSL for secure communication, the following must be preconfigured on the LDAP server:
l
SSL must be enabled.
l
A secure port must be set (the port is 636 by default).
l
A server certificate must be installed.
Also, you must obtain a root certificate (and any intermediate) of the Certificate Authority (CA) that
issued the LDAP server certificate.
ALM Server Configuration:
The following must be pre-configured on the ALM server:
1. A certificate trust store.
In most cases, the default trust store is used. The default trust store is <JAVA_
HOME>/jre/lib/security/cacerts (the default password is changeit), where <JAVA_HOME> is the
installation location for the JDK that comes with ALM (for example, C:\Program
Files\HP\ALM\java\jre).
2. To establish trust to the CA that issued the LDAP server certificate, import the root CA certificate
into the java trust store using the keytool utility.
HP ALM (12.50)
Page 132
Administrator Guide
Chapter 6: Managing ALM Users
Note: The keytool utility is located in the bin folder of the JAVA_HOME (for example,
C:\Program Files\HP\ALM\java\jre\bin).
For example, keytool -import -alias <your LDAP CA> -trustcacerts -file <LDAP CA cert> keystore <JAVA_HOME>/jre/lib/security/cacerts
If there are any intermediate Certificate Authorities, import their certificates as well.
To define LDAP settings for SSL:
1. In Site Administration, click the Site Users tab.
2. Click the User Settings button
opens.
and select Multi LDAP Settings. The LDAP Settings dialog box
3. In the Directory provider URL box, type the URL of the LDAP server (ldaps://<server
name>:<port number>).
Note: The port must be enabled for SSL, as configured on the LDAP server. The default
SSL port is 636.
Defining LDAP Settings for Importing Users
To enable you to import users from an LDAP directory to the Users list in Site Administration, you must
define your LDAP import settings.
HP ALM (12.50)
Page 133
Administrator Guide
Chapter 6: Managing ALM Users
When you import users from an LDAP directory, ALM copies attribute values from an LDAP directory into
ALM. For each imported user, the following attribute values are copied:
l
Distinguished name (DN). A unique name that is made up of a sequence of relative distinguished
names (RDN) separated by commas.
Example
CN=John Smith, OU=QA, O=HP
CN is the common name; OU is the organizational unit; and O is the organization.
l
l
Userid (UID). The name that identifies a user as an authorized user. The UID attribute value is
mapped to the User Name field in ALM.
Full Name, Description, Email and Phone. Optional attributes that are used to populate the Full
Name, Description, Email, and Phone Number fields for each user imported from an LDAP directory.
Note: The optional LDAP_IMPORT_ATTRIBUTE_MASK parameter enables you to define a regular
expression that can be used to distinguish between different values for an LDAP attribute. For
more information, see "Setting ALM Configuration Parameters" on page 168.
To define LDAP settings for importing users:
1. In Site Administration, click the Site Users tab.
2. Click the User Settings button
opens.
and select Multi LDAP Settings. The LDAP Settings dialog box
3. Click New. Enter the server name and click OK.
HP ALM (12.50)
Page 134
Administrator Guide
Chapter 6: Managing ALM Users
Server Name is valued with the server name, and other fields are valued with default values.
4. In the Directory provider URL box, type the URL of the LDAP server (ldap://<server
name>:<port number>).
5. Under LDAP authentication type:
l
l
l
Select Anonymous to enable you to import users from the LDAP server using an anonymous
account.
Select Simple to enable you to import users from the LDAP server using an authorized (searchentitled) user account and password. If you select Simple, the following options are enabled:
o
In the Authentication principal box, type the authorized user name.
o
In the Authentication credentials box, type the password.
If you are using lightweight single sign-on, select Use LWSSO and enter the LDAP attribute name
to be used as the lightweight single sign-on login name.
6. Click Test Connection to test the URL of the LDAP server.
7. In the Directory base box, type the LDAP directory name.
Note: The Directory base is a distinguished name of a node in the LDAP hierarchy and is
used as a root for operations retrieving data. If this field is left empty, it dramatically
increases the search time of a user in the LDAP tree.
8. In the Base filter box, define filter criteria.
9. In the Result record limit box, enter the maximum number of records to display in the Import
LDAP Users by Keyword dialog box. The default value is 100.
Note: A value less than the recommended minimum value of 100 can slow LDAP imports
and searches. A value greater than the recommended maximum value of 10000 can cause
the server to run out of memory.
10. Define the corresponding LDAP field names. Note that User Name is a required field.
11. To set the default values for the Active Directory, click Use default values for: and select Active
Directory.
12. To set the default values for LDAP, click Use default values for: and select LDAP.
13. Click Save to save the LDAP directory.
As each LDAP directory is created, it is added to the LDAP server panel. You can add or delete
LDAP directories from this panel.
Note: When a user logs in, ALM searches the LDAP directories in the order they are listed in
the LDAP server panel until a match is found.
14. Click Close to close the LDAP Settings dialog box.
HP ALM (12.50)
Page 135
Administrator Guide
Chapter 6: Managing ALM Users
Handling User Name Conflicts
When importing users from an LDAP directory to the Users list in Site Administration, you may
encounter the following conflicts:
l
Same user. A user with the same LDAP distinguished name already exists.
l
Same user name. A user with the same user name already exists.
To resume the process of importing users, you can choose to skip the user, rename a user name, or
update user information.
To handle user name conflicts:
1. Import users (see "Importing Users from LDAP" on page 130). If conflicts occur, the Handle Conflict
dialog box opens.
2. If the conflict is listed under Conflict: Same User, you can choose one of the following options to
resume the process:
Option
Description
Update Updates existing user information. Click the corresponding Solution box. Click the browse button and choose
Update.
Skip
Does not import the selected user (default).
3. If the conflict is listed under Conflict: Same User Name, you can choose one of the following
options to resume the process:
Option
Description
Rename Assigns a new name to the selected user. Click the corresponding Solution box. Click the browse button and
choose Rename. In the New User Name box, type the new name.
Auto
Assigns a new name to the selected user by adding a suffix. Click the corresponding Solution box. Click the
Rename browse button and choose AutoRename. The new name is displayed in the New User Name box.
HP ALM (12.50)
Page 136
Administrator Guide
Chapter 6: Managing ALM Users
Option
Description
Update
Updates existing user information. Click the corresponding Solution box. Click the browse button and choose
Update.
Skip
Does not import the selected user (default).
4. Click Continue.
Updating User Details
After you add a user, you can update user details. For example, you may need to update a user's full
name or contact details. You can also define ALM users as site administrators. For more information,
see "Defining Site Administrators" on page 22.
To update user details:
1. In Site Administration, click the Site Users tab. In the right pane, click the User Details tab.
2. Select a user from the Users list.
Tip: You can search for a user in the Users list by typing the name, or the first letter(s) of
the name, of a user in the Find box, and clicking the Find button
. The first user that
matches the searched text is highlighted. Click the button again to search for other users
containing the searched text.
3. Edit the user detail fields.
Note: If the user was imported from an LDAP directory to Site Administration, LDAP
Authentication Server displays the LDAP server and Domain Authentication displays the
LDAP authentication properties of the imported user. If the user was not imported, these
fields are not displayed. For more information, see "Importing Users from LDAP" on page
130.
HP ALM (12.50)
Page 137
Administrator Guide
Chapter 6: Managing ALM Users
For smart card authentication, enter the email from the smart card in E-mail and the
common name (CN) from the smart card in Description. For single sign-on (SSO)
authentication, enter the email and the user name in Description.
4. To set the user's status, click the Deactivate or Activate button. For more information on user
status, see "Deactivating and Activating Users" below.
5. To assign projects to a user, click the User Projects tab. For more information, see "Assigning
Projects to Users" on page 142.
6. Click Apply to save your changes.
Deactivating and Activating Users
You can deactivate or activate an ALM user. A deactivated user cannot log in to any project. The user is
not deleted from the Users list, and all user permissions and settings are saved. This can be useful, for
example, for contract workers that work intermittently for a set period of time.
Caution: A deactivated site administrator user cannot log in to Site Administration.
To deactivate a user:
1. In Site Administration, click the Site Users tab.
2. Choose one of the following:
l
To deactivate users as of the next attempted login, select one or more Active users from the
Users list, and click the Deactivate button
on the toolbar. The Status is set to Inactive, and
the user icon is changed in the Users list. In addition, the Deactivation Date box is hidden.
If a user is currently logged in to an ALM project, this does not terminate the user session. When
the user next attempts to log in to a project, a message box displays stating that the user is
deactivated and cannot log in.
l
To deactivate a user on a set date in the future, select an Active user from the Users list. Click
the User Details tab. In the Deactivation Date box, click the drop-down arrow and select a date.
To activate a user:
1. In Site Administration, click the Site Users tab.
2. Select one or more Inactive users from the Users list.
3. Click the Activate button
changed in the Users list.
HP ALM (12.50)
on the toolbar. The Status is set to Active, and the user icon is
Page 138
Administrator Guide
Chapter 6: Managing ALM Users
Creating and Changing Passwords
The site administrator can create, change, or override a user's password.
Note:
l
You can only change passwords for users that are set to log in to ALM using their ALM
passwords. If LDAP passwords are in use, or if users log in to ALM using external
authentication, this option is unavailable. For more information on LDAP authentication, see
"Defining LDAP Settings for Importing Users" on page 133.
l
Users who are not administrators can change their passwords using the User Properties link
in the Project Customization window. For more information, refer to the HP Application
Lifecycle Management User Guide.
l
For details on the old connection method to Site Administration for the purposes of
backward compatibility, see the BACKWARD_SUPPORT_SA_DEFAULT_USER site parameter.
To create or change a password:
1. In Site Administration, click the Site Users tab.
2. Select a user from the Users list.
3. Click the Password button. The Set User Password dialog box opens.
4. In the New Password box, type a new password (maximum length 20 characters).
5. In the Retype Password box, retype the new password.
6. Click OK.
Locking Out Users
As the site administrator, you can determine the number of login attempts a user can make before
being deactivated. By default, no limit is set. In addition, you can set a parameter that resets the count
of failed logins if a specified amount of time passes after an attempted login.
You can set a time interval after which a deactivated user is reactivated automatically, or you can
reactivate locked out users.
To lock out users:
1. Set the MAX_INVALID_LOGINS_ATTEMPT_TO_LOCKOUT Site Configuration parameter.
If the user unsuccessfully tries to log in more times than the number you assign, the user is locked
out.
2. You can also set the INTERVAL_BETWEEN_INVALID_LOGINS_TO_LOCKOUT Site Configuration
parameter.
HP ALM (12.50)
Page 139
Administrator Guide
Chapter 6: Managing ALM Users
The default value for this Site Configuration parameter is 60 seconds. If the user waits longer than
this amount of time between login attempts, the count of invalid login attempts resets to zero.
When a user is locked out, the user's status is set to Inactive. Activate the user, and the user can
attempt to log in again. For more information, see "Deactivating and Activating Users" on page 138.
To automatically allow users to attempt to log in again, set the INTERVAL_TO_AUTO_RELEASE_
LOCKOUT Site Configuration parameter. Once the user waits the amount of time specified in this
parameter, the user is activated and can attempt to log in again.
For more information on the Site Configuration parameters, see "Setting ALM Configuration
Parameters" on page 168.
Enabling Authentication for Users
You can allow users to log in to ALM using their LDAP passwords or external authentication, instead of
ALM passwords.
Working with LDAP through SSL requires that you perform additional steps. For more information, see
HP Software Self-solve knowledge base article KM188096
(http://h20230.www2.hp.com/selfsolve/document/KM188096).
This section includes:
l
"Considerations" below
l
"Enabling LDAP Authentication for Users" below
l
"Enabling External Authentication for Users" on the next page
Considerations
l
l
After LDAP authentication is enabled, authentication will be performed against the LDAP server.
Make sure that the site administrator is set up as an LDAP user before switching to LDAP
authentication, otherwise the site administrator will not be able to log in after the authentication
type is switched.
After you enable LDAP authentication, you need to disable the password reset option, by defining the
PASSWORD_RESET_DISABLE Site Configuration parameter. For more information, see "Setting ALM
Configuration Parameters" on page 168.
Enabling LDAP Authentication for Users
1. In Site Administration, click the Site Users tab.
2. Click the User Settings button
Settings dialog box opens.
HP ALM (12.50)
and choose Authentication Settings. The Authentication
Page 140
Administrator Guide
Chapter 6: Managing ALM Users
3. Under Authentication type, select LDAP to set the authentication type as LDAP for all users.
4. Click OK.
Enabling External Authentication for Users
1. In Site Administration, click the Site Users tab.
2. Click the User Settings button
Settings dialog box opens.
and choose Authentication Settings. The Authentication
3. Under Authentication type, select External Authentication to set external authentication for all
users.
4. Click Advanced Settings to set the external authentication parameters. The External
Authentication Advanced Settings dialog box opens.
5. From the dropdown list, select the Authentication Type.
a. Email: ALM extracts the user email from the header value and finds the ALM user with the
same email address defined in ALM.
HP ALM (12.50)
Page 141
Administrator Guide
Chapter 6: Managing ALM Users
b. Name: ALM extracts the user name from the header value and finds the ALM user with the
same name in the Description field.
c. Email + Name: ALM Desktop Client extracts the user email and name from the header value.
ALM first tries to match the email to an ALM user, and if this is unsuccessful tries to match the
name to an ALM user.
6. Enter the Pattern - The format for extracting information from the header.
If the Pattern is not defined, ALM uses the default pattern.
Following are the default patterns that ALM uses to search for the email and common name:
l
To match by email field: *[eE][^=]*=([^,]*@[^,]*).*
l
To match by description field: *?[cC][nN] *= *([^/,]*).*
You can also write your own pattern.
7. Click OK.
8. Click OK in the Authentication Settings dialog box.
Assigning Projects to Users
As an ALM site administrator, you can control user access to ALM projects by defining the projects to
which a user can log on. When a user is no longer working on a project, remove the user from the User
Projects list.
When you add a user to a project, the user is automatically assigned to the project with Viewer
privileges. For more information on user groups and group privileges, see "Managing Users in a Project"
on page 235 and "Managing User Groups and Permissions" on page 239.
Note:
l
You can assign users to projects from the Site Projects tab. For more information, see
"Assigning Users to Projects" on page 71.
l
ALM sends automatic email notification to project administrators when users are assigned or
removed from a project in Site Administration. You can make automatic notification
unavailable by adding the AUTO_MAIL_USER_NOTIFICATION parameter in the Site
Configuration tab. For more information, see "Setting ALM Configuration Parameters" on
page 168.
To assign projects to a user:
1. In Site Administration, click the Site Users tab. In the right pane, select the User Projects tab. The
Projects list for the selected user is displayed.
HP ALM (12.50)
Page 142
Administrator Guide
Chapter 6: Managing ALM Users
Tip: You can click the Domain column to change the sort order from ascending to
descending domain names. You can also click the Project column to sort according to
project instead of domain name.
2. In the Users list in the left pane, select a user.
Tip: You can search for a user by typing the name of a user in the Find box, and clicking the
Find button
.
The selected user's projects are displayed in the User Projects list.
To group user projects by domain, select Group By Domain. Clear the check box to remove the
group by settings.
3. In the User Projects tab, click the Select Projects button. The ALM Projects list is displayed in a new
pane to the right of the User Projects tab.
4. To select projects from the Projects list, expand the directory, and select the projects that you
HP ALM (12.50)
Page 143
Administrator Guide
Chapter 6: Managing ALM Users
want to assign to the user.
To clear all selected projects, click Clear All.
5. Click the Add current user to the selected projects button
to the User Projects list.
. The selected projects are added
6. To remove a project from the User Projects list, select the project in the User Projects tab and click
the Remove button. Click OK to confirm. The project is removed from the User Projects list.
Note: This does not delete the project from the server.
7. To refresh the User Projects list, click the Refresh button
.
Exporting User Data
You can export the user name and full name of all site users from the Users list to a text file.
To export user data:
1. In Site Administration, click the Site Users tab.
2. Click the Export User Data To File button
. A confirm message box opens. Click Yes to
continue. The Export Data To File dialog box opens.
3. Select the directory where you want to save the parameters, and type a name for the file in the
File name box.
4. Click Save to export the data to a text file.
Deleting Users
You can delete a user from the Users list.
To delete a user:
1. In Site Administration, click the Site Users tab.
2. Select a user from the Users list.
3. Click the Delete User button
.
4. Click Yes to confirm.
HP ALM (12.50)
Page 144
Chapter 7: Managing User Connections and
Licenses
In Site Administration, you can monitor user connections and modify license information.
This chapter includes:
•
•
•
About Managing User Connections and Licenses
146
Monitoring User Connections
146
Managing Licenses
148
HP ALM (12.50)
Page 145
Administrator Guide
Chapter 7: Managing User Connections and Licenses
About Managing User Connections and Licenses
You use the Site Connections tab in Site Administration to monitor and manage the users connected to
your HP Application Lifecycle Management (ALM) projects. For more information, see "Monitoring User
Connections" below.
You use the Licenses tab in Site Administration to view ALM license information and modify the license
key. For more information, see "Managing Licenses" on page 148.
Monitoring User Connections
You can use the Site Connections tab to perform the following:
l
l
l
l
Monitor the users currently connected to an ALM server. For each user, you can view the domain and
project being used, the user's machine name, the time the user first logged in to the project, and the
time the most recent action was performed. You can also view the client type connection to the ALM
server.
View the licenses that are used by each user.
Send messages to users connected to your ALM projects. You can also disconnect users from
projects.
Modify access to an ALM project using the Module Access link. For more information, see
"Customizing Module Access for User Groups" on page 251.
Note:
l
To view the total number of licenses that are in use for each ALM module, click the
Licenses tab. For more information, see "Managing Licenses" on page 148.
l
To view and analyze the number of licensed ALM users connected to your projects at
specific points over a period of time, click the Site Analysis tab. For more information, see
"Monitoring Site Usage" on page 172.
l
The ALM client can be inactive for a certain amount of time before it is disconnected from
ALM. Disconnecting the client enables the license to be used by another ALM user. For more
information, see the site administration configuration parameter WAIT_BEFORE_
DISCONNECT.
HP ALM (12.50)
Page 146
Administrator Guide
Chapter 7: Managing User Connections and Licenses
To monitor user connections:
1. In Site Administration, click the Site Connections tab.
Tip: You can click any column heading to change the sort order of the column from
ascending to descending.
2. To refresh the Connections list, click the Refresh Connections List button
.
To instruct ALM to automatically refresh the Connections list, click the Refresh Connections List
arrow and choose Automatic Refresh. By default, the Connections list is automatically refreshed
every 60 seconds. To change the automatic refresh rate, click the Refresh Connections List arrow
and choose Set Refresh Rate. In the Set Refresh Rate dialog box, specify a new refresh rate in
seconds.
3. You can group connected users by clicking the Group By arrow, and choosing a Group By option. To
group connected users by project, choose Group By Project. To group connected users by user,
choose Group By User. To clear the Group By settings, click the Group By arrow and choose Clear
Group By.
4. You can send a message to a connected user or group of users by clicking the Send Message
button. For more information on sending messages, see "Sending Messages to Connected Users"
below.
5. To disconnect a user or group of users from a project, select the row of the user or group and click
the Disconnect Users button
. Click Yes to confirm.
Sending Messages to Connected Users
You can send messages to users connected to your ALM projects. This enables you to routinely inform
connected users about important maintenance activities. For example, disconnecting a project, or
restarting an ALM server.
When you send a message, a pop-up window automatically opens on the user's machine displaying the
message text. The message box is displayed until the user closes it or disconnects from ALM. For more
information, refer to the HP Application Lifecycle Management User Guide.
To send messages to connected users:
HP ALM (12.50)
Page 147
Administrator Guide
Chapter 7: Managing User Connections and Licenses
1. In Site Administration, click the Site Connections tab.
2. Select the users to whom you want to send a message:
l
To send a message to a user or group of users, select the row of the user or group.
l
To send a message to multiple users, use Ctrl or Shift to highlight users to include.
3. Click the Send Message button. The Send Message dialog box opens.
The To box displays the intended recipients of the message in the format [DOMAIN:Project
Name:User Name].
Example
[DEFAULT:ApplicationLifecycleManagement_Demo:peter_alm]
4. In the Message Text box, type a message.
5. Click Send. ALM sends the message to user machines within five minutes.
Managing Licenses
In the Licenses tab, you can view the total number of licenses in use, the maximum number of licenses
that you have for each ALM project or domain, and the expiration dates for the licenses. When other HP
tools, such as UFT, are connected to an ALM project, you can view the total number of licenses in use for
these tools. You can also add licenses. In addition, you can view the ALM edition installed on your server.
Within the Licenses tab, there are tabs for viewing and updating licenses:
l
Status. You can modify licenses and link to the licensing portal to retrieve licenses.
l
License Assignments. You can assign licenses to the various domains and projects.
l
Named Licenses. You can assign named licenses to specific users.
l
PPU Licenses History. You can view the current number of available PPU licenses and the history of
their usage.
Note:
l
To view the ALM licenses that are currently being used by each user, click the Site
Connections tab. For more information, see "Monitoring User Connections" on page 146.
l
To view and analyze the number of licensed ALM users connected to your projects at specific
points over a period of time, click the Site Analysis tab. For more information, see
"Monitoring Site Usage" on page 172.
l
Performance Center: You can view additional Performance Center license information in Lab
Management. For more information, refer to the HP ALM Lab Management Guide.
HP ALM (12.50)
Page 148
Administrator Guide
Chapter 7: Managing User Connections and Licenses
This section includes:
•
•
•
•
Modifying Licenses
150
Assigning Licenses to Domains and Projects
151
Assigning Licenses to Users
152
PPU Licenses History
154
HP ALM (12.50)
Page 149
Administrator Guide
Chapter 7: Managing User Connections and Licenses
Modifying Licenses
In the Status tab, you can modify licenses and launch the HP Licensing portal to retrieve licenses.
To modify licenses:
1. In Site Administration, click the Licenses tab.
2. Click the Status tab.
The Status tab includes the following UI elements:
UI Element
Description
Refresh. Refreshes the screen.
Enables you to modify the license by selecting one of the following: Upload License. Opens the Upload License dialog box, enabling you to
browse for and select a license key.
Paste License. Opens the Paste License dialog box, enabling you to paste
the license key into a text box.
Hides expired licenses in the table.
Opens the HP Licensing portal in a new browser, enabling you to purchase
licenses.
License Name
The ALM module name.
Named
Indicates whether the license is a named license assigned to a specific user.
Expiration Date
The expiration date of the license.
In Use
The total number of licenses in use.
Max
The maximum number of available licenses.
Edition
Indicates the ALM edition installed. For more information, refer to the HP
Application Lifecycle Management User Guide .
Model
Indicates the license type. Possible values are:
CONCURRENT. A license that allows perpetual usage of the purchased licenses
HP ALM (12.50)
Page 150
Administrator Guide
Chapter 7: Managing User Connections and Licenses
UI Element
Description
until the license expiration date.
PPU. A license that allows a month of actual usage of the purchased licenses.
Used licenses expire at the end of the month in which they were used.
3. Click the arrow next to Modify Licenses.
4. Select Upload License or Paste License.
l
l
Select Upload License to open the Upload License dialog box, enabling you to browse for and
select a license key.
Select Paste License to open the Paste License dialog box, enabling you to paste the license key
into a text box.
Note: You cannot paste licenses in Internet Explorer 11. You must upload the license
from a file.
5. To add licenses, click Launch Licensing Portal.
The HP Licensing portal opens in a new browser, enabling you to purchase licenses.
Assigning Licenses to Domains and Projects
In the License Assignments tab, you can assign licenses to specific domains or projects to allow users
assigned to each project to use the assigned licenses. The number of remaining, available licenses is
shown towards the bottom of the tab. If a project needs more licenses than the number it is assigned,
extra licenses can be taken from the domain or from the available licenses, until all available licenses
are used.
To assign licenses:
1. In Site Administration, click the Licenses tab.
2. Click the License Assignments tab.
The License Assignment tab includes the following UI elements:
UI Element
Description
Refresh. Refreshes the screen.
HP ALM (12.50)
Page 151
Administrator Guide
Chapter 7: Managing User Connections and Licenses
UI Element
Description
Saves changes.
Expands the domains and displays all project names.
Collapses the domains and hides the project names.
Hides the domains and projects that do not have licenses assigned to
them.
Available
Number of available unassigned site level licenses by license type
remaining.
Site Pool
Total number of available site level licenses by license type.
3. Select the domain or project to which you want to assign licenses. and enter the number of
licenses you want to assign in the project or domain row.
4. Enter the number of licenses you want to assign in the entry in the selected row, according to the
type of licenses you are assigning.
The total of available licenses is reduced accordingly.
ALM validates that the total number of licenses assigned to the projects and domains does not
exceed the number of licenses in the site pool.
5. Click Save to save the changes.
Assigning Licenses to Users
You can assign named licenses to specific users. The user has exclusive access to this license, but
cannot use licenses from the Site Pool. The user must use this license for thirty days. After thirty days,
the license assignment can be removed from the user. Also, when a named license is assigned to a user,
you have one hour to remove the assignment.
To assign a license to a user:
1. In Site Administration, click the Licenses tab.
2. Click the Named Licenses tab.
3. Click Select Users to open the Site Users area to the right of the screen.
The Named Licenses tab includes the following UI elements:
HP ALM (12.50)
Page 152
Administrator Guide
Chapter 7: Managing User Connections and Licenses
UI Element
Description
Refresh. Refreshes the screen.
Saves changes and updates the Assigned Time column.
Hides any expired licenses in the table.
Opens the Site Users area to the right of the screen.
Remove selected users. Removes the selected users from the Assigned Users area.
Add selected users. Adds the selected users to the Assigned Users area.
Apply filter . Applies the filter typed in the Filter field. To return to the full list, leave
the Filter field empty and click Apply filter again.
Pages forward or back in the list of site users.
Refreshes the list of site users.
License Name
The ALM module name.
Expiration Date
The expiration date of the license.
In Use
The total number of licenses in use.
Max
The maximum number of licenses that you have for each ALM module.
User Name
The name of the user.
Full Name
The full name of the user.
Assignment Time
The date and time that the user was assigned to the license.
Reassignment Time
The date and time that the license assignment can be removed from the user. Once a
license is assigned to a user, you have one hour to remove the assignment. After that
time, the assignment cannot be removed from the user for thirty days. During the
first hour and after thirty days, this field is valued with Reassignable.
Page
Displays the current page in the list of site users.
4. In License Status, select the license name.
5. In Site Users, select the user.
6. Click Add selected users
area.
to assign the user. The user name is displayed in the Assigned Users
7. Click Save to save the changes.
HP ALM (12.50)
Page 153
Administrator Guide
Chapter 7: Managing User Connections and Licenses
To remove a license assignment from a user:
Note: A license assignment can only be removed from a user when Reassignment Time has the
value Reassignable.
1. In License Status, select the license.
2. In Assigned Users, select the user.
3. Click Remove selected users
Assigned Users.area.
to remove the user. The user name is no longer displayed in the
4. Click Save to save the changes.
PPU Licenses History
The usage of Pay-Per-Use (PPU) licenses is determined by the peak number of concurrent license usage
that is recorded during the month. You can track peak usage in the current month in the Site Analysis
tab. For more information, see "Monitoring Site Usage" on page 172.
At the beginning of each month, the number of used PPU licenses is subtracted from the total number
of available licenses. If the remaining number of available licenses goes below the number of licenses
you require, you can load additional licenses to meet the demand.
In the PPU Licenses History tab, you can view the number of available PPU licenses and the history of
PPU license usage.
The information in the tab includes the following transactions:
l
l
New purchases of PPU licenses, increasing the number of available licenses.
The automatic recalculation of licenses at the beginning of each month, decreasing the number of
available licenses.
The PPU Licenses History tab includes the following UI elements:
UI Element
Description
Date
The date on which a change in the number of available licenses is recorded. This occurs in one of the
following cases:
HP ALM (12.50)
l
Available licenses are calculated at the beginning of a month.
l
New licenses are added.
Page 154
Administrator Guide
Chapter 7: Managing User Connections and Licenses
UI Element
Description
Delta
The number of licenses added or subtracted from the previous quota of available licenses. A Delta value is
displayed separately for each module.
l
l
Available
In the case of a calculation of available licenses, the delta displays a negative value, equal to the peak
number of licenses that were used concurrently in the previous month.
In the case of adding new licenses, the delta displays a positive value, equal to the number of licenses
added.
The number of licenses available for concurrent use during the reported calendar month. An Available value
is displayed separately for each module.
The number of available licenses is equal to the number of available licenses in the previous row, plus the
Delta value in the current row.
The Available value can also indicate Unlimited, meaning there is no limit to the number of resources
available.
Recommended A suggested number of additional licenses you should buy, assuming the same level of usage as in the
previous month. A Recommended to buy value is displayed separately for each module.
to buy
This value is equal to the number of licenses used in the previous month (Delta), minus the current amount
of available licenses. If the amount is less than zero, nothing is displayed.
Recommended to buy is not displayed if the number of licenses is unlimited.
HP ALM (12.50)
Page 155
Administrator Guide
Chapter 7: Managing User Connections and Licenses
HP ALM (12.50)
Page 156
Chapter 8: Configuring Servers and Parameters
You use Site Administration to configure HP Application Lifecycle Management (ALM) servers, define and
modify database servers, configure the text search, set configuration parameters, and define the ALM
mail protocol.
This chapter includes:
•
•
•
•
•
•
•
•
About Configuring Servers and Parameters
158
Configuring Server Information
158
Defining New Database Servers
160
Modifying Database Server Properties
162
Configuring Text Search
164
Setting ALM Configuration Parameters
168
Setting the ALM Mail Protocol
169
Setting ALM Mail Restrictions
170
HP ALM (12.50)
Page 157
Administrator Guide
Chapter 8: Configuring Servers and Parameters
About Configuring Servers and Parameters
You use the Servers tab to configure ALM server information. You can set the server log files and
maximum number of database handles. For more information, see "Configuring Server Information"
below.
You use the DB Servers tab to define database servers that were not defined during installation. For
each database server, you enter the database type, database name, default connection string, and
administrator user and password.
You also use the DB Servers tab to modify existing database server definitions. For more information,
see "Modifying Database Server Properties" on page 162. In addition, you can configure the text search
option for a specified database server that has the text search feature installed and configured. For
more information, see "Configuring Text Search" on page 164.
You use the Site Configuration tab to add and modify ALM configuration parameters. For more
information, see "Setting ALM Configuration Parameters" on page 168. In addition, you can set the mail
protocol to be used by all the server nodes in your ALM site. For more information, see "Setting the ALM
Mail Protocol" on page 169.
Configuring Server Information
You can configure ALM server information. This includes:
l
l
Setting the ALM server log files. ALM can write all ALM and Site Administration events to log files.
The log files display the date and time a function was run. This is useful for when you contact ALM
support.
Setting the maximum number of database connections. ALM can open a number of connections for
each project on a database server. You can set the maximum number of connections per active
request that can be opened by ALM for each project.
ALM Editions: Functionality related to project planning and tracking (PPT) is available for ALM
Edition only. For more information about ALM editions and their functionality, see the HP
Application Lifecycle Management User Guide.
To configure ALM server information:
HP ALM (12.50)
Page 158
Administrator Guide
Chapter 8: Configuring Servers and Parameters
1. In Site Administration, click the Servers tab.
2. In the Server list, select a server.
The General Settings area displays the server name.
3. You configure ALM and Site Administration log file settings under the Client Log File Settings, Site
Administration Log File Settings and Project Planning and Tracking Log File Settings sections,
respectively.
Click the Log Level link to configure the type of log file you want the server to create. Select one of
the following options in the Log Level dialog box:
l
None. Does not create a log file.
l
Errors. Records error events.
l
Warnings. Records potentially harmful situations.
l
Flow. Records informational messages that highlight the application flow.
l
Debug. Records events that are most useful for debugging.
4. Click the Max. Log Lines link to open the Maximum Log Lines dialog box and configure the
maximum number of lines that ALM can write to the log file. ALM creates a new log file after the
log file reaches the maximum number of lines. The default value is 10,000.
5. Click the Max. Log Days link to open the Maximum Log Days dialog box and configure the
maximum number of days that the ALM server keeps the log file. ALM automatically deletes the log
files once the maximum number of days is reached. The default value is Unlimited.
6. Click the Log File Location link to change the directory path of the log file. In the Log File Location
dialog box, type the new location for the log file.
HP ALM (12.50)
Page 159
Administrator Guide
Chapter 8: Configuring Servers and Parameters
Saving logs on a remote server may cause performance issues. It is therefore recommended
that you save logs to the local file system. If the local file system has limited space, prepare a
script which periodically moves the logs to network storage
7. You can set the maximum number of connections per active request that can be opened on the
database server by the ALM server for each project. Click the Max. Database Connections link to
open the Maximum Database Connections dialog box and set the maximum number of concurrent
connections. For information on maximum database connections, see
http://h20230.www2.hp.com/selfsolve/document/KM630397.
Note: In addition to changing the number of connections that can be opened on the
database server for each project, you can also change:
l
The number of users allowed to connect concurrently to a domain. For more
information, see "Creating Domains" on page 27.
l
The number of users allowed to connect concurrently to a project. For more
information, see "Updating Project Details" on page 68.
8. To remove an ALM server from the Server list, select it and click the Delete Server button
. Click Yes to confirm.
9. Click the Refresh Servers List button
to refresh the servers list.
Defining New Database Servers
You can define additional database servers that were not defined during the installation process.
Notes:
l
For information on the Oracle or Microsoft SQL permissions required by ALM, refer to the HP
Application Lifecycle Management Installation and Upgrade Guide.
l
To make text search unavailable on a new database server, you must disable text search on
the database server before you define the new database server in ALM.
To define a new database server:
1. In Site Administration, click the DB Servers tab.
2. Click the New Database Server button
HP ALM (12.50)
. The Create Database Server dialog box opens.
Page 160
Administrator Guide
Chapter 8: Configuring Servers and Parameters
3. Under Database Type, select the type of database server you want to define:
l
MS-SQL (SQL Auth.). Uses SQL authentication.
l
MS-SQL (Win Auth.). Uses Microsoft Windows authentication.
l
Oracle.
4. Under Database Values, in the Database Name box, type the database name.
5. In the DB Admin User box, type the login name of the database administrator.
l
l
l
For Oracle database type, the default administrator user account enabling you to create ALM
projects is system.
For MS-SQL (SQL Auth.) database type, the default administrator user account enabling you to
create ALM projects is sa.
For MS-SQL (Win Auth.) database type, the DB Admin User box is unavailable. The login name of
the database administrator is the Windows user that is set to run ALM as a service.
6. In the DB Admin Password box, type the password of the database administrator. This field is
unavailable if you selected the MS-SQL (Win Auth.) database type.
7. Under Default Connection String, you can edit the default connection string parameters or the
connection string, as follows:
l
To edit the default connection string parameters, choose Connection String Parameters and
define the following parameters:
Parameter
Description
Server Host
The server name.
Port
The port number of the database server.
Oracle Service Name
The service name for an Oracle database server.
HP ALM (12.50)
Page 161
Administrator Guide
Chapter 8: Configuring Servers and Parameters
l
To edit the connection string, choose Connection String and edit the connection string.
l
For Oracle RAC support, enter a connection string, using the following example:
jdbc:company:oracle:TNSNamesFile=<ALM server>\tnsnames.ora;
TNSServerName=OrgRAC
o
tnsnames.ora is a file containing Oracle database addresses. For more details, refer to HP
Application Lifecycle Management Installation and Upgrade Guide.
o
OrgRAC is the address of the TNS server ALM should refer to.
Note: To enable Oracle RAC support, you must set the ORACLE_RAC_SUPPORT site
parameter to "Y". For more information, see "Setting ALM Configuration Parameters"
on page 168.
To check whether you can connect to the database server, click the Ping button. The DB admin
user and password you entered are displayed in the Ping Database Server dialog box. Click OK.
l
8. Click OK to close the Create Database Server dialog box.
9. If necessary, click the Refresh Database Servers List button
list.
to refresh the database servers
Modifying Database Server Properties
You can modify the database server properties.
Notes:
l
For information on the Oracle or Microsoft SQL permissions required by ALM, refer to the HP
Application Lifecycle Management Installation and Upgrade Guide.
l
You can configure the site administration database schema for Oracle RAC support. For more
information, refer to the HP Application Lifecycle Management Installation and Upgrade Guide.
l
For debugging issues related to closure, see the DEBUG_CLOSURE_LOG_DOM_PROJ site
parameter.
HP ALM (12.50)
Page 162
Administrator Guide
Chapter 8: Configuring Servers and Parameters
To modify database server properties:
1. In Site Administration, click the DB Servers tab.
2. Select a database server in the Database Servers list.
3. To modify the connection string, click the Edit Connection String button
, or click the
Connection String link. Edit the connection string in the Connection String Editor and click OK. For
more information on connection strings, see "Defining New Database Servers" on page 160.
4. To modify the database administrator's login name, click the Database Administrator User Name
link. In the Database Administrator User Name dialog box, type the new login name and click OK.
For more information on defining a new login name for a database administrator, see step 5 under
"Defining New Database Servers" on page 160.
5. To modify the database administrator's password, click the DatabaseAdministrator Password
button
, or click the Database Administrator Password link. In the Database
Administrator Password dialog box, type the new password and then retype it. Click OK.
6. To modify the default ALM user password for accessing the database schema, click the Application
Lifecycle Management User Password link. In the User Password dialog box, type the new
password and retype it. Click OK.
Note: If you change the ALM user password, you must update the user password in the
database server accordingly:
a. Replace the value of DefaultUserPassword in the siteadmin.xml file with the value of
DB_USER_PASS in the dbid.xml file.
b. Modify the td user password in the database.
c. Restart the ALM service or restart the server machine.
d. If you changed the password in the database before changing it in ALM:
HP ALM (12.50)
Page 163
Administrator Guide
Chapter 8: Configuring Servers and Parameters
i. Update DB_USER_PASS in the dbid.xml file of each project.
ii. Updated DB_USER_PASS in the PROJECTS table and the DBSERVERS table of the
qcsiteadmin_db schema.
7. To enable text search capabilities in ALM, click the Text Search link.
If the text search is enabled, you can set the default text search language for the database server
in the Default Search Language list.
For more information on text search, see "Configuring Text Search" below.
8. To check whether you can connect to the database server, click the Ping Database Server button.
The DB admin user and password you entered are displayed in the Ping Database Server dialog box.
Click OK.
9. To delete a database server from the Database Servers list, select it and click the Delete Database
Server button
. Click Yes to confirm.
10. Click the Refresh Database Servers List button
to refresh the database servers list.
Configuring Text Search
Text search allows users to enter keywords and search specific project fields in the Requirements, Test
Plan, and Defects modules. For information on working with the text search feature, refer to the HP
Application Lifecycle Management User Guide.
To configure text search:
l
l
l
l
Perform setups on each database user schema on which you want to enable text search. For more
information, see "Enabling Text Search on Database User Schemas" below.
In Site Administration, enable text search and define the default search language for a specified
database server in the DB Servers tab. For more information, see "Enabling Text Search in ALM" on
the next page.
To specify a different search language for a specific project, change the search language from the
Site Projects tab. For more information, see "Selecting a Text Search Language for a Project" on page
166.
For a specific project, define the project fields to be included in the search from Project
Customization. For more information, see "Defining Searchable Fields" on page 166.
Enabling Text Search on Database User Schemas
Before you enable text search in ALM, you must perform a set up step on each database user schema
on which you want to enable text search.
HP ALM (12.50)
Page 164
Administrator Guide
Chapter 8: Configuring Servers and Parameters
To enable text search on an Oracle database user schema:
As Admin user, run the following command:
GRANT CTXAPP to <database user schema>
To enable text search on an SQL database user schema:
Enable full text indexing:
EXEC sp_fulltext_database 'enable'
Enabling Text Search in ALM
In Site Administration, you can enable text search for a specified database server that has the text
search feature installed and configured. You can enable text search on a database server before or
after you add projects to your Projects list.
If you enable text search on a database server before you add projects, the projects that you add
afterwards are text search enabled. If you enable text search on a database server after you have
added projects, you must manually enable text search for each existing project.
After you have enabled the text search for a specified database server, you set the default search
language for the database server. You can change the default search language for a specific project
from the Site Projects tab. For more information, see "Selecting a Text Search Language for a Project"
on the next page.
To enable text search on a database server before adding projects:
1. In Site Administration, click the DB Servers tab.
2. In the Database Servers list, select a database server.
3. Click the Text Search link.
Caution: You cannot disable the text search after you have enabled it.
Click Yes to confirm. The Text Search value changes from Disabled to Enabled.
4. In the Default Search Language list, set the default text search language for the database server.
To enable text search on a database server after adding projects:
1. In Site Administration, click the DB Servers tab.
2. In the Database Servers list, select a database server.
3. Click the Text Search link.
Caution: You cannot disable the text search after you have enabled it.
HP ALM (12.50)
Page 165
Administrator Guide
Chapter 8: Configuring Servers and Parameters
Click Yes to confirm. The Text Search value changes from Disabled to Enabled.
4. In the Default Search Language list, set the default text search language for the database server.
5. Click the Site Projects tab, and select a project for which you want to enable text search.
6. In the Project Details tab, click the Enable/Rebuild Text Search button to enable and rebuild the
text search indexes. Click Yes to confirm.
If the operation of enabling and rebuilding the text search indexes times out before it completes,
you can change the default timeout value by defining the TEXT_SEARCH_TIMEOUT parameter. For
more information, see "Setting ALM Configuration Parameters" on page 168.
7. To enable text search for additional projects, repeat the previous two steps.
Selecting a Text Search Language for a Project
For each project, you can specify a search language other than the default search language you set for
the database server. For more information on enabling the text search and setting the default search
language, see "Enabling Text Search in ALM" on the previous page.
Note: Search languages are not available for a project created on a database server that does
not have the text search feature enabled.
To select a search language for a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project. In the right pane, click the Project Details tab.
3. In the Search Language field, select a language for the project. For more information on updating
project details in the Project Details tab, see "Updating Project Details" on page 68.
Defining Searchable Fields
For each project, you must define the fields to be included in the search in project customization. The
searchable option is only available in the Requirement, Test, Business Component, Business Process
Models, and Defect entities.
The following are available as searchable fields: l
User-defined fields with field type Memo or String
l
The following system fields.
Entity
Searchable System Fields
Business Component
l
Comments
l
Component Folder
l
Component Name
l
Description
HP ALM (12.50)
Page 166
Administrator Guide
Chapter 8: Configuring Servers and Parameters
Entity
Searchable System Fields
l
Original Location
l
Subtype ID
l
Comments
l
Description
l
Text
l
Comments
l
Description
l
Comments
l
Description
l
Summary
l
Comments
l
Description
l
Name
l
Rich Text
Run
l
Comments
Test
l
Comments
l
Description
l
Path
l
Protocol Type
l
Template
l
Test Name
Business Process Model Activities
Business Process Models
Defect
Requirement
To define a searchable field:
1. In the ALM main window, on the masthead, click
Customization window opens.
, then select Customize. The Project
2. Click the Project Entities link. The Project Entities page opens. For more information on
customizing project entities, see "Customizing Project Entities" on page 254.
3. Expand an entity, and select a system or user-defined field that can be made searchable.
HP ALM (12.50)
Page 167
Administrator Guide
Chapter 8: Configuring Servers and Parameters
4. Select the Searchable check box.
5. Click Save to save your changes to the Project Entities page.
Setting ALM Configuration Parameters
You can add, modify, and delete parameters in the Site Configuration tab. You can also export
parameters to a text file.
Note:
l
You cannot add or delete default parameters. You can only modify them.
l
You must reconnect to any open projects to work with the new settings.
HP ALM (12.50)
Page 168
Administrator Guide
Chapter 8: Configuring Servers and Parameters
To set ALM parameters:
1. In Site Administration, click the Site Configuration tab.
2. To add a new parameter to the list, click the New Parameter button. The New Parameter dialog
box opens. Type a name, value, and description for the parameter you want to add. Click OK.
Note: The parameter name is case-sensitive. You must enter the parameter name in all
capitals ( for example, ADD_NEW_USERS_FROM_PROJECT).
3. To delete a parameter from the list, select it and click the Delete Parameter button. Click Yes to
confirm.
4. To edit a parameter, select it from the list and click the Edit Parameter button. The Edit
Parameter dialog box opens. Type a new value and value description, and click OK.
5. To export parameters from the site configuration grid to a text file, click the Export button. The
Export Data To File dialog box opens. Select the directory where you want to save the parameters,
and type a name for the file in the File name box. Click Save.
6. You can click the Refresh Parameters List button
to refresh the parameter list.
Note:
l
For the list of available site parameters, see Site Parameters.
l
ALM configuration parameters related to external authentication can be found in the
HP Application Lifecycle Management External Authentication Configuration Guide.
Setting the ALM Mail Protocol
ALM uses email to send project information to users. You can select the mail service to be used by all
the server nodes in your ALM site. ALM supports the SMTP mail protocols.
HP ALM (12.50)
Page 169
Administrator Guide
Chapter 8: Configuring Servers and Parameters
For more information on setting the ALM mail protocol, refer to the HP Application Lifecycle Management
Installation and Upgrade Guide. To view the protocol currently configured, see the MAIL_PROTOCOL
parameter in the Site Configuration tab in Site Administration. For more information, see "Setting ALM
Configuration Parameters" on page 168.
To set the ALM mail protocol:
1. In Site Administration, click the Site Configuration tab.
2. Click the Settings button and select Set Mail Protocol. The Set Mail Protocol dialog box opens.
3. Select one of the following options:
l
l
l
None. ALM does not send an email.
SMTP Server. ALM sends an email from an SMTP server on the network. Type the address of an
SMTP server available on your local area network. For details, see the MAIL_SERVER_HOST
parameter.
Microsoft IIS SMTP Service. ALM sends an email from the ALM server machines. This option is
available if you installed Microsoft IIS SMTP Service on your ALM server machines during IIS
installation.
4. Click Test to send a test email to your mailbox. The Test Mail dialog box opens. Type an email
address and click Send. A pop-up message confirms whether the mail was sent successfully.
5. Click OK to close the Set Mail Protocol dialog box.
Setting ALM Mail Restrictions
ALM uses email to send project information to users. You can restrict which users receive emails.
To set ALM mail restrictions:
1. In Site Administration, click the Site Configuration tab.
2. Click the Settings button and select Mail Restriction. The Mail Restriction Definition dialog box
opens.
3. Select the restriction level:
l
All. ALM sends an email to any address.
l
Per Site Level.ALM sends an email only to those users who are on the site.
l
Per Project. ALM sends an email only to those users who are assigned to the project.
4. Click OK to close Mail Restriction Definition dialog box.
HP ALM (12.50)
Page 170
Chapter 9: Analyzing Site Usage
In Site Administration, you can track the number of licensed users that have connected to your HP
Application Lifecycle Management (ALM) site at specific points over a period of time. You can also
analyze ALM usage by filtering the number of licensed users by projects, users or license types.
This chapter includes:
•
•
•
•
•
About Analyzing Site Usage
172
Monitoring Site Usage
172
Filtering Site Usage
173
Exporting Site Analysis Data to a File
174
Customizing the Site Analysis Line Chart Graph
175
HP ALM (12.50)
Page 171
Administrator Guide
Chapter 9: Analyzing Site Usage
About Analyzing Site Usage
You use the Site Analysis tab in Site Administration to monitor license usage for each time interval
displayed. You can specify the time interval displayed along the x-axis. You can also specify what
information appears in the graph by filtering the graph content by projects, users, or license types.
Example
You may want to charge each department in your organization according to license usage. You
can filter by projects in a specific department to view license usage for the department. You can
also view license usage for a specific group of users by filtering according to selected users.
If the Site Analysis tab is not displayed, you can make it available by editing the SITE_ANALYSIS
parameter in the Site Configuration tab in Site Administration. For more information, see "Setting ALM
Configuration Parameters" on page 168.
Monitoring Site Usage
You can monitor the number of licensed users that have connected to an ALM site over a selected
period of time. You can analyze the usage level of each module and extension, and track the peak usage
level in the current month. The data can be displayed in line graphs or data grids. In addition, you can
filter records by projects, users, or license type, and save data to a file.
Note: You can also monitor the users currently connected to an ALM server. For more
information, see "Managing User Connections and Licenses" on page 145.
To monitor site usage:
HP ALM (12.50)
Page 172
Administrator Guide
Chapter 9: Analyzing Site Usage
1. In Site Administration, click the Site Analysis tab.
2. In the Type box, select a display type:
l
Line Chart. Displays the data as a line graph.
l
Data Grid. Displays the data as a grid.
3. In the right pane under Period, select a set or custom period of time you want the line graph or
data grid to show.
4. Under Level of Detail, select the time period between each measurement.
5. Click the Filter button to open the Set Filter dialog box and filter the graph contents. For more
information, see "Filtering Site Usage" below.
6. To customize the appearance of a Line Chart graph, see "Customizing the Site Analysis Line Chart
Graph" on page 175.
7. If you chose Data Grid, you can save the contents of a data grid as a text file, Microsoft Excel
spreadsheet, Microsoft Word document, or HTML document. To save, click the Save As button. For
more information, see "Exporting Site Analysis Data to a File" on the next page.
8. To refresh data in the graph, click the Refresh button.
Filtering Site Usage
You can analyze the number of users that have connected to your ALM site at specific points over time
by filtering by projects, users, or license types.
To filter site usage:
1. In Site Administration, click the Site Analysis tab.
2. Click the Filter button in the bottom right corner. The Set Filter dialog box opens.
HP ALM (12.50)
Page 173
Administrator Guide
Chapter 9: Analyzing Site Usage
3. Under Filter By, select the category that you want to filter:
l
Projects. Displays all the ALM domains and projects.
l
Users. Displays all the ALM site users.
l
License Types. Displays all the available license types.
4. Click the items you want to include in the filter.
l
For Projects, double-click the domain folder to display the domain's projects, and select the
projects you want to include. To filter all projects in the domain, select the domain folder.
l
For Users, select the users you want to include.
l
For License Types, select the licenses you want to include.
5. To clear the selected filter conditions, click the Clear button
.
6. Click OK to apply the filter and close the Set Filter dialog box. The new line chart or data grid is
displayed.
Exporting Site Analysis Data to a File
You can export site analysis data in a Data Grid as a text file, Microsoft Excel spreadsheet, Microsoft
Word document, or HTML document.
To export Site Analysis data to a file:
1. In Site Administration, click the Site Analysis tab.
2. In the Type field, select the Data Grid display type.
HP ALM (12.50)
Page 174
Administrator Guide
Chapter 9: Analyzing Site Usage
3. Select the analysis period and define a filter.
4. Click Save as, and select one of the following formats:
l
Text Format. Saves the data as a Text file.
l
Excel Sheet. Saves the data as an Excel sheet.
l
Word Document. Saves the data as a Word document.
l
HTML Document. Saves the data as an HTML document.
5. In the Save in box, choose a location for the file.
6. In the File name box, type a name for the file.
The Save as type box is automatically filled according to the format you selected.
7. Click Save.
Customizing the Site Analysis Line Chart Graph
You can determine how information appears in the Line Chart graph using the line chart toolbar. The
toolbar includes the following buttons:
Tool
Element
Description
Show Total Values. Toggles between displaying and hiding a total value in the graph.
Scroll to the Left. Scrolls the graph to the left. (This button is enabled when the Zoom In and Zoom Out
buttons are in use.)
Scroll to the Right. Scrolls the graph to the right. (This button is enabled when the Zoom In and Zoom Out
buttons are in use.)
Show All. Returns the graph to its normal size. (This button is enabled when the Zoom In and Zoom Out
buttons are in use.)
Zoom In. Increases the magnification of the selected portion of the graph.
Zoom Out. Decreases the magnification of the selected portion of the graph.
Rotate Bottom Labels. Toggles between displaying the text on the x-axis vertically and horizontally.
Set 2D/3D Graph. Toggles the graph from two to three dimensions.
HP ALM (12.50)
Page 175
Administrator Guide
Chapter 9: Analyzing Site Usage
Tool
Element
Description
Copy Graph to Clipboard. Copies the graph to the Clipboard.
Print Graph. You can choose to print the graph in portrait or landscape view.
HP ALM (12.50)
Page 176
Chapter 10: Scheduling Calculations for Project
Planning and Tracking (PPT)
In Site Administration, you can schedule project planning and tracking (PPT) calculations for your HP
Application Lifecycle Management (ALM) projects.
ALM Editions: Functionality related to PPT is available for ALM Edition only. For more information
about ALM editions and their functionality, see the HP Application Lifecycle Management User
Guide.
This chapter includes:
•
•
•
•
•
About Scheduling Calculations for PPT
178
Scheduling Calculations for a Site
178
Enabling or Disabling Automatic Calculations for a Project
178
Launching Calculations for a Project Manually
179
Project Planning and Tracking Tab
180
HP ALM (12.50)
Page 177
Administrator Guide
Chapter 10: Scheduling Calculations for Project Planning and Tracking (PPT)
About Scheduling Calculations for PPT
PPT tracks application readiness and displays the status of your release in the form of a scorecard. The
scorecard monitors and tracks how well each milestone is being met on a daily basis.
To view progress in the scorecard, you must run PPT calculations for your project. You can schedule
calculations for your ALM site, and enable scheduled calculations for specific projects and include them
in your daily progress calculations. In addition, you can manually trigger calculations for a selected
project in order to refresh its results without waiting for an upcoming scheduled calculation.
For more details on PPT, refer to the HP Application Lifecycle Management User Guide.
Note: For information on configuring PPT log files, see "Configuring Server Information" on page
158.
Scheduling Calculations for a Site
This section describes how to schedule PPT calculations for an ALM site.
To schedule calculations for a site:
1. In Site Administration, click the Project Planning and Tracking tab.
2. Schedule calculations in the Project Planning and Tracking tab. For user interface details, see
"Project Planning and Tracking Tab" on page 180.
3. Enable projects for automatic calculations. For more details, see "Enabling or Disabling Automatic
Calculations for a Project" below.
Enabling or Disabling Automatic Calculations for a
Project
This section describes how to enable PPT calculations for a project in order to include it in the automatic
daily calculations of your site. When your business needs change, you can disable calculations for a
project.
Note: PPT is enabled by default when creating a new project.
HP ALM (12.50)
Page 178
Administrator Guide
Chapter 10: Scheduling Calculations for Project Planning and Tracking (PPT)
To enable or disable automatic calculations for a project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. In the Project Details tab, under Project Planning and Tracking, click Automatic Calculations
State. Click OK to confirm.
Launching Calculations for a Project Manually
This section describes how to manually trigger PPT calculations for a project in order to refresh its
results without waiting for the next scheduled calculation.
To launch calculations for a project manually:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, select a project.
3. In the Project Details tab, under Project Planning and Tracking, click the Run Now button.
HP ALM (12.50)
Page 179
Administrator Guide
Chapter 10: Scheduling Calculations for Project Planning and Tracking (PPT)
Project Planning and Tracking Tab
This tab enables you to manage PPT calculations for your entire site.
To access
Important
information
In Site Administration, click the Project Planning and Tracking tab.
l
l
The database server time displayed on the bottom right-side of the Project Planning and Tracking tab is used
when scheduling calculations.
By default, ALM performs calculations on a project that has been in use in the past 7 days. If a project has not
been in use in the past 7 days, calculations are not performed. To change the number of days, edit the PPT_
RECENTLY_USED_PROJECTS_THRESHOLD_MINUTES parameter in the Site Configuration tab in Site
Administration. For more information, see "Setting ALM Configuration Parameters" on page 168.
l
By default, if 10% or more of the KPI calculations within the release fail, ALM aborts project planning and
tracking calculations on a release and skips to the next release in a project. To change the percentage value,
edit the PPT_KPI_FAILURES_PERCENTAGE_PER_RELEASE_FUSE parameter in the Site Configuration
tab in Site Administration. For more information, see "Setting ALM Configuration Parameters" on page
168.
Miscellaneous Elements
User interface elements are described below:
UI Elements
Description
This button includes the following options:
Refresh Status. Refreshes the Project Planning and Tracking tab so that it displays the most
up-to-date information.
Automatic Refresh. Instructs ALM to automatically refresh the Project Planning and Tracking
HP ALM (12.50)
Page 180
Administrator Guide
Chapter 10: Scheduling Calculations for Project Planning and Tracking (PPT)
UI Elements
Description
tab. By default, the tab is automatically refreshed every 60 seconds.
Set Refresh Rate. Opens the Set Refresh Rate dialog box, enabling you to change the
automatic refresh rate in seconds.
Terminates all PPT activities.
Enables PPT for your site.
Current Status
Includes the following options:
Enabled/Disabled. Indicates whether PPT is enabled for your site.
Active/Inactive. Indicates whether the scheduled calculation is currently running.
Apply Settings
Applies scheduling changes.
Scheduling Area
This area enables you to schedule PPT calculations for your entire site.
User interface elements are described below:
UI Elements
Description
Automatically Run Calculations On
Indicates whether or not scheduled calculations are performed on your site.
Daily Calculation Start Time
Start time for scheduling PPT calculations.
Calculation Recurrence
Runs calculations periodically at a specified time.
Abort Calculation After
Ends scheduled calculations at a specified time.
Purge Area
This area enables you to purge calculations after a specific time period.
User interface elements are described below:
UI Elements
Description
Delete data older than X
days
Deletes data older than the defined value. The default value is set to 120 days.
Note: To retain the scorecards, the last five days of the results of the
milestone are not purged.
Advanced Area
This area enables you to increase the number of parallel calculations that are being performed on an
HP ALM (12.50)
Page 181
Administrator Guide
Chapter 10: Scheduling Calculations for Project Planning and Tracking (PPT)
entire site. You can also change the speed of scheduled calculations.
User interface elements are described below:
UI
Description
Elements
Override
Settings
Enables the advanced settings.
Number
of
Engines
Sets the number of parallel calculations that are being performed concurrently on an entire site.
Engines
Throttle
Changes the speed that it takes for ALM to calculate the KPI data. 1 indicates a slower processing speed and
HP ALM (12.50)
minimum database stress. 10 indicates a faster processing speed and maximum database stress.
Page 182
Chapter 11: ALM Advisor
This chapter describes the ALM Advisor process for collecting and analyzing environment details in order
to assess the current ALM deployment and to recommend usage improvements.
This chapter includes:
•
•
About ALM Advisor
184
Collecting and Assessing ALM Data
188
HP ALM (12.50)
Page 183
Administrator Guide
Chapter 11: ALM Advisor
About ALM Advisor
As an ALM site administrator, you can collect environment details to assess the current ALM deployment
and recommend usage improvements. The collected data can also be helpful when contacting support.
The ALM Advisor process collects environment details, which are stored in a file in the following location:
C:\ProgramData\HP\ALM\Repository\productData\assessment.
Once these details are collected, you can then access the ALM Advisor website to assess the deployment
and recommend usage improvements.
Note: Some of the SQL Server properties require the site administrator for that database to
have advanced options permissions. To ensure these permissions, run the following:
sp_configure 'show advanced options', 1
GO
RECONFIGURE
GO
The following table describes the collected details.
Note: For more information on EHCache, see HP Software Self-solve knowledge base article
KM00213910 (http://h20230.www2.hp.com/selfsolve/document/KM00213910).
Property Name
Description
DB Common Data
Name
DB Server name
Version
DB Server version
SQL Server Data
productLevel
The level of the version of the SQL Server instance
edition
The installed product edition of the SQL Server instance
engineEdition
Database Engine edition of the SQL Server instance installed on the
server
editionId
The edition ID of the SQL Server instance
isFullTextInstalled
Indicates whether the full-text and semantic indexing components
HP ALM (12.50)
Page 184
Administrator Guide
Chapter 11: ALM Advisor
Property Name
Description
are installed on the current SQL Server instance
collation
Name of the default collation for the server
osMachineName
Windows computer name on which the server instance is running
Oracle DB Data
sga_max_size
Hard limit up to which sga_target can dynamically adjust sizes
processes
The maximum number of operating system user processes that
can simultaneously connect to Oracle
sessions
Maximum number of sessions that can be created in the system
cpu_count
The number of CPUs available for use by the Oracle database
db_cache_size
The size of the DEFAULT buffer pool for buffers with the primary
block size
log_buffer
The amount of memory (in bytes) that Oracle uses when buffering
redo entries to a redo log file
shared_pool_size
The size of the shared pool
large_pool_size
The size of the large pool allocation heap
java_pool_size
The size of the Java pool, from which the Java memory manager
allocates most Java state during runtime execution
pga_aggregate_target
The target aggregate PGA memory available to all server processes
attached to the instance
optimizer_mode
Establishes the default behavior for choosing an optimization
approach for the instance
optimizer_features_enable
Acts as an umbrella parameter for enabling a series of optimizer
features based on an Oracle release number
compatible
Allows using a new release of Oracle, while at the same time
guaranteeing backward compatibility with an earlier release
cursor_sharing
Determines what kind of SQL statements can share the same
cursors
open_cursors
Specifies the maximum number of open cursors (handles to private
SQL areas) a session can have at once
session_cached_cursors
Specifies the number of session cursors to cache
memory_max_target
Specifies the maximum value to which a DBA can set the MEMORY_
TARGET initialization parameter
sga_target
Specifies the total size of all SGA components
NLS Parameters (NLS_CHARACTERSET, NLS_
LANGUAGE , NLS_TERRITORY, NLS_LENGTH_
SEMANTICS)
Character set related information
HP ALM (12.50)
Page 185
Administrator Guide
Chapter 11: ALM Advisor
Property Name
Description
Site Usage Data
usersCount
Number of site users
activeUsersCount
Number of active site users
operativeUsersCount
Number of active site users who opened a session in the last 30
days
projectsCount
Number of projects
activeProjectsCount
Number of active projects
operativeProjectsCount
Number of active projects that had a session in the last 30 days
Application Server Data
maxDbConnectionsAllowed
The maximum concurrent db connections allowed
connectorName
Jetty connector name
maxConnectionsRequest
The maximum number of connections requests
maxConnectionsOpen
The maximum number of open connections
maxConnectionsDuration
The maximum duration of connections
Architecture Data
activeNodes
Number of active nodes- application servers
totalNodes
Total number of nodes
serverName
Application server name
isActive
Application server status
General Site Data
almEdition
ALM edition
almEditionDisplayName
ALM edition display name
informationCollectionTime
Information collection time in milliseconds
extensionName
Extension name
extensionDisplayName
Extension display name
version
Extension version
Cache Data
cacheManagerName
Name of the EHCache manager
cacheName
Name of the cache
objectCount
Number of items found in cache
HP ALM (12.50)
Page 186
Administrator Guide
Chapter 11: ALM Advisor
Property Name
Description
maxElementsInMemory
Sets the maximum number of objects created in memory
maxElementsOnDisk
Sets the maximum number of objects maintained in the DiskStore
memoryStoreEvictionPolicy
Policy enforced upon reaching the maxElementsInMemory limit
eternal
Determines whether an element is eternal, meaning that timeouts
are ignored and the element is never expired
timeToIdleSeconds
Sets the time for an element to idle before it expires
timeToLiveSeconds
Sets the time for an element to live before it expires
overflowToDisk
Determines whether elements can overflow to disk when the
memory store reaches the maxElementsInMemory limit
diskPersistent
Determines whether the disk store persists between restarts of the
Virtual Machine
diskSpoolBufferSizeMB
The size to allocate the DiskStore for a spool buffer
diskExpiryThreadIntervalSeconds
The number of seconds between runs of the disk expiry thread
statisticsAccuracy
The accuracy of the cache statistics at the time the statistic was
computed
cacheHits
The number of times a requested item was found in the cache
onDiskHits
The number of times a requested item was found in the Disk Store
inMemoryHits
The number of times a requested item was found in the Memory
Store
misses
The number of times a requested element was not found in the
cache
averageGetTime
The average get time
evictionCount
Gets the number of cache evictions since the cache was created or
statistics were cleared
Jvm Data
jvmVersion
Version of JVM being used
usedHeapSize
The total amount of memory in the Java virtual machine
maxHeapSize
The maximum amount of memory that the Java virtual machine
attempts to use
freeHeapSize
The amount of free memory in the Java virtual machine
nonHeapUsedSize
The amount of used memory in bytes
nonHeapInitSize
The amount of memory in bytes that the Java virtual machine
initially requests from the operating system for memory
management
HP ALM (12.50)
Page 187
Administrator Guide
Chapter 11: ALM Advisor
Property Name
Description
nonHeapCommittedSize
The amount of memory in bytes that is committed for the Java
virtual machine to use
nonHeapMaxSize
The maximum amount of memory in bytes that can be used for
memory management
name
The name representing this memory manager
collectionElapseTime
The approximate accumulated collection elapsed time in
milliseconds
innerCollectionCount
The total number of collections that have occurred
memoryPoolNames
The names of memory pools that this memory manager manages
architecture
Architecture of the JVM being used
is64Bit
Whether the JVM being used has 64 bits architecture
numberOfProcessorsAvailable
Number of processors available for this JVM
Machine Specification Data
totalMemoryMB
Total memory installed on the machine
QCSense Data
startGroupingTime
Segment starting time
endGroupingTime
Segment ending time
nodeName
Name of the node for which the data was collected
measurementName
Name of the measurement collected during the segment
weightedMeanAverageValue
Weighted mean of the average value recorded during the segment
minimumValue
Minimum value recorded during the segment
weightedMeanMinimumValue
Weighted mean of the minimum value recorded during the
segment
maximumValue
Maximum value recorded during the segment
weightedMeanMaximumValue
Weighted mean of the maximum value recorded during the
segment
measurementsInspectedNumber
Number of records (measurement values) recorded during the
segment
Collecting and Assessing ALM Data
You can assess the current ALM deployment and recommend usage improvements based on the
environment details collected.
To collect environment details:
HP ALM (12.50)
Page 188
Administrator Guide
Chapter 11: ALM Advisor
1. In Site Administration, select Tools > ALM Advisor. The ALM Advisor dialog box opens.
2. Select Data Protection to protect sensitive data. Click
for more information on the data
protection process.
3. Click Collect to begin the data collection process. An email is sent when the process is complete.
Note: The email may indicate that the data collection process did not complete
successfully. In this case, ensure that all nodes are active and rerun the data collection
process.
4. Once the data collection process is complete, log in to the ALM Advisor website. The link to the
website is found in the email sent when the data collection process is complete, or click Go to Site
in the ALM Advisor dialog box.
5. Follow the instructions on the website to upload the collected data and to complete the
assessment process.
HP ALM (12.50)
Page 189
Administrator Guide
Chapter 11: ALM Advisor
HP ALM (12.50)
Page 190
Chapter 12: ALM Robot
This chapter describes how to use ALM Robot to run activities for multiple projects in parallel. ALM
Robot supports the following activities:
l
l
Project upgrade. Upgrades multiple ALM projects in parallel to your new version of ALM.
Undo checkout. Reverts version controlled projects to their state prior to the check out. This activity
is especially useful as a centralized approach to managing version controlled entities.
Performing these activities manually can be time-consuming and complicated, especially for a large
number of projects. ALM Robot streamlines and automates these activities, enabling you to process a
selected number of ALM projects in parallel.
Note: For recent documentation updates on ALM Robot, check the online help.
This chapter includes:
•
•
•
•
•
Considerations Before Getting Started with ALM Robot
192
•
Project Upgrade Best Practices
192
Upgrading Projects Using ALM Robot
193
Undoing Checkouts Using ALM Robot
198
Customizing ALM Robot
200
•
•
•
Managing Environments
200
Sending Email Notices
201
Setting Site Parameters
201
ALM Robot Dashboard Actions
202
HP ALM (12.50)
Page 191
Administrator Guide
Chapter 12: ALM Robot
Considerations Before Getting Started with ALM Robot
l
l
l
l
l
Caution: Projects must be backed up before running any activity in ALM Robot.
ALM Robot does not support upgrading multiple projects when their database schemas are stored in
different database types or versions per activity. Each activity must contain projects based on the
same database instance.
ALM Robot supports running activities on ALM 11.52 or later. Make sure the appropriate patch is
installed on your server:
l
ALM 11.52 requires Patch 7 or later
l
ALM 12.01 requires Patch 2 or later
l
ALM 12.20 requires Service Pack 1 or later
ALM Robot does not back up the repository, database, or Site Administration schema. These steps
must be performed manually before running ALM Robot.
Prior to running ALM Robot, if you are using a new database server, you must back up the schema on
the original database server and restore it manually to the target database server.
l
Prior to running ALM Robot, make sure that the project schema exists on your target database.
l
Only one activity can be executed at a time.
l
l
If an activity is stopped during the upgrade action, the project may become corrupted. If this occurs,
the database administrator must roll back the project using its backed up database schema and
repository.
ALM Robot cannot upgrade projects with the Service Test Management extension. This extension is
no longer available in ALM 12.50.
Project Upgrade Best Practices
To upgrade from a previous version with the minimum possible interruption to your system operations,
you should be familiar with the considerations and recommendations involved in the upgrade process.
The following guides are available:
HP ALM Upgrade Best
Practices Guide (view
online)
Provides information on upgrade methodology. Following these best practices can assist you in
preparing and planning your ALM upgrade.
HP ALM Database Best
Practices Guide (view
online)
Provides best practices for implementing HP ALM. Following these best practices can help you
when upgrading your database or moving to a different database as a part of your overall upgrade
plan.
HP ALM (12.50)
Page 192
Administrator Guide
Chapter 12: ALM Robot
Upgrading Projects Using ALM Robot
You can automatically upgrade multiple ALM projects in parallel to your new version of ALM.
As part of the upgrade process, ALM Robot performs the following actions as required:
l
Deactivate activated projects.
l
Undo check outs of entities in version controlled projects.
l
Copy projects' repositories to a new repository server, as needed.
l
Restore projects.
l
Once project upgrade is successfully completed, ALM Robot automatically removes the projects from
the original ALM instance.
l
Verify, repair, and upgrade projects.
l
Activate any projects that were active before the upgrade.
l
ALM Robot does not perform any post upgrade activities, such as project validation, updating
required changes that result from an ALM server change, aligning integrations, and so on.
Information on the upgrade process and the existing upgrade functionality, which is still available within
Site Administration, can be found in the Project Upgrade part of the HP Application Lifecycle
Management Installation and Upgrade Guide (view online).
Note: Before you get started with ALM Robot, review the "Considerations Before Getting
Started with ALM Robot" on the previous page.
To upgrade your projects using ALM Robot:
1. In Site Administration, select Tools > ALM Robot. ALM Robot opens.
2. Click Add Activity to create a new activity for ALM Robot. A wizard opens in the Activity Settings
page.
HP ALM (12.50)
Page 193
Administrator Guide
Chapter 12: ALM Robot
3. Define activity settings.
On the Activity Settings page of the wizard:
a. In the Activity Name box, enter a name for your activity.
b. In the Type box, select Upgrade.
c. Determine the source location of the projects for project selection. The source depends on
where your Site Administration database schema is located.
Target If you upgraded a copy of the existing Site Administration database schema when installing your new
version of ALM, select Target as the source of the projects.
Note: If the ALM source includes version controlled projects that have not been upgraded yet, and those
projects have checked out entities, you must run the Upgrade activity using the Origin option instead of
the Target .
Origin
o
If you created a new Site Administration database schema when installing your new version of ALM,
select Origin as the source of the projects, and click Edit Env list to define the ALM server from
which you will select the projects to upgrade. For details on adding ALM environments, see
"Customizing ALM Robot" on page 200.
Note: The Origin server must be directly accessible by the Target server.
o
Copy projects repositories. Select this option as a default for copying all selected projects'
repositories from the origin's base repository path to the target's base repository path. Note that you
can remove specific projects' repositories from this selection in the Project Settings page.
Notes:
l
You cannot copy a repository that resides on a network mounted drive on Windows.
l
To copy a repository on Linux, it must be mounted on a shared folder on the ALM server where
ALM Robot is running. This path must be specified in the Origin Repository Path field.
l
o
When copying a repository, the user running the ALM service must have the relevant "read"
credentials to the shared repository.
Origin Repository Path. If you select Copy projects repositories, enter the network shared path
to the Origin Repository Path. This path must be accessible from the server where ALM Robot is
running.
HP ALM (12.50)
Page 194
Administrator Guide
Chapter 12: ALM Robot
Caution: If you do not select the Copy projects repositories option, you must
manually copy the repository to the base repository path on the destination server
prior to running the upgrade. Note that the repository folder structure must be
preserved while copying the repository folders.
d. Click Next to open the Projects Selection page and display the available projects.
4. Select projects.
On the Projects Selection page of the wizard:
a. From the list of projects and domains, select the projects to include in your activity. You can
select all projects, all projects in a specific domain, or specific projects.
The Dependencies column indicates any project dependencies. Projects that have lab
extensions are dependent on Lab_Project, and projects that are linked to a template are
dependent on a template project.
After your selection, click
pane.
to move the selected projects to the Selected Projects & Rank
To remove projects from the selected list, select the projects and click
from the Selected Projects & Rank pane.
to remove them
b. To set the order in the Selected Projects & Rank pane in which the projects will be processed
during the upgrade, highlight a project and click the arrows at the top
to
move the project up or down in the list.
Note:
o
Lab_Project is always ranked first when selected, followed by template projects. All
other projects are added to the Selected Projects & Rank pane in the same order
as they appear in the Projects Tree, but can be moved according to your priorities.
o
HP ALM (12.50)
Lab_Project is located in the DEFAULT domain.
Page 195
Administrator Guide
Chapter 12: ALM Robot
o
By default, ALM Robot can process up to 10 projects simultaneously on each ALM
node. To change the default value, edit the ROBOT_MAX_TASKS_PER_NODE site
parameter and set it according to your environment performance, as a large value
can cause performance degradation.
c. Note any possible warning messages that may appear at the bottom of the Selected Projects
& Rank pane.
d. Click Next to open the Project Settings page.
5. Define project settings.
On the Project Settings page of the wizard:
a. Under Project Name, select a project.
b. If you selected Target as the source for the project selection, you can:
Add an
You can add an exception file to ignore certain warnings and errors while running the Upgrade
Exception activity.
File
For example, if you have made changes to the schema such as the addition of tables, columns, or
sequences, the upgrade processes may fail. You can define an exception file that instructs ALM Robot
to ignore these changes during the upgrade process.
Note: You can create a global exception file via the UPGRADE_EXCEPTION_FILE site parameter.
This parameter impacts all selected projects.
For details on exception files, see the "Define an Exception File" section of the HP Application
Lifecycle Management Installation and Upgrade Guide (view online).
If you selected Origin as the source for the project selection, the following options are
available.
Copy
Enables you to copy the project repository from the Origin to the Target . You need to copy the
project repository when you change the repository server or repository path. Repositories must be
Project
Repository defined on a shared network path.
HP ALM (12.50)
Page 196
Administrator Guide
Chapter 12: ALM Robot
If you selected Copy Projects Repositories on the Activity Settings screen, Copy Project
Repository is automatically selected. If this option is unchecked, then the repository for this specific
project will not be copied.
If a project has a repository path different from the base repository path set in Site Administration,
you must manually update the value for the From and To fields.
Note:
o
You cannot copy a repository that resides on a network mounted drive on Windows.
o
To copy a repository on Linux, it must be mounted on a shared folder on the ALM server where
ALM Robot is running. This path must be specified in the Origin Repository Path field.
o
Add an
Exception
File
When copying a repository, the user running the ALM service must have the relevant "read"
credentials to the shared repository.
You can add an exception file to ignore certain warnings and errors while running the Upgrade
activity.
For example, if you have made changes to the schema such as the addition of tables, columns, or
sequences, the upgrade processes may fail. You can define an exception file that instructs ALM Robot
to ignore these changes during the upgrade process.
Note: You can create a global exception file via the UPGRADE_EXCEPTION_FILE site parameter.
This parameter impacts all selected projects.
For details on exception files, see the "Define an Exception File" section of the HP Application
Lifecycle Management Installation and Upgrade Guide (view online).
Target DB
Schema
Name
Enter the database schema name used in the Target , if it is different from the database schema
name in the Origin.
Note: If your project selection includes the Lab_Project, in order to upgrade it, ALM
Robot requires a copy of the Lab_Project.
To create a copy of the Lab_Project:
i. Under Project Name, select the Lab_Project.
ii. Select Copy Project Repository.
iii. Select Target DB Schema Name and type a schema name for the copy.
c. Click Next for a summary of the activity you have created.
6. Review the activity summary.
The Activity Summary shows the configuration of your activity. The Activity Tasks section shows
the projects selected for your activity and the changes made per project on the Project Settings
page.
Click Submit. ALM Robot starts the validation process.
If the validation process is completed successfully, the activity begins processing. The dashboard
window opens. See "ALM Robot Dashboard Actions " on page 202 for details.
HP ALM (12.50)
Page 197
Administrator Guide
Chapter 12: ALM Robot
If ALM Robot detects an error while validating the selected projects, fix the error and click Submit.
Undoing Checkouts Using ALM Robot
ALM Robot enables you to revert version controlled projects to their state prior to the check out. This
activity is especially useful as a centralized approach to managing version controlled entities. For
example, you can unlock the checked out entities of users that are no longer using your projects.
Caution: Performing undo checkout causes the loss of any data updates made since the
entities were last checked in.
Note:
l
The user running the Undo checkout activity must be the project administrator of the
selected projects. This can be done manually by assigning the user in the Project Users tab
to the relevant projects. For more details, see "Assigning Users to Projects" on page 71.
Alternatively, to set the user running the Undo checkout activity as a project administrator,
set the ROBOT_AUTO_ADD_USER site parameter to "Y". For more details, see "Customizing
ALM Robot" on page 200.
l
Undo checkout is also performed by ALM Robot as part of the Upgrade activity.
Note: Before you get started with ALM Robot, review the "Considerations Before Getting
Started with ALM Robot" on page 192.
To undo check outs using ALM Robot:
1. In Site Administration, select Tools > ALM Robot. ALM Robot opens.
2. Click Add Activity to create a new activity for ALM Robot. A wizard opens in the Activity Settings
page.
HP ALM (12.50)
Page 198
Administrator Guide
Chapter 12: ALM Robot
3. Define activity settings.
On the Activity Settings page of the wizard:
a. In the Activity Name box, enter a name for your activity.
b. In the Type box, select Undo checkout.
c. Determine the source location of the projects for project selection. The source depends on
where your Site Administration database schema is located.
Target To undo checkout of projects already upgraded to the current ALM version, select Target as the source
of the projects.
Origin
To undo checkout of projects on previous ALM versions, select Origin as the source of the projects, and
click Edit Env list to add the original ALM server to the list of environments. See "Customizing
ALM Robot" on the next page for details.
d. Click Next to open the Projects Selection page.
4. Select projects.
On the Projects Selection page of the wizard:
a. From the list of projects and domains, select the version controlled projects to include in your
activity. You can select all projects, all projects in a specific domain, or specific projects.
HP ALM (12.50)
Page 199
Administrator Guide
Chapter 12: ALM Robot
The Dependencies column indicates any project dependencies. Projects that have lab
extensions are dependent on Lab_Project, and projects that are linked to a template are
dependent on the template project
After your selection, click
pane.
to move the selected projects to the Selected Projects & Rank
To remove projects from the selected list, select the projects and click
from the Selected Projects & Rank pane.
to remove them
b. To set the order in the Selected Projects & Rank pane in which the projects will be processed
during the upgrade, highlight a project and click the arrows at the top
to
move the project up or down in the list.
Note: By default, ALM Robot can process up to 10 projects simultaneously on each ALM
node. To change the default value, edit the ROBOT_MAX_TASKS_PER_NODE site
parameter and set it according to your environment performance, as a large value can
cause performance degradation.
c. Click Next for a summary of the activity you have created.
5. Review the activity summary.
a. The Activity Summary shows the configuration of your activity. The Activity Tasks shows the
projects selected for your activity.
b. Click Submit. ALM Robot starts the validation process.
If the validation process is completed successfully, the activity begins processing. The
dashboard window opens. See "ALM Robot Dashboard Actions " on page 202 for details.
If ALM Robot detects an error while validating the selected projects, fix the error and click
Submit.
Customizing ALM Robot
You can customize ALM Robot to define the environments from which you will select the projects to
update, and to send email notices when an activity finishes or when a task in an activity fails. You can
also customize ALM Robot using site parameters.
Managing Environments
If you select Origin as the source of the projects for your activity, you set the Origin Instance based on
your defined environments.
Click
HP ALM (12.50)
and select Environment Management. The Environment Management dialog box opens.
Page 200
Administrator Guide
Chapter 12: ALM Robot
You can perform the following actions:
l
Add. Adds an environment to the list.
l
Validate. Validates a selected environment to determine if you have access to the environment.
Note: Upgrade fails if the Origin ALM server is inaccessible from the server on which the
upgrade is running.
l
Remove. Removes a selected environment from the list.
l
To edit an environment's details, double-click the environment.
Sending Email Notices
You can send email notices when an activity finishes or when a task (project) in an activity fails. An email
notice includes details such as activity names, activity types, tasks, and task statuses.
Click
and select Email Settings. The Email Settings dialog box opens.
1. Select the option to send an email when an activity finishes or when an activity fails.
To send emails, you must first set the ALM mail protocol and apply relevant rules from Site
Administration. For details, see "Setting the ALM Mail Protocol" on page 169.
2. Enter the email addresses of any users who should receive the email. Separate the addresses by a
semicolon.
Setting Site Parameters
You can also customize ALM Robot using the following site parameters:
ROBOT_MAX_
TASKS_PER_
NODE
Sets the amount of simultaneously running tasks on each node. This parameter should be set according
to your environment performance, as a large value can cause performance degradation. The default value
is "10".
ALM_ROBOT_
LOGGER_
Indicates the level of the ALM Robot logs. The values are:
HP ALM (12.50)
Page 201
Administrator Guide
Chapter 12: ALM Robot
DEBUG_LVL
ROBOT_AUTO_
ADD_USER
l
1 - error
l
2 - warning
l
3 - flow (this is the default value)
l
4 -debug
Sets the Site Administrator as a Project Administrator of the selected projects. The default value is set to
"N".
To perform the undo checkout activity, set the value to "Y".
For more details on site parameters, see "Setting ALM Configuration Parameters" on page 168.
ALM Robot Dashboard Actions
On the dashboard window, you can view the activities and their statuses, and perform the following
actions.
Abort to stop any
running activities
You can abort the task that is currently running or allow it to finish. All subsequent tasks on other
projects are not started.
Caution:
l
ALM Robot does not back up the repository, database, or Site Administration
schema. These steps must be performed manually before running ALM Robot.
Additionally, when the upgrade includes the usage of a new database, the
database schema must be restored manually.
l
If an activity is stopped during the upgrade action, the project may become
corrupted. If this occurs, the database administrator must roll back the project
using its backed up database schema and repository.
Customize the list
of activities
View activity
progress by
clicking the
Activity ID
number
HP ALM (12.50)
You can filter or sort the list, and delete any finished activities you no longer need.
l
l
A list of the tasks (projects) processed in the activity.
Project dependencies. Projects that have lab extensions are dependent on Lab_Project, and projects
that are linked to a template are dependent on the template project.
l
The status of each project.
l
The status of an action performed on each project is displayed in a tooltip. Hover over each point in
Page 202
Administrator Guide
Chapter 12: ALM Robot
the Progress Status to see the action performed.
l
Download logs for
each project
The duration of a task (project) within the activity.
Select the tasks (projects) you want to include in a log, and click Export Logs.
This option enables you to export log files from the ALM server to your client machine.
Note: Selecting a large number of projects and clicking Export Logs can cause a delay
in the download process.
HP ALM (12.50)
Page 203
Administrator Guide
Chapter 12: ALM Robot
HP ALM (12.50)
Page 204
Chapter 13: QC Sense
This chapter describes QC Sense, the internal monitoring tool for collecting and analyzing HP Application
Lifecycle Management (ALM) usage and performance data.
This chapter includes:
•
•
•
•
About QC Sense
206
QC Sense Configuration
206
Generating and Viewing QC Sense Reports
213
QC Sense Schema
214
HP ALM (12.50)
Page 205
Administrator Guide
Chapter 13: QC Sense
About QC Sense
As an ALM site administrator, you can utilize usage and performance data collected by QC Sense to
analyze ALM performance behaviors from the user perspective. For example, you can look at the time it
takes from the user's click of a button until the desired response is received.
QC Sense collects data on user actions performed in the ALM user interface, and monitors all client and
server activity resulting from those actions. You can examine a single user activity and its resulting
server and database activities, as well as compare average system response analyzed by user action,
server transaction, and many other parameters.
You can configure QC Sense to collect data based on a wide variety of actions and measures. This
enables you to examine performance as it relates to different aspects of ALM, such as projects, users,
types of actions, and workflow impact. You can examine and compare performance between
components of the system, including application servers, database servers, the network, and the file
system.
In addition to data on single user activity, you can configure QC Sense to collect information on the ALM
servers in your site. QC Sense can collect data on server and network activity such as server threads,
memory usage, active sessions, database access time, and file system access time.
QC Sense includes client and server monitors. Each monitor collects usage and performance data on a
specific area within ALM. As an ALM site administrator, you can configure each monitor to customize the
scope of data collected. All data collected by QC Sense is stored centrally in a site database so you can
easily connect between client activity and the resulting server activity. For more information, see "QC
Sense Configuration" below.
QC Sense reports enable you to examine and compare performance to help identify the source of a
problem. You can compare data between users who are experiencing different levels of performance,
or you can clarify actions or behaviors that may be causing a sudden slowing in system responsiveness.
For example, you can identify especially long operations, or examine which long operations occurred just
before the general slowness on your site. For more information, see "Generating and Viewing QC Sense
Reports" on page 213.
The data collected by the QC Sense monitors is stored in the database according to the QC Sense
schema. For more information, see "QC Sense Schema" on page 214.
Note: QC Sense is not accessible when ALM is configured with external authentication.
QC Sense Configuration
To configure QC Sense, access the QC Sense Server Configuration window from Site Administration.
The configuration options enable you to:
HP ALM (12.50)
Page 206
Administrator Guide
Chapter 13: QC Sense
l
set filters for each client and server monitor to define the scope of data that QC Sense collects
l
enable or disable a QC Sense monitor
l
define the location for storing QC Sense data
l
define the maximum number of records stored per monitor
l
set the frequency for transferring updated data to the database
l
define the frequency at which the QC Sense tables are purged
This section includes:
•
•
•
•
QC Sense Monitors
208
Configuring QC Sense
209
QC Sense Server Configuration Window
209
Connection String Builder Dialog Box
212
HP ALM (12.50)
Page 207
Administrator Guide
Chapter 13: QC Sense
QC Sense Monitors
The following table lists the QC Sense monitors and describes the data that each monitor collects by
default. For more information on the QC Sense database tables that store the collected data, see "QC
Sense Schema" on page 214.
Monitor
Name
Database Table Description
Contains raw data for user operations, such as
Client
Operation submitting a defect, updating a requirement, or
clicking the Login button.
For details, see "PERF_CLIENT_OPERATIONS" on
page 214.
Client
Method
Call
Contains raw data for ALM client methods
monitored by QC Sense.
Partial . Collects data on the following:
l
Login operations that exceed two minutes.
l
Create Entity operations that exceed two minutes.
l
Paste operations that exceed two minutes.
l
All operations that exceed five minutes.
Partial. Collects data on the following:
l
For details, see "PERF_CLIENT_METHODS_CALLS"
on page 215.
Client
Request
Default Configuration
Raw data for requests sent by a client operation to
the ALM server.
For details, see "PERF_CLIENT_REQUESTS" on
l
Calls to generate Analysis Items that exceed two
minutes.
Calls to workflow events that exceed two minutes.
Partial. Collects data on all requests that were sent to the
server in the context of a filtered client operation or a
filtered client method.
page 216.
Server
General
Aggregated data based on several server measures.
On
For details, see "PERF_SERVER_GENERAL_
MEASURES" on page 220.
Server
Thread
Type
Aggregated data on threads running on the server.
Server
Thread
Raw data for each thread run on the server.
On
For details, see "PERF_SERVER_THREAD_TYPES"
on page 220.
Off
For details, see "PERF_SERVER_THREADS" on
page 218.
Server
SQL
Raw data for each SQL statement run by the ALM
server.
Off
For details, see "PERF_SERVER_SQLS" on page
219.
HP ALM (12.50)
Page 208
Administrator Guide
Chapter 13: QC Sense
Configuring QC Sense
You can configure the global settings for QC Sense, such as specifying an alternate location for the QC
Sense schema. You can also configure settings for each monitor to define the scope of data collected,
and the maximum number of records stored for the monitor.
To configure QC Sense:
1. In Site Administration, select Tools > QC Sense > Configuration. The Login to <server> dialog box
opens.
2. Enter login credentials for a site administrator user and click OK. The QC Sense Server
Configuration window opens. For user interface details, see "QC Sense Server Configuration
Window" below.
QC Sense Server Configuration Window
This window enables you to configure QC Sense settings for an ALM server.
QC Sense configuration includes global settings, as well as settings you can configure for each monitor
individually.
To access
In Site Administration, select Tools > QC Sense > Configuration. In the Login to <server> box,
enter your site administrator password.
Important
information
For details on the default configuration settings, see "QC Sense Monitors" on the previous page.
See also
HP ALM (12.50)
l
"About QC Sense" on page 206
l
"Generating and Viewing QC Sense Reports" on page 213
Page 209
Administrator Guide
Chapter 13: QC Sense
Global Settings
Enables you to define general settings for QC Sense.
To access
In the monitor list located on the left side of the window, select Global Settings.
User interface elements are described below:
UI Element
Description
Specify a storage location
for QC Sense data
Includes the following options:
l
Store data in Site Administration schema.
l
Store data in another schema (recommended). Specify an alternate location and
connection information for storing QC Sense schema tables.
To define the Connection String, click the browse button (
). For details, see the "
Connection String Builder Dialog Box" on page 212. You can also enter all the
necessary data manually.
l
Native authentication. For an SQL server, use Windows Authentication and not SQL
Server authentication.
For details on the QC Sense schema, see "QC Sense Schema" on page 214.
Server Persist Job
Defines the time interval, in minutes, at which updated information from QC Sense server
monitors is written to the database.
Server Purge Job
Defines the time interval, in hours, at which QC Sense tables are cleaned.
Client Persist Job
Defines the time interval, in minutes, at which updated information from QC Sense client
monitors is sent to the server.
Restores default QC Sense configuration settings. Located in the bottom left of the
configuration window.
HP ALM (12.50)
Page 210
Administrator Guide
Chapter 13: QC Sense
Monitor Settings
Enables you to define settings for QC Sense monitors. For details on the monitors, see "QC Sense
Monitors" on page 208.
To access
In the monitor list located on the left side of the window, select a monitor to configure.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
<Monitor list>
Located on the left side of the window, displays the QC Sense client and server monitors. Select a
monitor to configure its options and filters.
indicates an active monitor.
indicates an inactive monitor. Data is not collected for this monitor.
To activate or deactivate a monitor, right-click the monitor and select Turn Monitor OFF/ON.
Enables you to set filter conditions to define the scope of data collected by the filter.
Select a filter from the menu to add and configure. There are different filters available for each QC
Sense monitor.
Delete Data Filter. Deletes the selected data filter. If there are no filters defined, QC Sense collects
all data for the selected monitor.
Note: An SQL server must have at least one filter.
Monitor Settings. Enables you to define settings for the selected monitor. Includes the following
settings:
l
Maximum number of records in monitor database table: Defines the maximum number of
records for the monitor that can remain in the database after the database is cleaned by the server
purge job.
l
Time frame length. Defines the time frame for which some measures are calculated. For
example, the average server CPU time used for processing a thread, measured over a 15 minute
period.
Available for the following monitors: Server General, Server Thread Type
l
Excluded Fields. Monitor data is not saved for the selected fields.
Available for the following monitors: Server SQL, Server Thread
Data Filters pane
Lists the filters for the selected monitor.
Data Filter Details
Displays details and enables you to set conditions for the selected data filter.
For more information on the available fields for each monitor, see "QC Sense Schema" on page 214.
Monitor Description
HP ALM (12.50)
Describes the selected monitor. Indicates the QC Sense schema table that stores data for the monitor.
Page 211
Administrator Guide
Chapter 13: QC Sense
Connection String Builder Dialog Box
This dialog box enables you to build custom connection strings. It also enables you to use connection
strings that are already defined in Site Administration.
To
access
From the Global Settings window, under Specify a storage location for QC Sense data, click Store data in
another schema, and then click
See
also
.
"QC Sense Server Configuration Window" on page 209
User interface elements are described below:
UI Element
Description
Connection string parameters
This option enables you to build the connection string by selecting a
database type and defining parameters.
l
Database Type. The database type can be MS SQL or Oracle.
l
Server Host. The server name.
l
Port. The port number of the database server. The default ports
are:
l
l
Oracle: 1521
l
MS SQL: 1433
SID. The service ID for an Oracle database server. The SID field can
be edited only for Oracle database type.
Connection string from registered database
server in Site Administration
HP ALM (12.50)
This option enables you to select connection strings from registered
database servers in Site Administration.
l
DB Server Name. The database server name.
l
Use DB Admin credentials. Use the database administrator
Page 212
Administrator Guide
Chapter 13: QC Sense
UI Element
Description
credentials of the selected database server.
Custom connection string
This option enables you to define complex and non-standard
connection strings directly here.
Generating and Viewing QC Sense Reports
Note: The QC Sense reports are for debugging purposes only, and are disabled by default. You
can generate QC Sense reports by configuring the ENABLE_PERFORMANCE_MONITOR_BIRT_
REPORTS parameter in the Site Configuration tab in Site Administration. For more information,
see "Setting ALM Configuration Parameters" on page 168. If you generate QC Sense reports, it is
recommended to disable the reports immediately after usage.
You can generate reports based on the data collected by QC Sense. For example, to examine the user
experience, you can generate reports on the following:
l
l
all operations performed by a specific user
transactions of a specific type for all users, such as creating a requirement or clicking the Login
button
l
transactions longer than a set amount of time
l
compare users who are experiencing different levels of performance
After you generate a report, you can print the report.
The following types of reports are available:
l
l
l
Client reports. Based on data collected by the QC Sense client monitors. Reports provide information
from the user experience perspective, representing user operations in the ALM user interface.
Server reports. Based on data collected by the QC Sense server monitors.
l
Represent server activities invoked by user operations.
l
Server reports on general server activity.
Database table reports. Enable you to access information in the QC Sense schema tables using
standard SQL syntax.
To generate and view reports:
1. In Site Administration, select Tools > QC Sense > Reports. The Login to <server> dialog box opens.
2. Enter login credentials for a site administrator user and click OK. The QC Sense Report page opens.
3. Click a report link. In the login window that opens, enter login credentials for a site administrator
user.
HP ALM (12.50)
Page 213
Administrator Guide
Chapter 13: QC Sense
Note: You can grant permissions to additional users who are not site administrators by
configuring the QC_SENSE_REPORTS_USERS parameter in the Site Configuration tab in
Site Administration. For more information, see "Setting ALM Configuration Parameters" on
page 168.
4. In the report viewer, enter parameters to define the scope of the report you want to generate.
QC Sense Schema
QC Sense has a single database schema per ALM site. The schema is created during the ALM installation,
and stored by default in the Site Administration schema. However, the QC Sense schema is independent
of the ALM Site Administration schema, and the tables can be stored in any database schema. For
enterprise sites, we recommend storing the schema on another database server. For details on defining
an alternate location for the QC Sense schema, see "QC Sense Configuration" on page 206.
The QC Sense schema consists of the following tables:
Table Name
Data Source
Data Type
"PERF_CLIENT_OPERATIONS" below
Client
Raw
"PERF_CLIENT_METHODS_CALLS" on the next page
Client
Raw
"PERF_CLIENT_REQUESTS" on page 216
Client
Raw
"PERF_SERVER_THREADS" on page 218
Server
Raw
"PERF_SERVER_SQLS" on page 219
Server
Raw
"PERF_SERVER_GENERAL_MEASURES" on page 220
Server
Aggregated
"PERF_SERVER_THREAD_TYPES" on page 220
Server
Aggregated
PERF_CLIENT_OPERATIONS
This table stores the data collected by the Client Operation monitor.
The table contains one record for each client operation. A client operation is an action performed by
the user in the ALM user interface. For example:
l
clicking the Authenticate button in the Login window
l
selecting the Attachments tab in the Defects module
l
expanding a folder in the test plan tree
A client operation type is described by type, data, and context. The column prefix for the table is PCO.
For example, PCO_OPERATION_ID.
HP ALM (12.50)
Page 214
Administrator Guide
Chapter 13: QC Sense
COLUMN NAME
DESCRIPTION
OPERATION_ID
A unique GUID assigned to the operation.
CLIENT_MACHINE_
NAME
The client host name in which the operation was performed.
LOGIN_SESSION_
ID
The login session ID.
PROJECT_
SESSION_ID
The project session ID.
PROJECT
The domain and project name, in the format <domain name>/<project name> .
USER_NAME
The user name.
OPERATION_TYPE
The type of the operation. For example:
OPERATION_DATA
OPERATION_
CONTEXT
l
Button Clicked
l
Tab Selected
l
Tree Node Expanded
The operation's data. For example:
l
The clicked button label, such as Login
l
The selected tab label, such as Attachments
The path to the window in which the operation was performed. For example:
l
l
CLIENT_START_
TIME
Module: Business Components .Net; View : EntityTypeViewControl; View :
ComponentStepsViewControl; View : DesignStepsViewControl
Form : Component Step Details
The start time of the operation as a date time data type.
CLIENT_END_TIME The end time of the operation as a date time data type.
CLIENT_START_
TIME_MS
The start time of the operation as the number of milliseconds since 01/01/1970.
CLIENT_TOTAL_
TIME
The total milliseconds that passed from the start of the operation until the end of the operation.
PERF_CLIENT_METHODS_CALLS
This table stores the data collected by the Client Method Call monitor.
The table contains one record for each method call monitored by QC Sense. The methods that are
monitored are predefined by QC Sense. Each method call is linked to the following related records:
l
Owner Operation. The active operation when this method call was ran.
l
Owner Method Call. The active monitored method when this method call ran. It can be null.
HP ALM (12.50)
Page 215
Administrator Guide
Chapter 13: QC Sense
l
Called Methods. Another monitored method called from this method call, directly or indirectly.
l
Requests. Requests sent to the server from this method call, directly or indirectly.
The column prefix for the table is PCMC. For example, PCMC_METHOD_CALL_ID.
COLUMN NAME
DESCRIPTION
METHOD_CALL_ID
A unique GUID assigned to the method call.
LOGIN_SESSION_ID
The login session ID.
PROJECT_SESSION_ID
The project session ID.
PROJECT
The domain and project name, in the format <domain name>/<project name> .
USER_NAME
The user name.
SEQUENCE
The sequence of the method call in the context of its owner operation.
OWNER_OPERATION_ID
The active client operation ID when the method call started.
OWNER_OPERATION_TYPE
The type of the owner operation.
OWNER_OPERATION_DATA
The data of the owner operation.
OWNER_OPERATION_
CONTEXT
The context of the owner operation.
OWNER_METHOD_CALL_ID
The active method call ID when the method call started (can be null).
METHOD_NAME
The method name, for example, Login.
CLASS_NAME
The class name, for example, ConnectionManagementService.
MODULE_NAME
The module/assembly name, for example, QCClient.Library.dll .
ADDITIONAL_DATA
Additional data added by the method call.
CLIENT_START_TIME
The start time of the method call as a date time data type.
CLIENT_END_TIME
The end time of the method call as a date time data type.
CLIENT_START_TIME_MS
The start time of the operation as the number of milliseconds since 01/01/1970.
CLIENT_TOTAL_TIME
The total milliseconds that passed from the start of the operation until the end of the
operation.
PERF_CLIENT_REQUESTS
This table stores the data collected by the Client Request monitor.
The table contains one record for each request sent from the client to the server. Each request is linked
to the following related records:
l
l
Owner Operation. The active operation when the request was sent to the server.
Owner Method Call. The active monitored method when the request was sent to the server. It can be
null.
HP ALM (12.50)
Page 216
Administrator Guide
Chapter 13: QC Sense
The request record contains the following:
l
client performance data, such as the time the client sent the request to the server
l
server performance data, such as the time the request arrived at the server
The column prefix for the table is PCR. For example, PCR_REQUEST_ID.
COLUMN NAME
DESCRIPTION
REQUEST_ID
The request unique GUID.
Note: This is also the GUID of the thread that handled the request in the server.
SEQUENCE
The sequence of the request in the context of its owner operation.
OWNER_OPERATION_
ID
The active client operation ID when the request was sent to the server.
OWNER_METHOD_
CALL_ID
The active monitored method when the request was sent to the server.
LOGIN_SESSION_ID
The login session ID.
PROJECT_SESSION_ID
The project session ID.
PROJECT
The domain and project name, in the format <domain name>/<project name> .
USER_NAME
The user name.
REQUEST_TYPE
The request type, for example, PostBug.
CLIENT_START_TIME
The time the request was sent to the server as a date time data type.
CLIENT_END_TIME
The time the response returned from the server as a date time data type.
CLIENT_START_TIME_ The time the request was sent to the server as the number of milliseconds since 01/01/1970.
MS
CLIENT_TOTAL_TIME
The total milliseconds that passed from the time the request was sent to the server until the
response was received.
SERVER_MACHINE_
NAME
The ALM server in which the request was processed.
SERVER_START_TIME
The time the server started processing the request as a date time data type.
SERVER_START_
TIME_MS
The time the server started processing the request as the number of milliseconds since
SERVER_TOTAL_TIME
The total time, in milliseconds, it took for the server to process the request.
SERVER_CPU_TIME
The total CPU time, in milliseconds, allocated for processing the request.
DB_TIME_AVG
The average time the database processed an SQL statement for this thread.
DB_TIME_MAX
The maximum time the database processed an SQL statement for this thread.
DB_TIME_MIN
The minimum time the database processed an SQL statement for this thread.
HP ALM (12.50)
01/01/1970.
Page 217
Administrator Guide
Chapter 13: QC Sense
COLUMN NAME
DESCRIPTION
DB_TIME_COUNT
The number of SQL statements processed by the database for this thread.
FS_TIME_AVG
The average access time to the file system for this request.
FS_TIME_MIN
The minimum access time to the file system for this request.
FS_TIME_MAX
The maximum access time to the file system for this request.
FS_TIME_COUNT
The number of file system accesses (read/write or delete file) for this request.
PERF_SERVER_THREADS
This table stores the data collected by the Server Thread monitor.
The table contains one record for each thread run on the server. There are four thread categories:
l
REQUEST. Thread processing web-gate requests.
l
JOB. Threads running ALM jobs.
l
ASYNC_TASK. Threads running ALM asynchronous tasks.
l
NONE. All other threads, such as threads running the repository migration process.
The column prefix for the table is PCT. For example, PCT_THREAD_ID.
COLUMN NAME
DESCRIPTION
THREAD_ID
The thread unique GUID.
SERVER_MACHINE_NAME
The ALM server in which the thread was processed.
THREADY_CATEGORY
The thread category. Available categories: REQUEST, JOB, ASYNC_TASK, NONE.
THREAD_TYPE
The thread type. For example, request type – PostBug, Job Name – CKeepAliveJob, etc.
SERVER_START_TIME
The time the thread started to run as a date time data type.
SERVER_START_TIME_MS
The time the thread started to run as the number of milliseconds since 01/01/1970.
LOGIN_SESSION_ID
The login session ID.
PROJECT_SESSION_ID
The project session ID.
PROJECT
The domain and project name, in the format <domain name>/<project name> .
USER_NAME
The user name.
SERVER_TOTAL_TIME
The total time, in milliseconds, it took for the server to process the thread.
SERVER_CPU_TIME
The total CPU time, in milliseconds, allocated for processing the thread.
DB_TIME_AVG
The average time the database processed an SQL statement for this thread.
DB_TIME_MAX
The maximum time the database processed an SQL statement for this thread.
DB_TIME_MIN
The minimum time the database processed an SQL statement for this thread.
HP ALM (12.50)
Page 218
Administrator Guide
Chapter 13: QC Sense
COLUMN NAME
DESCRIPTION
DB_TIME_COUNT
The number of SQL statements processed by the database for this thread.
FS_TIME_AVG
The average access time to the file system for this thread.
FS_TIME_MIN
The minimum access time to the file system for this thread.
FS_TIME_MAX
The maximum access time to the file system for this thread.
FS_TIME_COUNT
The number of file system accesses (read/write or delete file) for this thread.
PERF_SERVER_SQLS
This table stores the data collected by the Server SQL monitor.
You can examine the data in this table as it relates to the user actions that are performed (stored in the
PERF_CLIENT_OPERATIONS table) and the resulting requests that are generated (stored in the PERF_
CLIENT_REQUESTS table).
The table contains one record for each SQL statement run on the server. The column prefix for the table
is PSS. For example, PSS_SQL_ID.
COLUMN NAME
DESCRIPTION
SQL_ID
The SQL unique GUID.
SERVER_MACHINE_NAME
The ALM server that ran this SQL statement.
THREAD_ID
The ID of the thread in the context of which the SQL statement was run.
THREAD_CATEGORY
The thread category.
THREAD_TYPE
The thread type.
PROJECT
The domain and project name, in the format <domain name>/<project name> .
USER_NAME
The user name.
SQL_TYPE
The type of SQL statement, for example: `executeQuery' and `executeUpdate'.
RECORD_COUNT
Number of records added, deleted or etched by this SQL statement.
START_TIME
The SQL statement start time as a date time data type.
START_TIME_MS
The SQL statement start time as the number of milliseconds since 01/01/1970.
TOTAL_TIME
The total time, in milliseconds, that it took for the server to execute the SQL statement.
SQL_STRING
The actual SQL string.
HP ALM (12.50)
Page 219
Administrator Guide
Chapter 13: QC Sense
PERF_SERVER_GENERAL_MEASURES
This table stores the data collected by the Server General monitor.
The table stores aggregated data about ALM server behavior. Each record describes a single measure
on a single ALM node in a specific time frame. The column prefix for the table is PSGM. For example,
PSGM_SERVER_MACHINE_NAME.
COLUMN NAME
DESCRIPTION
SERVER_MACHINE_NAME
The ALM server from which the data was collected.
START_TIME
The start time of the record's time frame.
END_TIME
The end time of the record's time frame.
MEASURE_NAME
The measure name.
Available values:
l
MEMORY_USAGE
l
ACTIVE_THREADS
l
ACTIVE_PROJECT_SESSION
l
THREAD_TOTAL_TIME
l
THREAD_CPU_TIME
l
FREC_REQUEST_CALL_TOTAL_TIME
l
DB_TIME
l
FS_TIME
AVG
The average value measured during the time frame.
MIN
The minimum value measured during the time frame.
MAX
The maximum value measured during the time frame.
COUNT
The number of times the measure was calculated during the time frame.
PERF_SERVER_THREAD_TYPES
This table stores the data collected by the Server Thread Type monitor.
The table stores aggregated data about server threads. Each record describes a single thread type
behavior on a single ALM node in a specific time frame in a specific ALM project. The column prefix for
the table is PSTT, for example, PSTT_SERVER_MACHINE_NAME.
COLUMN NAME
DESCRIPTION
SERVER_MACHINE_NAME
The ALM server from which the data was collected.
START_TIME
The start time of the record's time frame.
HP ALM (12.50)
Page 220
Administrator Guide
Chapter 13: QC Sense
COLUMN NAME
DESCRIPTION
END_TIME
The end time of the record's time frame.
THREAD_CATEGORY
The thread category. Available categories: REQUEST, JOB, ASYNC_TASK, NONE.
THREAD_TYPE
The thread type. For example, request type – PostBug, Job Name – CKeepAliveJob, etc.
PROJECT
The domain and project name, in the format <domain name>\<project name> .
SERVER_TOTAL_TIME_AVG
The average time, in milliseconds, it took for the server to process a thread.
SERVER_TOTAL_TIME_MIN
The minimum time, in milliseconds, it took for the server to process a thread.
SERVER_TOTAL_TIME_MAX
The maximum time, in milliseconds, it took for the server to process a thread.
SERVER_TOTAL_TIME_COUNT
The number of threads that run in the server.
SERVER_CPU_TIME_AVG
The average CPU time, in milliseconds, allocated for processing a thread.
SERVER_CPU_TIME_MIN
The minimum CPU time, in milliseconds, allocated for processing a thread.
SERVER_CPU_TIME_MAX
The maximum CPU time, in milliseconds, allocated for processing a thread.
SERVER_CPU_TIME_COUNT
The number of threads that run in the server.
DB_TIME_AVG
The average time for processing an SQL statement.
DB_TIME_MIN
The minimum time for processing an SQL statement.
DB_TIME_MAX
The maximum time for processing an SQL statement.
DB_TIME_COUNT
The number of SQL statements processed by the database.
FS_TIME_AVG
The average access time to the file system.
FS_TIME_MIN
The minimum access time to the file system.
FS_TIME_MAX
The maximum access time to the file system.
FS_TIME_COUNT
The number of file system accesses (read/write or delete file).
HP ALM (12.50)
Page 221
Administrator Guide
Chapter 13: QC Sense
HP ALM (12.50)
Page 222
Chapter 14: Installing HP ALM Tools and Add-ins
HP Application Lifecycle Management (ALM) offers integration and synchronization solutions with HP
and third-party tools. To integrate ALM with other tools, you may need to install an add-in from the HP
Application Lifecycle Management ALM Tools page or the HP Application Lifecycle Management Add-ins
page.
Note: If you are integrating ALMwith another tool, you can verify that you are using a supported
version of the tool. Click Help > What’s New, and choose the appropriate integrations matrix.
The following ALM tools are available:
l
l
l
l
l
HP ALM Connectivity. Enables you to integrate ALM with other tools.
HP ALM Lab Service. Enables you to trigger functional tests and maintenance tasks on a testing host
using HP ALM. Install and configure the HP ALM Lab Service agent on functional testing tools (such as
VAPI and QuickTest Professional) that need to connect to Lab Management.
HP ALM Client Registration. Registers ALM components on the client machine, enabling you to work
with HP testing tools as well as third-party and custom tools.
Shared Deployment for Virtual Environments. Deploys ALM components on a shared location that
can be accessed by all users. This is useful if users connect to ALM over a virtual environment, such
as Citrix or VMware.
Webgate Customization. Enables you to customize WebGate client components.
To install an ALM tool:
1. Choose Help > ALM Tools in the ALM main window. The HP Application Lifecycle Management Tools
page opens.
HP ALM (12.50)
Page 223
Administrator Guide
Chapter 14: Installing HP ALM Tools and Add-ins
2. Click a tool link. A page with additional information about the tool opens. If you click the More HP
ALM Add-ins link, the HP Application Lifecycle Management Resources Add-ins page opens,
enabling you to select additional add-ins.
3. Click the tool link for instructions on using the tool.
Tip: You can also click an extension’s link to view the extension’s documentation.
4. Follow the instructions on your screen to download and install the tool.
To install an ALM add-in:
Choose Help > ALM Add-ins in the ALM main window. The HP Application Lifecycle Management
Resources Add-ins page opens, enabling you to select additional add-ins.
HP ALM (12.50)
Page 224
Part 2: Project Customization
HP ALM (12.50)
Page 225
HP ALM (12.50)
Page 226
Chapter 15: Project Customization at a Glance
As an HP Application Lifecycle Management (ALM) project administrator, you use Project Customization
to control access to a project by defining the users who can access the project and by determining the
types of tasks each user can perform. You can also customize a project to meet the specific
requirements of your organization.
Cross Project Customization: As an ALM template administrator, you can customize a template project
and apply the customization to one or more ALM projects using cross project customization. This
enables you to standardize policies and procedures across projects in your organization. For more
information, see "Cross Project Customization" on page 289.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
This chapter includes:
•
•
•
Starting Project Customization
228
Understanding the Project Customization Window
230
Saving Customization Changes
232
HP ALM (12.50)
Page 227
Administrator Guide
Chapter 15: Project Customization at a Glance
Starting Project Customization
You can customize your ALM projects using the Project Customization window.
Note: Users belonging to the Viewers group cannot view or change any settings in the Project
Customization window, except settings on the User Properties page.
To start project customization:
1. Open your Web browser and type your ALM URL
http://<ALM server name>[<:port number>]/qcbin. The HP Application Lifecycle
Management Options window opens.
2. Click the ALM Desktop Client link.
The first time you run ALM, files are downloaded to your client machine. Subsequently, ALM carries
out a version check. If there is a newer version on the server, updated files are downloaded to your
client machine.
Note:
l
Windows 7/2008R2/2012: If you do not have administrator privileges on your machine,
and a Security Warning displays, click Don't Install. You will be redirected to the Install
screen.
l
If file downloads are prohibited through your browser, you can install these files by
using the HP ALM Client MSI Generator add-in, available from the HP Application
Lifecycle Management Add-ins page (Help > Add-ins).
HP ALM (12.50)
Page 228
Administrator Guide
Chapter 15: Project Customization at a Glance
l
If you run ALM over a virtual environment, such as Citrix or VMware, only the system
administrator can install a new version.
After the ALM version has been checked and files have been updated if necessary, the ALM Login
window opens.
Note: If ALM was configured for external authentication, the Name and Password fields do
not appear in this window. Continue with step 7.
3. In the Login Name box, type your user name.
If you type a user name that does not have administrator privileges for a particular project, you are
restricted to the customization functions available for that user group. For more information, see
"About Managing User Groups and Permissions" on page 240.
4. In the Password box, type your password. If you cannot remember your password, click the Forgot
Password link. For more information, refer to the HP Application Lifecycle Management User Guide.
After you log in to ALM, you can change your password from the Project Customization window. For
more information, refer to the HP Application Lifecycle Management User Guide. In addition, site
administrators can change a user's password from Site Administration. For more information, see
"Creating and Changing Passwords" on page 139.
5. Select the Automatically log in to my last domain and project on this machine check box if you
want ALM to automatically log in to the last project in which you were working.
6. Click Authenticate. ALM verifies your user name and password and determines which domains and
projects you may access. If you specified automatic login, ALM opens.
7. In the Domain list, select a domain. By default, the last domain in which you were working is
displayed.
8. In the Project list, select a project. By default, the last project in which you were working is
HP ALM (12.50)
Page 229
Administrator Guide
Chapter 15: Project Customization at a Glance
displayed.
9. Click Login. ALM opens and displays the module in which you last worked during your previous
session.
10. On the masthead, click
, then select Customize. For more information, see "Understanding the
Project Customization Window" below.
11. To exit the Project Customization window and return to your ALM project, click the Return button
located on the upper-right corner of the window.
If you have made changes to Project Customization, the Customization Changes dialog box opens.
For more information, see "Saving Customization Changes" on page 232.
Understanding the Project Customization Window
As an ALM project administrator, you can customize a project to meet the specific requirements of your
organization in the Project Customization window.
For important considerations when making changes to project customization, see "Saving
Customization Changes" on page 232.
The Project Customization window contains the following links:
Note: If you are working in a template project, some links are displayed with (Shared) after the
name. This indicates that the customization on that page is applied to linked projects. For more
information, see "Cross Project Customization" on page 289.
Link
Description
User
Properties
All users can use this option to change their user properties and password. For more information, refer to the
HP Application Lifecycle Management User Guide .
In Site Administration, a site administrator can override and change a user's properties and password from
the Site Users tab. For more information, see "Updating User Details" on page 137, and "Creating and
HP ALM (12.50)
Page 230
Administrator Guide
Chapter 15: Project Customization at a Glance
Link
Description
Changing Passwords" on page 139. A project administrator cannot change a user's properties from Project
Customization, unless the ALLOW_UPDATE_USER_PROPERTIES_FROM_CUSTOMIZATION parameter is
set to Y .
Project Users
You can add and remove users from an ALM project. You can also assign users to user groups to restrict user
access privileges. For more information, see "Managing Users in a Project" on page 235.
Note: You create ALM users and define user properties from Site Administration. For more
information, see "Managing ALM Users" on page 127.
Groups and
Permissions
You can assign privileges to user groups by specifying permission settings. This includes specifying transition
rules and hiding data. For more information, see "Managing User Groups and Permissions" on page 239.
Module
Access
You can control the modules that each user group can access. By preventing users from accessing
unnecessary modules, you can better utilize your ALM licenses. For more information, see "Customizing
Module Access for User Groups" on page 251.
Project
Entities
You can customize your ALM project to suit your environment. A project can contain system fields and userdefined fields. System fields can be modified. User-defined fields can be added, modified, and deleted. For
more information, see "Customizing Project Entities" on page 254.
Requirement
Types
You can add requirement types to your ALM project and define which fields are available and which fields are
required for each requirement type. For more information, see "Customizing Project Requirement Types"
on page 261.
Risk-Based
Quality
Management
You can customize criteria and criterion values for risk-based testing, and customize default testing efforts
Project Lists
You can add customized field lists to a project. A field list contains values that the user can enter in system
fields or user-defined fields. For more information, see "Customizing Project Lists" on page 266.
Automail
You can set up automatic mail notification rules to inform users via email about defect repair activity. For
more information, see "Configuring Automail" on page 271.
Alert Rules
You can activate alert rules for your project. This instructs ALM to create alerts and send email when changes
occur in the project. For more information, see "Activating Alert Rules" on page 285.
Workflow
You can generate scripts to perform commonly needed customizations on the fields of the Defects module
and testing levels. For more information, see "Customizing Risk-Based Quality Management" on page
275
dialog boxes. For more information, see "Generating Workflow Scripts" on page 355.
In addition, you can write scripts to customize dialog boxes in any module, and to control the actions that
users can perform. For more information, see "Workflow Customization at a Glance" on page 367.
Project
Planning and
Tracking
You can create and customize the project planning and tracking (PPT) KPIs. For more information, see
"Customizing Project Planning and Tracking KPIs" on page 301.
ALM Editions: The Project Planning and Tracking link in Project Customization is available
for ALM Edition. For more information about ALM editions and their functionality, see the
HP Application Lifecycle Management User Guide.
HP ALM (12.50)
Page 231
Administrator Guide
Chapter 15: Project Customization at a Glance
Link
Description
Project
Report
Templates
You can create and customize report templates that project users can assign to template based reports. For
more information, see "Project Report Templates" on page 309.
Business
Process
Testing
You can configure Business Process Testing and BPT Packaged Apps Kit. For more information, see
"Configuring Business Process Testing" on page 347.
Business
Views
You can create business views which can be used as a basis for creating reports in the Analysis View module.
For more information, see Business Views.
Sprinter
You can configure settings for working with HP Sprinter for manual testing in ALM. For more information, see
"Configuring Sprinter" on page 351.
ALM Editions: The Sprinter link in Project Customization is not available for Performance
Center Edition. For more information about ALM editions and their functionality, see the
HP Application Lifecycle Management User Guide.
IDE Connector You can perform the necessary customizations to work with Application Lifecycle Intelligence.
Customizer
Note: This link is available only if you enable the ALM Dev Extension. For more details on
enabling extensions, see "Enabling Extensions for a Project" on page 74. To download
documentation for IDE Connector Customizer, visit the HP ALM Add-ins page, available
from Help > Add-ins.
Saving Customization Changes
As a project administrator, you can save a customization change as a major change or a minor change.
The option you select determines if customization is reloaded when a user reconnects after a session
expires.
l
Major change (default). When a user session expires and the user reconnects, customization reloads.
We recommend that you use this option only for critical changes that must be made available to
users as soon as possible. Limiting major changes enables users to quickly reconnect without
reloading customization. For example, you might use this option when adding a required user-defined
field.
l
Minor change. When a user session expires and the user reconnects, customization does not reload.
If at least one major customization change has been made since the last login, customization is
reloaded when a user reconnects, for details, see the DISPLAY_LAST_USER_INFO site parameter.
This includes all major and minor customization changes that have been made between the last time
the user logged in and the current login time.
To select a save option for a customization change:
HP ALM (12.50)
Page 232
Administrator Guide
Chapter 15: Project Customization at a Glance
1. After making changes to Project Customization, click the Return button to exit the Project
Customization window. The Customization Changes dialog box opens.
2. Select a save option and click OK to exit Project Customization and return to your ALM project.
HP ALM (12.50)
Page 233
Administrator Guide
Chapter 15: Project Customization at a Glance
HP ALM (12.50)
Page 234
Chapter 16: Managing Users in a Project
As an HP Application Lifecycle Management (ALM) project administrator, you can control access to a
project by defining the users who can log in to the project and by specifying the types of tasks each user
may perform.
This chapter includes:
•
•
•
•
About Managing Users in a Project
236
Adding a User to a Project
236
Assigning Users to a User Group
237
Removing a User from a Project
238
HP ALM (12.50)
Page 235
Administrator Guide
Chapter 16: Managing Users in a Project
About Managing Users in a Project
For each ALM project, you must select a list of valid users from the overall ALM users list.
Note: The users list is created in Site Administration. For more information, see "Managing ALM
Users" on page 127.
You then need to assign each project user to a user group. Each group has permissions to perform
certain ALM tasks.
Adding a User to a Project
You add new users to an ALM project.
To add a user to a project:
1. In the Project Customization window, in the left pane, click Project Users. The Project Users page
opens.
Tip: You can click the Name column to change the sort order from ascending to
descending user names. You can also click the Full Name column to sort according to full
names instead of user names.
2. Click the arrow to the right of the Add User button. Add users to the project using one of the
following options:
l
l
To add an existing user by typing a user name, select Add User By Name. The Add User dialog
box opens. Type the user name of a user that is defined in Site Administration for this project.
Click OK.
To create a new user in the Site Users list and add the user to the project, select Add New User
HP ALM (12.50)
Page 236
Administrator Guide
Chapter 16: Managing Users in a Project
to Site. In the Add New User to Site dialog box, type the details for the new user and click OK.
Note: For smart card authentication, enter the email from the smart card in E-mail and
the common name (CN) from the smart card in Description. For single sign-on (SSO)
authentication, enter the email and the user name in Description.
If this option is not available, you can enable it by setting the ADD_NEW_USERS_FROM_PROJECT
parameter in Site Administration. For more information, see "Setting ALM Configuration
Parameters" on page 168.
l
To add existing users from the Site Users list, select Add Users from Site. In the Add Users from
Site dialog box, select the users you want to add to the project.
You can refresh the list of users with the Refresh button, and you can search for existing users
by name with the Find button. Click OK.
The users are added to the Project Users list and the user details are displayed in the Details tab.
User details are defined in Site Administration. For more information, see "Updating User Details"
on page 137.
3. Click Save to save your changes to the Project Users page.
Assigning Users to a User Group
After you add a user to the project, you can assign the user to one or more user groups. By default, new
users are assigned to the project as members of the Viewer user group.
You can assign a user to a default user group, or to a customized user group. For more information on
customizing a user group, see "Managing User Groups and Permissions" on page 239. You can change
the access privileges for existing users at any time by changing the user group to which they are
assigned.
Tip: You can also assign users to user groups from the Groups and Permissions page. For more
information, see "Assigning Users to Groups" on page 241.
To assign a user to a user group:
1. In the Project Customization window, in the left pane, click Project Users. The Project Users page
opens.
2. In the Project Users list, select the user you want to assign to a user group. The user properties are
displayed (name, email, phone, and description) in the Details tab. The email information is
important as it enables a user to receive defects, tests, requirements, and test set notifications
directly to their mailbox.
The user details are defined in Site Administration. For more information, see "Updating User
Details" on page 137.
HP ALM (12.50)
Page 237
Administrator Guide
Chapter 16: Managing Users in a Project
3. Select the Membership tab.
4. To assign the selected user to a user group, click a user group name in the Not Member of list and
click the right arrow button
.
5. To remove the user from the currently selected user group, click a user group name in the Member
of list and click the left arrow button
.
Note: The Member of list can never be empty. A user must always belong to at least one
user group.
6. To move all the user groups from one list to the other, click the double arrow buttons
.
7. Click Save to save your changes to the Project Users page.
Removing a User from a Project
To ensure the security of a project, remove any users who are no longer working on the project.
Removing a user from a project does not delete the user from the ALM users list in Site Administration.
To remove a user from a project:
1. In the Project Customization window, in the left pane, click Project Users. The Project Users page
opens.
2. In the Project Users list, select the user you want to remove and click the Remove User button.
3. Click OK to confirm. The user is removed from the Project Users list.
4. Click Save to save your changes to the Project Users page.
HP ALM (12.50)
Page 238
Chapter 17: Managing User Groups and
Permissions
You can control access to HP Application Lifecycle Management (ALM) projects and modules by defining
the user groups that can enter them, and by determining the types of tasks each user group performs
according to permission levels.
This chapter includes:
•
•
•
•
•
•
•
•
•
•
About Managing User Groups and Permissions
240
Adding User Groups
241
Assigning Users to Groups
241
Setting User Group Permissions
242
Setting Transition Rules
245
Hiding Data for a User Group
248
Renaming User Groups
249
Deleting User Groups
250
Understanding Permission Settings
250
Customizing Module Access for User Groups
251
HP ALM (12.50)
Page 239
Administrator Guide
Chapter 17: Managing User Groups and Permissions
About Managing User Groups and Permissions
To protect a project from unauthorized access, ALM enables you to assign each user to one or more
groups. ALM includes predefined groups with default privileges. Each group has access to certain ALM
tasks. The default user groups include: TDAdmin, QATester, Project Manager, Developer, and Viewer.
Performance Center:
l
The following additional default user groups are available: Performance Advisor,
Performance Tester, Performance Test Specialist.
When a project requires that certain user groups have privileges that are outside the scope of their
default permissions, you can add your own customized user groups and assign each group a unique set
of privileges.
After you set user group permissions, you can also define the ALM modules to which you want to give a
user group access. When a user group member logs in to a project, only the authorized modules are
displayed.
Groups and Permissions when Using Cross Project Customization
ALM template administrators use cross project customization to apply customization from a template
project to one or more ALM projects. For information, see "Cross Project Customization" on page 289.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
If you are working with cross project customization, consider the following when setting permissions for
groups:
l
l
Working with a Template Project: If you are working with a template project, in Project
Customization, you use the Groups (Shared) link to manage user groups and permissions. User
groups created in a template project are created in the linked projects when you apply the template
customization. The users assigned to the user group in the template project are not applied to linked
projects. For more information on applying template customization, see "Applying Template
Customization to Linked Projects" on page 295.
Working with a Linked Project: User groups defined by a template project are displayed with a
template icon
in the linked project. You can assign users to user groups defined by the template
project. You cannot modify, rename, or delete a user group defined by the template project. You can,
however, limit the records that the user group can view. For more information, see "Hiding Data for a
User Group" on page 248.
HP ALM (12.50)
Page 240
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Adding User Groups
If you determine that the default user groups do not meet the needs of your project, you can create
additional user groups for your project. When you add a new user group, you set the group's
permissions according to an existing user group.
To add a user group:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. Click the New Group button. A confirm message box opens. Click Yes to continue. The New Group
dialog box opens.
3. In the New Group Name box, type a name for the group. A group name cannot include the following
characters: ( ) @ \ / : * ? " ` < > | + = ; , %
4. In the Set As list, assign the privileges of an existing user group to the new group.
Choose an existing user group that has similar access privileges to the new user group you want to
create. This minimizes the level of customization you need to do.
5. Click OK. The new group name is added to the group list in the Groups and Permissions page.
6. Click Save to save your changes to the Groups and Permissions page.
Assigning Users to Groups
After you add a user to the project, you can assign the user to one or more user groups. By default, new
users are assigned to the project as members of the Viewer user group.
You can assign a user to a default user group, or to a customized user group. You can change the access
privileges for existing users at any time by changing the user group to which they are assigned.
HP ALM (12.50)
Page 241
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Tip: You can also assign users to user groups from the Project Users customization module. For
more information, see "Managing Users in a Project" on page 235.
To assign a user to a user group:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. In the group list, select the group to which you want to assign a user.
3. Select the Membership tab to see which users belong to the group.
The users assigned to the group are displayed in the In Group pane of the Membership tab. Users
not assigned to the group are displayed in the Not in Group pane of the Membership tab.
4. To assign a user to the currently selected user group, select a user in the Not in Group list and
click the right arrow button
.
5. To remove a user from the currently selected user group, select a user in the In Group list and click
the left arrow button
.
6. To move all the user groups from one list to the other, click the double arrow buttons
.
7. Click Save to save your changes to the Groups and Permissions page.
Setting User Group Permissions
Every user group has a set of privileges, or permissions, which are defined by the ALM project
administrator.
HP ALM (12.50)
Page 242
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Example
Suppose a group of users called DOC has Viewer permissions. To work more effectively on the
project, they need to add, modify, and delete defects. As the ALM project administrator, you can
assign these privileges to the DOC group by specifying permission settings.
Note:
l
You cannot modify the privileges of a default user group. To view permissions for these
groups, in the Groups and Permissions page, select the user group in the group list and click
the Permissions tab. For more information, see "Understanding Permission Settings" on
page 250.
l
If you upgrade a project, and the upgraded version contains a permission that was not
present in the original version, ALM automatically assigns that permission to all users in the
project.
Cross Project Customization - Working with a Linked Project:
User groups defined by a template project are displayed with a template icon
in the linked project. If
you are working with a project that is linked to a template project, you cannot modify the permissions
of a user group defined by the template project. You can, however, limit the records that the user group
can view. For more information, see "Hiding Data for a User Group" on page 248.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To set user group permissions:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. In the group list, select the user group for which you want to set permissions, and click the
Permissions tab.
A set of tabs are displayed in alphabetical order, one tab for each ALM module plus tabs for specific
purposes, such as for administration. Permission levels (such as Create, Update, and Delete) for
the entities available in each module are listed under the Permission Level column.
HP ALM (12.50)
Page 243
Administrator Guide
Chapter 17: Managing User Groups and Permissions
3. Click a module tab. If necessary, to see the permission levels for each entity, expand the entity.
l
If the permissions of an entity is dependent on, or impacts, the permissions of another entity,
an
icon is displayed to the right of the By Owner Only column, and the Impacts pane at the
bottom of the window displays information about the impact.
l
l
If additional options are available for a permission level, they are displayed in the Options pane
at the right of the window.
If an entity's permission levels can only be modified by its owner, a check box appears in the By
Owner Only column. For more information, see "Owning ALM Objects" on page 247.
4. Select the checkbox for the permission levels that the selected user group should have for each
entity. For more information on the available permissions, see "Understanding Permission
Settings" on page 250.
5. If a permission level has sublevels, expand the permission level to display the list of associated
fields. Then select the fields that the selected user group can use.
6. Limit the capabilities of modifying a field as follows:
l
l
To limit the entities whose permission levels can only be modified by their owners, select the
checkbox for the permission level in the By Owner Only column. For example, ensure that only
the person who owns the record can delete the value by selecting the checkbox in the By Owner
Only column, next to Delete in the Permission Level column. For more information, see "Owning
ALM Objects" on page 247.
To limit the values a user group can select from a lookup list type field, set transition rules of
permissible field values in the Options pane. For more information, see "Setting Transition
Rules" on the next page.
7. Click the Data-hiding tab to hide data from the current user group by module. For more
information, see "Hiding Data for a User Group" on page 248.
8. Click Save to save your changes to the Groups and Permissions page.
HP ALM (12.50)
Page 244
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Setting Transition Rules
You can limit a group's modifying privileges by setting transition rules for modifying values in fields.
These rules determine the values that the group can modify in fields that you specify. Transition rules
can be set only for lookup and user list fields.
Example
When modifying defect information, you can limit the items a user group can select in the
Status field of a defect record. You can set a transition rule that only allows a user group to edit
the Status field from Fixed to Closed.
Note: When Workflow has been used to change a list of values for a field that is set with
transition rules, the field may only be modified in a way that satisfies both the workflow script
and the transition rules. For more information, see "Workflow Event Reference" on page 381.
To set transition rules:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. In the group list, choose the user group for which you want to set permissions.
3. Click the Permissions tab.
4. Click a module tab, such as Defects. The tab displays the entities available in the Defects module
and their corresponding permission levels.
5. Expand and select an entity and its permission level. For example, expand Defect and then expand
Update. The permission level expands and lists available fields.
For more information on the available entities and permission levels, see "Understanding
Permission Settings" on page 250.
HP ALM (12.50)
Page 245
Administrator Guide
Chapter 17: Managing User Groups and Permissions
6. Select a field. For example, select Status. The Transition Rules grid appears in the Options pane on
the right side of the window.
7. Click Add Rule to add a transition rule. The Add Transition Rules dialog box opens.
8. Under From, you can:
l
l
Select $ANY to allow a user group to modify the field, irrespective of the currently displayed
value.
Select a value from the list. A user group is able to modify the selected field only when the field
displays the value you select. For example, to allow a user group to edit the Status field of a
defect only if "Fixed" is the current value, select Fixed.
9. Under To, you can:
l
l
Select $ANY to allow a user group to change the field to any value.
Select a value from the list. A user group is able to change the value of the selected field to only
the value that you specify. For example, to allow a user group to change the value of the Status
field only to "Closed", select Closed.
10. Click OK to save and close the Add Transition Rules dialog box. The new rules are displayed in the
Transition Rules grid.
11. To modify a transition rule, select a rule from the Transition Rules grid and click the Edit Rule
button. In the Edit Transition Rules dialog box, modify the rule. Click OK.
12. To delete a transition rule, select a rule from the Transition Rules grid and click the Delete Rule
button. Click OK to confirm if prompted.
13. Click Save to save your changes to the Groups and Permissions page.
HP ALM (12.50)
Page 246
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Owning ALM Objects
When setting group permissions, you can limit the capabilities of modifying or deleting a field value so
that only the user who owns the record can change or delete the value. The following table describes
the objects in ALM and the users that are defined as the owners of the objects.
ALM Object
Owner
Analysis folder
The Owner field displays the user who created the analysis folder. The owner is updated to the current
user if the analysis folder is moved (cut and paste) to the user's private folders.
Analysis item
The Owner field displays the user who created the analysis item. The owner is updated to the current
user if the analysis item is moved (cut and paste) to the user's private folders.
Baselines
The Created By field displays the user who captured the baseline.
Business
Components
The Assigned To field displays the user or user group responsible for the component.
Business Process
Model Elements
The Import By field displays the user who imported the business process model elements.
Business Process
Model Models
The Created By field displays the user who created the business process model models.
Business Process
Model Paths
The Created By field displays the user who created the business process model paths.
Dashboard folder
The Folder Owner field displays the user who created the dashboard folder. The owner is updated to
the current user if the dashboard folder is moved (cut and paste) to the user's private folders.
Dashboard page
The Page Owner field displays the user who created the dashboard page. The owner is updated to the
current user if the dashboard page is moved (cut and paste) to the user's private folders.
Defect
The Assigned To field displays the user to which the defect has been assigned.
Favorites
The Owner field displays the user who created the favorite.
Requirement
The Author field displays the user who created the requirement.
Test in the Test
Plan module
The Designer field displays the user who created the test in the test plan module.
Resource in the
Test Resources
module
The Created By field displays the user who created the resource in the test resources module.
Test Configuration
The Created By field displays the user who created the test configuration.
Test in the Test
Lab module
The Responsible Tester field displays the user testing the test in the test lab module.
Test run in the Test The Tester field displays the user testing the test run in the test lab module.
Lab module
HP ALM (12.50)
Page 247
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Note: You can change the owner of an ALM object by modifying the value of TB_OWNER_FIELD_
NAME in the Tables table. For more information on the Tables table, refer to the HP ALM Project
Database Reference.
Hiding Data for a User Group
You can instruct ALM to hide specific records that a user group can view. You can hide records related to
defects, libraries, requirements, business components, resources, tests, and test sets. Hiding records
includes the following options:
l
Filtering Data. You can set filters for specific fields, limiting the records that the user group can
view. For example, you can set the filter for the field Assigned To to "[CurrentUser]". This instructs
ALM to display only the records that are assigned to the current user.
Note: If you are filtering requirements for a user group according to the Req Parent field, all
requirements under the selected parent are displayed in the requirements grid. The
requirements tree does not display any requirements.
Empty test subject and test set folders are not included in any filter results.
For more information on filtering, refer to the HP Application Lifecycle Management User Guide.
l
Defining Visible Fields. You can select which fields in a module the user group can see and which
should be hidden. Users belonging to a specific user group need to view only data that relates to their
work. For example, you may want to hide the Path field in the Test Plan module from user groups
that should not be able to access test scripts from the file system. You cannot hide required fields.
Note: Certain critical fields cannot be hidden. These fields are marked with a
and cannot
be moved.
To hide data:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. In the group list, choose the user group for which you want to hide data.
3. Click the Data-hiding tab.
4. Click the entity for which you want to hide data. For example, click Defect. The pane at the right
displays the filters currently set and the fields currently visible in the Defects module to the users
of the selected group.
5. Click the Set Filter/Sort
HP ALM (12.50)
button. The Filter <entity> dialog box opens.
Page 248
Administrator Guide
Chapter 17: Managing User Groups and Permissions
6. Set one or more filters. The filter determines the records that a user group can view in ALM. For
more information, refer to the HP Application Lifecycle Management User Guide.
7. Click OK to close the Filter <entity> dialog box. The filters you set are displayed.
8. Click the Set Visible Fields
button. The Select Columns dialog box opens.
9. Click the arrows to hide or display each field.
10. Click OK to close the Select Columns dialog box. The fields you set as visible are displayed.
11. Click Save to save your changes to the Groups and Permissions page.
Cross Project Customization
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
If you are working with a project that is linked to a template project, you cannot hide data for any field
defined by the template project.
For user groups defined by the template project, you can hide the data of user-defined fields defined by
the project. In the Groups and Permissions page, select the user group in the group list, and click the
Data-hiding tab to determine which data is visible.
Renaming User Groups
You can rename a user group. All customization performed on the group remains.
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot rename a user group defined by the template project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To rename a user group:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. In the group list, select a group name.
3. Click the Rename Group button. The Rename Group dialog box opens.
4. Type a new name for the group.
5. Click OK to save your changes.
HP ALM (12.50)
Page 249
Administrator Guide
Chapter 17: Managing User Groups and Permissions
Deleting User Groups
You can delete user groups that were added to an ALM project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
Cross Project Customization. If you are working with cross project customization, consider the
following:
l
l
Working with a Template Project: If you delete a user group from a template project, ALM does not
delete the group from the linked projects. After you next apply template customization to the linked
projects, the user group is no longer read-only in the project and can be modified, renamed, or
deleted by the project administrator.
Working with a Linked Project: If you are working with a project that is linked to a template project,
you cannot delete a user group defined by the template project.
To delete a user group:
1. In the Project Customization window, in the left pane, click Groups and Permissions. The Groups
and Permissions page opens.
2. In the group list, select a group name.
3. Click the Delete Group button.
4. Click Yes to confirm.
Understanding Permission Settings
You can display the permissions of user groups in the Permissions tab. You can modify the permissions
of custom user groups at any time. You cannot modify the permissions of the default user groups
(TDAdmin, QATester, Project Manager, Developer, and Viewer).
To display permissions for a user group, in the Groups and Permissions page, select the user group in
the group list, and click the Permissions tab.
HP ALM (12.50)
Page 250
Administrator Guide
Chapter 17: Managing User Groups and Permissions
When Performance Center is installed, the following additional default user groups are available:
l
Performance Advisor
l
Performance Tester
l
Performance Test Specialist
Note: ALM Editions: Some permission settings may not be applicable, according to the available
functionality with each edition. For more information about ALM editions and their functionality,
see the HP Application Lifecycle Management User Guide.
If you are working with a project that is linked to a template project, you cannot modify the permissions
of user groups defined in the template. You can, however, limit the records that the user group can
view. For more information, see "Hiding Data for a User Group" on page 248.
Note: ALM Editions: Cross project customization is not available for Quality Center Enterprise
Edition. For more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
Customizing Module Access for User Groups
For each ALM project, you can control the modules that each user group can access. you can better
utilize your ALM licenses by preventing users from accessing unnecessary modules. For example, if a
user group uses ALM only to add defects to a project, you can limit the group's access to the Defects
module only.
HP ALM (12.50)
Page 251
Administrator Guide
Chapter 17: Managing User Groups and Permissions
You can specify module access for the following modules: Defects, Test Plan, Test Lab, Requirements,
Dashboard, Business Components, Releases, Business Process Models, and Libraries.
If access to the Business Components module is not enabled for a user group, those users can still view
existing business process tests in read-only mode.
Note: Performance Center: Module access customization is not supported in Lab Management.
To customize module access for user groups:
1. In the Project Customization window, in the left pane, click Module Access. The Module Access page
opens.
Checkmarks indicate the modules that a user group can access.
2. To select or clear a cell in the table, select the cell's checkbox.
3. To select or clear all modules for a user group, select the checkbox in the column to the right of
the user group name.
4. To select or clear all user groups for a module, select the checkbox to the left of the module name
(in the same cell).
5. To select or clear all user groups for all modules, select the checkbox in the column to the right of
the heading "User Groups."
6. Click Save to save your changes.
HP ALM (12.50)
Page 252
Chapter 18: Customizing ALM Projects
As an HP Application Lifecycle Management (ALM) project administrator, you can customize a project to
meet the specific needs of your organization. For example, you can add or customize fields, customize
requirement types, and create categories and lists that reflect the needs of your project.
This chapter includes:
•
•
•
•
About Customizing ALM Projects
254
Customizing Project Entities
254
Customizing Project Requirement Types
261
Customizing Project Lists
266
HP ALM (12.50)
Page 253
Administrator Guide
Chapter 18: Customizing ALM Projects
About Customizing ALM Projects
Before you begin a project, you can customize your project to reflect your unique requirements. As a
project progresses, you can further adjust the project to meet its changing needs.
ALM contains system fields in which you enter information about ALM entities. You can modify the
behavior of these fields by restricting users to selecting values only from associated lists, by making
entry into certain fields mandatory, and by preserving a history of values entered in the field. In
addition, you can include data unique to your project by creating user-defined fields. You can associate
these fields with ALM system and user-defined lists.
For example, if you are running tests on several builds of an application, you can add a Detected in
Build field to the Add Defect dialog box. You can then create a selection list containing the values
Build1, Build2, and Build3, and associate the list with the Detected in Build field.
In the Requirements module, you can also assign each requirement to a requirement type. A
requirement type defines which fields are available and which fields are required for a requirement of
that type. This enables you to make available for a requirement only the fields relevant to the type to
which it is assigned.
Customizing Project Entities
Using the Project Entities page, you can customize your ALM project to suit your environment.
Each ALM project is divided into project entities. Entities contain data entered by users for a specific
application management process. The data is stored in tables.
Project Entities Tree
The project entities tree displays the available project entities.
HP ALM (12.50)
Page 254
Administrator Guide
Chapter 18: Customizing ALM Projects
Each entity contains system fields and user-defined fields:
l
l
System fields. These are ALM default fields. You cannot add or delete system fields, you can only
modify them.
User fields. These are fields that you can define and include in an ALM project to customize for your
specific project needs. You can add, modify, and delete user-defined fields.
For details, see:
l
"Adding User-Defined Fields" on page 258
l
"Modifying System and User-Defined Fields" on page 258
l
"Deleting User-Defined Fields" on page 259
For detailed information on ALM entities and fields, refer to the HP ALM Project Database Reference.
The Settings Tab
The Settings tab displays the field properties. The following properties are available:
Properties
Description
Name
Indicates the field name used in the ALM database table. Read-only.
Label
Indicates the field name as it is displayed in ALM. You can type a new name or use the default name. The label
cannot be blank and cannot include the following characters: ( ) @ \ / : * ? " ` < > | + = ; , %
Type
Specifies the type of data that the user can enter in the field. It includes the following types:
l
Number. Enables integer entry only.
l
Float. Enables the entry of a floating point/real number.
l
String. Enables the entry of any character string.
l
Date. Enables the selection of a date.
l
Lookup List. Displays the Lookup List area and enables the selection from a drop-down list.
l
User List. Enables the selection of a user name from your ALM users list.
l
Memo. Enables the entry of blocks of data. Note that by default, you can add up to five memo fields to each
ALM entity.
In Site Administration's Site Configuration tab, you can edit the EXTENDED_MEMO_FIELDS parameter, which
extends the number of memo fields you can add. For more information, see "Setting ALM Configuration
Parameters" on page 168.
Length
Indicates the field size. (Available only when the String type is selected.)
Note: The maximum field length is 255 characters.
Sanitization Specifies the sanitization type of the field. (Available only when the String type is selected.) It includes the
following types:
type
l
HP ALM (12.50)
None. Returns the value as it is stored in the database.
Page 255
Administrator Guide
Chapter 18: Customizing ALM Projects
Properties
Description
l
HTML. The value is sanitized according to a predefined white list for allowed HTML content.
l
Text. The value is HTML encoded.
History
Preserves a log of values entered in the selected field.
Required
Indicates that a user must enter a value for the field.
Note: If you set a field as required in a project that already contains data, users do not need
to enter a value for the field when they modify an existing record if the field is already
empty.
Masked
Indicates the input data mask for the field. (Available only when the String type is selected.) For more
information, see "Defining Input Masks" on page 260.
Versioned
Version Control: Indicates whether to save field values for each version of entities/fields under version
control.
This checkbox is selected, by default, for most fields. You can turn off versioning for user-defined fields and
some system fields.
Note: In some cases, the checkbox is disabled—for example, if the field's parent entity is not
version-controlled.
Tip: Turning off versioning for relevant fields enables workflow scripts and OTA scripts to run
without requiring entities to be checked in.
Searchable
Indicates a searchable field. (Available only when the Text Search option is enabled in the DB Servers tab in Site
Administration. For more information, see "Defining Searchable Fields" on page 166.)
Lookup List
Includes a list of predefined lists. (Available only when the Lookup List type is selected.) To associate a field
with a predefined list, select a list from the Lookup List box. To view or modify the selected list, click the Goto
List button.
New List
Creates a new list. (Available only when the Lookup List type is selected.) To associate a field with a new list,
click the New List button. The Project Lists dialog box opens. For more information on customizing a list, see
"Customizing Project Lists" on page 266.
Goto List
Displays a predefined list. (Available only when the Lookup List type is selected.) To open a predefined list,
select a list from the Lookup List box. Click the Goto List button. The Project Lists dialog box opens. For more
information on customizing a list, see "Customizing Project Lists" on page 266.
Verify
Value
Limits the user to select a value only from the items that are listed in the list box. (Available when Lookup List
Allow
Multiple
For user-defined fields, this option allows the user to select more than one value in any field that is associated
HP ALM (12.50)
or User List is selected.)
with a predefined lookup list. (Available only when the Lookup List type is selected.) For more information, see
Page 256
Administrator Guide
Chapter 18: Customizing ALM Projects
Properties
Description
Values
the ALLOW_MULTIPLE_VALUES site parameter.
For example, if you create a Language user field in the Defect entity and enable the Allow Multiple Values
option, a user can select English , French , and German language values at the same time when entering
this field's value.
Note:
l
This option is not available in the TEST STEP entity.
l
If you group a data grid or summary graph by a field containing multiple values, the
information in each value is grouped as its entire value. This value is the category for
grouping. For example, a value with English and French is grouped once as
English;French, and not as part of separate English and French categories.
For more information on customizing a list, see "Customizing Project Lists" on page 266.
Cross Project Customization
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
If you are working with cross project customization, consider the following:
l
l
Working with a Template Project: If you are working with a template project, you use the Project
Entities (Shared) link to customize system fields and create user-defined fields. System and userdefined fields in a template project are applied to the linked projects when you apply the template
customization. For more information on applying template customization, see "Applying Template
Customization to Linked Projects" on page 295.
Working with a Linked Project: If you are working with a project that is linked to a template project,
you cannot modify system or user-defined fields that are defined by the template project.
This section includes:
•
•
•
•
Adding User-Defined Fields
258
Modifying System and User-Defined Fields
258
Deleting User-Defined Fields
259
Defining Input Masks
260
HP ALM (12.50)
Page 257
Administrator Guide
Chapter 18: Customizing ALM Projects
Adding User-Defined Fields
You can customize an ALM project by adding up to 99 user-defined fields to each ALM entity.
Cross Project Customization: The template project and linked projects can each contain up to 99 userdefined fields for each ALM entity.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To add a user-defined field:
1. In the Project Customization window, in the left pane, click Project Entities. The Project Entities
page opens.
2. Under Project Entities, expand an entity.
3. Click the User Fields folder.
4. To add a user-defined field, you can:
l
l
Click the New Field button to add a number, string, date, or list type field.
Click the New Field arrow and choose New Memo Field to add a memo field. You can add up to
5 memo fields to each ALM entity.
Note: In Site Administration's Site Configuration tab, you can extend the number of
memo fields you can add, by editing the EXTENDED_MEMO_FIELDS parameter. For more
information, see "Setting ALM Configuration Parameters" on page 168.
5. In the Settings tab, set properties for the field. For more information, see "Customizing Project
Entities" on page 254.
6. Click Save to save your changes to the Project Entities page.
Note: If you add a user-defined field in the Requirements entity, you must assign the entity to a
specific requirement type. For details, see "Customizing Requirement Types" on page 263.
Modifying System and User-Defined Fields
You can modify the properties of system and user-defined fields in your ALM project.
Note: Certain fields cannot be modified. For example, you cannot modify the Type or Length
properties for system fields. In addition, for system fields of type Lookup List, you cannot
HP ALM (12.50)
Page 258
Administrator Guide
Chapter 18: Customizing ALM Projects
modify which list is associated with the field, or allow multiple values to be selected. For more
information, see "Customizing Project Entities" on page 254.
Cross Project Customization: If you are working with a project that is linked to a template project, you
cannot modify system or user-defined fields that are defined by the template project. Fields defined by
a template project are displayed with a template icon
.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To modify a system or user-defined field:
1. In the Project Customization window, in the left pane, click Project Entities. The Project Entities
page opens.
2. Under Project Entities, expand an entity.
3. Expand the System Fields folder or the User Fields folder.
4. Click the field that you want to customize. The settings for that field appear in the Settings tab.
5. Modify the properties for the selected field. For more information, see "Customizing Project
Entities" on page 254.
6. Click Save to save your changes to the Project Entities page.
Deleting User-Defined Fields
You can delete user-defined fields from your ALM project.
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot delete user-defined fields defined by the template project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To delete a user-defined field:
1. In the Project Customization window, in the left pane, click Project Entities. The Project Entities
page opens.
2. Under Project Entities, expand an entity.
3. Expand the User Fields folder.
4. Click the field that you want to delete and click the Delete Field button.
HP ALM (12.50)
Page 259
Administrator Guide
Chapter 18: Customizing ALM Projects
5. Click OK to confirm. The field is removed from the User Fields folder.
6. Click Save to save your changes to the Project Entities page.
Defining Input Masks
The input mask option is used to prompt users for data input using a mask pattern. If the user attempts
to enter a character that conflicts with the input mask, an error occurs. For example, to prompt the
user to enter a phone number, you can define the following input mask:
!\(000\)000-0000
This input mask limits the user to numeric characters only. It is displayed in an edit box as follows:
(___) ___ - ____
Note: You can define input masks for string type fields only.
To define an input mask:
1. In the Settings tab, select Masked. For more information, see "Customizing Project Entities" on
page 254.
2. Under Masked Edit Attributes, click the Define button. The Input Mask Editor dialog box opens.
3. In the Input Mask box, type an input mask or select a predefined mask.
HP ALM (12.50)
Page 260
Administrator Guide
Chapter 18: Customizing ALM Projects
You can use the following characters when defining input masks:
Mask
Character
Description
!
A space for a leading or trailing blank.
#
A digit.
.
A decimal.
:
A time separator.
/
A date separator.
\
Treats the next character in the mask string as a literal. For example, you can include the (, ), #, &, A, and ?
characters in the mask.
>
Converts all the characters that follow to uppercase.
<
Converts all the characters that follow to lowercase.
A
An alphanumeric character (entry required). For example: a – z, A – Z, or 0 – 9.
a
An alphanumeric character (entry optional). For example: a – z, A – Z, or 0 – 9.
C
A character (entry required). Valid values are ANSI characters in the following ranges: 32-126 and 128255.
c
A character (entry optional). Valid values are ANSI characters in the following ranges: 32-126 and 128255.
L
An alphabetic character or space (entry required). For example: a – z or A – Z.
l
An alphabetic character or space (entry optional). For example: a – z or A – Z.
0
A digit (entry required). For example: 0 – 9.
9
A digit (entry optional). For example: 0 – 9.
_
Inserts spaces. When the user types characters in the field box, the cursor skips the _ character.
4. In the Test Input box, you can test the input mask.
5. Click OK to close the Input Mask Editor dialog box.
6. Click Save to save your changes to the Project Entities page.
Customizing Project Requirement Types
Using the Requirement Types page, you can create requirement types for your project, and customize
their properties.
HP ALM (12.50)
Page 261
Administrator Guide
Chapter 18: Customizing ALM Projects
You can assign each requirement in the Requirements module to a requirement type. A requirement
type defines which fields are optional and which user-defined fields are available. This enables you to
create user-defined fields that are only available for requirements of a specific type.
For example, you might create a requirement type Security Requirement for requirements
connected to security. You could then create a user-defined field Security Hazards containing a list
of possible security hazards a requirement might cover. This field is not relevant for requirements of
types other than Security Requirement, so you would not make it available for any type except for
Security Requirement.
Each requirement type has an associated icon, which is displayed next to the requirement in the
Requirements module tree views, enabling you to easily identify to which type a requirement belongs.
For each requirement type you can determine whether test coverage and risk-based quality
management are available.
In addition, for each requirement type, you can define a rich text template to be used when adding or
editing rich text within the Requirements module.
Cross Project Customization
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
If you are working with cross project customization, consider the following:
l
l
Working with a Template Project: If you are working with a template project, you use the
Requirement Types (Shared) link to create and customize requirement types. Requirement types
defined in a template project are applied to the linked projects when you apply the template
customization.
Working with a Linked Project: If you are working with a project that is linked to a template project,
you cannot modify the default requirement types or requirement types that are defined by the
template project.
This section includes:
HP ALM (12.50)
Page 262
Administrator Guide
Chapter 18: Customizing ALM Projects
Creating Requirement Types
You can create a requirement type. ALM provides the default requirement types Undefined, Folder,
Group, Functional, Business, Testing, and Business Model. For more information on these types, refer
to the HP Application Lifecycle Management User Guide.
To create a requirement type:
1. In the Project Customization window, in the left pane, click Requirement Types. The Requirement
Types page opens.
2. Click the New Type button. The New Type dialog box opens.
3. In the Name box, type a name for the type.
4. In the Create As list, assign properties of an existing requirement type.
Tip: Choose an existing requirement type that has similar properties to the new type you
want to create. This minimizes the level of customization you need to do.
5. Click OK. The New Type dialog box closes and the new type is added to the Types list.
6. Click Save to save your changes to the Requirement Types page.
Customizing Requirement Types
You can customize a requirement type by changing its icon, by setting options for test coverage and risk
analysis, and by defining which fields are available and which are required for each requirement type.
You can also define a rich text template for each requirement type.
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot modify the default requirement types or requirement types
defined by the template project. For requirement types defined by the template project, you can choose
which user-defined fields defined in the project are available to requirements of the type.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To customize a requirement type:
1. In the Project Customization window, in the left pane, click Requirement Types. The Requirement
Types page opens.
2. Select a requirement type.
HP ALM (12.50)
Page 263
Administrator Guide
Chapter 18: Customizing ALM Projects
3. In the Details tab, you can set the following:
l
Type Icon. To change the icon that is displayed in Requirements module tree views, next to the
requirements of the selected type, select an icon from the Type Icon list. The icon is changed
accordingly.
Note: You cannot change the icon for the default requirement types Folder and Group.
l
Risk-Based Quality Management. To set risk-based quality management for the requirements
of the selected type, select one of the following options from the Risk-Based Quality
Management box:
o
Perform Analysis.
o
Perform Assessment.
o
None. Select this one if you do not want to enable risk-based quality management for
requirements of the selected type.
For more information on risk-based quality management, see the HP Application Lifecycle
Management User Guide.
l
Test Coverage. To enable or disable test coverage of the requirements of the selected type,
select or clear the Test Coverage check box.
Note: You cannot clear the Testing Coverage check box for a requirement type if there
are requirements of that type which already have test coverage. To clear, you must
either delete the requirements of that type with test coverage, remove the test
coverage from those requirements, or change their type.
4. In the System Fields tab, you can make a system field a required field for the type. Select the
check box in the Required column for the field. Note that all system fields are automatically
included in every type, and that some system fields cannot be set as optional.
Tip: To set all system fields as required fields at one time, select the check box next to the
Required column heading.
5. In the User Defined Fields tab, you can choose which user fields are available for requirements of
the type, and which of these fields are required:
l
l
To make a user-defined field available for the type, select the check box in the In Type column
for the field. For more information on user-defined fields, see "Customizing Project Entities" on
page 254.
To make a user-defined field that is available for the type a required field, select the check box
in the Required column for the field.
6. In the Rich Text Template tab, use the HTML editor to define a page layout to be displayed as the
initial view in the Rich Text tab of the Requirements module. For more information on the Rich Text
HP ALM (12.50)
Page 264
Administrator Guide
Chapter 18: Customizing ALM Projects
tab, see the HP Application Lifecycle Management User Guide.
Note:
l
You can only define one template per requirement type.
l
You cannot include graphics in the template. You can only add graphics from within the
Rich Text tab of the Requirements module.
l
The template is applied automatically to all newly created requirements of the type.
l
The template can also by applied manually to existing requirements from within the
Rich Text tab. Applying the template overwrites any existing content.
7. Click Save to save your changes to the Requirement Types page.
Renaming Requirement Types
You can rename a requirement type. You cannot rename the following default requirement type:
Folder.
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot rename the default requirement types or requirement types
defined by the template project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To rename a requirement type:
1. In the Project Customization window, in the left pane, click Requirement Types. The Requirement
Types page opens.
2. Select a requirement type.
3. Click the Rename Type button. The Rename Type dialog box opens.
4. Type a new name for the requirement type.
5. Click OK to close the Rename Type dialog box. The requirement type name is updated.
6. Click Save to save your changes to the Requirement Types page.
Deleting Requirement Types
You can delete a requirement type. You cannot delete a type if there are requirements of the type in
your project. To delete a type, you must first delete all requirements of the type, or change their types.
You cannot delete the following default requirement types: Folder, Group, and Undefined.
HP ALM (12.50)
Page 265
Administrator Guide
Chapter 18: Customizing ALM Projects
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot delete the default requirement types or requirement types
defined by the template project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To delete a requirement type:
1. In the Project Customization window, in the left pane, click Requirement Types. The Requirement
Types page opens.
2. Select a requirement type.
3. Click the Delete Type button.
4. Click OK to confirm. The requirement type is deleted.
5. Click Save to save your changes to the Requirement Types page.
Customizing Project Lists
Using the Project Lists page, you can create, rename, and delete user-defined lists. For details, see:
l
"Creating Lists" on the next page
l
"Renaming Lists, Items, or Sub-Items" on page 268
l
"Deleting Lists, Items, or Sub-Items" on page 269
A list contains items, which are values that you can enter in a field. For example, the selection list for the
Languages user-defined field may contain the items English and European Languages.
The list can also contain several levels of sub-items. For example, the item English can contain a
sublist with the sub-items English (Australia), English (Canada), English (Great Britain),
and English (US).
HP ALM (12.50)
Page 266
Administrator Guide
Chapter 18: Customizing ALM Projects
Note: Performance Center: When creating project lists in Project Customization, sub-items are not
supported.
You can allow the user to select more than one value from a list by enabling the Allow Multiple Values
option for the relevant field in the Project Entities page. For more information, see the Field Settings
table in "Customizing Project Entities" on page 254.
Note: To associate a list with a field, see "Customizing Project Entities" on page 254.
Cross Project Customization
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
If you are working with cross project customization, consider the following:
l
l
Working with a Template Project: If you are working with a template project, you use the Project
Lists (Shared) link to create and customize user-defined lists. Project lists defined in a template
project are applied to the linked projects when you apply the template customization.
Working with a Linked Project: If you are working with a project that is linked to a template project,
you cannot modify, rename, or delete user-defined lists that are defined by the template project.
Creating Lists
You can create a list to be assigned to one or more fields.
To create a list:
1. In the Project Customization window, in the left pane, click Project Lists. The Project Lists page
opens.
2. Click the New List button. The New List dialog box opens.
3. Type a name for the new list (maximum length 255 characters) and click OK.
4. To add an item to the new list or to an existing list, select the list name and click the New Item
button. The New Item dialog box opens. Type a name for the item and click OK.
Note: You should not use a semi-colon (";") as part of any list item if the list is to be used in
a multiple value field. For more information on multiple value fields, see the Field Settings
table in "Customizing Project Entities" on page 254.
5. To create a sub-item, select an item and click the New Sub-Item button. The New Sub-Item dialog
HP ALM (12.50)
Page 267
Administrator Guide
Chapter 18: Customizing ALM Projects
box opens. Type a name for the sub-item and click OK.
Note: Performance Center: Sub-items are not supported.
6. Click Save to save your changes to the Project Lists page.
Renaming Lists, Items, or Sub-Items
You can rename user-defined lists, and system and user-defined items or sub-items.
Note: You cannot change some system list items. For example, the Y and N in the YesNo list. For
more information on system items that cannot be changed, see HP Software Self-solve
knowledge base article KM206085
(http://h20230.www2.hp.com/selfsolve/document/KM206085).
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot rename lists, items, or sub-items defined by the template
project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To rename a list:
1. In the Project Customization window, in the left pane, click Project Lists. The Project Lists page
opens.
2. Select a list.
3. Click the Rename List button. The Rename List dialog box opens.
4. Type a new name for the list.
5. Click OK to close the Rename List dialog box.
6. Click Save to save your changes to the Project Lists page.
To rename an item or sub-item:
1. In the Project Customization window, in the left pane, click Project Lists. The Project Lists page
opens.
2. Select a list.
3. Select an item.
4. Click the Rename Item button. The Rename List Item dialog box opens.
5. Type a new name for the item. Click OK.
6. Click Save to save your changes to the Project Lists page.
HP ALM (12.50)
Page 268
Administrator Guide
Chapter 18: Customizing ALM Projects
Deleting Lists, Items, or Sub-Items
You can delete user-defined lists and system and user-defined items or sub-items.
Note:
l
You cannot delete a user-defined list that is being used as a lookup list for a field.
l
You cannot delete some system list items. For example, the Y and N in the YesNo list. For
more information on system items that cannot be deleted, see HP Software Self-solve
knowledge base article KM206085
(http://h20230.www2.hp.com/selfsolve/document/KM206085).
Cross Project Customization - Working with a Linked Project: If you are working with a project that is
linked to a template project, you cannot delete lists, items, or sub-items defined by the template
project.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
To delete a list:
1. In the Project Customization window, in the left pane, click Project Lists. The Project Lists page
opens.
2. Select a user-defined list name.
3. Click the Delete List button.
4. Click Yes to confirm.
5. Click Save to save your changes to the Project Lists page.
To delete an item or sub-item:
1. In the Project Customization window, in the left pane, click Project Lists. The Project Lists page
opens.
2. In the left pane, select a list name.
3. In the right pane, select a list item.
4. Click the Delete Item button.
5. Click Yes to confirm.
6. Click Save to save your changes to the Project Lists page.
HP ALM (12.50)
Page 269
Administrator Guide
Chapter 18: Customizing ALM Projects
HP ALM (12.50)
Page 270
Chapter 19: Configuring Automail
As an HP Application Lifecycle Management (ALM) project administrator, you can routinely inform your
personnel about defect repair activity. You determine the conditions for sending defect messages to
each recipient by defining a mailing configuration.
This chapter includes:
•
•
•
About Setting Automail
272
Designating Automail Fields and Conditions
272
Customizing the Subject of Defect Mail
274
HP ALM (12.50)
Page 271
Administrator Guide
Chapter 19: Configuring Automail
About Setting Automail
ALM enables you to automatically notify users through email each time changes are made to specified
defect fields. Configuring mail for an ALM project involves the following steps:
l
l
l
l
l
Click the Automail link in the Project Customization window to define the defect fields and specify
the users and conditions. See "Designating Automail Fields and Conditions" below.
In Site Administration's Site Projects tab, enable the mail configuration for a project by selecting the
Send mail automatically check box. You must select this check box for your mail configuration to
work. For more information, see "Updating Project Details" on page 68.
In Site Administration's Site Configuration tab, you can edit the MAIL_INTERVAL parameter, which
defines the time interval for sending defect emails in all projects. You can also set parameters to
define the format and character set of mail, and whether attachments or history are included in the
mail. For more information, see ATTACH_MAX_SIZE, AUTO_MAIL_WITH_ATTACHMENT, and AUTO_
MAIL_WITH_HISTORY.
You can customize the subject line of defect email for all projects or for a specific project. For more
information, see "Customizing the Subject of Defect Mail" on page 274.
In Site Administration's Site Users tab, make sure you have specified the email addresses of the
users who should receive defect messages. For more information, see "Updating User Details" on
page 137.
Designating Automail Fields and Conditions
When you designate a field as a mail field, any changes made to that field cause ALM to send an email
message in the next time interval. For example, suppose you designate Status as a mail field and then
update the Status field for a particular defect. In the next time interval, the details of the defect,
including the updated status information, are sent to designated users.
Mail conditions determine when various users receive defect messages. For each user, you can define
separate mail conditions. For example, you can specify that a user receives messages only for defects
assigned an urgent priority.
To designate Automail fields and conditions:
HP ALM (12.50)
Page 272
Administrator Guide
Chapter 19: Configuring Automail
1. In the Project Customization window, in the left pane, click Automail. The Automail page opens.
Available Defect Fields contains the names of the fields that appear in the Defects Grid. Selected
Defect Fields contains the names of fields currently assigned as mail fields.
2. Choose one or more fields and click the arrow buttons (> and <) to move the fields from one list to
the other. Click the double arrow buttons (>> and <<) to move all the fields from one list to the
other.
3. Select the users who should receive the email by selecting the checkbox next to each user name in
the To area in the lower half of the window.
Tip: To see only the relevant selected users, select the Show Only Selected Users
checkbox.
4. Click the Filter button to define a filter under which the selected user receives mail. If you define
multiple filters, the selected user only receives mail if all of the conditions are met. For more
information on filtering, refer to the HP Application Lifecycle Management User Guide.
HP ALM (12.50)
Page 273
Administrator Guide
Chapter 19: Configuring Automail
5. Click Save to save your changes.
Customizing the Subject of Defect Mail
You can customize the subject line of defect email sent automatically to users, for all projects or for a
specific project. For example, you can define a subject line such as the following:
Defect # 4321 has been created or updated - Buttons on print dialog are not
aligned
The line can contain the values of ALM fields. To include a field value from the defect that is being sent,
prefix the field name with a question mark (?). Field names must be upper-case. For example:
Defect # ?BG_BUG_ID has been created or updated - ?BG_SUMMARY
You can customize the subject line for all your projects by adding the AUTO_MAIL_SUBJECT_FORMAT
parameter in the Site Configuration tab. For more information, see "Setting ALM Configuration
Parameters" on page 168.
To customize the subject of defect mail for a specific project:
1. In Site Administration, click the Site Projects tab.
2. In the Projects list, double-click the project for which you want to customize the email subject line.
3. Select the DATACONST table.
4. In the SQL pane, type an SQL INSERT statement to insert a row into the table with the following
values:
l
l
In the DC_CONST_NAME column, insert the parameter name AUTO_MAIL_SUBJECT_FORMAT.
In the DC_VALUE column, insert the strings and the names of fields to be placed in the subject
line.
For example, type the following SQL statement into the SQL pane:
insert into dataconst values ('AUTO_MAIL_SUBJECT_FORMAT',
'DEFAULT.TESTPROJ - Defect # ?BG_BUG_ID has been created or updated ?BG_SUMMARY')
The subject line you define is specific to the project, so you can include the project name in the
line.
For more information on modifying project tables, see "Querying Project Tables" on page 84.
5. Click the Execute SQL button. The row is added to the DATACONST table to set the email subject.
HP ALM (12.50)
Page 274
Chapter 20: Customizing Risk-Based Quality
Management
This chapter describes how to customize the criteria and the constant values used in risk-based quality
management.
This chapter includes:
•
•
•
•
About Customizing Risk-Based Quality Management
276
Customizing Risk-Based Quality Management Criteria
276
Customizing Risk Calculations
282
Customizing Risk-Based Quality Management Constants
283
HP ALM (12.50)
Page 275
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
About Customizing Risk-Based Quality Management
You use risk-based quality management to determine at which Testing Level to test each requirement
in the Requirements module. ALM then calculates the total estimated Testing Time for an analysis
requirement based on the Testing Levels of its child assessment requirements. You compare this with
the resources you have available to test the analysis requirement, and if necessary, make adjustments
to the Testing Levels for the requirement and its children. This enables you to plan the testing strategy
for your requirements. For more information on risk-based quality management, see the HP Application
Lifecycle Management User Guide.
The Testing Level is determined by the requirement's Risk and Functional Complexity. Risk is comprised
of the Business Criticality and Failure Probability. You determine values for these factors by assigning
values to a series of criteria associated with each factor. Each criterion has a number of possible values.
You can customize these criteria and values and how ALM uses them to determine the Business
Criticality, Failure Probability, and Functional Complexity. For more information, see "Customizing RiskBased Quality Management Criteria" below.
You can customize how Risk is calculated from the Business Criticality and Failure Probability. For more
information, see "Customizing Risk Calculations" on page 282.
You can also customize which Testing Time is associated by default with each Testing Level and
Functional Complexity. In addition, you can customize how ALM determines the Testing Level with which
to test a requirement based on the requirement's Risk and Functional Complexity. For more
information, see "Customizing Risk-Based Quality Management Constants" on page 283.
In addition, you can customize for each requirement type whether requirements of the type enable risk
assessment, risk analysis, or do not enable risk-based quality management. For more information, see
"Customizing Requirement Types" on page 263.
Customizing Risk-Based Quality Management Criteria
You can customize the criteria used to determine the Risk and Functional Complexity of a requirement,
the possible values for each criterion and the weight assigned to each value. You can then define how
the total of these weights determines the Risk and Functional Complexity Categories.
Note: If you already calculated the Risk or Functional Complexity for a requirement, modifying
these criteria does not automatically recalculate the requirement's Risk or Functional
Complexity Category. To recalculate, you must reassess the requirement and change at least
one of its criterion values.
HP ALM (12.50)
Page 276
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
This section includes:
•
•
Customizing criteria and Values
278
Customizing Weight Boundaries
279
HP ALM (12.50)
Page 277
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
Customizing criteria and Values
You can customize the criteria, criterion values, and weights used by ALM to determine the Risk and
Functional Complexity Categories for each requirement. Risk is comprised of the Business Criticality and
Failure Probability.
ALM provides a default set of criteria when you create a new project. You can delete these criteria if you
do not want to use them.
To customize criteria and values:
1. In the Project Customization window, in the left pane, click Risk-Based Quality Management. The
Risk-Based Quality Management page opens.
2. Click one of the following tabs:
l
To customize criteria for determining Business Criticality, click the Business Criticality tab.
l
To customize criteria for determining Failure Probability, click the Failure Probability tab.
l
To customize criteria for determining Functional Complexity, click the Functional Complexity
tab.
The selected tab displays the relevant criteria.
3. To add a new criterion, select the Criterion list and click the New button. A new row is added to the
end of the Criterion list. Type a name for the criterion in the new row.
4. To add a description for a criterion, select the criterion from the Criterion list and type the
description in the Description of Criterion box. This description is displayed in the Risk tab of the
Requirements module when a user assesses Business Criticality, Failure Probability, and Functional
Complexity. By providing a full description of each criterion, including an explanation of its available
values, you help the user decide which value to assign to each criterion for a requirement.
5. To add a value for a criterion, select the criterion from the Criterion list and select the Value list.
HP ALM (12.50)
Page 278
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
Click the New button. A new row is added to the Value list. Type a name for the value in the new
row.
Note: Each value for a criterion must be unique.
6. To assign a weight to a criterion value, select the criterion from the Criterion list and then select
the value from the Value list. In the Weight column for the value, type the weight to assign to the
value.
When ALM calculates the Business Criticality, Failure Probability, or Functional Complexity of a
requirement, it checks the values assigned to each criterion and calculates the sum of the
corresponding weights for each value. This sum determines the Business Criticality, Failure
Probability, or Functional Complexity. For more information, see "Customizing Weight Boundaries"
below.
7. You can delete a criterion or a value for a criterion:
l
l
To delete a criterion, select the criterion from the Criterion list and click the Delete button. The
criterion is deleted.
To delete a criterion's value, select the criterion from the Criterion list and the value from the
Value list. Click the Delete button. The value is deleted.
Note: Business Criticality, Failure Probability, and Functional Complexity must each have at
least one associated criterion defined. In addition, each criterion must have at least one
possible value.
8. To change the order in which criteria are displayed in the Criterion list, select a criterion and click
the Move Up or Move Down buttons. Note that values for a criterion are automatically ordered by
their weights.
9. Click Save to save your changes to the Risk-Based Quality Management page.
Customizing Weight Boundaries
You can customize how ALM uses the values assigned to risk-based quality management criteria to
determine the Business Criticality, Failure Probability, and Functional Complexity for a requirement.
Customizing Weight Boundaries for Business Criticality
For each requirement, ALM calculates the total of the weights (TW) of the values assigned to each of
the Business Criticality criteria. ALM then uses this total to categorize the Business Criticality of the
requirement as either C- Nice to Have, B - Important, or A - Critical. ALM automatically calculates the
highest and lowest possible total weight and uses these to define the upper boundary of the Critical
category and the lower boundary of the Nice to Have category. You define the boundaries between the
Nice to Have and Important categories, and between the Important and Critical categories.
HP ALM (12.50)
Page 279
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
For example, suppose there are two criteria for Business Criticality, each with three possible values
whose weights are 20, 60, and 100. The minimum total weight is therefore 40 (if both criteria are
assigned the value with weight 20) and the maximum total weight is 200 (if both criteria are assigned
the value with weight 100). ALM automatically calculates these totals and uses them to determine the
lower and upper boundaries for the categories. You determine the boundaries between the categories
by typing 100 in the Nice to Have box and 160 in the Critical box.
In this example, ALM determines the Business Criticality for a requirement as follows:
l
l
l
If the sum of the weights of each of the criteria for a requirement is less than or equal to 100, the
requirement will have Nice to Have Business Criticality. This could happen, for example, if the
criteria have values with weights 20 and 60, so the total weight is 80.
If the sum is greater than 100 but less than 160, the requirement will have Important Business
Criticality. This could happen, for example, if the criteria have values with weights 60 and 60, so the
total weight is 120.
If the sum is greater than or equal to 160, the requirement will have Critical Business Criticality.
This could happen, for example, if the criteria have values with weights 100 and 60, so the total
weight is 160.
To customize weight boundaries for Business Criticality:
1. In the Project Customization window, in the left pane, click Risk-Based Quality Management. The
Risk-Based Quality Management page opens.
2. Click the Business Criticality tab. The Business Criticality tab displays criteria used to determine
Business Criticality.
3. Under Calculation of Business Criticality value based on total weights, define the boundaries
between different Business Criticality values. To define these boundaries, type the relevant values
in the Nice to Have and Critical boxes.
4. Click Save to save your changes to the Risk-Based Quality Management page.
Customizing Weight Boundaries for Failure Probability
For each requirement, ALM calculates the total of the weights (TW) of the values assigned to each of
the Failure Probability criteria. ALM then uses this total to categorize the Probability of the requirement
as either 3 - Low, 2 - Medium, or 1- High. ALM automatically calculates the highest and lowest possible
total weight and uses these to define the upper boundary of the High category and the lower boundary
of the Low category. You define the boundaries between the Low and Medium categories, and between
the Medium and High categories.
For example, suppose there are two criteria for Failure Probability, each with three possible values
whose weights are 20, 60, and 100. The minimum total weight is therefore 40 (if both criteria are
assigned the value with weight 20) and the maximum total weight is 200 (if both criteria are assigned
HP ALM (12.50)
Page 280
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
the value with weight 100). ALM automatically calculates these totals and uses them to determine the
lower and upper boundaries for the categories. You determine the boundaries between the categories
by typing 100 in the Low box and 160 in the High box.
In this example, ALM determines the Failure Probability for a requirement as follows:
l
l
l
If the sum of the weights of each of the criteria for a requirement is less than or equal to 100, the
requirement will have Low Failure Probability. This could happen, for example, if the criteria have
values with weights 20 and 60 so the total weight is 80.
If the sum is greater than 100 but less than 160, the requirement will have Medium Failure Probability.
This could happen, for example, if the criteria have values with weights 60 and 60 so the total weight
is 120.
If the sum is greater than or equal to 160, the requirement will have High Failure Probability. This
could happen, for example, if the criteria have values with weights 100 and 60 so the total weight is
160.
To customize weight boundaries for Failure Probability:
1. In the Project Customization window, in the left pane, click Risk-Based Quality Management. The
Risk-Based Quality Management page opens.
2. Click the Failure Probability tab. The Failure Probability tab displays criteria used to determine
Failure Probability.
3. Under Calculation of Failure Probability value based on total weights, define the boundaries
between different Failure Probability values. To define these boundaries, type the relevant values
in the Low and High boxes.
4. Click Save to save your changes to the Risk-Based Quality Management page.
Customizing Weight Boundaries for Functional Complexity
For each requirement, ALM calculates the total of the weights (TW) of the values assigned to each of
the Functional Complexity criteria. ALM then uses this total to categorize the Functional Complexity of
the requirement as either 3 - Low, 2 - Medium, or 1- High. ALM automatically calculates the highest
and lowest possible total weight and uses these to define the upper boundary of the High category and
the lower boundary of the Low category. You define the boundaries between the Low and Medium
categories, and between the Medium and High categories.
For example, suppose there are two criteria for Functional Complexity, each with three possible values
whose weights are 20, 60, and 100. The minimum total weight is therefore 40 (if both criteria are
assigned the value with weight 20) and the maximum total weight is 200 (if both criteria are assigned
the value with weight 100). ALM automatically calculates these totals and uses them to determine the
lower and upper boundaries for the categories. You determine the boundaries between the categories
by typing 100 in the Low box and 160 in the High box.
HP ALM (12.50)
Page 281
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
In this example, ALM determines the Functional Complexity for a requirement as follows:
l
l
l
If the sum of the weights of each of the criteria for a requirement is less than or equal to 100, the
requirement will have Low Functional Complexity. This could happen, for example, if the criteria have
values with weights 20 and 60 so the total weight is 80.
If the sum is greater than 100 but less than 160, the requirement will have Medium Functional
Complexity. This could happen, for example, if the criteria have values with weights 60 and 60 so the
total weight is 120.
If the sum is greater than or equal to 160, the requirement will have High Functional Complexity. This
could happen, for example, if the criteria have values with weights 100 and 60 so the total weight is
160.
To customize weight boundaries for Functional Complexity:
1. In the Project Customization window, in the left pane, click Risk-Based Quality Management. The
Risk-Based Quality Management page opens.
2. Click the Functional Complexity tab. The Functional Complexity tab displays criteria used to
determine Functional Complexity.
3. Under Calculation of Functional Complexity value based on total weights, define the boundaries
between different Functional Complexity values. To define these boundaries, type the relevant
values in the Low and High boxes.
4. Click Save to save your changes to the Risk-Based Quality Management page.
Customizing Risk Calculations
You can define how ALM calculates the Risk value of an assessment requirement.
To customize risk calculations:
1. In the Project Customization window, in the left pane, click Risk-Based Quality Management. The
Risk-Based Quality Management page opens.
2. Click the Risk Calculation tab.
3. In the Risk Calculation Policy grid, you can define the Risk policy for testing a requirement.
HP ALM (12.50)
Page 282
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
To define Risk calculations based on Business Criticality and Failure Probability, click the arrow next
to the cell in the grid corresponding to a particular Business Criticality and Failure Probability value.
Select a value. The available values are A - High, B - Medium, and C - Low.
Customizing Risk-Based Quality Management
Constants
You can define the default estimated Testing Times required to test a requirement with each Functional
Complexity value at each Testing Level. You can also define the default Testing Level used with each
Risk and Functional Complexity Category. If the user does not enter different values for a requirement
in the Requirements module, ALM uses these default values when calculating the estimated Testing
Time for the requirement during the risk analysis.
Note: Modifying these criteria does not automatically affect the results of existing risk
analyses. To update the results of a risk analysis, you must perform the analysis again.
To customize risk-based quality management constants:
1. In the Project Customization window, in the left pane, click Risk-Based Quality Management. The
Risk-Based Quality Management page opens.
2. Click the Risk Constants tab. The Risk tab displays constants used by default when calculating the
Testing Time and Testing Level for a requirement.
3. In the Units used to measure Testing Effort box, select the unit of measurement that you want
ALM to display when measuring Testing Time. The available units are Hours, Days, Weeks, and
Months.
HP ALM (12.50)
Page 283
Administrator Guide
Chapter 20: Customizing Risk-Based Quality Management
Note: If you change the units of measurement for a project, the Testing Time values are
not updated automatically. For example, if a requirement has Testing Time 48 hours and
you change the units of measurement from Hours to Days, the requirement has Testing
Time 48 days and not 2 days.
4. Under Testing Time (full) per Functional Complexity, for each Functional Complexity value, type
the estimated time required to fully test a requirement with the Functional Complexity value. The
Calculated Testing Time grid is updated to reflect these changes.
5. Under Testing level, in the Partial and Basic boxes, type the default Testing Time required for
partial testing and basic testing of a requirement. This should be expressed as a percentage of the
time required for full testing. The Calculated Testing Time grid is updated to reflect these changes.
6. In the Default Testing Policy grid, you can define the default Testing Level for testing a
requirement.
To define the default Testing Levels, click the arrow next to the cell in the grid corresponding to a
particular Risk and Functional Complexity value. Select a Testing Level from the available Testing
Levels. The available Testing Levels are Full, Partial, Basic, and None. Next to each Testing Level,
you can see the estimated time needed to test a requirement at that level, based on the default
Testing Times and Testing Levels you defined.
7. Click Save to save your changes to the Risk-Based Quality Management page.
HP ALM (12.50)
Page 284
Chapter 21: Activating Alert Rules
As an HP Application Lifecycle Management (ALM) project administrator, you can activate alert rules for
your project. This instructs ALM to create alerts and send email to notify those responsible when
changes occur in your project that may impact the application management process.
This chapter includes:
•
•
About Activating Alert Rules
286
Setting Alert Rules
287
HP ALM (12.50)
Page 285
Administrator Guide
Chapter 21: Activating Alert Rules
About Activating Alert Rules
You can keep track of your requirements, tests, and defects as you perform your application
management process. When an entity changes, you can instruct ALM to notify those responsible for any
associated entities.
The alert rules you can activate are based on the following associations you can create in ALM:
You can associate a test in the test plan tree with a requirement. This is performed by creating
requirements coverage in the Test Plan module, or by creating tests coverage in the Requirements
module.
l
l
You can link a test with a defect. This is performed by adding a defect during a manual test run.
l
You can create traceability links between requirements in the Requirements module.
After you have established associations in your project, you can then track changes using these
associations. When an entity in your project changes, ALM alerts you of any associated entities that may
be impacted by the change.
Version Control: ALM alerts associated entities only when a new version is checked in. The alert
indicates that the version status has changed to Checked In. You can then compare the new version
with the previous version. For more information on comparing versions, refer to the HP Application
Lifecycle Management User Guide.
Notification involves two steps. ALM flags the associated entity, which can be seen by all users, and then
sends an email to the user responsible for the entity.
There are four alert rules you can activate:
Rule Change Made
1
Requirement has any change, excluding changes in the
Direct Cover Status field and the risk-based quality
Entities Flagged
User Notified
Tests covering the
requirement.
Test designer. Note that
only the test designer can
delete the alert.
management fields.
2
Defect status changes to "Fixed".
Test instances associated
with the defect.
Responsible tester for the
test instance.
3
Test run status changes to "Passed".
Defects linked to the test
instance.
User assigned to the defect.
4
Requirement is deleted or has any change, excluding
The requirement's child
requirements and traced to
requirements.
Author of the requirement.
changes in the Direct Cover Status field and the riskbased quality management fields.
For more information on alerts, refer to the HP Application Lifecycle Management User Guide.
HP ALM (12.50)
Page 286
Administrator Guide
Chapter 21: Activating Alert Rules
Setting Alert Rules
You can activate four alert rules. For each rule, you can choose to alert the associated entity. The alert
can be seen by all users. You can also choose to send an email notification to the user responsible for
the entity.
To set alert rules:
1. In the Project Customization window, in the left pane, click Alert Rules. The Alert Rules page opens.
2. Select Alert Associated Entity to activate a rule. This instructs ALM to flag the entity when the
associated entity changes.
3. Select Send E-mail To to instruct ALM to send a notification email to the specified user when the
associated entity changes.
4. Click Save to save your changes.
HP ALM (12.50)
Page 287
Administrator Guide
Chapter 21: Activating Alert Rules
HP ALM (12.50)
Page 288
Chapter 22: Cross Project Customization
As an HP Application Lifecycle Management (ALM) template administrator, you use cross project
customization to apply customization from a template project to one or more ALM projects. Cross
project customization enables you to standardize policies and procedures across projects in your
organization.
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
This section includes:
•
•
•
•
•
About Cross Project Customization
290
Cross Project Customization Overview
291
•
292
Cross Project Customization Examples
Updating Linked Projects
292
•
•
•
Updating Linked Project Details
293
Verifying Cross Project Customization
294
Applying Template Customization to Linked Projects
295
The Cross Project Customization Report
297
Updating Linked Template Details
298
HP ALM (12.50)
Page 289
Administrator Guide
Chapter 22: Cross Project Customization
About Cross Project Customization
Cross project customization enables you to use a template project to define and maintain a common
set of project customizations for multiple projects.
Note: Cross project customization cannot be implemented between a Unicode template project
and ASCII projects. Also, when a template project is converted to Unicode, any linked
ASCII projects cannot receive customization changes from the template.
A template administrator is any user that is assigned project administrator permissions for a template
project. As template administrator, you can customize a template project to meet the needs of your
organization.
You link a template project to one or more ALM projects. This enables you to apply template
customization to the linked projects. As the needs of your organization change over time, you can
update the customization in your template project, and then reapply the template customization to the
linked projects.
A template project can be used to create additional projects or templates. When the Site Administrator
creates a project or template based on a template project, the template customization is copied to the
newly created project or template.
Product Feature Movie: To view a movie that demonstrates how to work with cross project
customization, choose Help > Movies in the ALM main window.
HP ALM (12.50)
Page 290
Administrator Guide
Chapter 22: Cross Project Customization
Cross Project Customization Overview
Implementing cross project customization involves the following steps:
l
l
l
l
Creating a Template Project. The site administrator creates template projects and assigns
template administrators in Site Administration. For more information, see "Creating Template
Projects" on page 47.
Linking the Template to Projects. The site administrator selects projects to link to a template in
Site Administration. For more information, see "Linking a Template to Projects" on page 66.
Customizing the Template Project. As template administrator, you customize a template project to
meet the policy needs of your organization. The template customizations that are applied to linked
projects include: user groups and permissions, module access, project entities, project requirement
types, project lists, PPT, report templates, and workflow.
Verifying Cross Project Customization. Before applying template customization to linked projects,
you must verify that ALM can successfully apply customization from the template to the projects. For
HP ALM (12.50)
Page 291
Administrator Guide
Chapter 22: Cross Project Customization
more information, see "Verifying Cross Project Customization" on page 294.
l
Applying Customization to Linked Projects. After defining or updating customization in the
template, you apply the customization to the linked projects. For more information, see "Applying
Template Customization to Linked Projects" on page 295.
Cross Project Customization Examples
The following examples demonstrate how you can use cross project customization:
l
Set a standard for working with defects.
The QA manager wants to limit how testers can modify defects. For example, you want to allow
testers to modify the status of defects to Fixed, but not to Closed, to allow the QA manager to
review the defect before closing it. You can create a customized user group for testers in your
template and set transition rules for the group. After applying the template customization to the
linked projects, all testers can be assigned to this group.
l
Enable consistent reporting by managers.
Managers in all divisions of your organization are required to report on a standard set of measures,
such as defect status or priority, or coverage status of requirements. As template administrator, you
can customize project lists and fields, and set required fields in a template. Applying the template
customization to the linked projects provides users with a common set of fields and values for
consistent reporting.
l
Create unique policies for separate sectors of an organization.
Your organization has acquired a new company. The new company has a standard policy for working
with defects, which is different from how your organization currently operates. Both sectors want to
maintain their current policies. You can customize a template for each sector of your organization,
and link each to the relevant projects for its sector.
Updating Linked Projects
You manage template customization updates to linked projects in Project Customization.
This section includes:
•
•
•
Updating Linked Project Details
293
Verifying Cross Project Customization
294
Applying Template Customization to Linked Projects
295
HP ALM (12.50)
Page 292
Administrator Guide
Chapter 22: Cross Project Customization
Updating Linked Project Details
You update linked project details in Project Customization.
To update linked project details:
1. Log into ALM using the template project.
2. In the Project Customization window, in the left pane, click Cross Project Customization. The Cross
Project Customization - Linked Projects page opens.
3. In the Linked Projects grid, view the projects linked to the template project. The Linked Projects
grid contains the following information for each project:
Column
Description
Indicates a request by the project administrator not to apply template customization changes to the project.
Domain
The domain of the linked project.
Project
The name of the linked project.
Updated Indicates if the linked project is updated with current template customization. The current status can be one
of the following:
Verified
l
Not Updated (default)
l
Updated
Indicates if template customization has been verified and can be successfully applied to the linked project. By
default, the status is Not Verified.
The current status can be one of the following:
l
HP ALM (12.50)
Not Verified (default)
l
Verified with Warnings
l
Verified
Page 293
Administrator Guide
Chapter 22: Cross Project Customization
Click on a column heading to change the sort order of the projects in the grid.
4. To refresh the data in the Linked Projects grid, click the Refresh button
.
5. View additional details about a selected project on the right side of the Linked Projects page. For
example, under Project Status, view the status of the project. If the project administrator has
selected the Request Suspension of Apply Customization option in the linked project, Requested
suspension of Apply Customization is displayed. The template administrator can choose to
exclude the project from template customization updates.
6. In the Comments box, view comments added by the project administrator. Click Add Comment to
add a comment to the project. The project administrator can view and add comments when
viewing the project details.
7. Under Project Details, the names of project administrators are displayed. Click the Send E-mail
button
to send mail to project or template administrators.
8. Under Last Applied Customization, view the date that template customization was last applied to
the linked project. Click the Applied Customization Report link to view details. For more
information, see "The Cross Project Customization Report" on page 297.
9. Under Last Verification, view the date of the last verification. Click the Verification Report link to
view details of the last verification. For more information, see "The Cross Project Customization
Report" on page 297.
Verifying Cross Project Customization
Before you can apply template customization to linked projects, you must verify the customization. The
verification process checks that ALM can successfully apply template customization to the linked
projects. Verification must complete successfully before ALM can apply template customization to a
linked project.
Note: For verification to complete successfully, the appropriate extensions must be enabled in
linked projects. If an extension is enabled for a template project, the extension must also be
enabled for the template's linked projects. Linked projects can have additional extensions
enabled. For more information on enabling extensions, see "Enabling Extensions for a Project"
on page 74.
To verify cross project customization:
1. In the Project Customization window, in the left pane, click Cross Project Customization. The Cross
Project Customization - Linked Projects page opens.
HP ALM (12.50)
Page 294
Administrator Guide
Chapter 22: Cross Project Customization
2. Select a project from the grid, or press the CTRL key and select multiple projects. To display only
those projects that are activated, select Show only active projects.
3. Click Verify. The Verification dialog box opens and displays progress.
4. To stop verification before it completes, click Stop. ALM completes the project that it is currently
verifying and then stops. The remaining projects are not verified.
5. Click Details to view additional information during or after verification. When verification
completes, click the Report link to view detailed results for a project.
6. When verification completes, click Close to close the Template Verification dialog box. The
verification status for the projects is updated in the Linked Projects grid.
7. Under Last Verification, click the Verification Report link to view details of the verification. For
more information, see "The Cross Project Customization Report" on page 297.
Applying Template Customization to Linked Projects
You can apply template customization to projects linked to the template. This applies the following
customization: groups and permissions, module access, project entities, project requirement types,
project lists, PPT, report templates, and workflow. When you apply template customization, the applied
customization is set to read-only in the linked projects and cannot be edited.
Note:
l
When a new project is created based on a template and linked to the template, you must
apply template customization in order to set the template customization as read-only in the
linked project. For more information on creating a project based on a template, see "Creating
Projects" on page 29.
l
The option for setting a report template as default is not applied to linked projects and can
be set by a project administrator in the linked project.
HP ALM (12.50)
Page 295
Administrator Guide
Chapter 22: Cross Project Customization
Before you can apply template customization, you must verify the customization. For more information,
see "Verifying Cross Project Customization" on page 294. Verification must complete successfully
before ALM can apply template customization to a linked project.
To apply template customization to linked projects:
1. In the Project Customization window, in the left pane, click Cross Project Customization. The Cross
Project Customization - Linked Projects page opens.
2. Select a project from the grid, or press the CTRL key and select multiple projects. To display only
those projects that are activated, select Show only active projects.
3. Click Apply Customization. If the project administrator of any of the selected projects has
requested not to apply template customization changes, a warning is displayed. Click OK to apply
template customization to all selected projects.
The Apply Customization Initialization dialog box opens.
4. Select Send mail notification to project administrators to instruct ALM to notify project
administrators after the process completes.
5. Click OK. The Apply Customization dialog box opens and displays progress.
6. To cancel the process for projects that ALM did not yet update, click Stop. ALM completes the
HP ALM (12.50)
Page 296
Administrator Guide
Chapter 22: Cross Project Customization
update to the current project and cancels the update to the remaining projects.
7. When the process completes, click Close to close the Apply Customization dialog box.
8. Under Last Applied Customization, click the Applied Customization Report link to view details of
applied template customization. For more information, see "The Cross Project Customization
Report" below.
The Cross Project Customization Report
The Cross Project Customization Report provides detailed results of the verification process, or of
template customization applied to linked projects. For more information on verification, see "Verifying
Cross Project Customization" on page 294. For more information on applying template customization,
see "Applying Template Customization to Linked Projects" on page 295.
There are two types of Cross Project Customization Reports:
l
l
Verification Report. Provides results of verification for the linked project.
Applied Customization Report. Provides results of template customization applied to the linked
project.
The Applied Customization Report includes the following sections:
l
l
Report Details. Contains details about the type of report, the template, the linked project, the
number of changes verified or applied to the linked project, and results.
Report by Customization Category. A listing of all changes verified or applied to the linked project.
This section lists changes by customization category including user groups, project entities, project
lists, requirement types, and workflow scripts.
Report results are classified into several categories as follows:
Result
category
Verification Report
Successful The change can be successfully applied to the linked
Warning
Applied Customization Report
project.
The change was successfully applied to the linked
project.
The change can be applied to the linked project, but
may result in data loss.
The change was applied to the linked project but may
have caused data loss.
For example:
l
reducing the length of a string type field
l
deleting a user-defined field
l
defining a field to be searchable and the Text
Search option is not available in the linked project
l
Failure
HP ALM (12.50)
disabling test coverage for a requirement type
while there are tests covering requirements of the
type
The change cannot be applied to the linked project.
An error occurred during the Apply Customization
process. The change was not successfully applied to the
Page 297
Administrator Guide
Chapter 22: Cross Project Customization
Result
category
Verification Report
Applied Customization Report
For example:
linked project.
l
Changing a field type from Memo type to
Number , String, or Date type or the reverse.
l
l
Naming a new field, or renaming an existing field,
with a field name that already exists in the linked
project.
The report is too large for the default limit query
size. For details, see the MAX_QUERY_LENGTH
site parameter.
Tips:
l
To easily locate warnings or errors in the Cross Project Customization Report, click the Find
button to open the browser's search tool, and search for the word warning or error.
l
To preserve formatting when mailing a report to another user, save the file as an HTML
archived web page by saving it with the .mht file extension.
l
If transition rules are set for user groups in the linked or template projects, each rule is listed
in the Transition Rule column in the format <from state>,<to state>. For example,
New,Open New,Rejected Open,Fixed Open,Rejected indicates that the user group can
change the field value from New to Open or Rejected, and from Open to Fixed or Rejected.
Updating Linked Template Details
If you are working with a project that is linked to a template project, you can view details about the
project and about the template project from the Linked Template page. You can view details about
template customization applied to the project, send email to the template administrator, check for
conflicts between customization in the project and customization in the template project, or make a
request to block template customization updates.
To update linked template details:
1. Log into ALM using a project that is linked to a template.
2. In the Project Customization window, in the left pane, click Cross Project Customization. The Cross
Project Customization - Linked Template page opens.
HP ALM (12.50)
Page 298
Administrator Guide
Chapter 22: Cross Project Customization
3. Under Project Status, view the following status information:
l
l
Updated. Customization in the template project is applied to the project.
Not Updated. Changes made to customization in the template project have not been applied to
the project.
4. Select Request suspension of Apply Customization to make a request to block template
customization updates. The request is displayed in the template project, and the template
administrator can choose to exclude the project from template customization updates.
5. Click Add Comment to add a comment to the project. The comment is displayed in the Comments
box. The Comments box also displays comments made by the template administrator. The
template administrator can add and view comments when reviewing linked project details in the
template project.
6. Under Template Details, view the name of the template project linked to the project, and the
names of the template administrators. To send email to the project or template administrators,
click the Send E-mail button
.
7. Under Last Applied Customization, view the date of the last time template customization was
applied to the project. Click the Applied Customization Report link to view details. For more
information, see "The Cross Project Customization Report" on page 297.
8. Under Last Verification, view the date of the last time customization was verified for the project.
Click the Verification Report link to view details. For more information, see "The Cross Project
Customization Report" on page 297.
9. Click the Verify button to verify cross project customization for the project. For example, if you
make changes to project customization, you can run template verification to check for conflicts
between customization in the project and customization in the template project.
10. Click Details to view additional information during or after verification. When verification
completes, you can click the Report link to view detailed results for the project.
HP ALM (12.50)
Page 299
Administrator Guide
Chapter 22: Cross Project Customization
11. When verification completes, click Close to close the Verification dialog box.
HP ALM (12.50)
Page 300
Chapter 23: Customizing Project Planning and
Tracking KPIs
This chapter describes how to customize KPIs for project planning and tracking (PPT).
ALM Editions: The Project Planning and Tracking link in Project Customization is available for
ALM Edition only. For more information about ALM editions and their functionality, see the HP
Application Lifecycle Management User Guide.
This chapter includes:
•
•
•
•
•
About Customizing PPT KPIs
302
Project Planning and Tracking Page
302
Project Planning and Tracking - General Tab
303
Configure Transitions Dialog Box
305
Project Planning and Tracking - KPI Analysis Tab
306
HP ALM (12.50)
Page 301
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
About Customizing PPT KPIs
PPT collects data from the milestones of your release using key performance indicators (KPIs). A KPI is a
quantifiable measure designed to track a critical performance variable over time, and measure the
essential outcome of quality assurance activities. You can customize each KPI to reflect your needs. You
can customize system-defined KPIs or create user-defined KPIs.
When analyzing the overall health and deployment readiness of your release in the PPT scorecard, you
can further enhance your output by customizing the KPI graphs displayed in your scorecard.
For more details on PPT, refer to the HP Application Lifecycle Management User Guide.
Project Planning and Tracking Page
This page enables you to customize the PPT KPIs.
To access
Important
information
In Project Customization, in the left pane, click Project Planning and Tracking.
ALM Editions: The Project Planning and Tracking tab is available for ALM Edition only. For
more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
See also
HP ALM (12.50)
"About Customizing PPT KPIs" above
Page 302
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Elements
Description
Saves your changes to the Project Planning and Tracking page.
Opens the New KPI Type dialog box enabling you to define a new KPI by specifying a KPI name, an entity
type, and measurement type.
Opens the Create As dialog box enabling you to create a KPI based on a selected KPI.
Deletes the selected KPI from the KPI Types list.
Note: A KPI type in use cannot be deleted.
<KPI types list> Lists available KPI types.
Filter By
KPI types associated with the selected entity type are displayed in the KPI type list. To view all KPI types,
select None.
General tab
Displays the properties of a selected KPI type. For more details, see "Project Planning and Tracking -
General Tab" below.
KPI Analysis tab Displays the KPI drill down properties of a selected KPI type. For more details, see "Project Planning and
Tracking - KPI Analysis Tab" on page 306.
Project Planning and Tracking - General Tab
This tab enables you to customize the properties of a selected KPI type.
HP ALM (12.50)
Page 303
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
To access
In Project Customization, in the left pane, click Project Planning and Tracking. Select a KPI type. The KPI
properties are displayed in the General tab.
Important
information
ALM Editions: The Project Planning and Tracking tab is available only for ALM Edition. For
more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
General Area
User interface elements are described below:
UI Elements
Description
Name
The name of the selected KPI.
Entity Type
The entity type of the selected KPI. Possible values are Requirement , Test , Test Instance, and Defect .
Description
The description of the selected KPI.
Threshold Settings Area
User interface elements are described below:
UI Elements
Description
KPI is better
when values
are
The expected growth direction of the values of the selected KPI. The higher or lower the value, the better it
is.
Default value: Higher
A value greater than the specified amount indicates a good KPI state.
Default
Threshold OK
Above/Below
Warning
Range
A percentage value relevant to the OK Above/Below threshold. If a KPI is better when a value is higher and
the OK Above threshold is set to 100, and the warning range is set to 10%, then any value between 90 and
100 will trigger a warning. Any value below 90 indicates a bad KPI state.
Measurement Area
This area enables you to define how to measure the KPI values.
Important
When defining the properties for the Percentage measurement type, the Measure percentage of section
information indicates the numerator to be used for percentage calculations. The Out of section indicates the denominator
to be used for percentage calculations.
User interface elements are described below:
UI Elements
Description
Measurement
The method of measurement.
HP ALM (12.50)
Page 304
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
UI Elements
Description
Type
Function
Measured
Entities
Indicates one of the following:
l
Count. Counts the number of entities.
l
Sum values of field. Totals the values of a specified field for all the entities.
Enables you to filter on entities of the type specified for the selected KPI:
l
Set Filter/Sort. Opens the Filter dialog box enabling you to define a filter. For more details, see
the HP Application Lifecycle Management User Guide .
l
Consider
Transitions
Clear Filter. Clears the defined filter.
Enables the Configure button.
When transitions are configured, the KPI aggregates field changes instead of counting the changes.
Opens the Configure Transitions dialog box, enabling you to define how field changes are counted when
measuring KPI values. For more details, see "Configure Transitions Dialog Box" below.
Configure Transitions Dialog Box
This dialog box enables you to define how field changes are aggregated when measuring KPI values.
To access
In Project Customization, in the left pane, click Project Planning and Tracking. Select a KPI type. In the
General tab, select Consider Transitions and click the Configure button.
Important
information
ALM Editions: The Project Planning and Tracking tab is available only for ALM Edition. For
more information about ALM editions and their functionality, see the HP Application
HP ALM (12.50)
Page 305
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
Lifecycle Management User Guide.
User interface elements are described below:
UI Elements
Description
Measure changes in
field
Indicates the field used for aggregating field value changes.
When value changes
from
Aggregates when the value changes from the specified field value.
When value changes
to
Aggregates when the value changes to the specified field value.
The value $ANY aggregates irrespective of the currently displayed value.
$ANY aggregates irrespective of the currently displayed value.
Opens the Measure Values dialog box, enabling you to select the values to be used when measuring
changes.
Accumulate changes
Enables you to aggregate changes on a daily basis; for the duration of a milestone; or for the
duration of a release.
Project Planning and Tracking - KPI Analysis Tab
This tab enables you to define two additional breakdown graphs for inclusion in the KPI Drilldown graph.
For more details, see the HP Application Lifecycle Management User Guide.
To access
In Project Customization, in the left pane, click Project Planning and Tracking. Select a KPI and click the KPI
Analysis tab.
HP ALM (12.50)
Page 306
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
Important
information
ALM Editions: The Project Planning and Tracking tab is available only for ALM Edition. For
more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
User interface elements are described below:
UI Elements
Description
Graph
1/Graph 2
Enables/disables the graph.
Name
The name of the graph.
Function
Choose one of the following:
Measured
Entities
l
Count. Counts the number of entities.
l
Sum values of field. Totals the values of a specified field for all the entities.
Enables you to filter on entities of the type specified for the selected KPI:
l
Set Filter/Sort. Opens the Filter dialog box enabling you to define a filter. For more details, see the
HP Application Lifecycle Management User Guide .
l
Group By
Clear Filter. Clears the defined filter.
Determines the fields by which ALM groups data in the graph.
Bar/Pie/Grid Indicates the type of graph.
HP ALM (12.50)
Page 307
Administrator Guide
Chapter 23: Customizing Project Planning and Tracking KPIs
HP ALM (12.50)
Page 308
Chapter 24: Project Report Templates
Project report templates determine the layout and style in which data is displayed in project reports.
For more details on project reports, refer to the HP Application Lifecycle Management User Guide.
This chapter includes:
•
•
•
About Project Report Templates
310
Managing Project Report Templates
310
Designing Report Templates
314
HP ALM (12.50)
Page 309
Administrator Guide
Chapter 24: Project Report Templates
About Project Report Templates
Project report templates are Microsoft Word files that determine the design of project reports. Users
assign templates to project reports in the Analysis View module.
In the Project Report Templates page, as a project administrator, you manage report templates that
are available to all project users.
Note:
l
Depending on permissions, users can create and use custom report templates, in addition to
the project report templates. For more information on custom templates, refer to the HP
Application Lifecycle Management User Guide.
l
Template fonts need to be installed on the client machine of the user generating the report
in order for them to be properly visible in the generated document.
There are various types of templates that affect different aspects of template reports:
Template
Type
Description
Document Define the outline of the report layout. For example, a document template dictates the design of the title page,
Templates whether the report includes a table of contents, page orientation, page numbering, and more.
Define the formatting (for example, tables, section headings, paragraphs) applied to Microsoft Word styles.
Style
Templates
Define the format in which history information is displayed in report sections.
History
Templates
Define the fields that are included in report sections, and the format in which they are displayed. Section
Section
Templates templates are defined separately for each ALM entity.
Predefined templates are provided for each of the template types.
For more information on managing project report templates in Project Customization, see "Managing
Project Report Templates" below.
You design report templates in Microsoft Word using the Template Creator. For more information, see
"Designing Report Templates" on page 314.
Managing Project Report Templates
As an ALM project administrator, you manage the templates that are available to project users for
creating project reports.
HP ALM (12.50)
Page 310
Administrator Guide
Chapter 24: Project Report Templates
This section includes:
•
•
•
•
Creating a New Report Template
312
Editing a Report Template
313
Duplicating a Report Template
313
Deleting a Report Template
313
HP ALM (12.50)
Page 311
Administrator Guide
Chapter 24: Project Report Templates
Creating a New Report Template
You can create a new report template, and make it available for users to assign to project reports.
To create a new report template:
1. In Project Customization, in the left pane, click Project Report Templates. The Project Report
Template page opens.
2. In the templates tree, select a template type or category of the template you want to create.
3. Click the downward arrow on the Template Creator button, and select one of the following:
l
l
Create From Default Style Template. Creates a template file using the default style template.
This is the default option if you click the button.
Create From Style Template. Creates a template file using a selected style template.
4. Design a new template file in Microsoft Word using the Template Creator tab. For details on
designing template files, see "Designing Report Templates" on page 314.
5. Save and close the file.
6. In Project Customization, in the left pane, click Project Report Templates, and select a template
category.
7. Click Add Template, and select the template file that you created. The following fields are
displayed for the project report template:
UI Elements
Description
Name
The name of the project report template.
Last Modified By
The name of the ALM user who last made changes to the project report template.
File Modified Date The date and time on which changes were last made to the project report template.
Type
HP ALM (12.50)
Indicates whether the project report template is a full page or tabular template.
Page 312
Administrator Guide
Chapter 24: Project Report Templates
UI Elements
Description
Full Page. Defines the layout of ALM entity records on a page.
Tabular. Defines the layout of ALM entity records in a table.
8. To set the new template as the default template for the category, select Default <Category>
Report Template. When a user adds a section to a report, the default project template for the
entity is initially selected.
Editing a Report Template
You can make changes to an existing report template.
To edit a report template:
1. In Project Customization, in the left pane, click Project Report Templates.
2. Select the template you want to edit, and click Download Template. A copy of the template file is
saved on your computer file system, and the file opens in Microsoft Word.
3. Edit the template using the Template Creator tab. For details on designing template files, see
"Designing Report Templates" on the next page.
4. Save and close the template file.
5. In Project Customization, select the template, and click Upload Template.
6. Select the template file on your computer file system.
Duplicating a Report Template
You can create a duplicate of a report template, and modify the duplicate template.
To duplicate a template:
1. In Project Customization, in the left pane, click Project Report Templates.
2. Select the template you want to duplicate, and click Duplicate.
3. To edit the duplicated template, see "Editing a Report Template" above.
4. To set the new template as the default template for the category, select Default <Category>
Report Template.
Deleting a Report Template
You can delete a report template.
Note: You cannot delete a template that is set as the default template in its category, or that is
being used by one or more project reports.
To delete a template:
HP ALM (12.50)
Page 313
Administrator Guide
Chapter 24: Project Report Templates
1. In Project Customization, in the left pane, click Project Report Templates.
2. Select the template you want to delete, and click Delete.
Designing Report Templates
Report templates are Microsoft Word files that contain the outline of report sections.
Note: Complete examples of report templates are provided in Project Customization. For more
information, see "Managing Project Report Templates" on page 310.
This section includes:
•
•
•
•
•
•
•
About Designing Report Templates
315
Designing Document Templates
315
Designing Style Templates
316
Designing History Templates
316
Designing Section Templates
318
Guidelines for Creating Full-Page and Tabular Templates
320
Template Creator Tab
321
HP ALM (12.50)
Page 314
Administrator Guide
Chapter 24: Project Report Templates
About Designing Report Templates
You design report template files in Microsoft Word. Document, history, and section templates are
created using the Template Creator tab in Microsoft Word.
With the template creator, you select and arrange merge fields in a Microsoft Word document. Merge
fields represent ALM field labels and values, or contain instructions for building the report. When you
generate a report, the merge fields in the report templates are replaced by actual data.
For details on the template creator options, see "Template Creator Tab" on page 321.
Note: To enable the template creator:
l
Microsoft Office 2010 (32 bit) or Microsoft Office 2013 (32 bit) must be installed on your
machine.
l
You must allow macros in Microsoft Word. In Word, click the Office Button, and then click
Word Options. Select Trust Center > Trust Center Settings > Macro Settings. Select Enable
all macros.
Designing Document Templates
In Document template files you define the outline of the report layout. For example, a Document
template dictates the design of the title page, whether the report includes a table of contents, page
orientation, page numbering, and more. You design document templates using the Template Creator
tab in Microsoft Word.
The following elements are used in Document templates:
l
l
l
l
l
ReportName. A merge field that is replaced in reports by the value of the report's Name field.
Custom fields. Merge fields that represent information you want users to include in reports, for
example Author, Project. You can use any string as a custom field. Users type actual values for
custom fields when configuring project reports.
DocumentData. A merge field that marks the point at which the report sections begin.
Document design. Document formatting that you define in a Document template is used in project
reports that use the Document template. This includes headers and footers, page numbers, and
page layout.
Fixed text. Fixed text that you type in a Document template is displayed in reports. For example,
type your organization name on the cover page, or type Created by: before the custom field
Author.
To design a new Document template:
1. Create a new template file using the template creator in Microsoft Word. For more information on
accessing the template creator, see "Template Creator Tab" on page 321.
HP ALM (12.50)
Page 315
Administrator Guide
Chapter 24: Project Report Templates
2. Click Template Type
, and select Document.
3. To include the report name, click Insert Field Value
, and select ReportName. The
ReportName tag retrieves the report name from the Name field of the template based report.
4. To include customized information in areas such as the title page, headers and footers, click Insert
Custom Field
. In the Custom Field dialog box, enter a custom field name (for example,
Author). When you create a report, you enter actual values that are displayed on the report cover
page.
Repeat the step to include additional custom fields.
5. Design the document with elements such as headers, footers, and page numbers.
6. Place the cursor at the point at which report data should begin, click Insert Field Value
select DocumentData.
, and
Designing Style Templates
In Style template files you define the formatting that is applied to Microsoft Word styles in all sections
of a report.
For example, in a Style template you define the formatting for the Normal style. As a result, text in
section templates that is assigned the Normal style, is displayed in the format you defined in the Style
template.
Style formatting that is defined in the Style template overrides the formatting defined in other
templates used in a project report.
Consider the following for designing Style templates:
l
l
l
Heading styles. The Heading 1, Heading 2, Heading n styles that you define in a Style template
are automatically applied to report sections according to the level of the section in the report. For
more details on applying heading styles in section templates, see "Designing Section Templates" on
page 318.
Table styles. To ensure a uniform style for all data tables displayed in a report, define the Project
Report Table Style. By default, tables you create in tabular templates use this style.
Text. Any text that you type in a Style template is ignored by project reports.
Designing History Templates
In History template files you define how history information is displayed in all report sections. You
design History templates using the Template Creator tab in Microsoft Word.
Notes:
HP ALM (12.50)
Page 316
Administrator Guide
Chapter 24: Project Report Templates
l
To display History information in project reports, section templates must include History
merge fields.
l
History templates can be only in tabular format. For more details, see "Guidelines for
Creating Full-Page and Tabular Templates" on page 320.
The following elements are used in History templates:
l
l
History fields. Merge fields that represent history field labels and values.
Fixed text. Fixed text that you type in a history template is displayed in reports. For example, type
History in a heading row above the history merge fields.
To design a new History template:
1. Create a new template file using the template creator in Microsoft Word. For more information on
accessing the template creator, see "Template Creator Tab" on page 321.
2. Click Template Type
3. Click Formatting
, and select History.
, and select Tabular, to create a tabular template.
The Select Fields dialog box opens.
4. To include a field in the template, select a field in the Available Fields pane, and click the right
arrow
HP ALM (12.50)
.
Page 317
Administrator Guide
Chapter 24: Project Report Templates
Tip: Use the CTRL or SHIFT key to select multiple fields.
5. To remove a field from the template, select a field in Selected Fields pane, and click the left arrow
.
6. To move all fields from one pane to the other, click the double arrows
.
7. Click the Reorder buttons to change the order of fields in the template.
8. Click Insert. The fields you selected are inserted in tabular layout.
Designing Section Templates
In section templates you define how information is displayed in report sections. You define separate
section templates for each ALM entity that can be included in report sections. You design section
templates using the Template Creator tab in Microsoft Word.
Note: Section templates can be in either a full-page or tabular format. For more information,
see "Guidelines for Creating Full-Page and Tabular Templates" on page 320.
The following elements are used in section templates:
l
Section Name. A merge field that is replaced in reports by the value of a section's Name field.
l
Section Filter. A merge field that displays the data filter applied to the report section.
l
Entity fields. Merge fields that represent entity field labels and values.
Note: Date and time fields are formatted using a SHORT DATE/TIME format associated with
the locale defined on the ALM server. The report designer cannot change these formats.
l
l
History. A merge field that inserts history information of the entity record. Use the merge field in
full-page templates, within the data area.
Graphs. A merge field that inserts graphs that have been added to the report. By default graphs are
added to the end of a report.
Note: You cannot include more than one graph field in the same template.
l
Fixed text. Fixed text that you type in a section template is displayed in reports.
To design a new section template:
1. Create a new template file using the template creator in Microsoft Word. For more information on
accessing the template creator, see "Template Creator Tab" on page 321.
HP ALM (12.50)
Page 318
Administrator Guide
Chapter 24: Project Report Templates
2. Click Template Type
3. Click Formatting
template.
, and select a section.
, and select either Full Page or Tabular, to create a full-page or a tabular
The Select Fields dialog box opens.
4. To include a field in the template, select a field in the Available Fields pane, and click the right
arrow
.
Tip: Use the CTRL or SHIFT key to select multiple fields.
5. To remove a field from the template, select a field in Selected Fields pane, and click the left arrow
.
6. To move all fields from one pane to the other, click the double arrows
.
7. Click the Reorder buttons to change the order of fields in the template.
8. Click Insert. The fields you selected are inserted in full-page or tabular layout.
9. To include history information of records in a full-page template, place the cursor before the
Data End tag, click Insert Field Value
, and select History.
Note: History information is displayed according to the History template assigned to the
HP ALM (12.50)
Page 319
Administrator Guide
Chapter 24: Project Report Templates
report.
10. To include the section name, or details of the section filter, click Insert Field Value
, and
select Section Name or Section Filter. Make sure these fields are placed outside the data area.
11. A section template can be used at any level of a report. To ensure that a section header displays in
a style appropriate to its level in the report, place the cursor on the Section Name merge field.
Make sure the Set Auto Heading Style button
is pressed.
12. To ensure that tables use the uniform table style defined in the Style template, place the cursor in
the table area. Make sure the Set Table Style button
is pressed.
Guidelines for Creating Full-Page and Tabular Templates
Section templates can be designed in either full-page or tabular formats.
Note: Templates should consist of only one Word section. Only those text and fields in the first
Word section are included in the generated report.
Full-page templates
In a full-page template, you arrange fields of an entity across several lines of a page. Typically, merge
fields of a field's label and value are displayed on the same line, separated by a colon or tab.
For example: Detected By Label : Detected By
In full page templates, the section of the template that is repeated for each record must be surrounded
by Data Start and Data End merge fields.
Example:
HP ALM (12.50)
Page 320
Administrator Guide
Chapter 24: Project Report Templates
Tabular templates
In a tabular template, you arrange fields of an entity in a two-row table. The top row of the table
contains merge fields of field labels. The bottom row of the table contains merge fields of the
corresponding field values.
In tabular templates, the first cell in the value row must begin with a Table Start merge field, and the
last cell in the value row must end with a Table End merge field.
Example:
Template Creator Tab
The template creator enables you to design Document, History, and section templates in Microsoft
Word.
To access
You access the template creator either from Project Customization > Project Report Templates, or from
the project report Configuration tab.
l
l
To create a new template file, select a project report template or section, and click Template Creator .
Microsoft Word opens, and the applicable template type is selected in the Template Creator tab.
To edit an existing template file, select a project report template, and click Download Template
. The
template opens in Microsoft Word.
Important
To enable the template creator, you must first allow macros in Microsoft Word. In Word, click the Office
information Button, and then click Word Options. Select Trust Center > Trust Center Settings > Macro Settings.
Select Enable all macros.
See also
"Designing Report Templates" on page 314
User interface elements are described below:
UI
Description
Elements
Choose Template Type. Lists the template types that you can create in the template creator. The selected
template type is displayed in the button label, and determines the fields you can include in the template.
Formatting. Inserts selected fields in one of the following formats:
l
Full Page. Lists selected fields vertically across multiple lines. Field values are placed alongside their labels,
separated by a colon and tab.
l
HP ALM (12.50)
Tabular. Lists selected fields horizontally in a table. Field labels are listed in the top row of the table, and field
Page 321
Administrator Guide
Chapter 24: Project Report Templates
UI
Description
Elements
values are listed below them.
Insert Field Label. Inserts a selected field label at the cursor position.
Insert Field Value. Inserts a selected field value at the cursor position.
Insert Multiple Fields. Opens the Select Fields dialog box, enabling you to insert field labels and values at the
cursor location.
Note: The selected fields are inserted on separate lines.
Insert Custom Field. In a Document template, enables you to insert custom fields anywhere in the Document
template. For example, add custom fields to the document title page, and to document headers and footers.
When creating a report, users enter values that replace the custom fields in the report.
Set Auto Heading Style. Toggles the Template Report Auto Heading style to the selected paragraph. In
report sections based on the template, the style is automatically replaced by the Heading style appropriate to the
section level.
In full-page templates, you can apply the Template Report Auto Heading style both to the section heading
(before the Data Start merge field), and to the record heading. As a result, the section heading in a report is
displayed on a higher hierarchical level than the section records.
In tabular templates, you can apply the Template Report Auto Heading style only to the section heading.
Set Table Style. Toggles the Template Report Table style to the selected table.
Connect to ALM. Enables you to connect to a different ALM project. The template creator automatically retrieves
the entity fields from the selected project.
Localize Strings. Retrieves updated field labels from Project Customization.
HP ALM (12.50)
Page 322
Chapter 25: Business Views
This section describes how to create and manage business views, which can be used as a basis for ALM's
reporting tools.
This chapter includes:
•
•
•
•
Business Views Overview
324
Creating and Managing Business Views
324
Working with DQL
326
Business Views User Interface
340
HP ALM (12.50)
Page 323
Administrator Guide
Chapter 25: Business Views
Business Views Overview
Business views are a semantic data layer that can be used as a basis for the various HP Application
Lifecycle Management (ALM) reporting tools.
The views are based on project entities, and ensure that only information that is relevant to a business
consumer is revealed in a report. For example, you can select only those defect related entity fields that
represent some business value to a report consumer. You then create a unique view which can be used
and reused as a report basis.
For example, a business view based on Baselines could contain the Name, Description, and Baseline ID
fields. This is because these fields convey information that could be of importance to the graph
consumer who needs to understand baseline information from a business perspective only. By the same
logic, the same business view does not include the Attachment and Auto complete type fields, as they
are of little business significance.
Creating reports based on business views ensures standardization across the reports, as different
reports that are based on the same business view reflect a common frame of reference. This provides
genuine business value to the reports consumer, thereby making the reports more meaningful.
Note: Reports are generated according to the permission levels of the user generating them.
Therefore, information that is included in a business view that is not available to a user will not
appear in any report that user creates.
Business views can be based on a single project entity (for example, defects), or can represent more
complex relationships between several entities (for example, defects, requirements, and tests). ALM
provides a set of pre-defined business views that are available for selection.
Business views must be designed by a user who understands the business requirements of the
organization. In addition, the process of creating business views utilizes DQL, a domain query language
that is a flavor of ANSI SQL. It is important that the business view designer be able to understand DQL
queries. For more information on working with DQL, see "Working with DQL" on page 326.
Creating and Managing Business Views
This task describes how to create and manage business views.
To learn more about business views, see "Business Views Overview" above.
1. Open the Business Views page
a. On the ALM masthead, click
opens.
HP ALM (12.50)
, then select Customize. The Project Customization window
Page 324
Administrator Guide
Chapter 25: Business Views
b. In the Project Customization window, click the Business Views link. The Business Views page
opens. For user interface details, see "Business Views Page" on page 341.
2. Create an empty business view
On the Business Views page toolbar, click Add View. The New View dialog box opens. Enter a
technical name and label, and click OK.
3. Add project entities to the business view
a. On the Business Views page, if it is not selected, select the Query Designer tab.
b. On the Query Designer tab toolbar, click Add Entity. The Model tree opens in the right pane.
The Model tree displays all project entities and fields in the current project.
c. Select the entities you want to add to the new business view and drag them to the Main pane
in the middle of the Query Designer tab. For each project entity you add, a <project entity>
dialog box is added, displaying all available fields contained within the entity. You use the
checkboxes next to the field names to select specific fields to include in the view.
Note: By default, all fields are selected and the checkboxes are unchecked.
4. Define relationships between selected entities
You create relationships between selected entities in one of the following ways:
l
l
l
Select a <project entity> dialog box, and on the Query Designer tab toolbar click Add Related
Entity. The Add Related Entity dialog box opens. For user interface details, see "Add Related
Entity Dialog Box" on page 346.
When more than one entity has been selected, create the relationships manually by dragging a
field from one entity to another.
Enter the query directly in the DQL Query Builder.
5. Edit filter criteria - optional
You can edit and define filter criteria for selected fields in the selected fields grid below the Main
panel.
Tip: You can change a field's label using the Alias column of the selected fields grid.
6. Edit entity relationships - optional
To edit relationships between entities, double click on a relationship line. The Link Properties dialog
box opens. For user interface details, see "Link Properties Dialog Box" on page 345.
7. Validate the business view
On the Query Designer tab toolbar, click Validate. Any warning or error messages are shown in the
Query Results pane at the bottom of the Query Designer tab.
8. Preview the business view
On the Query Designer tab toolbar, click Preview. The Query Results pane opens at the bottom of
the Query Designer tab.
HP ALM (12.50)
Page 325
Administrator Guide
Chapter 25: Business Views
9. Update the business view status
On the Query Designer tab toolbar, click the Status arrow and select Published.
10. Save the business view
On the Business Views page toolbar, click Save.
Working with DQL
The process of creating business view queries utilizes DQL, a domain query language.
For the most part, DQL is an exact match to ANSI SQL 9.2, however there are some significant
differences.
Note: DQL only supports SELECT statements.
This section includes:
l
Advantages of DQL
l
Additions to SQL
l
Supported Functions
Advantages of DQL
Building queries with DQL has the following advantages:
l
l
l
DQL enforces data hiding in accordance with user's permission levels. In other words, reports are
generated according to the permission levels of the user generating them. Information that is
included in a business view that is not available to a user does not appear in any report that the user
creates.
The DQL query creates a database abstraction which is then used as a basis for the business view.
Since the basis of the view is an abstraction of the database and not the database itself, you do not
need to identify entity fields according to their actual names. Rather the query simplifies them and
makes them easier to identify. For example, all fields that relate to an object's identification appear
with the suffix "ID", such as Defect ID, Cycle ID, and Release ID.
DQL queries run equally well on Oracle and SQL database servers.
Additions to SQL
DQL provides the following options, which are not available in ANSI SQL:
l
Variables. Three variables have been added:
l
:me. Returns information relevant to the user creating the report. Meaning different users who
create reports based on the same business view will receive different results.
HP ALM (12.50)
Page 326
Administrator Guide
Chapter 25: Business Views
l
l
:current_project_name. Returns information relevant for the project from which the reports is
created.
:current_domain_name. Returns information relevant for the domain from which the report is
created.
Following is an example of the Me variable:
Select *
From defect
Where defect.detected_by = :me
l
Select Top. This option enables you to limit the query results to a defined number of items.
Supported Functions
The following table lists the DQL functions that are supported in ALM. DQL functions are converted to
the corresponding SQL functions for use in the database. The table lists the conversions of the
DQL functions to MS SQL and Oracle. For more information, refer to the MS SQL and Oracle
documentation.
Function
Signature
Return
Type
Description
count
count(expression)
integer
Returns the number of rows in a query.
count_big
count_big(expression)
integer
(bigint)
Returns the number of rows in a query. The only
Aggregation
difference between count and count_big is their return
values. In MS SQL, count_big always returns a bigint
data type value, and count always returns an int data
type value.
Note: In Oracle, the function is converted
to count.
variance
variance(decimal)
decimal
Returns the variance of the expression .
Note: In MS SQL, the function is converted
to var. In Oracle, the function is coded as
round(variance(<decimal>), 14).
var_pop
HP ALM (12.50)
var_pop(expression)
decimal
Returns the population variance of a set of numbers after
discarding the nulls in the set.
Page 327
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
Note: In MS SQL, the function is converted
to varp. In Oracle, the function is coded as
round(var_pop(<expression>), 14).
stddev
stddev(decimal)
decimal
Returns the standard deviation of a set of numbers.
Note: In MS SQL, the function is converted
to stdev. In Oracle, the function is coded as
round(stddev(<decimal>), 14).
stddev_pop
stddev_pop(expression)
decimal
Computes the population standard deviation and returns
the square root of the population variance.
Note: In MS SQL, the function is converted
to stdevp. In Oracle, the function is coded
as round(stddev_pop(<expression>), 14).
avg
avg(expression)
decimal
Returns the average value of an expression.
Note: In Oracle, the function is coded as
round(avg(<decimal>), 14).
sum
sum(decimal)
decimal
Returns the summed value of an expression.
min
min(expression)
expression
Returns the minimum value of an expression.
max
max(expression)
expression
Returns the maximum value of an expression.
upper
upper(string)
string
Returns the given string with all letters converted to
upper case.
lower
lower(string)
string
Returns the given string with all letters converted to
lower case.
rtrim
rtrim(string)
string
Returns the given string with all trailing spaces removed
from the right-hand side.
ltrim
ltrim(String)
string
Returns the given string with all leading spaces removed.
replace
replace(string, string_to_
replace, replacement_
string)
string
Returns the given string with all sequences of <string_
substring(string, int_
string
String Manipulation
substring
HP ALM (12.50)
to_replace> replaced with <replacement_string>.
Returns a substring from the given string.
Page 328
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
start_position, int_
length)
Description
l
int_start_position. The position from which to
start extracting the substring.
l
int_length. The number of characters to extract.
Note: In Oracle, the function is converted
to substr.
length
length(string)
decimal
Returns the length of the specified string.
Note: In MS SQL, the function is converted
to len.
chr
chr(integer)
string
Converts an int ASCII code into a character.
Note: In MS SQL, the function is converted
to char.
soundex
soundex(string)
string
Returns a phonetic representation of a string.
ascii
ascii(string)
integer
Returns the ASCII code value of the leftmost character of
a character expression.
concat
concat(string1, string2)
string
Concatenates two strings together .
Note: In MS SQL, the function is converted
to +, and the function is coded as <string1>
+ <string2>.
leftstr
leftstr(string, integer)
string
Returns the left part of a character string with the
specified number of characters.
Note: In MS SQL, the function is converted
to left. In Oracle, the function is converted
to substr and is coded as substr(<string>,
1, <integer>).
lpad
HP ALM (12.50)
lpad(string1, integer,
string2)
string
Returns <string1>, left-padded to length <integer>
characters with the sequence of characters in <string2>.
This function is useful for formatting the output of a
query.
Page 329
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
Note: In MS SQL, the function is converted
to the left padding expression, which
implements the above logic.
reverse
reverse(string)
string
Returns the reverse of a string value.
Note: In Oracle, the function is coded as
reverse(to_char(<string>)).
rightstr
rightstr(string, integer)
string
Returns the right part of a character string with the
specified number of characters.
Note: In MS SQL, the function is converted
to right. In Oracle, the function is
converted to substr with the right part
expression, which implements the above
logic.
rpad
rpad(string1, integer,
string2)
string
Returns <string1>, right-padded to length <integer>
characters with <string2>, replicated as many times as
necessary. This function is useful for formatting the
output of a query.
Note: In MS SQL, the function is converted
to left with the right padding expression,
which implements the above logic.
stuff
stuff(string, integer,
integer, string)
string
Inserts a string into another string. It deletes a specified
length of characters in the first string at the start
position, and then inserts the second string into the first
string at the start position.
Note: In Oracle, the stuff function is
converted to an expression that
implements the above logic.
in_string
HP ALM (12.50)
in_string(string1,
string2, integer_start_
location)
integer
Returns the location of substring string2 in string1, if it
exists. Otherwise, returns 0. The search starts at
integer_start_location, which starts at 1.
Page 330
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
Note: In MS SQL, the function is converted
to charindex. In Oracle, the function is
converted to instr and is coded as instr
(<string2>, <string1>, <integer_start_
location>).
replicate
replicate(string, integer)
string
Repeats the <string> value the number of times given in
the <integer> parameter.
Note: In Oracle, the function is converted
to rpad and is coded as rpad(<string>,
length(<string>*<integer>), <string>).
Math
sin
sin(decimal)
decimal
Returns the sine of the decimal parameter.
Note: In Oracle, the function is coded as
round(sin(<decimal>), 14).
asin
asin(decimal)
decimal
Returns the arc sine of the decimal parameter. The
argument must be in the range of -1 to 1.
Note: In Oracle, the function is coded as
round(asin(<decimal>), 14).
cos
cos(decimal)
decimal
Returns the cosine of the decimal parameter.
Note: In Oracle, the function is coded as
round(cos(<decimal>), 14).
acos
acos(decimal)
decimal
Returns the arc cosine of the decimal parameter. The
argument must be in the range of -1 to 1.
Note: In Oracle, the function is coded as
round(acos(<decimal>), 14).
tan
HP ALM (12.50)
tan(decimal)
decimal
Returns the tangent of the decimal parameter.
Page 331
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
Note: In Oracle, the function is coded as
round(tan(<decimal>), 14).
atan
atan(decimal)
decimal
Returns the arc tangent of the decimal parameter.
Note: In Oracle, the function is coded as
round(atan(<decimal>), 14).
atan2
atan2(decimal1,
decimal2)
decimal
Returns the angle, in radians, between the positive x-axis
and the ray from the origin to the point (y, x), where x and
y are the values of decimal1 and decimal2.
Note: In MS SQL, the function is converted
to atn2. In Oracle, the function is coded as
round(atan2(<decimal1>), 14).
tanh
tanh(decimal)
decimal
Returns the hyperbolic tangent of the decimal
parameter.
Note: In MS SQL, the function is converted
to the tanh expression, which implements
the above logic. In Oracle, the function is
coded as round(tanh(<decimal>), 14).
sqrt
sqrt(decimal)
decimal
Returns the square root of decimal parameters.
Note: In Oracle, the function is coded as
round(sqrt(<decimal>), 14).
exp
exp(decimal)
decimal
Returns e raised to the decimal parameter power, where
e = 2.71828183.
Note: In Oracle, the function is coded as
round(exp(<decimal>), 14).
sign
sign(decimal)
decimal
Returns a value indicating the sign of a number. If the
number < 0, then sign returns -1. If the number = 0, then
sign returns 0. If the number > 0, then sign returns 1.
HP ALM (12.50)
Page 332
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
Note: In MS SQL, the function is converted
to the sign expression, which implements
the above logic, and is coded as CAST(sign
(<decimal>) AS int).
floor
floor(decimal)
integer
Returns the largest integer less than or equal to the
specified decimal argument.
ln
ln(decimal)
decimal
Returns the natural logarithm of the decimal argument.
Note: In MS SQL, the function is converted
to log. In Oracle, the function is coded as
round(ln(<decimal>), 14).
abs
abs(decimal)
decimal
Returns the absolute value of a number.
round
round(decimal, integer)
decimal
Returns decimal rounded to integer places to the right
of the decimal point. The integer parameter can be
negative to round off digits left of the decimal point.
Note: In MS SQL, the function is coded as
CAST(round(<decimal>, <integer>) AS int)
or as CAST(round(<decimal>, <integer>)
AS float), depending on whether integer is
valued with zero.
mod
mod(decimal1, decimal2)
decimal
Returns the remainder of decimal1 divided by
decimal2.
Note: In MS SQL, the function is converted
to % and is coded as <decimal1> %
<decimal2>.
trunc_number
trunc_number(decimal,
integer)
decimal
Returns decimal truncated to integer decimal places. If
integer is omitted, then decimal is truncated to 0
places.
Note: In MS SQL, the function is converted
to the truncation expression, which
implements the above logic. In Oracle, the
HP ALM (12.50)
Page 333
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
function is converted to trunc.
str
str(decimal, integer1,
integer2)
string
Returns character data converted from numeric data.
Note: In Oracle, the function is converted
to the string construction expression,
which implements the above logic.
ceil
ceil(decimal)
decimal
Returns the smallest integer greater than or equal to the
decimal parameter.
Note: In MS SQL, the function is converted
to ceiling.
Cast
to_number
to_number(string)
decimal
Converts a string to a number.
Note: In MS SQL, the function is coded as
CAST(<string> AS float).
number_to_char
number_to_char
(decimal)
string
Converts a number to a string.
Note: In MS SQL, the function is coded as
CAST(<decimal> AS varchar(50)). In
Oracle, the function is converted to to_
char.
char_to_char
char_to_char(string)
string
Converts NCHAR, NVARCHAR2, CLOB, or NCLOB data to
the database character set.
Note: In MS SQL, the function is coded as
CAST(<string> AS varchar(50)). In Oracle,
the function is converted to to_char.
datetime_to_char
datetime_to_char
(expression)
string
Converts a date or datetime to a string.
Note: In MS SQL, the function is coded as
HP ALM (12.50)
Page 334
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
convert(varchar, <date>, 121). In Oracle,
the function is converted to to_char and is
coded as to_char(<date>, 'YYYY-MM-DD
HH24:MI:SS:FF3').
Miscellaneous
nullif
nullif(expression1,
expression2)
expression
Compares expression1 and expression2. If
coalesce
coalesce()
expression
Returns the first non-null expression among its
arguments. The data type of the returned value is the
data type of the parameter with the highest data type
precedence.
isnull
isnull(check_expression,
replace_expression)
expression
Substitutes a value when a null value is encountered. If
expression1 and expression2 are equal, the function
returns NULL. Otherwise, it returns expression1.
check_expression is null, then the function returns
replace_expression.
Note: In Oracle, the function is converted
to nvl.
Date
currentdate
currentdate()
date
Returns the current date.
Note: In MS SQL, the function is coded as
CAST(CAST(getdate() AS date) AS
datetime). In Oracle, the function is coded
as to_date(to_char(sysdate)).
dateadd
dateadd(integer, date)
date
Adds days to date parameters:
l
l
integer . The numbers of days to add.
date. The date to add to.
Note: In MS SQL, the function is coded as
dateadd(DAY, <int days>, <Date date>). In
Oracle, the function is converted to + and is
coded as <int days> + <Date date>.
datediff
HP ALM (12.50)
datediff(start_date, end_
integer
Returns the count (signed integer) of dates crossed
Page 335
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
date)
Description
between the specified start_date and end_date.
Note: In MS SQL, the function is coded as
datediff(DAY, <date>, <date>). In Oracle,
the function is converted to - and is coded
as trunc(<date> - <date>, 0).
get_time
get_time()
datetime
Returns the current date and time.
Note: In MS SQL, the function is converted
to getdate and is coded as convert
(datetime, getdate(), 126). In Oracle, the
function is converted to
LOCALTIMESTAMP.
trunc_date
trunc_date(date, string_
format)
date
Returns a date truncated to a specific unit of measure.
string_format is the unit of measure to apply for
truncating. The following formats are supported: year, y,
yy, yyyy, q, quarter, mm, month, d, dd, day, hh, mi
Note: In MS SQL, the function is converted
to dateadd and is coded as dateadd
(<unquoted string_format>, datediff
(<unquoted string_format>, 0, <date>),
0). In Oracle, the function is converted to
trunc and is coded as trunc(<date>,
<string_format>.
to_date
to_date(string)
date
Converts a string to a date.
Note: In MS SQL, the function is coded as
CAST(<string> AS datetime). In Oracle, the
function is coded as to_date(<string>,
'YYYY-MM-DD').
timestamp_tz
timestamp_tz()
string
Returns the current server time zone .
Note: In MS SQL, the function is converted
HP ALM (12.50)
Page 336
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
to sysdatetimeoffset. In Oracle, the
function is converted to CURRENT_
TIMESTAMP. This function is not supported
in MS SQL Server 2005.
from_tz
from_tz(date, string)
date
Converts a timestamp value (date)and a time zone
(string)to a timestamp with time zone value.
Note: In MS SQL, the function is converted
to the time stamp and zone expressions,
which implement the above logic. This
function is not supported in MS SQL Server
2005.
sysdatetimeoffset
sysdatetimeoffset()
datetime
with time
zone
Returns the system date, including fractional seconds,
and the time zone of the system on which the database
resides.
Note: In Oracle, the function is converted
to SYSTIMESTAMP. This function is not
supported in MS SQL Server 2005.
getyear
getyear(date)
integer
Returns an integer that represents the year of the
specified date.
Note: In MS SQL, the function is converted
to year. In Oracle, the function is converted
to to_char and is coded as CAST(to_char
(<date>, 'yyyy') AS number).
getmonth
getmonth(date)
integer
Returns an integer that represents the month of the
specified date.
Note: In MS SQL, the function is converted
to month. In Oracle, the function is
converted to to_char and is coded as CAST
(to_char(<date>, 'mm') AS number).
getday
HP ALM (12.50)
getday(date)
integer
Returns an integer representing the day of the month of
Page 337
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
the specified date.
Note: In MS SQL, the function is converted
to day. In Oracle, the function is converted
to to_char and is coded as CAST(to_char
(<date>, 'dd') AS number).
datepart
datepart(string_datepart,
date)
integer
Returns an integer that represents the specified string_
datepart of the specified date.
Note: In MS SQL, the function is coded as
datepart(<unquoted string_datepart>,
<date>). In Oracle, the function is
converted to the datepart expression,
which implements the above logic.
datename
datename(string_
datepart, date)
string
Returns a character string that represents the specified
string_datepart of the specified date. The following
formats are supported: yyyy, yy, year, q, quarter, m,
month, d, dd, day, hh, mi
Note: In MS SQL, the function is coded as
datename(<unquoted string_datepart>,
<date>). In Oracle, the function is
converted to the datename expression,
which implements the above logic.
Case
decode
decode(expression,
search, result [, search,
result]... [, default] )
expression
Das the functionality of an IF-THEN-ELSE statement.
Compares the expression to each search value one by
one. If the expression is equal to a search, then an Oracle
Database returns the corresponding result. If no match
is found, then Oracle returns default . If default is
omitted, then Oracle returns null .
Note: In MS SQL, the function is converted
to the case-when-else expression, which
implements the above logic.
greatest
HP ALM (12.50)
greatest()
expression
Returns the greatest of the list of parameters.
Page 338
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
Note: In MS SQL, the function is converted
to the greatest expression, which
implements the above logic.
least
least()
expression
Returns the least of the list of parameters.
Note: In MS SQL, the function is converted
to the least expression, which implements
the above logic.
Special Date
Note: For each function, the requested date is returned in the respective date format. In MS SQL, the
requested date in yyyy-MM-dd format is cast as datetime. In Oracle, to_date(<requested date in dd-MMMyy format>, DD-MON-YY)
firstDayOfCurrentMonth
firstDayOfCurrentMonth
()
date
Returns the date of the first day of the current month.
firstDayOfCurrentWeek
firstDayOfCurrentWeek()
date
Returns the date of the first day of the current week.
firstDayOfCurrentYear
firstDayOfCurrentYear()
date
Returns the date of the first day of the current year.
firstDayOfNextMonth
firstDayOfNextMonth()
date
Returns the date of the first day of the next month.
firstDayOfNextWeek
firstDayOfNextWeek()
date
Returns the date of the first day of the next week.
firstDayOfNextYear
firstDayOfNextYear()
date
Returns the date of the first day of the next year.
firstDayOfPreviousMonth
firstDayOfPreviousMonth
()
date
Returns the date of the first day of the previous month.
firstDayOfPreviousWeek
firstDayOfPreviousWeek() date
Returns the date of the first day of the previous week.
firstDayOfPreviousYear
firstDayOfPreviousYear()
date
Returns the date of the first day of the previous year.
lastDayOfCurrentMonth
lastDayOfCurrentMonth()
date
Returns the date of the last day of the current month.
lastDayOfCurrentWeek
lastDayOfCurrentWeek()
date
Returns the date of the last day of the current week.
lastDayOfCurrentYear
lastDayOfCurrentYear()
date
Returns the date of the last day of the current year.
lastDayOfNextMonth
lastDayOfNextMonth()
date
Returns the date of the last day of the next month.
lastDayOfNextWeek
lastDayOfNextWeek()
date
Returns the date of the last day of the next week.
lastDayOfNextYear
lastDayOfNextYear()
date
Returns the date of the last day of the next year.
HP ALM (12.50)
Page 339
Administrator Guide
Chapter 25: Business Views
Function
Signature
Return
Type
Description
lastDayOfPreviousMonth
lastDayOfPreviousMonth
()
date
Returns the date of the last day of the previous month.
lastDayOfPreviousWeek
lastDayOfPreviousWeek()
date
Returns the date of the last day of the previous week.
lastDayOfPreviousYear
lastDayOfPreviousYear()
date
Returns the date of the last day of the previous year.
Business Views User Interface
This section includes:
•
•
•
Business Views Page
341
Link Properties Dialog Box
345
Add Related Entity Dialog Box
346
HP ALM (12.50)
Page 340
Administrator Guide
Chapter 25: Business Views
Business Views Page
The Business Views page enables you to create and manage business views.
To access
1. On the masthead, click
, then select Customize. The Project Customization page
opens.
2. In the Project Customization window, in the left pane, click Business Views.
See also
"Creating and Managing Business Views" on page 324
Business Views Page Common Elements
User interface elements are described below:
UI Element
Description
Saves changes made in the Business Views page.
Opens the New View dialog box. Enter the following information:
l
Label. The name of the view which is used for identification purposes only. For example, in the
Views tree, and when selecting views in the Analysis View module, views are listed according to
their labels. You can change the label in the selected fields grid. For more information, see
"<selected fields grid>" on page 344.
l
Technical name. The name of the view which is used as part of the DQL query. The name cannot
contain spaces.
Click OK. The view is added to the Views tree.
Duplicates the selected view. The duplicated view is added to the Views tree.
HP ALM (12.50)
Page 341
Administrator Guide
Chapter 25: Business Views
UI Element
Description
Deletes the selected view.
Note: You will no longer be able to view reports or graphs based on the deleted
view.
Validates all views.
Opens the Save As dialog box, enabling you to save the selected view as an .xml file.
Tip: To select multiple views, press the CTRL key and select the desired views.
Opens the Open dialog box enabling you to import views.
Note: By default, imported views are not valid.
Views tree
Displays pre-defined as well as user-defined views. The icon next to the view's name indicates the
view's status.
l
The view is valid and is published.
l
The view is valid and is not published.
l
The view is not valid.
Note: Views are listed alphabetically according to their labels. Place the cursor
over the label to view a tooltip displaying the view's technical name.
Query Designer tab
This tab enables you to customize business views.
User interface details are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
Determines the view of the Query Designer tab. Click the arrow to select the desired
view:
l
QBE Only. Hides the DQL Query Builder .
l
DQL Only. Displays only the DQL Query Builder .
l
QBE and DQL. Displays the entire Query Designer tab. This is the default view.
Opens the Model pane on the right of the tab, enabling you to select project entities to
add to a view. For more information, see Model pane.
HP ALM (12.50)
Page 342
Administrator Guide
Chapter 25: Business Views
UI Element
Description
Opens the Add Related Entity dialog box, enabling you to define joins between selected
entities.
For user interface details, see "Add Related Entity Dialog Box" on page 346.
Opens the Query Results pane at the bottom of the tab. For more information, see
Query Results pane.
Validates the selected view. The following checks are performed:
l
That the DQL syntax is correct.
l
That the query contains only fields from selected entities.
Defines whether the selected view is available for use in reporting.
l
Published. The view is available.
l
Not Published. the view is not available.
Note:
l
When changing a view from Not Published to Published, ALM first
validates the view before changing the status.
l
When changing a view from Published to Not Published, you will
no longer be able to view reports or graphs based on that view.
Opens the SQL Query dialog box which displays the SQL query which is run against the
database server.
Invalid views. The Messages tab displays details about problems with the view. Place
the cursor over the message text to view a tooltip displaying the full message.
Main pane
Displays a <Project entity> dialog box for every entity that has been added to the view,
as well as defined relationships between entities.
l
For more information about the <Project entity> dialog box, see <Project_entity>_
dialog_box.
l
For information about defining relationships between entities, see "Creating and
Managing Business Views" on page 324
<project entity> dialog box
Appears in the Main pane after you add a project entity to the view. The dialog box
displays all available fields within the entity. Use the checkboxes to select fields to add
to the view.
Default: All fields all included in the view. The checkboxes appear unchecked.
Model pane
Displays available project entities.
To add an entity to the view, select it and click the Add button
. Alternatively, you
can add entities by dragging them to the Main pane.
HP ALM (12.50)
Page 343
Administrator Guide
Chapter 25: Business Views
UI Element
Description
Note: Entities are listed alphabetically according to their Labels, with
their technical names in brackets.
<selected fields grid>
Enables you to define filter criteria for entity fields.
To add a field to the grid, in the <project entity> dialog box in the Main pane, use the
checkboxes to select the desired fields.
Tip: You can use the Alias column to change a field's label.
Note: You cannot change a label for a field in a sub-entity.
Displays the business view query.
DQL Query Builder
The query updates automatically as you add entities and define relationships.
You can create and edit a view by entering the query directly in the DQL Query Builder.
For more information about working with DQL, see "Working with DQL" on page 326.
Query Results pane
Appears when you click Preview on the Query Designer tab toolbar. Displays the
following information:
l
Query Results. Valid views only. Displays a preview of the view.
l
Query Messages. Invalid views only. Displays messages detailing problems with
the view. Place the cursor over the message text to view a tooltip displaying the full
message.
Details Tab
This tab enables you to view or edit the selected view's details.
User interface details are described below:
UI Element
Description
Label
The name of the view which is used for identification purposes only. For example, in the Views tree, and when
selecting views in the Analysis View module, views are listed according to their labels.
Tip: You can change the label in the selected fields grid. For more information, see
"<selected fields grid>" above.
Technical
name
The name of the view which is used as part of the DQL query.
Note: The technical name cannot contain spaces.
HP ALM (12.50)
Page 344
Administrator Guide
Chapter 25: Business Views
UI Element
Description
Description A description of the view. Click in the text box to display a toolbar for formatting and spell checking the text.
tab
Query Messages Tab
This tab enables you to view messages detailing problems with the view.
User interface details are described below:
UI
Description
Element
Message The severity of the error.
Severity
Note: Business views with warning messages can be published. Business views with errors
cannot be published. Some business views with warning messages can cause the business view
reports not to be generated. For example, a business view created with duplicate fields or
aliases generates a warning message, but no report is generated from this business view.
Message The full error message.
Text
Link Properties Dialog Box
The Link Properties dialog box enables you to edit relationships between entities.
To access Double-click a relation line between two related entities.
See also
HP ALM (12.50)
"Creating and Managing Business Views" on page 324
Page 345
Administrator Guide
Chapter 25: Business Views
User interface elements are described below.
UI Element
Description
Left/Right Object
Displays the technical names of the joined entities.
Select all from left/right Use the checkboxes to define if the relationship contains inner, left, right, or outer joins.
Join expression
Enables you to edit the join expression.
Add Related Entity Dialog Box
The Add Related Entity dialog box enables you to define joins between project entities. The dialog box
enables you to select from all entities related to the source entity.
To
Access
l
In the Query Designer tab Main pane, select a <project entity> dialog box and on the toolbar, click Add Related
Entity.
l
Opens automatically when you add an entity to the view that already has a defined relationship with another
entity in the view.
See Also "Creating and Managing Business Views" on page 324
User interface elements are described below:
UI
Element
Description
Source
Entity
The currently selected entity.
Target
Entity
Displays a drop-down list enabling you to select an available target entity. For each available entity, the entity label
appears, with its technical name in brackets.
Relation
Name
Displays the relation name given the source and target entities. If more than one relation name exists, you can
choose the desired name from the drop-down list.
HP ALM (12.50)
Page 346
Chapter 26: Configuring Business Process
Testing
This chapter describes how to configure Business Process Testing for working with business
components in HP Application Lifecycle Management (ALM).
This chapter includes:
•
•
About Configuring Business Process Testing
348
Business Process Test Page
348
HP ALM (12.50)
Page 347
Administrator Guide
Chapter 26: Configuring Business Process Testing
About Configuring Business Process Testing
You can set additional Business Process Testing options, such as automatic creation of manual design
steps as business components are created.
For more information on working with Business Process Testing in ALM, refer to the HP Business Process
Testing User Guide.
Available in ALM 12.21: As a project administrator, you can enable BPT Packaged Apps Kit features,
such as:
l
Learning tests and flows
l
Detecting changes in your application
Business Process Test Page
The Business Process Test customization page enables the project administrator to customize Business
Process Testing.
Available in ALM 12.21: You can also customize BPT Packaged Apps Kit on this page.
To access
On the ALM masthead, click
, then select Customize. Select the Business Process Test sidebar
entry.
Relevant tasks HP Business Process Testing User Guide
Available in ALM 12.21:
l
HP Business Process Testing User Guide :
User interface elements are described below:
UI Element
Description
Enable BPT Packaged Apps Kit
Available in ALM 12.21: Enables you to use BPT Packaged Apps Kit features in ALM.
Automatically create new
component with manual
implementation
If checked, Business Process Testing assumes that new components should have a
manual implementation and automatically prepares them for the creation of manual
design steps when creating a business component.
Include component instance
iterations in the report
If checked, Business Process Testing project reports list entries for all the iterations of a
component.
If unchecked, Business Process Testing project reports list only one entry for each
component, regardless of the iterations.
Enable automatic promotion
when creating a business
component or flow parameter
HP ALM (12.50)
If checked, Business Process Testing gives you the option to automatically promote
parameters to the next level(s) when you add a parameter.
l
When adding a component parameter, the parameter is promoted to any flow or test
Page 348
Administrator Guide
Chapter 26: Configuring Business Process Testing
UI Element
Description
that contains the component.
l
When adding a flow parameter, the parameter is promoted to any test that contains
the flow.
If checked, Business Process Testing gives you the option to automatically delete the
Enable automatic deletion of
parameters from the next level(s) if the parameters are not used at those levels.
unused test/flow parameters
when deleting a parameter at a
lower level
Note: This has no impact on other parameters that happen not to be in
use. This affects only those parameters that were deleted at the
component or flow level.
Example
A parameter called LastLoginDate exists in a component called Login.
The Login component is contained within a flow called LoginToSystem
and a test called LoginToAllSystems and at some point, LastLoginDate
was promoted to the flow and test levels.
LastLoginDate is no longer needed. When you delete LastLoginDate
from the component, the parameter is also deleted from
LoginToSystem and LoginToAllSystems.
Set default On Failure behavior
to
Business Process Testing sets the default behavior when a component in a test script
fails to either: l
Continue. The business process test will run the next business component or flow if
a component fails. By default, this failure condition is defined for each component
when it is added to a test.
l
HP ALM (12.50)
End. The business process test run ends if a business component fails.
Page 349
Administrator Guide
Chapter 26: Configuring Business Process Testing
HP ALM (12.50)
Page 350
Chapter 27: Configuring Sprinter
This chapter describes how to configure HP Sprinter for running tests manually in HP Application
Lifecycle Management (ALM).
ALM Editions: Sprinter functionality is not available with Performance Center Edition. For more
information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
This chapter includes:
•
•
About Configuring Sprinter
352
Sprinter Page
352
HP ALM (12.50)
Page 351
Administrator Guide
Chapter 27: Configuring Sprinter
About Configuring Sprinter
As a project administrator, you can enable running tests manually in your project using Sprinter, using
Manual Runner, or both. By default, running tests manually is enabled for both Sprinter and Manual
Runner. You can also set additional options for working with Sprinter, such as default screen capture
functionality.
For more information on running tests manually in ALM, refer to the HP Application Lifecycle
Management User Guide. For full details on Sprinter, refer to the HP Sprinter User Guide, available from
the HP Application Lifecycle Management Add-ins page (Help > Add-ins).
Sprinter Page
This page enables you to activate or deactivate Sprinter features. Deactivated features are visible in
the Sprinter user interface, but are inactive.
HP ALM (12.50)
Page 352
Administrator Guide
Chapter 27: Configuring Sprinter
To access
In Project Customization, in the left pane, click Sprinter .
Important
The settings available in the Sprinter page control which features are enabled in Sprinter. Users still need the
information correct permissions within ALM that allow them to perform various functions.
For example, suppose you select Allow editing steps in Sprinter . The features that allow step editing will be
enabled in Sprinter. However, users that do not have test editing permissions in ALM will still be unable to edit
steps in a test.
See also
"About Configuring Sprinter" on the previous page
User interface elements are described below:
UI Elements
Description
Saves Sprinter customization changes.
Enable manual tests
to run with
Options include:
l
Manual Runner. Enable manual tests to run with the Manual Runner only.
l
Sprinter. Enable manual tests to run with Sprinter only.
l
Both Manual Runner and Sprinter. (Default) Enable manual tests to run with Manual Runner
or Sprinter.
Screen Captures
l
Sprinter temporarily saves the screen captures of all the actions in your test. You indicate which
images to capture during the run, in the Run pane in Sprinter's Settings dialog box.
l
The settings below control access to the corresponding images in the Run pane in Sprinter's
Settings dialog box. They allow you to limit the amount of images saved during test runs:
l
Enable storing of all images during a test. Enables the storing of all images during a run.
Note: Storing all images during a test may cause a delay due to traffic and
increase the storage needs on the ALMrepository.
l
Enable storing of all images for a failed test. (Default) Enables the storing of all
images for a failed test during a run.
l
Enable storing of all images for a failed step (tests with steps only). Enables the
storing of all images for a failed step during a run.
l
l
Disable storing of images. Disables the storing of any images during a run.
Regardless of your selection, you can always attach screen captures to defects, both during your
test, and at the end of your test from the test results.
Allow macros
Enable recording and running macros in Sprinter. Macros are available only for tests run in Sprinter
using Power Mode.
Allow Data Injection
Enable Sprinter's Data Injection feature, allowing you to automatically enter data into fields in your
test application. Data Injection is available only for tests run in Sprinter using Power Mode.
Allow Mirroring
Enable Sprinter's Mirroring feature, allowing you to run the same test scenario on different
configurations. Mirroring is available only for tests run in Sprinter using Power Mode.
HP ALM (12.50)
Page 353
Administrator Guide
Chapter 27: Configuring Sprinter
UI Elements
Description
Allow editing steps
in Sprinter Run
mode
Enable adding, deleting, and modifying the name or description of steps in a test.
Allow attaching
movies to defects
Enable attaching movies to defects when opening a defect from Sprinter's Tools sidebar, Workspace
Tools sidebar, or from the test results.
If this option is cleared, you are still able to modify the actual results of a step and add screen
captures to steps.
l
Maximum movie length (minutes). The maximum length of the movie that you can attach to a
defect. The movie length for each defect is set in Sprinter's Smart Defect Settings dialog box. You
can attach a movie to a defect, of a size that is up to the length of time defined by this setting. The
maximum allowable length of a movie is 10 minutes.
Note:
l
Increasing the length of movies that can be attached to defects may cause a
delay in the time it takes to submit a defect to ALM and increase the storage
needs of your ALM server.
l
The length of the movie you can attach to a defect may be limited by the
maximum size of an attachment you are allowed to attach to a defect in
ALM.
Add snapshot link to
the step's
actual/expected
result fields
Sprinter allows you to attach snapshots to test steps. This parameter enables ALM to show the
snapshots created in Sprinter as links in the actual or expected result fields of the test.
Capture the actual
step image
automatically when
the step status
changes
Enable capturing of the step image automatically when the status of the step changes.
HP ALM (12.50)
Page 354
Chapter 28: Generating Workflow Scripts
ALM provides script generators to enable you to perform commonly needed customizations on the
Defects module dialog boxes.
For information on writing workflow scripts to customize the user interface and to control user actions
in any ALM module, see "Workflow Customization at a Glance" on page 367.
Note: Workflow scripts run with the privileges of the logged-on user, not the privileges of the
user who created the script. As a result, a script fails if it attempts any action or data change
that the logged-on user is not privileged to perform, or if it accesses any restricted object that
the user is not privileged to use. Therefore, a script developed by a privileged user should be
tested with users that belong to the groups expected to trigger the script.
This chapter includes:
•
•
•
About Generating Workflow Scripts
356
Customizing Defects Module Field Lists
357
Customizing Defects Module Dialog Boxes
359
HP ALM (12.50)
Page 355
Administrator Guide
Chapter 28: Generating Workflow Scripts
About Generating Workflow Scripts
The Workflow page provides links to script generators and a script editor. You can use the script
generators to perform customizations on the input fields of the Defects module dialog boxes. You can
use the script editor to create scripts to control the workflow in any ALM module.
Performance Center: The Workflow page is not supported in Lab Management.
To open the Workflow page, click the Workflow link in the Project Customization window.
The Workflow page contains the following links:
l
l
l
l
Script Generator - List Customization for Defects Module. Enables you to customize the field lists
displayed for fields on the dialog boxes and in the Defects Grid of the Defects module. For more
information, see "Customizing Defects Module Field Lists" on the next page.
Script Generator - Add Defect Field Customization. Enables you to modify the appearance of the
New Defect dialog box. For more information, see "Customizing Defects Module Dialog Boxes" on
page 359.
Script Generator - Defect Details Field Customization. Enables you to modify the appearance of
the Defect Details dialog box. For more information, see "Customizing Defects Module Dialog Boxes"
on page 359.
Script Editor. Enables you to write VBScript code to customize the ALM workflow in any module. You
place your code in the appropriate ALM event so that the script is triggered when the relevant user
action takes place. You can also use the script editor to modify scripts created by the script
generators. For more information, see "Workflow Customization at a Glance" on page 367.
HP ALM (12.50)
Page 356
Administrator Guide
Chapter 28: Generating Workflow Scripts
Cross Project Customization
If you are working with a template project, in Project Customization, you use the Workflow (Shared) link
to customize workflow. Workflow customization created in a template project is applied to the linked
projects when you apply the template customization. For more information on customizing workflow
scripts as a part of cross process customization, see "The Script Editor" on page 370.
ALM Editions: Cross project customization is not available for for Quality Center Enterprise
Edition. For more information about ALM editions and their functionality, see the HP Application
Lifecycle Management User Guide.
Customizing Defects Module Field Lists
A field list is a list of values displayed in a drop-down list, from which the user can choose a value for the
field.
You can specify that a different field list be used for a Defects module field, depending on the value of
another field. For example, you can set the Detected in Versions list to change depending on the value
in the Project field.
Note: This script generator can be used to customize field lists in the Defects module only.
To customize a field list, you must define the following rules:
l
l
Primary/Secondary Rule. Select the primary and secondary fields. When a primary field value is
changed, the list of values in the secondary field changes automatically. For example, you could
select Project as the primary field and Detected in Versions as the secondary field.
List Match Rule. Select the list that you want to display in the secondary field for each value of the
primary field.
Note: When workflow customization has been used to change a list of values for a field that has
transition rules defined, the field may only be modified in a way that satisfies both the workflow
script and the transition rules. For more information, see "Setting Transition Rules" on page
245.
To customize a field list:
1. In the Project Customization window, in the left pane, click Workflow. The Workflow page opens.
2. Click the Script Generator - List Customization for Defects Module link. The Script Generator List Customization dialog box opens.
HP ALM (12.50)
Page 357
Administrator Guide
Chapter 28: Generating Workflow Scripts
3. Under Primary/Secondary Rule, select the primary field and the secondary field:
l
l
l
To set a rule, click <select primary> and select a field name. Click <select secondary> and
select a field name.
To add a new rule, click the Add Primary/Secondary Rule button
<select primary> and <select secondary>.
. Select field names for
To delete a rule, select the rule and click the Delete Primary/Secondary Rule button
Yes to confirm.
. Click
4. Under Primary/Secondary Rule, select the primary/secondary rule for which you want to set list
match rules.
5. Under List Match Rule, select the field list to be used in the secondary field for specific values
entered into the primary field:
l
l
l
To set a rule for a defined primary field value, click <select list> and select a list name.
To set a rule for an undefined primary field value, click <enter value> and type a primary field
value. Press Enter. Click <select list> and select a list name.
To add a new list match rule, click the Add List Match Rule button
. Click <enter value>
and type a primary field value. Click <select list> and select a list name.
HP ALM (12.50)
Page 358
Administrator Guide
Chapter 28: Generating Workflow Scripts
l
To delete a list match rule, select the rule and click the Delete List Match Rule button
Click Yes to confirm.
.
6. To save your changes, do one of the following:
l
l
Click the Apply Script Changes button to save your changes and close the script generator.
Click the Apply & View button to save your changes and view the generated script in the Script
Editor.
If you use the Script Editor to modify a script that was created by a script generator, your
modifications are overwritten the next time you run that script generator. It is recommended that
your name the generated script before you modify it. For more information on the Script Editor,
see "Working with the Workflow Script Editor" on page 369.
Customizing Defects Module Dialog Boxes
You can modify the appearance of the New Defect and Defect Details dialog boxes by setting different
fields to be visible for each user group. You can also sort the order in which the fields are displayed on
the dialog box for each user group.
Note: This workflow customization example can be modified to display fields only to specific
user groups. However, this example only covers changing the fields available in a dialog box. To
set which fields are visible to specific user groups in a module grid, use the Groups and
Permissions module in Customization. For task information, see "Hiding Data for a User Group"
on page 248.
For example, you may want the Assigned To and Priority fields to appear only for a user that has
developer privileges. Also, you can customize the Assigned To field so that it is displayed before the
Priority field for this user group.
Note: To make fields invisible, set the ENABLE_COLUMN_VISIBILITY_TRACKING parameter in
the Site Configuration tab. For more information, see "Setting ALM Configuration Parameters"
on page 168.
To perform a customization for all user groups, you can use the script editor to write a script. For more
information, see "Example: Customizing a Defects Module Dialog Box" on page 427.
Note: These script generators can be used to customize dialog boxes in the Defects module
only.
HP ALM (12.50)
Page 359
Administrator Guide
Chapter 28: Generating Workflow Scripts
To customize Defects module dialog boxes by user group:
1. In the Project Customization window, in the left pane, click Workflow. The Workflow page opens.
2. To modify the appearance of the New Defect dialog box, click the Script Generator - Add Defect
Field Customization link. The Script Generator - Add Defect Field Customization dialog box opens.
To modify the appearance of the Defect Details dialog box, click the Script Generator - Defect
Details Field Customization link. The Script Generator - Defect Details Field Customization dialog
box opens.
HP ALM (12.50)
Page 360
Administrator Guide
Chapter 28: Generating Workflow Scripts
Available Fields contains the names of all the fields you can display. Visible Fields contains the
names of the fields that can currently be seen by the selected user group, and their sorting
priority.
3. From the User Group list, select the user group to which the customizations are to apply.
4. Choose field names and click the arrow buttons (> and <) to move a name between Available
Fields and Visible Fields. Click the double arrow buttons (>> and <<) to move all the names from
one list to the other. You can also drag the field names between lists.
5. In Visible Fields, to set a field as a required field, select the check box next to it. For a required
field, a value is mandatory. Its title is displayed in red in the Add Defect or Defect Details dialog box.
6. You can set the order in which fields are displayed for the selected user group by using the up and
down arrows
. You can also drag the field names up or down.
7. You can set the Add Defect and Defect Details dialog boxes to include one or more input pages. By
default, all fields are displayed on one page. Use the up and down arrows to move fields to the
appropriate page.
8. To save your changes, do one of the following:
l
l
Click the Apply Script Changes button to save your changes and close the script generator.
Click the Apply & View button to save your changes and view the generated script in the Script
Editor.
If you use the Script Editor to modify a script that was created by a script generator, your
modifications are overwritten the next time you run that script generator. It is recommended that
you rename the generated script before you modify it. For more information on the Script Editor,
see "Working with the Workflow Script Editor" on page 369.
HP ALM (12.50)
Page 361
Administrator Guide
Chapter 28: Generating Workflow Scripts
HP ALM (12.50)
Page 362
Chapter 29: Managing Analysis Menus
The Analysis View module's Analysis Menu tab enables you to manage the behavior of graphs and
project reports that are generated from within the following modules: Requirements, Test Plan, Test
Lab, Defects, and Business Components.
The tab lists all graphs and project reports grouped per module. You can perform the following tasks for
each individual module:
l
Add or remove graphs or project reports
l
Configure graphs or project reports
l
View graph or project report details
l
Generate graphs or project reports
l
Preview project reports
HP ALM (12.50)
Page 363
Administrator Guide
Chapter 29: Managing Analysis Menus
HP ALM (12.50)
Page 364
Part 3: Workflow Customization
HP ALM (12.50)
Page 365
HP ALM (12.50)
Page 366
Chapter 30: Workflow Customization at a
Glance
You can write workflow scripts to customize the HP Application Lifecycle Management (ALM) user
interface, and to control the actions that users can perform.
To customize workflow:
1. In the Project Customization window, in the left pane, click Workflow. The Workflow page opens.
2. To customize a Defects module dialog box, click the appropriate Script Generator link on the
Workflow page. You need not be familiar with VBScript, or with ALM events and objects to use this
feature. For more information, see "Generating Workflow Scripts" on page 355.
3. To write or modify scripts by entering code into the appropriate event procedures, open the Script
Editor. To create workflow scripts, you must be familiar with VBScript. You can open the Script
Editor either from a script generator or directly:
l
l
To write a script that is similar to a script created by a script generator, click the relevant Script
Generator link and set the customization you want to perform. Click the Apply & View button
on the script generator dialog box. The Script Editor opens to display the scripts that were
generated.
To create your own scripts, click the Script Editor link. The Script Editor opens to display a
Scripts Tree that lists the existing event procedures.
For more information on the Script Editor, see "Working with the Workflow Script Editor" on page
369.
4. Decide which ALM event should trigger your script. You must place your code in the procedure of
HP ALM (12.50)
Page 367
Administrator Guide
Chapter 30: Workflow Customization at a Glance
the appropriate module and event so that it is invoked for the relevant user action. For more
information, see "Workflow Event Reference" on page 381.
5. Decide which ALM objects your script must access. Your script performs customizations based on
information obtained from the relevant objects. You customize the workflow by using the methods
and properties of the objects. For more information, see "Workflow Object and Property
Reference" on page 407.
6. Examine the sample scripts to find one that can be adapted for your use. Sample scripts are
provided in this guide and in the HP Self-solve knowledge base. Scripts generated by the workflow
script generators can also be used as a basis for your scripts.
l
l
For examples of common customizations that can be performed by using workflow scripts, see
"Workflow Examples and Best Practices" on page 419.
For an index to knowledge base articles that provide examples of workflow scripts, see HP
Software Self-solve knowledge base article KM183671
(http://h20230.www2.hp.com/selfsolve/document/KM183671).
Tip: Turning off versioning for relevant fields enables workflow scripts and OTA scripts to run
without requiring entities to be checked in.
HP ALM (12.50)
Page 368
Chapter 31: Working with the Workflow Script
Editor
You can use the Script Editor to create workflow scripts to customize the user interface, and to control
user actions.
This chapter includes:
•
•
•
•
•
About Working with the Workflow Script Editor
370
The Script Editor
370
Creating a Workflow Script
374
Adding a Button to a Toolbar
376
Setting the Properties of the Script Editor
378
HP ALM (12.50)
Page 369
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
About Working with the Workflow Script Editor
You can use the Script Editor to create workflow scripts and to add a toolbar button to the window of an
HP Application Lifecycle Management (ALM) module.
The Script Editor dialog box contains two tabs:
l
l
Script Editor tab. You use the Script Editor tab to create and edit workflow scripts. The Script Editor
assists you in placing your code in the appropriate ALM event procedure. For more information on
using the Script Editor, see "Creating a Workflow Script" on page 374.
Toolbar Button Editor tab. You use the Toolbar Button Editor tab to add a toolbar button to the
window of an ALM module. For more information, see "Adding a Button to a Toolbar" on page 376.
The Script Editor
You can use the Script Editor to modify scripts that have been generated by a script generator, or to
create a user-defined workflow script. For information on opening the Script Editor, see "Workflow
Customization at a Glance" on page 367.
The Script Editor tab contains the following elements:
l
l
l
Script Editor toolbar. Contains buttons used when creating scripts. For more information, see
"Understanding the Script Editor Commands" on page 372.
Scripts Tree. Lists the event procedures to which you can add code. The event procedures are
grouped by the module in which they are triggered. For more information, see "Workflow Event
Reference" on page 381.
Scripts pane. Displays the code of the selected event procedure. To create or modify a script, you
HP ALM (12.50)
Page 370
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
add VBScript code to the event procedure. For more information, see "Creating a Workflow Script" on
page 374.
l
Messages pane. Displays any syntax errors encountered when you save or validate a script.
Cross Project Customization
ALM Editions: Cross project customization is not available for Quality Center Enterprise Edition.
For more information about ALM editions and their functionality, see the HP Application Lifecycle
Management User Guide.
If you are working in a template or linked project, the Scripts Tree displays two sections under Workflow
Scripts:
l
Template Scripts (Shared). Workflow scripts listed in this section are the scripts applied from the
template to the linked project. For more information on applying template customization, see
"Applying Template Customization to Linked Projects" on page 295.
If you are working with a linked project, this section is displayed only when there are template scripts
defined in the template. The template scripts cannot be edited in the linked project. If you remove a
project from a template, the template scripts remain in the project and are editable.
l
Project Scripts. Workflow scripts listed in this section apply only to the template or linked project in
which you are working. Scripts in this section of a template are not applied to linked projects.
When running workflow scripts for a linked project, ALM combines template scripts and project
scripts into one script. Duplicate variables or functions in the template scripts and projects scripts
can cause conflicts.
Additional considerations when working in a template project:
l
l
Scripts generated by one of the script generators are created under Template Scripts (Shared).
ALM adds the prefix Template_ to events in template scripts. By default, ALM triggers template
event procedures. The project event procedure is triggered if the template event procedure does not
exist, or if you instruct the template event procedure to call the project event procedure.
Each template event includes a commented call to the parallel project event. For example, the
Template_Bug_New event in the template script is displayed as follows:
Sub Template_Bug_New
On Error Resume Next
`call Bug_New
On Error Go To 0
End Sub
HP ALM (12.50)
Page 371
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
To instruct the template script to call the project event, remove the comment marker to activate the
call to the project event, as follows:
Sub Template_Bug_New
On Error Resume Next
call Bug_New
On Error Go To 0
End Sub
Understanding the Script Editor Commands
The Script Editor toolbar, menu bar, and right-click menu contain the following buttons and menu
commands:
UI Element
Description
Save. Saves the changes made to scripts in the selected module.
Print. Prints the displayed script.
Undo. Reverses the last command or deletes the last entry you typed.
Redo. Reverses the action of your last Undo command.
Cut. Removes the selected text and places it on the Clipboard.
Copy. Copies the selected text to the Clipboard.
Paste. Inserts the contents of the Clipboard at the insertion point.
Delete. Deletes the selected text.
Find. Searches for specified text in the scripts of the selected module.
Find Next. Finds the next occurrence of the text specified in the Find Text dialog box.
Replace. Replaces the specified text with replacement text.
Synchronize Tree with Script. Refreshes the Scripts Tree to reflect procedures you have added, deleted or
renamed.
Field Names. Displays a list of field names in the project that you can insert into your script.
HP ALM (12.50)
Page 372
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
UI Element
Description
Code Complete. Displays a list of objects, properties, methods, or field names that you can insert into your
script.
Code Template. Displays a list of templates for commonly used VBScript statements that you can insert into
your script.
List Value. Opens the Select Value From List dialog box, to enable you to choose an item from a project list.
Syntax Check. Validates the syntax of your script and displays any messages in the Messages pane.
Show/Hide Scripts Tree. Displays or hides the Scripts Tree. If you have opened the Script Editor from a script
generator, this is not available.
Show/Hide Messages Pane. Displays or hides the Messages pane.
Properties. Opens the Properties dialog box, enabling you to change the properties of the Script Editor. For
more information, see "Setting the Properties of the Script Editor" on page 378.
Save All
To save script changes in all modules, choose File > Save All .
Revert to
Saved
To return to a saved version of a module, select a changed module and choose File > Revert to Saved.
Select All
To select all text in the scripts pane, choose Edit > Select All .
Expand All
To expand all nodes in the Scripts Tree, choose View > Expand All .
Collapse
All
To collapse all nodes in the Scripts Tree, choose View > Collapse All .
Go to Line
Number
To jump to a specific line in the Script Editor, choose Search > Go to Line Number .
Clear
Messages
To clear syntax messages displayed in the messages pane, choose Tools > Clear Messages.
Sort Field
Names by
Field
Labels
When you choose the Field Names option, the Script Editor sorts the list by the field name used in the ALM
VBScript
Home Page
To get help for the VBScript language, choose Help > VBScript Home Page.
HP ALM (12.50)
database table (for example, BG_BUG_ID). To sort the fields by the field label (for example, Defect ID) rightclick the script pane and choose Sort Field Names by Field Labels.
Page 373
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
Creating a Workflow Script
You use the Script Editor to add VBScript code to an ALM event procedure, or to create user-defined
procedures that can be called from an ALM event procedure.
To create a workflow script:
1. In the Workflow window, click the Script Editor link. The Script Editor opens.
For more information on the Script Editor window, see "The Script Editor" on page 370.
2. In the Scripts Tree, select the node of the module for which you need to customize the workflow.
The Scripts Tree contains the Common script node in addition to the nodes for specific modules.
When you create user-defined procedures that must be accessible from several modules, place
them under the Common script node. To declare a global variable that can be used across all
modules, declare the variable under the Common script node, outside of any function.
3. Expand the node and select the event procedure to which you need to add code, depending on
when you want your code to be triggered. The existing script for this event procedure is displayed
in the Scripts pane.
For a description of ALM event procedures, see "Workflow Event Reference" on page 381.
4. Add your VBScript code to the script.
Note: A red indicator
next to a module name in the Scripts Tree indicates that there are
unsaved script changes in that module.
5. To use the code complete feature instead of typing in the names of ALM objects, properties,
methods, and fields, place the insertion point at the location where you want to insert an object
name and click the Code Complete
HP ALM (12.50)
Page 374
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
button. For information about ALM objects, see "Workflow Object and Property Reference" on
page 407.
6. To use the code template feature instead of typing in commonly used VBScript statements, place
the insertion point where you want to insert the code and click the Code Template
Choose one of the following items from the code template list:
Template
Code Added to Script
FVal: Fields value access
Fields.Field("").Value
List: QualityCenter list access
Lists.List()
IfAct: Action "switch" If Block
If ActionName = "" Then
button.
End IF
Act: Actions access
Actions.Action("")
Func: Function template
Function
On Error Resume Next
On Error GoTo 0
End Function
Sub
On Error Resume Next
Sub: Sub Template
On Error GoTo 0
End Sub
On Error Resume Next
Err: Error Handler
7. To insert an item from a field list defined in the project, place the insertion point at the location
where you want to add the item. Click the List Value
button. In the Lists box of the Select
Value From List dialog box, choose the name of the list. In the List Items box, select the list value.
8. To insert an ALM field name, place the insertion point at the location where you want to add the
field name. Click the Field Names
defined fields in the ALM project.
button. Select a name from the list of system and user-
9. To validate the syntax of the script, click Syntax Check
Messages pane.
10. Click the Save button
. Any messages are displayed in the
to save the script.
11. Close the Script Editor.
HP ALM (12.50)
Page 375
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
Adding a Button to a Toolbar
You can use the Toolbar Button Editor to define a toolbar button to be displayed on the window of an
ALM module, or on the Manual Runner dialog box.
To add a button to a toolbar:
1. In the Script Editor, click the Toolbar Button Editor tab.
2. From the Command bar list, select the toolbar to which you want to add a button:
Option
Toolbar Location
Requirements
Requirements module window.
TestPlan
Test Plan module window.
TestLab
Test Lab module window.
ManualRun
Manual Runner dialog box.
Defects
Defects module window.
Component
Business Components module window. This option depends on your ALM license.
Releases
Releases module window.
Resources
Test Resources module window.
Analysis
Analysis module window.
Dashboard
Dashboard module window.
BusinessModels
Business Models module window.
Libraries
Libraries module window.
HP ALM (12.50)
Page 376
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
Option
Toolbar Location
TestRuns
Test Runs module window.
3. Click Add. A default command name for the button is added to the Commands list.
4. In the Caption box, type a new command name for the button, or use the default name.
5. In the Hint box, type a tooltip for the button.
6. In the Action Name box, type a new action name for the button, or use the default name.
7. Under Images, select an icon for the button.
8. Click Apply to apply your changes.
9. To delete a button that you have created, select its command name in the Commands list, and click
Remove.
10. Click the Save button
to save the new button definition.
11. Click the Script Editor tab.
12. In the Scripts Tree of the Script Editor, select the ActionCanExecute event procedure located in the
common script section.
13. In the procedure displayed in the scripts pane of the Script Editor, add statements to be performed
if the user initiates an action with the action name you defined for the button. Set the return value
to True or False.
For example, the following code opens a message box when the user clicks the Requirements_
Action1 button on the tool bar of the Requirements module:
Function ActionCanExecute(ActionName)
On Error Resume Next
ActionCanExecute = True
If ActionName = "UserDefinedActions.Requirements_Action1" Then
MsgBox "You clicked the Action1 button."
End If
On Error GoTo 0
End Function
For more information, see "Example: Adding Button Functionality" on page 436.
14. Click the Save button
HP ALM (12.50)
to save the script.
Page 377
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
Setting the Properties of the Script Editor
You can customize the behavior of the Script Editor.
To set the properties of the Script Editor:
1. In the Script Editor, click the Properties button
Properties dialog box opens.
HP ALM (12.50)
or choose Options > Editor Properties. The
Page 378
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
2. In the Editor tab, you can set the following options:
Option
Description
Auto indent mode
Places the cursor under the first non-blank character of the preceding non-blank line when you
press Enter .
Smart tab
Tabs to the first non-blank character in the preceding non-blank line. If Use tab character is
selected, this option is cleared.
Use tab character
Inserts a tab character. If cleared, inserts space characters. If Smart tab is selected, this option is
cleared.
Backspace
unindents
Aligns the insertion point to the previous indentation level when you press Backspace, if the
cursor is on the first non-blank character of a line.
Show line
numbers
Displays line numbers. If this option is selected, Show line numbers on gutter is enabled.
Show line
numbers on
gutter
Displays line numbers in the gutter instead of in the left margin. If Show line numbers is
selected, this option is enabled.
Group undo
Reverses your last editing command and any subsequent editing commands of the same type, if
you press Alt+Backspace or choose Edit > Undo.
Cursor beyond
EOF
Enables you to place the insertion point after the last line of code.
Cursor beyond
EOL
Enables you to position the cursor after the end of the line.
Selection beyond
EOL
Enables you to select characters beyond the end of the line.
Keep trailing
blanks
Keeps any blank spaces you have at the end of a line.
Persistent blocks
Keeps marked blocks selected, even when the cursor is moved using the arrow keys, until a new
block is selected.
Overwrite blocks
Replaces a marked block of text with new text. If Persistent Blocks is also selected, text you
enter is appended following the currently selected block.
Double click line
Highlights the line when you double-click any character in the line. If disabled, only the selected
word is highlighted.
Find text at
cursor
Places the text at the cursor into the Text To Find list box in the Find Text dialog box when you
Force cut and
copy enabled
Enables the Cut and Copy commands, even when there is no text selected.
Use syntax
highlight
Displays script elements according to colors and attributes defined in the Display tab and Colors
tab.
HP ALM (12.50)
choose Search > Find.
Page 379
Administrator Guide
Chapter 31: Working with the Workflow Script Editor
Option
Description
Overwrite cursor
as block
Controls the appearance of the caret when using the Overwrite mode.
Disable dragging
Disables dragging and dropping text.
Block indent
Specifies the number of spaces to indent a marked block.
Tab stops
Specifies the locations to which the cursor moves when you press Tab.
Keymapping
Sets the keyboard mappings in the Script Editor. Supports the following keyboard mappings:
Default, Classic, Brief, Epsilon, and Visual Studio.
3. In the Display tab, you can set the following options:
Option
Description
Editor gutter
Enables you to set the visibility, width, color, and style of the gutter.
Editor margin
Enables you to set the visibility, width, color, style, and position of the right margin.
Use mono font
Displays only monospaced screen fonts, such as Courier, in the Editor font box.
Editor font
Lists the available text fonts.
Editor color
Lists the available background colors.
Size
Lists font sizes.
Use Read-Only Color
Enables you to select a color for displaying read-only text from the Read-Only Color box.
Draw Special Symbols
Sets special characters for displaying end-of-file, end-of-line, space, and tab characters.
4. In the Colors tab, you can set the following options:
Option
Description
Color SpeedSetting Enables you to configure the Script Editor display using predefined color combinations.
Element
Specifies syntax highlighting for a particular code element.
Foreground color
Sets the foreground color for the selected code element.
Background color
Sets the background color for the selected code element.
Use defaults for
Displays the code element using default system colors for the foreground, background, or both.
Text attributes
Specifies format attributes for the code element.
Open
Loads a color scheme from your computer.
Save
Saves a color scheme to your computer.
HP ALM (12.50)
Page 380
Chapter 32: Workflow Event Reference
You can write workflow scripts to customize the actions that HP Application Lifecycle Management
(ALM) users can perform, and the fields that are available to users in dialog boxes. To write a workflow
script, you add VBScript code to event procedures that are triggered by user actions.
This chapter includes:
•
•
•
About ALM Events
382
Naming Conventions for ALM Event Procedures
383
Reference for ALM Events
384
HP ALM (12.50)
Page 381
Administrator Guide
Chapter 32: Workflow Event Reference
About ALM Events
During an ALM user session, as the user initiates various actions, ALM triggers event procedures. You
can place code in these procedures to customize the execution of the associated user actions.
The Script Editor lists the event procedures for each ALM module, and allows you to add your code to
the appropriate procedure. For more information, see "Working with the Workflow Script Editor" on
page 369.
The code you add to the event procedures can access ALM objects. For more information, see "Workflow
Object and Property Reference" on page 407.
Event procedures can be functions or subroutines:
l
Event functions. These procedures are triggered by ALM to check whether the user's action should
be performed. You can place code in these functions to determine whether ALM may execute the
user's request. If your code returns a value of False, ALM does not proceed with the action.
For example, when a user clicks the Submit button on the Add Defect dialog box, ALM invokes the
function Bug_CanPost before posting the defect to the database on the server. You can add code to
the Bug_CanPost function to control whether ALM posts the defect. For example, you can ensure
that a user cannot reject a defect without adding a comment. For example, see "Example: Object
Validation" on page 433.
l
Event subroutines. These procedures are triggered to perform actions when an event takes place.
For example, when a user opens the Add Defect dialog box, ALM invokes the subroutine Bug_New. You
can add code to the Bug_New subroutine to perform actions that should be performed when a user
opens the dialog box. For example, you can change the value of the Detection Mode field to BTW if
the user is not in the QA Tester user group. For example, see "Example: Changing a Field Based on
the User Group" on page 432.
Version Control: After enabling version control for a project, you should review all its workflow
scripts and make adjustments for each checked in entity. This includes the following entities:
Req, Test, Resource, and Component. For each checked in entity that includes a Post function in
its script, you must modify the script. To modify, add a Checkout function before every Post
function. Making this modification prevents the Check Out dialog box from opening each time a
call to a Post function is made. For more information about the Post and Checkout functions,
see the HP ALM Open Test Architecture Reference.
For more information on version control, refer to the HP Application Lifecycle Management User
Guide.
HP ALM (12.50)
Page 382
Administrator Guide
Chapter 32: Workflow Event Reference
Naming Conventions for ALM Event Procedures
The naming convention for an event procedure is as follows:
<entity>_<event>
See "Entity" below and "Event" on the next page for more details.
Note:
l
For backwards compatibility, the previous naming convention, including the module name, is
still supported. However, we recommend you use the new naming conventions instead.
l
Some event procedure names do not include an entity name. For example, the
GetDetailsPageName event name does not include an entity name.
Entity
An Entity can be one of the following:
Entity
Description
Release
Release data
Release Folder
Release folder data
Cycle
Release cycle data
Library
Library data
Library Folder
Library folder data
Baseline
Baseline data
Req
Requirement data
Test
Test data
DesignStep
Design step data
Resource
Test resource data
Resource Folder
Test resource folder data
TestSet
Test set data
TestSetTests
Test instance data
Run
Test run data
Bug
Defect data
HP ALM (12.50)
Page 383
Administrator Guide
Chapter 32: Workflow Event Reference
Entity
Description
Step
Test run step data
AnalysisItem
Reports and graphs data
AnalysisItemFolder
Reports and graphs folder data
DashboardFolder
Dashboard folder data
DashboardPage
Dashboard page data
Component
Business component data
ComponentStep
Business component step data
ComponentFolder
Business component folder data
BusinessModel
Business model data
BusinessModelActivity
Business model activity data
BusinessModelPath
Business model path data
BusinessModelFolder
Business model folder data
Event
The Event can be either a function name or a subroutine name. The event names are listed in
"Reference for ALM Events" below.
Reference for ALM Events
This section contains an alphabetical reference of the ALM event functions and subroutines. It includes
the event name, description, syntax, type (Function or Sub), the value returned by a function, and the
entities for which the event procedure is available.
For information on the naming conventions for event procedures, see "Naming Conventions for ALM
Event Procedures" on the previous page.
The following event functions are available:
Function Name
When the Function is Triggered
"ActionCanExecute" on page 386
before performing a user action
"Attachment_CanDelete" on page 388
before deleting an attachment
"Attachment_CanOpen" on page 388
before opening an attachment
"Attachment_CanPost" on page 389
before updating an attachment
"CanAddTests" on page 390
before adding tests to a test set
HP ALM (12.50)
Page 384
Administrator Guide
Chapter 32: Workflow Event Reference
Function Name
When the Function is Triggered
"CanCustomize" on page 390
before opening Customization window
"CanDelete" on page 390
before deleting an object from the server
"CanLogin" on page 393
before a user logs in to the project
"CanLogout" on page 393
before a user logs out of the project
"CanPost" on page 393
before posting an object to the server
"CanRemoveTests" on page 395
before removing tests from a test set
"CanAddComponentsToTest" on page 389
before adding business components to a test of type Flow or BusinessProcess
"CanAddFlowsToTest" on page 389
before adding flows to a test of type Business-Process
"CanRemoveComponentsFromTest" on
page 395
before removing business components from a test of type Flow or BusinessProcess
"CanRemoveFlowsFromTest" on page 395
before removing flows from a test of type Business-Process
"CanDeleteGroupsFromTest" on page 393
before deleting groups from a test of type Flow or Business-Process
"CanReImportModels" on page 394
before importing business models
"DefaultRes" on page 396
before resetting project defaults
"FieldCanChange" on page 397
before changing a field value
"GetDetailsPageName" on page 399
before displaying Defect Details dialog box
"GetNewBugPageName" on page 400
before displaying Add Defect dialog box (for backward compatibility)
"GetNewReqPageName" on page 400
before displaying New Requirement dialog box (for backward compatibility)
"GetReqDetailsPageName" on page 401
before displaying Requirement Details dialog box (for backward
compatibility)
The following event subroutines are available:
Subroutine Name
When the Subroutine is Triggered
"AddComponentToTest" on page
387
a component has been added to a test of type Flow or Business-Process
"AfterPost" on page 387
an object has been posted to the server
"Attachment_New" on page 389
an attachment is added
"DialogBox" on page 396
a dialog box is opened or closed
"EnterModule" on page 396
user switches modules
"ExitModule" on page 397
user exits a module
"FieldChange" on page 398
a field value changes
HP ALM (12.50)
Page 385
Administrator Guide
Chapter 32: Workflow Event Reference
Subroutine Name
When the Subroutine is Triggered
"MoveTo" on page 401
user changes focus
"MoveToComponentFolder" on
page 402
user moves to the specified component folder in the business component tree (for
backward compatibility)
"MoveToFolder" on page 403
user clicks a folder in the test sets tree (for backward compatibility)
"MoveToSubject" on page 403
user clicks a subject in the test plan tree (for backward compatibility)
"New" on page 403
an object is added
"RemoveComponentFromTest" on user removes a component from a test of type Flow or Business-Process
page 404
"RunTests" on page 405
user clicks Run in the Test Lab module (provided that Sprinter is not installed and none
of the tests is automated)
"RunTests_Sprinter" on page 405
user clicks Run in the Test Lab module (provided that Sprinter is installed and at least
one test is automated)
"RunTestSet" on page 405
user clicks RunTest Set in the Test Lab module
"RunTestsManually" on page 406
user clicks Run > Run Manually in the Test Lab module
ActionCanExecute
This event is triggered before ALM performs an action that has been initiated by the user, to check
whether the action can be executed.
You can add code to this event procedure to perform actions when the user has initiated a particular
action, or to prevent the action from being executed in specific cases. For example, see "Example:
Controlling User Permissions" on page 436.
Syntax
ActionCanExecute(ActionName)
where ActionName is the action that the user has initiated.
Actions are in the format context.action.
Note: The previous format for this event is supported for purposes of backward
compatibility. We recommend you use ActionCanExecute instead.
User-defined actions start with the prefix UserDefinedActions .
Type
Function
Returns
True or False
Availability ActionCanExecute (all modules)
HP ALM (12.50)
Page 386
Administrator Guide
Chapter 32: Workflow Event Reference
Tip: To obtain the name of an action, see the sample code on "Action Object" on page 409.
AddComponentToTest
This event is triggered when the user adds a component to a test of type Flow or Business-Process in
the Test Script tab.
Version Control: Changing components checked in or checked out by another user, using the
AddComponentToTest event, is not supported.
Syntax
AddComponentToTest
Type
Sub
Availability
AddComponentToTest
AfterPost
This event is triggered after an object has been posted to the server.
Project fields should not be changed after they have been posted, because then the new value is not
stored in the database.
Syntax
<entity>_AfterPost
Type
Sub
Availability
l
AnalysisItem_AfterPost
l
AnalysisItemFolder_AfterPost
l
Baseline_AfterPost
l
Bug_AfterPost
l
BusinessModel_AfterPost
l
BusinessModelFolder_AfterPost
l
BusinessModelPath_AfterPost
l
Component_AfterPost
l
ComponentFolder_AfterPost
l
Cycle_AfterPost
l
DashboardFolder_AfterPost
l
DashboardPage_AfterPost
l
Library_AfterPost
l
LibraryFolder_AfterPost
l
Release_AfterPost
l
ReleaseFolder_AfterPost
l
Req_AfterPost
HP ALM (12.50)
Page 387
Administrator Guide
Chapter 32: Workflow Event Reference
l
Resource_AfterPost
l
ResourceFolder_AfterPost
l
Run_AfterPost
l
Step_AfterPost
l
Test_AfterPost
l
TestConfiguration_AfterPost
l
TestFolder_AfterPost
l
TestSet_AfterPost
l
TestSetFolder_AfterPost
Attachment_CanDelete
This event is triggered before ALM deletes an attachment from the server, to check whether that
attachment can be deleted.
Syntax
Attachment_CanDelete(Attachment)
where Attachment is the IAttachment interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
Type
Function
Returns
True or False
Availability Attachment_CanDelete (all modules)
Attachment_CanOpen
This event is triggered before ALM opens an attachment from the server, to check whether the
attachment can be opened.
Syntax
Attachment_CanOpen(Attachment)
where Attachment is the lAttachment interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
Type
Function
Returns
True or False
Availability Attachment_CanOpen (all modules)
HP ALM (12.50)
Page 388
Administrator Guide
Chapter 32: Workflow Event Reference
Attachment_CanPost
This event is triggered before ALM updates an existing attachment on the server, to check whether the
attachment can be updated.
Syntax
Attachment_CanPost(Attachment)
where Attachment is the lAttachment interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
Type
Function
Returns
True or False
Availability Attachment_CanPost (all modules)
Attachment_New
This event is triggered when an attachment is added to ALM.
Syntax
Attachment_New(Attachment)
where Attachment is the lAttachment interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
Type
Sub
Availability Attachment_New (all modules)
CanAddComponentsToTest
This event is triggered before ALM adds business components to a test of type Flow or BusinessProcess, to check whether the specified components can be added.
Syntax
CanAddComponentsToTest(Components)
where Components is an array of component IDs.
Type
Function
Returns
True or False
Availability
CanAddComponentsToTest
CanAddFlowsToTest
This event is triggered before ALM adds flows to a test of type Business-Process, to check whether the
specified flows can be added.
HP ALM (12.50)
Page 389
Administrator Guide
Chapter 32: Workflow Event Reference
Syntax
CanAddFlowsToTest(Flows)
where Flows is an array of flow IDs.
Type
Function
Returns
True or False
Availability
CanAddFlowstoTest
CanAddTests
This event is triggered before ALM adds tests to a test set, to check whether the specified tests can be
added.
Syntax
<entity>_CanAddTests(Tests)
where Tests is an array of Test IDs.
Type
Function
Returns
True or False
Availability
TestSet_CanAddTests
CanCustomize
This event is triggered when a user attempts to open the Customization window, to check whether the
specified user can customize the specified project.
Syntax
CanCustomize(DomainName, ProjectName, UserName)
where DomainName is the domain name, ProjectName is the project name, and UserName is the user name.
Type
Function
Returns
True or False
Availability CanCustomize (all modules)
CanDelete
This event is triggered before ALM deletes an object from the server, to check if the object can be
deleted.
Syntax
<entity>_CanDelete(Entity)
Type
Function
Returns
True or False
Availability
l
HP ALM (12.50)
AnalysisItem_CanDelete
Page 390
Administrator Guide
Chapter 32: Workflow Event Reference
HP ALM (12.50)
l
AnalysisItemFolder_CanDelete
l
Baseline_CanDelete
l
Bug_CanDelete
l
BusinessModel_CanDelete
l
BusinessModelFolder_CanDelete
l
BusinessModelPath_CanDelete
l
Component_CanDelete
l
ComponentFolder_CanDelete
l
Cycle_CanDelete
l
DashboardFolder_CanDelete
l
DashboardPage_CanDelete
l
Library_CanDelete
l
LibraryFolder_CanDelete
l
Release_CanDelete
l
ReleaseFolder_CanDelete
l
Req_CanDelete
l
Resource_CanDelete
l
ResourceFolder_CanDelete
l
Test_CanDelete
l
TestConfiguration_CanDelete
l
TestFolder_CanDelete
l
TestSet_CanDelete
l
TestSetFolder_CanDelete
Page 391
Administrator Guide
Chapter 32: Workflow Event Reference
Additional Syntax for Backward Compatibility
For purposes of backward compatibility, the following syntaxes are also available for certain objects.
However, we recommend you use CanDelete instead.
l
The syntax for tests or test subject folders:
Syntax
Test_CanDelete(Entity, IsTest)
where:
l
Entity is the test or subject folder.
l
If IsTest is True , Entity refers to an ITest object.
If IsTest is False , Entity refers to an ISubjectNode object. For more information on ITest and
ISubjectNode, refer to the HP ALM Open Test Architecture API Reference .
Type
Function
Returns
True or False
Availability Test_CanDelete
l
The syntax for test sets or test set folders:
Syntax
TestSet_CanDelete(Entity, IsTestSet)
where:
l
Entity is the test set or test set folder.
l
If IsTestSet is True , Entity refers to an ITestSet object.
If IsTestSet is False , Entity refers to an ITestSetFolder object. For more information on ITestSet and
ITestSetFolder, refer to the HP ALM Open Test Architecture API Reference .
Type
Function
Returns
True or False
Availability TestSet_CanDelete
l
The syntax for business components or business component folders:
Syntax
Component_CanDelete(Entity, IsComponent)
where:
l
Entity is the component or component folder.
l
If IsComponent is True , Entity refers to an IComponent object.
If IsComponent is False , Entity refers to an IComponentFolder object. For more information on
IComponent and IComponentFolder, refer to the HP ALM Open Test Architecture API Reference .
Type
Function
Returns
True or False
Availability Component_CanDelete
HP ALM (12.50)
Page 392
Administrator Guide
Chapter 32: Workflow Event Reference
CanDeleteGroupsFromTest
This event is triggered when a user removes groups from a test of type Flow or Business-Process, to
check whether the specified groups can be removed.
Syntax
CanDeleteGroupsFromTest(Groups)
where Groups is an array of group IDs.
Type
Function
Returns
True or False
Availability
CanDeleteGroupsFromTest
CanLogin
This event is triggered to check whether the specified user can log in to the specified project.
Syntax
CanLogin(DomainName, ProjectName, UserName)
where DomainName is the domain name, ProjectName is the project name, and UserName is the user name.
Type
Function
Returns
True or False
Availability CanLogin (all modules)
CanLogout
This event is triggered to check whether the current user can log out of the current project.
Syntax
CanLogout
Type
Function
Returns
True or False
Availability
CanLogout (all modules)
CanPost
This event is triggered before ALM posts an object to the server, to check whether the object can be
posted.
You can add code to this event procedure to prevent an object from being posted in specific cases. For
example, see "Example: Object Validation" on page 433.
HP ALM (12.50)
Page 393
Administrator Guide
Chapter 32: Workflow Event Reference
Syntax
<entity>_CanPost
Type
Function
Returns
True or False
Availability
l
AnalysisItem_CanPost
l
AnalysisItemFolder_CanPost
l
Baseline_CanPost
l
Bug_CanPost
l
BusinessModel_CanPost
l
BusinessModelFolder_CanPost
l
BusinessModelPath_CanPost
l
Component_CanPost
l
ComponentFolder_CanPost
l
Cycle_CanPost
l
DashboardFolder_CanPost
l
DashboardPage_CanPost
l
Library_CanPost
l
LibraryFolder_CanPost
l
Release_CanPost
l
ReleaseFolder_CanPost
l
Req_CanPost
l
Resource_CanPost
l
ResourceFolder_CanPost
l
Run_CanPost
l
Step_CanPost
l
Test_CanPost
l
TestConfiguration_CanPost
l
TestFolder_CanPost
l
TestSet_CanPost
l
TestSetFolder_CanPost
l
TestSetTests_CanPost (does not appear in the Scripts Tree)
CanReImportModels
This event is triggered when attempting to import the specified business process models that already
exist in ALM, to check if the business process models can be reimported.
Syntax
<entity>_CanReImportModels(Models)
where Models is an array of Model IDs.
HP ALM (12.50)
Page 394
Administrator Guide
Chapter 32: Workflow Event Reference
Type
Function
Returns
True or False
Availability
CanReImportModels
CanRemoveComponentsFromTest
This event is triggered when a user removes components from a test of type Flow or Business-Process,
to check whether the specified components can be removed.
Syntax
CanRemoveComponentsFromTest(Components)
where Components is an array of component IDs.
Type
Function
Returns
True or False
Availability
CanRemoveComponentsFromTest
CanRemoveFlowsFromTest
This event is triggered when a user removes flows from a test of type Business-Process, to check
whether the specified flows can be removed.
Syntax
CanRemoveFlowsFromTest(Flows)
where Flows is an array of flow IDs.
Type
Function
Returns
True or False
Availability
CanRemoveFlowsFromTest
CanRemoveTests
This event is triggered to check whether the specified tests can be removed from a test set.
Syntax
<entity>_CanRemoveTests(Tests)
where Tests is an array of Test Instance IDs.
Type
Function
Returns
True or False
Availability
TestSet_CanRemoveTests
HP ALM (12.50)
Page 395
Administrator Guide
Chapter 32: Workflow Event Reference
DefaultRes
This function is used to determine the default return value for ALM functions, such as FieldCanChange.
All ALM workflow functions call this function (unless explicitly omitted by user) to determine the default
return value. DefaultRes can be used to quickly replace the default return values of all ALM workflow
functions.
Syntax
DefaultRes
Type
Function
Returns
True or False
Availability
DefaultRes (all modules)
DialogBox
This event is triggered when a dialog box is opened or closed.
Syntax
DialogBox(DialogBoxName, IsOpen)
where DialogBoxName is the name of the dialog box, and IsOpen indicates whether the dialog box is open.
Type
Sub
Availability
DialogBox (all modules)
Note: For purposes of backward compatibility, this event is also triggered using backward
compatible values for defect details (DialogBoxName="Details") and test instance details
(DialogBoxName="TestInstanceDetails"). These backward compatible values are not
recommended.
EnterModule
This event is triggered when the user enters or switches to an ALM module. It is also triggered when the
user logs in to ALM.
You can add code to this event procedure to perform an action whenever the user switches to the
specified module.
Syntax
EnterModule
Type
Sub
Availability
EnterModule (all modules)
HP ALM (12.50)
Page 396
Administrator Guide
Chapter 32: Workflow Event Reference
ExitModule
This event is triggered when the user exits the specified module.
Syntax
ExitModule
Type
Sub
Availability
ExitModule (all modules)
FieldCanChange
This event is triggered before ALM changes a field value, to determine whether the field can be
changed.
You can add code to this event procedure to prevent a field from being changed in specific cases. For
example, see "Example: Field Validation" on page 433.
Syntax
<entity>_FieldCanChange(FieldName, NewValue)
where FieldName is the name of the field and NewValue is the field value.
Type
Function
Returns
True or False
Availability
l
AnalysisItem_FieldCanChange
l
AnalysisItemFolder_FieldCanChange
l
Baseline_FieldCanChange
l
Bug_FieldCanChange
l
BusinessModel_FieldCanChange
l
BusinessModelActivity_FieldCanChange
l
BusinessModelFolder_FieldCanChange
l
BusinessModelPath_FieldCanChange
l
Component_FieldCanChange
l
ComponentFolder_FieldCanChange
l
ComponentStep_FieldCanChange
l
Cycle_FieldCanChange
l
DashboardFolder_FieldCanChange
l
DashboardPage_FieldCanChange
l
DesignStep_FieldCanChange
l
Library_FieldCanChange
l
LibraryFolder_FieldCanChange
l
Release_FieldCanChange
l
ReleaseFolder_FieldCanChange
HP ALM (12.50)
Page 397
Administrator Guide
Chapter 32: Workflow Event Reference
l
Req_FieldCanChange
l
Resource_FieldCanChange
l
ResourceFolder_FieldCanChange
l
Run_FieldCanChange
l
Step_FieldCanChange
l
Test_FieldCanChange
l
TestConfiguration_FieldCanChange
l
TestFolder_FieldCanChange
l
TestSet_FieldCanChange
l
TestSetFolder_FieldCanChange
l
TestSetTests_FieldCanChange
The code for hiding a field that depends on another field should be placed in the FieldChange event
procedure (not in the FieldCanChange event procedure).
FieldChange
This event is triggered when the value of the specified field changes.
Every change of value triggers the field change event when the field loses focus.
You can add code to this event procedure to perform an action when the value of a particular field is
changed. For example, you can hide or display one field depending on the value the user enters into
another field. For example, see "Example: Changing One Field Based on Another Field" on page 431.
Syntax
<entity>_FieldChange(FieldName)
where FieldName is the name of the field.
Type
Sub
Availability
l
AnalysisItem_FieldChange
l
AnalysisItemFolder_FieldChange
l
Baseline_FieldChange
l
Bug_FieldChange
l
BusinessModel_FieldChange
l
BusinessModelActivity_FieldChange
l
BusinessModelFolder_FieldChange
l
BusinessModelPath_FieldChange
l
Component_FieldChange
l
ComponentFolder_FieldChange
l
ComponentStep_FieldChange
l
Cycle_FieldChange
l
DashboardFolder_FieldChange
l
DashboardPage_FieldChange
HP ALM (12.50)
Page 398
Administrator Guide
Chapter 32: Workflow Event Reference
l
DesignStep_FieldChange
l
Library_FieldChange
l
LibraryFolder_FieldChange
l
Release_FieldChange
l
ReleaseFolder_FieldChange
l
Req_FieldChange
l
Resource_FieldChange
l
ResourceFolder_FieldChange
l
Run_FieldChange
l
Step_FieldChange
l
Test_FieldChange
l
TestConfiguration_FieldChange
l
TestFolder_FieldChange
l
TestSet_FieldChange
l
TestSetFolder_FieldChange
l
TestSetTests_FieldChange
When a user changes a field value using the Find/Replace command, workflow events are not triggered.
If restrictions implemented in workflow scripts are critical, consider disabling the Replace command for
specific user groups, to ensure that your restrictions cannot be bypassed.
GetDetailsPageName
This event is triggered by ALM to retrieve the name of the page (tab) that has the index number
specified in PageNum in the following dialog boxes:
l
The Details dialog box for an entity
l
The New <entity> dialog box for an entity
You can add code to this event procedure to customize the tab names for the Details dialog box. For
example, see "Example: Changing Tab Names" on page 430.
Syntax
GetDetailsPageName(PageName, PageNum)
where PageName is the default page (tab) name (for example, Page 1 ) and PageNum is the page (tab)
number.
Note: The page number is the absolute page number, regardless of the page's relative
position in relation to the other displayed pages in the dialog box.
Type
Function
Returns
String containing the page name
Availability GetDetailsPageName (all modules)
HP ALM (12.50)
Page 399
Administrator Guide
Chapter 32: Workflow Event Reference
GetNewBugPageName
This event is triggered by ALM to retrieve the name of the New Defect dialog box page (tab) that has the
index number specified in PageNum.
You can add code to this event procedure to customize the tab names on the New Defect dialog box. For
example, see "Example: Changing Tab Names" on page 430.
Syntax
GetNewBugPageName(PageName, PageNum)
where PageName is the default page (tab) name (for example, Page 1 ) and PageNum is the page (tab)
number.
Note: The page number is the absolute page number, regardless of the page's relative
position in relation to the other displayed pages in the New Defect dialog box.
Type
Function
Returns
String containing the page (tab) name
Availability GetNewBugPageName
Note: The GetNewBugPageName event is not listed in the Scripts Tree of the Script Editor. This
event is triggered for backward compatibility purposes only. GetDetailsPageName should be
used instead.
GetNewReqPageName
This event is triggered by ALM to retrieve the name of the New Requirement dialog box page (tab) that
has the index number specified in PageNum.
You can add code to this event procedure to customize the tab names on the New Requirement dialog
box. For example, see "Example: Changing Tab Names" on page 430.
Syntax
GetNewReqPageName(PageName, PageNum)
where PageName is the default page (tab) name (for example, Page 1 ) and PageNum is the page (tab)
number.
Note: The page number is the absolute page number, regardless of the page's relative
position in relation to the other displayed pages in the New Defect dialog box.
Type
Function
Returns
String containing the page name
Availability GetNewReqPageName
HP ALM (12.50)
Page 400
Administrator Guide
Chapter 32: Workflow Event Reference
Note: The GetNewReqPageName event is not listed in the Scripts Tree of the Script Editor. This
event is triggered for backward compatibility purposes only. GetDetailsPageName should be
used instead.
GetReqDetailsPageName
This event is triggered by ALM to retrieve the name of the Requirement Details dialog box page (tab)
that has the index number specified in PageNum.
You can add code to this event procedure to customize the tab names on the Requirement Details
dialog box. For example, see "Example: Changing Tab Names" on page 430.
Syntax
GetReqDetailsPageName(PageName, PageNum)
where PageName is the default page (tab) name (for example, Page 1 ) and PageNum is the page (tab)
number.
Note: The page number is the absolute page number, regardless of the page's relative
position in relation to the other displayed pages in the New Defect dialog box.
Type
Function
Returns
String containing the page name
Availability GetReqDetailsPageName
Note: The GetReqDetailsPageName event is not listed in the Scripts Tree of the Script Editor.
This event is triggered for backward compatibility purposes only. GetDetailsPageName should
be used instead.
MoveTo
This event is triggered when the user changes focus from one object to another.
You can add code to this event procedure to perform actions when the user changes the focus. For
example, see "Example: Presenting a Dynamic Field List" on page 434.
Tip: When moving from one object to another in a tree, the MoveTo event is not triggered.
However, it is possible to trigger the event for Requirement trees. For details, see the ENABLE_
ENTITY_SELECTION_TREE_REQ_MOVE_TO site parameter.
Syntax
HP ALM (12.50)
<entity>_MoveTo
Page 401
Administrator Guide
Chapter 32: Workflow Event Reference
Type
Sub
Availability
l
AnalysisItem_MoveTo
l
AnalysisItemFolder_MoveTo
l
Baseline_MoveTo
l
Bug_MoveTo
l
BusinessModel_MoveTo
l
BusinessModelActivity_MoveTo
l
BusinessModelFolder_MoveTo
l
BusinessModelPath_MoveTo
l
Component_MoveTo
l
ComponentFolder_MoveTo (formerly MoveToComponentFolder )
l
ComponentStep_MoveTo
l
Cycle_MoveTo
l
DashboardFolder_MoveTo
l
DashboardPage_MoveTo
l
DesignStep_MoveTo
l
Library_MoveTo
l
LibraryFolder_MoveTo
l
Release_MoveTo
l
ReleaseFolder_MoveTo
l
Req_MoveTo
l
Resource_MoveTo
l
ResourceFolder_MoveTo
l
Run_MoveTo
l
Step_MoveTo
l
Test_MoveTo
l
TestConfiguration_MoveTo
l
TestFolder_MoveTo
l
TestSet_MoveTo
l
TestSetFolder_MoveTo
l
TestSetTests_MoveTo
MoveToComponentFolder
This event is triggered when the user moves to the specified component folder in the business
component tree.
Syntax
MoveToComponentFolder(Folder)
where Folder is the IComponentFolder interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
HP ALM (12.50)
Page 402
Administrator Guide
Chapter 32: Workflow Event Reference
Sub
Type
Availability MoveToComponentFolder
Note: The MoveToComponentFolder event is not listed in the Scripts Tree of the Script Editor.
This event is supported for purposes of backward compatibility. We recommend you use
ComponentFolder_MoveTo event instead.
MoveToFolder
This event is triggered when the user moves to the specified test set folder in the test sets tree.
Syntax
MoveToFolder(Folder)
where Folder is the ISysTreeNode interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
Sub
Type
Availability MoveToFolder
Note: The MoveToFolder event is not listed in the Scripts Tree of the Script Editor. This event is
supported for purposes of backward compatibility. We recommend you use MoveToFolder
instead.
MoveToSubject
This event is triggered when the user moves to the specified subject in the test plan tree.
Syntax
MoveToSubject(Subject)
where Subject is the ISysTreeNode interface. For more information, refer to the HP ALM Open Test
Architecture API Reference .
Sub
Type
Availability MoveToSubject
Note: The MoveToSubject event is not listed in the Scripts Tree of the Script Editor. This event is
supported for purposes of backward compatibility. We recommend you use MoveToSubject
instead.
New
This event is triggered when an object is added to ALM.
HP ALM (12.50)
Page 403
Administrator Guide
Chapter 32: Workflow Event Reference
You can add code to this event procedure to perform an action when a new object is added. For
example, see "Example: Customizing a Defects Module Dialog Box" on page 427.
Syntax
<entity>_New
Type
Sub
Availability
l
AnalysisItem_New
l
AnalysisItemFolder_New
l
Baseline_New
l
Bug_New
l
BusinessModelFolder_New
l
BusinessModelPath_New
l
Component_New
l
ComponentFolder_New
l
ComponentStep_New
l
Cycle_New
l
DashboardFolder_New
l
DashboardPage_New
l
DesignStep_New
l
Library_New
l
LibraryFolder_New
l
Release_New
l
ReleaseFolder_New
l
Req_New
l
Resource_New
l
ResourceFolder_New
l
Step_New
l
Test_New
l
TestConfiguration_New
l
TestFolder_New
l
TestSet_New
l
TestSetFolder_New
RemoveComponentFromTest
This event is triggered when the user removes a component from a test of type Flow or BusinessProcess in the Test Script tab.
Version Control: Changing components checked in or checked out by another user, using the
RemoveComponentFromTest event, is not supported.
Syntax
HP ALM (12.50)
RemoveComponentFromTest
Page 404
Administrator Guide
Chapter 32: Workflow Event Reference
Type
Sub
Availability
RemoveComponentFromTest
RunTests
This event is triggered when the user clicks the Run button to run tests in the Test Lab module, provided
that Sprinter is not installed and none of the tests is automated.
Syntax
RunTests(Tests)
where Tests is an array of Test Instance IDs.
Type
Sub
Availability
RunTests
RunTests_Sprinter
This event is triggered:
l
l
When the user clicks the Run arrow and chooses Run with Sprinter to run tests in the Test Lab
module.
When the user clicks the Run button to run tests in the Test Lab module, if Sprinter is installed and all
the tests are manual.
Syntax
RunTests_Sprinter(Tests)
where Tests is an array of Test Instance IDs.
Type
Sub
Availability
RunTests_Sprinter
RunTestSet
This event is triggered when the user clicks the RunTest Set button to run a test set in the Test Lab
module.
Syntax
RunTestSet(Tests)
where Tests is an array of Test Instance IDs.
Type
Sub
Availability
RunTestSet
HP ALM (12.50)
Page 405
Administrator Guide
Chapter 32: Workflow Event Reference
RunTestsManually
This event is triggered when the user clicks the Run arrow and chooses Run Manually to run tests in the
Test Lab module.
Syntax
RunTestsManually(Tests)
where Tests is an array of Test Instance IDs.
Type
Sub
Availability
RunTestsManually
HP ALM (12.50)
Page 406
Chapter 33: Workflow Object and Property
Reference
Workflow scripts can reference HP Application Lifecycle Management (ALM) objects to obtain
information and to change project values. They can also use properties that return information about
the current module and dialog box. This chapter lists the ALM objects and properties that are available
to workflow scripts.
•
•
•
•
•
•
•
•
•
•
About ALM Objects and Properties
408
Actions Object
409
Action Object
409
Fields Objects
411
Field Object
412
Lists Object
413
TDConnection Object
414
User Object
414
ActiveTreeSelection Object
415
ALM Properties
415
HP ALM (12.50)
Page 407
Administrator Guide
Chapter 33: Workflow Object and Property Reference
About ALM Objects and Properties
Workflow scripts can obtain information, make decisions based on that information, and change values
in the project based on those decisions.
You can obtain information such as the user group to which the current user belongs, and the value of a
field, by accessing objects such as the User object or the Field object.
You can also obtain information about the active module and active dialog box using workflow
properties. For more information on these properties, see "ALM Properties" on page 415.
Your script can change the value of a field or field list. To do so, the script modifies the Value property
or the List property of the appropriate Field object.
For information on the event procedures in which you place VBScript code to create workflow scripts,
see "Workflow Event Reference" on page 381.
The following table lists the ALM objects that are available when you write a script.
Object
Description
Actions
The list of actions that are available. See "Actions Object" on the next page.
Action
The Action object is handled by the Actions object. See "Action Object" on the next page.
Fields
Includes the objects that provide access to specific fields. See "Fields Objects" on page 411.
Field
The Field object is handled by the Fields objects. See "Field Object" on page 412.
Lists
Includes the lists that are available in an ALM project. See "Lists Object" on page 413.
TDConnection
Provides access to open test architecture (OTA) objects. See "TDConnection Object" on page 414.
User
Includes the properties of the current user. This object is available in all modules. See "User Object"
on page 414.
ActiveTreeSelection Accesses the list of currently selected entities in active modules that are open test architecture (OTA)
objects. See "ActiveTreeSelection Object" on page 415.
Note: In some cases, a function returns the object itself instead of the ID property of the object.
For example, after the following statement has been executed, testsetf is a reference to a
TestSetFolder object:
Set testsetf = TestSet_Fields("CY_FOLDER_ID").Value.
For information on the Script Editor used to write workflow scripts, see "Working with the Workflow
Script Editor" on page 369.
For each ALM object, this chapter lists the properties of the object. The list includes the property name,
a description, and the data type of the property. It indicates whether the property is read-only (R) or
whether your script can modify it (R/W).
HP ALM (12.50)
Page 408
Administrator Guide
Chapter 33: Workflow Object and Property Reference
Version Control: After enabling version control for a project, you should review all its workflow
scripts and make adjustments for each checked in entity. This includes the following entities:
Req, Test, Resource, and Component. For each checked in entity that includes a Post function in
its script, you must modify the script. To modify, add a Checkout function before every Post
function. Making this modification prevents the Check Out dialog box from opening each time a
call to a Post function is made. For more information about the Post and Checkout functions,
see the HP ALM Open Test Architecture Reference.
For more information on version control, refer to the HP Application Lifecycle Management User
Guide.
Actions Object
You can use the Actions object to manipulate toolbar buttons, menu commands, and dialog boxes.
The Actions object has the following property:
Property
R/W
Type
Description
Action
R
Object
Allows access to every action in a list. The index for this property is the action name.
Action Object
You can use the Action object to verify whether a button or command is enabled, checked, or visible.
You can also use it to execute actions.
For example, to set the Defect Details dialog box to open automatically when the user moves from one
defect to another in the Defects Grid, place the following code in the Bug_MoveTo event procedure:
Set NewDefectAction=Actions.Action("Defects.DefectDetails")
NewDefectAction.Execute
To obtain the name of an action, add the following lines to the ActionCanExecute event procedure,
perform the action, and note the action name that is printed in the message:
Sub ActionCanExecute(ActionName)
On Error Resume Next
MsgBox "You have performed an action named: " & ActionName
On Error GoTo 0
End Sub
HP ALM (12.50)
Page 409
Administrator Guide
Chapter 33: Workflow Object and Property Reference
This object has the following properties:
Property R/W Type
Description
Checked
R/W
Boolean
Indicates whether an action is checked in ALM.
Enabled
R/W
Boolean
Indicates whether an action is enabled. A disabled action cannot be invoked by the user, but can
be invoked from the workflow script.
Visible
R/W
Boolean
Indicates whether an action is visible in ALM.
The Action object includes the following method:
Method
Description
Execute
Executes the action.
When a workflow script invokes an action using the Execute method of the Action object, the workflow
events that would be triggered if a user initiated the action from a dialog box are by default not
triggered. Therefore, when using Action.Execute, you must ensure that you do not bypass the site
policies you are enforcing with workflow events.
To enable workflow events to be triggered from within a dialog box, set the value of the
AllowReentrancy flag to true. To restore the default settings, so that these events are not triggered,
set the value of the AllowReentrancy flag to false. For example, to set the Add Defect dialog box to
open automatically when a user enters the Defects module, place the following code in the EnterModule
event procedure:
AllowReentrancy=true
Set NewDefectAction=Actions.Action("Defects.DefectDetails")
NewDefectAction.Execute
AllowReentrancy=false
If the value of the AllowReentrancy flag is set to false, the dialog box opens as usual, but workflow
customizations will not work in the dialog because the workflow events for the dialog box are not
triggered.
Caution: Consider carefully the implications of setting the value of this flag to true. If you set
the value of the flag to true, you enable a function to call another function which may call the
original function. This can cause an endless loop. This can also occur when functions call internal
functions which call the original function.
HP ALM (12.50)
Page 410
Administrator Guide
Chapter 33: Workflow Object and Property Reference
Fields Objects
You can use the following objects in workflow scripts to access the fields of ALM modules:
Object
Description
AnalysisItem_Fields
Provides access to the fields of the reports and graphs in the Dashboard module.
AnalysisItemFolder_
Fields
Provides access to the fields of the report and graph folders in the Dashboard module.
Baseline_Fields
Provides access to the fields of the baselines in the Libraries module.
Bug_Fields
Provides access to the fields of the defects in the Defects module and the Manual Runner dialog
box.
Component_Fields
Provides access to the fields of components in the Business Components module.
ComponentStep_Fields
Provides access to the fields of component steps in the Business Components module.
Cycle_Field
Provides access to the fields of cycles in the Releases module.
DashboardFolder_Fields
Provides access to the fields of dashboard page folders in the Dashboard module.
DashboardPage_Fields
Provides access to the fields of dashboard pages in the Dashboard module.
DesignStep_Fields
Provides access to the fields of the design steps in the Test Plan module.
Library_Fields
Provides access to the fields of the libraries in the Libraries module.
LibraryFolder_Fields
Provides access to the fields of the library folders in the Libraries module.
Release_Fields
Provides access to the fields of the releases in the Releases module.
ReleaseFolder_Fields
Provides access to the fields of the release folders in the Releases module.
Req_Fields
Provides access to the fields of the Requirements module.
Resource_Fields
Provides access to the fields of the resources in the Test Resources module.
ResourceFolder_Fields
Provides access to the fields of the resource folders in the Test Resources module.
Run_Fields
Provides access to the fields of the test runs in the Manual Runner dialog box.
Step_Fields
Provides access to the fields of the steps in the Manual Runner dialog box.
Test_Fields
Provides access to the fields of tests in the Test Plan module.
TestSet_Fields
Provides access to the fields of the test sets in the Test Lab module.
TestSetTest_Fields
Provides access to the fields of the test instances in the Test Lab module.
HP ALM (12.50)
Page 411
Administrator Guide
Chapter 33: Workflow Object and Property Reference
For example, to set a certain property for all fields in the Req_Fields object, you can refer to each field
by its ID number (Req_Fields.FieldById). To set all fields to be visible (IsVisible)in a dialog box, you can
use the following code:
For i = 1 to Req_Fields.Count
Req_Fields.FieldById(i).IsVisible = True
Next
These objects have the following properties:
Property
R/W
Type
Description
Count
R
Long
Returns the number of fields in the current object.
Field
(FieldName)
R
Object
Accesses the fields by field name or field label.
FieldById
(FieldID)
R
Object
Accesses the fields by the field ID number.
Tip: To avoid errors if your script attempts to access a non-active or a non-existing field,
include On Error Resume Next in the script.
Field Object
You can use the Field object to access the properties of an entity field.
For example, to display a message box when a user does not have permission to change a value in the
Status field, you can use the following code:
Msgbox "You do not have permission to change "_
& "Bug_Fields.Field("BG_STATUS").FieldLabel field."
The Field object has the following properties:
Property
R/W Type
Description
FieldLabel
R
String
The displayed label of the field.
FieldName
R
String
The logical name of the field.
IsModified
R
Boolean
Specifies whether the value was modified.
IsMultiValue R
Boolean
Specifies whether the field can contain multiple values from a lookup list.
IsNull
R
Boolean
Specifies whether the field value is absent.
IsReadOnly
R/W
Boolean
Specifies whether the field is read-only.
IsRequired
R/W
Boolean
Specifies whether a field value is required. This enables you to override field customization
information. To modify the IsRequired property of a field, the IsVisible property must be
True . Changes to IsRequired are ignored if the field is not visible.
HP ALM (12.50)
Page 412
Administrator Guide
Chapter 33: Workflow Object and Property Reference
Property
R/W Type
Description
Users must always enter a value for a field that is set as required by the workflow. This
applies whether they are modifying an existing record or adding a new record, and even if the
field is already empty.
IsVisible
R/W
Boolean
Specifies whether the field is displayed.
List
R/W
List
Sets or retrieves the field list attached to a field of type lookup list.
PageNo
R/W
Integer
Sets or retrieves the page (tab) on which the field is displayed in the New Defect and Defect
Details dialog boxes.
Value
R/W
Variant
Sets or retrieves the value of the field.
ViewOrder
R/W
Integer
Sets or retrieves the order in which the fields are displayed in the New Defect and Defect
Details dialog boxes. You must set the value for every field in the dialog box.
Lists Object
You can use the Lists object to limit field input to a specific list of values.
For example, to set the list in the Planned Closing Version field, depending on the Project field value,
you can use the following code:
If Bug_Fields.Field("BG_PROJECT").Value = "Project 1" Then
Bug_Fields.Field("BG_PLANNED_CLOSING_VER").List _
= Lists("All Projects")
' ...
End If
For more information, see "Example: Presenting a Dynamic Field List" on page 434.
The Lists object can be used only with fields that are defined as the Lookup List type or the String type
in Project Customization of project entities.
The Lists object has the following properties:
Property
R/W
Type
Description
List
R
ISysTreeNode
Accesses the ALM lists.
Note: When workflow customization has been used to change a list of values for a field that has
transition rules defined, the field may only be modified in a way that satisfies both the workflow
script and the transition rules. For more information, see "Setting Transition Rules" on page
245.
HP ALM (12.50)
Page 413
Administrator Guide
Chapter 33: Workflow Object and Property Reference
TDConnection Object
In workflow scripts, the only objects that are available are the objects of the module in which the code is
written and a limited number of global objects. One of the global objects is the TDConnection object.
TDConnection provides access to the open test architecture (OTA) objects.
You can use the TDConnection object to access objects from other modules, and to access general
session parameters. You can access TDConnection properties in any procedure, from any module.
For more information about the TDConnection object, and a list of TDConnection properties, refer to
the HP ALM Open Test Architecture API Reference.
For examples of using the TDConnection object in workflow scripts, see "Workflow Examples and Best
Practices" on page 419.
User Object
You can access the User object to retrieve the user name of the current user and to check whether the
user belongs to a particular user group. You can retrieve or modify the first and last name of the user.
For example, to have a message box open when the user has project administrator permissions, use the
following code:
If User.IsInGroup("TDAdmin") Then
MsgBox "The user " & User.FullName & _
" has administrative permissions for this project."
End If
For more information, see "Example: Changing a Field Based on the User Group" on page 432, and
"Example: Controlling User Permissions" on page 436.
To access user properties that cannot be accessed by the User object, you can use the TDConnection
object of the ALM open test architecture (OTA).
The User object has the following properties:
Property
R/W Type
Description
FullName
R/W
String
Sets or retrieves the first and last name of the current user.
IsInGroup
(GroupName)
R
Boolean
Checks whether or not the current user is a member of a predefined/user-defined
group.
UserName
R
String
Returns the user name used when logging in to ALM.
HP ALM (12.50)
Page 414
Administrator Guide
Chapter 33: Workflow Object and Property Reference
ActiveTreeSelection Object
You can use the ActiveTreeSelection object to access the list of currently selected entities in active
module that are open test architecture (OTA) objects. You can retrieve or modify selected entities by
iterating through the list.
For more information about OTA objects, and a list of OTA object properties, refer to the HP ALM Open
Test Architecture API Reference.
ALM Properties
You can use the ActiveModule and ActiveDialogName properties to obtain information about the active
module and dialog box.
This section includes:
•
•
ActiveModule Property
416
ActiveDialogName Property
416
HP ALM (12.50)
Page 415
Administrator Guide
Chapter 33: Workflow Object and Property Reference
ActiveModule Property
The ActiveModule property returns the name of the active ALM module. The following values can be
returned:
l
Releases
l
Libraries
l
Analysis
l
Dashboard
l
Requirements
l
Business Models
l
Test Resources
l
Business Components
l
Test Plan
l
Test Lab
l
Test Runs
l
Defects
Example
To open a message box displaying the module name when you move to a new module, use the
following code:
Sub EnterModule
On Error Resume Next
msgbox "You have just entered the " & ActiveModule & _
" module."
On Error GoTo 0
End Sub
ActiveDialogName Property
The ActiveDialogName property returns the name of the active dialog box.
Example
HP ALM (12.50)
Page 416
Administrator Guide
Chapter 33: Workflow Object and Property Reference
To open a message box displaying the dialog box name when you open a new dialog box, use the
following code:
Sub DialogBox(DialogBoxName, IsOpen)
On Error Resume Next
msgbox "You have just opened the " & ActiveDialogName & _
" dialog box."
On Error GoTo 0
End Sub
HP ALM (12.50)
Page 417
Administrator Guide
Chapter 33: Workflow Object and Property Reference
HP ALM (12.50)
Page 418
Chapter 34: Workflow Examples and Best
Practices
This chapter provides considerations and examples for workflow scripts.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
About the Workflow Examples
420
Best Practices for Writing Workflow Scripts
420
Example: Customizing a Defects Module Dialog Box
427
Example: Changing Tab Names
430
Example: Adding a Template to a Memo Field
431
Example: Changing One Field Based on Another Field
431
Example: Changing a Field Based on the User Group
432
Example: Object Validation
433
Example: Field Validation
433
Example: Presenting a Dynamic Field List
434
Example: Changing Field Properties when a Field Changes
435
Example: Controlling User Permissions
436
Example: Adding Button Functionality
436
Example: Error Handling
437
Example: Obtaining Session Properties
438
Example: Sending Mail
438
Example: Storing the Last Values Entered
440
Example: Copying Field Values to Another Object
442
HP ALM (12.50)
Page 419
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
About the Workflow Examples
The workflow examples presented in this chapter perform several types of tasks. The following table
lists the examples that illustrate each type of task.
Workflow Task
See Examples
dialog box customization
"Example: Customizing a Defects Module Dialog Box" on page 427
"Example: Changing Tab Names" on page 430
field value automation
"Example: Adding a Template to a Memo Field" on page 431
"Example: Changing One Field Based on Another Field" on page 431
"Example: Changing a Field Based on the User Group" on page 432
data validation
"Example: Object Validation" on page 433
"Example: Field Validation" on page 433
dynamic field customization
"Example: Presenting a Dynamic Field List" on page 434
"Example: Changing Field Properties when a Field Changes" on page 435
user permission control
"Example: Controlling User Permissions" on page 436
functionality
"Example: Adding Button Functionality" on page 436
error handling
"Example: Error Handling" on page 437
using OTA to obtain session parameters
"Example: Obtaining Session Properties" on page 438
sending mail
"Example: Sending Mail" on page 438
using the Settings object
"Example: Storing the Last Values Entered" on page 440
copying values between modules
"Example: Copying Field Values to Another Object" on page 442
Best Practices for Writing Workflow Scripts
This section describes best practices for writing workflow scripts and making sure the scripts run as
expected. In addition to the best practices provided in this section, you can refer to the Microsoft
Developer Network VBScript Language Reference at http://msdn.microsoft.com/en-us/library/.
The following best practices are described in this section:
General VBScript Tips and Best Practices
l
"Checking Value Types Before Use" on the next page
l
"Anticipating Full Evaluation of Logical Expressions" on page 422
l
"Defining Default Behavior for Select Case and If-Then-Else Statements" on page 423
l
"Setting Return Values in Functions" on page 424
HP ALM (12.50)
Page 420
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
ALM Workflow Tips and Best Practices
l
"Making Sure that Entity Properties Are Set Before an Entity Comes into Focus" on page 424
l
"Check if a Dialog Box is Open" on page 426
l
"Avoid Defining Duplicate Subroutines" on page 427
Checking Value Types Before Use
VBScript is a "weakly-typed" programming language. This means that you can create, use, and access
data values without initially declaring their types. However, certain operations can be performed only on
values of a specific type. Therefore, it is important to check the type of the data before performing any
operations on them.
Values of different types behave differently in different statements. Object value behavior is even more
unpredictable because the behavior depends on the object's implementation. For example, the object in
the call <entity>_CanDelete(Entity) can either be text or a subject node.
Recommendations
To avoid unpredictable results:
l
Check value types before use, especially for object types. When checking an object type, also check
that the object has the properties you access.
Note: In the examples provided in this chapter, only object types are checked before use.
l
l
l
l
l
Assume as little as possible—do not assume that a value is of a certain type. Write scripts that can
handle all possibilities by using Else statements and Select Case statements.
Always check parameter types before use with various VBScript functions, such as IsArray, IsDate,
IsNull, IsEmpty, IsNumeric, and IsObject.
Do not assume an object's default property is of a specific type; the type can vary from object to
object.
Use VBScript built-in conversion functions to achieve a degree of type safety.
When working with objects, check that the value you receive is neither Null or Empty by calling the
IsNull and IsEmpty functions.
HP ALM (12.50)
Page 421
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Examples
For the purposes of the following examples, assume the field values are declared as in the table
below.
Field Values
Type
Bug_Fields["BG_BUG_ID"].Value
Integer
Bug_Fields["BG_SUMMARY"].Value
String
Bug_Fields["BG_SUBJECT"].Value
Object implementing the ISysTreeNode interface
In the following example, statement usage is correct. The integer is converted to a string.
If Bug_Fields["BG_BUG_ID"].Value = "10" Then...
In the following example, statement usage is correct. The strings are comparable.
If Bug_Fields["BG_SUMMARY"].Value = "some text" Then...
In the following example, statement usage is incorrect. This code can work only when the value
of BG_SUBJECT field is neither Empty or Null. VBScript also assumes that this objects's default
value (meaning, the default property) is either of string type or is comparable with the string
type, which is not always the case.
If Bug_Fields["BG_SUBJECT"].Value = "My Tests" Then...
Anticipating Full Evaluation of Logical Expressions
The VBScript programming language does not short-circuit evaluation of Boolean conditions. VBScript
evaluates all the terms in a Boolean logical expression, even if the expression can be established as
True or False without evaluating all its terms. For example, in the following example, both
<statement1> and <statement2> are evaluated, even if <statement1> resolves to False:
<statement 1> AND <statement 2>
Recommendations
To avoid errors, check that all values and objects are not Null before attempting to use them.
Examples
The following examples:
l
demonstrate incorrect and correct usage of logical expressions
l
take into consideration how logical expressions are evaluated
HP ALM (12.50)
Page 422
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Incorrect Usage
value.Name is evaluated even when its value is Null. This causes an error.
Sub namecheck(value)
If Not IsNull(value) And value.Name = "aName" Then
' ...
End If
End Sub
Correct Usage
The code is correct on the condition that value is an object that contains the Name property.
The code runs without errors.
Sub namecheck(value)
If Not IsNull(value) And Not IsEmpty(value) Then
If value.Name = "aName" Then
' ...
End If
End If
End Sub
Defining Default Behavior for Select Case and If-Then-Else
Statements
Unpredictable results can occur when no default action is defined for Select Case statements or IfThen-Else statements.
Recommendations
To avoid unpredictable results, always define default behavior when using Select Case of If-Then-Else
statements.
Example
The following are examples of incorrect and correct ways to define default behavior for
situations not covered by the existing Select Case and If-Then-Else statements.
Incorrect Usage
The author of this subroutine intends for the BG_USER_01 field to be visible only if the status of
the defect is Open, New, or Reopen. However, if the IsVisible property of a Closed or Fixed defect
was set to True prior to the instance of this subroutine, that Closed or Fixed defect will also be
HP ALM (12.50)
Page 423
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
visible. This is because there is no case statement defined specifically for Closed and Fixed
defects.
Sub Bug_FieldChange(FieldName)
If FieldName="BG_STATUS" Then
Select Case Bug_Fields(FieldName).Value
Case "Open", "New", "Reopen" _
Bug_Fields("BG_USER_01").IsVisible = True
End Select
End If
End Sub
Correct Usage
This subroutine effectively handles all possible cases.
Sub Bug_FieldChange(FieldName)
If FieldName="BG_STATUS" Then
Select Case Bug_Fields(FieldName).Value
Case "Open", "New", "Reopen"
Bug_Fields("BG_USER_01").IsVisible = True
Case Else
Bug_Fields("BG_USER_01").IsVisible = False
End Select
End If
End Sub
Setting Return Values in Functions
If a function ends without a return value, unpredictable and inconsistent results may occur. Also, it is
difficult to debug behavior if a return code is not set.
Recommendations
To avoid unpredictable results, set a default return value at the beginning of each function.
Making Sure that Entity Properties Are Set Before an Entity
Comes into Focus
It is common practice to set entity properties (such as IsVisible, IsRequired, and List) when creating or
modifying a new entity (New or FieldChanged). When writing ALM workflow scripts, it is also important to
set entity properties when the entity comes into focus (meaning, when the user navigates to that entity
in the ALM graphical user interface). When an entity comes into focus, the MoveTo event is called.
HP ALM (12.50)
Page 424
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
If entity values are not set in the MoveTo event, the end user experience is unpredictable—for example,
incorrect values might be displayed in drop-down lists.
Recommendations
To avoid unpredictable results, such as a drop-down list not containing the most up-to-date set of
values:
l
l
Make sure that all entity properties are set in the MoveTo event—not just in the New or
FieldChanged events.
Isolate entity properties customization code into a separate routine and call that routine from all
relevant events.
Example
The following table provides an example of how to make sure that properties of a defect are
set appropriately when the defect is in focus—and not just when it is modified or added.
Sub SetupBugFields(Context1, Context2)
' Code for customizing defect properties is entered here,
' such as set IsVisible, IsRequired, IsReadonly, Label, List...
If Context1="Focus" Then
' Code for handling the focus event is entered here
ElseIf Context1="FieldChange" Then
If Context2="RQ_USER_01" Then
' Code for handling the FieldChange event
' is entered here
ElseIf Context2="RQ_REQ_STATUS" Then
' ... Enter your code here
Else
' ... Enter your code here
End If
End If
End Sub
Sub Req_FieldChange(FieldName)
If FieldName = "RQ_REQ_STATUS" Then
SetupBugFields("FieldChange", FieldName)
Else
' ...Enter your code here
End If
End Sub
Sub Req_MoveTo
SetupBugFields("Focus")
End Sub
HP ALM (12.50)
Page 425
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Check if a Dialog Box is Open
It is helpful to track whether a dialog box is open before performing certain actions. For example:
l
Dialog boxes do not need to be refreshed but grid displays do.
l
Certain workflow events are not allowed when a dialog box is open.
The DialogBox event can be used to track the visibility of dialog boxes.
Recommendations
To avoid unpredictable results, determine if a dialog box is open before any events occur.
Example
The following example checks whether the dialog box for creating a new defect is open. This is
relevant because the BG_USER_01 field can only be modified for a new defect. If a different
dialog box is open, such as the dialog box for editing a defect, the BG_USER_01 field cannot be
modified.
' Declare a global variable for each dialog box of interest
Dim NewDefectDialogIsOpen
' Initialize the global variable
NewDefectDialogIsOpen = False
Sub DialogBox(DialogBoxName, IsOpen)
If DialogBoxName="New Bug" Then
NewDefectDialogIsOpen = True
Else
NewDefectDialogIsOpen = False
End If
End Sub
Function Bug_FieldCanChange(FieldName, NewValue)
' Initialize the function's return value to avoid
' unpredictable behavior.
Bug_FieldCanChange = True
' The BG_USER_01 field can only be modified for a new defect.
If FieldName="BG_USER_01" Then
If NewDefectDialogIsOpen Then
Bug_FieldCanChange = True
Else
Bug_FieldCanChange = False
End If
End If
End Function
HP ALM (12.50)
Page 426
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Avoid Defining Duplicate Subroutines
If you define a subroutine in one section and then add another subroutine with the same name in
another section, the subroutines will conflict. One of them will be ignored.
Example: If you define the subroutine, MySub, in the Test Lab module script section, and then
define another subroutine, MySub, in the Manual Runner script section, one of your defined
subroutines will be ignored.
Recommendations
To avoid unpredictable conflicts when defining subroutines, always check if another subroutine with the
same name already exists in your project.
Example: Customizing a Defects Module Dialog Box
This example shows how you can customize the field layout and other field properties in the Add Defect
dialog box. You can create similar code to arrange the layout of the Defect Details dialog box.
This example illustrates a solution that customizes field properties for all user groups. You can also use
the script generators to customize the layout of the Defects module dialog boxes. If you use the script
generators, you must perform customization separately for each user group. For information on these
script generators, see "Customizing Defects Module Dialog Boxes" on page 359.
This example involves the following procedures:
l
l
SetFieldApp is a general purpose procedure that receives a field name and its properties as
parameters, and assigns the properties to the field. See "SetFieldApp" on the next page.
FieldCust_AddDefect calls SetFieldApp for each field in the Add Defects dialog box, to set the
properties of the field. For some of the fields, FieldCust_AddDefect checks the user group to which
the current user belongs, and customizes the field properties accordingly. A call to FieldCust_
AddDefect is placed in the Bug_New event procedure. See "FieldCust_AddDefect" on the next page.
Note: To implement this example, you can run the Add Defect Field Customization script
generator and then modify the resulting scripts.
l
Rename the generated function WizardFieldCust_Add to FieldCust_AddDefect and
modify it as necessary. (Before you modify a generated script, you must rename it so that
it is not overwritten the next time you run the script generator.)
l
The script generator places a call to WizardFieldCust_Add in the event procedure Bug_
New.Change this to FieldCust_AddDefect.
HP ALM (12.50)
Page 427
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
l
The function SetFieldApp is generated when you run the script generator. You do not need
to rename or modify this function.
SetFieldApp
The subroutine SetFieldApp receives a field name and its properties as parameters, and assigns the
properties to the field.
The subroutine assigns the following field properties: field visibility, whether the field is required, the
number of the page (tab) on which the field should be displayed, and the view order (from left to right
and from top to bottom).
Add a call to the subroutine SetFieldApp in the user-defined function FieldCust_AddDefect. For more
information on this function, see "FieldCust_AddDefect" below.
Sub SetFieldApp(FieldName, Vis, Req, PNo, VOrder)
On Error Resume Next
With Bug_Fields(FieldName)
.IsVisible = Vis
.IsRequired = Req
.PageNo = PNo
.ViewOrder = VOrder
End With
PrintError "SetFieldApp"
On Error GoTo 0
End Sub
FieldCust_AddDefect
The user-defined function FieldCust_AddDefect calls the function SetFieldApp.
The function first sets all fields to be invisible, not required, and to appear on page 100 at location 0.
This ensures that if you add a new field using the Project Entities link on the Project Customization
window, the layout will not be changed.
Add a call to FieldCust_AddDefect in the Bug_New event procedure so that it will be triggered when a
user adds a new defect:
Sub Bug_New
FieldCust_AddDefect
End Sub
First, the code handles the fields that are common to all user groups. It uses conditional statements for
the fields that will appear in the dialog box only for specific user groups, or that will have different
properties for different users.
HP ALM (12.50)
Page 428
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Sub FieldCust_AddDefect
On Error Resume Next
' Initialize the fields of the defect
For i= 0 To Bug_Fields.Count -1
SetFieldApp Bug_Fields.FieldByID(i).FieldName, _
False, False, 100, 0
Next
ViewNum = 0
PageNum = 0
' Set fields that are in common for all user groups
SetFieldApp "BG_BUG_ID", True, True, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_DESCRIPTION", True, False, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_SUMMARY", True, True, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_DETECTED_BY", True, True, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_DETECTION_DATE", _
True, True, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_DETECTION_VERSION", True, True, PageNum, _
ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_SEVERITY", True, True, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_PRIORITY", True, True, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_PROJECT", True, False, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_REPRODUCIBLE", True, False, PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_STATUS", True, False, PageNum, ViewNum
ViewNum = ViewNum + 1
' Set fields that are different for different user groups.
' Since one user can belong to multiple user groups,
' or none of these groups, there is no need for an Else statement.
If User.IsInGroup("Developer") Then
SetFieldApp "BG_PLANNED_CLOSING_VERSION", True, False, _
PageNum, ViewNum
ViewNum = ViewNum + 1
SetFieldApp "BG_PLANNED_FIX_TIME", True, False, PageNum, _
ViewNum
ViewNum = ViewNum + 1
End If
If User.IsInGroup("QATester") Then
PageNum = PageNum + 1
SetFieldApp "BG_USER_01", True, False, PageNum, ViewNum
HP ALM (12.50)
Page 429
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
ViewNum = ViewNum + 1
SetFieldApp "BG_USER_02", True, False, PageNum, ViewNum
ViewNum = ViewNum + 1
End If
SetFieldApp "BG_ACTUAL_FIX_TIME", True, False, PageNum, _
ViewNum
ViewNum = ViewNum + 1
' ...
PrintError "FieldCust_AddDefect"
On Error GoTo 0
End Sub
Example: Changing Tab Names
You can change the names of the tabs on the Add Defect dialog box. This example sets the tabs to
General, Environments, and Business Case.
Add the following code to the GetNewBugPageName event procedure, which is triggered before ALM
opens the Add Defect dialog box. To change the tab names on the Defect Details dialog box, add similar
code to the Defects_GetDetailsPageName event procedure.
Sub Bug_New
On Error Resume Next
Bug_Fields.Field("BG_ACTUAL_FIX_TIME").PageNo = 1
Bug_Fields.Field("BG_ESTIMATED_FIX_TIME").PageNo = 2
On Error GoTo 0
End Sub
Function GetDetailsPageName(PageName,PageNum)
On Error Resume Next
if ActiveDialogName = "New Bug" then
Select case PageNum
case "1"
GetDetailsPageName="General"
case "2"
GetDetailsPageName="Environments"
case else
GetDetailsPageName="Business Case"
End Select
end if
On Error GoTo 0
End Function
HP ALM (12.50)
Page 430
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Example: Adding a Template to a Memo Field
You can use workflow scripts to add a default template to a memo field. This example adds text to a
memo field called Business Case to display the following template:
Perform this customization by placing the HTML code for the text into the BG_USER_25 field when a
defect is added. This example assumes that the user-defined field BG_USER_25 stores a business case
string.
Add the code to the Bug_New event procedure, which is triggered when a user adds a new defect.
Sub Bug_New
On Error Resume Next
Bug_Fields("BG_USER_25").value = _
"<html><body><b>Step by step scenario:</b>" & _
"<br><br><br><b>How it affects the user:</b></body></html>"
PrintError "Bug_New"
On Error GoTo 0
End Sub
Example: Changing One Field Based on Another Field
This example demonstrates how you can change a field value based on the value entered into another
field.
For example, you can cause defects to be assigned to user alex_qc when UI Suggestion is typed into
the Category field, and to user alice_qc when Security Issues is typed.
The example assumes that the user-defined field BG_USER_05 is used to store the category. When the
Category field is changed in the Defects module, the BG_RESPONSIBLE field is assigned the appropriate
value.
HP ALM (12.50)
Page 431
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Add the code to the Bug_FieldChange event procedure so that it is triggered when a user changes a field
value for a defect.
Sub Bug_FieldChange(FieldName)
On Error Resume Next
If FieldName = "BG_USER_05" then
Select case Bug_Fields("BG_USER_05").Value
case "UI Suggestion"
Bug_Fields("BG_RESPONSIBLE").value="alex_qc"
case "Security Issue"
Bug_Fields("BG_RESPONSIBLE").value="alice_qc"
Case Else
Bug_Fields("BG_RESPONSIBLE").value="non-assigned"
End Select
End If
PrintError "Bug_FieldChange"
On Error GoTo 0
End Sub
Example: Changing a Field Based on the User Group
This example demonstrates how you can change a field value according to the user group of the user
entering the defect.
In this example, the user-defined field BG_USER_01 is a detection mode field in which the user who
detected the defect can enter the way in which it was discovered. Possible values are Formal testing,
Informal testing, and BTW.
The example sets the value of the detection mode field to BTW when a defect is opened by a user who is
not in the QA Tester group. If the defect is opened by a user who is in the QA Tester group, the
default value Formal testing is set.
Add the code to event procedure Bug_New, so that it is triggered when a defect is added.
Sub Bug_New
On Error Resume Next
If not User.IsInGroup("QATester") then
Bug_Fields("BG_USER_01").Value = "BTW"
Else
Bug_Fields("BG_USER_01").Value = "Formal testing"
End If
PrintError "Bug_New"
On Error GoTo 0
End Sub
HP ALM (12.50)
Page 432
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Example: Object Validation
This example demonstrates how you can perform validations of all fields by using the CanPost event
procedure. For example, this code segment ensures that a user cannot reject a defect without adding a
comment.
In this example, a user may not post a defect where the defect status (BG_STATUS) has been changed
to Rejected unless some explanatory text has been typed in the R&D Comment field (BG_DEV_
COMMENTS).
Add the code to the Bug_CanPost event procedure so that the check is performed when the user
attempts to submit the defect.
Function Bug_CanPost
' Initialize the function's return value
' to avoid unpredictable behavior.
Bug_CanPost = False
On Error Resume Next
If Bug_Fields("BG_STATUS").IsModified and _
Bug_Fields("BG_STATUS").Value = "Rejected" and _
not Bug_Fields("BG_DEV_COMMENTS").IsModified then
Bug_CanPost = False
msgbox "You must enter a comment when rejecting a defect."
Else
Bug_CanPost = True
End If
PrintError "Bug_CanPost"
On Error GoTo 0
End Function
Example: Field Validation
This example demonstrates how to validate a single field value. For example, the following code
segment shows how you can ensure that a user in a specific group cannot lower the priority of a defect.
In this example, if the user is in the QATester group and the BG_PRIORITY field is being modified, the
new value of the BG_PRIORITY field cannot be lower than the current value.
This example assumes that in the Priority field list for the project, lower priorities come first when the
values are sorted in ascending order. For example, the list meets this requirement if the elements are
as follows: 1-Low, 2-Medium, 3-High.
Add the code to the Bug_FieldCanChange event procedure so that it is triggered when the user
attempts to change a defect field value.
Function Bug_FieldCanChange(FieldName, NewValue)
' Initialize the function's return value
HP ALM (12.50)
Page 433
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
' to avoid unpredictable behavior.
Bug_FieldCanChange = True
On Error Resume Next
If User.IsInGroup("QATester") and FieldName ="BG_PRIORITY" _
Then
If NewValue < Bug_Fields("BG_PRIORITY").Value then
Bug_FieldCanChange = False
msgbox "You do not have permission to lower " _
& "defect priority."
Else
Bug_FieldCanChange = True
End If
Else
' Enter your code here.
End If
PrintError "Bug_FieldCanChange"
On Error GoTo 0
End Function
Example: Presenting a Dynamic Field List
This example demonstrates how you can present a different field list in a field, depending on the value
of another field.
The user-defined function SW_SetLists_Environment checks the value of the Environment
Specification field and assigns the appropriate field list to the Environment Type field.
This example assumes that the field lists have been defined in the project. For more information, see
"Customizing Project Lists" on page 266.
Note: To use workflow scripts to change or create lists that can be assigned to fields, you must
use the Open Test Architecture (OTA) interface.
Add code to the Bug_MoveTo event procedure so that the user-defined function SW_SetLists_
Environment is called when the user changes focus in the defects module.
Sub Bug_MoveTo()
On Error Resume Next
SW_SetLists_Environment
PrintError "Bug_MoveTo"
On Error GoTo 0
End Sub
Add code to the Bug_FieldChange event procedure so that the user-defined function SW_SetLists_
Environment is called when a user changes the value of the Environment Type field in the Defects
module.
HP ALM (12.50)
Page 434
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Sub Bug_FieldChange(FieldName)
On Error Resume Next
If FieldName = "BG_USER_01" then
SW_SetLists_Environment
Else
' Enter your code here.
End If
PrintError "Bug_FieldChange"
On Error GoTo 0
End Sub
The user-defined function SW_SetLists_Environment checks the value of the Environment
Specification field (BG_USER_02) and assigns the appropriate field list to the Environment Type field
(BG_USER_01).
Sub SW_SetLists_Environment()
Dim listName
On Error Resume Next
Select Case Bug_Fields("BG_USER_01").Value
Case "Browser"
listName = "Browsers"
Case "Database Type"
listName = "Database Type"
Case "Operating System"
listName = "Platform"
Case "Web Server"
listName = "Web Server"
Case Else
listName = "Environment Specification"
End Select
Bug_Fields("BG_USER_02").List = Lists(listName)
PrintError ("Set Environment List")
On Error GoTo 0
End Sub
Example: Changing Field Properties when a Field
Changes
This example demonstrates how you can change the properties of a field when a different field is
changed.
In this example, if the status of the defect (BG_STATUS) is changed to Closed, the user must provide a
value in the field Closed in Build (BG_CLOSING_VERSION).
Add the code to the Bug_FieldChange event procedure, to make the Closed in Build field a required
field if the status is changed to Closed.
HP ALM (12.50)
Page 435
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Sub Bug_FieldChange(FieldName)
On Error Resume Next
If FieldName= "BG_STATUS" then
If Bug_Fields("BG_STATUS").value="Closed" then
Bug_Fields("BG_CLOSING_VERSION").IsRequired=True
Else
Bug_Fields("BG_CLOSING_VERSION").IsRequired=False
End If
Else
' Enter your code here.
End If
PrintError "Bug_FieldChange"
On Error GoTo 0
End Sub
Example: Controlling User Permissions
This example demonstrates how you can prevent members of specific user groups from performing an
action.
The code allows a user to replace a defect field value only if the user belongs to the Admin user group.
Add the code to the ActionCanExecute event procedure so that the check is performed when a user
attempts to execute an action.
Function ActionCanExecute(ActionName)
' Initialize the function's return value
' to avoid unpredictable behavior.
ActionCanExecute = False
On Error Resume Next
If ActionName = "UserDefinedActions.BugReplaceAction1" _
And Not User.IsInGroup("Admin") then
ActionCanExecute = False
msgbox "You do not have permission to perform this action"
Else
ActionCanExecute = True
End If
PrintError "ActionCanExecute"
On Error GoTo 0
End Function
Example: Adding Button Functionality
This example opens a calculator when a user clicks a button defined with action name Calculator. For
more information about adding user-defined buttons, see "Adding a Button to a Toolbar" on page 376.
HP ALM (12.50)
Page 436
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Add the code to the ActionCanExecute event procedure, so that it is triggered when a user initiates
an action.
For information about the Wscript.Shell object, refer to the Microsoft documentation. To access help
for the VBScript language, choose Help > VBScript Home Page in the Script Editor.
Function ActionCanExecute(ActionName)
' Initialize the function's return value to
' avoid unpredictable behavior.
ActionCanExecute = DefaultRes
On Error Resume Next
If ActionName = "UserDefinedActions.Calculator" Then
Set shell = CreateObject("Wscript.Shell")
shell.Run "Calc"
Set shell = Nothing
End If
ActionCanExecute = DefaultRes
PrintError "ActionCanExecute"
On Error GoTo 0
End Function
Example: Error Handling
This example demonstrates how you can display a standard error message. Error handling should be
added to each workflow script that you write, because errors that are not detected by the workflow
code can cause the user's browser to crash.
The user-defined function PrintError receives the name of the calling procedure as a parameter. If an
error has occurred, PrintError prints out the error number, description and severity, and the name of
the procedure in which the error occurred.
You do not need to create an Err object, because it is intrinsic to VBScript. For more information about
the Err object, refer to the Microsoft documentation.
Sub PrintError(strFunctionName)
If Err.Number <> 0 Then
MsgBox "Error #" & Err.Number & ": " & Err.Description, _
vbOKOnly+vbCritical, _
"Workflow Error in Function " & strFunctionName
End If
End Sub
The following code segment illustrates how you can add error handling to your subroutines.
Sub <sub_name>()
On Error Resume Next
...
[Your code here]
...
HP ALM (12.50)
Page 437
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
PrintError "<sub_name>"
End Sub
The following code segment illustrates how you can add error handling to your functions.
Function <function_name>()
On Error Resume Next
...
[Your code here]
...
PrintError "<function_name>"
End Function
Example: Obtaining Session Properties
This example demonstrates how to use the TDConnection object to obtain the properties of the current
session. Add the code to the procedure where these properties are needed. The properties do not
depend on each other, so each of the properties can be retrieved separately.
The following are examples of session properties:
TDConnection.ServerName
TDConnection.ServerTime
TDConnection.DomainName
TDConnection.ProjectName
User.UserName
Note that there is no need to use TDConnection to retrieve the user name because the workflow has a
predefined User object. For more information, see "TDConnection Object" on page 414.
The example below tests the first five characters of the server URL to determine whether the user is
connected to the server using HTTP or HTTPS:
If Left(UCase(TDConnection.ServerName), 5) = "HTTPS" Then
MsgBox "You are currently connected to the server using SSL."
Else
MsgBox "You are not using SSL."
End If
Example: Sending Mail
These examples demonstrate how to use the TDConnection object to send mail when a defect is
submitted, and to send mail when a field value changes in the Test Plan module.
Sending Mail when a Defect is Submitted
This example sends mail when a defect is submitted.
HP ALM (12.50)
Page 438
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Add a call to the SendDefect procedure in the Bug_AfterPost event procedure.
Note: If the SendDefect procedure is called before the defect is submitted, the values that
were changed in the current modification will not be included. The database is updated with the
new values only after the defect is posted.
Sub SendDefect (iObjectId, strTo, strCc, strSubject, strComment)
On Error Resume Next
Dim objBugFactory, objBug
Set objBugFactory = TDConnection.BugFactory
Set objBug = objBugFactory.Item(iObjectId)
objBug.Mail strTo, strCc, 2, strSubject, strComment
Set objBug = Nothing
Set objBugFactory = Nothing
PrintError "SendDefect"
On Error GoTo 0
End Sub
The constant 2 in the call to objBug.Mail indicates that the history should be included with the mail.
For a list of the constants that can be used to customize email, refer to the tagTDMAIL_FLAGS
enumeration in the HP ALM Open Test Architecture API Reference. In workflow scripts, use numeric
constants and not the enumeration values.
Sending Mail when a Test Plan Module Field Value Changes
The example below demonstrates mail notification when the value of the status field is changed in the
Test Plan module.
The code is added to the Test_FieldChange event procedure. It constructs a subject and comment for
the email, and calls a user-defined function, SendTest. SendTest sends mail from the Test Plan module.
You can code SendTest similarly to the SendDefect subroutine shown in "Sending Mail when a Defect
is Submitted" on the previous page.
Sub Test_FieldChange(FieldName)
On Error Resume Next
Dim strSubject, strComment
If FieldName = "TS_STATUS" Then
strSubject = "Test Change Notification" & _
" for project " & TDConnection.ProjectName & _
" in domain " & TDConnection.DomainName
strComment = "The user " & User.FullName & _
" changed the status of the test " & _
Test_Fields("TS_NAME").Value & _
" to " & Test_Fields("TS_STATUS").Value
SendTest Test_Fields("TS_TEST_ID").Value, _
Test_Fields("TS_RESPONSIBLE").Value, "[QA Testers]", _
strSubject, StrComment
HP ALM (12.50)
Page 439
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
End If
End Sub
Example: Storing the Last Values Entered
This example shows how to use the TDConnection object to implement persistent data between actions.
The lifetime of a variable in a routine is only for the routine run. Therefore, persistent data must be
stored if it must be available later. It is recommended that you use the ALM API to store persistent data
whenever possible instead of using external objects, files, or the registry.
In this example, a user-defined function SW_KeepLastValue uses the Settings object to save the
values typed into the fields BG_DETECTION_VERSION, BG_USER_01, and BG_USER_03 when a user
posts a defect. These values are retrieved and assigned as default values when this user adds a new
defect.
The user-defined function is called with the SET action from Bug_CanPost, before a new defect is
posted by the user. The values in the fields are stored.
Function Bug_CanPost()
' Initialize the function's return value to
' avoid unpredictable behavior.
Bug_CanPost = True
If Bug_Fields("BG_BUG_ID").Value = "" Then
SW_KeepLastValue ("SET")
End If
End Function
The function is called with the GET action from the Bug_New event procedure. When a user adds a new
defect, the values stored in the fields for this user are entered into these fields.
Sub Bug_New()
SW_KeepLastValue ("GET")
End Sub
Depending on the action passed as a parameter, the user-defined function SW_KeepLastValue stores
the values of the fields in the common settings table for the current user, or reads the values from the
Settings object and assigns the values to the appropriate fields.
Sub SW_KeepLastValue(action)
Dim tdc, vals, flds
Dim uset, pairs, pair
Dim bld
On Error Resume Next
bld = ""
Set tdc = TDConnection
Set uset = tdc.UserSettings
If action = "SET" Then
flds = Array("BG_DETECTION_VERSION", _
"BG_USER_01", "BG_USER_03")
HP ALM (12.50)
Page 440
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
vals = ""
For i = 0 To UBound(flds)
If vals <> "" Then vals = vals & ";"
vals = vals & flds(i) & "=" & _
Bug_Fields(flds(i)).Value
Next
'Open category KeepLValueSetting
uset.Open ("KeepLValueSetting")
'Setting KeepValueFields in category KeepLValueSetting
uset.Value("KeepValueFields") = vals
uset.Close
End If 'SET
If action = "GET" Then
uset.Open ("KeepLValueSetting")
vals = uset.Value("KeepValueFields")
If vals <> "" Then
pairs = Split(vals, ";")
For i = 0 To UBound(pairs)
pair = Split(pairs(i), "=")
If UBound(pair) = 1 Then
Select Case pair(0)
Case "BG_USER_03"
bld = pair(1)
Case Else
If Bug_Fields(pair(0)).Value = "" Then
Bug_Fields(pair(0)).Value = pair(1)
End If
End Select
If Bug_Fields("BG_DETECTION_VERSION").Value _
<> ""
And bld <> "" Then
SW_SetLists_VersionsBuilds _
"BG_DETECTION_VERSION", _
"BG_USER_03"
Bug_Fields("BG_USER_03").Value = bld
If Err.Number <> 0 Then Err.Clear
End If 'Bug_Fields
End If 'UBound(pair)
Next
End If 'vals <> ""
End If 'GET
uset.Close
PrintError ("Keep Last Value (" & action & ")")
On Error GoTo 0
End Sub
HP ALM (12.50)
Page 441
Administrator Guide
Chapter 34: Workflow Examples and Best Practices
Example: Copying Field Values to Another Object
This example shows how to use the TDConnection object to copy the value from the Build Number field
of a Run (RN_USER_02) to the Last Ran On Build field of a Test in a Test Set (TC_USER_03).
Add the code to the Run_AfterPost event procedure.
Sub Run_AfterPost
On Error Resume Next
Dim tdc
set tdc = TDConnection
Dim TSFact 'As TestSetFactory
Set TSFact = tdc.TestSetFactory
Dim TstSet 'As TestSet
Set TstSet = TSFact.Item(Run_Fields("RN_CYCLE_ID").Value)
MsgBox TstSet.Name
Dim TSTestFact 'As TSTestFactory
Set TSTestFact = TstSet.TSTestFactory
Dim TSTst 'As TSTest
Set TSTst = _
TSTestFact.Item(Run_Fields("RN_TESTCYCL_ID").Value)
MsgBox TSTst.Name
TSTst.Field("tc_user_03").value = _
Run_Fields("RN_USER_02").Value
TSTst.Post
PrintError ("Run_AfterPost")
On Error GoTo 0
End Sub
HP ALM (12.50)
Page 442
Send Us Feedback
Can we make this Administrator Guide better?
Tell us how: docteam@hpe.com
HP ALM (12.50)
Page 443