IBM Rational Performance Tester, Version 8.1; IBM Rational Service Tester for SOA Quality, Version 8.1; IBM Rational Performance Tester Agent, Version 8.1

Installation Guide


Note

Before using this information and the product it supports, read the information in Notices.

First edition, July 2009

This edition applies to IBM Rational Performance Tester Version 8.1, IBM Rational Service Tester for SOA Quality Version 8.1, and IBM Rational Performance Tester Agent Version 8.1 and to all subsequent releases and modifications until otherwise indicated in new editions.

Copyright International Business Machines Corporation 2000, 2009.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

Installing IBM Rational Performance Tester, IBM Rational Service Tester for SOA Quality, and IBM Rational Performance Tester Agent
Product Overview
Installation overview
Installation conventions and terminology
Planning the installation
Installation Manager overview
Installation requirements
Installation considerations
Installing from the Setup disk
Starting the launchpad
Starting installation from the Setup disk
Install the product software
Installing Rational Performance Tester Agent on an AIX workstation
Uninstalling previous versions of Agent Controller
Configuring the operating system environment
Installing Rational Performance Tester Agent
Installing Rational Performance Tester Agent silently
Starting and stopping Agent Controller
Uninstalling Rational Performance Tester Agent
Uninstalling Agent Controller that has multiple references on a workstation
Installing Rational Performance Tester Agent on z/OS (OS/390)
Uninstalling previous versions of Agent Controller
Configuring the operating system environment
Installing Rational Performance Tester Agent
Starting and stopping Agent Controller on the z/OS (OS/390)
Uninstalling Rational Performance Tester Agent on the z/OS (OS/390)
Manage licenses
Licenses
License enablement
Enabling runtime licenses for testing
Purchasing licenses
Viewing license information for installed packages
Configuring Web-based help
Accessing Web-based help
Installing help content from an archive file
Downloading help content from the Local Help System Updater site
Updating help content
Removing help content
Setting up an intranet server for help content
Changing the way you access help content
Notices
Trademarks and service marks

Installing IBM Rational Performance Tester, IBM Rational Service Tester for SOA Quality, and IBM Rational Performance Tester Agent

This installation guide provides instructions for installing, updating, and uninstalling IBM® Rational® Performance Tester, IBM Rational Service Tester for SOA Quality, and IBM Rational Performance Tester Agent.

Note:
Before installing, you should consult the IBM Rational Performance Tester Release Notes for late-breaking installation issues.

Product Overview

Two independent products are covered by this installation guide: IBM Rational Performance Tester and the IBM Rational Service Tester for SOA Quality. The IBM Rational Performance Tester Agent is a tool for use with IBM Rational Performance Tester. It is included as part of the IBM Rational Performance Tester product kit. IBM Rational Performance Tester Agent is used to automate the load and scalability testing of server-based software applications by distributing the load generation to other computers. You can use Rational Performance Tester to ensure your software application will scale and perform to meet service-level agreements and production-level loads. You can increase load generation capacity by installing additional agents on remote computers.

Installation overview

Installation conventions and terminology

Understanding these terms and conventions can help you take full advantage of the installation information and your product.

The following conventions are used in this installation information:

These terms are used in the installation topics.

Installation directory
The location of product artifacts after the package is installed.
Package
An installable unit of a software product. Software product packages are separately installable units that can operate independently from other packages of that software product.
Package group
A package group is a directory in which different product packages share resources with other packages in the same group. When you install a package using Installation Manager, you can create a new package group or install the packages into an existing package group. Eclipse-based packages installed in the same package group are able to use the shell-sharing features of Eclipse. Some packages cannot share a package group, in which case the option to use an existing package group is unavailable.
Repository
A storage area for installable software packages. A repository can be disc media, a folder on a local hard disk, or a server or Web location.
Shared directory
In some instances, product packages can share resources. These resources are located in a directory that the packages share.

Planning the installation

Read all the topics in this section before you begin to install or update any of the features of your product. Effective planning and an understanding of the key aspects of the installation process can help ensure a successful installation.

Installation Manager overview

IBM Installation Manager is a program for installing, updating, and modifying packages. It helps you to manage the IBM applications, or packages, that it installs on your computer. Installation Manager also helps you to keep track of what you have installed, determine what is available for you to install, and to organize installation directories.

Installation Manager provides features that help you keep packages up to date, modify packages, manage the licenses for your packages, and uninstall packages.

Installation Manager includes six wizards that make it easy to maintain packages:

Installation requirements

Installation requires the correct hardware, software, server environment, operating systems, and user privileges for installing and running your software.

For the most up-to-date, detailed system requirements, see http://www.ibm.com/software/awdtools/tester/performance/sysreq/index.html for Rational Performance Tester and Rational Performance Tester Agent Controller, and http://www.ibm.com/software/awdtools/tester/service/sysreq/index.html for Rational Service Tester for SOA Quality.

Hardware requirements

Before you can install the product, verify that your system meets the minimum hardware requirements.

Hardware Requirements
Processor Minimum: 1.5 GHz Intel® Pentium® 4 (or higher for best results). For best results with large test runs, use a 2 GHz or higher Intel Pentium dual-core processor.
Memory Minimum for Rational Performance Tester and Rational Service Tester for SOA Quality: 768 MB of RAM; minimum for just the Agent Controller: 500 MB of RAM. For best results with large test runs, use 2 GB of RAM.
Disk space

Minimum: 1.5 GB of disk space for product package installation. Additional disk space for the resources that you develop.

Note:
  • Disk space requirements can be reduced or increased depending on the features that you install.
  • Additional disk space is required if you download the product package to install this product.
  • For Windows. Additional disk space is required if you use FAT32 instead of NTFS.
  • For Windows. An additional 500 MB of disk space is required in the directory that you specify in the environment variable TEMP.
  • For Linux. An additional 500 MB of disk space is required in the /tmp directory.
  • Large test runs can store several gigabytes of data. Make sure that you have adequate disk space before attempting a large test run.
Display 1024 x 768 resolution minimum using 256 Colors or higher for best results

For just the Agent Controller: 800 x 600 display minimum using 256 Colors or higher for best results

Other hardware Microsoft® mouse or compatible pointing device

Software requirements

Before you can install the product, verify that your system meets the software requirements.

Operating system

The following operating systems are supported for this product. Some 64-bit versions of operating systems are supported where noted. However, the Rational Performance Tester Agent Controller runs only in 32-bit mode on 64-bit operating systems.

Operating system Rational Performance Tester / Rational Service Tester Workbench Rational Performance Tester Agent Controller
AIX® 5.2 TL7 or later No Yes
AIX 5.3 TL3 or later No Yes
Red Hat Desktop 4 updates 1 through 7, includes 64-bit version running in 32-bit mode (on Intel platforms, not on pSeries or zSeries platforms) Yes Yes
Red Hat Enterprise Linux® 4 updates 1 through 7, includes 64-bit version running in 32-bit mode (on Intel platforms, not on pSeries or zSeries platforms) Yes Yes
Red Hat Enterprise Linux 5 update 2, includes 64-bit version running in 32-bit mode (on Intel platforms, not on pSeries or zSeries platforms) Yes Yes
SuSE Linux Enterprise Server Version 9.0 SP1 to SP4 (on Intel platforms, not on pSeries or zSeries platforms) Yes Yes
SuSE Linux Enterprise Desktop / Enterprise Server Version 10.0 to SP2 (on Intel platforms, not on pSeries or zSeries platforms) Yes Yes
Microsoft Windows® Server 2003 Enterprise/Standard Edition with Service Pack 1, 2, or 3, includes 64-bit version running in 32-bit mode Yes Yes
Microsoft Windows Server 2008 Yes Yes (see note)
Microsoft Windows XP with Service Pack 1, 2 or 3, includes 64-bit version running in 32-bit mode Yes Yes
Microsoft Windows Vista SP1 Yes Yes
z/OS® 1.4, 1.5, 1.6, 1.7, 1.8, 1.9 System Z No Yes (see note)
Note:

Java™ requirements for Rational Agent Controller on z/OS

Java 6 is required on the z/OS operating system. See http://www-03.ibm.com/servers/eserver/zseries/software/java/products/j6pcont31.html#j6getting for more information.

Software requirements for extending an installed Eclipse IDE

The products in this version of the IBM Rational Software Delivery Platform were developed for use with version 3.4, or later, of the Eclipse integrated development environment (IDE). You can only extend an existing Eclipse IDE of version 3.4 with latest updates from eclipse.org.

To extend an installed Eclipse IDE, you also require a Java runtime environment from one of these Java development kits:

Note:
You might need to update your Eclipse version in order to install updates to Rational Performance Tester. Refer to the release documentation of the update for information on changes to the prerequisite Eclipse version.

Supported virtualization software

Rational Performance Tester supports Citrix Presentation Manager Version 4 or 4.5, running on Windows Server 2003 Standard Edition or Windows Server 2003 Professional Edition. Although the client for Citrix Presentation Server is available on Linux, Rational Performance Tester does not support the Citrix extension on Linux.

Rational Performance Tester also supports Windows Terminal Server 2003 and later.

To reduce the likelihood of connection problems caused by firewalls between the workbench computer and the agent computers, locate the workbench computer and the agent computers on the same local network, and then use Remote Desktop to access the workbench computer. Do not use virtualized agent computers. Agent computers need full, real-time access to the hardware platform for accurate load generation and measurement.

Additional software requirements

User privileges requirements

You must have a user ID that meets the following requirements to install Rational Performance Tester, Rational Service Tester, Rational Performance Tester Agent.

Installation considerations

Part of planning entails making decisions about installation locations, working with other applications, extending Eclipse, upgrading, migrating, and configuring help content.

Installation locations

IBM Installation Manager retrieves product packages from specified repositories and installs the products into selected locations, referred to as package groups.

Package groups

During installation, you specify a package group into which to install a product.

Important:
When installing products on the Windows Vista operating system, do not create package groups in the Program Files directory (C:\Program Files\). Otherwise, users without Administrator privileges will be unable to use the product.

Shared resources directory

The shared resources directory is where product resources are installed so that they can be used by multiple product package groups. You define the shared resources directory the first time that you install the first product package. For best results, use your largest disk drive for shared resources directories. You cannot change the directory location unless you uninstall all product packages.

Important:
When installing products on the Windows Vista operating system, do not create the shared resources directory in the Program Files directory (C:\Program Files\). Otherwise, users without Administrator privileges will be unable to use the product.

Coexistence

Some products are designed to coexist and share functions when they are installed in the same package group. A package group is a location where you can install one or more software product packages.

Offering coexistence considerations

When you install each product package, you select whether you want to install the product package into an existing package group or whether you want to create a new package group. IBM Installation Manager blocks products that are not designed to share or do not meet version compatibility and other requirements. If you want to install more than one product at a time, the products must be able to share a package group.

Any number of eligible products can be installed to a package group. When a product is installed, the product functions are shared with all of the other products in the package group. If you install a development product and a testing product into one package group, when you start either of the products, you have both the development and testing functions available to you in your user interface. If you add a product with modeling tools, all of the products in the package group will have the development, testing, and modeling functionality available.

Upgrade and coexistence information

You cannot install the latest version of the product into an existing installation of the same product from the previous major release. If you have Agent Controller installed, you should uninstall it before attempting to install the latest version of the product. If you have the IBM Rational License Key Administrator installed, you should save its settings before attempting to install the latest version of the product.

Before you attempt to install the current version of Rational Performance Tester, you must uninstall Rational Performance Tester versions 7.0.2.3 and earlier. If you attempt to install the latest version of Rational Performance Tester, an error message is displayed indicating that you must uninstall the older version before proceeding. If you install Rational Performance Tester and Rational Service Tester into the same package group, you must install the same versions of both products. If you install into an existing instance of Eclipse, or if you install in the same package group as another product other than Rational Service Tester, streamlined Eclipse mode is not available. Only Full Eclipse mode is available.

Before you attempt to install Rational Performance Tester, you must uninstall any version of the Rational Agent Controller or TPTP Agent Controller from your computer. If you have other Rational products installed on your computer, you should uninstall any versions of Rational Agent Controller that were installed with those products. If you have a previous version of the Rational Agent Controller installed and you have instrumented a server for data collection, you must stop data collection and uninstrument the server first, and then uninstall Rational Agent Controller.

The current version of the product includes an updated version of the IBM Rational License Key Administrator (LKAD). The Installation Manager uninstalls any existing version of LKAD before installing the new version of LKAD, and LKAD settings are not preserved. Before you install the product, back up your LKAD settings. Start the LKAD by clicking Start -> Programs -> IBM Rational -> Rational License Key Administrator. The LKAD main window and wizard page open simultaneously. Click Settings to find the product settings. If you are comfortable editing the Windows Registry, you can back up and then restore the following Registry branches to back up your LKAD settings: HKEY_LOCAL_MACHINE\SOFTWARE\Rational Software\Licensing and HKEY_CURRENT_USER\Software\Rational Software\Licensing. For more information, see the LKAD help.

If you have the Rational License Server or Rational License Client installed, do not uninstall those packages. Uninstalling Rational License Server or Rational License Client might disable some of the Rational products on your computer or on other computers.

Installing with your Eclipse instance

The product package that you install using IBM Installation Manager comes with a version of Eclipse, which is the base platform of this product package. If you already have Eclipse installed on your workstation, you can add your product package directly to that Eclipse installation and extend the functions of the Eclipse integrated development environment (IDE).

Extending an Eclipse IDE adds the functions of the newly installed product, but maintains your IDE preferences and settings. Previously installed plug-ins are also still available.

In most cases, your current Eclipse IDE must be the same version as the Eclipse that the product you are installing uses. Installation Manager checks that the Eclipse instance that you specify meets the requirements for the installation package and helps you install the latest updates from eclipse.org, if necessary.

Important:
When installing products on the Windows Vista operating system, do not install Eclipse in the Program Files directory (C:\Program Files\). Otherwise, users without Administrator privileges will be unable to use the product.

Extending an existing Eclipse IDE

When you install the product package or packages, you can choose to extend an Eclipse integrated development environment (IDE) already installed on your computer by adding to the functions that your new product or products contain.

Any product package that you install using IBM Installation Manager is bundled with a version of the Eclipse IDE or workbench; this bundled workbench is the base platform for providing the functionality in the Installation Manager package. However, if you have an existing Eclipse IDE on your workstation, then you have the option to extend it, that is, add to the IDE the additional functionality provided in the product package or packages.

