CaliberRM Tutorial

User Tutorial
CaliberRM
Borland Software Corporation may have patents and/or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents. Copyright 19972006 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. CRM06-TUT November 2006
Table of Contents
Chapter 1 Chapter 7
Tutorial Conventions
Chapter 2
CaliberRM Administrator Tutorial

Overview . . . . . . . . . . . . . . . Logging On . . . . . . . . . . . . . Projects . . . . . . . . . . . . . . . Creating a Project . . . . . . . . Departments . . . . . . . . . . . . . Creating a Department . . . . . . Glossaries . . . . . . . . . . . . . . Creating a Glossary . . . . . . . Assigning a Glossary to a Project Groups . . . . . . . . . . . . . . . . Creating a Group . . . . . . . . . Users . . . . . . . . . . . . . . . . Creating a User. . . . . . . . . . Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
27
27 27 28 28 28 29 29 29 29 30 30 31 31 32
Notational Conventions . . . . . . . . . . . . . . . . 1
Introduction
Overview . . . . . . . . . . Tutorial Objective . . . . . . StarTeam Toolbar . . . . . . Toolbar Options . . . . . Adding a Tool Shortcut. . Modifying a Tool Shortcut Deleting a Tool Shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3
3 3 4 4 5 5 5
Chapter 3
Getting Started
Overview . . . . . . . . . . . . . . . . . . Logging On to the CaliberRM Administrator Logging On to CaliberRM . . . . . . . . . . User Interface . . . . . . . . . . . . . . . . Displaying Requirement Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
7 7 8 9 9
Chapter 8
Baseline Maintenance
Overview . . . . . . . . . . . . . . Creating a Project Baseline . . . . Initializing a Baseline . . . . . . . Locking a Baseline. . . . . . . . . Electronic Signatures for Baselines Adding a Signature . . . . . . . . Signature Reports . . . . . . . . . Comparing Baselines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
33 33 34 35 35 35 36 36
Chapter 4
Basic Tutorial
11
Overview . . . . . . . . . . . . . . . . . . . . . . . 11 Creating a Requirement . . . . . . . . . . . . . . . 11 Step 1: Defining Requirement Information. . . . . 11 Step 2: Assigning Attribute Values to a Requirement 12 Step 3: Assigning Users and Groups to a Requirement . . . . . . . . . . . . . . . . . . . 13 Copying a Requirement . . . . . . . . . . . . . . . . 13 Modifying a Requirement . . . . . . . . . . . . . . . 14 Changing the Requirement Order . . . . . . . . . . 14
Chapter 9
Group Discussion and Change History 37

Group Discussion . . . . . Reading a Message . . Posting a New Message Change History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 37 38 38
Chapter 5
Chapter 10
Advanced Tutorial
Overview . . . . . . . . . . . . Linking a Reference Document . Creating a Traceability Link . . . Traceability Matrix . . . . . . . . Defining Requirement Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
. 17 . 17 . 18 . 18 . 19
Reports and the Document Factory

Reports . . . . . . . . . . . . . . . . Document Factory . . . . . . . . . . . Document Factory Commands . . . . Keywords . . . . . . . . . . . . . . Word Template Setup . . . . . . . . . Creating a Document Using Document Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
39 39 40 42 43
Chapter 6
. . . . . . . 44
Administrator Tutorial
21
Overview . . . . . . . . . . . . . . . . . . . . . . . 21 Requirement Types . . . . . . . . . . . . . . . . . . 21 Creating a Requirement Type . . . . . . . . . . . 21 Attributes . . . . . . . . . . . . . . . . . . . . . . . 23 User-Defined Attributes . . . . . . . . . . . . . . . . 23 Creating a User-Defined Attribute . . . . . . . . . 23 Assigning User-Defined Attributes to a Requirement Type . . . . . . . . . . . . . . . . . . . . . . . 24 Summary . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 11
Summary
Appendix A
45
Borland Support . . . . . . . . . . . . . . . . . . . 45
Glossary Index
47 49
ii
Chapter
1
Chapter 1
Tutorial Conventions
Notational Conventions
The following notational conventions are used throughout this manual: Convention
File > Open Project Bold
Represents
Indicates cascading menu commands. A new term or an item requiring special attention Menu name, option, button or field that performs an action
Example
Select File > Open Project to open a project. ...called Show Serial Numbers Select the Accessibility requirement... Click the Save button. Select Tools > Options from the menu. Enter admin as the user ID. Select the user guest...
Italics
Text to be typed in Sample User names
C h a pt er 1 : T ut or i al C on ve n ti o ns
2 U s e r T u to ri a l
Chapter
2
Chapter 2
Introduction
Overview
Requirements management is the process of establishing a common understanding of application requirements. It involves managing and communicating changes to those requirements throughout the development cycle to ensure that the application or system will meet end-user needs. Borlands approach to enterprise requirements management is fundamentally different from the tools currently on the market. This product promotes the definition and management of requirements in a repository-based system, producing documents as an end result of the requirements process. This approach helps project teams track relationships between requirements and evaluate the impact of requirement changes more effectively than in a document-centric approach. Clients are liberated from having to manage versions of a document and are able to manage the requirements and generate documents when needed. This brings a new level of sophistication to requirements management, giving project teams the ability to see all of the relationships and impacts of requirement changes. Because the application is built on a commercially available, object-oriented database, it supports a collaborative, enterprise-scalable approach to development. This is a powerful requirements management system that allows project teams to deliver higher quality applications that meet end-user specifications. It enables teams to fully define, manage and communicate changing requirements. Changes to requirement data such as traceability, status, priority and more are recorded and stored in CaliberRMs central repository, providing reliable, up-to-date information for effective requirements-driven development and testing.
Tutorial Objective
The purpose of this tutorial is to guide you through the steps required to create projects, requirements, requirement types, attributes, baselines, users and groups. The Basic Tutorial (Chapter 4) and Advanced Tutorial (Chapter 5) chapters guide you through creating a requirement and requirement maintenance using the Automated Teller Machine project installed with your sample database.
C ha p te r 2 : In tr od u ct io n
The Administrator Tutorial (Chapter 6) guides you through creating requirement types and user-defined attributes. The CaliberRM Administrator Tutorial (Chapter 7) guides you through creating projects, users and groups. Chapter 8 details baselines and baseline maintenance. Chapter 9 gives you an overview of the group discussion and change history features associated with requirements. Chapter 10 gives you an overview of reports and guides you through creating a document using the Document Factory.
StarTeam Toolbar
The StarTeam Toolbar (referred to later as simply the Toolbar) is a component of the certain Borland products that enables you to log on using only one login. It makes it easier for you to log on to multiple servers and launch different programs from a single location. The Toolbar is automatically populated with shortcuts for the tools of the Borland products that are installed on your workstation. Because the Toolbar uses the standard Windows program shortcut feature, you can easily add any other program as a tool for quick launch. The Toolbar enables you to:
Specify which portions of its user interface are visible (none, system tray only, window only, or system tray and window). Cache the user name and password used to log on to each server, making it easier for you to log on to multiple servers, and reducing the number of times you must log on to the same server to perform certain operations. (There is even an option for using the same user name and password for each server, so you do not have to log on to other servers where that user name and password is valid.) View the cached server/user associations. Add program shortcuts as tools on the Toolbar, so you can easily locate and start those tools. (You can also modify or delete an existing tool.) Display the Toolbars help information or version information.
When you launch a component of the application, the Toolbar icon is displayed in the system tray. When you right-click the icon, a pop-up menu is displayed. Click Open to open the main Toolbar window. Click a component name to launch the program. Click About to view details about the Toolbar. Click Exit to exit the Toolbar.
Toolbar Options
Display systray icon: Determines if the Toolbar icon is displayed in the system tray. A check in the box indicates the feature is enabled. Display expanded Toolbar at startup: Displays the full Toolbar window on startup. A check in the box indicates the feature is enabled.
Hide from taskbar when minimized: Determines whether the Toolbar icon is displayed in the taskbar when the Toolbar is minimized. A check in the box indicates the feature is enabled. Use same username/password for each server: Enables the Toolbar to use the same username and password for each component. A check in the box indicates the feature is enabled. Server List: This displays all of the servers that are cached by the Toolbar. For each server, the product icon, Server Type, Host Name, Port, and User Name are displayed.
Adding a Tool Shortcut

Note: The Toolbar uses the standard Windows shortcut wizard for adding tool shortcuts. Therefore, if someone other than yourself logs in using his/her Windows username and installs the product, the first time you log in using your username, you may not see any shortcuts on the Toolbar. You must add the application, its components and shortcuts using the following method. You can add various tool shortcuts for single login use. To add a tool shortcut on the menu:
1 Right-click on the toolbar. 2 Select Add Tool from the pop-up menu.
The Windows Shortcut Wizard is launched.

3 Enter the location of the executable you want a shortcut for, or click the Browse button to navigate to it. 4 Click Next. The Select a Title for the Program screen is displayed. 5 Enter a name for the shortcut and click Finish. 6 Right-click on the toolbar and select Refresh Tools.
The icon now appears in the toolbar and can be launched from the Toolbar.
Modifying a Tool Shortcut

