IBM Rational Functional Tester, Version 8.1

Installation Guide


Note

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

Second Edition (Feb 2010)

This edition applies to version 8.1.1 of IBM Rational Functional Tester (part number 5724-G25) and to all subsequent releases and modifications until otherwise indicated in new editions.

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

Contents

Installing Rational Functional Tester
Product overview
Installation terminology
Planning the installation
Installation roadmap
Installation Manager overview
Installation requirements
Installation considerations
Preinstallation tasks
Increasing the number of file handles on Linux workstations
Verifying and extracting electronic images
Installing software
Installing from the Setup disk
Working with IBM Installation Manager
Installing Rational Functional Tester
Working with test agents
Installing the Rational Test Agent on Windows
Starting the Rational Test Agent on Windows
Installing the Rational Test Agent on Linux
Starting the Rational Test Agent and the RAServer on Linux
Enabling environments on Test Agents
Configuring applications on Test Agents
Post-installation tasks
Post-installation checklist
Starting Rational Functional Tester
Managing licenses
Configuring Web-based help
Updating Rational Functional Tester
Modifying installations
Reverting updates to previous versions
Uninstalling Rational Functional Tester
IBM Packaging Utility
Installing Packaging Utility
Copying product packages to an HTTP server using Packaging Utility
Notices
Trademarks and service marks

Installing Rational Functional Tester

This section contains instructions for installing, updating, and uninstalling IBM® Rational® Functional Tester.

The latest version of the installation information is available online at: http://publib.boulder.ibm.com/infocenter/rfthelp/v8r1/index.jsp

Product overview

Rational Functional Tester is part of IBM Rational Software Delivery Platform. The IBM Rational Software Delivery Platform is a common development environment that contains the development workbench and other software components that share multiple products.

About Rational Functional Tester

IBM Rational Functional Tester is an object-oriented automated testing tool that tests Windows®, .Net, Java™, HTML, Siebel, SAP, AJAX, PowerBuilder, Flex, Dojo, and GEF applications. You can also test Adobe PDF documents, and zSeries®, iSeries®, and pSeries® applications. Rational Functional Tester enables you to record reliable, robust scripts that can be played back to validate new builds of a test application.

Functional Tester is available in two integrated development environments. It records user actions to create simplified test scripts that are easy to understand in Rational Software Delivery Platform. It also supports two scripting languages for advanced users. Functional Tester Java scripting uses the Java language and the Functional Tester VB.NET 2003 and VB.NET 2005 scripting uses the VB.NET language and the Microsoft® Visual Studio .NET development environment.

Rational Functional Tester Extension for Terminal-based Applications is a tool that helps you create test scripts to automate your host application test cases. Functional Tester Extension for Terminal-based Application provides a rich set of capabilities to test host attributes, host field attributes and screen flow through a host application. It uses terminal verification points and properties, as well as synchronization code to identify the readiness of terminal for user input.

Rational Functional Tester Extension for Terminal-based Applications supports connection to zSeries (TN3270 terminal types for MVS and VM), iSeries (TN5250 terminal type for OS/400®) and pSeries (VT terminal types for Unix) hosts.

Using Functional Tester Extension for Terminal-based Applications, you can:

Note:
From Rational Functional Tester version 8.0 release, the Functional Tester Extension for Terminal-based Application is integrated with Rational Functional Tester. You do not need to buy a separate license for working with Functional Tester Extension for Terminal-based Application.

Installation terminology

Understanding these terms can help you take full advantage of the installation information and your Rational Functional Tester.

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. (Some packages cannot share a package group, in which case the option to use an existing package group is unavailable.)
Repository
A storage area where packages are available for download. 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 product features. Effective planning and an understanding of the key aspects of the installation process can help ensure a successful installation.

Installation roadmap

The installation roadmap lists the high-level steps for installing your product.

Roadmap for installing Rational Functional Tester

Perform these tasks to install Rational Functional Tester:

  1. Verify that your computer meets the minimum hardware and software requirements for installing the product.
  2. Verify that your user ID meets the requirements for installing the product.
  3. Review the rest of the planning information .
  4. Complete any necessary pre-installation tasks.
  5. From the Setup disk, do one of the following steps:
  6. Install or update IBM Installation Manager, if necessary.
  7. In Installation Manager, click Install and install the product.
  8. Verify that the installation is successful.
  9. Perform any necessary post-installation tasks, such as configuring the appropriate product license.

Installation Manager overview

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

Installation Manager provides tools 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:

For more information about IBM Installation Manager, visit the Installation information center.

Installation requirements

This section details hardware, software, and user privilege requirements that must be met in order to successfully install and run your software.

You can also view the system requirements, at www.ibm.com/software/awdtools/tester/functional/sysreq/index.html.

Hardware requirements

Before you can install IBM Rational Functional Tester, verify that your system meets the minimum hardware requirements.

Hardware Requirements
Processor Minimum: 1.5 GHz Intel® Pentium® 4 (or higher for best results)
Memory Minimum: 1 GB of RAM
Disk space

Minimum: 750 MB of disk space is required for product package installation. Additional disk space is required 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 pointed to by your environment variable TEMP.
  • For Linux®: An additional 500 MB of disk space is required in the /tmp directory.
Display 1024 x 768 resolution 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.

Table 1. Software requirements to install Rational Functional Tester
Item Requirements
Platform

One of the following operating systems must be installed:

Supported operating systems in 32-bit mode

  • Microsoft Windows XP Professional with Service Pack 2 or 3
  • Microsoft Windows 2000 Professional with Service Pack 4
  • Microsoft Windows 2000 Server with Service Pack 4
  • Microsoft Windows 2000 Advanced Server with Service Pack 4
  • Microsoft Windows 2003 Server Standard Edition with Service Pack 1 or 2
  • Microsoft Windows 2003 Server Enterprise Edition with Service Pack 1 or 2
  • Microsoft Windows Vista Business, Windows Vista Enterprise, and Windows Vista Ultimate, Service Pack 1, Service Pack 2
  • Microsoft Windows 2008 Server Standard Edition with Service Pack 1
    Note:
    The Hyper-V host is not supported, but the guest operating system that is supported by Rational Functional Tester and hosted on Hyper-V is supported.
  • Microsoft Windows 7 Ultimate, Enterprise and Professional
  • Red Hat Enterprise Linux AS 4.0, Update 5, Update 8 (All functions except recording)
  • Red Hat Enterprise Linux ES 4.0, Update 1 (All functions except recording)
  • Red Hat Enterprise Linux ES 5.0 Update 3 (All functions except recording)
  • Red Hat Enterprise Linux Desktop 4.0, Update 1, Update 7, Update 8 (All functions except recording)
  • Red Hat Enterprise Linux Desktop 5.0 Update 2, Update 3 (All functions except recording)
  • SUSE Linux Enterprise Server (SLES) 9.0, SP4 (All functions except recording)
  • SUSE Linux Enterprise Server (SLES) 10.0, SP1, SP2 (All functions except recording)
  • SUSE Linux Enterprise Server (SLES) 11.0 (All functions except recording)
  • SUSE Linux Enterprise Desktop 10.0, SP1, SP2 (All functions except recording)

