CaliberRM 2008 SP1

CaliberRM™

2008 SP1

Installation Guide

Borland Software Corporation may have patents and/or pending patent applications covering subjectmatter in this document. The furnishing of this document does not give you any license to thesepatents.

Copyright © 2009 Borland Software Corporation and/or its subsidiaries. All Borland brand andproduct names are trademarks or registered trademarks of Borland Software Corporation in theUnited States and other countries. All other marks are the property of their respective owners.

CRM06-INST

March 2009

1

Table of Contents

Introduction 1Borland Support 1

Installing Server Components 3Installing the CaliberRM Server 4

Installing Both Client and Server 4Installing the Server Only 5

Installing CaliberRM Web 6Installing LDAP User Import 8Installing MPX Services 8Configuring MPX Services After Installation 9Reconnecting MPX Services If the Server Loses the Connection 9Installing CaliberRM for Microsoft Team Foundation Server 10

Silent Installation 10

Installing Client Components 13Installing the CaliberRM Client 14

Typical or Full Client Installation 14Custom Installation 15Silent installation of CaliberRM client 15

Installing the CaliberRM Plug-in for Eclipse 17Installing the CaliberRM Plug-in for Microsoft Visual Studio 2005 17Installing the CaliberRM Plug-in for Visual Studio Team System 18

Silent Installation 18Installing the Visual Studio 2008 Plug-in 19Installing the CaliberRM SDK 19

Performing an Upgrade 21Server Upgrade 21

Upgrading from 2006 Release , 2005 Release 2, or 2005 Release 2 SP1 22Client Upgrade 23

Upgrading Borland CaliberRM for Microsoft Visual Studio Team System 24

Program Maintenance for CaliberRM 24

Chapter 1: Introduct ion 1

C h a p t e r

Chapter 1IntroductionWelcome to CaliberRM, Borland’s requirements management system. Please take a moment to review the release notes for the latest information.

This guide discusses how to install CaliberRM for the first time as well as how to upgrade to this release of CaliberRM from a previous release.

CaliberRM is a client server application that allows software teams to view requirements from a variety of interfaces (Windows standalone client, Eclipse plug-in, Visual Studio plug-in, and Web).

The installation program presents choices on the components to install and explanations for each. Read each component description before installing that component.

Borland SupportBorland 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 installation support to fee-based consultant-level support and extensive assistance.

For more information about Borland’s support services, go tohttp://support.borland.com/kbshow.php?q=29638.

For Borland support knowledge base and discussion forums, visit http://support.borland.com/.

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, please contact the vendor of the tool.

For the latest updates, we strongly recommend you to download the latest documents from Borland Documentation Web site at http://info.borland.com/techpubs/caliber_rm/.

http://info.borland.com/techpubs/caliber_rm/

2 Instal la t ion Guide

Chapter 2: Instal l ing Server Components 3

C h a p t e r

Chapter2Installing Server ComponentsThis chapter details how to install the Server Components of CaliberRM, including:

■ CaliberRM Server (required)

■ CaliberRM Web (optional)

■ LDAP User Import (optional)

■ StarTeam MPX services (optional)

■ CaliberRM for Microsoft Team Foundation Server (required to view CaliberRM requirements from Visual Studio Team System)

If you are upgrading an existing installation, see Chapter 4.

Prerequisites■ The installer checks the length of the currently logged in user name and does not

allow the server install to continue if the length is greater than 15 characters or contains spaces. On a domain controller, the actual length of the name is comprised of the user name, domain name, and a slash. For example, if the domain name is MyDomain, and the logged on user is Administrator, then the actual user name detected by the CaliberRM install isMyDomain\Administrator.

■ The computer name where the server is installed should not include non-English characters and the server install directory should not contain any special (%, &, etc.) or non-English characters.

■ If you are attempting to install CaliberRM on an unsupported or non-server operating system, a warning message displays at the bottom of the screen. Before you can proceed, you must select the check box indicating you are aware that your installation is not supported. Please review the system requirements in the CaliberRM 2008 readme.

■ Before you upgrade to CaliberRM 2006 server, you must obtain new CaliberRM 2008 license keys from Borland. Previous license keys are not recognized.

■ Changing the computer name for the CaliberRM server machine will result in a non-operational installation.

■ The disk browser should start automatically if autorun is enabled. If it is not enabled, click Run from the Windows Start menu. Windows displays the Run


dialog box. In the Open field, enter E:\setup, where E is the letter of your optical disk drive. Click OK.

Installing the CaliberRM ServerThere are two ways to install the CaliberRM server: with the client (below) or alone (page 5).

To install the CaliberRM server:

1 Close all Windows programs before proceeding with the installation.