To modify a shortcut file:
1 Right-click on the tool icon of the shortcut you want to modify. 2 Select Modify Tool. The Shortcut properties window is displayed. 3 Make changes as necessary and click OK. 4 Right-click on the toolbar and select Refresh Tools. The changes are applied.
Deleting a Tool Shortcut

To delete a shortcut:
1 Right-click on the tool icon of the shortcut you want to delete. 2 Select Delete Tool. The shortcut is deleted.
C ha p te r 2 : In tr od u ct io n
Chapter
3
Chapter 3
Getting Started
Overview
Before users can create requirements, an administrative user must first create a project in the CaliberRM Administrator, and create requirement types in the requirements manager. When you installed the product, if you installed a sample database, a project, users, groups and requirement types are already created for you to use for this tutorial.
Important!
To perform the lessons in this tutorial, you must have the Automated Teller Machine Sample database installed. If you do not, please re-install the server to include the sample database and re-install the client with the sample database. Before beginning these tutorials, log on to the CaliberRM Administrator and modify an existing user account to contain your information.
Logging On to the CaliberRM Administrator

To log on to the CaliberRM Administrator:
1 Select Start > Programs > Borland CaliberRM > Administration > Administrator from the Windows Start menu. 2 Enter the following information in the fields specified:
Field
Server
Data to Enter
Your computer name (or you can enter localhost) admin
Notes
If you are unsure of your computers name, select Start > Settings > Control Panel from the Windows Start menu, open the System applet and look on the Computer Name tab. The user and password fields are case sensitive, so be sure to use all lowercase characters. This is the default password for the admin user.
User
Password
admin
3 Click Logon. The CaliberRM Administrator verifies the userid and password and logs you on to the system.
C ha p te r 3 : G e tti n g S ta r te d
4 Select View> Users from the menu. The User View is displayed. Notice the user named guest. This is the user that you will modify to contain your information. 5 Select the guest user in the user list. 6 Enter the following information in the fields specified:
Field
Userid First Name Last Name Title Phone Fax Email
Data to Enter
Your first initial and last name Your first name Your last name Your title Your phone number Your fax number Your e-mail address
Notes
This field is case-sensitive.
This is the e-mail address where automatic notifications of the changes that are made to requirements are sent.
7 Select the Group Membership tab. 8 From the Not member of list, select the Administrators group and click the Add button. 9 Select the Security tab. 10 Select the CaliberRM in the Authentication type and in the CaliberRM Credentials fields, type a new password.
Note: Initially, the password is blank. The asterisks appear for security reasons only.
11 Select the Password Never Expires check box. 12 Select the User Can Perform Baseline Administration check box. 13 Select File > Save Changes from the menu.
Now that you have modified your user account in the CaliberRM Administrator, select File > Exit and Log Off from the menu to close the CaliberRM Administrator and log off of the system. You can then log on using your new account to perform the tutorials in the following chapters.
Logging On to CaliberRM
To log on:
1 Select Start > Programs > Borland CaliberRM > CaliberRM from the Windows Start menu. 2 Enter the information in the fields specified:
Field
Server
Data to Enter
Your computer name (or you can enter localhost)
Notes
If you are unsure of your computers name, select Start > Control Panel from the Windows Start menu, double-click the Network icon and look on the Identification tab. The user and password fields are case sensitive, so be sure to use all lowercase characters. This is the password you created in the steps above.
User Password
Your user name Your password
3 Click Logon. The userid and password is verified and you are logged on to the system.
User Interface
The user interface displays the requirement tree on the left side of the screen. This list contains the project name and a hierarchical list showing all requirement types and requirements. Multiple requirement types for each project are supported. For information on creating Requirement Types, See Creating a Requirement Type on page 21. When the project is selected in the list, there are two tabs in the right pane, Project Info and Discussion. The Project Info tab allows you to enable or disable security and shared requirements, and displays the project description. For the Automated Teller Machine (ATM) project, security is disabled by default to allow you to add, modify and delete requirements as needed for the tutorials. For more information on security, see the CaliberRM User Guide. The projects Discussion tab allows you to post and/or reply to project level discussions. When a requirement type is selected in the list, the right side of the screen displays three tabs:

Description: a read-only description of the requirement type. Custom Tabs: a read-only list of the custom tabs assigned to the requirement type, and the user-defined attributes assigned to the selected custom tab. Summary: an editable text field that describes the requirement type for the project you have open.
Note: You must have administrator privileges to edit the Summary tab text. When a requirement is selected in the requirement list, tabs in the right pane contain different attributes for the selected requirement. These tabs are explained in more detail in the following chapters.
Displaying Requirement Numbers

Each requirement within a project has two different numbers associated with it. One is the hierarchical number, which is determined by the requirements placement within the project tree or hierarchy. The hierarchical number changes as requirements are added, moved or deleted. The other number associated with each requirement is its unique serial (or ID) number. The serial number does not change, regardless of the requirements position, and it is not reused if the requirement is deleted. To display the requirement hierarchical numbers, first expand the requirements in the list by clicking the plus sign (+) to the left of the requirement type and requirement names. Then select View > Hierarchical from the menu. The hierarchical numbers are displayed in the requirement list. When you display serial numbers for requirements, the tag assigned to each requirement type is displayed as well. For example, the Business Requirements requirement type may have the tag BR. Each requirement within the Business Requirements requirement type has the BR tag displayed as a prefix for the serial number. To display the requirement serial numbers, select View > Serial from the menu. The serial numbers are displayed in the requirement list.
C ha p te r 3 : G e tti n g S ta r te d
10 U s e r T u to r ia l
Chapter
4
Chapter 4
Basic Tutorial
Overview
The lessons in this chapter guide you through the basic steps required to create a requirement, as well as show you how to copy, modify, move and delete requirements. The Advanced Tutorial builds upon these lessons.
Creating a Requirement
There are three basic steps to creating a requirement: defining requirement information, assigning attribute values and assigning users and groups. Additionally, there are three advanced steps: linking reference documents, creating traceability links and defining the validation procedure. The advanced steps are covered in Chapter 4: CaliberRM Advanced Tutorial.
Step 1: Defining Requirement Information

When you create a requirement, you have four options for the placement of the new requirement on the Requirement > Create Requirement menu. The menu option you select determines the placement:
Create Requirement
Child: Creates a new requirement as a child of the currently selected requirement. Above: Creates a new requirement at the same hierarchical level and before the currently selected requirement. Below: Creates a new requirement at the same hierarchical level and after the currently selected requirement. Drag-and-Drop: Creates a new requirement anywhere in the tree (that you have permission to create requirements) by allowing you to drop the requirement in place.
You can move a requirement to another location after it is defined and saved. You can also copy an existing requirement. See Copying a Requirement on page 13.
C h a p te r 4 : Ba s i c T u to ri a l
11
To create a requirement and define the requirement information:

1 Open the Automated Teller Machine project and expand the Business Requirements requirement type by clicking the plus sign (+) to the left of the requirement type name. 2 Within the Business Requirements requirement type, select the Accessibility requirement by clicking on the requirement name. 3 Select Requirement > Create Requirement > Below from the menu. The new requirement is created. 4 Select the Details tab if it is not already selected. 5 Enter the following information in the fields specified:
Field
Requirement name Owner Status Priority Description
Data to Enter
Balance Transaction Leave at default Leave at default Essential ATMs shall allow balance transactions. Customers will be able to obtain current balance information on their checking, savings and money market accounts from the ATMs.
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.
6 After you have entered the text, select the word current. 7 Click the Palette button from the toolbar. The Color dialog box is displayed. 8 Select a color and click OK.
Note: You can also change the font size, style and effects of the requirement description text using the options in the Format menu on the toolbar.
9 Select Requirement > Save Changes from the menu to save your requirement.
The first time you save a requirement, that requirement is entered into CaliberRM. Each time you make changes to the requirement and save it, you may be prompted to enter a comment about the change. This comment is then stored in the change history. You can turn this comment option on or off, either through Tools > Options or within the Comment dialog box itself by selecting the Do not show this dialog box again check box. For these tutorials, however, we want to enter comments.
Step 2: Assigning Attribute Values to a Requirement

There can be user-defined attributes associated with each requirement type. These attributes help fully define the requirement since they allow users to determine what data should be tracked and stored. User-defined attributes can be one of 13 types of data, including text, long integer, date, boolean, users, groups and selection lists. Once created, user-defined attributes are assigned to custom tabs for each requirement type, allowing users to track only the information needed for each type of requirement. For instructions on creating user-defined attributes, See Creating a User-Defined Attribute on page 23. In the Automated Teller Machine project, the attributes Owner Priority, Sponsor Name, Source, Funded, Risk, Notes and Due Date are assigned to the User Attributes tab for the Business Requirements requirement type. To assign attribute values to a requirement:
1 Select the Balance Transactions requirement you created earlier in the tutorial. 2 Click the User Attributes tab. The tab displays the user-defined attributes assigned to this tab.
Note: When a requirement is being modified, the list displays a lock icon meaning that the requirement cannot be modified by anyone else simultaneously.
3 Enter the following information in the fields specified:
Field
Owner Priority Sponsor Name Source Funded Notes Due Date
Data to Enter
Leave at default (High) Bank ABC John Doe No (leave check box blank) 12/31/2010
4 Save your changes by selecting Requirement > Save Changes from the main menu. 5 When the Enter a Comment dialog box is displayed, enter the comment Set User Attributes for the change and click OK.
Step 3: Assigning Users and Groups to a Requirement

