Documente Academic
Documente Profesional
Documente Cultură
Borland Software Corporation may have patents and/or pending patent applications covering subject matter in this
document. Please refer to the product CD or the About dialog box for the list of applicable patents. The furnishing of
this document does not give you any license to these patents.
Copyright 19982006 Borland Software Corporation and/or its subsidiaries. All Borland brand and product names
are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries. All
other marks are the property of their respective owners.
November 2006
PDF
2
Getting Started
Getting Started
Help on Help ................................................................................................................................................ 9
Concepts .................................................................................................................................................... 11
CaliberRM Overview ........................................................................................................................... 12
Requirements Management ............................................................................................................... 14
Product Integrations ............................................................................................................................ 15
Extending CaliberRM Functionality ..................................................................................................... 16
Procedures ................................................................................................................................................. 18
Administrative Procedures .................................................................................................................. 19
Defining Projects ......................................................................................................................... 20
Creating Users ............................................................................................................................. 23
End-User Procedures ......................................................................................................................... 25
Logging On .................................................................................................................................. 26
What's New ................................................................................................................................................ 28
New Administrative Features .............................................................................................................. 29
New API Features ............................................................................................................................... 30
New Features in Integrations .............................................................................................................. 31
New Reporting Features ..................................................................................................................... 33
New Requirement Editor Features ..................................................................................................... 35
New Traceability Features .................................................................................................................. 37
New Usability Features ....................................................................................................................... 39
Discontinued Features ........................................................................................................................ 41
3
Concepts
Concepts
Administrating CaliberRM Servers ............................................................................................................. 45
Importing Project Information .............................................................................................................. 46
Database Administration ..................................................................................................................... 47
Administrating CaliberRM Projects ............................................................................................................ 48
Projects ............................................................................................................................................... 49
Requirement Types ............................................................................................................................ 50
Attributes ............................................................................................................................................. 51
Users ................................................................................................................................................... 53
Licensing ............................................................................................................................................. 54
Security ............................................................................................................................................... 56
Administrative Reports ........................................................................................................................ 57
Using CaliberRM to Manage Requirements .............................................................................................. 58
Requirements ..................................................................................................................................... 59
Requirement Views ............................................................................................................................. 60
Reports ............................................................................................................................................... 61
Traceability .......................................................................................................................................... 63
Glossaries ........................................................................................................................................... 64
Baselines ............................................................................................................................................ 65
Export .................................................................................................................................................. 66
Import .................................................................................................................................................. 67
4
Procedures
Procedures
Baselines ................................................................................................................................................... 71
Comparing Baselines .......................................................................................................................... 72
Creating and Defining Baselines ........................................................................................................ 73
Glossaries .................................................................................................................................................. 75
Adding Glossary Terms ...................................................................................................................... 76
Projects ...................................................................................................................................................... 77
Creating a Requirement Type ............................................................................................................. 78
Creating Security Profiles ................................................................................................................... 80
Defining Projects ................................................................................................................................. 81
Reports ....................................................................................................................................................... 84
Creating a Report from the Requirement Grid .................................................................................... 85
Creating Administrative Reports ......................................................................................................... 87
Creating Document Factory Reports .................................................................................................. 88
Creating Requirement Reports ........................................................................................................... 90
Scheduling Document Factory Reports .............................................................................................. 92
Requirements ............................................................................................................................................. 94
Attaching References to a Requirement ............................................................................................. 95
Creating a Requirement Type ............................................................................................................. 96
Creating Requirement Reports ........................................................................................................... 98
Creating Requirements ..................................................................................................................... 100
Creating Traces Between Requirements and Software Artifacts ...................................................... 102
Editing and Deleting Traces .............................................................................................................. 105
Exporting Requirements to CSV Files .............................................................................................. 106
Importing Requirements from Microsoft Word .................................................................................. 107
Sorting Requirements ....................................................................................................................... 109
Export ....................................................................................................................................................... 110
Exporting Attribute Definitions .......................................................................................................... 111
Exporting Requirements to CSV Files .............................................................................................. 112
Publishing Requirements to StarTeam ............................................................................................. 113
Import ....................................................................................................................................................... 117
Importing Requirements from Microsoft Word .................................................................................. 118
Server Administration ............................................................................................................................... 120
Backing up and Restoring a Database ............................................................................................. 121
Enabling LDAP ................................................................................................................................. 123
Traceability ............................................................................................................................................... 124
Connecting to a Team Foundation Server ........................................................................................ 125
Creating Traceability Filters .............................................................................................................. 126
Creating Traces Between Requirements .......................................................................................... 128
Creating Traces Between Requirements and Software Artifacts ...................................................... 129
Editing and Deleting Traces .............................................................................................................. 132
Enabling Project Traceability to Software Artifacts ........................................................................... 133
Viewing Microsoft Visual Studio Team System Test Results ........................................................... 134
Viewing Traceability .......................................................................................................................... 135
Users ........................................................................................................................................................ 136
Creating Baseline Administrators ..................................................................................................... 137
Creating Groups ............................................................................................................................... 138
Creating Users .................................................................................................................................. 139
5
Reference
References
Document Factory Syntax ........................................................................................................................ 143
Database Manager Commands ............................................................................................................... 156
StarTeam Integration Configuration ......................................................................................................... 157
6
Getting Started
7
Getting Started
The topics in this section are designed to help you understand and begin using CaliberRM easily and quickly.
In This Section
Help on Help
This section describes how the data is organized in the online Help and lists additional resources.
Concepts
This section provides topical information to help you begin using CaliberRM quickly and easily.
Procedures
This section contains tasks that will help you begin using CaliberRM quickly and easily.
What's New
Provides information about the improvements made in the Borland CaliberRM product.
8
Help on Help
This section includes information about the:
Help
The Help includes conceptual overviews, procedural how-to information, and reference information, allowing you to
navigate from general to more specific information as needed.
Additionally, the help is delivered as a PDF that you can print in book format. It is located on the Start menu
under Programs Borland CaliberRM Documentation CaliberRM Help.
Conceptual Overviews
The conceptual overviews provide information about product architecture, components, and tools that simplify
development. If you are new to a particular area of development, see the overview topic at the beginning of each
section in the online Help.
At the end of most of the overviews, you will find links to related, more detailed information.
How-To Procedures
The how-to procedures provide step-by-step instructions for performing tasks. All of the procedures are located
under Procedures in the Contents pane of the Help window. Additionally, most of the conceptual overviews provide
links to the pertinent procedures.
References
Reference topics provide detailed information on subjects such as menu elements, Document Factory syntax, and
troubleshooting.
All of the reference topics are located under References in the Content pane of the Help window.
9
Typographic Conventions Used in the Help
The following typographic conventions are used throughout the online Help.
Typographic conventions
Convention Used to indicate
Monospace type Source code and text that you must type.
Boldface Reserved language keywords or options, references to dialog
boxes and tools.
Italics Identifiers, such as variables or type names. Italicized text is
also used for book titles and to emphasize new terms.
KEYCAPS Keyboard keys, for example, the CTRL or ENTER key.
10
Concepts
This section provides topical information to help you begin using CaliberRM quickly and easily.
In This Section
CaliberRM Overview
Provides an overview of CaliberRM.
Requirements Management
Provides topical information about requirements management.
Product Integrations
Provides information about the various integrations CaliberRM supports.
Extending CaliberRM Functionality
Provides information about how to extend CaliberRM functionality.
Related Concepts
Help on Help
What's New
11
CaliberRM Overview
Designed for ease of use, the intuitive interface and powerful decision support capabilities of CaliberRM help teams
deliver on key project milestones with greater accuracy and predictability. CaliberRM also helps applications meet
end-user needs by allowing all project stakeholders marketing teams, analysts, developers, testers, and
managers to collaborate and communicate the voice of the customer throughout the software delivery lifecycle.
Centralized Repository CaliberRM provides a central, secure repository for project requirements.
Adaptable to fit your processed CaliberRM is designed to bring speed and agility to the software requirements
process.
Requirements traceability across the lifecycle CaliberRM has an open architecture that permits software
requirements to be linked to a variety of artifacts across the lifecycle.
Impact analysis throughout the application lifecycle Multiple methods of traceability visualization help users
immediately understand the scope of analysis required to gauge the effect of a requirements change.
Online Glossaries to standardize and define terminology Glossaries are useful to define industry terms,
project references, corporate language, etc., to help ensure that team members look at requirements the same
way.
CaliberRM Interfaces
CaliberRM comes with several interfaces to meet the needs of the respective audiences it serves.
Windows client: primary client to author, prioritize, organize and manage requirements. This client requires
a CaliberRM license and includes: Estimate Professional, a wizard to generate project estimates from
requirements (for more information on project estimation, see the Integrating with Estimate Professional and
Using Estimate Professional user guides in \Program Files\Borland\CailberRM\Documentation); Document
Factory, a report generator to output requirements report to MS Word; and the StarTeam Toolbar, a shared
utility that allows users to use their login credentials across StarTeam servers and CaliberRM servers
Web client: Web interface to author, prioritize requirements. Requires a CaliberRM license. the following
functionality is not available from the Web client: administration, reporting, import Word documents, export to
MS Access, user interface customization, traceability matrix and write-access to software artifacts traced to
requirements
Web Viewer: Web interface to view requirements. Requires a read-only CaliberRM license. The following
functionality is not available from the Web Viewer: administration, reporting, import Word documents, export
to MS Access, user interface customization, traceability matrix and write-access to software artifacts traced to
requirements
Requirement Viewer: Simple interface for extended team members to view properties of a specific
requirement.
Borland Search: Provides a way to search for information across StarTeam and CaliberRM servers
12
For Visual Studio Team System architects, testers and developers
This is the CaliberRM for Microsoft Visual Studio Team System client. It is a CaliberRM client embedded in
Microsoft Visual Studio 2005 (when used in conjunction with Microsoft Team Foundation Server as part of Microsoft
Visual Studio Team System) to create and view requirements associated with Microsoft work items. It requires a
CaliberRM license.
For Developers
These interfaces assist developers:
CaliberRM Eclipse client: CaliberRM client embedded in Eclipse IDE to create and view requirements.
Requires a CaliberRM license.
Microsoft Visual Studio 2003 client: CaliberRM client embedded in Microsoft Visual Studio to view
requirements. Requires a CaliberRM read-only license. For more information, please see the Integrating with
Visual Studio 2003 user guide installed with the product in \Program Files\Borland\CaliberRM\Documentation.
Microsoft Visual Studio 2005 client: CaliberRM client embedded in Microsoft Visual Studio to view and
create requirements. Requires a CaliberRM license.
CaliberRM Administrator: Primary client for the CaliberRM Administrators to administer users, licenses and
project creation.
Datamart: Administrative utility to extract requirements into a relational database for reporting across multiple
CaliberRM projects. This utility is used in conjunction with reporting tools such as Crystal Reports and Business
Objects. For more information about Datamart, please see the Using Datamart user guide installed with the
product in \Program Files\Borland\CaliberRM\Documentation.
LDAP QuickStart Manager: Administrative utility to import users defined in an LDAP server. For more
information, please see the LDAP QuickStart Manager user guide installed with the product in \Program Files
\Borland\LDAP Quick Start\PDF.
RM Import/RM Export: Administrative utilities to import and export project structure and data from one server
to another.
Diagnostic Tool: Troubleshooting utility to assess the connection between the clients and the CaliberRM
server.
Requirements Publisher to StarTeam: Enables you to export CaliberRM requirements to StarTeam.
Requirements Publisher to Mercury Quality Center: Enables you to export CaliberRM requirements to
Mercury Quality Center. For more information, please see the Integrating with Mercury Quality Center user
guide installed with the product in \Program Files\Borland\CaliberRM\Documentation.
Related Concepts
Product Integrations
Extending CaliberRM Functionality
Related Procedures
Publishing Requirements to StarTeam
Creating Traces Between Requirements and Software Artifacts
13
Requirements Management
Requirements management involves establishing and maintaining agreement between customer and developer on
both technical and non-technical requirements. This agreement forms the basis for estimating, planning, performing,
and tracking project activities throughout the project and for maintaining and enhancing developed software. Studies
have shown that 30-35% of software development effort is spent on rework, over 50% of software defects are
attributed to requirement errors and over 80% of rework effort is spent on requirements related defects. Getting
requirements management right pays huge dividends in delivering software solutions to your customers in a time
frame that satisfies them.
Related Concepts
CaliberRM Overview
Extending CaliberRM Functionality
14
Product Integrations
CaliberRM integrates with other Borland products to provide a complete ALM solution:
Borland StarTeam: Trace requirements to tasks, change requests and files. Publish requirements to StarTeam
so developers can view requirements from their main source control tool.
Borland Together: Trace requirements to model elements.
Borland Caliber DefineIT: Validate customer scenarios before creating requirements to increase the quality of
requirements managed in CaliberRM. The integration is enabled and documented in Caliber DefineIT.
Borland SilkCentral: Trace requirements to test cases.
IDE Environments
Additionally, CaliberRM provides embedded clients for the most popular Integrated Development Environments:
Other Integrations
Borland also recognizes that you may use non-Borland tools to manage some aspect of your software lifecycle, and
provides integrations to the following products:
Most importantly, CaliberRM does not lock you into the products it only integrates with. Its unique traceability add-
in technology enables any third-party vendors to trace requirements to other applications.
Related Concepts
Extending CaliberRM Functionality
Traceability
Related Procedures
Creating Traces Between Requirements and Software Artifacts
Related Reference
StarTeam Integration Configuration
15
Extending CaliberRM Functionality
There are many ways to extend the functionality provided by CaliberRM:
CaliberRM SDK
Partner Solutions
Custom Tools
Traceability Add-in Technology
MPX Agents
CaliberRM SDK
CaliberRM is provided with an API to create add-ons using either Java or .NET. Borland Professional Services can
write add-ins to support your needs or you can write your own.
Partner Solutions
Several Borland partners have developed customer solutions to extend CaliberRM. For example:
Process Exchange
Dunn Solutions
Ring Zero
Custom Tools
You can launch any commonly used executable from CaliberRM by simply creating a Custom Tools entry using
Tools Custom Tools.
MPX Agents
Your Borland sales team can write MPX agents to write customized solutions for CaliberRM. Examples include
calculated attributes and requirement workflows. Contact your sales team for details.
16
Related Concepts
Traceability
Related Procedures
Creating Traces Between Requirements and Software Artifacts
17
Procedures
This section contains tasks that will help you begin using CaliberRM quickly and easily.
In This Section
Administrative Procedures
This section provides information about administrative tasks, and is designed to help you begin using
CaliberRM quickly and easily.
End-User Procedures
This section provides getting started how-to information for non-administrative users.
18
Administrative Procedures
This section provides information about administrative tasks, and is designed to help you begin using CaliberRM
quickly and easily.
In This Section
Defining Projects
Describes how to create and define a project in the CaliberRM Administrator.
Creating Users
Describes how to create users.
19
Defining Projects
There are four necessary steps to defining a project in the CaliberRM Administrator and two optional steps.
Additionally, you must assign requirement types to the project in CaliberRM:
Create a project
Define the project information
Specify the project access rights
Set requirement types in CaliberRM
Enable email notification (optional)
Enable traceability to external objects (optional)
Tip: You can create a project without using the wizard. To do so, the option to use wizards must
be unchecked in Tools Options Wizards.
2 Enter a name (up to 128 characters), description for the project, select the user groups to assign to the project,
and select the glossaries to associate with the project.
3 Click Next. The New Project Information dialog window opens.
4 Verify the information you have entered.
You can now modify the user list, assign a security profile and set automatic notification for each group assigned
to the project.
To specify the project access rights and set automatic notification for assigned groups
within the project
1 In the CaliberRM Administrator, select the project to which you want to assign attribute values, click the Group
Assignment tab and click the Advanced button. The advanced functions appear.
Note: The Assigned list contains a list of users assigned to that group within the project, and the
Not Assigned list contains a list of users not assigned to the project. All users of the
selected group are assigned by default.
2 To automatically add users to the project, check the Users assigned to the groups are automatically
assigned to the project check box.
Note: This option is per project. If you select this option, all users assigned to the group are
assigned to the project and the Assigned and Not Assigned selections are unavailable.
Warning: Any user that is assigned to a project that is not assigned to a group will no longer be
assigned to that project if this option is selected.
3 To display all users in the Not Assigned list box, click the Select From All Users option.
20
This allows you to assign users to the group for the selected project only, without changing global group
assignments. For example, the tester ajones may assist in development for a specific project, but does not need
to be added to the Developers group to participate as a developer for that project only.
Note: If you create new users and assign them to a group that was already assigned to a project,
you must modify the user list to move them into the Assigned list box.
4 To set access privileges for each group in a project, click the Security button. The Security dialog window
opens.
Check the security profiles you want to assign to the group.
Security profiles apply to all users within the selected group, for the selected project only. If multiple security
profiles are selected, the profile permissions are combined, and the least restrictive access level of all selected
profiles is used. If no profile is selected, the default profile is used to determine user access.
5 Click OK to return to the Group Assignment tab.
6 To save your changes, choose File Save Changes from the menu.
Note: When a new discussion is posted or replied to and the A New Discussion Item is posted
option is selected, an email will be sent to users in this group. When any of the
requirements-related options are selected, an email will be sent to listed on the requirement
Responsibilities tab, as well as users who have registered interest in the requirement.
Note: These options apply to all users within the selected group that are assigned to the project.
21
4 Choose File Save Changes from the menu.
Note: When a project is being modified, the project list displays a lock icon on the project,
indicating that the project cannot be modified by anyone else at the same time.
Related Concepts
Projects
Requirement Types
Related Procedures
Creating a Requirement Type
22
Creating Users
Users are created using the User Creation Wizard in the CaliberRM Administrator. You must be an administrator
(either the admin user or a user who belongs to the Administrators group) to create users.
To create a user
1 Select File New User from the CaliberRM Administrator menu.
2 Enter a unique ID (username) for the user. Do not include spaces.
3 Enter the first and last name of the user and optionally specify the users title and department, and click Next.
Note:
First names and last names must not exceed 128 characters.
4 Optionally enter the users phone, fax, email, pager and location information and click Next.
5 To assign the user to groups, select groups in the Not a member of list and click the Add button. Click Next.
Note: The Administrators group is a special group that provides users full access to CaliberRM
project definition. Very few users should belong to this group. Users in this group are
referred to Project Administrators.
6 Select the type of Authentication for this user: CaliberRM, which will use a CaliberRM password, or LDAP,
which will use an LDAP password. If you select CaliberRM, enter a password for the user. If you select LDAP,
enter the user's LDAP DN.
Note: If LDAP is not enabled at the CaliberRM server, but a user is configured to use LDAP
Authentication, the user should logon using CaliberRM credentials.
Note: If a user's DN has changed in the LDAP Domain Controller since the user was created in
CaliberRM, you need to re-enter the latest DN in this tab.
7 Select one or more of the following options to set the appropriate user password restrictions:
User Must Change Password at Next Logon: Forces the user to change his/her password at the next
logon. Not available when using LDAP.
User Cannot Change Password: Prevents the user from changing his/her password. Not available when
using LDAP.
Password Never Expires: Allows the user to have a password that never expires. Not available when
using LDAP.
Account is Disabled: Disables the user account. You cannot select the User Must Change Password
at Next Logon and the User Cannot Change Password check boxes at the same time. If you select
these boxes and attempt to save the information, an error message is displayed.
User Can Perform Baseline Maintenance: Allows the user to create and manage baselines. Such user
is referred to a Baseline Administrator.
User Can Manage Glossary Terms: Allows the user to create new glossary terms (for all glossaries in
the CaliberRM server) and edit existing ones.
23
Related Concepts
Licensing
Related Procedures
Enabling LDAP
24
End-User Procedures
This section provides getting started how-to information for non-administrative users.
In This Section
Logging On
Describes how to log on to CaliberRM.
25
Logging On
To log on to CaliberRM
1 Select Start Programs CaliberRM CaliberRM. The Logon dialog box appears.
2 In the Server field, enter the server to log into or click the Browse button to select a server. If you change the
default server ports you must enter servername:port number as the server when you log on (for example:
serverA:3000, instead of serverA).
3 Enter your user credentials in the User and Password fields.
Note: If LDAP is not enabled at the CaliberRM server, but you are configured to use LDAP
Authentication in the CaliberRM Administrator, you should logon to the CaliberRM server
using CaliberRM credentials. Contact your CaliberRM administrator if you encounter
difficulties logging on.
Note: If you have installed a CaliberRM server locally (using the trial software for instance), use
localhost as server and admin/admin as the username and password.
4 Click Logon.
Note: If your Administrator has changed the location of the Web index page or has moved the
links to a custom page, you need to enter that location instead.
The Web index page is displayed.
3 Click the CaliberRM Web link. The first time you attempt to use Web, a security window is displayed.
4 Click the Always button. A warning is displayed. Read the warning carefully and check the In the future, do
not show this warning check box.
5 Click OK. The Web applet loads, and the Logon screen is displayed.
6 Enter your server Host, your User name and Password in the appropriate fields. Click Logon. The system
verifies your information, and logs you on to the server.
Note: If your Administrator has changed the location of the Web index page or has moved the
links to a custom page, you need to enter that location instead.
The Web index page is displayed.
26
3 Click the CaliberRM WebView link. The first time you attempt to use WebView, a security window is displayed.
4 Click the Always button. A warning is displayed. Read the warning carefully and check the In the future, do
not show this warning check box.
5 Click OK. The Web applet loads, and the Logon screen is displayed.
6 Enter your server Host, your User name and Password in the appropriate fields. Click Logon. The system
verifies your information, and logs you on to the server.
Related Concepts
Users
Related Procedures
Enabling LDAP
27
What's New
This section includes information about the improvements made in the Borland CaliberRM product for this release.
In This Section
New Administrative Features
New administrative features in the CaliberRM release.
New API Features
New API features in CaliberRM.
New Features in Integrations
New features in the CaliberRM integrations.
New Reporting Features
New Reporting features in CaliberRM.
New Requirement Editor Features
New Requirement Editor features in CaliberRM.
New Traceability Features
New Traceability features in CaliberRM.
New Usability Features
New Usability features in the CaliberRM.
Discontinued Features
Features no longer supported in CaliberRM.
28
New Administrative Features
This topic describes the new administrative features in the CaliberRM release.
Related Concepts
New Requirement Editor Features
New Traceability Features
New Reporting Features
New Usability Features
New Features in Integrations
New API Features
Discontinued Features
Related Procedures
Creating Users
29
New API Features
This topics below list the new features in the CaliberRM product. Refer to the links in the Related Information section
for more specific information about the new features.
Traceability add-ins
Vendor add-ins are renamed traceability add-ins and samples are provided (Program Files Borland
CaliberRM Samples Addins) to help you extend CaliberRM traceability to any software artifacts to which you
want to measure impact of requirement changes.
Related Concepts
New Requirement Editor Features
New Traceability Features
New Reporting Features
New Usability Features
New Administrative Features
New Features in Integrations
Discontinued Features
30
New Features in Integrations
This topics below list the new features in the following CaliberRM integrations:
31
The latest version of Mercury Quality Center (9.0) is supported.
The Quality Center Requirements Publisher allows you to select the specific Quality Center folder (root) in
which to publish CaliberRM requirements. The specific requirement versions included in baselines being
published are reflected in Quality Center.
The Quality Center test execution status is included in the Traceability status on the requirement
Traceability tab, as well as in Document Factory report when using the new <<trace_teststatus>>
When displaying Quality Center objects in the Traceability Matrix, only those objects traced to requirements
in the currently open CaliberRM project are displayed, minimizing the display of information to just what you
requested.
Related Concepts
New Requirement Editor Features
New Traceability Features
New Reporting Features
New Usability Features
New Administrative Features
New API Features
Discontinued Features
32
New Reporting Features
New Reporting features for CaliberRM are as follows:
33
Datamart SQL Server reduced data truncation
When using Microsoft SQL Server 2005, the extracted data is no longer truncated. Note that this enhancement relies
on an improvement made in SQL Server 2005.
Related Concepts
New Requirement Editor Features
New Traceability Features
New Usability Features
New Administrative Features
New Features in Integrations
New API Features
Discontinued Features
34
New Requirement Editor Features
This topics below list the new Requirement Editor features in the CaliberRM product:
The size of the requirement description window no longer decreases to the point of not being visible making
this field easily visible to users at all times.
Tables in requirement description can be resized
When copying and pasting requirement description from other applications (ex: Microsoft Word), you have
control on the margin in the requirement description field (right click and select Remove margins option)
35
Related Concepts
Requirement Views
New Traceability Features
New Reporting Features
New Usability Features
New Administrative Features
New Features in Integrations
New API Features
Discontinued Features
Related Procedures
Creating Requirements
36
New Traceability Features
The following new traceability features have been added:
Traceability in baselines
Improved display in Traceability Matrix
Improved filtering in Traceability Matrix
Multi-select support in Traceability Matrix
Traceability behavior in requirement copies
Traceability in baselines
Traceability information is captured when creating baselines. When creating a baseline, the Traceability information
displayed on the Requirements Traceability tab is captured so that this information is displayed when you view
the baseline at a later time.
37
Related Concepts
New Requirement Editor Features
New Reporting Features
New Usability Features
New Administrative Features
New Features in Integrations
New API Features
Discontinued Features
Related Procedures
Creating Traces Between Requirements
38
New Usability Features
The following are the new usability features:
User appearance
Users can be displayed using their first and last name, a more intuitive display than their sometimes cryptic user ID.
Specify your user appearance preference in the CaliberRM Tools Options User Appearance panel, and owners
and responsible users will be displayed in terms of their first and last name.
References indicator
When adding references to requirements, the Reference tab indicates the number of references without having to
click on the tab to determine the presence of references.
39
Baseline Maintenance
An Edit Find in Tree option in the Baseline Maintenance dialog makes it easier to locate a specific requirement
in the baseline. Selecting a parent automatically selects its children minimizing the number of clicks when using
requirement hierarchies.
Related Concepts
New Requirement Editor Features
New Traceability Features
New Reporting Features
New Administrative Features
New Features in Integrations
New API Features
Discontinued Features
40
Discontinued Features
For this release, certain features have been removed to make way for enhancements or newer features. They are
as follows:
Related Concepts
New Requirement Editor Features
New Traceability Features
New Reporting Features
New Usability Features
New Administrative Features
New Features in Integrations
New API Features
41
42
Concepts
43
Concepts
This section contains conceptual information for the various CaliberRM user roles.
In This Section
Administrating CaliberRM Servers
This section provides conceptual information for server administrators managing several CaliberRM
projects.
Administrating CaliberRM Projects
This section provides conceptual information for project administrators responsible for setting up projects
for end-users.
Using CaliberRM to Manage Requirements
This section provides conceptual information for end-users.
44
Administrating CaliberRM Servers
This section provides conceptual information for server administrators managing several CaliberRM projects.
In This Section
Importing Project Information
Provides topical information about the RM Import feature for importing project information.
Database Administration
Provides topical information about database administration.
45
Importing Project Information
You may import project information to a CaliberRM server using RM Import. RM Import uses a path and name of
the import data, normally a directory ( a .txt file) created by RM Export.
When you import certain objects, objects of other types may be created by the import utility as needed. The utility
attempts to recreate the object as it existed in the original data; however, if the data is not available, an appropriate
object with the correct name is created automatically. For example, if an imported requirement is owned by smith,
the import utility searches the import data for a definition for smith. If smith does not exist, a userid smith is
created automatically with minimal data.
RM Import currently creates (if necessary) the following objects in the manner stated below:
Users: any new users in the User.txt import file are added to the list of users in the CaliberRM Administrator
Groups: any new groups in the Group.txt import file are added to the list of groups in the CaliberRM
Administrator
Projects: any new projects in the Project.txt import file are added to the list of projects in the CaliberRM
Administrator and CaliberRM
Requirement Types: any new requirement types in the ReqType.txt import file are added to either new or
existing projects
Requirements: any new requirements in the Requirement.txt import file are added to either new or existing
projects
User-Defined Attributes: any new user-defined attributes in the UDA.txt import file are added to the list of
attributes available for assignment to custom tabs
The utility currently modifies (if necessary) the following objects in the manner stated below:
Groups: modified to include the new users belonging to those groups in the import file
Projects: modified to include the new groups that are assigned to those projects in the import file
System Attributes (status and priority): modified to include any new values for status and priority that are
contained in the import file
Related Concepts
Import
Export
Related Procedures
Importing Requirements from Microsoft Word
46
Database Administration
CaliberRM requires limited database administration but regular backups are strongly recommended. The main utility
to administer the CaliberRM database is the dbmgr utility and the database owner is the user who installs the
CaliberRM server and is the only user who can run the dbmgr utility, including backing up and restoring an existing
database or create a new database.
Warning: A hard-drive defragmentation can corrupt a CaliberRM database. Before defragmenting the hard-drive
where the database is installed, make sure all databases are stopped and remain stopped. The best
method is to set each database to unstartable mode (dbinfo -0), and stop the SQM Database service.
Related Procedures
Backing up and Restoring a Database
Related Reference
Database Manager Commands
47
Administrating CaliberRM Projects
This section provides conceptual information for project administrators responsible for setting up projects for end-
users.
In This Section
Projects
Provides topical information about projects.
Requirement Types
Provides topical information about requirement types.
Attributes
Provides topical information about system and user-defined attributes of a requirement.
Users
Provides topical information about users.
Licensing
Provides topical information about licensing.
Security
Provides topical information about security.
Administrative Reports
Provides topical information about administrative reports.
48
Projects
CaliberRM stores requirements in projects. Projects stored in the same CaliberRM server share a common set of
properties (requirement types, attributes, security profiles, users and groups).
Projects are defined by the requirement types assigned to that project (File Admin Set Requirement
Types).
Users in projects belong to groups that are assigned to projects in the CaliberRM Administrator.
You can enable security for projects on the Project Info tab in CaliberRM. Project security is defined by Security
Profiles (File Admin Security Profiles) that are assigned to groups that are in turn assigned to the
project.
Requirements in one project can be traced across projects.
Traceability to software artifacts stored outside of CaliberRM is enabled for each project on the project's
External Traceability tab in the CaliberRM Administrator.
Requirements in one project can be shared across projects. This is enabled on the Project Info tab in
CaliberRM.
Related Concepts
Importing Project Information
Requirement Types
Attributes
Related Procedures
Defining Projects
49
Requirement Types
CaliberRM organizes requirements by type. A requirement type defines a logical grouping of requirements that will
share common attributes.
The key properties of requirement type are:
CaliberRM makes it easy to reuse requirement types among projects. Once created, a requirement type can be
assigned to any project, minimizing the time it takes to create projects.
Related Concepts
Projects
Attributes
Related Procedures
Creating a Requirement Type
Defining Projects
50
Attributes
Each requirement in CaliberRM can be fully qualified with a set of attributes. All requirements share a common set
of attributes. Those include:
Priority: You can change the default values using File Admin System Attributes.
Status: You can change the default values using File Admin System Attributes.
Additionally, the project administrator defines custom attributes (user-defined attributes) and assigns them to each
requirement type in the project. For all requirements of that type, users can set values to these custom attributes.
CaliberRM provides a wide variety of attribute types:
51
Related Concepts
Projects
Requirement Types
Related Procedures
Defining Projects
Creating a Requirement Type
52
Users
CaliberRM users are defined either manually by the CaliberRM administrator or by importing users from a LDAP
directory. Each user is defined by a set of properties, the primary ones being:
unique userID
a first and last name
an email address (used for requirement change notification and discussion posting alerts)
You can display users by their userID or by their first and last name.
Users belong to one or many groups that define their access rights to requirements.
Each user must have an assigned license to log into CaliberRM from any client (Windows standalone, Web client,
Eclipse and Visual Studio).
There are five levels of users:
Server Administrators: are members of the Administrators group and can only be created by other Server
Administrators. They control license assignment, creating of projects and users. Depending on their security
profile, an administrator does not necessarily have access to all user-level functions.
Project Administrators: are created in CaliberRM by Server Administrators. Depending on their security
profile, an administrator does not necessarily have access to all user level functions.
Baseline Administrators: perform all levels of baseline maintenance for all projects on the server. This user
does not have to be a Server or Project Administrator. See Setting Security for information on making a user
a baseline administrator.
Glossary Administrators: perform all levels of glossary maintenance for all glossaries on the server. This
user does not have to be a Server or Project Administrator. See Setting Security for information on making a
user a glossary administrator.
Users: perform user-level functions. Has no administrative rights. Users' security access to requirements is
determined by the project security level. Projects may have security enabled or not. Once a project security is
enabled, user access to requirements is defined by security profiles assigned to user groups for that project.
Security profiles are defined once in the CaliberRM server and can be reused by all projects in that server.
Related Concepts
Licensing
Related Procedures
Creating Users
Enabling LDAP
53
Licensing
CaliberRM users need a license key to run CaliberRM. All clients (Windows, Web client, Visual Studio, Eclipse) can
use either a concurrent license (shared with other users) or a named license (specific to a user). The Web Viewer
is enabled with a read-only license key. The administrator assigns licenses in the CaliberRM Administrator. License
administration can use the CaliberRM server (native licensing), Macromedia FlexLM or Borland License Server. This
gives you a choice between using a license server and using the licensing found in CaliberRM.
There are three license specifications for users:
Note: If a named user attempts to connect from more than one machine, the connection from the second machine
is treated as a concurrent license if one is available. If none are available, the user receives a No License
Available caution window and must try again later.
Important Notes
The Admin user is always a named user for each product, but does not count against the number of named
user licenses you have. However, if the Admin user attempts to connect from more than one machine, the
connection from the second machine is treated as a concurrent license if one is available.
The CaliberRM Administrator and Diagnostic Tool do not count against your number of licenses used.
The number of licenses purchased does not affect how many users you can create in the CaliberRM
Administrator.
If you are using a major version (x.0) with evaluation keys, then upgrade to a minor version (x.1), the evaluation
period does not start over.
For a 30 day evaluation copy, the number of named and concurrent licenses is 5.
Do not change the date on the server until you have a permanent key.
hosts the licenses sent by Borland (this involves accessing a Borland web site and downloading Borland license
files called slips)
places the slips in the /license folder, a subdirectory of the server installation folder
configures the license server for users (this is covered in the license server documentation)
assign users to specific licenses
54
Once you have downloaded all of the .zip files containing the .slip files, copy each concurrent_.slip and/or
named_.slip file into your License directory (C:\Program Files\Borland\CaliberRMServer\License). Copy each
server_.slip file to(C:\Borland\BLS4\conf).
Project administrators can view license consumption from the CaliberRM Administrator.
FlexLM
A project administrator:
Related Concepts
Users
Related Procedures
Creating Users
55
Security
Requirement access is determined by the project security level. Projects may or may not have security enabled.
Once a project security is enabled, user access to requirements is defined by security profiles assigned to user
groups for that project. Security profiles are defined once in the CaliberRM server and can be reused by all projects
in that server.
Related Concepts
Projects
Users
Related Procedures
Creating Security Profiles
56
Administrative Reports
From CaliberRM Administrator, project administrators can run reports to view project information and user
assignment to groups. They can also monitor which users are running which CaliberRM clients, and review the
CaliberRM license consumption across their user base.
Related Concepts
Reports
Related Procedures
Creating Administrative Reports
Creating Requirement Reports
57
Using CaliberRM to Manage Requirements
This section provides conceptual information for end-users.
In This Section
Requirements
Provides topical information about requirements.
Requirement Views
Provides topical information about requirement views.
Reports
Provides topical information about CaliberRM reports.
Traceability
Provides topical information about traceability.
Glossaries
Provides topical information about glossaries.
Baselines
This section provides topical information about baselines.
Export
Provides topical information about exporting CaliberRM information.
Import
Provides topical information for importing information from Microsoft Word into CaliberRM.
58
Requirements
Requirements are the primary artifact in CaliberRM. Each requirement is defined by a set of properties:
system attributes: priority, status, Tag/ID (unique number to refer to the requirement), owner (user assigned to
this requirement; the ownership defines access rights to this requirement), name (a short description of the
requirement)
UDAs: (user defined attributes); these attributes depends on the requirement type assigned to the requirement
description: this field stores the requirement text. The text can include images (JPEG format yields to better
performance), hyperlinks, tables and OLE objects. You can reuse description of other requirements by mapping
into your project a shared requirement stored in another project. You can also reuse requirement text stored in a
Word document as your requirement description (see Related Procedures below for details).
version: each requirement is versioned and users can visit previous versions of requirements and compare
requirement versions (Requirement Compare Requirement to previous version.../to other requirement
or version...)
responsibility: this field allows users that have parts in the completion of the requirement to be notified over E-
mail when the requirement changes. Users who are not responsible for the requirement can receive similar E-
mail notification by registering their interest in the requirement but those users will not be listed in Responsibility
reports.
hierarchical number: this number represents the position of the requirement in the requirements tree and is
helpful to distinguish parent and children requirements
validation: the set of acceptance criteria development must meet to complete the requirement
references: optionally users can attach references to requirements. These references can be a URL (such as a
team site page or a hyperlink to a StarTeam file) or a file located on a shared drive using UNC notation.
The primary means to view requirements, include the requirement tree and the requirement grid (Tools
Requirement Grid), as well as generating Word reports with Document Factory.
Document references provide additional information for a requirement. The Reference tab of a requirement with an
attached reference displays a special icon with a paperclip on the left and a number of references in the parentheses
on the right.
Related Concepts
Requirement Views
Requirement Types
Related Procedures
Creating Requirements
59
Requirement Views
There are several requirement views:
Requirement Information
Requirement information view provides the following detailed information regarding the requirement: name, owner,
status, priority, description, user-defined attribute values, validation, change history and responsible users.
Requirement Grid
You can view requirements in a spreadsheet format to sort requirements and export requirements to XML.
The grid view displays the requirement type, tag/ID, name, status, priority, owner, responsible users, and user
defined attributes. You also can optionally view requirement description, last modified date and hierarchical number
(these options may decrease performance).
Tip: To customize the Document View, use the Increase Height and the Word Wrap toolbar buttons.
Traceability Matrix
Traceability allows you to create and track relationships between requirements and other related development and
testing information. Such relationships are called "traces" and shown on the Traceability tab.
You can view traceability between many requirements using the Traceability Matrix.
Tree View
The tree view displays requirements organized by types. Relocating requirements in the tree changes the
requirement hierarchy number. To display hierarchical or serial number (tag/ID), use the View Hierarchical
Numbers and View Serial Numbers options.
Related Concepts
Requirements
Traceability
Related Procedures
Viewing Traceability
60
Reports
From CaliberRM Administrator, project administrators can run reports to view project information and user
assignment to groups. They can also monitor which users are running which CaliberRM clients, and review the
CaliberRM license consumption across their user base.
There are three types of reports in CaliberRM:
Document Factory
You can generate up-to-date, customized requirement specifications reports for a selected requirement or a subset
of requirements in .doc, .txt or .rtf files using Document Factory. In Microsoft Word, you create templates containing
fields that correspond to requirement attributes in CaliberRM. You can then use Document Factory to populate the
template with data from any project. Using filter criteria in the template fields, you can even specify what requirement
data is included in the document.
Templates contain Document Factory commands, keywords and operators. Commands control the selection, order
and grouping of the requirements in the document. Keywords are placeholders that correspond to project and
requirement characteristics. They specify the data that is put into the document. You must enter them in a template
exactly as they appear in the requirements manager. Operators allow you to apply very specific criteria when
searching for groups of requirements. You can format your template to create the look you desire including tables
of contents, headers and footers and page numbers. You can apply most character and paragraph formatting
available in Word to the entire template, including the keywords.
Document Factory is best run as a background task using the command.ini while MS Word is not running on the
machine. You should avoid using MS Word while DocFactory is running.
There are several sample templates included with the product. If installed, they are located in Program Files
Borland CaliberRM Samples.
Datamart
Datamart allows you to extract data from the CaliberRM repository into a relational database, then report on the data
using various reporting tools from leading business intelligence software vendors (for example, BusinessObjects,
Crystal Reports). Please see the installed document Using Datamart located in \Program Files\Borland\CaliberRM
\Documentation for more information about Datamart.
61
Traceability Reports
You can generate traceability reports using the Traceability Matrix, Traceability Diagram, Document Factory or
Datamart.
Related Concepts
Traceability
Export
Related Procedures
Creating Document Factory Reports
62
Traceability
Traceability is key to assessing requirement coverage and assess the impact of requirement changes. CaliberRM
provides full traceability
view traceability between many requirements using the Traceability Matrix (Tools Traceability Matrix)
view a specific requirement and its traceability relationship using the Traceability tab or the Traceability
Diagram (Tools Traceability Diagram)
generate a traceability report in Microsoft Word format using Document Factory
Related Concepts
Product Integrations
Related Procedures
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
Viewing Traceability
Related Reference
Document Factory Syntax
63
Glossaries
CaliberRM helps you write better requirements by highlighting ambiguous words and providing quick access to
glossary terms. When you type the text of a requirement, words are automatically colored to indicate use of a glossary
term or alert the you of an ambiguous term that you should replace with a better-defined term.
The project administrator defines theme glossaries (ex: ambiguous terms, acronyms, project-specific terms) and
assigns these glossaries to individual projects. The administrator grants individuals on the team glossary
management rights. Those users can then manage all glossaries in the CaliberRM server.
You can have multiple glossaries that allow you to define terms that are specific to your organizations projects.
You can also print glossary information using Document Factory. See Related Information below for more
information.
To be able to add new terms or edit existing terms in a project glossary, users must have glossary management
privilege.
Related Procedures
Adding Glossary Terms
Creating Users
64
Baselines
CaliberRM baselines provide a way to create subsets of requirements. Only administrators and baseline
administrators can create baselines. In all baselines but the Current baseline, requirements are read-only. The
Current baseline is a special baseline that displays all current requirements for a project and allows editing of these
requirements. Once a baseline is created, users with baseline administration privileges can add or remove
requirements to the baseline or change the version of requirements included in the baseline using Baseline
Maintenance (File Baseline Administration Baseline Maintenance).
Baseline administrators can lock a baseline to prevent further modification. A locked baseline can then go through
an electronic signature process (File Baseline Administration Baseline Properties Signatories and
Tools Baseline Signatures).
To determine changes between two baselines, you can compare the content of two baselines (Tools Compare
Baselines).
Related Concepts
Requirements
Related Procedures
Creating and Defining Baselines
65
Export
Once requirements are stored in CaliberRM, you may want to export them to other formats and other tools. CaliberRM
can export requirements to XML, MS Access, CSV, SQL Server or Oracle format.
You can:
export a subset of requirements to XML and CSV formats from the Requirement Grid
export requirement reports to XML (Reports menu)
export requirements to MS Access (File Export to Access)
The project administrator can also export project information from one CaliberRM server to another using CaliberRM
RM Export.
Related Concepts
Import
Reports
Related Procedures
Exporting Requirements to CSV Files
Publishing Requirements to StarTeam
66
Import
You may have requirements stored in Microsoft Word that you now want to manage in CaliberRM. You can migrate
requirements stored in Microsoft Word by using CaliberRM import facilities (File Import from Word).
To reuse project information across CaliberRM servers, project administrators can also import project information
from one CaliberRM server to another using CaliberRM RM Import. Note that the project information must be first
exported using CaliberRM RM Export.
Related Concepts
Export
Related Procedures
Importing Requirements from Microsoft Word
67
68
Procedures
69
Procedures
This section provides "how to" information.
In This Section
Baselines
Provides how-to information about baselines.
Glossaries
This section provides how-to information about glossaries.
Projects
This section provides how-to information about projects.
Reports
This section provides how-to information about reports.
Requirements
This section provides how-to information about requirements.
Export
This section provides how-to information about exporting requirement information.
Import
This section provides how-to information about importing requirement information.
Server Administration
This section provides how-to information about server administration.
Traceability
This section provides how-to information about requirement traceability.
Users
This section provides how-to information about users.
70
Baselines
Provides how-to information about baselines.
In This Section
Comparing Baselines
Describes the task content in a sentence; used for part descriptions only.
Creating and Defining Baselines
Describes how to create and define baselines.
Related Concepts
Baselines
71
Comparing Baselines
Type introductory text only if necessary, otherwise, start the procedure. Avoid including conceptual information. For
more complex procedures requiring multiple stages, use the initial taskList to outline the required steps, then use
subtasks for each subsequent stage.
Note: Use a note to provide important information that might prevent the procedure from working.
72
Creating and Defining Baselines
Creating a baseline defines the baselines characteristics, not its contents. Once you have created a baseline, you
must initialize it. That is, you have to populate the baseline with requirement information. You must be an
administrator or a baseline administrator to create baselines.
Warning: Changes in attribute definitions are reflected in baselines. For instance, changing the parameters of the
UDA type (ex: list of values for selection list UDAs) changes the respective attribute values for
requirements included in baselines. If you must create a baseline with content that does not change,
consider publishing CaliberRM baselines to StarTeam.
To create a baseline
1 In CaliberRM, choose File Baseline Administration New Baseline. There are three tabs that contain
information about the baseline: Properties, Signatories, and Signature Meaning.
2 On the Properties tab:
3 Click the Baseline Signatories tab. The tab displays a list of people, called signatories, who can sign a locked
baseline. Click Modify to add users to the list. The Add Baseline Signatories dialog box is displayed.
4 Select the users you want to add as signatories for the baseline:
To select signatories from existing members of the project, click the Members of this baselines
project option button.
To select from signatories in an existing baseline, click the Signatories of the following baseline option
button. The baseline drop-down list is enabled. Select the baseline that contains the signatories you want
to add to the new baseline. The top pane contains all members of the project or existing signatories from
an existing baseline. From this list, select the users you want to add as signatories by selecting the check
box next to the users name. The bottom pane provides a preview of the signatory list.
73
To import signature meanings
1 On the Signature Meaning tab, click the Import button. The Import Signature Meanings dialog box appears.
2 Select a baseline from the drop-down list.
3 Click OK in the Import Signature Meanings dialog box.
To initialize a baseline
1 In CaliberRM, choose File Open Baseline from the menu. The Initialize a Baseline dialog box appears.
2 Select the desired baseline to initialize from the Starting point drop-down list. If you want to baseline the current
state of the project without performing baseline maintenance, click OK. If you want to modify the baseline after
you initialize it, check the Proceed to baseline maintenance after pressing OK check box.
3 Click OK.
To modify a baseline
1 In CaliberRM, choose File Admin Baseline Maintenance from the menu. The Baseline Maintenance
window appears and contains the requirement tree with check boxes next to the requirements contained in the
baseline.
Note: You must be a baseline administrator to modify a baseline. Some baselines may have been
locked. For security reasons, you cannot modify locked baselines.
Note: You can also select a different version of a requirement by right-clicking on it and changing
the version number to the version you intend to baseline.
Related Concepts
Baselines
Related Procedures
Publishing Requirements to StarTeam
74
Glossaries
This section provides how-to information about glossaries.
In This Section
Adding Glossary Terms
Describes how to add a term to an existing glossary.
Related Concepts
Glossaries
75
Adding Glossary Terms
To create new terms or edit the definition of existing glossary terms, you must either be part of the Administrators
group or be assigned the User Can Manage Glossary Terms right in the CaliberRM Administrator.
Note: The following characters are not allowed in creating a term in glossaries: !, ?, ;, :, , , (, ),
[, ], {, }, carriage returns, and line feeds.
Related Concepts
Glossaries
Related Procedures
Creating Users
76
Projects
This section provides how-to information about projects.
In This Section
Creating a Requirement Type
Describes how to create and define a requirement type.
Creating Security Profiles
Describes how to create security profiles.
Defining Projects
Describes how to create and define a project in the CaliberRM Administrator.
Related Concepts
Projects
77
Creating a Requirement Type
Note: Custom tabs are specific to the requirement type. Therefore, you must create a custom tab
for each requirement type that you want to contain a custom tab. User-defined attributes
are assigned to requirements and displayed on custom tabs. If you display the same user-
defined attribute on multiple custom tabs in a single requirement type, the user-defined
attribute will be the same on all tabs. If you change the data on one tab, the data changes
on all tabs.
78
Related Concepts
Projects
Attributes
Related Procedures
Defining Projects
79
Creating Security Profiles
There are four steps to creating a security profile:
Related Concepts
Requirement Types
Attributes
Related Procedures
Creating a Requirement Type
80
Defining Projects
There are four necessary steps to defining a project in the CaliberRM Administrator and two optional steps.
Additionally, you must assign requirement types to the project in CaliberRM:
Create a project
Define the project information
Specify the project access rights
Set requirement types in CaliberRM
Enable email notification (optional)
Enable traceability to external objects (optional)
Tip: You can create a project without using the wizard. To do so, the option to use wizards must
be unchecked in Tools Options Wizards.
2 Enter a name (up to 128 characters), description for the project, select the user groups to assign to the project,
and select the glossaries to associate with the project.
3 Click Next. The New Project Information dialog window opens.
4 Verify the information you have entered.
You can now modify the user list, assign a security profile and set automatic notification for each group assigned
to the project.
To specify the project access rights and set automatic notification for assigned groups
within the project
1 In the CaliberRM Administrator, select the project to which you want to assign attribute values, click the Group
Assignment tab and click the Advanced button. The advanced functions appear.
Note: The Assigned list contains a list of users assigned to that group within the project, and the
Not Assigned list contains a list of users not assigned to the project. All users of the
selected group are assigned by default.
2 To automatically add users to the project, check the Users assigned to the groups are automatically
assigned to the project check box.
Note: This option is per project. If you select this option, all users assigned to the group are
assigned to the project and the Assigned and Not Assigned selections are unavailable.
Warning: Any user that is assigned to a project that is not assigned to a group will no longer be
assigned to that project if this option is selected.
3 To display all users in the Not Assigned list box, click the Select From All Users option.
81
This allows you to assign users to the group for the selected project only, without changing global group
assignments. For example, the tester ajones may assist in development for a specific project, but does not need
to be added to the Developers group to participate as a developer for that project only.
Note: If you create new users and assign them to a group that was already assigned to a project,
you must modify the user list to move them into the Assigned list box.
4 To set access privileges for each group in a project, click the Security button. The Security dialog window
opens.
Check the security profiles you want to assign to the group.
Security profiles apply to all users within the selected group, for the selected project only. If multiple security
profiles are selected, the profile permissions are combined, and the least restrictive access level of all selected
profiles is used. If no profile is selected, the default profile is used to determine user access.
5 Click OK to return to the Group Assignment tab.
6 To save your changes, choose File Save Changes from the menu.
Note: When a new discussion is posted or replied to and the A New Discussion Item is posted
option is selected, an email will be sent to users in this group. When any of the
requirements-related options are selected, an email will be sent to listed on the requirement
Responsibilities tab, as well as users who have registered interest in the requirement.
Note: These options apply to all users within the selected group that are assigned to the project.
82
4 Choose File Save Changes from the menu.
Note: When a project is being modified, the project list displays a lock icon on the project,
indicating that the project cannot be modified by anyone else at the same time.
Related Concepts
Projects
Requirement Types
Related Procedures
Creating a Requirement Type
83
Reports
This section provides how-to information about reports.
In This Section
Creating a Report from the Requirement Grid
Describes how to create requirement reports from the Requirement Grid.
Creating Administrative Reports
Describes how to create administrative reports.
Creating Document Factory Reports
Describes how to create customized requirement reports using Document Factory.
Creating Requirement Reports
Describes how to create standard requirement reports.
Scheduling Document Factory Reports
Describes how to schedule Document Factory reports.
Related Concepts
Reports
84
Creating a Report from the Requirement Grid
Select a file from the list in the Template box. The drop-down list allows you to make a selection from the
most recently used templates. By default, there are five files in the list. This number is determined by your
administrator. To open the selected template to check it or make any edits before running Document
Factory, click the Word icon.
In the Save Document As box, enter a path and name for your new document, click the Browse button
to navigate to a previously created document or leave blank.
To generate a log file for the report, check the check box.
If you have named some UDAs with identify labels as CaliberRM system attributes (ex: Priority, Status,
etc..), check the Warn about ambiguous tags check box.
Choose the date format that you would like to use: Short Date or Long Date.
Choose Once for the method of replacing fields if the template contains only one occurrence of each
keyword used. This option replaces only the first instance of the keyword. If you use a keyword more than
once in a section, choose the Multiple option to replace all occurrences of the keyword with the actual
data. This option replaces all instances of the field, but takes longer to process the data.
Choose the data from which you would like to create the document. If you choose to use data from the
CaliberRM server, you can also choose to save the current data to use again with a different template.
If you want to create a file with an encrypted password that can be used for scheduling, select the Create
a configuration file only check box. This creates the file commandline.ini that can be used to run
Document Factory from the command line or placed in a batch file for scheduling purposes. If you choose
this option, Document Factory does not create a Word document from your template, but creates the .ini
file only.
If you want to display images, OLE objects, tables and formatted text included the requirement
descriptions, select the Requirement description will include formatted text, tables and images check
box.
5 Click Finish. If your template does not specify which project and/or baseline to use, you are prompted to select
them
85
Related Concepts
Reports
Related Procedures
Creating Document Factory Reports
Related Reference
Document Factory Syntax
86
Creating Administrative Reports
You can create standard administrative reports or usage reports.
Project: Displays the option to view or save the Project report, which lists all projects with their data,
including description and baselines. You can view it in your default browser or save it as an .xml file.
User: Displays the option view or save the User report, which lists all users with their data, including
description, name, address, department, email address and group assignments. You can view it in your
default browser or save it as an .xml file.
Group: Displays the option to view or save the Group report, which lists all groups with their data, including
email address, description and users assigned. You can view it in your default browser or save it as an .xml
file.
Related Concepts
Reports
Administrative Reports
Related Procedures
Creating Requirement Reports
87
Creating Document Factory Reports
You can create customized requirement reports using Document Factory. To define which requirements to report
on, you can:
Warning: For large reports, performance may not be adequate when running Document Factory from CaliberRM.
In this case, use Document Factory in batch mode off hours using the command.ini file. See the
Related Information link, Scheduling Document Factory Reports below.
Warning: When running Document Factory, Microsoft Word should not be running.
Select a file from the list in the Template box. The template you use must contain the $REQTREE or
$REQID command to report on a selected requirement, but the tree selection overrides any template
parameters that conflict with the tree selection. To open the selected template to check it or make any
edits before running Document Factory, click the Word icon.
In the Save Document As box, enter a path and name for your new document, click the Browse button
to navigate to a previously created document or leave blank.
To generate a log file for the report, select the check box.
To check for ambiguous tags, select the Warn about ambiguous tags check box.
4 Click Next.
Choose the date format that you would like to use: Short Date or Long Date.
Choose Once for the method of replacing fields if the template contains only one occurrence of each
keyword used. This option replaces only the first instance of the keyword. If you use a keyword more than
once in a section, choose the Multiple option to replace all occurrences of the keyword with the actual
data. This option replaces all instances of the field, but takes longer to process the data.
5 Click Next.
Choose the data from which you would like to create the document: Use data from the active project (If
you choose this option, you can also choose to save the current data to use again with a different template)
or Use previously saved data.
If you want to create a file with an encrypted password that can be used for scheduling, check the Create
a configuration file only check box. This creates the file commandline.ini file that can be used to run
Document Factory from the command line or placed in a batch file for scheduling purposes. See the
Scheduling Document Factory Reports link below. If you choose this option, Document Factory does not
create a Word document from your template, but creates the .ini file only.
88
If you want to display the requirement descriptions in HTML format, check the Requirement description
will include formatted text, tables and images check box.
6 Click Finish. Document Factory begins to process the data. If you used a template that was not project-specific,
you are asked to choose the project and baseline during this processing phase. When the data has been
processed, Document Factory asks if you would like to open your document.
Select a file from the list in the Template box. To open the selected template to check it or make any edits
before running Document Factory, click the Word icon.
In the Save Document As box, enter a path and name for your new document, click the Browse button
to navigate to a previously created document or leave blank.
To generate a log file for the report, select the check box.
To check for ambiguous tags, select the Warn about ambiguous tags check box.
Related Concepts
Reports
Related Procedures
Scheduling Document Factory Reports
Creating a Report from the Requirement Grid
Related Reference
Document Factory Syntax
89
Creating Requirement Reports
There are three standard requirement HTML reports: Detail, Status, and Responsibility.
Note: You can also use Document Factory to generate customized requirement reports, which enables you to
generate customized documents using Word templates.
To generate a report, select Reports from the CaliberRM menu, then select the type of report
you want to generate.
90
To preview the report, click the Print Preview button.
Related Concepts
Reports
Related Procedures
Creating a Report from the Requirement Grid
Creating Document Factory Reports
91
Scheduling Document Factory Reports
You can run Document Factory from the MS-DOS command line, using an .ini file, allowing you to set up scheduled
document generation. First you must create the commandline.ini file using Document Factory.
Select the template file you want to report from in the Template box. To open the selected template to
check it or make any edits before running Document Factory, click the Word icon.
In the Save Document As box, enter a path and name for your new document, click the Browse button
to navigate to a previously created document or leave blank.
To generate a log file for the report, select the check box.
To check for ambiguous tags, select the Warn about ambiguous tags check box.
4 Click Next.
Choose the date format that you would like to use: Short Date or Long Date
Choose Once for the method of replacing fields if the template contains only one occurrence of each
keyword used. This option replaces only the first instance of the keyword. If you use a keyword more than
once in a section, choose the Multiple option to replace all occurrences of the keyword with the actual
data. This option replaces all instances of the field, but takes longer to process the data.
5 Click Next.
Choose the data from which you would like to create the document: Use data from the active project (If
you choose this option, you can also choose to save the current data to use again with a different template)
or Use previously saved data.
Check the Create a configuration file only check box. This creates the file commandline.ini file that can
be used to run Document Factory from the command line or placed in a batch file for scheduling purposes.
See the Scheduling Document Factory Reports link below. If you choose this option, Document Factory
does not create a Word document from your template, but creates the .ini file only.
If you want to display the requirement descriptions in HTML format, check the Requirement description
will include formatted text, tables and images check box.
6 Click Finish. Document Factory begins to process the data. If you used a template that was not project-specific,
you are asked to choose the project and baseline during this processing phase.
The commandline.ini file is created. You can rename or relocate the file as needed.
To run Document Factory from the command line using the commandline.ini file
1 Select Start Programs Command Prompt to get to a DOS command prompt.
2 At the prompt enter: cd Program Files\Borland\CaliberRM (or to where you have Document Factory
installed) to change the directory to where the Docfactory.exe file resides.
3 If the commandline.ini file is in the directory with the docfactory.exe file, at the prompt, enter the following
command: docfactory -autofile (you can also enter docfactory /autofile). If the file resides
92
elsewhere, enter the following command, substituting the location of the file for Path docfactory -
autofile<path>\commandline.ini (you can also enter docfactory -autofile -yes if the file is in
the CaliberRM directory).
Related Concepts
Reports
Related Procedures
Creating Document Factory Reports
Related Reference
Document Factory Syntax
93
Requirements
This section provides how-to information about requirements.
In This Section
Attaching References to a Requirement
Describes the task content in a sentence; used for part descriptions only.
Creating a Requirement Type
Describes how to create and define a requirement type.
Creating Requirement Reports
Describes how to create standard requirement reports.
Creating Requirements
Describes how to create a requirement.
Creating Traces Between Requirements and Software Artifacts
Describes how to create traces between requirements and external software artifacts.
Editing and Deleting Traces
Describes how to modify and delete requirement traces.
Exporting Requirements to CSV Files
Describes how to export requirements to CSV files.
Importing Requirements from Microsoft Word
Describes how to import requirements from Microsoft Word.
Sorting Requirements
Describes how to sort and view subsets of requirements using the Requirement Grid.
Related Concepts
Requirements
94
Attaching References to a Requirement
Type introductory text only if necessary, otherwise, start the procedure. Avoid including conceptual information. For
more complex procedures requiring multiple stages, use the initial taskList to outline the required steps, then use
subtasks for each subsequent stage.
Note: Use a note to provide important information that might prevent the procedure from working.
95
Creating a Requirement Type
Note: Custom tabs are specific to the requirement type. Therefore, you must create a custom tab
for each requirement type that you want to contain a custom tab. User-defined attributes
are assigned to requirements and displayed on custom tabs. If you display the same user-
defined attribute on multiple custom tabs in a single requirement type, the user-defined
attribute will be the same on all tabs. If you change the data on one tab, the data changes
on all tabs.
96
Related Concepts
Projects
Attributes
Related Procedures
Defining Projects
97
Creating Requirement Reports
There are three standard requirement HTML reports: Detail, Status, and Responsibility.
Note: You can also use Document Factory to generate customized requirement reports, which enables you to
generate customized documents using Word templates.
To generate a report, select Reports from the CaliberRM menu, then select the type of report
you want to generate.
98
To preview the report, click the Print Preview button.
Related Concepts
Reports
Related Procedures
Creating a Report from the Requirement Grid
Creating Document Factory Reports
99
Creating Requirements
There are four steps necessary to create a requirement:
Create a requirement
Define the requirement information
Define the requirement attribute values (see Related Procedures below for details)
Assign responsible users
Note: In addition, you can link reference documents, create traceability links, and define the validation procedure.
Warning: Security is enforced while creating a new requirement, so you are not able to modify fields that your
security profile does not allow. Only fields that are enabled are available for you to change.
To create a requirement
1 Choose Requirement Create Requirement Child/Above/Below/Drag and Drop from the menu. This
creates a new requirement in the requirement tree.
Note: The Above and Below menu items are disabled when you create a requirement starting
from a requirement type in the tree.
Note: When creating a new requirement, the view does not shift from the current tab.
Note: The first time you save a requirement, that requirement is entered into the CaliberRM
database and a creation entry (Rev. 1.0) is made in the change history record. Each time
you change a requirement and save it, you may be prompted to enter a comment about
the change. The change and the comment are entered in the change history record. See
Related Procedures below for details.
Tip: To avoid unwanted change history data, fully define the requirement before saving it. You
can turn the Comment dialog window on or off through the Options dialog window.
3 Select the appropriate Owner, Status, and Priority from their respective drop-down lists.
100
Note: The default Owner is the user who created the requirement. You may assign the
requirement to someone else, but you may not be able to modify it again after it is saved
if you do not have security privileges to do so.
Note: The requirement description is visible at all times, in a pane below the tabs, and allows you
to adjust the size of the description window. The size of the description window on the
Details tab is independent from all other tabs.
To add a picture, OLE object, table, or hyperlink to the requirement description,
select Insert Picture/ Object/Table/Hyperlink from the menu. The JPG
format is the recommended format for inserted pictures. To edit an object, right-
click it and select Edit Object.
Note: In Document Factory, objects are represented as pictures. Inserted objects may be
inserted as icon (ex: JPG, GIF) or image of the object (BMP), consistent with Microsoft
Word OLE behavior.
Note: Typically, several individuals are assigned to a requirement. For example, the business
analyst who created the requirement is assigned, as well as a developer, tester and
manager. When the requirement is changed, the users assigned to them are notified in
order to keep development on track.
Note: The lists are limited by the group membership assigned for the project in Framework
Administrator.
2 Expand or collapse a list by clicking the plus (+) or minus (-) sign to the left of the group/member name. A gray
check box next to a group indicates that at least one member of that group has been selected.
3 To select all members of a group, select the check box to the left of that group. To select only certain members
of a group, select the check box to the left of each member you want to assign.
Note: To display users first in the tree, select the Display in Member/Group order check box.
To assign a user that is a member of multiple groups, but only as a responsible member
of one of those groups, select that groups check box.
Related Concepts
Requirements
101
Creating Traces Between Requirements and Software Artifacts
You can create traces to or from external software artifacts such as Borland StarTeam change requests,
requirements, files and tasks, Borland SilkCentral or Mercury Quality Center test cases, Borland Together designs
(you must create traces between requirements and Together designs in Together. Once created in Together, you
can view the traces and properties of Together designs in CaliberRM), and Microsoft Visual Studio Team System
work items or tests.
Note: You must create traces between requirements and Together designs in Together. Once
created in Together, you can view the traces and properties of Together designs in
CaliberRM.
102
To create traces to or from Mercury Quality Center artifacts
1 Select the Quality Center tab.
2 Select the Requirements, Test Plan, or Test Lab tab to trace the selected requirement to a corresponding
Mercury object.
3 Select a server name from the list of available Mercury servers. CaliberRM connects to the Mercury server.
4 Select a Mercury domain. CaliberRM connects to the Mercury domain.
5 Select a Mercury project. CaliberRM connects to the Mercury project.
Note: When you access a Mercury project for the first time, the Login to Quality Center Server
dialog box appears. Specify a valid user name and password to access the Mercury server.
You can also define a default credential to be used to access all Mercury projects. Note
that you must check this box if you want to run a Datamart report in silent mode, so that
no login dialog box is displayed during the Datamart extraction. Refer to the
UsingDatamart.pdf guide for details.
Note: The Test execution status for Mercury Test objects, and status for Mercury Requirements
are displayed on the Traceability tab. Note that status for TEST SET is not displayed in
CaliberRM at this time. Also note that the execution status displayed for Test Lab tests is
the status of the last run Test Lab test (among all the Test Lab tests created for the matching
Test Plan test (or No Run if no Test Lab tests were created).
7 Click the Trace From or Trace To button from the menu to create a traceability link from a CaliberRM
requirement to a Mercury object.
8 Click the Save As button to save the trace.
Note: If you have not yet established a connection to the Microsoft Team Foundation Server, the
Connect to Team Foundation Server dialog box appears. See the Related Procedure
below.
2 Select the test to establish a trace with. Choose Trace Trace To or Trace Trace From from the menu to
add a trace to or from the object.
Tip: You can create Microsoft Visual Studio Team System Work Items in the Traceability
Modification window. Right-click the list of work items to display the context menu and
choose New Work Item.
103
Related Concepts
Traceability
Reports
Related Procedures
Enabling Project Traceability to Software Artifacts
Creating Traces Between Requirements
Editing and Deleting Traces
Viewing Traceability
Connecting to a Team Foundation Server
Viewing Microsoft Visual Studio Team System Test Results
Related Reference
StarTeam Integration Configuration
104
Editing and Deleting Traces
Modify: Opens the Traceability Modification window, where you can change the direction of a trace.
Go To: Navigates to the Traceability tab of the requirement you have selected.
Remove: Deletes the trace.
Make/Clear Suspect: Makes the link a suspect link or clears the suspect link.
Properties: Displays Property Details and User Defined Attributes (UDAs) for the selected requirement
or object.
3 Select an option and save the changes to the requirement when finished.
You can also delete/edit a trace between requirements from the Traceability Matrix. When the matrix appears,
right-click the cell that corresponds to the requirements to trace and select one of the options.
Note: To delete or edit many traces at once, use the CTRL and SHIFT keys to select multiple cells.
Related Concepts
Traceability
Related Procedures
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
105
Exporting Requirements to CSV Files
Once you have created a requirement grid, you can export those requirements and requirement information to CSV
files from the Requirement Grid.
Note: Alternatively from the grid menu, you can select File Print, and click Print Preview. In
the displayed HTML page, right-click and select Export to Microsoft Excel.
Related Concepts
Requirements
Related Procedures
Creating a Report from the Requirement Grid
106
Importing Requirements from Microsoft Word
You can import requirement names and descriptions from a Microsoft Word document into a project using the Import
From Word wizard.
Note: Do not use special bullets (check marks or shaded less than signs) in table cell items.
Note: OLE objects included in Word documents are imported as pictures. You can insert the
respective OLE objects after import.
Indicate how you want to name the requirements. Select either the Retrieve the requirements names from
the document option button, or the Automatically name the requirements using a base name and a
sequential number option button. Enter a base name here. If you do not enter a name, Import uses the Microsoft
Word document name as the base name by default.
3 Click Next. In the top pane, if you are importing requirement names by style, select the paragraph style(s) that
are specific to requirement names. Styles define the appearance of various text elements within the document,
such as headings and body text. The styles listed are those found in your Microsoft Word document. You may
select any or all styles from the list.
In the bottom pane, indicate how to recognize requirement descriptions:
if you are importing requirements names by style, select the Import all text between the above selected
Text styles as the requirement description option.
if you are not importing requirement names by style, select the Import only the Text styles below as
the requirement description option. Select the styles that are specific to requirement descriptions.
4 Click Next. If you are importing requirement names by paragraph style, select the Import all text, ignoring
delimiters option button.
If not, select the Only import text enclosed in the following delimiters option button. The Beginning and
Ending fields become available. Enter the beginning and ending delimiter in the appropriate area.
5 Click Next. If you are importing requirement names by paragraph style, select the Import all text, ignoring
keywords option button. Import from Microsoft Word begins processing the document. Once processing is
completed, Import from Microsoft Word displays a list of new requirements for each criteria that was met. Import
from Microsoft Word also creates child requirements based on the paragraph style hierarchy in your document.
If you are importing requirement names by keywords, select the Only import text containing the following
keywords option button. Enter the keywords in the available field, separating each keyword by a comma.
Phrases containing these keywords are imported as requirement names.
6 Click Next. Import from Microsoft Word begins processing the document. Once processing is completed, Import
from Microsoft Word displays a list of new requirements for each criteria that was met. Import from Microsoft
Word also creates child requirements based on the paragraph style hierarchy in your document.
7 Select a requirement, and choose the location for the newly created requirements. Select one of the following
options: Insert Above, Insert Below, or Insert as Children.
8 Click Finish to complete import. The Import is Complete dialog box is displayed. Click OK.
107
Related Concepts
Import
108
Sorting Requirements
3 To display the requirement hierarchy numbers in the grid, check the Retrieve Hierarchy Numbers check box.
Using this feature may slow performance.
4 To display the requirement description in the grid, check the Retrieve Description field check box.
5 To display the most recent modification date, check the Retrieve Last Modified Info check box.
6 Click OK.
Note: And displays the requirements that meet both criteria. Or displays the requirements that
meet one or both of the conditions.
Related Concepts
Requirement Views
109
Export
This section provides how-to information about exporting requirement information.
In This Section
Exporting Attribute Definitions
Describes the task content in a sentence; used for part descriptions only.
Exporting Requirements to CSV Files
Describes how to export requirements to CSV files.
Publishing Requirements to StarTeam
Describes how to export, or publish, CaliberRM requirements to StarTeam.
Related Concepts
Export
110
Exporting Attribute Definitions
Type introductory text only if necessary, otherwise, start the procedure. Avoid including conceptual information. For
more complex procedures requiring multiple stages, use the initial taskList to outline the required steps, then use
subtasks for each subsequent stage.
Note: Use a note to provide important information that might prevent the procedure from working.
111
Exporting Requirements to CSV Files
Once you have created a requirement grid, you can export those requirements and requirement information to CSV
files from the Requirement Grid.
Note: Alternatively from the grid menu, you can select File Print, and click Print Preview. In
the displayed HTML page, right-click and select Export to Microsoft Excel.
Related Concepts
Requirements
Related Procedures
Creating a Report from the Requirement Grid
112
Publishing Requirements to StarTeam
The Publisher to StarTeam addin enables you to export CaliberRM requirements to StarTeam. Once the
requirements are in StarTeam, you can view them, but not edit them. An ID string that identifies the requirement in
CaliberRM is stored in a field in StarTeam. The default is to use the External Reference field in StarTeam.
An administrator periodically publishes requirements to StarTeam to update whatever changes have been made to
the requirements in CaliberRM.
Publishing CaliberRM requirements to StarTeam involves the following steps:
1 Enabling StarTeam integration in CaliberRM if you want to use Publisher to StarTeam from the CaliberRM client.
2 Running the Publisher to StarTeam wizard.
3 Specifying the CaliberRM properties, which include the CaliberRM server and log-in information, and the source
project and baseline.
4 Selecting the CaliberRM requirements to publish to StarTeam.
5 Specifying the StarTeam properties, which include the StarTeam server and log-in information, and the target
project, view, and folder.
6 Mapping the CaliberRM properties (attributes and UDAs ) to StarTeam properties (fields and custom fields).
7 Saving your configuration to a property file for future use.
8 Publishing the CaliberRM requirements to StarTeam.
Note: The StarTeam integration must be enabled in CaliberRM for a project before you can access Publisher to
StarTeam from the CaliberRM client menu or toolbar. However, you do not need to enable the StarTeam
integration in CaliberRM if you only want to run Publisher to StarTeam from the Start menu.
Note: To cancel the External Traceability changes, choose Edit Cancel Changes before you
save the changes.
113
The StarTeam Publisher Wizard enables you to define the CaliberRM and StarTeam server and project
information, select the requirements to publish, and specify a mapping of the requirement properties between
the two products.
Tip: You can also open Publisher to StarTeam in the CaliberRM client window by choosing
Tools Publish To StarTeam, or by clicking the Publish to StarTeam toolbar button. In
this case, Publisher to StarTeam assumes you want to use the current CaliberRM server,
project and baseline for the source, and skips the CaliberRM Properties page wizard. To
change the CaliberRM server, project, or baseline, click Back to open the CaliberRM
Properties page and modify the information. Otherwise, skip the next section of this
procedure called "To specify the CaliberRM properties" and go directly to the steps called
"To select the CaliberRM requirements" This will load in the properties and mappings used
from the previous time for this CaliberRM server and project.
Note: If you check a parent requirement, all child requirements are automatically checked.
Uncheck the child requirements you do not want to publish. If you check children
requirements and do not check their parent, the child requirements will be created in
StarTeam only if the parent requirement was previously published.
114
Publish To Subfolders By Type organizes the requirements into subfolders of the selected target folder, using
the same requirement type nodes as in CaliberRM.
Publish To One Folder Only puts all the requirement into the root of the selected target folder.
5 Click Next to customize the mapping between CaliberRM and StarTeam properties.
Tip: You can manage your property files without opening the CaliberRM client. Open Publisher to StarTeam from
the Start menu in Windows to display the Property File List dialog box where you can add new property files,
edit or remove existing ones, or run a previous property file from the list.
A property file is created in the Traceability Addins installation folder with the name you specified and the
extension .calst.
If you used the Windows Start menu to open Publisher to StarTeam, you are returned to the Property
List dialog box. Select a saved property file from the property file list and click Run.
If you started Publisher to StarTeam from CaliberRM, when you click Finish, the publishing process begins
immediately.
Note: You can also run (or edit) a previously saved property file from the Publisher to StarTeam Wizard menu if
you start the wizard from the CaliberRM client. On the wizard menu, choose File Open and select the
property file in the Select A Property File dialog box.
When you publish requirements to StarTeam, the Publisher to StarTeam Wizard creates a custom executable
(.stjava) file in the Traceability Addins installation folder based on the property file name you specified. It
uses the following file naming convention: CalStPublisher_[property file name].stjava
115
The Publisher to StarTeam Wizard also creates an .html log file in the same folder for every publishing session
you run. This log file contains a summary report of parameter details and debug information, including errors and
exceptions during execution.
Tip: You can publish requirements to StarTeam directly from the command-line or Windows Explorer by running
the [file name].stjava executable file.
Related Concepts
Product Integrations
Related Procedures
Creating Traces Between Requirements and Software Artifacts
Related Reference
StarTeam Integration Configuration
116
Import
This section provides how-to information about importing requirement information.
In This Section
Importing Requirements from Microsoft Word
Describes how to import requirements from Microsoft Word.
Related Concepts
Import
117
Importing Requirements from Microsoft Word
You can import requirement names and descriptions from a Microsoft Word document into a project using the Import
From Word wizard.
Note: Do not use special bullets (check marks or shaded less than signs) in table cell items.
Note: OLE objects included in Word documents are imported as pictures. You can insert the
respective OLE objects after import.
Indicate how you want to name the requirements. Select either the Retrieve the requirements names from
the document option button, or the Automatically name the requirements using a base name and a
sequential number option button. Enter a base name here. If you do not enter a name, Import uses the Microsoft
Word document name as the base name by default.
3 Click Next. In the top pane, if you are importing requirement names by style, select the paragraph style(s) that
are specific to requirement names. Styles define the appearance of various text elements within the document,
such as headings and body text. The styles listed are those found in your Microsoft Word document. You may
select any or all styles from the list.
In the bottom pane, indicate how to recognize requirement descriptions:
if you are importing requirements names by style, select the Import all text between the above selected
Text styles as the requirement description option.
if you are not importing requirement names by style, select the Import only the Text styles below as
the requirement description option. Select the styles that are specific to requirement descriptions.
4 Click Next. If you are importing requirement names by paragraph style, select the Import all text, ignoring
delimiters option button.
If not, select the Only import text enclosed in the following delimiters option button. The Beginning and
Ending fields become available. Enter the beginning and ending delimiter in the appropriate area.
5 Click Next. If you are importing requirement names by paragraph style, select the Import all text, ignoring
keywords option button. Import from Microsoft Word begins processing the document. Once processing is
completed, Import from Microsoft Word displays a list of new requirements for each criteria that was met. Import
from Microsoft Word also creates child requirements based on the paragraph style hierarchy in your document.
If you are importing requirement names by keywords, select the Only import text containing the following
keywords option button. Enter the keywords in the available field, separating each keyword by a comma.
Phrases containing these keywords are imported as requirement names.
6 Click Next. Import from Microsoft Word begins processing the document. Once processing is completed, Import
from Microsoft Word displays a list of new requirements for each criteria that was met. Import from Microsoft
Word also creates child requirements based on the paragraph style hierarchy in your document.
7 Select a requirement, and choose the location for the newly created requirements. Select one of the following
options: Insert Above, Insert Below, or Insert as Children.
8 Click Finish to complete import. The Import is Complete dialog box is displayed. Click OK.
118
Related Concepts
Import
119
Server Administration
This section provides how-to information about server administration.
In This Section
Backing up and Restoring a Database
Describes how to back up and restore a database.
Enabling LDAP
Describes how to enable and configure LDAP for user authentication.
Related Concepts
Importing Project Information
120
Backing up and Restoring a Database
Be sure to verify your backups periodically. Back up the production server and restore and test backups of project
data on a test system. Restoring and testing your backups helps to ensure that your data is being backed up correctly.
This does not require that you shut down the server.
To back up a database
1 Log on as the database administrator (DBA) to the machine where the server resides.
Note: You can determine the DBA by opening a command prompt and entering dblist
<enter>. The listed "creator" in the displayed list is the database owner.
Warning: Using the incorrect account results in a backup file that contains incorrect or no data.
The DBA name is case sensitive and must be exactly the same as used when the
database was created. The install utility created a directory called \CaliberRM_Backup
in the root of the drive where you installed the server. This is the default (preferred)
location for the backup file.
To restore a database
1 Choose Start Programs Command Prompt.
2 At the command prompt enter dbmgr -stop to stop the database.
To ensure the database is stopped after a dbmgr -stop command, the following four processes are not present
in Task Manager: caliber_srv.exe, cleanbe.exe, obe.exe and sqm_monitor.exe.
3 Remove the existing database using removedb rmdir {db name} (Example: removedb rmdir SQMDB).
4 Create a new database using makedb g {db name} (Example: makedb g SQMDB).
5 Overwrite the file profile.be with the corresponding backup file profile_mmddyy.be.
Copy the file profile_mmddyy.be that corresponds with the database directory that will be restored to
the database folder drive: \Borland\CaliberRMServer\Versant\DB\SQMDB.
Delete the exiting profile.be in the database folder.
Rename the file profile_mmddyy.be to profile.be .
Note: If the backup is the same database as the current database (just an earlier copy of it) you
do not have to perform the removedb and copy profile.be steps.
6 Restore the backup using vbackup dev {path & file name for backup file} restore {db
name} .
121
Answer no to prompt about applying logical log, if presented.
Answer no when prompted to restore another level of backup (Example: vbackup dev C:
\CaliberRM_Backup\SQMDB.bak restore SQMDB).
Related Concepts
Database Administration
122
Enabling LDAP
To enable LDAP
1 On the machine where the CaliberRM server is installed, select Start Settings Control Panel.
2 Click on the CaliberRM Server icon. The CaliberRM Server Settings window appears.
3 Click on the Directory Services tab.
4 Select the Enabled check box. If the Enabled check box is not selected, but a user is configured to use LDAP
Authentication on the his/her Security tab in the CaliberRM Administrator, the user should logon to the
CaliberRM server using CaliberRM credentials.
In the baseDN field, enter the baseDN data. The baseDN data represents the distinguished name of the
entry at which to start the search. For example, the baseDN for all Atlanta users in the directory for
Company A would be: (OU=Users,OU=Atlanta,DC=domain,DC=comp,DC=net)
In the Host field, enter the Host data. The Host data represents the domain name, or a space-separated
list of host names or dotted strings representing the IP address of hosts running an LDAP server to which
to connect. Each host name in the list can include an optional port number which is separated from the
host itself with a colon (:) character.
Do not modify the Filter field without checking with your LDAP Administrator.
Select the SSL check box to enable encryption for LDAP communications.
In the Port field. Enter the Port data. Normally, if you turn on SSL, you need to change the port number
as well. By default the ldap_port is 389, but the ldap_ssl_port by default is 636. Borland anticipates most
users will enable SSL, so our default port value is 636 (decimal).
5 If the Active Directory is set up to allow anonymous logins, and you will use the CaliberRM server's credentials
to access the Active Directory, select the Windows Authentication check box . This defaults to the server's
Local System account. If you do not select this option, the CaliberRM server needs credentials to access the
Active Directory to look up the CaliberRM client's user's LDAP DN. You need to enter values in the BindDN
and BindPW fields. You should not select the check box if the Active Directory does not allow anonymous logins.
123
Traceability
This section provides how-to information about requirement traceability.
In This Section
Connecting to a Team Foundation Server
Describes how to connect to a Team Foundation Server while working with Microsoft Visual Studio Team
Systemartifacts.
Creating Traceability Filters
Describes how to create and save traceability filters.
Creating Traces Between Requirements
Describes how to create requirement-to-requirement traces.
Creating Traces Between Requirements and Software Artifacts
Describes how to create traces between requirements and external software artifacts.
Editing and Deleting Traces
Describes how to modify and delete requirement traces.
Enabling Project Traceability to Software Artifacts
Describes how to enable external traceability for a project.
Viewing Microsoft Visual Studio Team System Test Results
Describes how to view Microsoft Visual Studio Team System test results.
Viewing Traceability
Describes how to view traceability relationships.
Related Concepts
Traceability
124
Connecting to a Team Foundation Server
Performing tasks with work items and tests requires connection to the Microsoft Team Foundation Server. If you
have not yet established a connection to the Microsoft Team Foundation Server, the Connect to Team Foundation
Server dialog box appears.
Note: If the drop-down server list is empty or does not contain the required server, you need to
add the server to the list manually. See To add a Microsoft Team Foundation Server to
the drop-down list below.
3 Click OK.
Related Concepts
Traceability
Related Procedures
Enabling Project Traceability to Software Artifacts
Creating Traces Between Requirements and Software Artifacts
125
Creating Traceability Filters
You can create traceability filters based on multiple criteria:
Note: Filters are private to each user and cannot be shared at this time.
Note: If you have an error in your filter conditions, the condition with the error appears with a red
underline.
3 You can group filter criteria and nest criteria using the Decrease Indent and Increase Indent buttons.
4 Once you have set all conditions as desired, click the Save button.
5 Enter a name for the filter and click OK. The filter is saved.
Note: You cannot filter on external objects but you can include external objects in the matrix by
selecting the external object tab in the Traceability Filter window, and indicating whether
the external objects should be displayed in the rows or the columns.
To copy a filter
1 In the Traceability Filter window, select a filter from the Rows or Columns drop-down list and click the
Browse button. The Filter Manager window appears.
2 From the Available Filters list, select the filter to copy.
3 Click the Duplicate button. A copy of the filter is created. You can modify the filter as needed.
126
Related Concepts
Traceability
Related Procedures
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
127
Creating Traces Between Requirements
You can establish traceability between requirements from either the requirement Traceability tab or from the
Traceability Matrix (Tools Traceability Matrix).
Note: Right-click the requirement in the list and select Properties to view requirement properties.
Note: To establish many traces at once, use the CTRL and SHIFT keys to select multiple cells.
Related Concepts
Traceability
Reports
Related Procedures
Viewing Traceability
Creating Traces Between Requirements and Software Artifacts
128
Creating Traces Between Requirements and Software Artifacts
You can create traces to or from external software artifacts such as Borland StarTeam change requests,
requirements, files and tasks, Borland SilkCentral or Mercury Quality Center test cases, Borland Together designs
(you must create traces between requirements and Together designs in Together. Once created in Together, you
can view the traces and properties of Together designs in CaliberRM), and Microsoft Visual Studio Team System
work items or tests.
Note: You must create traces between requirements and Together designs in Together. Once
created in Together, you can view the traces and properties of Together designs in
CaliberRM.
129
To create traces to or from Mercury Quality Center artifacts
1 Select the Quality Center tab.
2 Select the Requirements, Test Plan, or Test Lab tab to trace the selected requirement to a corresponding
Mercury object.
3 Select a server name from the list of available Mercury servers. CaliberRM connects to the Mercury server.
4 Select a Mercury domain. CaliberRM connects to the Mercury domain.
5 Select a Mercury project. CaliberRM connects to the Mercury project.
Note: When you access a Mercury project for the first time, the Login to Quality Center Server
dialog box appears. Specify a valid user name and password to access the Mercury server.
You can also define a default credential to be used to access all Mercury projects. Note
that you must check this box if you want to run a Datamart report in silent mode, so that
no login dialog box is displayed during the Datamart extraction. Refer to the
UsingDatamart.pdf guide for details.
Note: The Test execution status for Mercury Test objects, and status for Mercury Requirements
are displayed on the Traceability tab. Note that status for TEST SET is not displayed in
CaliberRM at this time. Also note that the execution status displayed for Test Lab tests is
the status of the last run Test Lab test (among all the Test Lab tests created for the matching
Test Plan test (or No Run if no Test Lab tests were created).
7 Click the Trace From or Trace To button from the menu to create a traceability link from a CaliberRM
requirement to a Mercury object.
8 Click the Save As button to save the trace.
Note: If you have not yet established a connection to the Microsoft Team Foundation Server, the
Connect to Team Foundation Server dialog box appears. See the Related Procedure
below.
2 Select the test to establish a trace with. Choose Trace Trace To or Trace Trace From from the menu to
add a trace to or from the object.
Tip: You can create Microsoft Visual Studio Team System Work Items in the Traceability
Modification window. Right-click the list of work items to display the context menu and
choose New Work Item.
130
Related Concepts
Traceability
Reports
Related Procedures
Enabling Project Traceability to Software Artifacts
Creating Traces Between Requirements
Editing and Deleting Traces
Viewing Traceability
Connecting to a Team Foundation Server
Viewing Microsoft Visual Studio Team System Test Results
Related Reference
StarTeam Integration Configuration
131
Editing and Deleting Traces
Modify: Opens the Traceability Modification window, where you can change the direction of a trace.
Go To: Navigates to the Traceability tab of the requirement you have selected.
Remove: Deletes the trace.
Make/Clear Suspect: Makes the link a suspect link or clears the suspect link.
Properties: Displays Property Details and User Defined Attributes (UDAs) for the selected requirement
or object.
3 Select an option and save the changes to the requirement when finished.
You can also delete/edit a trace between requirements from the Traceability Matrix. When the matrix appears,
right-click the cell that corresponds to the requirements to trace and select one of the options.
Note: To delete or edit many traces at once, use the CTRL and SHIFT keys to select multiple cells.
Related Concepts
Traceability
Related Procedures
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
132
Enabling Project Traceability to Software Artifacts
Related Concepts
Traceability
Product Integrations
Related Procedures
Defining Projects
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
Related Reference
StarTeam Integration Configuration
133
Viewing Microsoft Visual Studio Team System Test Results
You can view Microsoft Visual Studio Team System test results:
Note: For the purposes of this documentation, the user-customized tab that refers to tests is called VSTSTests.
Note: If you have not yet established a connection to the Microsoft Team Foundation Server, the
Connect to Team Foundation Server dialog box appears. See Related Procedures
below.
Note: You can open the Results for test: window from the Traceability Diagram.
Related Concepts
Product Integrations
Traceability
Related Procedures
Creating Traces Between Requirements and Software Artifacts
Connecting to a Team Foundation Server
134
Viewing Traceability
To view a view a specific requirement and its traceability relationship using the Traceability Diagram, select Tools
Traceability Diagram.
To view a specific requirement and its traceability relationship using the Traceability
Diagram
1 Choose Tools Traceability Diagram.
The selected requirement is located in the center of the diagram and underlined in green. Other objects in the
diagram include requirements, StarTeam change requests, Mercury Quality Center objects and other external
objects that are represented by their associated file type icon. The trace to objects are located to the right of
the target requirement, while the trace from objects are located to the left. The arrows represent the direction
of the trace.
2 To view an object's properties, click the option from the View menu. You can view the object's tag (ID number),
name or project name.
3 Right-click an object to open its Properties or to Go To the requirement in the tree.
4 To print the diagram, choose File Print from the menu.
Related Concepts
Traceability
Related Procedures
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
Creating Traceability Filters
135
Users
This section provides how-to information about users.
In This Section
Creating Baseline Administrators
Describes the task content in a sentence; used for part descriptions only.
Creating Groups
Describes how to create groups.
Creating Users
Describes how to create users.
Related Concepts
Users
Related Procedures
Enabling LDAP
136
Creating Baseline Administrators
Type introductory text only if necessary, otherwise, start the procedure. Avoid including conceptual information. For
more complex procedures requiring multiple stages, use the initial taskList to outline the required steps, then use
subtasks for each subsequent stage.
Note: Use a note to provide important information that might prevent the procedure from working.
137
Creating Groups
To create a group
1 In the CaliberRM Administrator, choose File New Group from the menu.
2 Enter a unique name and an email address for the group and click Next.
3 Enter a description for the group and click Next.
4 To assign users to the group, select users in the Not Selected list and click the Add button.
5 Click Next. To assign the group to projects, select projects in the Not Selected list and click the Add button.
6 Click Next. The New Group Information dialog box appears.
7 Verify the information you have entered. If the information is correct, click Finish. If not, click Back and make
the necessary changes.
Related Concepts
Users
Related Procedures
Creating Users
138
Creating Users
Users are created using the User Creation Wizard in the CaliberRM Administrator. You must be an administrator
(either the admin user or a user who belongs to the Administrators group) to create users.
To create a user
1 Select File New User from the CaliberRM Administrator menu.
2 Enter a unique ID (username) for the user. Do not include spaces.
3 Enter the first and last name of the user and optionally specify the users title and department, and click Next.
Note:
First names and last names must not exceed 128 characters.
4 Optionally enter the users phone, fax, email, pager and location information and click Next.
5 To assign the user to groups, select groups in the Not a member of list and click the Add button. Click Next.
Note: The Administrators group is a special group that provides users full access to CaliberRM
project definition. Very few users should belong to this group. Users in this group are
referred to Project Administrators.
6 Select the type of Authentication for this user: CaliberRM, which will use a CaliberRM password, or LDAP,
which will use an LDAP password. If you select CaliberRM, enter a password for the user. If you select LDAP,
enter the user's LDAP DN.
Note: If LDAP is not enabled at the CaliberRM server, but a user is configured to use LDAP
Authentication, the user should logon using CaliberRM credentials.
Note: If a user's DN has changed in the LDAP Domain Controller since the user was created in
CaliberRM, you need to re-enter the latest DN in this tab.
7 Select one or more of the following options to set the appropriate user password restrictions:
User Must Change Password at Next Logon: Forces the user to change his/her password at the next
logon. Not available when using LDAP.
User Cannot Change Password: Prevents the user from changing his/her password. Not available when
using LDAP.
Password Never Expires: Allows the user to have a password that never expires. Not available when
using LDAP.
Account is Disabled: Disables the user account. You cannot select the User Must Change Password
at Next Logon and the User Cannot Change Password check boxes at the same time. If you select
these boxes and attempt to save the information, an error message is displayed.
User Can Perform Baseline Maintenance: Allows the user to create and manage baselines. Such user
is referred to a Baseline Administrator.
User Can Manage Glossary Terms: Allows the user to create new glossary terms (for all glossaries in
the CaliberRM server) and edit existing ones.
139
Related Concepts
Licensing
Related Procedures
Enabling LDAP
140
Reference
141
References
This section provides additional information about CaliberRM interfaces and other helpful information.
In This Section
Document Factory Syntax
Provides information about Document Factory syntax.
Database Manager Commands
Provides information about the database manager (DB Manager) commands.
StarTeam Integration Configuration
Provides information about customizing and displaying StarTeam objects in CaliberRM.
142
Document Factory Syntax
Document Factory enables you to generate any type of up-to-date, customized specifications documents using
Microsoft Word templates. In Word, you can create templates containing fields that correspond to requirement
attributes. You can then use Document Factory to populate the template with data from any project. Using filter
criteria in the template fields, you can even specify what requirement data is included in the document. Document
Factory generates .doc, .txt and .rtf files.
The first step in generating a Document Factory document is to create a Microsoft Word template. Templates contain
any printable data you want to appear in the document including column headers, labels and page numbers.
Templates also contain Document Factory commands, keywords and operators.
Commands control the selection, order and grouping of the requirements in the document.
Keywords are placeholders that correspond to project and requirement information. They specify the data that
is put into the document. You must enter them in a template exactly as they appear in the requirements
manager.
Operators allow you to apply very specific criteria when searching for groups of requirements.
Note: You must have Microsoft Office installed to use Document Factory.
Note: New lines in Document Factory templates result in carriage returns or line feeds in the Document Factory
output document. If you do not want extra space in your reports, make sure your templates do not include
new lines.
Warning: For large reports, performance may not be adequate when running Document Factory. In this case, use
Document Factory in batch mode off hours using the command.ini file. See the Related Information link,
Scheduling Document Factory Reports below. When running Document Factory, Microsoft Word should
not be running.
Commands
Document Factory uses a set of special commands referred to as $Commands to populate and format the document.
The $Commands are non-printing and do not appear in the completed document. Some commands, like $Begin_list/
$End_list, are used in pursuant process lists of information, such as a list of traceability links or a list of users
responsible for a requirement. $Commands alone do not place data in the document. You must use them in
conjunction with keywords.
There are 4 types of commands:
Note: $Commands are not case sensitive, and uppercase letters are not required for proper operation; however,
adopting a formatting style and using it consistently adds to the readability of your templates.
143
$FILTER{type = Business
Requirements}
$SORT{hierarchy}
$END_SECTION
The following keywords can
be used in a sort command:
type, tag, id_number, version,
status, priority, hierarchy,
user-defined attributes
Note: You cannot sort on:
description, validation,
references, responsibility,
traces, text-field UDAs, User
List UDA, Group List UDA or
Multiple Selection List UDA.
$INDENTION_LEVEL{ } Optional Specifies the maximum $BEGIN_SECTION
number of levels a section will
$FILTER{type = Business
be indented.
Requirements}
$SORT{hierarchy}
$INDENTION_LEVEL{3}
$INDENTION_SIZE{.5}
$END_SECTION
$INDENTION_SIZE{ } Optional Specifies how far, in inches, See the example above
each level is indented.
$PROJECT{ } Optional Specifies the project name for $PROJECT{Order
the document. You can only Processing}
specify one project in a
template.
$BASELINE{ } Optional Specifies the baseline to use $BASELINE{Version 1.0}
for the document.
$BEGIN_SECTION Required Marks the beginning of a $BEGIN_SECTION
section. Most commands
$FILTER{type = Business
must be enclosed in a
Requirements}
$BEGIN_SECTION/
$END_SECTION command. $SORT{hierarchy}
Rules about a section: $INDENTION_LEVEL{.3}
A template can contain $INDENTION_SIZE{.5}
many sections; however, you
can not have a section within $BEGIN_LIST
a section. <<references>>
All $Commands except <<responsibilities>>
$Project, $Baseline, and
$Begin_Signatures/ $END_LIST
$End_Signatures must be $CALCULATE{keyword1 *
used within in a keyword2 as result}
$Begin_Section/
$End_Section command. <<name>>
(<<tag>><<id_number>>)
There can be only one
instance of each type of <<description>>
command in a section.
<<traces>>
144
<<history>>
$END_SECTION
$END_SECTION Required Marks the end of a section. See the example above
Must be used with
$BEGIN_SECTION.
$REQIDS Optional Specifies which requirements $PROJECT{Order
to search using ID numbers. Processing} $BASELINE
$Reqids is used in conjunction {Version 1.0} $REQIDS{123,
with $Project and $Baseline 345}
keywords.
$REQTREE Optional An alternative to the $REQIDS $REQTREE{214}
command. This command
allows you to report on a group
of requirements by simply
specifying the parent
requirement ID number. Note
that $REQTREE is mutually
exclusive with $REQIDS.
$REQIDS takes priority over
$REQTREE and only the first
$REQTREE command
specified in a template is
used.
$BEGIN_SIGNATURES/ Optional A command loop used to $BEGIN_SIGNATURES
$END_SIGNATURES include baseline signature
<<first_name>><<last_name
information. Used with
>>,<<title>>
signature keywords.
<<signature_date>>
<<meaning>>
<<comment>>
$END_SIGNATURES
$FILTER{ } Optional Specifies that only data that $BEGIN_SECTION
meets the criteria specified by
$FILTER{type = Business
its arguments is included in
Requirements}
the section.
$END_SECTION
$Filter commands are
expressed as:
expression1 compare
operator expression2 where:
Expression1 is one of the
following keywords: tag, type,
id_number, version, status,
priority, hierarchy, user-
defined attributes
See the list of compare
operators in the Operators
section below for details
Expression1 is a keyword
value expressed as: text string
(expressed as Business
Requirements), numbers
(integers or float expressed as
145
number of days = 50), dates
(expressed as date =
#11-22-01#), boolean
(expressed as yes or no, no
quotes)
You can use wild cards in
searches that use the like
condition. The wild card
characters are as follows: %
(a string of characters of any
length, or possibly no
characters; also used to
represent multiple
characters), _ (one character),
(one digit), [a-g] (range of
characters), [!a-g] (outside a
range of characters); [%] or
[ _ ] (placing a special
character in brackets means
to take it literally rather than
giving it a special meaning)
You can combine search
conditions by using the
following logical operators:
and (both expressions must
be true to return a value), or
(either condition must be true
to return a value).
$BEGIN_LIST Optional A command loop used with Responsibilities:
keywords to produce lists of
$BEGIN_LIST
data. It displays a comma
separated sequence for <<responsibilities>>
<<responsibilities>> and
Multiple Selection User- $END_LIST
Defined Attributes. Only when Note: You can format the
<<references>> is used does information with bolding,
an actual list appear in the underlining, etc.
output. Data is pre-formatted.
Must be used with
$END_LIST.
$END_LIST Optional Marks the end of a list. Must See the example above
be used with $BEGIN_LIST.
$BEGIN_HISTORY Optional A command loop used with $BEGIN_SECTION
history revision keywords.
$FILTER{type = Business
Allows you to format the data.
Requirements}
Must be used with
$END_HISTORY. $SORT{hierarchy}
$BEGIN_HISTORY
Rev#:<<major_version>><<
minor_version>>User:<<user
id>>
Name:<<user_name>>
<<Comment>>
$BEGIN_CHANGES
146
Changed
Field:<<field_changed>>
From:<<from_value>>To:<<t
o_value>>
$END_CHANGES
$END_HISTORY
$END_SECTION
$END_HISTORY Optional Marks the end of the history See the example above
revision loop. Must be used
with $BEGIN_HISTORY.
$BEGIN_CHANGES Valid only if $BEGIN_ A command loop used with See the example above
HISTORY/ $END_ HISTORY history changes keywords.
is used Allows you to format the data.
Must be used with
$END_CHANGES.
$END_CHANGES Valid only if $BEGIN_ Marks the end of the history See the example above
HISTORY/ $END_ HISTORY changes loop. Must be used
is used with $BEGIN_CHANGES.
$BEGIN_TRACES( ) Optional A command loop used with $BEGIN_SECTION
the traceability keywords.
$BEGIN_TRACES
Allows you to format the data.
(TO_TRACES,FROM_TRAC
Must be used with
ES,DIRECT_TRACES,
$END_TRACES.
ALL_OBJECTS)
<<Trace_Name>><<Trace_D
irection>><<Trace_Suspect>
>
$END_TRACES
$END_SECTION
$Begin_Traces/$End_Traces
takes a string of identifiers that
specify the trace and object
types you want to be include in
the document. There are three
categories of identifiers: trace
direction (to or from traces),
trace type (direct or implied),
object type (requirements,
Quality Center (to traces only)
and SCM objects)
The option string can contain
a combination of identifiers.
The identifiers can be in any
order and separated by any
type of separator.
The trace identifiers are as
follows: TO_TRACES,
FROM_TRACES,
DIRECT_TRACES,
IMPLIED_TRACES,
REQUIREMENT_OBJECTS,
SCM_OBJECTS,
ALL_OBJECTS
147
If no option string is supplied,
Document Factory assumes
the following default:
$Begin_Traces
(To_Traces,From_Traces,Dir
ect_Traces, All_Objects)
The data extracted for each
object is determined by the
keywords used within the
command.
$END_TRACES Optional Marks the end of the See the example above
traceability loop. Must be used
with $BEGIN_TRACES.
$BEGIN_DISCUSSIONS Optional A command loop used to $BEGIN_SECTION
format requirement
$FILTER{type = 'Functional
discussion data. Used with
Requirements'}
discussion keywords. Must be
used with <<hierarchy>><<name>>
$END_DISCUSSIONS. (<<tag>><<id_number>>)
Project Discussions:
$BEGIN_DISCUSSIONS
Tag: <<discussion_req_tag>>
Subject:<<subject>>
From:<<from>>
Is Read: <<is_read>>
Date: <<discussion_date>>
Body: <<body>>
$END_DISCUSSIONS
$END_SECTION
$END_DISCUSSIONS Optional Marks the end of the See the example above
requirement discussion loop.
Must be used with
$BEGIN_DISCUSSIONS.
$BEGIN_PROJECT_ Optional A command loop used to $PROJECT{Order
DISCUSSIONS format project discussion Processing}
data. Used with discussion
Project name:<<project>>
keywords. Must be used with
$END_PROJECT_DISCUSS Project description:
IONS. <<project_description>>
Note: The Project Discussions:
$Begin_Project_Discussions/
$End_Project_Discussions $BEGIN_PROJECT_DISCU
command does not have to be SSIONS
used in a $Begin_Section/ Subject: <<subject>>
$End_Section.
From: <<from>>
Is Read: <<is_read>>
Date: <<discussion_date>>
Body: <<body>>
148
$END_PROJECT_DISCUSS
IONS
$END_PROJECT_ Optional Marks the end of the project See the example above
DISCUSSIONS discussion loop. Must be used
with
$BEGIN_PROJECT_DISCU
SSIONS.
$BEGIN_GLOSSARY Optional A command loop used to $PROJECT{Order
include glossary information. Processing}
Used with glossary keywords.
User name: <<userid>>
Must be used with
$END_GLOSSARY. Project name: <<project>>
Project description:
<<project_description>>
$Begin_Glossary
Term: <<term>>
Definition: <<definition>>
$End_Glossary
$END_GLOSSARY Optional Marks the end of the glossary See the example above
loop. Must be used with
$BEGIN_GLOSSARY.
$RGVFile Optional A command loop used to $BEGIN_SECTION
apply a Requirement Grid filter
$RGVFILE{C:\Program Files
within a section.
\Borland\CaliberRM\All
You can apply a Requirement Requirements.rgv}
Grid filter to your Document
<<hierarchy>><<name>>
Factory reports using the
(<<tag>><<id_number>>)
$RGVFile command. If a
$Filter command is used in the $END_SECTION
same section as the $RGVFile
command, Document Factory
combines the two queries. If a
$Sort command is used in the
same section as the $RGVFile
command, the resulting
document will display data
from both commands, in an
order determined by which
command is used first in the
template.
When using the $RGVFile
command, you do not need to
specify the project in the
template. Document Factory
will use the project specified in
the .rgv file you are using. If
you do specify a project in the
template, it must be the same
project in the .rgv file.
$CALCULATE{ } Optional Performs calculations on $BEGIN_SECTION
specified keywords.
$CALCULATE{days +
The $Calculate command overtime hours as total_time}
instructs Document Factory to
149
perform a mathematical Number of hours:
calculation on the specified <<total_time>>
keywords. You must format
the arguments to $Calculate $END_SECTION
as keyword1 [*+-/] keyword2
as result. Keyword1 and
keyword2 are separated by an
operator (multiply [*], add [+],
subtract [-], divide[/]), then the
word as followed by the
result. Result is any name that
you want to use. It can then be
used elsewhere in the
document like a keyword to
display the results of the
calculation.
You can only use one
$Calculate command in a
section, but you can specify
several calculations in one
$Calculate command
separated by commas.
Keywords
Keywords are placeholders in the template that correspond to specific fields in a CaliberRM project. Document
Factory replaces the keyword in the template with the actual data from its corresponding field. Some keywords
correspond to a single entry, while others correspond to lists of data. Keywords must be enclosed by brackets, e.g.
<<hierarchy>>.
Keywords are also used as arguments to some $Commands. When used as arguments, keywords are not enclosed
in brackets.
Note: User-defined attributes that have names identical to keywords cannot be used in a document. To avoid
conflicts, these keywords should not be used as attribute names.
Global Keywords
The following keywords are global, meaning they can be used anywhere in the document, including headers and
footers (with the exception of <<project_description>> and <<baseline_description>>):
Keyword Description
<<project>> The name of the project
<<project_description>> The description of the project. Cannot be used in a header or
footer.
<<userid>> The ID of the user creating the document
<<baseline>> The name of the baseline
<<baseline_description>> The description of the baseline. Cannot be used in a header
or footer.
<<baseline_initialization_date>> The creation date of the baseline. Only applies to non-Current
baselines.
150
<<baseline_last_modified_date>> The last modification date of the baseline. Only applies to non-
Current baselines.
<<baseline_date_locked>> The date when the baseline was locked. Only applies to non-
Current baselines.
Specific Keywords
The following keywords can only be used within the limits specified in the table titles below.
$Begin_Section/$End_Section Keywords
Keyword Description
<<type>> The requirement type
<<hierarchy>> The requirement hierarchy number
<<id_number>> The unique ID number
<<status>> The requirement status
<<priority>> The requirement priority
<<description>> The requirement description
<<tag>> The requirement type tag
<<name>> The requirement name
<<version>> The project version number
<<owner>> The requirement owner
<<validation>> The validation procedure
<<UDA Name>> <<Any user-defined attribute; you must enter these exactly as
they appear in CaliberRM>>
<<Calculated Field Name>> Result of a $Calculate command
<<history>> All history data for a requirement
<<traces>> All traceability data for a requirement
<<references>> The drive, directory and the file link for all the document
references assigned to a requirement
<<responsibilities>> The list of all users responsible for the requirement
<<created_by>> The userid of the user who created the requirement
<<created_on>> The date/time that the requirement was created
The graphic below shows how some of the $Begin_Section/$End_Section keywords relate to the fields in CaliberRM.
$Begin_Signatures/$End_Signatures Keywords
You can only use these keywords within the $Begin_Signatures/$End_Signatures command loop. The
<<signatures>> keyword used alone produces a pre-formatted list of baseline signatures formatted as:
$Begin_List/$End_List Keywords
The following keywords are used to generate lists of information.
151
Keyword Description
<<references>> Used within a $Begin_List/$End_List command; extracts the
document reference list for a requirement, found on the
References tab.
<<responsibilities>> The keyword is used within a $Begin_List/ $End_List
command; extracts the responsibilities list for a requirement;
found on the Responsibilities tab.
Multiple Selection User- Defined Attributes Any multiple selection user-defined attribute can be used in a
$Begin_List/$End_List command.
$Begin_History/$End_History Keywords
The <<history>> keyword extracts all history data for a requirement.
$Begin_History/$End_History scans each entry in the revision list and extracts data for the keywords specified in
the template.
These keywords can only be used within the $Begin_History/$End_History command loop.
Keyword Description
<<major_version>> Major version number
<<minor_version>> Minor version number
<<datestamp>> Date of the change
<<timestamp>> Time of the change
<<userid>> Logon ID of user who made the change
<<user_name>> First and last name of user who made the change
<<comment>> Reason for the change
$Begin_Changes/$End_Changes Keywords
$Begin_Changes/$End_ Changes scans each entry in the changes list and extracts data for the keywords specified
in the template.
These keywords can only be used within the $Begin_Changes/$End_Changes command loop.
Keyword Description
<<field_changed>> Attribute - what changed
<<from_value>> Old attribute value
<<to_value>> Current attribute value
$Begin_Traces/$End_Traces Keywords
The <<traces>>keyword extracts all trace data for a requirement.
The following keywords are used to extract and format specific data. You can only use these within a $Begin_Traces/
$End_Traces command.
Keyword Description
<<Trace_objecttype>> Type of object trace
<<Trace_ReqTag>> Tag number of trace to or from object
152
<<Trace_Project>> The project in which the requirement being linked to or from is
located
<<Trace_Name>> Name of trace to or from object
<<Trace_Direction>> Indicates the direction of the trace
<<Trace_DirectImplied>> Indicates whether the trace is a direct or implied trace.
Reporting on large numbers of implied traces may cause
performance degradation.
<<Trace_Suspect>> Indicates whether the trace is suspect
<<Trace_TestStatus>> Indicates pass/fail status (Indicates test pass/fail status for
Mercury Quality Center and Silk Central Test Manager traces )
<<Trace_type>> The requirement type of the traced requirement
<<Trace_tag>> The requirement tag of the traced requirement
<<Trace_status>> The status of the traced requirement
<<Trace_priority>> The priority of the traced requirement
<<Trace_version>> The version of the traced requirement
<<Trace_owner>> The owner of the traced requirement
<<Trace_created_by>> The person who created the traced requirement
<<Trace_created_on>> The date the traced requirement was created
<<Trace_description>> The description of the traced requirement
$Begin_Discussions/$End_Discussions Keywords
The <<discussions>> keyword extracts the list of all requirement discussions. Data includes the requirement tag,
discussion subject, the user who initiated the discussion and the discussion date.
Note: You do not have to use the <<discussions>> keyword within a $Begin_Discussions/$End_Discussions
command loop.
The following keywords are used to extract and format specific data. You can only use them within a
$Begin_Discussions/$End_Discussions command.
Keyword Description
<<discussion_req_tag>> The requirement identifier; includes the type tag and id
<<subject>> The subject of the discussion
<<from>> User who initiated the discussion
<<is_read>> Indicates if current user has read the discussion
<<discussion_date>> Date the discussion was saved
<<body>> The message text of the discussion
Note: You do not have to use the <<project_discussions>> keyword does not have to be used within a
$Begin_Project_Discussions/$End_Project_Discussions command loop.
153
The keywords below are used to extract and format specific data. You can only use them
within a $Begin_Project_Discussions/$End_Project_Discussions command loop.
Keyword Description
<<subject>> The subject of the discussion
<<from>> User who initiated the discussion
<<is_read>> Indicates if current user has read the discussion
<<discussion_date>> Date the discussion was saved
<<body>> The message text of the discussion
$Begin_Glossary/$End_Glossary Keywords
The <<glossary>> keyword extracts a pre-formatted list of glossary information. This keyword outputs all glossaries
assigned to the selected project in their specified order. Data includes glossary terms and their definitions.
Note: You should not use the <<glossary>> keyword within a $Begin_Section/ $End_Section command loop.
Note: You do not have to use the <<glossary>> keyword within a $Begin_Glossary/ $End_Glossary command loop.
The following keywords are used to extract and format specific data. You can only use them within a
$Begin_Glossary/$End_Glossary command.
Keyword Description
<<glossary_name>> The name of the glossary
<<term>> The term
<<definition>> The terms definition
Operators
Operator is a symbol used to perform an operation on some value. It allows you to apply very specific criteria when
searching for groups of requirements in the $Filter and $Calculate commands that are described above.
Compare Operators
You use compare operators in the $Filter command.
154
Not Between Not within a range total not between 5 and 10
In In a set number in (1,2,3)
Not In Not in a set serial not in (88,89,90)
Logical Operators
You use logical operators in the $Filter command.
Operator Meaning
and Both expressions must be true to return a value
or Either condition must be true to return a value
Mathematical Operators
You use mathematical operators in the $Calculate command that instructs Document Factory to perform a
mathematical calculation on the specified keywords.
Operator Meaning
* Multiply
+ Add
- Subtract
/ Divide
Related Concepts
Reports
Related Procedures
Creating Document Factory Reports
Scheduling Document Factory Reports
155
Database Manager Commands
The Database Manager (DB Manager) is a utility to administer databases. The user running the commands must
be the user who created the CaliberRM database. DB Manager uses command line switches to run each utility. The
switches and their usage are detailed in the table below. All commands except for the Detailed Help command
require that all users be logged off.
156
StarTeam Integration Configuration
The StarTeam Traceability Add-in configuration file provides a way to customize how StarTeam items are displayed
in CaliberRM. The configuration file is divided in multiple sections, detailed below, each defining specific areas of
display configuration. In the CaliberRM Administrator, select the project view and click the External Traceability
tab. Select StarTeam and click the Edit button.
Connections to StarTeam servers may persist after the CaliberRM client session ends. This should be a
consideration when setting the timeout interval on the StarTeam server when using the integration.
157
Related Concepts
Product Integrations
Traceability
Related Procedures
Enabling Project Traceability to Software Artifacts
Creating Traces Between Requirements and Software Artifacts
Publishing Requirements to StarTeam
158
Index interfaces, 12
administrative reports key features, 12
creating, 87 Keywords, 143
administrator interfaces LDAP, 123
project administrator interfaces, 13 licensing, 54
attribute definitions log on, 26
exporting, 111 MPX agents, 16
attributes new features, 29
requirements, 51 Operators, 143
backing up database partner solutions, 16
restoring database, 121
port number, 125
baselines
project information
requirements, 65
importing, 46
creating, 73
projects, 49
Borland License Server, 54
protocol, 125
CaliberRM
overview, 12 references
requirements, 95
Commands, 143
reports, 57
connecting
creating, 90 98
Team Foundation Server, 125
Document Factory, 88
creating Requirement Grid, 85
requirements, 100 requirement reports, 90 98
custom tools, 16 requirement grid, 60
customized requirement reports, 61 requirement information, 60
database, 121 requirement type, 78
database administration requirement types, 50
dbmgr utility, 47
requirement views, 60
database manager commands
requirements, 59
commands, 156
importing, 67
Datamart, 61
requirements management, 14
defining projects
scheduling reports
Project Creation Wizard, 20 81
Document Factory reports, 92
developer interfaces, 13
SDK
discontinued features, 41 API, 16
Document Factory, 61 security, 56
syntax, 143
security profiles, 80
export, 66
Server name, 125
CSV files, 106 112
standard requirement reports, 61
extending functionality, 16
StarTeam
FlexLM, 55
publish requirements (export), 113
glossaries configuring, 157
theme glossaries, 64
Support Center
glossary terms, 76 Web site, 9
groups, 138 traceability, 63
creating, 138 software artifacts, 102 129
Help, 9 traceability add-in, 16
IDE environments, 15 traceability filters, 126
importing traceability matrix, 60
Microsoft Word, 107 118
traceability reports, 62
integrations, 15
159
traces, 105
tree view, 60
users, 23
Visual Studio Team System, 13
Visual Studio Team System tests
viewing results of, 134
160