caliber 11 - supportline.microfocus.com · installing caliber author and components ..... 8...

Caliber 11.5

Installation Guide

Micro FocusThe Lawn22-30 Old Bath RoadNewbury, Berkshire RG14 1QNUKhttp://www.microfocus.com

Copyright © Micro Focus 2016. All rights reserved.

MICRO FOCUS, the Micro Focus logo and Caliber are trademarks or registered trademarks ofMicro Focus IP Development Limited or its subsidiaries or affiliated companies in the UnitedStates, United Kingdom and other countries.

All other marks are the property of their respective owners.

2016-10-04

ii

Contents

Introduction ........................................................................................................ 4Micro Focus Support ...........................................................................................................4

Installing Data Server .........................................................................................5Installing MPX Services ...................................................................................................... 6

Installing Caliber Author and Components ..................................................... 8Installing Caliber Author ...................................................................................................... 8

Silent Install of Caliber Author Suite .........................................................................9Installing Caliber Plug-in for Eclipse Client ........................................................................10Installing the Caliber Plug-in for Microsoft Visual Studio ..................................................10Installing Caliber SDK ....................................................................................................... 11

Installing Caliber Review ................................................................................. 13Changing Caliber Review Server ...................................................................................... 13Enabling SSL for Caliber Review ..................................................................................... 13Configuring Cache for Caliber Review .............................................................................. 14

Configuring Caliber Review to use Windows Session Credentials ............15Creating a Kerberos Keytab .............................................................................................. 15Creating a Kerberos Configuration File ............................................................................. 16Configuring Caliber Review Server to Enable Windows Session Credentials .................. 16Configuring Windows Browser .......................................................................................... 17Restoring Review Server to non-Windows Session Credentials Mode .............................18

Installing Caliber Visualize .............................................................................. 20Introduction to Caliber Visualize ........................................................................................20Installing Caliber Visualize Overview ................................................................................ 20

Installing and Integrating with Caliber Overview .....................................................21Installing and Integrating with Caliber .................................................................... 21Configuring the Appearance of Assets in Caliber Visualize ................................... 22Starting or Stopping the Service ............................................................................ 23Enabling SSL Communication ................................................................................23Changing the Default Server TCP/IP Port Numbers .............................................. 23Changing the Caliber Data Server Settings ........................................................... 24

Uninstalling ........................................................................................................................24Logging on to .................................................................................................................... 24

Logging on as an Administrator for the First Time ..................................................24Application Startup Troubleshooting Guide .......................................................................25

Configuring Caliber Visualize to use Windows Session Credentials ..........27Creating a Kerberos Keytab for Caliber Visualize ............................................................. 27Creating a Kerberos Configuration File ............................................................................. 28Configuring Caliber Visualize Server to Enable Windows Session Credentials ................29Configuring Windows Browser .......................................................................................... 29Restoring Caliber Visualize Server to non-Windows Session Credential Mode ............... 30

Performing an Upgrade ....................................................................................32Data Server Upgrade ........................................................................................................ 32

Upgrading Data Server from 11.x to 11.5 ...............................................................32Manually Upgrading Server Components .............................................................. 32Important information for HP Quality Center customers .........................................32

Upgrading Author Suite Components ................................................................................33Information for Datamart Users .............................................................................. 33

Upgrading Caliber Review .................................................................................................33Program Maintenance .......................................................................................................33

Contents | 3

IntroductionCaliber is a requirement management system. It is a client server application that allows software teams toview requirements from a variety of interfaces (Windows standalone client, Eclipse plug-in, Visual Studioplug-in, and Web).

This guide discusses how to install Caliber as well as how to upgrade from a previous release to thisrelease. For the latest information, refer to the product Release Notes.

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

The installation must be completed in a specific order to ensure all components work fluidly together. InstallCaliber Author and components, Caliber Review, then Caliber Visualize.

Micro Focus SupportMicro Focus offers a variety of support options. These include free services on the Internet, where you cansearch our extensive information base.

For more information about Micro Focus’s support services, go to http://supportline.microfocus.com

When contacting support, be prepared to provide complete information about your environment, theversion 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 SupportlineWeb site at http://supportline.microfocus.com/productdoc.aspx.

4 | Introduction

http://supportline.microfocus.com

http://supportline.microfocus.com/productdoc.aspx

Installing Data ServerYou cannot upgrade from the 32-bit Data Server to the 64-bit Data Server. You must uninstall the 32-bitData Server before installing the 64-bit Data Server.

1. Close all Windows programs.

2. Run caliber-dataserver.exe from the location where you saved the downloaded 64-bit DataServer installation.

3. Select the language and click OK. The Caliber Installation Wizard starts and the Welcome screendisplays. If you do not have the correct version of Microsoft Visual C++, you will be prompted to install.Click Install.

4. Click Next. The License Agreement screen displays.

5. Read the license agreement carefully, and select I accept the terms in the license agreement if youagree to the terms.

6. Click Next. The Customer Information screen displays.

7. Type a User Name and Organization.

8. Click Next. The Destination Folder screen appears.

9. Click the Change button if you want to change the location where the component is installed. Thedefault install location for the data server is C:\Borland\CaliberServer

10.Click Next. The License Keys screen appears.

11.If you are installing an evaluation copy of Caliber, click Next and proceed to the next step. If you areinstalling a purchased copy of Caliber, click Edit next to the Caliber License Key text box.

12.Enter in your license key and click Validate Key.

13.Click Next. The MPX Configuration screen displays.

14.To enable MPX events, select the Enable MPX Events option.

Note: Enabling MPX events is optional. For MPX Service added value.

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

• Publish MPX events to this machine: Select this option If you do not have StarTeam MessageBroker installed. Select Install StarTeam Message Broker after Caliber installation completescheck box. For more information on installing the StarTeam Message Broker, refer to Installing MPXServices.

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

If you do not enable MPX events at first, but decide to at a later time, refer to Installing MPX Services.

16.Click Next. The System Configuration screen displays.

17.If you do not want to install a sample database, select Blank Database option. This option will notinstall project samples. 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-Englishcharacters.

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

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

Installing Data Server | 5

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

20.Click Finish to exit the Install Wizard. Setup displays the Caliber Installer Information screen.

21.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 isinsufficient. After you restart your machine, the Caliber data server starts.

Important: If you change the IP address of the Caliber data server, you must restart the server.

Installing MPX ServicesThe StarTeam Message Broker, or MPX, allows you to publish information about MPX events, such ascreating or deleting a requirement.

Benefits of MPX include:

• Requirement additions appear in the requirement tree even if the parent node has already beenexpanded.

• Requirement deletions are removed from the requirement tree even if the parent node has already beenexpanded.

• Clients cache requirement data as it is retrieved from the server. The next time those requirements areselected, they are retrieved from local cache. If someone changes the requirement, the client retrievesthe latest data from the server.

Note: If the Message Broker is not used, the application will function without any issues. However, ifthere are any additions, deletions or changes to the requirements, you must refresh the project to seethe amended requirements.

To install the StarTeam MPX server:

1. Close all Windows programs before proceeding with the installation.