When requirements are changed, the people assigned to it must be notified to keep development on track. For this reason, you can assign individuals to each requirement. Typically, several individuals may be assigned to each requirement. For example, the business analyst who created the requirement may be assigned, as well as a developer, tester and manager. To assign users to a requirement:
1 Select the Balance Transaction requirement you created earlier in the tutorial. 2 Click the Responsibilities tab. 3 Expand the Development group from the Project Groups and Members section by clicking the plus sign (+) to the left of the group.
Note: The lists are limited by the group membership assigned for the project in the CaliberRM Administrator.
4 Select the user Gale Jones from the list by clicking the check box to the left of the user name.
Once a user is assigned, s/he will receive notification that person of specific events, as defined in the CaliberRM Administrator. A darkened checkbox indicates that at least one member of that group has been selected.
5 Repeat steps 3-4 to assign the user ddeveloper to the Quality group. 6 Select Requirement > Save Changes from the menu to save your changes. 7 When the Comment dialog box is displayed, enter the comment Assigned additional development resources for the change and click OK.
Copying a Requirement
To copy an existing requirement:
13
1 Select the Balance Transaction requirement. 2 Select Edit > Copy from the menu. 3 Select the Receipt requirement. 4 Select Edit > Paste from the menu to paste the Balance Transaction requirement as a child requirement of the Receipt requirement.
Note: If a copied requirement has child requirements, you are asked if you want to paste the child requirements as well. The requirement is copied. The new requirement has a different serial number than the original requirement, but the same name. You can now move on to modify the new Balance Transaction requirement. The original Balance Transaction requirement will not change.
Modifying a Requirement
To modify a requirement:
1 Select the copied Balance Transaction requirement that is a child of the Receipt requirement. 2 Click the Details tab. 3 In the Requirement Name field, change the requirement name to Balance Receipt. 4 On the User Attributes tab, change the Owner Priority attribute to Highest. 5 Select Requirement > Save Changes from the menu to save your changes. 6 When the Comment dialog box is displayed, enter the comment Created requirement and set Owner Priority to Highest and click OK.
Changing the Requirement Order

You can change the requirement order in one of three ways: using the commands in the Requirement menu, using the buttons on the toolbar, or by dragging and dropping the requirements. Using the commands in the Requirement menu, or the buttons on the toolbar, you may move requirements only within the parent. You cannot change the hierarchical level of requirements using the toolbar buttons, nor can you move a requirement to another requirement type. Using drag and drop, you can move a requirement anywhere you want, even to another requirement type. Note: When moving requirements to another requirement type, only user-defined attributes that are common to both requirement types retain their values.
1 Select the Balance Transaction requirement and select Requirement > Move Up from the menu. This moves the Balance Transaction requirement above the Accessibility requirement. 2 Select the Balance Transaction requirement and select Requirement > Move down from the menu. This moves the Balance Transaction requirement back to its original position. 3 Now select the Balance Receipt requirement by clicking and holding the left mouse button. 4 Drag the requirement down one level, drag it on top of the Standalone Operation requirement. This makes the Balance Receipt requirement a child of the Standalone Operation requirement.
5 When the requirement is in the location you want it, release the left mouse button. The requirement is moved and the hierarchical numbers are automatically updated.
15
Chapter
5
Chapter 5
Advanced Tutorial
Overview
You can perform three advanced steps when creating or modifying a requirement: linking reference documents, creating traceability links and defining the validation procedure. These steps help you further define requirements by linking them to reference documents and other requirements, and allow you to define a validation procedure for testing. This chapter guides you through these advanced steps.
Linking a Reference Document

You can link reference documents to a requirement for additional information. For example, you might link a prototype screen or a document with additional information so developers and others can better understand the requirement. All file types with an associated application are accepted, such as Word, Excel, graphics files, HTML files, audio and video files, etc. You can also enter a text reference, so you can reference a book, periodical, or anything that is not online. To link a reference document to a requirement:
1 Select the Balance Transaction requirement you created in the Basic Tutorial. 2 Click the References tab. 3 Click the New File button. The Add Reference Files dialog box is displayed. 4 Navigate to the c:\Program Files\Borland\CaliberRM\Samples directory. This is the default references directory.
Note: If you selected a directory other than the default during the client installation, navigate to the samples folder in that directory instead.
5 Select the Federal Guidelines for ATM Machines.doc file. 6 Click the Add button to add the file to the reference list. 7 Select Requirement > Save Changes from the menu to save your changes. 8 When the Comment dialog box is displayed, enter the comment Linked reference documents for the change and click OK.
C ha p te r 5 : A d v a n c e d T u to ri a l
17
Note: If you want other users to be able to access reference documents, use either a URL (for items such as a team site page or a hyperlink to a StarTeam file) or UNC notation for a file located on a shared drive. See CaliberRM Help for more information.
Creating a Traceability Link

Requirement traceability is supported to allow you to see relationships between requirements and other related development and testing information. Requirements can link from or to any other requirement within the same project and across projects. Requirements can also trace to tests within Borland SilkCentral or Mercury Interactive Quality Center, Borland Together design elements, and other software artifacts and Software Configuration Management (SCM) tools. As a result, not only are traceability relationships tracked, but also changes to requirements to show what other entities are affected by the change. For more information about each of these objects, refer to Traceability topic in the CaliberRM User Guide. To create a traceability link:
1 Select the Balance Transaction requirement. 2 Click the Traceability tab. 3 Click the Modify button. The Traceability Modification dialog box is displayed. 4 Expand the Functional Requirements requirement type and navigate to the Account Balance requirement and select the requirement from the list.
Note: Right-click a requirement and select Properties to view requirement properties.

5 Click the Trace To button to create a link from the Balance Transaction requirement to the Account Balance requirement.
Note: You can also drag the Account Balance requirement to the Trace To list on the Traceability tab to create the link.
6 Click the Close button to close the Traceability Modification dialog box. 7 Select Requirement > Save Changes from the menu to save your changes. 8 When the Comment dialog box is displayed, enter the comment Linked to Account Balance requirement for the change and click OK.
Traceability Matrix
You can use the Tools menu, or click the Traceability Matrix button on the toolbar to access the Traceability Matrix. It is used to display all of the traceability links in one view. Each requirement is listed in rows along the left side of the matrix, and again in columns along the top edge of the matrix. You can add or delete traceability links in the matrix, as well as on the Traceability tab for each requirement. You can filter the display to show only specific requirement types or all requirement types. You can also filter to show only column-to-row links, only row-to-column links, implied links, no links or all links. In addition, you can show traceability between requirements and related development and testing entities and Software Configuration Management (SCM) objects. Once you have modified the Traceability Matrix to see the requirements you want, you can save the view and print a report of the data selected. For more information about the Traceability Matrix, see Traceability in the CaliberRM User Guide.
Defining Requirement Validation

When you create a requirement, it is often helpful for testers to know how to verify that the requirement is implemented properly. Therefore, you can enter in a validation procedure for each requirement if you want. The validation procedure is free form, meaning that the procedure can be in any form you want, from a paragraph to a numbered list of steps. To define the requirement validation procedure:
1 Select the Balance Transaction requirement. 2 Click the Validation tab. 3 Enter the text Select Balance Transaction; expect to see choices for checking, savings and money market accounts; upon making a selection, verify balance matches ledger as the Validation procedure. 4 Select Requirement > Save Changes from the menu to save your changes. 5 When the Comment dialog box is displayed, enter the comment Added validation procedure for the change and click OK.
C ha p te r 5 : A d v a n c e d T u to ri a l
19
Chapter
6
Chapter 6
Administrator Tutorial
Overview
Before users can begin entering requirements in a new project, a user with administrative privileges must perform some administrative tasks. These tasks include creating requirement types and assigning requirement types to projects. You can also create user-defined attributes, modify system attributes, and assign user-defined attributes to requirement types. These administrative tasks help users organize requirements by purpose and enable users to define requirements more completely. This Administrator Tutorial guides you through the steps required to create requirement types and attributes.
Requirement Types
Requirement types are high-level groups of requirements, typically classified by their function (i.e. Business, Marketing, GUI, Hardware, Software, Testing, etc.) CaliberRM supports multiple requirement types to allow you to organize your requirements more easily. Requirement types are defined globally and are available for use in all projects. Each requirement type can be customized through custom tabs and user-defined attributes, allowing you to track only the information you need for each requirement type. Tabs also can be hidden for requirement types, allowing you to hide tabs containing unnecessary information. There are two ways to create requirement types: through the Requirement Type Creation Wizard or using Expert Mode. Expert Mode uses the dialog boxes to create requirement types and is for those who are familiar with defining requirement type information. This tutorial guides you through steps required to create a requirement type using the wizard.
Creating a Requirement Type