2 Run Setup.exe either from the CaliberRM installation disk or from the location you saved the downloaded CaliberRM installation to.

3 Select Server Install.

4 Select Server in the list of components.

5 The CaliberRM Installation Wizard starts and the Welcome screen displays.

6 Click Next. The License Agreement screen displays.

7 Read the license agreement carefully, and if you agree to the terms, select I accept the terms in the license agreement.

8 Click Next. The Customer Information screen displays.

9 Enter a User Name and Organization.

10 Select an option in Install this application for.

11 Click Next. The Setup Type screen displays.

Note: If you are performing an upgrade, setup displays the Upgrade screen. See page 19 for upgrade information.

12 The installation options are displayed:

• Install Typical Client Features Only: Installs the client only. Go to page 14.

• Install Full Client: Installs the client only. Go to page 14.

• Install Client and Server: Installs both the CaliberRM client and the CaliberRM server.

• Custom: Installs only the features you select. Recommended for advanced users. Select this option if you want to install the server only. Go to page 5.

Installing Both Client and Server

1 Complete steps 1-12, starting on page 4.

2 Select Install Client and Server.

3 Click Next. The License Keys screen displays.

4 If you are installing an evaluation copy of CaliberRM, click Next and go to Step 5.

If you are installing a purchased copy of CaliberRM, click Edit next to the CaliberRM License Key text box.

5 Enter in your license key and click Validate Key.

6 Click Next. The MPX Configuration screen displays.

6 To enable MPX events, select the Enable MPX Events option button.

Note: Enabling MPX events is optional. For MPX Service added value, review the “Installing MPX Services” on page 8.


7 To designate where the MPX events are published, select an option:

• Publish MPX events to this machine. If you do not have StarTeam Message Broker installed, select the Install StarTeam Message Broker after CaliberRM installation completes check box. See "Installing MPX Services" on page 8 for instructions on installing the StarTeam Message Broker.

• Publish MPX events to a different machine. Enter the name or IP address of the alternate machine. Choose this option if the StarTeam Message Broker is, or will be, installed on another machine.

If you do not enable MPX events at first, but decide to at a later time, see page 9 for instructions on enabling MPX post installation.

8 Click Next. The System Configuration screen displays.

9 If you do not want a CaliberRM shortcut on your desktop, select the Do not leave a CaliberRM shortcut on the desktop option button. The default is to leave a shortcut on the desktop.

10 If you do not want to install a sample database, select the Blank Database option button. In this case project samples are not installed. The default is to install a sample database with five sample projects.

Note: The default database name is SQMDB. The database name should not include non-English characters.

11 Click Next. The Ready to Install the Program screen displays.

12 Click Install. Setup begins installing files and displays a status bar to show progress. Click Cancel to cancel the installation at any time.

13 Click Finish to exit the Install Wizard. Setup displays the CaliberRM Client Installer Information screen.

14 Click Yes to restart your system immediately, or No to restart later.

Note: You must restart your machine for the changes to take effect. Logging off and on again is insufficient.

Once you restart your machine, the CaliberRM server attempts to start up.

Important! If you change the IP address of the CaliberRM server, you must restart the server.

Installing the Server Only


2 Select Custom.

3 Click Next. The Custom Setup screen displays.

4 Click the install state icon of the CaliberRM Client feature.

5 Select the This feature will not be available option. This will deselect all CaliberRM client components.

6 Click the install state icon of the CaliberRM Server component.

7 Select the This feature, and all subfeatures, will be installed on local hard drive option.

8 Click the Help button for information about each install state.

Click the Space button to see a list of the disk space requirements for each component.

Click the Change button if you want to change the location where the component is installed. The default install location for the server is C:\Borland\CaliberRMServer.


9 Click Next. The License Keys screen displays.

10 If you are installing an evaluation copy of CaliberRM, go to step .

If you are installing a purchased copy of CaliberRM, click Edit next to the CaliberRM License Key text box.

11 Enter in your license key and click Validate Key.

Click Next. The MPX Configuration screen displays.

1 To enable MPX events, select the Enable MPX Events option button.

Note: Enabling MPX events is optional. For MPX Service added value, review the “Installing MPX Services” on page 8.

2 To designate where the MPX events are published, select an option:

• Publish MPX events to this machine. If you do not have MPX Broker installed, select the Install StarTeam Message Broker after CaliberRM installation completes check box. See "Installing MPX Services" on page 8 for instructions on installing the StarTeam Message Broker.

• Publish MPX events to a different machine. Enter the name or IP address of the alternate machine. Choose this option if the StarTeam Message Broker is, or will be, installed on another machine.

If you do not enable MPX events, but decide to at a later time, see page 9 for instructions on enabling MPX.


Note: The desktop shortcut options are disabled for a server-only installation.