2. Run Setup.exe from the directory where you downloaded Caliber.

3. Select Install Caliber Data Server and Server Utilities.

4. Select StarTeam MPX™ 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 theLicense Agreement and click Next. The Choose Install Set screen displays.

7. Select the type of install:

• Typical• Minimal• Custom

8. The Multicast Service Address screen displays. Type the address or click Next to use the defaultvalue. The Service Start Options screen displays.

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

10.Click Next. The Choose Install Folder screen displays.

11.Click Browse to change the location for install or click Next. The Choose Shortcut Folder screendisplays.

12.Indicate where you want to locate the product icons.

13.Click Next. The Pre-Installation Summary screen displays.

14.Review the information.

15.Click Previous if you want to change any installation settings.

6 | Installing Data Server

16.Click Install. The Install Complete screen displays.

17.Click Done to exit the Install Wizard.

Note: You must restart your machine for the changes to take effect. Logging off and on again isinsufficient. After you restart your machine, the Caliber Data Server attempts to start.

Installing Data Server | 7

Installing Caliber Author and ComponentsCaliber provides a variety of interfaces to create, view, and, manage requirements. The Caliber Authorprovides the richest feature set for the analysts and project administrators. The Eclipse and Visual Studioplug-ins allow developers to have access to the requirements from their fingertips.

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

This section details how to install the following Client Components of Caliber:

• Caliber Author Suite (including Datamart and Caliber Administrator)• Caliber for Eclipse• Caliber for Microsoft Visual Studio• Caliber SDK

If you are upgrading an existing installation, see Performing an Upgrade.

Prerequisites:

• On Windows 7 machines, turn off the User Account Control (UAC)• Caliber for Microsoft Visual Studio 2010 plug-in requires corresponding version of the Visual Studio

installed.• Existing customers: you must upgrade the Caliber Data Server before upgrading the Caliber Author.• 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 Caliber license (named or concurrent) to access Caliber requirements from anyof the Caliber interface.

Installing Caliber Author1. Close all Windows programs.

2. Run caliber-authorsuite.exe from the location you saved the downloaded Caliber installation.

3. Select the language and click OK. The Caliber Installation Wizard starts and the Welcome screendisplays.

4. Click Install to install Microsoft Visual C++ 2008 SP1, if you don't already have it installed.


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


8. Type a User Name and Organization and click Next. The Custom Setup screen displays.

9. Make the custom installation changes or accept the defaults.

10.Click Next. The Destination Folder screen appears.

11.Click the Change button if you want to change the location where the component is installed. Thedefault install location for the data server is C:\Borland\CaliberServer

12.Click Next. The License Keys screen appears.

13.If you are installing an evaluation copy of Caliber, click Next and proceed to the next step. If you areinstalling a purchased copy of Caliber, click Edit next to the Caliber License Key text box.

8 | Installing Caliber Author and Components

14.Enter in your license key and click Validate Key.

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

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

17.Click Finish to exit the Install Wizard.

Silent Install of Caliber Author SuiteYou can install or upgrade a Caliber Author using a silent installation process that uses command lineoptions to run the installation.

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

D:\caliber-authorsuite.exe /V“/qn+” /S

Note: caliber-authorsuite.exe represents the .exe name for documentation purposes.The .exe name includes the version number. Use the full .exe name for your version.

The minimum required command to accomplish a command line install is caliber-authorsuite.exe / V“/qn”. However, this command is not completely silent; you will see a briefsplash screen advising that Caliber setup is preparing the InstallShield Wizard. The /S eliminates thissplash 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 confirmscompletion or advises of failure in the event the install failed.

Command Description

caliber-authorsuite.exe/V"/qn+" /S Installs or upgrades the Caliber Author silently. Aconfirmation dialog box appears upon completion if youinclude the plus (+) sign.

caliber-authorsuite.exe /V“/qn+

ALLCLIENT=YES” /S

Enables all features when installing Caliber.

Setup.exe /V“/qn+

FEATURE=YES” /S

Disables any feature and prevents the user from enablingthat option in Custom installation mode. See the tablebelow for the feature commands for this option.

Accepted command line options are:

NODOCFACTORY Does not install Document Factory component

NOEXPORT Does not install Export and Import components

NOADMIN Does not install Caliber Administrator

ALLCLIENT Installs all Caliber Author 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 Caliber Author.

Default language selection options:

• English – /L1033• French – /L1036• German – /L1031• Japanese – /L1041• Chinese – /L2052

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

Installing Caliber Author and Components | 9

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 Caliber Author for all user accounts. Touse this option, you need to have administrator privileges on the machine on which you are performing theinstall. A typical command would be:

caliber-authorsuite.exe /V“/qn ALLUSERS=2” /S

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

caliber-authorsuite.exe /V“/qn NOADMIN=YES ALLCLIENT=YES” /S

To install Caliber without the Caliber Administrator but with a confirmation dialog box appearing uponcompletion:

caliber-authorsuite.exe /V“/qn+ NOADMIN=YES ALLCLIENT=YES” /S

To install a French version of Caliber without the Caliber Administrator but with a confirmation dialog boxappearing upon completion:

caliber-authorsuite.exe /V“/qn+ NOADMIN=YES ALLCLIENT=YES” /L1036 /S

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

Installing Caliber Plug-in for Eclipse ClientCaliber for Eclipse is only available in 32-bit.

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

2. Close all Windows programs before proceeding with the installation.

3. Run Caliber for Eclipse.exe from the location where you saved the downloaded Caliberinstallation.

4. Click Next. . The License Agreement screen appears.

5. Accept the license agreement and click Next. The Destination Folder screen appears.

6. Specify the location of your Eclipse installation folder. For example, c:\eclipse\.

Necessary components are installed to their respective folders.

7. Click Next. The Ready to Install the Program screen appears.

8. Click Install.

9. Click Finish to exit the wizard.

10.Start Eclipse.

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

12.Choose Caliber from the list and click OK. Views and editors associated with Caliber display. For moreinformation, refer to the Caliber Help located in the Eclipse Help menu.

Installing the Caliber Plug-in for Microsoft Visual StudioThe Caliber integration with Visual Studio allows developers to view project requirements from within theMicrosoft development environment.

Note: You only need a read-only license of Caliber to view Caliber requirements in Microsoft VisualStudio.


http://java.com

Note: Caliber supports Visual Studio Premium, Professional, and Ultimate. The plug-in will not installon other versions of Visual Studio, for example, the shell version.

Note: You must have the Caliber SDK installed on the same machine as the Microsoft Visual Studioplug-in.


2. Run Caliber for Visual Studio .NET.exe for the appropriate version from the location whereyou saved the downloaded Caliber installation. The .exe is located in the Caliber DevelopmentEnvironment Integrations. The Visual Studio Extension Installer screen displays.

3. If you have several versions of Visual Studio installed, select the version that you would like to integratewith Caliber. If you only have one version, it is checked by default.

4. Click Install. The installation begins.

5. Click Close when installation completes.

Installing Caliber SDKInstall the Caliber SDK if you plan to write custom applications for Caliber, plan to use the Visual Studiointegration, and plan to use the Silk Central integration.