To extend an existing Eclipse IDE: in the Location page of the Install Packages wizard, select the Extend an existing Eclipse IDE option.

You might extend your existing Eclipse IDE, for example, because you want to gain the functionality provided in a product package, but you also want to have the preferences and settings in your current IDE when you work with the functionality from the product package. You also might want to work with plug-ins that you have installed that already extend the Eclipse IDE.

Your existing Eclipse IDE must be version 3.4 for the latest updates from eclipse.org to be extended. Installation Manager checks that the Eclipse instance you specify meets the requirements for the installation package.

Note:
You might need to update your Eclipse version in order to install updates for some products. Refer to the update release documentation for information on changes to the prerequisite Eclipse version.

Increasing the number of file handles on Linux workstations

For best product performance, increase the number of file handles above the default of 1024 handles.

About this task

Important:
Before you work with your Rational product, increase the number of file handles. Most Rational products use more than the default limit of 1024 file handles per process. A system administrator might need to make this change.

Exercise caution when using the following steps to increase your file descriptors on Linux. If the instructions are not followed correctly, the computer might not start correctly.

To increase your file descriptors:

  1. Log in as root. If you do not have root access, you will need to obtain it before continuing.
  2. Change to the etc directory
    Attention: If you decide to increase the number of file handles in the next step, do not leave an empty initscript file on your computer. If you do so, your computer will not start up the next time that you turn it on or restart.
  3. Use the vi editor to edit the initscript file in the etc directory. If this file does not exist, type vi initscript to create it.
  4. On the first line, type ulimit -n 30000. The point is that 30000 is significantly larger than 1024, the default on most Linux computers.
    Important:
    Do not set the number of handles too high, because doing so can negatively impact system-wide performance.
  5. On the second line, type eval exec "$4".
  6. Save and close the file after making sure you have completed steps 4 and 5.
    Note:
    Ensure that you follow the steps correctly. If this procedure is not completed correctly, your computer will not start.
  7. Optional: Restrict the number of handles available to users or groups by modifying the limits.conf file in the etc/security directory. Both SUSE Linux Enterprise Server (SLES) Version 9 and Red Hat Enterprise Linux Version 4.0 have this file by default. If you do not have this file, consider using a smaller number in step 4 in the previous procedure (for example, 2048). Do this so that most users have a reasonably low limit on the number of open files that are allowed per process. If you use a relatively low number in step 4, it is less important to do this. However, if you set a high number in step 4 earlier and you do not establish limits in the limits.conf file, computer performance can be significantly reduced.

    The following sample limits.conf file restricts all users, and then sets different limits for others afterwards. This sample assumes that you set handles to 8192 in step 4 earlier.

    *      soft nofile 1024
    *      hard nofile 2048
    root    soft nofile 4096
    root    hard nofile 8192
    user1   soft nofile 2048
    user1 hard nofile 2048

    Note that the * in the preceding example sets the limits for all users first. These limits are lower than the limits that follow. The root user has a higher number of allowable handles open, while number available to user1 is between the two. Make sure that you read and understand the documentation contained in the limits.conf file before making changes.

What to do next

For more information on the ulimit command, see the man page for ulimit.

Web-based help content

The Rational Performance Tester help system is configured to use remote help so that you can pull in content from the Web dynamically. With remote help, you always have the latest content available from within your product.

Your product is configured to use remote help. You can obtain help three ways. Accessing help from an ibm.com server on the Internet is the default. The other two ways to access help are from a local installation on your computer or from a Web application server installed on your corporate intranet. One of these options will be best for you, depending on your needs and situation:

Because your help system supports remote help, you can change your access decision any time. If you install multiple products together, you can use different locations for the help for each product, depending on installation footprint, frequency of use, and Internet policies. If Internet speed is an issue, a longer one-time download and local access might be preferable. Later help updates include only differences. If you are an administrator and you want users to access help content from an intranet server, see the Installation Manager information center for instructions on how to install the help WAR file on a server.

Quickstart for Web-based help content

What is web-based help content delivery and how to configure it.

Definitions

Remote help
Help content that can be accessed or downloaded from the ibm.com Web site.
Local help
Help content from your local computer after you download the content from the Web.
Intranet help
Help content from your intranet server. The content is initially downloaded from the Web.
Local help updater
When you use local or intranet help, this utility helps you download initial content or updated content from the Web.
Local help updater site
A Web site containing compressed files of the help contents of your product to be used to populate either local or intranet help when you do not have an Internet connection.
Remote help web site
The ibm.com site where the information center for your product is hosted. This site can be accessed from a browser or from the product help system.

Introduction

Your product offers help content on the Web and only a limited number of help topics are installed with the product. By default, your product connects to the Web and accesses help content directly from an information center. If you need to access the help when you are not connected to the Internet, you can download the help and access it locally. Alternatively, you can connect to an information center on an intranet server if your system administrator hosts an information center on an intranet server.

During installation, you can choose from three access options for help, but you can change the way get help content at any time:

The three help content options.

Accessing help content from the Web

You can access help content from the Web by using Remote Help. This method provides the smallest installation footprint and helps ensure that you have access to the most current information. This access method is selected by default during installation.

If you select this option, then you will be linked to your product information center through an ibm.com® Web site. You can access the Web-based help for the product only when you are connected to the Internet. When you are disconnected, you will have access to a limited number of help topics that are installed with the product.

Note:
You need to have an internet connection to use this help option.

Install the product with the default setting for help content and start the product. When you need help, click Help -> Help content. Nothing more is required.

Accessing help content from your local computer

To access help content on your local computer, you can first download help contents to your computer so that you can work while disconnected from the Internet. To download the help and use local help, complete these steps.

Important:
If you select this method, you must connect to an update site where you can choose the help content and features to download. The help is not automatically downloaded when you install the product. For disconnected users, the product comes with an update site in the form of a help archive file. If you are a disconnected user, see Installing help content from an archive file to learn how to install help from the archive file. Other update site files are available at http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/.

After you download the information center content that you need, it will be available when you work while disconnected. You can update the content when changes are available.

  1. Install using the Local Help option.
  2. Start the product and follow the steps in Downloading help content from the Local Help System Updater site.

Accessing help content from an intranet server

Depending on company support, you might be able to access help content from your internal intranet servers. This method assumes that your intranet administrator has set up a link to a server behind your firewall where product help content is installed. By selecting this option, you must provide the link to your intranet server. Administrators must make scheduled updates to the help content.

The administrator needs to perform the following steps:

  1. Follow the steps in Setting up an intranet server for help content.
  2. Download the help to the intranet server by following the steps in Downloading help content from the Local Help System Updater site
  3. Provide the following information to your users:

The user needs to perform the following steps:

  1. Install use the Intranet help option and use the information provided by your administrator to configure the help:
  2. Start the product.
  3. Click Window -> Preferences.
  4. Click Add; then name the intranet connection, specify the address for the intranet server that contains the help content, and then click OK.
  5. Click OK to close Preferences.

Whether you access Web-based help content, download and use help content locally, or connect to your intranet to get help, click Help -> Help content to open help topics and find solutions.