There are seven steps to creating a requirement type through the Requirement Type Creation Wizard. The wizard launches automatically when you create a new requirement type.
C h a p te r 6: A dm in i s tr a to r T u to ri a l
21
Note: The Requirement Type Creation Wizard launches only if the wizard option is selected in the Options menu on the Wizards tab. The option is selected by default when you install CaliberRM. To create a requirement type using the Requirement Type Creation Wizard:
1 Select File > Admin > Requirement Types from the menu. The Requirement Types dialog box is displayed. 2 Click the New button. Step 1 of the Requirement Type Creation Wizard is displayed. 3 Enter Non-Functional Requirements as the name of the requirement type. 4 Enter the tag NFR for the requirement type. The tag is used as a prefix for the requirement ID number and helps identify requirement types in the Requirement Grid. 5 Click the Next button. Step 2 of the Requirement Type Creation Wizard is displayed. 6 Enter the description These requirements will constitute the non-functional requirements for the requirement type. 7 Click the Next button. Step 3 of the Requirement Type Creation Wizard is displayed. 8 Click the New button to create a new custom tab. The New Custom Tab dialog box is displayed. 9 Enter Estimates as the custom tab name. 10 Select the Expected Effort, High Effort and Low Effort user-defined attributes in the Available list. Use the Ctrl key to select multiple attributes. 11 Click the Move Left button to add the attributes to the Selected list. A message box is displayed to warn you that adding and deleting attributes can be a labor-intensive process that should not be performed while others are on the system. 12 Click Yes to continue.
The attributes are added to the Selected list in alphabetical order.

13 Use the Move Up and Move Down buttons to change the attribute order to: High Effort, Expected Effort, Low Effort. 14 Click the OK button to save the new custom tab. You are returned to Step 3 of the Requirement Type Creation Wizard. 15 Click Next. Step 4 of the Requirement Type Creation Wizard is displayed. 16 Select the last option button for the Create default access level, so other users can create requirements of this type. You can then modify the access level in other security profiles to limit the access if needed. See Security Profiles in the CaliberRM User Guide for more information on security. 17 Click Next. Step 5 of the Requirement Type Creation Wizard is displayed. 18 Select the Owned delete level so other users can only delete requirements of this type if they are the owner. 19 Click Next. Step 6 of the Requirement Type Creation Wizard is displayed. 20 For each attribute listed except Requirement Discussion, keep the Owned default modification level, so other users can only modify those attributes if they own the requirement. For the Requirement Discussion attribute, leave the value at Any, so anyone can enter discussion messages. 21 Click Next. Step 7 of the Requirement Type Creation Wizard is displayed.
Notice that the new requirement type is assigned to the open project by default.
22 Click Next. The New Type Information dialog box is displayed. 23 Verify that the information you have entered is correct and click Finish.
Note: To change information, click Back.

24 Click Close in the Requirement Types dialog box.
The requirement type is created and displayed within the Automated Teller Machine project. You can now create non-functional requirements within the project. To modify or delete a requirement type, you can select it in the Requirement Types dialog box and click the Edit or Delete button.
Attributes
Attributes are characteristics that help define a requirement. Both system and userdefined attributes are supported. The system attributes that are stored for each requirement are Priority and Status. You can configure the list of values for these system attributes, so you can use the terms that best fit your organizations needs. In addition to system attributes, you can define an unlimited number of user-defined attributes and assign those attributes to requirement types. User-defined attributes can be one of 13 different types of data, including text, long integer, date, boolean and users.
User-Defined Attributes
Each user-defined attribute contains several standard options that can be set, as well as options defined by the attribute type. The standard options that can be set are:
Increment major revision number: Increments the major revision number in the requirements change history when a change is made to this attribute. Make requirement traceability links suspect: Changes all traceability links for the requirement to suspect links when a change is made to this attribute. Initial value: Determines the source of the attributes initial value: inherit from the parent requirement, use default value specified, or force user to enter a value.
User-defined attributes can be one of 13 different types of data:

Boolean Date Duration Float Long Integer Multiple selection list Multiple selection group list
Multiple selection user list Multiple line text field Single selection list Single text line Single selection group list Single selection user list
There are two ways to create user-defined attributes: through the Attribute Creation Wizard or using Expert Mode. Expert Mode uses the dialog boxes to create attributes and is for those who are familiar with defining attribute information. This tutorial guides you through the steps required to create a user-defined attribute using the wizard.
Creating a User-Defined Attribute

There are five steps to creating an attribute through the Attribute Creation Wizard. The wizard launches automatically when you create a new user-defined attribute.
23
Note: The Attribute Creation Wizard launches only if the wizard option is selected from the CaliberRM Options menu on the Wizards tab. To create a user-defined attribute using the Attribute Creation Wizard:
1 Select File > Admin > User-Defined Attributes from the menu. The User-Defined Attributes dialog box is displayed. 2 Click the New button. Step 1 of the Attribute Creation Wizard is displayed. 3 Enter the name Business Need for the attribute. 4 Select the Single Selection List type for the attribute. 5 Enter the description The level of business need for the attribute. 6 Click Next. Step 2 of the Attribute Creation Wizard is displayed. 7 Click in the top of the List Box Contents box and type the name Standard for the first list item.
Note: To rename a list item, select it the list and type in a new name.
8 Use the Insert Before and Insert After buttons to enter two list items named Optional and Critical. Add Critical before Standard, and Optional after Standard.
Note: To arrange the list items, select an item and click the Move Up or Move Down button. To delete an item, select it and click the Delete button.
9 Select the Standard list item in the Default Selection drop-down list to make it the default list item. 10 Click Next. Step 3 of the Attribute Creation Wizard is displayed. 11 Choose the Inherit the value from the requirements parent option for obtaining the attributes initial value. 12 Click Next. Step 4 of the Attribute Creation Wizard is displayed. 13 Select the Increment the major revision number in the change history check box. 14 Select the Make requirements traceability links suspect check box. 15 Click Next. Step 5 of the Attribute Creation Wizard is displayed. 16 For each requirement type, keep the Owned modification level so users can only modify the attribute if they own the requirement. This sets the default security for this attribute. 17 Click the Next button. The New Attribute Information dialog box is displayed. 18 Verify that the information you have entered is correct and click Finish.
Note: To change information, click the Back button.

19 Click Close in the User-Defined Attributes dialog box.
Once you have created a new user-defined attribute, you must assign it to a custom tab in requirement type.
Assigning User-Defined Attributes to a Requirement Type