4 If you do not want to install a sample database, select the Blank Database option button. In this case project samples are not installed. The default is to install a sample database.

Note: The default database name is SQMDB. The database name should not include non-English characters.


Note: If you are attempting to install CaliberRM on an unsupported or non-server operating system, a warning message displays at the bottom of the screen. Before you can proceed, you must select the check box indicating you are aware that your installation is not supported. Please review the system requirements for CaliberRM in the readme file.

6 Click Install. Setup begins installing files and displays a status bar to show progress. Click Cancel to cancel installation at any time.




Once you restart your machine, the CaliberRM server attempts to start up.

Important! If you change the IP address of the CaliberRM server, you must restart the server.

Installing CaliberRM WebCaliberRM Web is a browser-based Web client that provides access to CaliberRM server without installing a standard CaliberRM client locally on a user machine. When installing CaliberRM Web, you have a choice to install CaliberRM Web Viewer, a web


interface for read-only access to requirements or CaliberRM Web Client, a web client that provides write access to requirements. For the list of standard client features that are not available from the Web client, refer to the “Web Client” online help reference.

Notes:

■ Before installing this feature, make sure you have administrator privileges on the machine on which you are performing the install.

■ If you want to use IIS as the Web server, do not install CaliberRM Web on the same machine where Team Foundation Server/Sharepoint is installed.

■ On Windows 2003: If you do not have the Java Runtime Environment installed and Internet Explorer Enhanced Security is enabled, you must modify the Internet Explorer security options to add http://sun.com to the list of Trusted sites or click the Download Java Runtime.

To install CaliberRM Web:


2 Insert the installation disk into the optical disk drive or double click the installation file you downloaded.

3 Click Server Install.

4 Click CaliberRM Web.







11 Select an installation option button:

• Install both, CaliberRM Web and CaliberRM Web Viewer

• Install CaliberRM Web Client

• Install CaliberRM Web Viewer

12 Select the Web server option you would like:

• If you will use Apache as your Web server, select the Use Apache as my Web Server option button.

• If you will use Microsoft IIS as your Web server, select the Use Microsoft IIS as my Web Server option button.

• If you will configure your Web server manually, select the I’ll configure my Web server manually option button.

13 Click Next. Setup displays the Ready To Install screen.

14 If you want to change the install location, click the Change button. The default path is C:\Borland\CaliberRMServer.

15 Click Install to begin installation. Setup displays the Installing the CaliberRM Web screen. Click Cancel to cancel the installation at any time.

When the installation is complete, setup displays the CaliberRM Installation Wizard Completed screen.

16 Click Finish to exit the Install Wizard. Setup displays the CaliberRM Web Installer Information screen.



Warnings:

■ The first time you open the Web client, it may take a while to appear. Do not abort your first access until you view the login page.

■ When you use Apache server as the Web server for CaliberRM Web, CaliberRM Web creates its own folder for documentation and configuration files (separate from the one in Apache).

Note: You must restart your machine for the changes to take effect. Logging off and on again is insufficient. Once installed, CaliberRM Web can be accessed by entering http://<webserver>/htdocs} in your browser (where <webserver> is the name of your Web server).

Installing LDAP User ImportBorland provides a utility (LDAP QuickStart Manager) that allows you to import information about users from a directory service or LDIF file into a CaliberRM server or a StarTeam server.

For more information about the LDAP QuickStart Manager, see the document LDAPQuickStart available in the LDAP QuickStart Manager folder on your installation disk.

Installing MPX Services

The StarTeam Message Broker, or MPX, allows you to publish information about MPX events, such as creating or deleting a requirement.

Benefits of MPX include:

■ requirement additions appear in the requirement tree even if the parent node has already been expanded.

■ requirement deletions are removed from the requirement tree even if the parent node has already been expanded.

■ clients cache requirement data as it is retrieved from the server. The next time those requirements are selected, they are retrieved from local cache. If someone changes the requirement, the client retrieves the latest data from the server.

If the Message Broker is not used:

■ the application will function without any issues.

■ you must refresh the project to see requirements that have been added or deleted.

To install the StarTeam MPX server:




4 Select StarTeam MPX™ Services. The StarTeamMPX Services Install Wizard starts and the Introduction screen displays.


6 Read the license agreement carefully, and if you agree to the terms, click I accept the terms of the License Agreement and click Next. The Choose Install Set screen displays.


7 Select the type of install: Typical, Minimal, or Custom. If you want to use StarTeam Multicast Service, leave Multicast checkbox selected. Click Next.

Note: The Multicast Service is an optional process that gives the Message Broker additional broadcast capabilities. The Multicast Service delivers the same event messages that are sent by the Message Broker, but it uses IP multicast messaging instead of TCP/IP (unicast) communication. This means that each message is sent only once, regardless of the number of StarTeam clients that are subscribed. As a result, network traffic is kept relatively constant even as the number of clients grows, reducing network congestion and improving scalability in large user communities.