Supported operating systems in 64-bit mode

  • Microsoft Windows XP Professional 64
  • Microsoft Windows Vista 64
  • Microsoft Windows 2003 Server 64
  • Microsoft Windows 7 Ultimate, Enterprise and Professional
Note:
Rational Functional Tester provides limited support for testing applications on 64-bit mode. You can test Windows and .NET 64-bit applications in the 64-bit Windows operating system. You can also test all the supported 32-bit applications that run in 32-bit mode in the 64-bit Windows operating system. For more information, see the product release notes and the tech. notes in the Support site.

The listed operating systems support all of the languages that are supported by Rational Functional Tester.

Others

  • Microsoft .NET Framework 1.1 or later for recording functional test scripts on any Windows applications
  • Microsoft Visual Studio.Net 2003, Standard Edition or Professional Edition, with VB.NET Project support for .NET 2003 scripting.
  • Microsoft Visual Studio.Net 2005, Standard Edition or Professional Edition, with VB.NET Project support for .NET 2005 scripting .
  • For Linux:
    • The GNU Image Manipulation Program Toolkit (GTK+), Version 2.2.1, or later
    • Libraries: libXp.so.6 must be available in the computer. If it is not available on the computer, you must install the appropriate libxp-1.rpm package for i386 or i586 that contains this library.
Extending an existing Eclipse IDE

To install Rational Functional Tester into an existing eclipse, you require:

  • Eclipse 3.4.2 or higher
  • For Windows: IBM 32-bit SDK for Windows, Java 2 Technology Edition, Version 6 or Sun Java 2 Standard Edition 6
  • For Linux: IBM 32-bit SDK for Linux on Intel architecture, Java 2 Technology Edition, Version 6 or Sun Java 2 Standard Edition 6
Note:
You can install Rational Functional Tester on an existing Rational Team Concert client and manage functional test assets using the Jazz source control management. Jazz Eclipse Client for Rational Team Concert/Rational Quality Manager is also provided as an optional feature installation. You must have the compatible Rational Team Concert or Rational Quality Manager server setup for using the Jazz source control management. Refer to the Rational Team Concert documentation for the supported list of platforms.
Important:
To enable users who do not have Administrator privileges to work with Rational Functional Tester on a Windows Vista system, do not install Eclipse inside the Program Files directory (C:\Program Files\).
Virtualization software

The following virtualization software is supported:

  • Citrix Presentation Manager Version 4, running on Windows Server 2003 Standard Edition or Windows Server 2003 Professional Edition
Note:
Functional Tester Extension for Terminal-based Application installs the IBM SWT HA Beans feature of IBM Host On-Demand in the system. If the latest version of IBM Host On-Demand is available in the system, the Extension for Terminal-based Application uses the IBM SWT HA Beans feature that is already installed. Do not uninstall the IBM Host On-Demand because the Extension for Terminal-based Application requires it.

User privileges requirements

You must have a user ID that meets the following requirements before you can install Rational Functional Tester.

Installation considerations

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

Planning what features to install

You can customize your software product by selecting which features of Rational Functional Tester to install.

When you install the Rational Functional Tester product package by using IBM Installation Manager, the installation wizard displays the features in the available product package. From the features list, you can select which to install. A default set of features is selected for you (including any required features). Installation Manager automatically enforces any dependencies between features and prevents you from clearing any required features.

Note:
After you finish installing the package, you can still add or remove features from your software product by running the Modify Packages wizard in Installation Manager. See Modifying installations for more information.
Features

The following table shows the features of Rational Functional Tester that you can choose to install. Default selections of features to install might vary. If a feature already exists in your shared resources directory, it will not be selected by default and will not be installed again.

Feature Description Selected for installation by default
Java scripting Provides automated functional and regression testing of Windows®, .NET, Java™, HTML, Siebel, SAP, AJAX, PowerBuilder, Flex, Dojo, GEF, Visual Basic applications, Adobe® PDF documents, and zSeries®, iSeries®, and pSeries® applications through the Eclipse IDE. The .NET Framework 1.1 or 2.0 is required for testing Siebel and SAP applications. Yes
.Net 2003 scripting Provides automated functional and regression testing of Windows®, .NET, Java™, HTML, Siebel, SAP, AJAX, PowerBuilder, Flex, Dojo, GEF, Visual Basic applications and Adobe® PDF documents, through the .NET 2003 IDE. Requires .NET Framework 1.1. No
.Net 2005 scripting Provides automated functional and regression testing of Windows®, .NET, Java™, HTML, Siebel, SAP, AJAX, PowerBuilder, Flex, Dojo, GEF, Visual Basic applications and Adobe® PDF documents, through the .NET 2005 IDE. Requires .NET Framework 2.0. No
IBM Rational Agent Controller IBM Rational Agent Controller drives the execution of Rational Functional Tester scripts on a remote machine when launched from ClearQuest® Test Manager. The Rational Agent Controller should be installed on the remote machine where scripts are to be run. ClearQuest Test Manager should be installed on the machine from which these scripts are to be launched. No
Jazz Eclipse Client for Rational Team Concert/Rational Quality Manager Manage functional test assets using the Jazz source control management provided by the Jazz Eclipse Client. You must have the compatible version of Rational Team Concert or Rational Quality Manager server setup to use the Jazz source control management. You must also have the platform that is also supported by Rational Team Concert client. No

Note:
In addition to integration with ClearQuest Test Manager, Rational Functional Tester supports integration with Rational Quality Manager for remote execution of test scripts. You can enable Rational Functional Tester integration with Rational Quality Manager by configuring the adapter that is installed by default when you install Rational Functional Tester. For more information about Rational Functional Tester integration with Rational Quality Manager, see Rational Functional Tester and Rational Quality Manager help topics.

Installation location

When you install the Rational Functional Tester package using IBM Installation Manager, you must choose a package group and a shared resource directory.

Package groups