If you are using a 64-bit JVM, install the SDK for 64-bt. The SDK for 64-bit installs in default 32-bit directory.You can only install one Caliber SDK on a machine.


2. Run Caliber SDK Installer.exe (32-bit) or Caliber SDK for 64bit Installer.exe (64-bit) from the location where you saved the downloaded Caliber installation.

3. Click Install Caliber Author and Utilities.

4. Click Caliber SDK or Caliber SDK for 64-bit. The Caliber Install Wizard starts and the Welcomescreen displays.


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



9. Click Next. The Setup Type screen displays.

10.Select an option for installing the SDK:

• Complete: This option installs both the COM SDK and the Java SDK and all associated files. Go tostep 15.

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

11.If you chose Complete:

a) Click Next. The Ready to Install the Program screen displays.b) Click Install. The installation begins.

12.If you chose Custom:

a) Click Next. The Custom Setup screen displays.

a) Click the install state icon for a component.

a) Choose the installation option you want for each component.

You can click Help for information about each install state.b) Click Space to see a list of the disk space requirements for each component.c) Click Change if you want to change the location where the component is installed. The default install

location is C:/Program Files/Borland.

Installing Caliber Author and Components | 11

d) Click Next. The Ready to Install the Program screen displays.e) Click Install. The installation begins.

13.When installation completes, click Finish.

14.Restart the system.

Note: For more information on the SDK, see Caliber SDK Programmers’ Guide or the Javadoc locatedat Program Files\Borland\Caliber SDK\api\index.html. Sample SDK applications areposted on the Micro Focus SupportLine site.


Installing Caliber ReviewCaliber Review provides a convenient and accessible place to review projects, requirements, traces, anddiscussions. You can easily navigate the interface from a Web browser or mobile device, allowing real-timecollaboration and feedback in the earliest stages of planning and development. This encourages cross-team collaboration and involvement from all stakeholders in the early stages of an Agile cycle.

The installation automatically sets connection to the CaliberData Server localhost:20000. If you haveinstalled the Data Server on another location, change the settings in the configuration utility afterinstallation is complete. For more information, see Changing Caliber Review Server

1. Run Caliber-Review.exe from the location you saved the downloaded Caliber installation.

2. Click Install Caliber Review. The Welcome screen appears.

3. Click Next. The Choose Install Folder screen appears.

4. Click Next to accept the default installation folder or click Choose to navigate to a custom installationfolder. The License Agreement screen appears.

5. Accept the terms and click Next. If you do not accept the terms, the installation quits. The Pre-Installation Summary screen appears.

6. Click Install. The Caliber Review installs.

Changing Caliber Review ServerTo connect to a different Caliber Data Server:

1. Stop the Caliber Review Service.

2. Choose Start > All Program > Caliber > Caliber Review > Review Configuration Utility and run asAdministrator.

3. Change the address and port number.

4. Save the changes.

5. Restart the Caliber Review Service.

Enabling SSL for Caliber ReviewBy default, SSL is disabled. To enable SSL communication, you must obtain a digital certificate that uses atrusted certificate authority (CA) as the root certificate authority.

Note: For more information, refer to the Apache Tomcat SSL configuration documentation: http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html.

If you use the untrusted certificate that is installed with Caliber Review, you will have to accept theuntrusted certificate in your Web browser.

To enable SSL: .

1. Stop the Caliber Review Service.

2. Edit server.xml located in <install directory>/conf.

3. Comment the following section:

<Connector connectionTimeout="20000"port="11012" protocol="HTTP/1.1"redirectPort="11082"/>

Installing Caliber Review | 13

http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html

http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html

4. Uncomment the following section:

<Connector port="11082" minSpareThreads="5" maxSpareThreads="75" protocol="org.apache.coyote.http11.Http11Protocol" enableLookups="true" disableUploadTimeout="true" acceptCount="100" maxThreads="200" scheme="https" secure="true" SSLEnabled="true" keystoreFile="conf/CaliberReview.keystore" keystorePass="caliber" clientAuth="false" sslProtocol="TLS"/>


6. Restart the Caliber Review Service.

7. In your browser, navigate to the secure IP address or URL provided for your workspace.

a) Type https to indicate the hypertext transfer protocol for secure access.b) Type 11082 for the port number.

For example, a secure access URL looks like https://localhost:11082/caliberreview.

If using the Micro Focus certificate or another untrusted certificate, a page appears and displays amessage indicating the certificate is untrusted. If you are using a trusted certificate, no warning pageappears and you are taken directly to the Log On page.

8. Accept the page to acknowledge the risk of an untrusted certificate and proceed to the Log On page.

Configuring Cache for Caliber ReviewCaliber Review uses caching to efficiently retrieve Projects and Filters. With caching enabled, the CaliberReview server will query the Caliber Data Server every 10 minutes. With caching enabled users will notsee new Projects and Filters in Caliber Review for up to 10 minutes. In a small installation (approximately20 projects/filters), caching may not provide much benefit or the users may want to see Projects and Filterscreated immediately.

To disable caching the administrator:

1. Stop the Caliber Review service.

2. Edit webViewer.properties (default directory is dir\lib\review.properties) in a text editor.

3. Change "useCache.projectList=true" to be "useCache.projectList=false".

4. Change "useCache.filterList=true" to be "useCache.filterList=false".


6. Restart the Caliber Review service.

By disabling caching, users may notice the project list and the filter lists takes longer to retrieve. However,they will see Projects and Filters immediately after they have been created.

14 | Installing Caliber Review

Configuring Caliber Review to useWindows Session Credentials

Caliber Review provides the ability to leverage a user's Windows Session Credentials to enable automaticlogin. By default, Caliber Review is not configured for Windows Session Credentials. This support requiresthe following steps to be enabled:

• Configure the Caliber Data Server to support Windows Session Credential authentication. Directionsare available in the Enabling Windows Session Credentials topic of the Caliber help.

• Create the keytab file for the Caliber Review server to support Kerberos Authentication. See Creating aKerberos Keytab.

• Create a Kerberos configuration file. See Creating a Kerberos Configuration File.• Configure Caliber Review server to enable Windows Session Credentials. See Configuring Caliber

Review server to enable Windows Session Credentials.• Configure each user's web browser to enable Windows authentication. See Configuring Windows

Browser.

The Kerberos administrator should deliver four items to the Caliber Review administrator, which arecovered in the topics that follow:

• Kerberos keytab file• Kerberos configuration file• Kerberos SPN• Kerberos encryption type

Creating a Kerberos KeytabIn order to authenticate Caliber Review, you must create a Kerberos keytab file from your Kerberos server.

To generate a Kerberos keytab file from MS Active Directory:

1. Create a normal user account (for example, caliber-review ) which will become the serviceprincipal. Deactivate the option User must change password at next logon and activate Passwordnever expires.

Note: Do not change password after first setting or kvno will need to be incremented by 1 when creatingkeytab file.

2. On the Caliber Review server, navigate to Services > Caliber Review > Properties > Log on andconfigure Caliber Review server to run under the newly created user account.

3. Create a client SPN (for example, HTTP/review-server.example.com:11012).