8 If you have enabled StarTeam Multicast Service, the Multicast Service Address screen displays. Enter the address or click Next to use the default value.

9 The Service Start Options screen displays.

10 Specify how to start the service: Auto or Manual.

11 Click Next. The Choose Install Folder screen displays.

12 Click Browse to change the location for install or click Next. The Choose Shortcut Folder screen displays. Indicate where you want to locate the product icons.

13 Click Next. The Pre-Installation Summary screen displays. Review the information. Click Previous, if you want to change any installation settings. Click Install when ready.

14 The Install Complete screen displays.

15 Click Done to exit the Install Wizard.

Configuring MPX Services After InstallationIf you are a StarTeam user, StarTeam MPX Services may already have been installed by your StarTeam administrator. You can then enable MPX Services for your CaliberRM Server.

To enable and configure MPX services:

1 On the machine where the CaliberRM server is installed, select Start > Settings > Control Panel.

2 Double click CaliberRM Server.

3 Click the MPX tab in the CaliberRM Server Settings dialog box.

4 Click Enabled to enable MPX events.

5 In the Broker name text box, type the name or IP address of the machine where MPX is installed.

6 In the Broker port text box, type the port number you want MPX services to use.

7 Click OK to save the settings and close the dialog box.

Note: You must stop and restart the server before MPX is active.

Reconnecting MPX Services If the Server Loses the ConnectionIf the CaliberRM server loses its connection to the MPX server, you must restart the CaliberRM server.

Note: To restart the CaliberRM server:

1 Select Start > Programs > Accessories > Command Prompt.

2 At the command prompt enter dbmgr -stop.

10 Insta l la t ion Guide

3 When the server stops, enter dbmgr -start. For further information, refer to the Database Manager Commands Reference topic in the online Help.

If the connection is lost on the MPX side, you must restart the MPX server, then the CaliberRM server.

Note: To restart the MPX server:

1 Select Start > Settings > Control Panel > Administrative Tools > Services.

2 In the Service list box, select the service named StarTeam Message Broker.

3 Click Restart the service.

Installing CaliberRM for Microsoft Team Foundation ServerTo allow Microsoft Visual Studio Team System teams to view CaliberRM requirements, you must install two components: a server component on the machine where Microsoft Team Foundation Server is installed, and a client component on each machine that will view CaliberRM requirements from the Visual Studio IDE integrated in Visual Studio Team System.

Prior to installing CaliberRM for Visual Studio Team System, make sure you have the various Visual Studio 2005 Team System components listed in the "System Requirements/Prerequisites" section of the Readme file.

The CaliberRM for Microsoft Team Foundation Server component enables the CaliberRM integration in Team Foundation Server. It must be installed on the machine where Microsoft Visual Studio Team Foundation Server is installed.

1 On the computer where Team Foundation System is installed, close all Windows programs before proceeding with the installation.


3 Click Server Install.

4 Click CaliberRM for Microsoft Team Foundation Server. The install wizard starts and the Welcome screen displays.

5 Follow the instructions of the InstallShield Wizard to complete the CaliberRM for Team Foundation Server installation.

Note: In a single-server installation of Team Foundation Server select (local) in the drop-down list of available Team Foundation database servers. In a dual-server installation of Team Foundation Server browse to the Team Foundation database server location on another computer. Alternately you can enter the IP address or the name of the computer where Team Foundation database server resides. For more information on dual server configuration refer to the Visual Studio® Team Foundation Installation Guide.

Once you install CaliberRM for Visual Studio Team System, all Visual Studio Team System process templates are enabled for the Borland® CaliberRM integration: both existing and new Visual Studio Team System projects include the Requirements (Borland CaliberRM) folder to view CaliberRM requirements.

Silent Installation

You can script the installation of this component to install it without user involvement.

Before running the silent installation scripts, make sure all machines comply to the system requirements specified in the readme file.


To install CaliberRM for Team Foundation Server, enter the following command in the command prompt:

setup.exe /v"/le \"server.log\" /qn INSTALLDIR=\"C:\Program Files\Borland\CaliberRM For Team Foundation Server\" IS_SQLSERVER_SERVER=servername AgreeToLicense2=Yes" /s

Note: The listed below file names, directory names, and server names require your edits to conform with your environment:

setup.exe is located in the CaliberRM for Visual Studio Team System Server folder on the installation disk.

server.log is the log file name; you may want to specify the path to the log file

c:\program files\Borland\CaliberRM For Team Foundation Server\ is the path to the CaliberRM for Team Foundation Server installation