To assign user-defined attributes to a requirement type:
1 Select File > Admin > Requirement Types from the menu. The Requirement Types dialog box is displayed. 2 Select the Business Requirements requirement type. 3 Click the Edit button. The requirement types dialog box is displayed.
4 In the Custom Tabs section, select User Attributes and click the Edit button. The Edit Custom Tab dialog box is displayed. 5 Select the Business Need attribute from the Available list and click the Move Left button to move it to the Selected list. A warning is displayed informing you that adding a user-defined attribute is a labor-intensive process. 6 Click Yes to continue. 7 Click OK to save changes to the custom tab. 8 Click OK in the selected requirement types dialog box.
The attribute is assigned to the requirement type. You can now view a Business Requirements requirement in the Automated Teller Machine project to see the new attribute listed on the User Attributes tab. To modify or delete a user-defined attribute, select it in the User-Defined Attributes dialog box and click the Edit or Delete button.
Summary
Now that you know how to create requirement types, attributes and requirements within CaliberRM, practice adding requirements of your own in the Non-Functional Requirements requirement type. When you have finished adding, modifying and deleting requirements within CaliberRM, select File > Exit and Log Off from the menu to close it.
25
Chapter
7
Chapter 7
CaliberRM Administrator Tutorial
Overview
The CaliberRM Administrator controls administrative functions, including creating and modifying users, groups and projects, administering security and setting up automatic e-mail notification. In the previous tutorials, we used a sample project, allowing you to start entering requirements immediately. In this tutorial, you will learn how to create projects, users and groups of your own. To complete the CaliberRM Administrator tutorial, you need to log in as the admin user.
Logging On
To log on to the CaliberRM Administrator:
1 Select Start > Programs > Borland CaliberRM > Administration > Administrator from the Windows Start menu. 2 Enter the following information in the fields specified:
Field
Host
Data to Enter
Your computer name (can enter localhost)
Notes
If you are unsure of your computers name, select Start > Control Panel from the Windows Start menu, double-click the Network icon and look on the Identification tab. The user and password fields are case sensitive, so be sure to use all lowercase characters. This is the default password for the admin user.
User Password
admin admin
3 Click Logon. The CaliberRM Administrator verifies the userid and password and logs you on to the system.
The CaliberRM Administrator contains three views, each of which allows you to perform specific tasks. The views available are Project, User and Group.
C h ap te r 7 : C al i be r R M A dm in i s tr a to r T u to ri a l
27
Projects
A project is defined as any application or system under development. Before you can create requirements, you must first create a project in the CaliberRM Administrator. After creating a project, you can modify or delete that project at any time. There are two ways to create a project: through the Project Creation Wizard or using Expert Mode. Expert Mode uses dialog boxes and is for users who are familiar with project definition. This tutorial guides you through the steps required to create a project using the wizard. The Project View in the CaliberRM Administrator also contains a Project Baselines tab, that allows you to create baselines, and a Project Integrations tab, that allows you to set up the integrations with Borland SilkCentral Test Manager, Borland Together, Borland StarTeam, Mercury Quality Center, Select Enterprise, and Software Configuration Management (SCM) tools. For more information on enabling integrations, see Enabling Project Traceability in the CaliberRM User Guide.
Creating a Project
There are four steps to creating a project through the Project Creation Wizard. The wizard launches automatically when you create a new project. Note: The Project Creation Wizard launches only if the wizard option is selected from the Options menu on the Wizards tab. That option is selected by default. To create a project using the Project Creation Wizard:
1 Select File > New Project from the menu. Step 1 of the Project Creation Wizard is displayed. 2 Enter ATM Maintenance as the name for the project. 3 Click Next. Step 2 of the Project Creation Wizard is displayed. 4 Enter the description This project contains requirements for a maintenance software program designed for automated teller machines for the project. 5 Click Next. Step 3 of the Project Creation Wizard is displayed. 6 Select the box to the left of the Administrators, Development, Quality Assurance and Design groups to assign them to the project. 7 Click Next. Step 4 of the Project Creation Wizard is displayed. 8 Select the glossary Company Terms from the Available list. 9 Click the Move Left button to move the glossary to the Selected list. 10 Click Next. The New Project Information dialog box is displayed. 11 Verify that the information you have entered is correct and click Finish.
Note: To change information entered, click Back. The project is created.
Departments
When you create a user, you can specify the department to which the user is assigned. You may add, modify or delete departments as needed, either from within the User View, on the User Info tab or from the File menu at any time. Note: Departments are used for information purposes only, and are not the same as user groups, although they may have the same name. Use of this feature is optional.
Creating a Department
To create a department:
1 Select File > Admin > Departments from the menu. The Departments dialog box is displayed. 2 Click the New button. The Create New Department dialog box is displayed. 3 Enter QA as the department name and This is the Quality Assurance department for the description. 4 Click OK. 5 When you have finished, click Close to exit the Departments dialog box.
Glossaries
You can have multiple glossaries that allow you to define terms that are specific to your organizations projects. These glossaries are created by an administrator in the CaliberRM Administrator. Administrators create, define, delete and modify terms. Defined terms are automatically converted to color-coded hyperlinks in the requirement description as they are typed.
Creating a Glossary
To create a new glossary:
1 Select File > Admin > Glossaries from the menu. The Glossaries dialog box is displayed. 2 Click New. The Glossary dialog box is displayed. 3 Enter the name Banking Terms for the new glossary. 4 Select a color for the glossary terms. Defined terms are automatically color-coded in the requirement description as they are typed. 5 Click the New Term button. The Enter New Glossary Term dialog box is displayed. 6 Enter the term transaction and its definition any exchange of information between the customer and said bank. 7 Click OK. The term and its definition are displayed in the Glossary dialog box. 8 Click Close.
Note: You can also add a term by right-clicking a word in a requirement description.
9 Click OK to close the Glossary dialog box.
The glossary is created and added to the Glossaries tab. You can also import an existing glossary to create a new glossary.
Assigning a Glossary to a Project

Once you create a glossary, you can assign it to a project. To assign a glossary to a project:
1 Select the Glossaries tab. The tab displays a list of all of the selected (assigned) and available glossaries. 2 Select the glossary Banking Terms from the Available list.
29
Note: Use the Shift key to select a range of glossaries, or the Ctrl key to select multiple glossaries individually.
3 Click the Move Left button to move the glossary to the Selected list.
Note: You can assign all the glossaries in the Available list to the Selected list by clicking the Move All Left button.
4 You may arrange the order of the glossaries by using the Move Up and Move Down buttons. The order of the list determines the order in which CaliberRM searches the glossaries, and the color order that is displayed when there are identical terms in multiple glossaries. 5 Select File > Save Changes from the menu to save the project.
The glossary is assigned to the project.
Groups
Groups are collections of users with similar responsibilities (i.e. Managers, Developers, Engineers, Marketing, etc.). Group information includes contact information for each group and group members. There are two ways to create a group: using the Group Creation Wizard or using Expert Mode. Expert Mode uses dialog boxes and is for users who are familiar with defining group information. This tutorial guides you through the steps required to create a group using the wizard.
Creating a Group
There are four steps to creating a group using the Group Creation Wizard. The wizard launches automatically when you create a new group. Note: The Group Creation Wizard launches only if the wizard option is selected from the CaliberRM Options menu on the Wizards tab. To create a group using the Group Creation Wizard:
1 Select File > New Group from the menu. Step 1 of the Group Creation Wizard is displayed. 2 Enter the name Consultants for the group. 3 Enter consultants@nowhere.com as the e-mail address for the group. 4 Click Next. Step 2 of the Group Creation Wizard is displayed. 5 Enter the description Made up of consultants and advisors for the group. 6 Click Next. Step 3 of the Group Creation Wizard is displayed. 7 Assign the users Amy Analyst and Betty Smith to the group, as well the user you created for yourself earlier in Chapter 2: Getting Started, by selecting the users in the Not Selected list and clicking the Add button. 8 Click Next. Step 4 of the Group Creation Wizard is displayed. 9 Assign the group to the Automated Teller Machine project by selecting the project in the Not Selected list and clicking the Add button. 10 Click Next. The New Group Information dialog box is displayed. 11 Verify that the information you have entered is correct, and click Finish.
Note: To change information entered, click Back. The group is created and assigned to the project. All of the users assigned to the group are also assigned to the project. You can now assign a security profile to the group for
the project if you want. See the Security chapter in the CaliberRM User Guide for more detailed information about security.
Users
A user is any person who has access to and uses the CaliberRM system. Users can be developers, managers, testers, CEOs and others. User information includes contact information for each user, including an e-mail address used for automatic notification. Users are placed in one or more groups and assigned to projects and requirements. Users and groups are defined once for all projects, and are then filtered at the project and requirement levels as needed. There are two ways to create a user: using the User Creation Wizard or using Expert Mode. Expert Mode uses dialog boxes and is for users who are familiar with defining user information. This tutorial guides you through the steps required to create a user using the wizard.
Creating a User
There are six steps to creating a user using the User Creation Wizard. The wizard launches automatically when you create a new user. Note: The User Creation Wizard launches only if the wizard option is selected from the CaliberRM Options menu on the Wizards tab. To create a user using the User Creation Wizard:
1 Select File > New User from the menu. Step 1 of the User Creation Wizard is displayed. 2 Enter the ID jdoe for the user. 3 Enter John as the users first name and Doe as his last name. 4 Enter Senior Consultant as his title. 5 Click Next. Step 2 of the User Creation Wizard is displayed. 6 Enter any phone, fax, pager and location information that you want. 7 Enter jdoe@nowhere.com as the users e-mail address. 8 Click Next. Step 3 of the User Creation Wizard is displayed. 9 Select the groups Consultants and Guests in the Not a member of list and click the Add button to assign the user to the groups. 10 Click Next. Step 4 of the User Creation Wizard is displayed. 11 Enter a password for the user and retype it for verification.
Note: If you assign and attempt to save a password that is not consistent with the Password Policy, you will get an error message. For more information on password policies, see Creating Users in the CaliberRM User Guide.
12 Choose the Password Never Expires allowing the user to have a password that never expires. 13 Click Next. Step 5 of the User Creation Wizard is displayed. 14 Select the CaliberRM option button to use standard CaliberRM licensing. For more information on license management, see Licensing in the CaliberRM User Guide. 15 Click Next. The New User Information dialog box is displayed. 16 Verify that the information you have entered is correct and click Finish.
31
Note: To change information entered, click Back. The user is created. Once you have created a new user, you must update the users license status before he/she can login. To do this, select File > Admin > License Management. Locate the user in the User ID column, and select an option for the user: Named User, Concurrent or Not Authorized. Perform these steps for each product the user needs access to. For more information on license management, see Licensing in the CaliberRM User Guide.
Summary
You have now completed the CaliberRM Administrator tutorial. You should be able to create projects, users, groups, requirement types, attributes and requirements. You may now continue to the following tutorials to learn more advanced functions of the tool.
Chapter
8
Chapter 8
Baseline Maintenance
Overview
Baselines allow you to label a set of requirements at specific versions. Baselining is an option that can be used only if you choose to do so. You must have baseline administrator privileges to create, manage and delete baselines. You can view baseline information in the CaliberRM Administrator. Select the project that contains the baselines you want to view and select the Project Baselines tab. The tab displays information about each baseline:

Baseline Name: The name of the baseline. Initialization Date: The date and time the baseline was initialized. Dates are displayed using the appearance setting for date format. To change the appearance, select Tools > Options > Appearance tab. Last Modified Date: The date and time of the last modification made to the baseline. Lock Status: Indicates if the baseline is locked or unlocked. Only a baseline administrator can modify an unlocked baseline. A locked baseline cannot be managed or unlocked. Date Locked: The date and time the baseline was locked.
There is also the Electronic Signature for Baselines functionality. This optional feature allows certain users, called signatories, to enter login credentials and electronically sign a locked baseline.
Creating a Project Baseline

Creating a baseline defines the baselines characteristics, not its contents. To create a baseline for a project:
1 Select the ATM Maintenance project from the project list. 2 Select the Project Baselines tab and click the New button. The New Baseline dialog box is displayed.
C h a p te r 8 : Ba s e l i ne M ai n te n an c e
33
3 On the Properties tab, enter Original Version as the baseline name. 4 Enter This baseline contains the original version of the project requirements as the description. 5 Select the Signatories tab.
The tab displays a list of people, called Signatories, who can sign a locked baseline.
6 Click Modify to add users to the list. The Add Baseline Signatories dialog box is displayed. 7 Select the Members of this baselines project option button. 8 Select the check boxes next to the users: admin, gjones, and your user name. 9 Click OK. 10 Select the Signature Meaning tab.
Each baseline has attached to it a list of signature meanings for electronic signatures. Each baseline must contain at least one signature meaning value. The default signature meaning is Approved. Note: The Approved signature meaning does not appear in the list until you select OK.
11 Click the Insert Before button. The New List Item line appears. 12 Enter Pending as the name for the signature meaning in the blank list entry. 13 Select Pending and click the Insert After button. The New List Item line appears. 14 Enter Declined as the name for the signature meaning in the blank list entry.
Note: To delete a signature meaning, select the signature meaning in the list and clicking the Delete button. You must have at least one signature meaning. You cannot delete the last remaining signature meaning from the list.
15 Click OK to save the new baseline. The New Baseline window closes automatically and the new baseline is listed in the Baseline drop-down list on the menu.
Initializing a Baseline
Once you have created a baseline, you must initialize it. That is, you have to populate the baseline with requirement information. You must be a baseline administrator to initialize a baseline. To initialize a baseline:
1 In CaliberRM select the ATM Maintenance project and select the Original Version baseline from the Baseline drop-down list. The Initialize a Baseline dialog box is displayed. 2 Select the Current Baseline as the Starting point. 3 Select the Proceed to baseline maintenance after pressing OK check box.
Note: When a baseline is initialized or modified, traceability, references, and discussion are not baselined.
4 Click OK. The Baseline Maintenance window is displayed. It contains the requirement tree with check boxes next to the requirements contained in the baseline. Since all of the requirement types are selected, click the Save button to save the baseline. 5 Close the Baseline Maintenance window.
Locking a Baseline
Warning!
Once you lock a baseline, you cannot unlock it. The Lock Baseline check box becomes disabled once you select it. Once you have completed all baseline maintenance, you can lock a baseline. Once you lock a baseline, you cannot make modifications to it. However, signatories can sign the baseline, modify signatures, and assign meanings to it once it is locked. You must be a baseline administrator to lock a baseline. To lock a baseline:
1 Select the Original Version baseline from the Baseline drop-down list. 2 Select File > Baseline Administration > Baseline Properties from the menu. The Modify Baseline dialog box is displayed. 3 On the Properties tab, select the Lock Baseline check box. The Lock Baseline warning is displayed. 4 Click Yes to lock the baseline. 5 Click OK. The baseline is locked and the Lock Baseline check box becomes disabled.
When a baseline is locked, all signatories for the baseline receive email notification informing them the baseline is ready to be signed. Signatories added after a baseline is locked also receive notification.
Electronic Signatures for Baselines

Baseline signatures are the electronic equivalent of a sign off sheet that is used to approve a set of requirements prior to development work taking place. To access baseline signature functionality, select Tools > Baseline Signatures from the menu. Selecting this menu item displays the Baseline Signatures window. From this window, you can view details about a signed baseline, add a new signature, view and print signature reports, and compare baselines. Depending on the status of the signature, the signatures are displayed in various colors and font styles:
If you have signed the baseline, your signature entry is the window text color, usually black. You can double-click the entry to view signature details. If you have not signed the baseline your signature entry is the windows text color and bold. You can double-click the entry to add your signature. If another user has not signed the baseline, his/her signature entry is gray and bold. If another user has signed the baseline, his/her signature entry is the window text color, usually black.
Adding a Signature
To sign a baseline:
1 Select the Original Version baseline from the Baseline drop-down list. 2 Select Tools > Baseline Signatures from the menu. The Baseline Signatures window is displayed. 3 Click the Add Signature button.
C h a p te r 8 : Ba s e l i ne M ai n te n an c e
35
Note: The Add Signature button is only enabled if the baseline is locked and you are a signatory for the baseline. The New Signature dialog box is displayed.
4 If you want to add or change your title, enter it in the Title box. 5 Assign a Signature Meaning to the signature using the drop-down list. 6 In the Authentication section, verify your User ID and enter your Password. 7 Click OK. The Baseline Signature warning dialog box is displayed, verifying that you want to sign the baseline. 8 Click OK. Your signature now appears in the Baseline Signatures window.
Signatories can sign a baseline multiple times, however, once a signature is added it cannot be replaced or deleted.
Signature Reports
To view a report of a baselines signatures, select the Signature Report button in the Baseline Signatures window. The report is launched in your web browser. The report is sorted using the same sort order as the signature list in the Baseline Signatures window. You can also view signature information in reports using Document Factory. See Document Factory Syntax in the CaliberRM User Guide for more information on this feature.
Comparing Baselines
You can compare baselines to review baseline changes or project progress. To compare two baselines:
1 Select Tools > Compare Baselines from the menu. The Compare Baselines dialog box is displayed.
Note: You can also select Tools > Baseline Signatures, then click the Compare Baselines button in the Baseline Signatures window to access the Compare Baselines dialog box.
2 Select Current Baseline from the Baseline 1 drop-down list, and Original Version from the Baseline 2 drop-down list. 3 Click OK. A comparison of the baselines is displayed in an .html file. 4 You can select one of three ways to view the data:
Show Baseline Comparison: Displays differences according to the hierarchical structure of the requirements. Show Only Baseline Differences Grouped by Requirement Type: Displays differences by Requirement Type. Show Only Baseline Differences Grouped by Difference Type: Displays differences by difference type. Missing: A requirement exists in one baseline, but not the other. Moved: A requirement has been moved. Moved and Versioned: A requirement has been moved and is a different version. Versioned: A requirement is a different version.
5 Select File > Print and following normal Windows printing procedure to print the report. 36 U s e r T u to r ia l
Chapter
9
Chapter 9
Group Discussion and Change History
Group Discussion
Project teams, which may include business analysts, managers, CEOs, end users, developers, testers and customers, can provide feedback on requirements through the Group Discussion feature. Using this interactive feature, team members can enter comments and reply to others comments to better define, refine and prioritize requirements. Messages and replies are stored for each requirement, so everyone knows exactly which requirement is being discussed. When a requirement has a discussion message you have not read, the Unread Discussion Indicator is displayed to the left of the requirement name in the requirement list. This indicator is only visible if you have not read the message(s). Once you have read the message(s), the indicator disappears. An indicator is also displayed on the Discussion tab if there is an unread reply to a requirement message. Once the reply is read, the indicator disappears. A pop-up list of unread discussions allows you to view all requirements in the currently selected project that have unread discussions. You can choose to have the list display automatically when the project is opened, or at any time, by clicking the Unread Discussions button.
Reading a Message
To read a message:
1 Notice that the Receipt requirement has an unread discussion indicator displayed to the left of the requirement name. 2 Click the Discussion tab. The tab displays all messages posted for the requirement.
Unread messages display an indicator that is illuminated green and are in bold type. Once you read the message, the indicator turns gray and the type becomes normal.
C h a p te r 9: G ro u p D i s c u s s io n a n d C h a ng e H ist or y
37
3 Select the message you want to view from the list displayed. You can collapse or display replies by clicking the plus sign (+) or minus sign (-) to the left of the subject. The message text displays in the message box.
Note: Click a header to sort messages in ascending order by subject, author or date. Click a second time to sort messages in descending order.
Posting a New Message