During the installation process, you must specify a package group for the Rational Functional Tester package. A package group represents a directory in which packages share resources with other packages in the same group. When you install the Rational Functional Tester package using Installation Manager, you can create a new package group or install the packages into an existing package group. (Some packages might not be able to share a package group, in which case the option to use an existing package group will be disabled.)

Note that when you install multiple packages at the same time, all the packages are installed into the same package group.

A package group is assigned a name automatically; however, you choose the installation directory for the package group.

After you create the package group by successfully installing a product package, you cannot change the installation directory. The installation directory contains files and resources specific to the Rational Functional Tester product package installed into that package group. Resources in the product package that can potentially be used by other package groups are placed in the shared resources directory.

Important:
To enable users who do not have Administrator privileges to work with Rational Functional Tester in the Windows Vista operating system, do not choose a directory inside the Program Files directory (C:\Program Files\).

Shared resources directory

The shared resources directory is the directory where installation artifacts are located so that they can be used by one or more product package groups.

Important:

Extending an existing Eclipse IDE

When you install the Rational Functional Tester product package, you can choose to extend an Eclipse integrated development environment (IDE) already installed on your computer by adding the functions that the Rational Functional Tester package contains.

The Rational Functional Tester 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 Rational Functional Tester package.

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

Important:
To enable users who do not have Administrator privileges to work with Rational Functional Tester in the Windows Vista operating system, do not install Eclipse inside the Program Files directory (C:\Program Files\).

You might extend your existing Eclipse IDE, for example, because you want to gain the functionality provided in the Rational Functional Tester package, but you also want to have the preferences and settings in your current IDE when you work with the functionality from the Rational Functional Tester 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.2 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 to Rational Functional Tester. Refer to the update release documentation for information on changes to the prerequisite Eclipse version.

Upgrade and coexistence considerations

If you have a previous version of the product, or if you plan to install multiple Rational Software Delivery Platform products on the same workstation, review the information in this section.

Upgrading from IBM Rational Functional Tester version 6.1.x or 7.0.x

IBM Rational Functional Tester version 8.x cannot be installed on a computer on which Rational Functional Tester version 6.1.x or 7.0.x is installed. All previous versions of Functional Tester must be uninstalled before attempting to install IBM Rational Functional Tester version 8.x. During the installation of Rational Functional Tester version 8.x, if an installation of the version 6.1.x or 7.0.x product is detected, the installation routine will stop. Refer to the previous product's documentation for instructions on uninstalling the software.

Note:
Uninstalling version 6.1.x or 7.0.x packages will not delete project assets.
Migrating test assets from earlier versions of IBM Rational Functional Tester

All test assets from earlier versions of Rational Functional Tester, including projects, scripts, object maps, and verification points, will work with the current version of the product. However, scripts recorded with the current version of the product will not play back on earlier versions.

For more information about migrating test assets, see Upgrading from earlier versions of Rational Functional Tester topic.

Coexistence within a package group

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 offers only products that are designed to share a package group and 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 functions available.

Coexistence between package groups

Multiple instances of a product package can exist on the same computer and they are automatically installed into separate package groups. The product packages can be at different versions or fix levels.

If you update a product package, you update only that instance of the product.

Installation repositories

IBM Installation Manager retrieves product packages from specified repository locations.

If the launchpad is used to start Installation Manager, the repository information is passed to Installation Manager. If the Installation Manager is started directly, you must specify an installation repository that contains the product packages that you want to install. See Setting repository preferences in Installation Manager.

Some organizations bundle and host their own product packages on their intranet. Your system administrators will need to provide you with the correct URL.

By default, IBM Installation Manager uses an embedded URL in each Rational software delivery product to connect to a repository server over the Internet. Installation Manager then searches for the product packages as well as new features.

Setting repository preferences in Installation Manager

When you start the installation of Rational Functional Tester from the launchpad program, the location of the repository that contains the product package you are installing is automatically defined in IBM Installation Manager when it starts. However, if you start Installation Manager directly (for example, installing Rational Functional Tester from a repository located on a Web server) then you must specify the repository preference (the URL for the directory that contains the product package) in Installation Manager before you can install the product package.

Before you begin

Specify these repository locations on the Repositories page of the Preferences window. By default, Installation Manager uses an embedded URL in each Rational software development product to connect to a repository server through the Internet and search for installable packages and new features. Your organization may require you to redirect the repository to use intranet sites.

Note:
Before starting the installation process, be sure to obtain the installation package repository URL from your administrator.

About this task

To add, edit, or remove a repository location in Installation Manager:

  1. Start Installation Manager.
  2. On the Start page of Installation Manager, click File -> Preferences, and then click Repositories. The Repositories page opens, showing any available repositories, their locations, and whether they are accessible.
  3. On the Repositories page, click Add Repository.
  4. In the Add repository window, type the URL of the repository location or browse to it and set a file path.
  5. Click OK. If you provided an HTTPS or restricted FTP repository location, then you will be prompted to enter a user ID and password. The new or changed repository location is listed. If the repository is not accessible, a red x is displayed in the Accessible column.
  6. Click OK to exit.

What to do next

Note:
For Installation Manager to search the default repository locations for the installed packages, ensure the preference Search service repositories during installation and updates on the Repositories preference page is selected. This preference is selected by default.

Web-based help content

Your 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. Some help systems are not configured to access help content on the Web; in such cases, help content is included with the installation.

If your product is configured to use remote help, you can obtain help three ways. One of these options will be best for you, depending on your needs and situation:

You can change your access decision any time. If an internet connection is an issue, a 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 information center for instructions on installing a WAR file on your intranet server.

Preinstallation tasks

Before you install the product, you might need to prepare or configure your computer.

Increasing the number of file handles on Linux workstations

About this task

Important: For best results, before you work with your Rational product, increase the number of file handles available for Rational Functional Tester, because it uses more than the default limit of 1024 file handles per process. (A system administrator might need to make this change.)

Exercise caution when following these steps to increase your file descriptors on Linux. Failure to follow the instructions correctly might result in a computer that will not start correctly. For best results, have your system administrator perform this procedure.

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
  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.

    Important: If you decide to increase the number of file handles, do not leave an empty initscript file on your computer. If you do so, your machine will not start up the next time that you turn it on or restart.

  4. On the first line, type ulimit -n 4096 (the key here is that the number is significantly larger than 1024, the default on most Linux computers). Caution: do not set this too high, because it can seriously impact system-wide performance.
  5. On the second line, type eval exec "$4".
  6. Save and close the file after making sure you have done steps 4 and 5.
    Note:
    Ensure you have followed the steps correctly, as not doing this correctly will result in a machine that does not boot.
  7. Optional: Restrict your 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, you might consider a smaller number in step 4 above (for example, 2048). You need to do this so that most users have a reasonably low limit on the number of allowable open files per process. If you used a relatively low number in step 4, it is less important to do this. However, if you choose to set a high number in step 4, refraining from establishing limits in the limits.conf file can seriously impact computer performance.

    The following is a sample limits.conf file that restricts all users and then sets different limits for others afterwards. This sample assumes you set descriptors 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 example above 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 descriptors open, while user1 is in between the two. Make sure you read and understand the documentation contained within the limits.conf file before making your modifications.