servername is the Visual Studio 2005 Team Foundation Database Server name.

Chapter 3: Instal l ing Cl ient Components 13

C h a p t e r

Chapter3Installing Client ComponentsCaliberRM provides a variety of interfaces to create, view, and, manage requirements. The CaliberRM client provides the richest feature set for the analysts and project administrators. The Eclipse and Visual Studio plug-ins allow developers to have access to the requirements from their fingertips.

The CaliberRM Administrator (included in the CaliberRM Client installation) is required to create projects, users, groups, and perform other administrative tasks.

This chapter details how to install the following Client Components of CaliberRM:

■ CaliberRM Client (including Datamart and CaliberRM Administrator)

■ CaliberRM for Eclipse

■ CaliberRM for Microsoft Visual Studio 2005

■ CaliberRM for Microsoft Visual Studio Team System

■ CaliberRM for Microsoft Visual Studio 2008

■ CaliberRM SDK

If you are upgrading an existing installation, see Chapter 4.

Prerequisites■ CaliberRM for Microsoft Visual Studio 2008 and CaliberRM for Microsoft Visual

Studio 2005 plug-ins require corresponding version of the Visual Studio installed.

■ Existing customers: you must upgrade the CaliberRM server before upgrading the CaliberRM clients.

■ The disk browser should start automatically if autorun is enabled. If it is not enabled, click Run from the Windows Start menu. Windows displays the Run dialog box. In the Open field, enter E:\setup, where E is the letter of your optical disk drive. Click OK.

■ You should have a valid CaliberRM license (named or concurrent) to access CaliberRM requirements from any of the CaliberRM interface.


Installing the CaliberRM ClientIn this release, Borland does not support CaliberRM 2006 clients connected to a previous version of CaliberRM server.

To install CaliberRM:



3 Click Client Install.

4 Click CaliberRM.

5 The CaliberRM Install Wizard starts and the Welcome screen displays.

If you attempt to install the CaliberRM client on a machine that already has the CaliberRM server installed, Setup displays the Program Maintenance screen. Select Custom. See “Custom Installation” on page 15 for instructions.


7 Read the license agreement carefully, and if you agree to the terms, select the I accept the terms in the license agreement option button.



10 Click an option in the Install this application for area.


Note: If you are performing a client upgrade, setup displays the Upgrade screen.

12 Select the type of installation you want to perform:

• Install Typical Client Features Only: This option installs: CaliberRM (includes Borland Together, Borland Silk Central Test Manager, and Mercury Quality Center traceability add-ins), StarTeam Toolbar, Document Factory, EstimatePro, Spell Checkers, SDK, StarTeam Integration (StarTeam Traceability add-in and StarTeam Publisher), and Samples.

• Install Full Client: Installs all CaliberRM client programs listed in the preceding item, plus Datamart, Requirement Viewer, Administrative Import and Export.

• Custom: Installs only the features you select. Recommended for advanced users.

Typical or Full Client Installation










Custom Installation

Note: The default custom install is the same as a typical install.



3 Click the install state icon for a component.

4 Choose the installation option for each component.

5 Click Help for information about each install state.

Click Space to see a list of the disk space requirements for each component.

Click Change if you want to change the location where the component is installed. The default install location for the client is C:\Program Files\Borland\CaliberRM.




9 Click Install. Setup begins installing files and displays a status bar to show progress. Click Cancel at any time to cancel the installation.




Silent installation of CaliberRM client

You can install or upgrade a CaliberRM client using a silent installation process that uses command line options to run the installation.

Note: The silent install feature cannot be used to install the CaliberRM server.

A typical silent installation command with full path to the folder on a local optical disk drive would be:

D:\Setup.exe /V“/qn+” /S

The minimum required command to accomplish a command line install is Setup.exe /V“/qn”. However, this command is not completely silent; you will see a brief splash screen advising that CaliberRM setup is preparing the InstallShield Wizard. The /S eliminates this splash screen and must be placed at the end of the command line.

A + following /qn causes a confirmation dialog box to appear upon completion. This dialog box confirms completion or advises of failure in the event the install failed.

Command Description

Setup.exe /V“/qn+” /S Installs or upgrades the CaliberRM client silently. A confirmation dialog box appears upon completion if you include the plus (+) sign.


Accepted command line options are:

The NO options are the equivalent of deselecting options in a custom install.

You can install the Help files using a Custom Modification at a later time.

The ALLUSERS=2 option is used if you want to create shortcuts to CaliberRM client for all user accounts. To use this option, you need to have administrator privileges on the machine on which you are performing the install. A typical command would be:

Setup.exe /V“/qn ALLUSERS=2” /S