You will use the utility (e.g., "setspn.exe") to create an SPN to associate with this new user account.

4. Open a command prompt.

5. Type the command: ktpass /princ HTTP/review-server.example.com:[email protected] /mapuser caliber-review /crypto AES256-SHA1 /ptypeKRB5_NT_PRINCIPAL /kvno 0 /pass hidden /out C:\temp\<name>.keytab.

Note: example.com and EXAMPLE.COM are the AD realm for your AD domain; review-serveris the name of the machine on which Caliber Review server will run; it must be on the domain;caliber-review is the user assigned to run Caliber Review service; HTTP/review-server.example.com:PORT NUMBER is the service principal name (SPN); AES256-SHA1 is

Configuring Caliber Review to use Windows Session Credentials | 15

the Kerberos encryption type. <name> is file name for the generated keytab. Update each to matchyour needs according to your corporate standards.

Note: The Kerberos Advanced Encryption Standard (AES) encryption options (both the 128-bitoption and the 256-bit option) are available only when the domain functional level is set toWindows Server 2008 R2, Windows Server 2008, or Windows Server 2003. AES is a newencryption algorithm that has been standardized by the National Institute of Standards andTechnology (NIST). For more information about Kerberos authentication, see Kerberos Explained(http://go.microsoft.com/fwlink/?LinkId=85494 ).

You can reference the section "Creating service principal with Microsoft Windows 2008 Server" onthe page

http://spring.io/blog/2009/09/28/spring-security-kerberos-spnego-extension

Give the generated keytab file (e.g., review-server.keytab) and the SPN (e.g., HTTP/review-server.example.com ) to Caliber Review administrator. Give Caliber Review administrator the usedKerberos encryption type, as well.

Creating a Kerberos Configuration FileThe Kerberos server/AD server administrator must create a Kerberos configuration file.

Create a Kerberos configuration file:

1. Create a Kerberos configuration file named krb5.conf.

2. Place the following code in the krb5.conf file:

[libdefaults] default_realm = EXAMPLE.COM default_tkt_enctypes = aes256-cts rc4-hmac des3-cbc-sha1 des-cbc-md5 des-cbc-crc default_tgs_enctypes = aes256-cts rc4-hmac des3-cbc-sha1 des-cbc-md5 des-cbc-crc permitted_enctypes = aes256-cts rc4-hmac des3-cbc-sha1 des-cbc-md5 des-cbc-crc

[realms] EXAMPLE.COM = { kdc = dc-server.example.com default_domain = example.com}

[domain_realm] .example.com = EXAMPLE.COM example.com = EXAMPLE.COM

Note: example.com is your domain name. Substitute it with your appropriate domain value.EXAMPLE.COM is your realm name. Substitute it with your appropriate realm value. kdc providesthe name of a host running a Kerberos Key Distribution Center (KDC) for that realm. Substitute itwith your appropriate host name.

3. Give the krb5.conf file to the Caliber Visualize or Caliber Review administrator.

Configuring Caliber Review Server to Enable WindowsSession Credentials

The Caliber Review administrator must configure the following in order to enable Windows sessioncredential logon.

16 | Configuring Caliber Review to use Windows Session Credentials

http://go.microsoft.com/fwlink/?LinkId=85494


1. Open the web.xml file from <install directory>\Borland\Caliber Review\webapps\caliberreview\WEB-INF\web.xml in a text editor.

2. Change /WEB-INF/applicationContext-security.xml to /WEB-INF/applicationContext-security-iwa.xml

3. Save the file.

4. Open the webViewer,properties file from <install directory>\Borland\Caliber Review\lib\webViewer.properties in a text editor.

5. Change the value of authentication.use.iwa from false to true.

6. Save the file.

7. Get the service principal name (SPN) for your Caliber Review server (for example, HTTP/review-server.example.com), keytab file (for example, review-server.keytab), and Kerberosconfiguration file (for example, krb5.conf) from the Kerberos server administrator.

8. Save the two files to your Kerberos folder. For example, C:\krb5.

9. Open <install directory>\Borland\Caliber Review\webapps\caliberreview\WEB-INF\applicationContext-security-iwa.xml in a text editor.

10.Replace HTTP/review-server.example.com with the SPN that you get in < beans:propertyname="servicePrincipal" value="HTTP/review-server.example.com:11012" />.

11.Replace C:/krb5/review-server.keytab with your full keytab file path in <beans:propertyname="keyTabLocation" value="file:C:/krb5/review-server.keytab"/>.

12.Replace C:/krb5/krb5.conf with your full krb5.conf file path in <beans:propertyname="krbConfLocation" value="C:/krb5/krb5.conf"/>.

13.Save the file.

14.Cipher suites that use AES_256 require installation of the JCE Unlimited Strength Jurisdiction PolicyFiles. These policy files are not shipped with Sun JDK, they need to be downloaded separately. Youmust download and install these files if Kerberos encryption type used to generate the keytab file isAES256.

a) Download UnlimitedJCEPolicyJDK7.zip from http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html.

b) Unzip the file.c) Copy local_policy.jar and US_export_policy.jar to replace the files with the same names

at <install directory>\Borland\Caliber Review\jre\lib\security.

15.Restart Caliber Review service.

Configuring Windows BrowserCaliber Review and Caliber Visualize Windows Session Credentials are supported for Firefox, Chrome, andSafari, as well as Internet Explorer.

Configure each users Windows Internet options to accept Windows authentication for Caliber Review andCaliber Visualize.

For Internet Explorer:

1. Open Internet Options from the Tool menu.

2. Click the Security tab.

3. Click Local Intranet.

4. Click Sites.

5. Click Advanced.