What to do next

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

Verifying and extracting electronic images

After you download the installation files, you must extract the electronic image from the compressed file before you can install Rational Functional Tester. You may want to verify the completeness of the downloaded files before extracting the image.

About this task

If you select the Download Director option for downloading the installation file, the Download Director applet automatically verifies the completeness of each file that it processes.

Extracting the downloaded files

About this task

Extract each compressed file to the same directory. For Linux: Do not include spaces in the directory names, or you won't be able to run the launchpad.sh command to start the launchpad from a command line.

Installing software

This section provides the instructions for installing IBM® Installation Manager and the product as well as installation verification.

To install your product, follow the procedures and information in these topics.

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 Rational Functional Tester in these cases:

By starting the installation process from the launchpad program, IBM Installation Manager is 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 and start Installation Manager directly, then you must set repository preferences manually.

What to do next

Important:
Installation notes for the Windows Vista operation system:

Starting the launchpad

To start the launchpad, complete the following steps:

Starting installation from the Setup disk

If you want to install Rational Functional 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.

To start the installation of Rational Functional Tester as a non-Admin from the Setup disk, complete the following steps:

To start the installation of Rational Functional Tester as an Admin from the Setup disk, complete the following steps:

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 Functional Tester.

Working with IBM Installation Manager

IBM® Installation Manager is the tool that you use to install your software packages. It is installed automatically when you start the installation for your product offering.

About this task

If you start the installation of IBM Rational Functional Tester from the Setup disk, either by using the launchpad program or by running the userinst program, IBM Installation Manager automatically starts even if it is not already installed. You will then install Installation Manager on your computer during the process of installingRational Functional Tester

The latest version of Installation Manager might be required for your package. Updates are discovered if you have not cleared the Search service repositories for updates check box on Repositories page in the Preferences window of Installation Manager.

This section deals with some common tasks relating to IBM Installation Manager. For more information, see the Installation Manager online help or the Installation information center.

Note:
You can run Installation Manager in silent mode to install, update, and uninstall packages. For information on installing silently, see Installation information center.
Note:
Installation Manager is installed only once for each user ID on the computer.

Installing Installation Manager

  1. On the Setup disk, change to the InstallerImage_platform subdirectory.
  2. Enter one of the following commands:
  3. On the first page of the Install Packages wizard, click Check for Other Versions and Extensions to install the latest available version. If a newer version is available, it is automatically selected for installation. Click Next.
  4. Review the license agreement on the License Agreement page and select I accept the terms in the license agreement to accept. Click Next.
  5. Click the Browse button on the Destination Folder page to change the installation location if required. Click Next.
  6. Click Install on the Summary page. When the installation process is complete, a message confirms the success of the process.
  7. Click Restart Installation Manager. IBM Installation Manager opens.

Starting Installation Manager on Windows

About this task

IBM Installation Manager should be started from the launchpad program. Doing so starts Installation Manager with a configured repository preference and selected Rational Functional Tester packages. If you start Installation Manager directly, then you must set a repository preference and choose product packages manually.

To start Installation Manager manually:

What to do next

Note:
On Windows Vista operating system, you must run Installation Manager as administrator: Right-click the program shortcut and click Run as administrator.

Uninstalling Installation Manager on Windows

About this task

To uninstall Installation Manager:

  1. Go to the Control Panel and double-click Add or Remove Programs.
  2. Select IBM Installation Manager.
  3. Click Remove.

Uninstalling Installation Manager on Linux

About this task

IBM Installation Manager must be uninstalled using the package management tool that is included with your Linux version.

To uninstall Installation Manager manually on Linux:

  1. Open a terminal window with root user privileges.
  2. Change directory to the uninstallation directory of Installation Manager. By default, this is /var/ibm/InstallationManager/uninstall.
  3. Run ./uninstall.

Installing Rational Functional Tester

This topic provides the instructions for installing IBM Rational Functional Tester.

Before you begin

You must start your installation from the Setup disk, either by running the launchpad program or by running the userinst program.

In the instructions that follow, it is assumed that you started your installation from the Setup disk. If you want Installation Manager to search for the latest available version of the packages you are installing, ensure that you are connected to the Internet.

About this task

To install IBM Rational Functional Tester, complete the following steps:

  1. Depending on your user ID, complete one of the following steps:
  2. If Installation Manager is not installed on your system or if an older version of Installation Manager is installed, IBM Installation Manager is listed in the Install Packages page.
    1. Follow the on-screen instructions in the wizard and install IBM Installation Manager.
    2. When the installation process completes, click Restart Installation Manager. Installation Manager closes and restarts.
  3. In the Installation Manager Start page, click Install.
  4. The Install page of the Install Packages wizard lists all the packages found in the repositories that Installation Manager searched. If two versions of a package are discovered, only the most recent, or recommended, version of the package is displayed.
  5. Click the IBM Rational Functional Tester package to display its description in the Details pane.
  6. To search for updates to the IBM Rational Functional Tester package, or for extension offerings that can be applied on IBM Rational Functional Tester, click Check for Other Versions and Extensions.
    Note:
    For Installation Manager to search the predefined IBM update repository locations for the installed packages, the preference Search the linked repositories during installation and updates on the Repositories preference page must be selected. This preference is selected by default. Internet access is also required.
    Installation Manager searches for updates at the predefined IBM update repository for the product package. It also searches any repository locations that you have set. A progress indicator shows the search is taking place. You can install updates at the same time that you install the base product package.
  7. If updates for the IBM Rational Functional Tester package are found, then they will be displayed in the Installation Packages list on the Install Packages page below their corresponding product. The latest updates are displayed by default.
  8. Select the IBM Rational Functional Tester 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.
    Important:
    If you are installing on Windows Vista, then to enable users who do not have Administrator privileges to work with Rational Functional Tester, do not choose a directory inside the Program Files directory (C:\Program Files\).

    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, specify whether to create a package group and install the IBM Rational Functional Tester package into a new package group or use an existing package group to shell-share with another offering. 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
      Note:
      If you are installing on Linux, ensure that you do not include any spaces in the directory path.
      Important:
      On Windows Vista, the Program Files directory is usually virtualized in order to allow users who are not running as the administrator to have write access to this protected directory. However, the virtualization workaround is not compatible with Rational Functional Tester.
    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.2 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 IBM Rational Functional Tester 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. When you are finished selecting features, click Next to continue.
  15. On the next Help System Features page, select the required option to access the help contents for the product. For more information about the help configuration, see Web-based help content.
  16. On the Summary page, review your choices before installing the IBM Rational Functional Tester 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.
    2. Click Finish.