Multiple command line options are acceptable. For example, to install CaliberRM without the CaliberRM Administrator and without a confirmation dialog box appearing upon completion:

Setup.exe /V“/qn NOADMIN=YES ALLCLIENT=YES” /S

To install CaliberRM without the CaliberRM Administrator but with a confirmation dialog box appearing upon completion:

Setup.exe /V“/qn+ NOADMIN=YES ALLCLIENT=YES” /S

To install a french version of CaliberRM without the CaliberRM Administrator but with a confirmation dialog box appearing upon completion:

Setup.exe /V“/qn+ NOADMIN=YES ALLCLIENT=YES” /L1036 /S

Setup.exe /V“/qn+ ALLCLIENT=YES” /S

Enables all features when installing CaliberRM.

Setup.exe /V“/qn+ FEATURE=YES” /S

Disables any feature and prevents the user from enabling that option in Custom installation mode. See the table below for the feature commands for this option.

■ NODOCFACTORY Does not install Document Factory component

■ NOEXPORT Does not install Export and Import components

■ NOADMIN Does not install CaliberRM Administrator

■ NOVIEWER Does not install Requirement Viewer

■ ALLUSERS Creates shortcuts to CaliberRM client for all user accounts

■ ALLCLIENT Installs all CaliberRM Client components

■ NOSBTOOLBAR Does not install StarTeam Toolbar

■ NOSAMPLES Does not install samples including sample database

■ NOSTINTEGRATION Does not install the StarTeam Integration component for the CaliberRM Client.

Default language selection options■ English – /L1033■ French – /L1036■ German – /L1031■ Japanese – /L1041


In the event of an upgrade, the modifiers take precedence over the default option to upgrade existing components.

Installing the CaliberRM Plug-in for EclipseTo install and use the CaliberRM plug-in for Eclipse, perform the following steps:

1 Make sure Java Runtime Environment (JRE) or Java Development Kit (JDK) 1.5 with "public JRE" feature enabled is installed on your computer. If it is not, you can download it from http://java.com.


3 Click CaliberRM for Eclipse on the Client Components page. CaliberRM for Eclipse installer displays. Click Next.

4 In the License Agreement screen, accept the license agreement and click Next.

5 In the Destination Folder screen, specify the location of your Eclipse installation folder, for example, c:\eclipse\. Necessary components are installed to their respective folders. Click Next.

6 Click Install in the Ready to Install the Program screen.

7 Click Finish to exit the wizard.

8 Start Eclipse.

9 On the main menu, select Window > Open Perspective > Other.

10 Select CaliberRM in the list and click OK. Views and editors associated with CaliberRM display.

Note: For more information, refer to the CaliberRM online Help from the Eclipse Help menu.

Installing the CaliberRM Plug-in for Microsoft Visual Studio 2005Note: The CaliberRM plug-in for Microsoft Visual Studio 2005 should not be installed when using Microsoft Team Foundation Server. If your team uses Team Foundation Server, refer to the “Installing the CaliberRM Plug-in for Visual Studio Team System” section.

To install CaliberRM for Microsoft Visual Studio, perform the following steps:


2 Click CaliberRM for Microsoft Visual Studio 2005 on the Client Components page. The install wizard displays. Click Next.

3 The License Agreement screen displays. Read the license agreement carefully, and if you agree to the terms, select the I accept the terms in the license agreement option button.

4 Click Next. The Choose Destination Location screen displays. To change the folder location, click Browse. Click Next to begin installation.

5 Click Finish to exit the installation wizard.

To access CaliberRM requirements in Microsoft Visual Studio, perform the following steps:

1 Start Visual Studio 2005.

2 On the main menu select View>Other Windows>Borland CaliberRM Explorer.

3 In the CaliberRM window, click <<Click Here to Add a New CaliberRM Project>>.


4 Type server name (using a server:port number format if you use a non-default port), user name and password.

5 Click Add to finish.

Note: For more information, refer to CaliberRM online Help from the Visual Studio Help menu.

Installing the CaliberRM Plug-in for Visual Studio Team SystemNote: You must install the CaliberRM for Team Foundation Server component prior to installing the CaliberRM Client for Visual Studio Team System.

This component enables the CaliberRM integration for Visual Studio Team System users. It must be installed on each Visual Studio Team System user machine to access CaliberRM requirements from within Visual Studio and establish traceability between requirements and Visual Studio Team System work items and tests from Visual Studio. Please make sure you have Visual Studio 2005 installed prior to installing CaliberRM Client for Visual Studio Team System.




4 Click CaliberRM for Microsoft Visual Studio Team System. The InstallShield Wizard starts and the Welcome screen appears.

5 Follow the instructions of the InstallShield Wizard to complete the installation of the CaliberRM client plug-in for Visual Studio Team System and its subfeatures.