To change the way that your products access help content, see Changing the way you access help content.

Installing from the Setup disk

The Setup disk includes the launchpad program, which provides you with a single location to start the installation process.

About this task

Use the launchpad program to start the installation of software in these cases:

For products that are installed by IBM Installation Manager for the Rational Software Delivery Platform, starting the installation process from the launchpad program causes Installation Manager to be automatically installed if it is not already on your computer. Furthermore, the installation process is already configured with the location of the repository that contains the installation package. If you install Installation Manager separately, you must configure the repository preferences manually. Also, you can start the installation of a number of supporting software items from the launchpad.

If you want to install Rational Performance Tester as a non-Admin, you cannot use the launchpad program to start the installation process. Instead, you must manually run the userinst program from the Setup disk. Running the userinst program provides you with the same functionality as starting the installation of Rational Performance Tester from the launchpad.

Starting the launchpad

To start the launchpad, complete the following steps:

  1. If you are installing from the CDs, complete these steps:
    1. Insert the Setup CD into your CD drive.
    2. For Linux. Mount the CD drive.
    3. If autorun is enabled on your computer, the launchpad program starts automatically. If the launchpad does not start automatically, complete one of these steps:
      • For Windows. Run launchpad.exe, which is located in the root directory of the CD.
      • For Linux. Run launchpad.sh, which is located in the root directory of the CD.
  2. If you are installing from electronic disks downloaded from IBM Passport Advantage, open a command line and change to the directory where you extracted the disk images, and then do one of the following things:

Results

The launchpad program starts.

Starting installation from the Setup disk

If you want to install Rational Performance Tester as a non-Admin, you must manually run the userinst program from the Setup disk instead of running the launchpad program. Running the userinst program provides you with the same functionality as starting the product installation from the launchpad.

About this task

To start the installation from the Setup disk, complete the following steps:

  1. If you are installing from the CDs, do these steps:

    1. Insert the Setup CD into your CD drive.
    2. For Linux. Mount the CD drive.
    3. If autorun is enabled on your computer, the launchpad program starts automatically. Stop the launchpad program.
    4. In a command line, change to the root of the Setup disk and do one of the following things:
      • For Windows. As an Admin, Run InstallerImage_win32\install.exe.
      • For Windows. As a non-Admin Run InstallerImage_win32\userinst.exe.
      • For Linux. As an Admin, Run InstallerImage_linux/install.
      • For Linux. As a non-Admin, Run InstallerImage_linux/userinst.
  2. If you are installing from electronic disks downloaded from IBM Passport Advantage, open a command line and change to the directory where you extracted the disk images, and then do one of the following things:

Results

When the userinst or install program starts, Installation Manager is installed if it is not already on your computer. Furthermore, Installation Manager is configured with the location of the repository (installation files) for Rational Performance Tester.

Install the product software

These instructions can be used to install Rational Performance Tester, Rational Service Tester, and Rational Service Tester Agent.

About this task

By starting the installation process from the launchpad program, IBM Installation Manager is automatically installed if it is not already on your computer, and it starts preconfigured with the location of the repository that contains the product package. If you install and start IBM Installation Manager directly, then you must set repository preferences manually.

To learn how to install the product from a command prompt in silent mode, see the Installing Silently section of the IBM Installation Manager documentation at http://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp.

To install from the launchpad:

Important:
Installation notes for the Windows Vista operation system:

  1. Review the Installation considerations, if you have not done so already.
  2. If you are installing from compressed files, such as ZIP or ISO files, extract the files into a common directory. Extract the disk images to directories named /disk1,/disk2, and so on. Extract the Setup disk image to a directory named RPT_SETUP. The Setup disk contains the launchpad.
  3. If you are installing from a CD, insert the first product disc into your CD drive. If autorun is enabled on your workstation, then the launchpad will start autostart. Otherwise, start the launchpad program manually.
  4. Select a language in which to run the launchpad and Installation Manager. Click OK.
  5. Select the product to install from the launchpad menu. The Install Packages window opens.
  6. Click on a product package to highlight it. The description of the package is displayed in the Details pane at the bottom of the screen.
  7. To search for updates to the product packages, click Check for Other Versions and Extensions. If updates for a product package are found, then they will be displayed in the Installation Packages list on the Install Packages page below their corresponding product. Only recommended updates are displayed by default.
  8. Select the product package and any updates to the package that you want to install. Updates that have dependencies are automatically selected and cleared together. Click Next to continue.
    Note:
    If you install multiple packages at the same time, then all the packages will be installed into the same package group.
  9. On the Licenses page, read the license agreement for the selected package. If you selected more than one package to install, there might be a license agreement for each package. On the left side of the License page, click each package version to display its license agreement. The package versions that you selected to install (for example, the base package and an update) are listed under the package name.
    1. If you agree to the terms of all of the license agreements, click I accept the terms of the license agreements.
    2. Click Next to continue.
  10. On the Location page, type the path for the shared resources directory in the Shared Resources Directory field, or accept the default path. The shared resources directory contains resources that can be shared by one or more package groups. Click Next to continue.

    The default path is:

    Important:
    You can specify the shared resources directory only the first time that you install a package. Use your largest disk for this to help ensure adequate space for the shared resources of future packages. You cannot change the directory location unless you uninstall all packages.
  11. On the Location page, create a package group to install the product package into or if this is an update, use the existing package group. A package group represents a directory in which packages share resources with other packages in the same group. To create a new package group:
    1. Click Create a new package group.
    2. Type the path for the installation directory for the package group. The name for the package group is created automatically.

      The default path is:

      • For Windows. C:\Program Files\IBM\SDP
      • For Linux. /opt/IBM/SDP
    3. Click Next to continue.
  12. On the next Location page, you can choose to extend an existing Eclipse IDE already installed on your system, adding the functionality in the packages that you are installing. You must have Eclipse Version 3.4 with the latest updates from eclipse.org to select this option.
  13. On the Features page under Languages, select the languages for the package group. The corresponding national language translations for the user interface and documentation for the product package will be installed.
  14. On the next Features page, select the package features that you want to install.
    1. Optional: To see the dependency relationships between features, select Show Dependencies.
    2. Optional: Click a feature to view its brief description under Details.
    3. Select or clear features in the packages. Installation Manager will automatically enforce any dependencies with other features and display updated download size and disk space requirements for the installation.
    4. Optional: If you plan to collect response time breakdown data, select the IBM Rational Performance Tester Agent check box.
    5. When you are finished selecting features, click Next to continue.
  15. On the help system configuration page, select one of the following options and then click Next:

    To learn more about Web-based help, see Configuring Web-based help.

  16. On the Summary page, review your choices before installing the product package. If you want to change the choices that you made on previous pages, click Back and make your changes. When you are satisfied with your installation choices, click Install to install the package. A progress indicator shows the percentage of the installation completed.
  17. When the installation process is complete, a message confirms the success of the process.
    1. Click View log file to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.
    2. In the Install Package wizard, select whether you want the product to start when you exit.
    3. Click Finish to launch the selected package. The Install Package wizard closes and you are returned to the Start page of Installation Manager.
  18. If the Data Collection Infrastructure software is installed, follow these steps to enable the test server for data collection:
    1. From the Start menu, select IBM Software Delivery Platform -> IBM Rational Data Collection Infrastructure -> Application Server Instrumenter to open the instrumentation application.
    2. Click the Add Local button and select the type of application server that you have running on the server.
    3. Fill in the server type specific fields including the location of the server if required and click OK.
    4. Stop and start the server for the instrumentation to take effect.
    5. From the Start menu, select IBM Software Delivery Platform -> IBM Rational Data Collection Infrastructure -> Start Data Collection.
    Note:
    All Rational Performance Tester systems involved with the Data Collection Infrastructure must have the data collection software running for the transaction breakdown functionality to be available within the results of an Rational Performance Tester test schedule.
    Note:
    The Application Server Instrumenter or the instrumentServer.bat (or instrumentServer.sh) batch file can fail with a generic error message ("Error during install/uninstall") when instrumenting or uninstrumenting a server. If this occurs, you can find more information to help troubleshoot the error in the log files in the IBM Tivoli® common directory. On Windows, the default location of this directory is C:\Program Files\IBM\tivoli\common. On Linux, the default location of this directory is /var/ibm/tivoli/common. If the IBM Tivoli common directory is not in the default location, search for a path containing tivoli/common, or for any of these log files: trace-install.log, trace-ma.log, or trace-tapmagent.log.
    Note:
    For Websphere Application Server 6.x, if you create a new profile and then use the Application Server Instrumenter to instrument this profile without first starting WebSphere® Application Server, the Application Server Instrumenter will report that the server is instrumented and will request that you re-start the server manually. This message is incorrect; the server is not actually instrumented. To work around this problem:
    1. Close and then re-start Application Server Instrumenter.
    2. Select the entry you just added from the list of instrumented servers and click Remove.
    3. Restart WebSphere Application Server.
    4. Restart Application Server Instrumenter and use it to instrument the server.
    To avoid this problem, after creating a new profile, start the WebSphere Application Server profile manually. Then, use the Application Server Instrumenter to instrument the server.
  19. License the product.