6. Type the Caliber Review URL (for example, review-server.example.com or http://review-server.example.com) in the Add this site to the zone field or type the Caliber Visualize URL (for


http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html


example, visualize-server.example.com or http://visualize-server.example.com) inthe Add this site to the zone field.

If using both Caliber Review and Caliber Visualize, add both URLs to this field.

7. Click Add.

8. Close dialogs until you are back to Internet Options.

9. Click Advanced tab.

10.Check Enable Integrated Windows Authentication located in the Security group.

11.Close Internet Options.

For Firefox:

1. Start Firefox.2. Type about:config in the address field.3. Choose the network.negotiate-auth.trusted-uris parameter.4. Set this value to the domain or machine name (i.e., review-server.example.com or visualize-

server.example.com) that you want to activate Negotiate.

For Chrome:

Additional configuration is not required

For Safari:


Notes:

Note: Make sure that you use the full qualified domain name (not the IP address and not the shortname) in your URL, like http://review-server.example.com:11012/caliberreview/ orhttp://visualize-server.example.com:11002/calibervisualize/.

Note: Browsers and Caliber Review Server/Caliber Visualize Server must be on different machines,because otherwise Windows will use NTLM instead of Kerberos.

Note: If you use Windows Session Credentials to log onto Caliber Review or Caliber Visualize usingInternet Explorer from a shared machine, close the browser after you log out of Caliber Review orCaliber Visualize.

You can reference http://spring.io/blog/2009/09/28/spring-security-kerberos-spnego-extension.

Restoring Review Server to non-Windows SessionCredentials Mode

To restore logon to standard Caliber Review user logon:

1. Open <install directory>\Borland\Caliber Review\webapps\caliberreview\WEB-INF\web.xml in a text editor.

2. Change /WEB-INF/applicationContext-security-iwa.xml to /WEB-INF/applicationContext-security.xml.

3. Save the file.

4. Open <install directory>\Borland\Caliber Review\lib\webViewer.properties in atext editor.

5. Change the value of authentication.use.iwa from true to false. For example,authentication.use.iwa=false.

6. Save the file.

18 | Configuring Caliber Review to use Windows Session Credentials


7. Restart Caliber Review service.


Installing Caliber VisualizeThis section describes how to install the Caliber Visualize component.

Introduction to Caliber VisualizeCaliber Visualize is a platform that combines interactive software simulation with Caliber's traditionalrequirements management.

Interactive simulations bring software requirements to life, greatly improving the quality and accuracy ofrequirements managed throughout the lifecycle. They can be shared with technical and non-technicalstakeholders early in the project lifecycle to ensure a thorough understanding of business needs andgreatly improve the quality of the requirements defined. Caliber Visualize combines interactive simulationswith Caliber's traditional requirements management to ensure that change is managed throughout thelifecycle and keeps everyone in synch with the business goals and needs.

Caliber Visualize is a Web-based and server-based, browser-independent application that runs in mostWeb browsers. Caliber Visualize is based on Adobe™ Flash® technology to provide a fast interfaceresponse.

The following sections provide instructions to install the Caliber Visualize on your system.

Note: Caliber Visualize, the code base has been internationalized to work with UTF-8 special ASCIIcharacters for German, Japanese, and French. Non-supported areas are path names, file names, orcolumn headings in tables. If you need assistance with UTF-8 characters, contact Customer Support.

Installing Caliber Visualize OverviewCaliber Visualize uses an installation wizard to assist you with application installation on your Windowssystem. Caliber Visualize is installed as a Windows service. The service is configured to startautomatically.

The executable file that starts the installation wizard might be accessed in several different ways. You couldaccess the installer from a link or from a location on a server where software installation files are availablefor download. If you need assistance with the type of installation you will have, contact your salesprofessional for details.

Caliber Visualize can be installed on a Windows server with or without Caliber. However, in order to runCaliber Visualize, you must have a Caliber Data Server connection. The installation automatically setsconnection to the Caliber Data Server localhost:20000. If you have installed the Caliber Data Serveron another location, change the settings in the configuration utility after installation. For more information,see Changing the Caliber Data Server Settings.

The installation wizard proceeds through each installation step with recommended default choices forlocations and other information. It is recommended that you install the files at the default location as shownin the installer. The path that is suggested might vary depending upon the operating system.

Important: Starting the server for the first time might take several minutes to complete. While theserver is starting, you may see a progress message. In the event that the server does not start, wait afew minutes before performing the Starting or Stopping the Service procedure. If that does not work,contact customer support.

20 | Installing Caliber Visualize

Installing and Integrating with Caliber OverviewThe following sections provide information you need to successfully install Caliber for use with CaliberVisualize. For specific guidance about installing, updating, or configuring Caliber, refer to the Caliber Help,or contact your sales engineering professional for assistance.

Requirements for the Caliber IntegrationCaliber and Caliber Visualize Installation

Installing Caliber Visualizeand Caliber on the samecomputer

If you want to install Caliber Visualize and Caliber on the same computer,you must install the Caliber Data Server, Caliber Author, and the MPXservices before installing Caliber Visualize.

Installing Caliber Visualizeand Caliber on differentcomputers

After installing Caliber Visualize, you can access the CaliberConfiguration utility and change the server settings to point to thedesired Caliber Data Server. For more information, see Changing theCaliber Data Server Settings.

User Privileges

The following conditions apply to user privileges that are required when Caliber Visualize is installed to usejointly with Caliber.

• To create a new project in Caliber Visualize, the Caliber Visualize user must be a member of the CaliberAdministrator's group.

• To work in an existing Caliber Visualize project, the user must be a member of a Caliber group that isassigned to the existing Caliber project. The user can view the same projects in Caliber Visualize andCaliber.

• The Caliber Visualize user who is a member of a Caliber group assigned to a Caliber project has fullaccess (create, read, update, and delete) to all Caliber Visualize assets.

Caliber-related Services

When you install Caliber, you must select the StarTeam MPX message broker. The MPX message brokerprovides important services for the Caliber Visualize - Caliber integration. MPX provides a method topublish events.

Important: Requirements and other project assets will not update properly between the two productsif the MPX message broker on the Caliber Data Server.

Installing and Integrating with CaliberInstall Caliber completely before installing Caliber Visualize.

Close all other applications before beginning the installation.

1. Double-click caliber-visualize.exe to start the installation:

Note: If you see an Open File - Security Warning dialog box, click Run.

The Introduction page appears.

2. On the Introduction page, click Next. The Choose Install Folder page appears.

3. Click Next to select the default folder for the installation directory.

Important: It is recommended that you accept the default directory as listed for your operatingsystem.

The License Agreement page appears.

Installing Caliber Visualize | 21

4. Review the license agreement text. When you understand and agree to the terms, click the I accept theterms of the License Agreement option button, and then click Next.

Remember: If you do not accept the terms of the license agreement, you cannot continue theinstallation.

5. In the Pre-Installation Summary, check the installation location. Is the installation location correct?

• If yes, proceed to the next step.• If no, click Cancel to quit the installer. Stop and make the necessary adjustments and return to the

installer at a later time.

6. Check the amount of available disk space. Is there an adequate amount of disk space available for thestated Caliber Visualize requirements?

• If yes, proceed to the next step.• If no, click Cancel to quit the installer. Stop and make the necessary adjustments and return to the

installer at a later time.

7. Click Install. The Installing Caliber Visualize page appears and shows the progress indicator.

Note:

If you have a Caliber Visualize database installed from a previous release, a prompt appearsasking you if you want to migrate the database. For more information, see Upgrading from aPrevious Release.

8. When the Install Complete page appears, the wizard displays a confirmation message.

9. Select an option to either automatically restart your system or wait until later, and then click Done. Theinstallation wizard closes indicating the installation is complete.

Note: To change the default Caliber Visualize server TCP/IP port numbers to avoid conflicts withother applications running on the same server port or to comply with your company's Webapplication standards, see Changing the Default Server TCP/IP Port Numbers.

After the installation completes, you can reconfigure Caliber settings using the Caliber Configuration utility.To access this utility, choose Start > All Programs > Borland > Caliber Visualize > CaliberConfiguration.

Note: To change the default Caliber Visualize server TCP/IP port numbers to avoid conflicts withother applications running on the same server port or to comply with your company's Web applicationstandards.

Configuring the Appearance of Assets in CaliberVisualizeThe following paragraphs describe changes you can make in the Windows registry to configure howCaliber Visualize assets appear in Caliber. These settings are optional.

For specific guidance about installing, updating, or configuring Caliber, refer to the Caliber Help.

Caliber Registry Settings

A registry key is set in Windows that determines which Caliber Visualize assets display in the CaliberRequirements Grid, Doc Factory Reports, and in other areas. Some companies may want to customizedwhich assets are visible when Caliber Visualize is used with Caliber.

Caution: Be aware that editing the registry is a highly technical task and should be assignedaccordingly. It is strongly suggested that you back up the registry before changing the settings.

In the registry location: HKEY_LOCAL_MACHINE\SOFTWARE\Borland\CaliberRM\11.5\Server, youcan add the following registry entry to configure how Caliber Visualize assets appear in Caliber:

• DWORD simRequirements = 0 (default value)


• 0 = Only Caliber Visualize notes

• 1 = Caliber Visualize notes and visualization assets (including all childobjects like steps)

• 2 = All Caliber Visualize assets

Starting or Stopping the ServiceDepending on your Windows configuration, administrator permission on your system might be required tocomplete this task.

Caliber Visualize is installed as a service in Windows. The service is configured to start automatically whenyour system starts. This procedure describes how to stop and restart the service.

1. Click Start and choose Administrative Tools > Services. The Services window opens and displaysthe entry Caliber Visualize Server for the Caliber Visualize service.

2. Right-click the service, and then select Start to start the service or Stop to stop the service. Theservice starts or stops depending on the command chosen.

Enabling SSL CommunicationCaliber Visualize supports SSL communication. To enable SSL communication, you must obtain a digitalcertificate that uses a trusted certificate authority (CA) as the root certificate authority.

Note: For more information, refer to the Apache Tomcat SSL configuration documentation: http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html

To test Caliber Visualize's SSL support, you can use the untrusted (CA) that is installed with CaliberVisualize.

Note: You must use FireFox to test Caliber Visualize's untrusted (CA).

1. Edit the server.xml file in \Borland\Caliber Visualize\conf to activate the definition for theconnection on port 11081.

2. In your browser, navigate to the secure IP address or URL provided for your workspace:

a) Type HTTPS to indicate the hypertext transfer protocol for secure access.b) Type 11081 for the port number.