Note: For more information, refer to CaliberRM online Help from the Visual Studio Help menu.

Silent Installation

You can script the installation of this component to install it without user involvement.

Before running the silent installation scripts, please make sure all machines comply to the system requirements specified in the readme file.

Prior to running the client installation create the client response file by running the client setup with the following command:

setup.exe /r /f1"client.iss"

To install CaliberRM Client for Visual Studio Team System, enter the following command in the command prompt:

setup.exe /f1"client.iss" /f2"client.log" /s

Note: The listed below file names, directory names, and server names require your edits to conform with your environment:

setup.exe is located in the CaliberRM for Visual Studio Team folder on the installation disk

client.iss is the response file name that lists answers to installer questions; you might want to specify the path to the log file

client.log is the log file name; you may want to specify the path to the log file.


Installing the Visual Studio 2008 Plug-inThe CaliberRM integration into the Visual Studio 2008 allows developers to view project requirements from within the Microsoft development environment.

Note: You only need a read-only license of CaliberRM to view CaliberRM requirements in Microsoft Visual Studio 2008.

To install the Visual Studio 2008 plug-in:


2 Click CaliberRM for Visual Studio 2008. The install wizard starts and the Welcome screen displays.






8 Click Next. The Select Installation Folder screen displays. To change the folder location, click Browse.


10 Click Install. The installation begins.

11 When installation is complete, click Finish.

Installing the CaliberRM SDKThe client install includes the CaliberRM SDK. You can install the CaliberRM SDK separately if you plan to write custom applications for CaliberRM.


2 Click CaliberRM SDK. The CaliberRM Install Wizard starts and the Welcome screen displays.






8 Select an option for installing the SDK:

• Complete: installs both the COM SDK and the Java SDK and all associated files. Go to step 13.

• Custom: allows you to select which components you want to install.


10 Click the install state icon for a component.

11 Choose the installation option you want for each component.

12 Click Help for information about each install state.

Click Space to see a list of the disk space requirements for each component.


Click Change if you want to change the location where the component is installed. The default install location is C:/Program Files/Borland.


14 Click Install. The installation begins.

15 When installation is complete, click Finish.

Note: For more information on the SDK, see CaliberRM SDK Programmers’ Guide or the Javadoc located at Program Files\Borland\CaliberRM SDK 2008\api\index.html. Sample SDK applications are posted on the Borland support site or contact Borland Services.

Chapter 4: Performing an Upgrade 21

C h a p t e r

Chapter4Performing an UpgradeThe CaliberRM 2008 SP1 upgrade procedure differs from previous releases in that it requires that you upgrade CaliberRM server first and only after that, upgrade CaliberRM clients. Depending on the version of CaliberRM you use, different upgrade procedures should be performed.

You can upgrade to CaliberRM 2008 SP1 from CaliberRM 2006 or CaliberRM 2005 R2. If you need to upgrade from a release older than 2005 Release 2, you must upgrade to each major release version before moving to 2008. For example, you will need to upgrade from 6.5 to 2005 to 2005 Release 2 to 2008. If you are upgrading from a version earlier than 6.5, please contact Borland Support.

In this release, Borland does not support CaliberRM 2008 SP1 clients connected to a previous version of CaliberRM server. CaliberRM 2005 Release 2 or 2005 Release 2 SP1 clients can access a CaliberRM 2008 server but new features will not be available.

Borland recommends to perform a backup of your database prior to upgrading your server. Refer to your current CaliberRM online help and readme guidelines on backing up a CaliberRM database.

If you need to restore backups of CaliberRM databases made with a previous release of CaliberRM, you must first restore the database using the same version of CaliberRM used to perform the backup database, then upgrade to this release (following the server upgrade section), then backup the database (under a new name not to overwrite your original backup) following this release backup and restore procedure documented in the online help.

Note: Similar to previous releases, this release of CaliberRM Administrator can only administer a 2008 server. If you must administer a previous version of the server, ensure that your administrator does not upgrade their client to this release.

Server UpgradeYou do not need to uninstall your existing CaliberRM server before upgrading to this release. The installer will automatically detect your current installation and offer to upgrade it.

The user performing the upgrade of CaliberRM server must be the CaliberRM dbowner. That person will be listed as the creator when running dblist command from the command prompt.


This release adds versioning of traceability links in baselines, therefore the upgrade may take longer than in previous releases. Existing baselines will show traces as if they were added in the last version of the requirements included in the baseline.

Upgrading from 2006 Release , 2005 Release 2, or 2005 Release 2 SP1

To upgrade the server from 2006, 2005 Release 2 or 2005 Release 2 SP1, perform the following steps:




4 Select Server in the list of components.

5 The CaliberRM Installation Wizard starts and the Welcome screen displays.