Installing Rational Performance Tester Agent on an AIX workstation

The Rational Performance Tester Agent includes the Rational Agent Controller and the data collection infrastructure.

Note:
For Rational Performance Tester, the Agent Controller should be installed on Windows and Linux systems using the Installation Manager.

Uninstalling previous versions of Agent Controller

Note:
Before installing Agent Controller version 8.0, you must uninstall the previous version of Agent Controller:

When uninstalling Agent Controller V6.x or V7.x on AIX platforms, you will need to manually remove any residual files. To do this, stop the Agent Controller, uninstall it, and clean up any of the following files which may be left behind after uninstalling:

AIX:

$RASERVER_HOME/* (directory where Agent Controller is installed
/usr/lib/libLogAgent.so
/usr/lib/libhcbnd.so
/usr/lib/libhcclco.so
/usr/lib/libhccldt.so
/usr/lib/libhccls.so
/usr/lib/libhcclserc.so
/usr/lib/libhcclsert.so
/usr/lib/libhcclsm.so
/usr/lib/libhcjbnd.so
/usr/lib/libhclaunch.so
/usr/lib/libhcthread.so

Configuring the operating system environment

Execute the following commands to set the required environment variables:

PATH={path to java installation}/jre/bin:$PATH
export PATH
LIBPATH={path to java installation}/jre/bin: {path to java installation}/jre/bin/
    classic:$LIBPATH
export LIBPATH
Note:
After the environment variables have been set, the command "java -fullversion" can be used to verify the Java version.

Installing Rational Performance Tester Agent

  1. Log in as Administrator (or root).
  2. Change directory to the directory where you unzipped the installation files for the appropriate platform.
  3. Close all Eclipse platforms before continuing with the installation.
  4. Run setup.bin.
  5. Click Next on the welcome screen to proceed.
  6. Read the license agreement.
  7. Select I accept the terms in the license agreement and click Next to proceed.
  8. Specify the path where Agent Controller should be installed and click Next to proceed.
  9. Specify the path of the Java Runtime Environment (JRE) executable program java.exe or java which Agent Controller should be using. The JRE entered here will be used by Agent Controller for launching Java applications. Therefore, you may want to change the JRE path pre-filled by the installer program.
    Note:
    The JRE you provide at this time will be used both to run Agent Controller and for Agent Controller to launch Java applications. You may, however, later configure Agent Controller to a use separate JRE for each of these functions. For details, refer to Agent Controller help topic Configuring Applications to be launched by Agent Controller.

    Click Next to proceed.

  10. Optional: Specify the version of IBM WebSphere Application Server if "Remote Support for WebSphere Application Server" was selected in step 9 above. Click Next to proceed.
  11. Optional: Specify the paths of IBM WebSphere Application Server version 5.0 (Windows only) and 5.1 if "Remote Support for WebSphere Application Server" was selected in step 9 above. Click Next to proceed.
  12. Specify which hosts can access Agent Controller. For Rational Performance Tester, you must select Specific computers. Click Next to proceed.
  13. Accept the default value (Disable) for the security setting. Click Next to proceed.
  14. Click Next on the summary screen to install Agent Controller.
  15. Click Finish after the installation has completed.

Installing Rational Performance Tester Agent silently

You can run the installation process silently using the following parameters with the setup command:

Parameter Description

-silent

This variable is required if silent is used:

-V licenseAccepted=true
Optional: tells the installer to run silently otherwise you will get an install wizard with passed inputs.

-P installLocation
Optional:  specifies the installation path. The default installation path is '$D(install)/IBM/AgentController'.

Examples:

for Windows: C:\Program Files\IBM\AgentController

for UNIX/Linux: /opt/IBM/AgentController

-V VJavaPath
Required: specifies the fully-qualified path of the java executable  

-V VAccessLocal

-V VAccessCustom

-V VAccessAll

Optional: specifies how clients can connect to Agent Controller (ALL, LOCAL, CUSTOM). Set only one of the variables to "true" and the others to false. By default, VAccessAll="true"

  • Any computer:           VAccessAll="true"           : allow any client
  • This computer only :   VAccessLocal="true"       : allow only localhost (default)
  • Specific computers :   VAccessCustom="true"    : allow a list of clients (also requires the -V VHosts parameter)

-V VHosts
Required if VAccessCustom="true

specifies the client hostnames, separated by commas

The following two variables must both be specified and should be set as opposites:

-V VSecurity="true" or "false"
-V VSecurityDisable="false"
 or "true"
Optional: (true, false)

default:

VSecurity=true 
VSecurityDisable=false

-V VUsers
Required: if VSecurity="true"

specifies which users can connect to Agent Controller

-V VWAS6

-V VWAS5
Optional:

-V VWAS6="true" (default) : If WAS V6 is used

-V VWAS5="true" : If WAS V5.x is used

-V VWAS_HOME_V50

-V VWAS_HOME_V51
Optional: if -V VWAS5="true"

specifies the installed location of IBM WebSphere Application Server 5.1 and 5.0

Examples:

Installing from the command line:

-P installLocation="D:\IBM\AgentController"

-V VJavaPath=" D:\jdk1.4.2\jre\bin\java.exe "

-V VAccessLocal="false"

-V VAccessCustom="true"

-V VAccessAll="false"

-V VHosts="host1,host2"

-V VSecurity="true"

-V VSecurityDisable="false"

-V VUsers="user1,user2"

-V VWAS5="true"

-V VWAS_HOME_V51="D:\WebSphere5.1\AppServer"

-V VWAS_HOME_V50="D:\WebSphere5.0\AppServer"

Installing using a response file:

You can create a response file, for example setup.rsp, to store all the parameters, instead of specifying them on the command line. Following is a Windows example, Linux/UNIX platforms would be similar:

setup.exe -silent -options setup.rsp

Contents of the response file:

      # Start of response file

-P installLocation="D:\IBM\AgentController"

-V licenseAccepted="true"

-V VJavaPath=" D:\jdk1.4.2\jre\bin\java.exe "

-V VAccessLocal="false"

-V VAccessCustom="true"

-V VAccessAll="false"

-V VHosts="host1,host2"

-V VSecurity="true"

-V VSecurityDisable="false"

-V VUsers="user1,user2"

-V VWAS5="true"

-V VWAS_HOME_V51="D:\WebSphere5.1\AppServer"

-V VWAS_HOME_V50="D:\WebSphere5.0\AppServer"

 
      # End of response file

Starting and stopping Agent Controller

Uninstalling Rational Performance Tester Agent

  1. Run the program uninstall.bin from the installation location's _uninst directory (for example, /opt/IBM/AgentController/_uninst).
  2. Follow the on-screen instruction to complete the uninstallation.
  3. To perform a silent uninstallation, use the command uninstall.bin -silent.

Uninstalling Agent Controller that has multiple references on a workstation

The Rational Performance Tester Agent includes the Rational Agent Controller and the data collection infrastructure. Agent Controller version 8.1 prevents multiple instances of the product from being installed on a single workstation. When additional installations are performed, either as a stand-alone installation or as an embedded installation inside a product, Agent Controller records a reference to the name of the product that is initiating the new installation.

If Agent Controller has been installed multiple times, it can be uninstalled only when the last referencing product is uninstalled; the last referencing product still requires Agent Controller.

If you attempt to uninstall Agent Controller while it is still required by another product, the uninstallation will not proceed and you will receive a message "This product cannot be uninstalled as it is required by another product."

Installing Rational Performance Tester Agent on z/OS (OS/390®)

Uninstalling previous versions of Agent Controller

If you have a previous version of Agent Controller, stop it and uninstall it before installing this version.

Configuring the operating system environment

  1. Create the installation directory for the RAC. For example: mkdir /u/rpt/IBM/RAC.
  2. Set ASSIZEMAX=2147483647. This may require support from the system programmer.
  3. Add the following export commands to the .profile of the user ID that will be used to start the RAC:
    export RASERVER_HOME={install location}
    export LIBPATH=$LIBPATH:{install location}/lib:{path to java installation}/bin:
        {path to java installation}/bin/classic
    export PATH=$PATH:{install location}/bin:{path to java installation}/bin
    export _BPX_SHAREAS="NO"
Note:
After the environment variables have been set, the command "java -fullversion" can be used to verify the Java version.

Installing Rational Performance Tester Agent

The Rational Performance Tester Agent includes the Rational Agent Controller and the data collection infrastructure.

  1. In a UNIX® System Services shell, go to the directory where you want to install Agent Controller. It is recommended that you install it in the /usr/lpp/ directory.
  2. Transfer the install images ibmrac.os390.pax, tptpdc.os390.pax to the installation directory.
  3. Issue the following command to extract Agent Controller files:

    pax -ppx -rvf ibmrac.os390.pax
  4. Issue the following command to extract the test and performance tools (TPTP) Agent Controller files:

    pax -ppx -rvf tptpdc.os390.pax
  5. Make the Agent Controller shared object files program controlled by issuing the following commands in a UNIX System Services shell:

    extattr +p /usr/lpp/IBM/AgentController/lib/*.so

    If you wish to install the National Language packs, complete steps 7 and 8 below. If not, proceed to step 9.

  6. Transfer the NL install images tptpdc.nl1.os390.pax, tptpdc.nl2.os390.pax, ibmrac.os390.nl1.pax, ibmrac.os390.nl2.pax to the installation directory.
  7. Issue the following command to extract Agent Controller files:

    	pax -ppx -rf tptpdc.nl1.os390.pax
    	pax -ppx -rf tptpdc.nl2.os390.pax
    	pax -ppx -rf ibmrac.os390.nl1.pax
    	pax -ppx -rf ibmrac.os390.nl2.pax
  8. After you have installed Agent Controller, change the directory to the installed location's bin directory /usr/lpp/IBM/AgentController/bin, and run the setup script by typing:

    ./SetConfig.sh
  9. Follow the on-screen prompt to configure Agent Controller.

Starting and stopping Agent Controller on the z/OS (OS/390)

Note: RAServer requires the directories of the JRE that contain executable libraries such as libjvm.so to be added to the LIBPATH environment variable. For example, if you are using the IBM JRE 1.4.1, the LIBPATH variable would be set as follows:

export LIBPATH=/usr/lpp/java/IBM/J1.4/bin/classic:
/usr/lpp/java/IBM/J1.4/bin:$LIBPATH

Uninstalling Rational Performance Tester Agent on the z/OS (OS/390)

Manage licenses

Licensing for your installed IBM software and customized packages is administered using the Manage Licenses wizard in the IBM Installation Manager. The Manage Licenses wizard displays license information for each of your installed packages.

Using the Manage Licenses wizard, you can apply a license to a product or upgrade trial versions of an offering to a licensed version by importing a product activation kit. You can also enable Floating license enforcement for offerings with trial or permanent licenses to use floating license keys from a license server.

For more information on managing licenses for your Rational product, see:

Licenses

As a purchaser of an IBM Rational software product, you can choose from three types of product licenses: an Authorized User license, an Authorized User Fixed Term License (FTL), and a Floating license. The best choice for your organization depends upon how many people use the product, how often they require access, and how you prefer to purchase your software.

Authorized User license

An IBM Rational Authorized User license authorizes a single individual to use a Rational software product. Purchasers must obtain an Authorized User license for each individual user who accesses the product in any manner. An Authorized User license cannot be reassigned unless the purchaser replaces the original assignee on a long-term or permanent basis.

For example, if you purchase one Authorized User license, you can assign that license to one individual, who can use the Rational software product exclusively. The Authorized User license does not authorize a second individual to use that product at any time, even if the licensed individual is not using the product.

Authorized User Fixed Term License

An IBM Rational Authorized User Fixed Term License (FTL) authorizes a single individual to use a Rational software product for a specific length of time (the term). Purchasers must obtain an Authorized User FTL for each individual user who accesses the product in any manner. An Authorized User FTL cannot be reassigned unless the purchaser replaces the original assignee on a long-term or permanent basis.

Note:
When you purchase an Authorized User FTL under the Passport Advantage® Express™ program, IBM will automatically extend the license term for an additional year at the prevailing price unless you notify IBM before the license expires that you do not want an extension. The subsequent FTL term starts when the initial FTL term expires. The price for this subsequent term is currently 80% of the initial FTL price, but is subject to change.

If you notify IBM that you do not want to extend the license term, then you must stop using the product when the license expires.

Floating license

An IBM Rational Floating license is a license for a single software product that can be shared among multiple team members; however, the total number of concurrent users cannot exceed the number of floating licenses you purchase. For example, if you purchase one floating license for a Rational software product, then any user in your organization may use the product at any given time. Another person who wants to access the product must wait until the current user logs off.

To use floating licenses, you must obtain floating license keys and install them on a Rational License Server. The server responds to user requests for access to the license keys; it will grant access to the number of concurrent users that equals the number of licenses the organization purchased.

License enablement

If you are installing the software for the first time or want to extend a license to continue using the product, you have options on how to enable licensing for your product.

Licenses for this product are enabled in two ways:

Activation kits

The Product Activation Kit CD contain the permanent license key for you product. You use IBM Installation Manager to import the activation kit to your product.

Floating license enforcement

Optionally, you can obtain floating license keys, install IBM Rational License Server, and enable Floating license enforcement for your product. Floating license enforcement provides the following benefits:

Note:
Some 7.0 and later versions of Rational products require an upgraded version of the Rational License Server. See support article http://www.ibm.com/support/docview.wss?uid=swg21250404 for license upgrade information.

For more information on obtaining activation kits and Floating licenses, see Purchasing licenses.

Enabling runtime licenses for testing

To run tests, you must have the correct license keys installed.

Rational Performance Tester requires two types of licensing: product activation and runtime licensing. Product activation licensing, also known as LUM licensing, allows you to run the product. Runtime licensing is unique to Rational Performance Tester. Runtime licensing, also known as Flex licensing, consists of protocol keys and virtual tester license key packs. Runtime licensing allows you to run performance tests on specific protocols with multiple virtual users. You use different tools to manage and configure product activation licensing and runtime licensing. You manage product activation using Installation Manager. You manage runtime licensing using IBM Rational License Key Administrator.

With product activation licenses you can start the product. There are two forms of product activation licensing: a product activation kit that is installed on the computer where the product is installed, or a floating product license that users check out from a Rational License Server. You can download the product activation kit from Passport Advantage for authorized user purchases. For floating product licenses, your license server administrator must log in to the Rational License Center to download a floating license key and import it to your Rational License Server. Make sure to use the version of Rational License Server that is shipped with the product. Earlier versions of Rational License Server might not support all of the necessary licensing functions.

The Rational License Server supports floating license keys, so that administrators can manage licensing across the enterprise. Administrators can install the Rational License Server from Passport Advantage or from the product media. To learn more about product activation, including the Rational License Server, see the product installation guide.

In addition to product activation, Rational Performance Tester also checks for runtime licensing when you run a performance schedule. Runtime licensing consists of the correct protocol keys and virtual tester license key packs. You need a protocol key to run performance tests with any protocol other than HTTP. You need a virtual tester license key pack to run tests with more than five virtual users. You can check out these keys from the same Rational License Server that you use for floating license product activation.

To check out protocol and virtual tester license keys in Windows, you must use the IBM Rational License Key Administrator program to point to a Rational License Server. Use the version of IBM Rational License Key Administrator that was installed with Rational Performance Tester. Click Start -> Programs -> IBM Rational -> IBM Rational License Key Administrator. Type the name or IP address of your Rational License Server. Protocol and virtual tester license keys are available from the Rational License Key Center in the form of .upd files. If you double-click a .upd file in Windows, the License Key Administrator program should start automatically and import the license keys. To learn more about IBM Rational License Key Administrator, click Help -> Contents and Index.

There is no Linux version of the IBM Rational License Key Administrator. To check out protocol and virtual tester license keys in Linux, you must create and edit the .flexlmrc file. Create the file .flexlmrc in the home directory of every user who runs more than five virtual testers, uses a protocol other than HTTP, or uses the floating license product activation. Edit the .flexlmrc file, adding a line with the computer name or the IP address of the Rational License Server. For example, add the line RATIONAL_LICENSE_FILE=@license-server-name.com or RATIONAL_LICENSE_FILE=@license-server-ip-address.

Runtime license examples

To run tests, you must have the correct license keys installed.

The trial licensing key allows you to run Rational Performance Tester for 30 days from the initial installation. After thirty days from the first time you install the product, the trial license expires. The trial license allows you to run HTTP performance tests with up to 5 virtual users. For other protocols except for SOA, the trial license allows you to run tests with a single user. The trial license for Rational Performance Tester does not allow you to run tests using the SOA protocol.

The following table shows the number of virtual users you can use depending on the license keys you have installed:

Protocol Trial Protocol key 500-user virtual tester key pack and protocol key
HTTP 5 n/a 505
Siebel 1 5 505
SAP 1 5 505
MySAP 1 5 505
Citrix 1 5 505
Socket 1 n/a 505
SIP 0 5 505
SOA 0 5 505

Purchasing licenses

You can purchase new licenses if your current product license is about to expire or if you want to acquire additional product licenses for team members.

About this task

To purchase licenses and use your product, complete the following steps:

  1. Determine the type of license you want to purchase.
  2. Go to ibm.com or contact your IBM sales representative to purchase the product license. For details, visit the IBM Web page on How to buy software.
  3. Depending on the type of license you purchase, use the Proof of Entitlement that you receive and do one of the following to enable your product:

What to do next

When you want to import the activation kit or enable Floating License support for your product, use the Manage Licenses wizard in IBM Installation Manager.

Viewing license information for installed packages

You can review license information for your installed packages, including license types and expiration dates, from IBM Installation Manager.

About this task

To view license information:

  1. Start IBM Installation Manager.
  2. On the main page, click Manage Licenses.

Results

The package vendor, current license types, and expiration dates are displayed for each installed package.

Configuring Web-based help

You might need to set up or change how you access help content.

Accessing Web-based help

Help for your product is available on a product information center on the Internet. You can view this help from within the product.

Before you begin

During installation, the option to access help content from a remote information center was selected. This is the default selection.

About this task

Your product help system can retrieve content installed with the product and content from a remote server running an information center. The information center for your product has the most current help content and when your product is configured to retrieve content from a remote information center, the contents of the information center can be accessed by selecting Help -> Help Contents to open your help system.

The information center for your product is available at http://publib.boulder.ibm.com/infocenter/rpthelp/v8r1m0/index.jsp.

Follow these steps to check your connection to the information center:

  1. Open the Preferences window by clicking Window -> Preferences.
  2. Select Help -> Content.
  3. Ensure that Include help content from a remote infocenter is selected.
  4. Ensure that the URL for your product information center is in the list of available information centers. If your information center is not listed, complete the following steps:
    1. Click Add.
    2. In the Name field, type a name for the connection.
    3. In the Host field, type http://publib.boulder.ibm.com.
    4. In the Path field, type /infocenter/rpthelp/v8r1m0/index.jsp.
    5. Select Use default port.
    6. Click OK.
  5. Select the entry for your product information center.
  6. Click Test Connection.

Results

Connection Successful is displayed if the connection is made. If Connection failed is displayed, verify that you have an active Internet connection and check the settings.

Installing help content from an archive file

This topic explains how to install help content from the archive file bundled with the product. Most help content is not installed when you install your product. If you do not have an Internet connection, to access help content locally you can install it from the bundled archive file.

Before you begin

During installation, the help access option, Download help and access the content locally, was selected. If you the help system window is open, close it before you start the following procedure.

About this task

You can use this procedure to install help from the bundled archive file, or from help archive files that you download from http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/. To install the help content from the bundled archive file:

  1. Extract the help archive file com.ibm.rpt.remote.help.updateSite.zip to a temporary folder. By default, on Windows, the help archive file is installed in this directory: C:\Program Files\IBM\SDP\rpt\remotehelp\docs.
  2. Start Rational Performance Tester and select a workspace. A warning message is displayed indicating that you need to install help content.
  3. Click Launch Local Help Updater. Alternately, from the main window of the product, click Help -> Local Help Updater. The Local Help Updater is a browser application. You might be prompted to adjust browser security settings to run the Local Help Updater. The Updater site opens in a separate browser window.
  4. On the Public Sites page, click the Internal Sites tab.
  5. Click the plus sign icon. A file chooser window opens.
  6. Type any name in the Name field. For example, type "Rational Performance Tester Documentation."
  7. Click Browse, then navigate to the directory where you extracted com.ibm.rpt.remote.help.updateSite.zip. Select the site.xml file, and then click OK. The name and location should now be displayed in the list of internal sites.
  8. Click the name of the internal site.
  9. The Available Features list will be populated with a list of the help that is available for download. Depending on your network connection speed, this might take a few minutes. Select the help content that you need.
  10. Click Install. The help content is downloaded and installed. A progress bar opens and tracks the status of the download. After the help is installed, the following message is displayed: Platform has been reset. You must restart your workbench for the changes to take effect.
  11. Click OK, and then close the browser window.
  12. In the product, click File -> Restart.

Results

The help that you selected is installed on your system.

Downloading help content from the Local Help System Updater site

This topic explains how to download help content from the Local Help System Updater site. Most help content is not installed when you install your product. To access all help content locally, you need download it from the IBM Local Help System Updater Web site.

Before you begin

During installation, the help access option, Download help and access the content locally, was selected. Before using the help for the product, you have to download the help to your local system. If you the help system window is open, close it before you start the following procedure.

About this task

To download the help content from the Local Help System Updater site:

  1. With your product open, click Help -> Local Help Updater. The Updater site opens in a separate browser window.
  2. On the Public Sites page, select the URL of the help to download.
  3. The Available Features list will be populated with a list of the help that is available for download. Depending on your network connection speed, this might take a few minutes. Select the help content that you need.
  4. Click Install. The help content is downloaded and installed. A progress bar opens and tracks the status of the download.
  5. When the download is completed, open the help in the product by selecting Help -> Help Contents.

Results

The help that you selected is installed on your system. The files will be updated automatically each time you start the application and an Internet connection is available.

Updating help content

Use the Local Help System updater to update local help content without restarting your product. If an Internet connection is available, the local help content is automatically updated each time your start your product.

Before you begin

Before you can update local help content, you must initially download the help content for your product from the Local Help System Updater Web site. See Downloading help content from the Local Help System Updater site for downloading help content. An Internet connection is required.

About this task

Updates are automatically installed each time you start the product, if you have an Internet connection. If you want to update the help without restarting the product, follow these steps.

  1. Close the product help system window.
  2. Open the Local Help System Updater by selecting Help -> Local Help Updater. The Updater site opens in a separate browser window.
  3. Click the Installed Features tab.
  4. Click Search for Updates If updates to the content you have installed are available, they are installed to your help system. A progress bar indicates the status of the request.
  5. When the update is completed, open the help in the product by selecting Help -> Help Contents.

Removing help content

Use the Local Help System Updater to remove installed help content.

Before you begin

Use this procedure if you have downloaded help features using the Local Help System Updater and decide to remove help content.

About this task

To use the Local Help System Updater to remove installed content:

  1. Close the product help system window.
  2. Open the Local Help System Updater by selecting Help -> Local Help Updater. The Updater site opens in a separate browser window.
  3. Click the Installed Features tab.
  4. Select the features to remove, and then click Remove. The help features that you selected are removed from your system. A progress bar indicates the status of the request.
  5. When the removal is completed, open the help in the product by selecting Help -> Help Contents.

Setting up an intranet server for help content

You can set up an intranet server behind a firewall to provide help content to users. In this way, users do not have to download and save help content to their computers.

Before you begin

Verify that you have a server available that can be accessed by users behind a firewall.

About this task

See the Installation Manager information center for the instructions on setting up an intranet server for help content.

Changing the way you access help content

You can change the way that you obtain help content.

Before you begin

During the installation process, a help content access method was selected. Close the help browser before you change the way that you access help content.

About this task

To change the way that you access help content:

  1. Click Window -> Preferences. The Preferences window opens.
  2. Expand the Help entry, and then click Content. A list of the information center or centers opens. Depending on the access method that was chosen, complete one of the following procedures.
    1. Disable the link to the Internet site by selecting the Internet URL in the Contents list, and then clicking Disable.
    2. Click Add; then name the intranet connection, specify the intranet URL for the server that contains the help content, and then click OK.
    3. Click OK to close Preferences.
    4. Click Help -> Help Contents, to open your help.
    1. Ensure that Include help content from a remote infocenter is selected.
    2. Disable the link to the product Information Center by selecting that connection in the Contents list, and then clicking Disable.
    3. Click Add, and then enter a name for the local help connection. Specify the localhost Host IP address 127.0.0.1 and path /help. Select any unused port number, and then click OK.
    4. Save any work and close and restart the product.
    5. Follow the instructions in Downloading help content from the Local Help System Updater site to download help content.
    1. Ensure that Include help content from a remote infocenter is selected.
    2. Disable the link to localhost by selecting that connection in the Contents list, and then clicking Disable.
    3. Click Add; then name the connection, specify the Internet URL for the IBM Web site that contains the help content, and then click OK. This URL might already be available in the list of connections. If it is listed, select the connection and click Enable.
    4. Click OK to close the Preferences window.
    5. Click Help -> Help Contents, to open your help.
    1. Ensure that Include help content from a remote infocenter is selected.
    2. Disable the link to localhost by selecting that connection in the Contents list, and then clicking Disable.
    3. Click Add; then name the connection, specify the intranet URL for the server that contains the help content, and then click OK.
    4. Click OK to close Preferences.
    5. Click Help -> Help Contents, to open your help.
    1. Ensure that Include help content from a remote infocenter is selected.
    2. Disable the link to the intranet server by selecting that connection in the Contents list, and then clicking Disable.
    3. Click Add; then enter a name for the local help connection. Specify the localhost Host address 127.0.0.1 and path /help. Enter any unused port number, and then click OK.
    4. Save any work and close and restart the product.
    5. Follow the instructions in Downloading help content from the Local Help System Updater site to download help content.
    1. Disable the link to your intranet site by selecting the intranet URL in the Contents list, and then clicking Disable.
    2. Click Add; then name the connection, specify the URL for the IBM Web site that contains the help content, and then click OK.
    3. Click OK to close the Preferences window.
    4. Click Help -> Help Contents, to open your help.

Notices

© Copyright IBM Corporation 2000, 2009. All rights reserved.

U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this documentation in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

Intellectual Property Dept. for Rational Software
IBM Corporation
20 Maguire Road
Lexington, Massachusetts 02421-3112
U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks and service marks

See www.ibm.com/legal/copytrade.shtml.