An example secure access URL is https://localhost:11081/calibervisualize .

A page appears and displays a message indicating the certificate is untrusted.

3. Accept the option to acknowledge the risk of an untrusted certificate and proceed to the Log Onwindow.

4. Type your user name in the Username box.

5. Type your password in the Password box.

6. Click Log On. The Loading message appears. When the product finishes loading, the mainworkspace opens in the browser window.

Changing the Default Server TCP/IP Port NumbersThis topic describes how to change the default Caliber Visualize server TCP/IP port numbers to avoidconflicts with other applications running on the same server ports or to comply with your company's Webapplication standards.

1. Install Caliber Visualize.

2. Open the file server.xml. This file is located in the following location of the Caliber Visualizeinstallation folder:


C:\Program Files\Borland\Caliber Visualize\conf\server.xml

3. Change the port number for all instances of the following default Caliber Visualize server ports:

• Http port: 11002• Https port: 11081• Tomcat shutdown port: 11001• Load balancing AJP 1.3 port: 11003

4. Restart the Caliber Visualize service.

Changing the Caliber Data Server SettingsIf you move the Caliber Data server after integrating with Caliber Visualize or if you did not install on thelocal machine and would like to change the settings to point to the new location, you can update theintegration using the Caliber Configuration utility. This utility allows you to reconfigure the integrationsettings to point to the new Caliber Data Server location.

1. Choose Start > All Programs > Borland > Caliber Visualize > Caliber Configuration. The CaliberConfiguration utility appears.

2. Update the server location settings, and then click OK. The Caliber Visualize integration configurationfile is updated with the new Caliber Data Server location settings. You do not have to restart CaliberVisualize after changing the Caliber server settings.

Uninstalling1. Click Start and select All Programs > Borland > Caliber Visualize > Uninstall Caliber Visualize. The

Uninstall Caliber Visualize wizard opens.

2. Click Next. The Uninstall Caliber Visualize window opens and displays the following message:

About to uninstall...

3. Click Next. The uninstalled wizard removes the application components. When uninstall is complete,the following message appears:

All items were successfully uninstalled.

4. Click Done. Caliber Visualize is uninstalled and the wizard closes.

Logging on toCaliber Visualize installs a default administrator account for the full version of the product.

Logging on as an Administrator for the First TimeThis first-time logon procedure is for Caliber Visualize administrators who are using either the 30-day trialversion or the full version of Caliber Visualize.

Important: After the Caliber Visualize installation is complete, the Caliber Visualize server might takeseveral minutes to start the first time. As a result, the URL might not be available immediately after theinstallation completes. If the service does not start, wait a few minutes and restart the service. If theservice does not start, contact customer support for assistance.

1. In your browser, navigate to the IP address or URL configured to access Caliber Visualize. The Log Onwindow opens in the browser.

2. Type the default user name as admin in the Username box.

3. Type the default password as admin in the Password box.


4. Click Log on.

Application Startup Troubleshooting GuideThis topic contains a table with startup error messages and their solutions.

The following tables provide possible causes of various error messages that you might receive whenstarting Caliber Visualize.

Note: The Caliber Data Server table addresses integration issues with Caliber.

Table 1: Caliber Data Server

Message Possible Causes

The Caliber Visualize server is unable to connect to theCaliber Data server. Please report this message to yourCaliber administrator.

1. Caliber Data Server is down.

2. Caliber Data Server is not compatible with this versionof the Caliber API (SDK).

3. The Caliber Data Server address or port is incorrect.

Caliber user ID provided for the startup of the CaliberVisualize server is not assigned a valid license. Pleasereport this message to your Caliber administrator.

The user has no available license.

The Caliber user ID provided for the startup of the CaliberVisualize server is not authorized. Please report thismessage to your Caliber administrator.

The user is not authorized.

The Caliber user ID provided for the startup of CaliberVisualize server is not properly specified. Please reportthis message to your Caliber administrator.

The userID or password is invalid.

The account of the Caliber user ID provided for thestartup of Caliber Visualize server is disabled. Pleasereport this message to your Caliber administrator.

The user's account is disabled.

The Caliber user ID provided for the startup of CaliberVisualize server is not properly specified. The passwordmust be reset in Caliber. Please report this message toyour Caliber administrator.

The user must change password.

The Caliber user ID provided in startup of CaliberVisualize server script is associated with an expiredlicense.

The user's license has expired. See Converting a TrialLicense to a Full Access License.

MPX support was not enabled. Please report thismessage to your Caliber administrator.

MPX is not enabled.

MPX support was enabled, but the Caliber Visualizeserver failed to connect to the MPX server. Please reportthis message to your Caliber administrator.

MPX broker name and/or broker port are incorrect.


Table 2: Flex Messaging Service

Message Possible Causes

The Caliber Visualize is unable to initialize theFlexMessaging required for UI presentation. Pleasereport this message to your Caliber administrator.

Check if services-config.xml and messaging-config.xml are missing from install_root\CaliberVisualize\webapps\caliberrdm\WEB-INF\flex.


Configuring Caliber Visualize to useWindows Session Credentials