To post a new message:
1 Select the Fee requirement (it is a child requirement of Deposit Transaction in the Automated Teller Machine project). 2 Select the Discussion tab. 3 Click the Post New button. The New Message dialog box is displayed. 4 Enter Clarification as the subject on the subject line. 5 Enter Charge $1 for all transactions, or just Deposit Transactions? as the message in the message box. 6 To post your message, select File > Post Message from the menu.
Change History
Change history for each requirement is stored. This change history details all revisions made to the requirement, including changes to specific attributes, the requirement description, status, priority and more. The Revisions list displays the revision number automatically generated, the date and time each revision was made, the user who made each revision and the user comment made about each revision. The Changes list displays all changes for the selected revision, including each attribute changed, the original data stored for that attribute and the new data. To view the change history, select the Balance Transaction requirement and click the History tab. This tab shows that you created the requirement and when you created it, as well as the revisions and changes you made. You can click the Detail button at the bottom of the tab to see all of the details about a change in one screen.
Chapter7
10
Chapter 10
Reports and the Document Factory
Reports
There are three standard requirement reports:
Detail: Lists all requirements in the project with their data, including name, description, priority, status, owner and user-defined attributes. Status: Lists all requirements in the project sorted by the status. Responsibility: Lists all requirements in the project sorted by the responsible user.
You can access the standard reports using Reports on the main menu. Once you have accessed a reports dialog box, you can choose to export or preview and print the report. For more information on the standard reports, see Reports in the CaliberRM User Guide.
Document Factory
In addition to standard reports, Document Factory enables you to generate 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. You can also 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. When the template is complete, you can run Document Factory to populate the template with data from a project. Document Factory templates must be Word templates (.dot) files. If you prefer, you can work in a Word document until you have finished it, then convert it to a template file and place it in a folder reserved for Document Factory templates. There are several sample templates included with the product. If installed, they are located in Program Files > Borland > CaliberRM > Samples, or wherever you installed the application.
C h ap te r 1 0 : R e p o rt s a n d th e D o c u m e n t F a ct or y
39
Document Factory generates .txt, .doc and .rtf files. It also can be run from a command line if you want to schedule the document generation through a scheduling tool.
Document Factory 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 form a loop, like $Begin_list/ $End_list. These are referred to as command loops and are used to process lists of information, such as a list of traceability links or a list of users responsible for a requirement. This tutorial details the $Commands that are displayed in the template on the previous page. For detailed information about all of the Document Factory $Commands, see Document Factory Syntax in the CaliberRM User Guide. Note: $Commands alone do not place data in the document. They must be used in conjunction with keywords. 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. The more common commands are listed below.
$PROJECT{ }
This command specifies the project to be used for the document. If you are creating a project- specific template you may want to include this command in your template. If you do not include this command in your template, Document Factory prompts you to choose a project. The project name must appear the same as it does in the project drop-down list. Only one project may be specified in a template.
Syntax
$PROJECT{Automated Teller Machine}
$BEGIN_SECTION/$END_SECTION
These commands are used together to specify a section. A section typically contains a set of requirements of the same requirement type, but sections can be based on other criteria as well. The arguments in the $Filter command determine the group of requirements included in a section. If you do not filter on a particular set of requirements, Document Factory uses all requirements in the project.
Syntax
$BEGIN_SECTION $FILTER{type = Business Requirements} $SORT{hierarchy} $INDENTION_LEVEL{3} $INDENTION_SIZE{.5} $CALCULATE{keyword1 * keyword2 as result} <<name>>(<<tag>><<id_number>>) <<description>>
$END_SECTION
$FILTER{ }
The $Filter command is used to specify the group of requirements included in a section. It must be the first command in the section. If no $Filter is used, Document Factory includes all requirements in the section.
Syntax
$BEGIN_SECTION $FILTER{type = Business Requirements} $END_SECTION
$SORT{ }
The $Sort command determines the order in which requirements appear in a section. Keywords used as arguments in the $Sort command can be labeled as ASC for ascending order or DESC for descending order. Ascending is assumed if neither is specified.
Syntax
$BEGIN_SECTION $FILTER{type = Business Requirements} $SORT{hierarchy} $END_SECTION If multiple arguments are used in the sort list, requirements are sorted first by the first argument in the list. If there are multiple requirements meeting that criteria, they are then sorted by the second argument, and so on.
$INDENTION_LEVEL{ } and $INDENTION_SIZE{ }

If $Indention_level is specified, requirements in the section are indented according to their hierarchy in the tree. $Indention_level specifies the maximum levels deep the section is indented. $Indention_size specifies how many inches each indent is. As projects may contain many hierarchical levels, it is a good idea to limit the number of indents to a reasonable number. These commands can only be used in conjunction with a $Sort{hierarchy} command.
Syntax
$BEGIN_SECTION $FILTER{type = Business Requirements} $SORT{hierarchy} $INDENTION_LEVEL{3} $INDENTION_SIZE{.5} $END_SECTION
41
$CALCULATE{ }
$Calculate instructs Document Factory to perform a mathematical calculation of the specified keywords. The arguments to $Calculate must be formatted 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. Note: When using the divisor operator ( / ), make sure there are no zero values in the fields being used in the calculation. There can be only one $Calculate command in a section, but you can specify several calculations in one $Calculate command separated by commas.
Syntax
$BEGIN_SECTION $CALCULATE{days + overtime hours as total_time} Number of hours: <<total_time>> $END_SECTION
Keywords
The keywords in this section correspond to requirement attributes and must be used to obtain data to populate the Word document in Document Factory. The following keywords can be used anywhere in the document, including headers and footers: <<project>>: The name of the project. <<project_description>>: The description of the project. <<userid>>: The ID of the user creating the document.
The following keywords can only be used within a section: <<type>>: The name of the requirement type. <<tag>>: The tag for the requirement type. <<id_number>>: The requirements unique ID number. <<name>>: The requirements name. <<owner>>: The requirements owner. <<status>>: The requirements status. <<priority>>: The requirements priority. <<description>>: The requirements description. <<validation>>: The requirements validation procedure. <<reference>>: The drive, directory and file link for all of the document references assigned to a particular requirement. <<responsibilities>>: The list of all users responsible for a particular requirement. These are separated by department. For user-defined attributes, use the attribute name, exactly as defined in the requirements manager, within brackets (<< >>).
Word Template Setup

The ATM Business Requirements template is already set up for the Automated Teller Machine project. To modify the template to include Software Requirements as well as Business Requirements, complete the following steps:
1 Open Word and select File > Open from the menu. 2 Navigate to the c:\Program Files\Borland\CaliberRM\Samples folder (or wherever you installed CaliberRM). 3 Select the ATM Business Requirements.dot template and click Open.
The template opens, and you can see that the first page is a title page, and the second page contains a table of contents section which will be updated after the document is created.
4 Scroll down to the third page. On this page, you can see the text <<project>> Business Requirements. On the second line you can see $PROJECT{Automated Teller Machine}. This specifies that the template is for use with the Automated Teller Machine project only. You can see a section of the document that begins with the text $BEGIN_SECTION.
The next several lines of the document specify the filter, sort and indention criteria for that section of the document. The $FILTER criteria specifies that only Business Requirements will be included in this section, and the $SORT criteria specifies that the requirements will be sorted by their hierarchical numbers. Following the filter, sort and indention criteria are the fields that determine the data to include in the document. And finally is the text $END_SECTION, which identifies the end of the section.
5 In the title line, change Business Requirements to Business and Software Requirements. 6 Scroll to the end of the document and add a page break. 7 On the last page of the document, enter Software Requirements as a header for a new section. 8 Add a blank line and enter $BEGIN_SECTION to add a new section. 9 On the next line, enter $FILTER{type = Software Requirements} to include only software requirements in the section. 10 On the next line, enter $SORT{name} to specify that the requirements should be sorted alphabetically. 11 On the next line, enter $INDENTION_LEVEL{1} to keep all of the data at one level. Because this section sorts the requirements alphabetically, only one level is needed. 12 Add the following lines:
<<hierarchy>> <<name>> <<tag>> <<id_number>> <<description>>

13 Make any other changes that you want. The CaliberRM Document Factory uses the formatting that you specify for each field (i.e., bold, italics, etc.) including the format of the brackets around the field. 14 Enter $END_SECTION on the next line to end the Software Requirements section. 15 Save the template and close Word.
43
Creating a Document Using Document Factory