Working with test agents

Test agents are remote computers that are capable of running test scripts.

Before you begin

You can use Rational TestManager or Rational ClearQuest Test Manager to coordinate remote testing activities from a local computer.

About this task

To run test scripts remotely, you must perform the following steps:

  1. Install Rational Functional Tester on the local computer.
  2. Install either IBM Rational TestManager v7.0.1.2 or Rational ClearQuest Test Manager on the local computer.
  3. To work with TestManager, install the Rational Test Agent software, located on the TestManager CD, and the Rational Agent Controller on the remote agent.
  4. To work with Rational ClearQuest Test Manager, install the Rational Agent Controller on the remote agent. (You can install just the Rational Agent Controller or the full Rational Functional Tester.)
  5. Start the Rational Test Agent software or the IBM Rational Agent Controller on the remote computer.
  6. Enable environments on the remote system.
  7. Configure applications to run on the remote system.

Installing the Rational Test Agent on Windows

This topic describes how to install the Rational Test Agent on a Windows computer.

About this task

Here are the steps:

  1. Log on with administrative privileges.
  2. Insert the CD containing the Rational Test Agent software into your CD drive. If the installation does not start automatically, perform these steps:
    1. Click Start -> Run
    2. Type: cd_drive:\SETUP.EXE.
    3. Click OK.
  3. In the Software Setup page, click Next.
  4. In the Product List, select Rational Test Agent.
  5. Click Next.
  6. Select all of the defaults provided by the wizard. You might need to restart the system to complete the installation.
  7. Click Finish in the last dialog box.

What to do next

After installing the Rational Test Agent, you must install the Rational Agent Controller, which you can find on the Rational Functional Tester CD.

Starting the Rational Test Agent on Windows

This topic describes how to start a Test Agent on a Windows computer.

About this task

To start the Rational Test Agent on Windows, perform these steps:

  1. Click Start -> Programs -> Rational Test Agent -> Rational Test -> Rational Test Agent.
  2. Enable the testing environments you want to use on the test agent.
  3. Configure the applications you want to test on the test agent.

Installing the Rational Test Agent on Linux

This topic describes how to install the Rational Test Agent on a Linux computer.

Before you begin

Before starting, be sure to uninstall all previous versions of Rational Functional Tester and disable all of their environment variables.

About this task

Here are the steps:

  1. Log on with administrative privileges.
  2. Create the installation directory:

    % mkdir -p /usr/rational/test

  3. Insert the CD-ROM containing the Rational Test Agent software into your CD drive.

    If the CD does not auto-mount, enter the Linux mount command at the prompt:

    % mount /dev/cdrom /mnt/cdrom

  4. Go to the test directory:

    % cd /usr/rational/test

  5. Enter the tar command to copy the Rational Test Agent files to your hard drive:

    % tar xzpf /mnt/cdrom/linux_agent.tar.gz

Starting the Rational Test Agent and the RAServer on Linux

This topic describes how to start the Rational Test Agent and the RAServer on Linux.

Before you begin

Before you can run the Rational Test Agent, you must set the RATL_RTHOME environment variable to /usr/rational/test by entering either of the following commands:

% export RATL_RTHOME=/usr/rational/test

% setenv RATL_RTHOME=/usr/rational/test

About this task

To start the Rational Test Agent on Linux, do the following:

  1. Set the environment variable LD_LIBRARY_PATH to libjava.so of the currently used JRE.
  2. Set the CLASSPATH to <product installation directory>/bin/rational_ft.jar
  3. Execute the following command:

    source <product installation directory>/rtsetup.

  4. From the Test Manager installation directory, run RTsagt.

What to do next

To start the RAServer for ClearQuest Test Manager remote execution, enter the following command from the product installation directory:

ft_agent_start

You can verify that the Test Agent is running by entering this command:

ps -ef | grep rtprvd

You can verify that the RAServer is running by entering this command:

ps -ef | grep RAServer

Enabling environments on Test Agents

This topic describes how to enable test environments on test agents.

Before you begin

The first time you start Rational Functional Tester, it automatically enables your environment for running functional test scripts. If you add a browser or add a new Java environment, you must enable the new browser or Java environment.

If you use TestManager or Rational ClearQuest Test Manager to coordinate your testing activities and run a functional test script on a test agent computer, you must enable environments on the agent computer that runs the script.

About this task

To enable environments:

  1. Do one of the following to start the Enabler.
    1. For Windows: Change to the directory where the rational_ft.jar file is located (by default, <product installation directory>\FunctionalTester\bin) and then from the command line, type:

      java -jar rational_ft.jar -enable

      Note:
      You may also need to type the full path to the IBM JRE, which can be found, by default, at <product installation directory>\SDP\jdk\jre\bin

      .

    2. For Linux: From the command line, type: /opt/IBM/SDP/ft_cmdline -enable
  2. When the Enabler starts, click the Web Browsers tab to enable browsers.
  3. Click the Java Environments tab to enable Java environments.
  4. Click OK.

Configuring applications on Test Agents

This topic describes how to configure applications on test agents.

Before you begin

Before you can test your applications, you must configure them. When you configure your applications, you provide the name, path, and other information about the application that you intend to test. This information is used during record and playback to make the test script more reliable and portable. If you use TestManager for remote execution on a Test Agent computer, you need to configure applications on the agent computer that runs the script.

About this task