Caliber Visualize provides the ability to leverage a user's Windows Session Credentials to enable automaticlogin. By default, Caliber Visualize is not configured for Windows Session Credentials. This supportrequires the following steps to be enabled:

• Configure the Caliber Data Server to support Windows Session Credential authentication. Directionsare available in the Enabling Windows Session Credentials topic of the Caliber help.

• Create the keytab file for the Caliber Visualize server to support Kerberos Authentication. See Creatinga Kerberos Keytab.

• Create a Kerberos configuration file. See Creating a Kerberos Configuration File.• Configure Caliber Visualize server to enable Windows Session Credentials. See Configuring Caliber

Visualize server to enable Windows Session Credentials.• Configure each user's web browser to enable Windows authentication. See Configuring Windows

Browser.

The Kerberos administrator should deliver four items to the Caliber Visualize administrator, which arecovered in the topics that follow:

• Kerberos keytab file• Kerberos configuration file• Kerberos SPN• Kerberos encryption type

For Caliber Administrator

In order for the links for Caliber Visualize in Caliber Author and Caliber Review to use Windows SessionCredential authentication, make sure that you use the full qualified domain name (not the IP address andnot the short name) for the Visualize URL, like http://visualize-server.example.com:11002/calibervisualize/ , when configuring Caliber Visualize projects from Caliber Administrator Tool.

Creating a Kerberos Keytab for Caliber VisualizeIn order to authenticate Caliber Visualize, you must create a Kerberos keytab file from your Kerberosserver.

To generate a Kerberos keytab file from MS Active Directory:

1. Create a normal user account (for example, caliber-visualize ) which will become the serviceprincipal. Deactivate the option User must change password at next logon and activate Passwordnever expires.

Note: Do not change password after first setting or kvno will need to be incremented by 1 when creatingkeytab file.

2. Create a client SPN (for example, HTTP/visualize-server.example.com:11002 ).

You will use the utility (e.g., "setspn.exe") to create an SPN to associate with this new user account.

3. Open a command prompt.

4. Type the command: ktpass /princ HTTP/visualize-server.example.com: [email protected] /mapuser caliber-visualize /crypto AES256-SHA1 /ptypeKRB5_NT_PRINCIPAL /kvno 0 /pass hidden /out c:\temp\<name>.keytab.

Configuring Caliber Visualize to use Windows Session Credentials | 27

Note: example.com and EXAMPLE.COM are the AD realm for your AD domain. visualize-server is the name of the machine on which Caliber Visualize server will run. It must be on thedomain. HTTP/visualize-server.example.com: PORT NUMBER is the service principalname (SPN). AES256-SHA1 is the Kerberos encryption type. <name> is file name for thegenerated keytab. Update them to match your needs according to your corporate standards.

Note: The Kerberos Advanced Encryption Standard (AES) encryption options (both the 128-bitoption and the 256-bit option) are available only when the domain functional level is set toWindows Server 2008 R2, Windows Server 2008, or Windows Server 2003. AES is a newencryption algorithm that has been standardized by the National Institute of Standards andTechnology (NIST). For more information about Kerberos authentication, see Kerberos Explained(http://go.microsoft.com/fwlink/?LinkId=85494 ).

You can reference the section "Creating service principal with Microsoft Windows 2008 Server" onthe page


Give the generated keytab file (e.g., visualize-server.keytab) and the SPN (e.g., HTTP/visualize-server.example.com:11002) to Caliber Visualize administrator. Give Caliber Visualize administrator theused Kerberos encryption type, as well.

Creating a Kerberos Configuration FileThe Kerberos server/AD server administrator must create a Kerberos configuration file.

Create a Kerberos configuration file:

1. Create a Kerberos configuration file named krb5.conf.

2. Place the following code in the krb5.conf file:

[libdefaults] default_realm = EXAMPLE.COM default_tkt_enctypes = aes256-cts rc4-hmac des3-cbc-sha1 des-cbc-md5 des-cbc-crc default_tgs_enctypes = aes256-cts rc4-hmac des3-cbc-sha1 des-cbc-md5 des-cbc-crc permitted_enctypes = aes256-cts rc4-hmac des3-cbc-sha1 des-cbc-md5 des-cbc-crc

[realms] EXAMPLE.COM = { kdc = dc-server.example.com default_domain = example.com}

[domain_realm] .example.com = EXAMPLE.COM example.com = EXAMPLE.COM

Note: example.com is your domain name. Substitute it with your appropriate domain value.EXAMPLE.COM is your realm name. Substitute it with your appropriate realm value. kdc providesthe name of a host running a Kerberos Key Distribution Center (KDC) for that realm. Substitute itwith your appropriate host name.

3. Give the krb5.conf file to the Caliber Visualize or Caliber Review administrator.

28 | Configuring Caliber Visualize to use Windows Session Credentials

http://go.microsoft.com/fwlink/?LinkId=85494


Configuring Caliber Visualize Server to Enable WindowsSession Credentials

The Caliber Visualize administrator must configure the following in order to enable Windows sessioncredential logon.

1. Open the web.xml file from <install directory>\Borland\Caliber Visualize\webapps\calibervisualize\WEB-INF\web.xml in a text editor.

2. Change /WEB-INF/applicationContext-security.xml to /WEB-INF/applicationContext-security-iwa.xml

3. Save the file.

4. Get the service principal name (SPN) for your Caliber Visualize server (for example, HTTP/visualize-server.example.com:11002), keytab file (for example, visualize-server.keytab), and Kerberos configuration file (for example, krb5.conf) from the Kerberos serveradministrator.

5. Save the two files to your Kerberos folder. For example, C:\krb5.

6. Open <install directory>\Borland\Caliber Visualize\webapps\calibervisualize\WEB-INF\applicationContext-security-iwa.xml in a text editor.

7. Replace HTTP/visualize-server.example.com with the SPN that you get in <beans:property name="servicePrincipal" value="HTTP/visualize-server.example.com:11002" />.

8. Replace C:/krb5/visualize-server.keytab with your full keytab file path in <beans:propertyname="keyTabLocation" value="file:C:/krb5/visualize-server.keytab"/>.

9. Replace C:/krb5/krb5.conf with your full krb5.conf file path in <beans:propertyname="krbConfLocation" value="C:/krb5/krb5.conf"/>.

10.Save the file.

11.Cipher suites that use AES_256 require installation of the JCE Unlimited Strength Jurisdiction PolicyFiles. These policy files are not shipped with Sun JDK, they need to be downloaded separately. Youmust download and install these files if Kerberos encryption type used to generate the keytab file isAES256.

a) Download UnlimitedJCEPolicyJDK7.zip from http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html.

b) Unzip the file.c) Copy local_policy.jar and US_export_policy.jar to replace the files with the same names

at <install directory>\Borland\Caliber Visualize\jre\lib\security.

12.Restart Caliber Visualize service.

Configuring Windows BrowserCaliber Review and Caliber Visualize Windows Session Credentials are supported for Firefox, Chrome, andSafari, as well as Internet Explorer.

Configure each users Windows Internet options to accept Windows authentication for Caliber Review andCaliber Visualize.