11 Click Next. The setup displays the Upgrade screen.

12 Select the type of upgrade you want to perform:

• Upgrade features currently installed: Upgrades all of the features that are currently installed.

• Custom: Installs only the features you select. See page 5 for instructions on performing a custom installation.

13 Click Next. Specify other options, if necessary.

Note: When the upgrade is complete, restart your computer for the changes to take effect. Logging off and on again is insufficient.

Important information for Mercury Quality Center customersYou must upgrade to a supported version of Mercury Quality Center before upgrading your CaliberRM server. Refer to the release notes for a list of supported Mercury versions.

If you are upgrading from CaliberRM 2005 Release 2 and have traces to Quality Center "test sets" objects, you must execute the following CaliberRM server command after the server upgrade to ensure that these Mercury traces are upgraded correctly: (you do not need to perform these steps if you are upgrading from 2005 Release 2 SP1 or if you do not have traces to Quality Center "test sets" objects)

dbmgr –fixtdsets

The server administrator must run this command manually from the command prompt. You will be prompted to log on to the Quality Center server. After the command executes, all traces to Quality Center test sets found in the CaliberRM server will be upgraded. You should only need to run the command once per CaliberRM server.


Important change in Mercury traceability for 2005 Release 2 customersA trace previously created in a release of CaliberRM older than 2005 Release 2 SP1 between a requirement and a TestDirector/Quality Center test in set is upgraded to a trace between that requirement and the design test to which the test in set is linked in TestDirector/Quality Center. To be consistent with the Mercury usage model, when a CaliberRM user creates a new trace between a CaliberRM requirement and a Mercury test in set, the trace is established between the requirement and the respective design test linked to that test in set in TestDirector/Quality Center.

Once you upgrade your server to this release, the Document Factory keywords available for reporting on Mercury traces are <<all_objects>>, <<vendor_objects>>, and <<trace_teststatus>>.

Client Upgrade1 Close all Windows programs before proceeding with the installation.



4 Click CaliberRM.

5 The CaliberRM Install Wizard starts and the Welcome screen displays.






11 Click Next. The Upgrade screen displays.

12 Select the type of upgrade you want to perform:

• Upgrade features currently installed: Upgrades all of the features that are currently installed.

• Custom: Installs only the features you select. Recommended for advanced users. See page 5 for instructions on performing a custom installation.







Note: You must restart your computer for the changes to take effect. Logging off and on again is insufficient.


Information for Datamart Users■ If you use Microsoft Access as a backend database, note that during the upgrade,

CaliberRM uninstalls the previous version of Datamart. If you do not select the Datamart component during the upgrade, CaliberRM saves the rmmsa.mdb file from the previous release in the %USERPROFILE%\Local Settings\Application Data\Borland\CaliberRM\backup folder.

■ Similar to previous releases, this release of Datamart can only report from a 2006 server. If you must generate Datamart reports from a previous version of the server, ensure that the user running Datamart does not upgrade their client to this release.

Information for SDK users upgrading from CaliberRM 2005 Release 2If you wrote SDK scripts using 2005 Release 2, note the API changes below and update your scripts accordingly:

■ New method: Baseline.GetBaselineTree() should be used for programmatic baseline administration of non-'Current' baselines. (Documented in 2005 Release 2 SP1 release notes)

■ Modified method: Baseline.GetRequirementTree() has been changed to always return a RequirementTree class. In CaliberRM 2005 Release 2, this method returned a RequirementTree class when the Baseline object was the "current baseline", and a BaselineTree class for other baselines. This function should be used to retrieve the content of any baseline (including "Current") for the purpose of browsing or iterating the requirement tree. (Documented in 2005 Release 2 SP1 release notes)

■ Retired object: if you use the TestDirectorObject class, or a derived class thereof, you must update your programs to use the IntegrationObjects class instead.

Upgrading Borland CaliberRM for Microsoft Visual Studio Team System

If you installed the previous release of CaliberRM for Microsoft Visual Studio Team System, perform the following steps:




4 Click CaliberRM for Microsoft Visual Studio Team System and follow the steps of the wizard to upgrade your CaliberRM clients.

Program Maintenance for CaliberRMTo remove CaliberRM or any of the CaliberRM components use the Windows Add/Remove Programs procedure:

1 Click the Windows Start button and click Settings > Control Panel.

2 When the control panel appears, double-click the Add/Remove Programs icon.

3 Select the program you want to remove from the program list.

4 Click Add/Remove.

5 Click Next, then Remove.

6 Upon completion, click Finish.


If prompted, restart your machine for the changes to take effect. Logging off and on again is insufficient.

CaliberRM 2008 SP1

Documents

Transcript of CaliberRM 2008 SP1