To configure applications, perform these steps:

  1. To start the Application Configuration Tool:
    1. For Windows: Change to the directory where the rational_ft.jar file is located (by default, <product installation directory>\FunctionalTester\bin) and then from the command line, type:

      java -jar rational_ft.jar -appConfig

      Note:
      You may also need to type the full path to the IBM JRE, which can be found by default at <product installation directory>\SDP\jdk\jre\bin.
    2. For Linux: From the command line, type: /opt/IBM/SDP/ft_cmdline -appconfig
  2. Click Add. The Application Configuration Tool starts.
  3. Select the application type and click Next.
  4. Take one of the following steps to configure the application:
  5. Click Open.

    The file name and path appear in the Filename field.

  6. Click Finish.

    The application appears in the Applications list in the Application Configuration Tool.

  7. Review the information in the Detailed Information list.

    For a Java application, the Name, Kind, Path, .class/.jar file, and Working Dir fields are automatically filled in. The JRE, Classpath, and Args fields are optional.

  8. Make any necessary edits to the information in the fields. For details, see the product Help.
  9. Click Run to ensure you have properly configured your application.
  10. Click OK or Apply to save the changes you made.
    Note:
    After you add an application, you can edit its information at any time by opening the Application Configuration Tool and selecting the application in the Applications list. To remove an application from the Applications list, select the application and click Remove.

Post-installation tasks

After you have installed your product package, complete the post-installation tasks or configure your product package as required.

Post-installation checklist

After you have installed your product, complete several tasks to configure and verify the installation.

Before you begin

About this task

Review the following information and ensure the post-installation steps are completed as required.

__   1.
Verify your installation and ensure that you can start your product.
__   2.
Configure your license for Rational Functional Tester .
__   3.
If you chose the option to download the help content for your product during the installation process, then you must download the help content from the Local Help System Updater site.

Starting Rational Functional Tester

You can start Rational Functional Tester from the desktop environment or a command-line interface.

Managing 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.

About this task

Trial licenses that came with the 8.0 and later versions of some Rational products expire 30 or 60 days after installation. You need to activate your product in order to use it after the expiration date.

Using the Manage Licenses wizard, you can 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 IBM Rational software products, 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 permits a single, specific 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 specific individual, who can then use the Rational software product. The Authorized User license does not entitle a second person to use that product at any time, even if the licensed individual is not actively using it.

Authorized User Fixed Term License

An IBM Rational Authorized User Fixed Term License (FTL) permits a single, specific 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 end-user requests for access to the license keys; it will grant access to the number of concurrent users that matches the number of licenses the organization purchased.

License enablement

If you are installing a Rational software product 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 Rational Software Delivery Platform offerings are enabled in two ways:

Note:
Trial licenses that came with the 8.0 and later versions of some Rational products expire 30 or 60 days after installation. You need to activate your product in order to use it after the expiration date. See support article http://www.ibm.com/support/docview.wss?uid=swg21250404 on product activation for a flow chart of the activation process.

Activation kits

Product activation kits contain the permanent license key for your trial Rational product. You purchase the activation kit, download the activation kit .zip file to your local machine, and then import the activation kit .jar file to enable the license for your 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:

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

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.

Importing a product activation kit

To install your permanent license key, you must import the activation kit from the download location or the product media by using IBM Installation Manager.

Before you begin

If you have not purchased an activation kit, you must do this first. If you have purchased a product or a product activation kit, insert the appropriate CD or download the activation kit from IBM Passport Advantage to an accessible workstation. The activation kit is packaged as a .zip file containing a Java archive (.jar) file. The .jar file contains the permanent license key and must be imported to activate your product.

About this task

To import an activation kit .jar file and enable the new license key:

  1. Start IBM Installation Manager.
  2. On the main page, click Manage Licenses.
  3. Select a package and click the Import Activation Kit button.
  4. Click Next. Details for the selected package are shown, including the current license kind and the product version range of the license.
  5. Browse to the path on the media CD or download location for the activation kit; then select the appropriate Java archive (JAR) file and click Open.
  6. Click Next. The Summary page displays the target install directory for the activation kit, the product the new license applies to, and version information.
  7. Click Finish.

Results

The product activation kit with its permanent license key is imported to the product. The Manage Licenses wizard indicates whether the import is successful.

Enabling floating licenses

If your team environment supports Floating license enforcement, you can enable Floating licenses for your product and configure a connection to obtain access to floating license keys.

Before you begin

Before enabling Floating license enforcement, you must obtain the license server connection information from your administrator. For details on license server, license key, and Rational Common Licensing administration, see the IBM Rational License Management Guide.

About this task

To enable floating licenses as the license type for specified packages and configure license server connections:

  1. In the IBM Installation Manager for the Rational Software Delivery Platform, click File -> Open -> Manage Licenses.
  2. Select a version of a package and then select the Configure Floating license support button.
  3. Click Next.
  4. Click the Enable Floating license enforcement button.
  5. Configure one or more license server connections.
    1. Click an empty field in the Servers table or click the Add button.
    2. If your administrator provided you with information for a redundant server environment, click the Redundant Server button. Fields for the primary, secondary, and tertiary server names and ports appear.
    3. Enter the host name of the license server in the Name field.
    4. (Optional) Enter a value in the Port field for environments where a firewall is used. Do not assign a value to this port unless your administrator instructs you to do so.
    5. For redundant server environments, enter the names and ports (if required) for the secondary and tertiary servers.
    6. (Optional) You can click the Test Connection button to confirm that the connection information is correct and that the server is available.
    7. Click OK.
  6. Click Next.
  7. (Optional) Configure the license usage order for your shell shared or custom packages. The order of licenses in the list determines the order in which your package attempts to obtain access to license keys for a given licensed package.
  8. Click Finish.

Results

The Manage Licenses wizard indicates whether the floating licenses configuration is successful.

What to do next

Now, when you next open the enabled product, a connection is created to the license server to obtain a license key from the pool of available floating license keys.

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 enable 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 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.

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 from the following URL: http://publib.boulder.ibm.com/infocenter/rfthelp/v8r1/index.jsp.

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

  1. Click Windows -> Preferences to open the Preferences window
  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 publib.boulder.ibm.com
    4. In the Path field, type /infocenter/rfthelp/v8r1.
    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.

Downloading help content from the Local Help System Updater site

This file 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.

Delivering help content from an intranet server

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. Depending on your security requirements and organizational needs, you can provide help content to users from an intranet server. This arrangement frees up disk space on users' computers, because one copy of the help content is stored on a server. You can also make sure that all users have the latest help content from IBM with a single update to the intranet server.

Before you begin

Providing help content on an intranet server requires deploying the enterprise help.WAR application on the server. You must have an application server for this purpose.

About this task

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

Because each enterprise is different, an example shows the procedures of setting up the application server and deploying the help.WAR application. For this example, the procedures show how to deliver help content with the open-source Apache Tomcat Application Server. The basic procedure applies to all servers; the specifics for your server might vary. Review the deployment instructions for your application server.

This example uses Apache Tomcat 6.0. You can download the server application from http://tomcat.apache.org.