For Internet Explorer:

1. Open Internet Options from the Tool menu.




2. Click the Security tab.

3. Click Local Intranet.

4. Click Sites.

5. Click Advanced.

6. Type the Caliber Review URL (for example, review-server.example.com or http://review-server.example.com) in the Add this site to the zone field or type the Caliber Visualize URL (forexample, visualize-server.example.com or http://visualize-server.example.com) inthe Add this site to the zone field.

If using both Caliber Review and Caliber Visualize, add both URLs to this field.

7. Click Add.

8. Close dialogs until you are back to Internet Options.

9. Click Advanced tab.

10.Check Enable Integrated Windows Authentication located in the Security group.

11.Close Internet Options.

For Firefox:

1. Start Firefox.2. Type about:config in the address field.3. Choose the network.negotiate-auth.trusted-uris parameter.4. Set this value to the domain or machine name (i.e., review-server.example.com or visualize-

server.example.com) that you want to activate Negotiate.

For Chrome:


For Safari:


Notes:

Note: Make sure that you use the full qualified domain name (not the IP address and not the shortname) in your URL, like http://review-server.example.com:11012/caliberreview/ orhttp://visualize-server.example.com:11002/calibervisualize/.

Note: Browsers and Caliber Review Server/Caliber Visualize Server must be on different machines,because otherwise Windows will use NTLM instead of Kerberos.

Note: If you use Windows Session Credentials to log onto Caliber Review or Caliber Visualize usingInternet Explorer from a shared machine, close the browser after you log out of Caliber Review orCaliber Visualize.

You can reference http://spring.io/blog/2009/09/28/spring-security-kerberos-spnego-extension.

Restoring Caliber Visualize Server to non-WindowsSession Credential Mode

To restore logon to standard Caliber Visualize user logon:

1. Open <install directory>\Borland\Caliber Visualize\webapps\calibervisualize\WEB-INF\web.xml in a text editor.

2. Change /WEB-INF/applicationContext-security-iwa.xml to /WEB-INF/applicationContext-security.xml.

30 | Configuring Caliber Visualize to use Windows Session Credentials


3. Save the file.

4. Restart Caliber Visualize service.


Performing an UpgradeTo upgrade from Caliber 11.x to Caliber 11.5, start the installation media and install the components.Follow the wizard and choose to upgrade all installed components or select custom upgrade.

To upgrade from all other previous releases of Caliber, follow these instructions:

The Caliber upgrade procedure requires that you upgrade Caliber server first and only after that, upgradeCaliber Visualize and Caliber Author.

Closely follow the upgrade procedures documented in this guide to ensure that there is no data loss.

If you need to restore backups of Caliber databases made with a previous release of Caliber, you must firstrestore the database using the same version of Caliber used to perform the backup, then upgrade to the11.5 release (following the server upgrade section). Backup the database (under a new name not tooverwrite your original backup) following this release backup, and follow the restore procedure documentedin the online help.

Note: Caliber Administrator 11.5 can only administer an 11.5 server.

Data Server UpgradeThe user performing the upgrade of Caliber data server must be the Caliber database owner. That accountwill be listed as the creator when running dblist command from the command prompt.

Important: Make sure any BLS licenses are un-assigned from Caliber user profiles prior toperforming the upgrade. After the upgrade is complete and the new product version is installed, re-assign the licenses to the users. This can be done using the Caliber Administrator tool.

Upgrading Data Server from 11.x to 11.5There is no direct upgrade from 11.x to 11.5.

1. Back up data.

2. Uninstall the previous version of the Data Server.

3. Install Data Server 11.5.

4. Restore the backed up data.

Manually Upgrading Server ComponentsFor customized Caliber installations, such as the database server is not on the same computer as theCaliber server, contact Customer Support.

Important information for HP Quality Center customersYou must upgrade to a supported version of HP Quality Center before upgrading your Caliber server. Referto the release notes for a list of supported Quality Center versions.

32 | Performing an Upgrade

Upgrading Author Suite ComponentsImportant: Follow these steps closely to ensure a successful upgrade.

To upgrade from 11.x, perform the following:


2. Run caliber-authorsuite.exe from the location where you saved the downloaded Caliberinstallation. Click Client Install.

3. Click Caliber. The Caliber Install Wizard starts and the Welcome screen displays.


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



8. Select to upgrade components or select custom upgrade and click Next.

If performing a custom upgrade, click Next and select the components to upgrade. Then, click Nextagain.

9. Type the license key and click Next.

10.Select Author options and click Next.

11.Click Install. Click Cancel to cancel installation at any time. Setup begins installing files and displays astatus bar to show progress.

12.Click Finish to exit the Install Wizard. Setup displays the Caliber Author Installer Information screen.

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

You must restart your machine for the changes to take effect.

Information for Datamart UsersIf you use Microsoft Access as a backend database, note that during the upgrade, Caliber uninstalls theprevious version of Datamart. If you do not select the Datamart component during the upgrade, Calibersaves the rmmsa.mdb file from the previous release in the %USERPROFILE%\Local Settings\Application Data\Borland\Caliber\backup folder.

Upgrading Caliber ReviewThere is no direct upgrade for Caliber Review.

1. Save configuration data.

2. Uninstall previous version of Caliber Review.

3. Install Caliber Review 11.5.

4. Restore configuration data.

Program Maintenance1. To remove Caliber or any of the Caliber components, use the Windows Add/ Remove Programs

procedure:

Performing an Upgrade | 33

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

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

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

5. Click Add/Remove.

6. Click Next, then Remove.

7. Upon completion, click Finish.

If prompted, restart your machine for the changes to take effect.

34 | Performing an Upgrade

IndexA

accessing the install executable 20

C

Caliberintegration requirements 21

Caliber Reviewconfiguring 13configuring cache 14enabling SSL 13installing 13upgrading 33

Caliber Visualize for Windows 20Caliber Visualize server 20Caliber Visualize service

restarting 23starting 23

changing server settings 24configure

Caliber Visualize assets in Caliber 22

D

data serverinstalling 5

I

installCaliber Visualize 20, 21for Caliber 21instructions 21

installation wizard overview 20instructions to install 20introduction 20

K

Kerberosauthentication 15, 27creating configuration file 16, 28keytab 15, 27ticket 15, 27windows authentication 16, 28

L

log on

first time 24for administrators 24

logging onto Caliber Visualize for the first time 24

R

restartingthe Caliber Visualize service 23

Reviewbrowser configuration 17, 29Windows session credentials 15

S

secure login 23server

changing Caliber Review 13configuring Caliber Review 13

server componentsmanually upgrading 32

SSL 13SSL communication 23starting

the Caliber Visualize service 23

U

Uninstall wizard 24uninstalling

Caliber Visualize 24

V

Visualizebrowser configuration 17, 29Windows session credentials 27

W

Windows 20Windows authentication 17, 29Windows installation 20windows session credentials

configuring Review 16configuring Visualize 29

Windows session credentialsrestoring to Review logon 18restoring to Visualize logon 30

Index | 35

caliber 11 - supportline.microfocus.com · installing caliber author and components ..... 8...

Documents