Once you have formatted your Word template to include the data you need in the format you want, you can launch Document Factory to populate the template with your requirement data. You can also run the Document Factory from a command line if you want, so you can schedule document generation as needed. See Document Factory Syntax in the CaliberRM User Guide for command line parameters. To create a document using Document Factory:
1 Select Programs > Borland CaliberRM > Document Factory from the Windows Start menu.
Document Factory launches. You should already be logged on to the system, so Step 1 should not display. If it does, log on, and Step 2 is displayed.
2 Click the Browse button under the Template to navigate to the ATM Business Requirement.dot template file that you modified. The default location is c:\Program Files\Borland\CaliberRM\Samples. 3 Enter a path and name for your new document or leave blank. 4 Click Next. Step 3 is displayed. 5 Choose the date format that you would like to use: Short Date or Long Date. 6 Choose Once for the method of replacing fields.
Note: If you use a keyword more than once in a section, the Once option replaces only the first instance of the field. The Multiple option replaces all instances of the field, but takes longer to process the data.
7 Click Next. Step 4 is displayed. 8 Choose the Use CaliberRM Server data option button. 9 Select the Requirement descriptions will include formatted text, tables and images check box. 10 Click Finish. Document Factory processes the data.
When the data has been processed, Document Factory prompts you to open Word and displays your document. You can now save the document or modify it.
Chapter
11
Chapter 11
Summary
Now that you have completed the Tutorial, you should have an understanding of the basic features and functionality of the product. Be sure to review the CaliberRM User Guide for more detailed information on all of the topics and lessons you found here, as well as information on the more complex and rich features of the whole tool. If you have any questions or comments about this documentation or the product, please contact Product Support.
Borland Support
Borland offers a variety of support options. These include free services on the Internet, where you can search our extensive information base and connect with other users of Borland products. In addition, you can choose from several categories of support, ranging from support on installations of the Borland product to fee-based consultantlevel support and extensive assistance. For more information about Borlands support services, see our web site at http://support.borland.com/. From the Web site, you can access many newsgroups where CaliberRM users exchange information, tips and techniques. When contacting support, be prepared to provide complete information about your environment, the version of the product you are using, and a detailed description of the problem. For support on third-party tools or documentation, contact the vendor of the tool.
C h a pt er 1 1 : S u m m ar y
45
Appendix
A
Appendix A
Glossary
Attributes: Attributes are characteristics that help define requirements. For example, all requirements contain the attribute Priority to indicate the priority of the requirement. Both system and user-defined attributes are supported. Automatic Notification: Users are assigned to requirements. When a requirement is added, modified or deleted, responsible individuals are automatically notified by e-mail. Baseline: A baseline is defined as a static snapshot of a group of requirements or a project at specific versions or a specific point in time. Custom Tabs: A feature that allows an Administrator to create and delete custom tabs that contain user-defined attributes. Custom Tools: A feature that allows the user to create custom tools, such as a link to Word, specific to the project. Custom tools can be created, given a user-chosen icon and placed at a specific location on the toolbar for accessibility. Field Changed Indicator: The indicator represented by an asterisk (*) that displays next to fields that have been changed for a requirement. CaliberRM Administrator: The CaliberRM Administrator controls all administrative functions related to projects, users, groups, security and automatic notification. Glossary: A feature that allows the user to create, define and store project-specific terms. Group: A group is a set of users with similar responsibilities (i.e., Managers, Developers, Engineers, Marketing, etc.) Hierarchical Numbers: These numbers, displayed to the left of the requirement name, are dynamic and are determined by the requirements placement in the requirement list. For example, for each requirement type, there is a requirement numbered 1 whose children are numbered 1.1, 1.2 and so on. Project: Any application or system under development. Projects consist of several layers of information, including users and groups, requirement types and requirements. Reference Documents: Provide additional information for a requirement. Referenced documents may include a specifications document, meeting notes, a screen shot or anything else that might be of use in defining requirements. Registered Interest: A feature that gives the user the option to receive e-mail notification when a change is made to a requirement to which the user is not assigned.
A pp e n d ix A: G lo s s ar y
47
Requirements: Requirements are specifications that the application or system being built must meet. Requirements can originate from many sources such as business rules, business process models, product marketing, prototypes, development meetings and more. Requirement ID Numbers: These numbers, also called Serial numbers, are displayed to the right of the requirement name. These numbers are static and are automatically generated. Each ID number is unique in the system. If a requirement is deleted, that ID number is not reused. Requirement Types: Requirement types are high-level groups of requirements. Requirement types are typically classified by their function (i.e., Marketing, Functional, GUI, Software, Testing, etc.). RM Export/RM Import: A feature that allows the user to export a project from a server into an ASCII file to be imported later into the same or another server. The user may also import a project to a server by specifying the path/name of the import data from a directory created by the export facility. Security Profile: Determine access privileges. These profiles are then assigned to groups within each project through the CaliberRM Administrator. Software Configuration Management (SCM): Development tools that track changes and provide version control for source code or other file types. System Attributes: An attribute that is automatically assigned to each requirement. System attributes are Priority and Status. Users set the values for these attributes to define requirements. Test Wizard: A feature that allows the user to create tests for any requirement by automating the process of creating tests in Quality Center. Traceability: Allows you to see requirement relationships easily. Requirements may trace to or trace from other requirements, as well as object modeling and test entities. Suspect links, which indicate a change in a requirement that may affect other objects, are shown when a requirement is changed. Unread Discussion Indicator: An indicator that notifies a user when a requirement has a discussion item that has not been read. Unread Discussion List: A pop-up list that shows all unread discussions, allowing the user to view all requirements in the currently selected project that have unread discussions. Unread Message Indicator: An indicator that notifies the user of an unread message on the Discussion tab of a selected requirement or project. The indicator is illuminated green when the message has not been read. Once the message has been read, the indicator turns gray. User-Defined Attributes: A user-defined attribute is one which a user defines and assigns to a custom tab in a requirement type. For example, GUI requirements may contain an attribute called screen width while functional requirements may contain an attribute called response time. User: Any person who has access to and uses the application. Users can be developers, managers, testers, CEOs and others. User Identity (Id): The display of a users name and department assignment in a tool tip box when the cursor is placed over the user ID. Validation: Validation procedures help determine how to test the application to ensure that the requirements are implemented correctly.
Index
A
adding baseline signatories 34 Administrator Tutorial 21-25 Advanced Tutorial 17-19 assigning attribute values 12 glossary 29 users and groups 13 attributes 23-25 assigning 12 creating 23 deleting 25 in requirement type 24 modifying 25 overview 23 system 23 types 23 user-defined 23
E
electronic signature 35
G
glossary assigning 29 creating 29 group discussion. see discussion. groups creating 30 overview 30
H
hierarchical number 9
L
linking document text 18 reference documents 17 requirements 18
B
baselines 33-36 comparing 36 comparison report 36 signatures 35 Basic Tutorial 11
M
meaning, signature 34 message posting 38 reading 37 modifying requirement types 23 user-defined attributes 25
C
CaliberRM Administrator overview 27 change history 38 comparing baselines 36 copying a requirement 13 creating documents 44 glossary 29 groups 30 projects 28 traceability links 18 user-defined attributes 23
O
overview Administrator Tutorial 21 Advanced Tutorial 17 Basic Tutorial 11 CaliberRM Administrator 27 requirement types 21
D
defining requirement information 11 requirement validation 19 deleting requirement types 23 user-defined attributes 25 departments 28 discussion overview 37 posting a message 38 reading a message 37 unread discussion indicator 37 document factory commands 40 creating a document 44 Word template setup 43
P
projects creating 28 overview 28
R
reference documents linking 17 reports 39 baseline 36 requirement changing the order 14 copying 13 defining 11 validation 19 requirement grid 13 requirement numbers 9 requirement types assign attributes 24 deleting 23
In de x
49
modifying 23 overview 21
S
serial number 9 signature meaning 34 signatures 35 StarTeam toolbar adding a tool 5 deleting a tool 5 modifying a tool 5 options 4
T
traceability creating links 18 matrix 18 tutorial conventions 1
U
user-defined attributes 23, 23-25 creating 23 in requirement type 24 modifying 25 types 23 users overview 31
V
validation 19

CaliberRM Tutorial

Caricato da

Informazioni sul documento

Descrizione originale:

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

CaliberRM Tutorial

Caricato da

Copyright:

Formati disponibili

User Tutorial

CaliberRM Administrator Tutorial

Group Discussion and Change History 37

Reports and the Document Factory

Text to be typed in Sample User names

Adding a Tool Shortcut

The Windows Shortcut Wizard is launched.

Modifying a Tool Shortcut

Deleting a Tool Shortcut

Logging On to the CaliberRM Administrator

Your user name Your password

Displaying Requirement Numbers

Step 1: Defining Requirement Information

To create a requirement and define the requirement information:

Step 2: Assigning Attribute Values to a Requirement

Step 3: Assigning Users and Groups to a Requirement

Changing the Requirement Order

Linking a Reference Document

Creating a Traceability Link

Note: Right-click a requirement and select Properties to view requirement properties.

Defining Requirement Validation

Creating a Requirement Type

The attributes are added to the Selected list in alphabetical order.

Note: To change information, click Back.

User-defined attributes can be one of 13 different types of data:

Creating a User-Defined Attribute

Note: To change information, click the Back button.

Assigning User-Defined Attributes to a Requirement Type

CaliberRM Administrator Tutorial

Note: To change information entered, click Back. The project is created.

Assigning a Glossary to a Project

The glossary is assigned to the project.

Creating a Project Baseline

Electronic Signatures for Baselines

Group Discussion and Change History

Posting a New Message

Reports and the Document Factory

Document Factory Commands

$INDENTION_LEVEL{ } and $INDENTION_SIZE{ }

Word Template Setup

<<hierarchy>> <<name>> <<tag>> <<id_number>> <<description>>

Creating a Document Using Document Factory

Potrebbero piacerti anche