Note:
Apache Tomcat 6.0 requires the Java 2 Standard Edition (J2SE) Runtime Environment (JRE), version 5.0 or later.

To set up the Apache Tomcat Application server for providing help content:

  1. Download and install according to the included instructions the J2SE JRE: http://java.sun.com/j2se.
    Note:
    You can also use the full JDK rather than just the JRE. In this case set your JAVA_HOME environment variable to the path name of the directory into which you installed the JDK. For example, use one of these environment variables: setc:\j2sdk5.0 or /usr/local/java/j2sdk5.0.
  2. Set an environment variable named JRE_HOME to the pathname of the directory into which you installed the JRE. For example, set one of these environment variables: c:\jre5.0 or /usr/local/java/jre5.0.
  3. Unpack the binary distribution files into a convenient location so that the distribution is located in its own directory, which is typically named apache-tomcat-version. For the purposes of the remainder of this document, the name $CATALINA_HOME is used to refer to the full path name of the release directory.
  4. Place the Help.WAR in the webapps folder: $CATALINA_HOME\webapps.
  5. Start Apache Tomcat by entering this command (Windows): $CATALINA_HOME\bin\startup.bat. After startup, the default Web applications that Apache Tomcat includes are available at this address: http://localhost:8080/.
  6. After you open the startup page, you can access the help system by adding help/index.jsp to the end of your URL: http://localhost:8080/help/index.jsp.
  7. To enable your users to access the help content from your application server, provide the users with the server, the port, and the path to the help system.
  8. With this information available, users start the workbench, and then click Window -> Preferences.
  9. Users select the Help preferences, expand it, and select Include help content from a remote infocenter, and then click Add.
  10. Users type the server name, host, path, and port in the appropriate fields, and then click OK.
  11. To obtain updated user assistance, navigate to the update window and follow the installation and update instructions there: http://localhost:8080/help/updater/updatewar.jsp
  12. To update the help content, you must clear the cache. Otherwise, updates are not reflected in the browser. Perform these steps to clear the cache in preparation for an update:
    1. Shut down the Apache Tomcat application server by entering this command: $CATALINA_HOME\bin\shutdown.bat.
    2. Navigate to the $CATALINA_HOME\work\Catalina\localhost directory, and delete the help folder, which contains your uncompressed Web application.
    3. Copy your new help.WAR file into the $CATALINA_HOME\webapps folder, and restart the Apache Tomcat application server.

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 you access help content.

About this task

To change the way that you access help content:

  1. Click Windows -> 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; 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 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 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 Preferences.
    4. Click Help -> Help Contents, to open your help.

Updating help content

You can 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.

Updating Rational Functional Tester

You can install updates for packages that were installed with IBM Installation Manager. Package updates provide fixes and updates to installed features and might also include new features that you can install using the Modify Packages wizard.

Before you begin

By default, Internet access is required unless your repository preferences points to your local update site.

Each installed package has the location embedded for its default IBM update repository. For Installation Manager to search the IBM update repository locations for the installed packages, the preference Search service repositories during installation and updates on the Repositories preference page must be selected. This preference is selected by default.

See the Installation Manager help for more information.

Note:
Close all programs that were installed using Installation Manager before updating.

About this task

To find and install product package updates:

  1. From the Start page of the Installation Manager, click Update.
  2. If IBM Installation Manager is not detected on your system or if an older version is already installed, then you must continue with the installation of the latest release. Follow the instructions in the wizard to complete the installation of IBM Installation Manager
  3. In the Update Packages wizard, select the location of the package group where the Rational Functional Tester product package you want to update is installed or select the Update All check box, and then click Next. Installation Manager searches for updates in its repositories and the predefined update sites for Rational Functional Tester. A progress indicator shows the search is taking place.
  4. If updates for a package are found, then they are displayed in the Updates list on the Update Packages page below their corresponding package. Only recommended updates are displayed by default. Click Show all to display all updates found for the available packages.
    1. To learn more about an update, click the update and review its description under Details.
    2. If additional information about the update is available, a More info link will be included at the end of the description text. Click the link to display the information in a browser. Review this information before installing the update.
  5. Select the updates that you want to install or click Select Recommended to restore the default selections. Updates that have a dependency relationship are automatically selected and cleared together.
  6. Click Next to continue.
  7. On the Licenses page, read the license agreements for the selected updates. On the left side of the License page, the list of licenses for the updates you selected is displayed; click each item to display the license agreement text.
    1. If you agree to the terms of all the license agreements, click I accept the terms of the license agreements.
    2. Click Next to continue.
  8. On the Summary page, review your choices before installing the updates.
    1. If you want to change the choices you made on previous pages, click Back, and make your changes.
    2. When you are satisfied, click Update to download and install the updates. A progress indicator shows the percentage of the installation completed.
    Note:
    During the update process, Installation Manager might prompt you for the location of the repository for the base version of the package. If you installed the product from CDs or other media, they must be available when you use the update feature.
  9. Optional: When the update process completes, a message that confirms the success of the process is displayed near the top of the page. Click View log file to open the log file for the current session in a new window. You must close the Installation Log window to continue.
  10. Click Finish to close the wizard.
  11. Optional: Only the features that you already have installed are updated using the Update wizard. If the update contains new features that you would like to install, run the Modify wizard and select the new features to install from the feature selection panel.

Modifying installations

The Modify Packages wizard in the IBM Installation Manager enables you to change the language and feature selections of an installed product package. You can also use the Modify Packages wizard to install new features that might be included in a package update, such as a refresh pack.

Before you begin

By default, Internet access is required unless the repository preferences points to a local update site. See the Installation Manager help for more information.

Note:
Close all programs that were installed using Installation Manager before modifying.

About this task

To modify an installed product package:

  1. From the Start page of the Installation Manager, click the Modify icon.
  2. In the Modify Packages wizard, select the installation location for the Rational Functional Tester product package and click Next.
  3. On the Modify page, under Languages, select the languages for the package group, then click Next. The corresponding national language translations for the user interface and documentation for the packages will be installed. Note that your choices apply to all packages installed under this package group.
  4. On the Features page, select the package features that you want to install or remove.
    1. To learn more about a feature, click the feature and review the brief description under Details.
    2. If you want to see the dependency relationships between features, select Show Dependencies. When you click a feature, any features that depend on it and any features that are its dependents are shown in the Dependencies window. As you select or exclude 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.
  5. When you are finished selecting features, click Next.
  6. On the Summary page, review your choices before modifying the installation package, and then click Modify.
  7. Optional: When the modification process completes, click View Log File to see the complete log.

Reverting updates to previous versions

You can remove an update to some packages to revert to a previous version by using the Roll Back Packages wizard of IBM Installation Manager.

Before you begin

During the rollback process, Installation Manager must access files from the earlier version of the package. By default, these files are stored on your computer when you upgrade to a new package. If you have deleted the files that are saved locally for rollback or cleared the Save files for rollback check box in the Preferences page (File > Preferences > Files for Rollback) while upgrading, you will not be able to roll back to the previous version without the media or repositories that were used to install that version of the package.

About this task

Use the rollback feature if you have applied an update to a product package and decide later that you want to remove the update and revert to the earlier version of the product. When you use the rollback feature, Installation Manager uninstalls the updated resources and reinstalls the resources from the previous version. You can only roll back one version level at a time.

For more information, see the Installation Manager online help or Information Center.

To revert an update to a previous version, complete the following steps:

  1. On the Start page, click Roll back Packages.
  2. In the Rollback wizard, from the Installation Packages list, select the package that you want to revert to the previous version.
  3. Follow the instructions in the wizard.

Uninstalling Rational Functional Tester

The Uninstall Packages option in the Installation Manager enables you to uninstall packages from a single installation location. You can also uninstall all the installed packages from every installation location.

Before you begin

To uninstall the packages, you must log in to the system using the same user account that you used to install the product packages.

Note:
Before you uninstall Rational Functional Tester, close the Eclipse and Visual Studio IDEs, as well as any open Web browsers, and all other applications that are enabled by Functional Tester.

About this task

To uninstall the packages:

  1. Close the programs that you installed using Installation Manager.
  2. On the Start page click Uninstall Packages.
  3. In the Uninstall Packages page, select the Rational Functional Tester product package that you want to uninstall. Click Next.
  4. In the Summary page, review the list of packages that will be uninstalled and then click Uninstall. The Complete page is displayed after the uninstallation finishes.
  5. Click Finish to exit the wizard.

IBM Packaging Utility

Use IBM Packaging Utility software to copy product packages to a repository that can be placed on a Web server available over HTTP or HTTPS.

Packaging Utility software is located on the Enterprise Deployment CD for each platform (Windows and Linux) that is included with Rational Functional Tester. If you want to place a repository that contains a Rational Functional Tester package on a Web server that will be available over HTTP or HTTPS, you must use Packaging Utility to copy the product package of Rational Functional Tester into the repository.

Use this utility to perform the following tasks:

Refer to the online help for Packaging Utility for full instructions using the tool.

Installing Packaging Utility

IBM Packaging Utility must be installed from the Enterprise Deployment CD before it can be used to copy the Rational Functional Tester product package.

About this task

Use the following steps to install IBM Packaging Utility software from the Enterprise Deployment CD:

  1. Navigate to the Enterprise Deployment CD for the appropriate platform and extract the zip file from the CD.
  2. Navigate to the Packaging Utility directory and extract the Packaging Utility installation package from the compressed file (pu.disk_win32.zip or pu.disk_linux.zip).
  3. Locate the Packaging Utility installer executable.
  4. Start the installer executable and follow the instructions in the wizard to install the Packaging Utility.
  5. If IBM Installation Manager is not detected on your workstation, you are prompted to install it and then the installation wizard starts. Follow the instructions in the wizard to complete the installation of Installation Manager. See Installing Installation Manager for details.
  6. When the installation of Installation Manager completes, or if it is already on your computer, Installation Manager starts and automatically begins the Install Packages wizard.
  7. Follow the instructions in the Install Packages wizard to complete the installation.

Copying product packages to an HTTP server using Packaging Utility

To create a repository on an HTTP or HTTPS server, you must use Packaging Utility to copy the product package for Rational Functional Tester.

About this task

Note that this method does not copy the optional software that is included with the Rational Functional Tester installation image. Only the Rational Functional Tester files that are installed using IBM Installation Manager are copied.

Note also that Packaging Utility can be used to combine multiple product packages into a single repository location. See the Packaging Utility online help for more information.

To copy product packages with Packaging Utility:

  1. If you are copying from a CD image, perform these tasks:
    1. Insert the first installation CD into your CD drive.
    2. For Linux: Mount the CD drive.
    3. If autorun is enabled on your system, the Rational Functional Tester launchpad program automatically opens. Close the launchpad program.
  2. Start Packaging Utility.
  3. On the main page of the utility, click Copy Packages. The Prerequisite page opens, and presents two options:
  4. Click I will be downloading product packages from IBM Web.
    Note:
    You can use the I will be obtaining the product packages from other sources option if you have already defined an accessible repository.
  5. Click Next to advance to the Source page. If there are no product packages to select, you must open a repository that contains product packages.
  6. To open a repository, click the Open repository button. The Open Repository window opens.
    Note:
    A repository can be a path to a file on the local file system, a disk drive containing the first CD of the product, or a URL to a file on a server.
  7. To define a repository location, click the Repository Location Browse button, and then navigate to the Repository location (the common root directory) that contains the disk images. For example, if the product files (disk1, disk2, and so on) reside in C:\productA\unzip, you should navigate there and select the repository.config file, the diskTag.inf, the jar file, or a zip file.
  8. Click OK to define the repository location and to close the Browse to a repository directory window.
  9. On the Destination page, click the Browse button and select an existing repository directory, or create a new folder to store the products.
  10. After you specify a repository for the selected product packages and any fixes, click OK to close the Browse to a directory window. The file path that you just defined is listed in the Directory field on the Destination page.
  11. Click Next to advance to the Summary page. The Summary page displays the selected product packages that will be copied into the destination repository. This page also lists the amount of storage space that the copy requires, as well as the amount of available space on the drive.
  12. Click Copy to copy the selected product packages to the destination repository. A status bar opens at the bottom of the wizard indicating how much time is remaining in the copy process. After the copy process is finished, a Complete page opens and displays all of the product packages that were copied successfully.
  13. Click Done to return to the Packaging Utility main page.

Example

Now that you have used Packaging Utility to copy the Rational Functional Tester installation files into a repository, you can place the repository on a Web server and make the directories and files available over HTTP. (The repository can also be placed on a UNC drive.)

For the latest information about working with IBM Packaging Utility, visit the IBM Packaging Utility Information Center at http://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp.

What to do next

Notices

© Copyright IBM Corporation 2000, 2010.

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 document 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:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 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 Documentation 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.

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.

Trademarks and service marks

The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both:

Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.

Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

Other company, product or service names, may be trademarks or service marks of others.