IBM Rational Method Composer, Version 7.5

Installation guide

Version 7.5
Note

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

Contents

Installation introduction
Installation terminology
Installation default values and conventions
Planning the installation
Installation roadmap
Installation Manager overview
Installation requirements
Hardware and software requirements
User privilege requirements
Planning your installation
Installation scenarios
Installation repositories
Pre-installation tasks
Pre-installation checklist
Increasing the number of file handles on Linux computers
Mounting a drive
Verifying and extracting electronic images
Extracting the downloaded files
Installing software
Installing Rational Method Composer from a CD: task overview
Installing Rational Method Composer from an electronic image on your workstation: task overview
Installing from an electronic image
Installing Rational Method Composer from an electronic image on a shared drive: task overview
Installing from the launchpad program
Starting the launchpad program
Starting an installation from the launchpad program
Installing IBM Installation Manager
Starting IBM Installation Manager
Installing Rational Method Composer by using IBM Installation Manager
Post-installation tasks
Post-installation checklist
Starting Rational Method Composer
Managing licenses
License activation
Viewing license information for installed product packages
Verifying the installation
Installing software silently
Creating a response file
Running Installation Manager in silent installation mode
Silently installing updates to all currently installed products
Response file commands
Silent installation preference commands
Silent installation commands
Reference: Sample response file
Silent install log files
Managing IBM Installation Manager - Additional information
Setting repository preferences in Installation Manager
Modifying installed product packages
Updating installed product packages
Reverting updates to previous versions
Uninstalling software
Uninstalling product packages
Uninstalling IBM Installation Manager
Notices
Trademarks and service marks

Installation introduction

This installation guide provides instructions for installing and uninstalling Rational(R) Method Composer and IBM(R) Rational Unified Process(R).

You can find the most recent version of this document online at the IBM Publications center, including updated translation versions.

Note:
Refer to http://www.ibm.com/software/rational/support/ for troubleshooting information.

Installation terminology

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

The following terms are used in the installation information:

Admin user
A user who has privileges to write to the default common installation location. On Linux(R) operating systems, this is the "root" or any user who is using "sudo" to start Installation Manager. On Microsoft(R) Windows(R) XP, this is any user who is a member of the "Administrators" group. On Microsoft Windows Vista, this is the user who is using "Run As Administrator" to start Installation Manager.
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 represents 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 disabled.)
Repository
A persistent storage area where packages are available for download. A repository can be disc media, a folder on a local hard disk, or a server location.
Shared resources directory
In some instances, product packages can share resources. These resources are located in a directory that the packages share.

Installation default values and conventions

The installation documentation uses conventions such as Shared resources directory that infer specific directory locations. This topic describes the conventions that are used for Rational Method Composer and their associated default value.

Table 1. Installation documentation conventions and default values
Name Convention in installation documentation Default Value
Installation Manager installation directory Installation Manager directory
  • For Windows: C:\Program Files\IBM\Installation Manager
  • For Linux.: /opt/IBM/Installation Manager
Installation manager Shared resources directory Shared resources directory
  • For Windows: C:\Program Files\IBM\SDPShared
  • For Linux.: /opt/IBM/SDPShared
Rational Method Composer installation directory Rational Method Composer directory
  • For Windows: C:\Program Files\IBM\RMC
  • For Linux.: /opt/IBM/RMC
Rational Method Composer workspace directory workspace directory
  • For Windows: <user.home>\IBM\RMC\workspace.75
  • For Linux.: <user.home>/IBM/RMC/workspace.75

Planning the installation

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

Installation roadmap

The installation roadmap lists the major tasks for installing your product.

Roadmap for installing Rational Method Composer

Perform these tasks to install Rational Method Composer:

  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. Start the launchpad.
  6. In the launchpad, click to install Rational Method Composer. Follow the instructions in the Install Packages wizard to install or update Installation Manager, if necessary, and install the product.
  7. Verify that the installation was successful.
  8. Perform any necessary post-installation tasks, such as configuring the appropriate product license.

Installation Manager overview

IBM Installation Manager is a program that helps you install the Rational Method Composer product packages on your workstation. Installation Manager also helps you update, modify, and uninstall packages. A package can be a product, a group of components, or a single component.

Regardless of which installation scenario you follow to install Rational Method Composer on your workstation, use Installation Manager to install your Rational package.

IBM Installation Manager offers a number of time-saving features. It keeps track of what you are about to install, software components that you have already installed, and components that are available for you to install. It searches for updates so you know that you are installing the latest version of a Rational product package. Installation Manager also provides tools for managing licenses for the product packages that it installs. It provides tools for updating and modifying packages. You can also use it to uninstall product packages.

IBM Installation Manager comprises six wizards that make it easy to maintain packages through their life cycles:

Installation requirements

This section describes hardware, software, and user privilege requirements that you must have to successfully install and run your software.

Hardware and software requirements

Verify that your hardware and software meets or exceeds the minimum requirements. If your hardware and software does not meet the minimum requirements, you might be unable to install or run Rational Method Composer.

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

Hardware Requirements
Processor Intel(TM) Pentium(R) III 800 MHz or higher processor.
Memory 768 MB RAM minimum. More memory is recommended as it improves responsiveness.
Disk space
  • 900 MB to install IBM Rational Method Composer
  • 1800 MB required in the TEMP directory during installation
Display 1024 x 768 display minimum using 256 Colors (or higher for best results). High-color or true-color is recommended.
Other hardware Microsoft mouse or compatible pointing device

Operating system

The following operating systems are supported for this product:

Table 2. Windows environment
Operating system Version
Microsoft Windows Vista Business, Enterprise, or Ultimate editions
Microsoft Windows XP Professional with Service Pack 2 and Service Pack 3
Microsoft Windows Server 2003 Standard Edition with Service Pack 1 and Service Pack 2
Microsoft Windows Server 2003 Enterprise Edition with Service Pack 1 and Service Pack 2
Microsoft Windows Server 2008 aka Longhorn

Table 3. Linux environment
Operating system Version
Red Hat Enterprise WS 4 (Update 4 and 5)
Red Hat Desktop version 4 (Update 4 and 5)
Red Hat Enterprise version 5.0 Server Edition (Update 1)
SuSE SLES 9 Service Pack 3
SuSE SLES 10 Service Pack 1 and Service Pack 2
Note:
The listed operating systems support all supported languages.

Browsers

The following browsers are supported for this product:

Software Version
Internet Explorer 6.0 with Service Pack 1
Internet Explorer 7.0
Firefox 2.0.0.4, 3.0 or later

BIRT reporting

The following software is required if you want to use BIRT reporting:

Software Version
Microsoft Word 2003 or 2007
Adobe(R) Reader 6 or later

User privilege requirements

You must have a user ID that meets specific requirements before you can install your product.

Implications of using an admin or non-admin user ID when installing from the Launchpad

Table 4. The following table describes what happens when user ID's with different access privileges are used when installing
User ID authority while running Installation Manager Click install as Non-admin Click install as Admin
Non-admin (current user)
  • Installation Manager is installed for the current user only, and will not display in other user accounts on the machine.
  • Future products and packages can only be installed to this user account.
  • Installation Manager is installed in the current user area for the Admin ID.
  • After Installation Manager is installed, it will only install products for the current Admin user.
Admin An error message occurs.
  • Installation Manager is installed for All Users.
  • Any products installed with this Installation Manager are for All Users

Planning your installation

After you have verified the hardware, software and user privilege requirements, plan the scenario that you want to install.

Installation scenarios

For Rational Method Composer 7.5, you will install from the launchpad. A trial license is automatically installed when you install Rational Method Composer. Use the Manage license wizard to change the trial license to a full license. See Managing licenses for details. The trial license expires 30 days after the installation.

To start the installation from the launchpad program, use one of the following scenarios:

Installation repositories

IBM Installation Manager retrieves product packages from specific repository locations.

By default, IBM Installation Manager uses an embedded URL in each Rational software development product to connect to a repository server that contains installation product packages and new features. Your organization may require you to redirect the repository connection to use your corporate Intranet site.

When you start the installation of Rational Method Composer from the launchpad program, the location of the repository that contains the product package is automatically defined in IBM Installation Manager.

Pre-installation tasks

You must complete the following tasks before you install Rational Method Composer.

  1. Confirm that your system meets the requirements that are described in the section Installation requirements
  2. Confirm that your user ID meets the required access privileges for installing the product. See User privilege requirements
  3. Read the section Planning the installation.

Pre-installation checklist

Review the following information and ensure that you complete the required pre-installation steps.

__   1.
If you are installing from an electronic image that you downloaded from IBM Passport Advantage(R), verify that you have the required parts and that you have extracted the download files correctly.
__   2.
(For Linux) If you are going to install from physical media, mount your CD drive.
__   3.
(For Linux) If you want accounts other than root to use the product installation, then set the umask variable to 0022 before you install the product. To set this variable, log in as root user, start a terminal session, and type umask 0022.
__   4.
(For Linux) Increase the number of file handles on your computer. For details, see Increasing the number of file handles on Linux computers.
__   5.
Make sure that you are logged on to your computer with an appropriate user ID.

Increasing the number of file handles on Linux computers

Most Rational products use more file handles per process. Increase the number of file handles to more than the default value of 1024 for best product performance. A system administrator might need to make this change.

Important:
If you do not do the following steps correctly, your computer will not start when you reboot.

To increase the number of file handles on Linux:

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

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

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

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

Mounting a drive

With some operating systems, such as Linux, you must mount the drive before you can access data on the product disc.

Insert the product disc into the drive before mounting the drive.

For Linux:

  1. Log in as a user with root access.
  2. Insert the CD-ROM in the drive and enter the following command:mount -t iso9660 -o ro /dev/cdrom /cdrom The /cdrom variable represents the mount point of the CD-ROM.
  3. Log out.

Some window managers can automatically mount your CD-ROM for you. Consult your system documentation for more information.

Verifying and extracting electronic images

If you download the installation files from IBMPassport Advantage, you must extract the electronic image from the compressed files before you can install. You might want to verify the completeness of the downloaded files before extracting the image.

You can compare the published MD5 values with the checksum of the downloaded files to check ifmake sure that the downloaded file is complete.

Extracting the downloaded files

Extract each compressed file to the same directory. For Linux: Do not include spaces in the directory names, or you will not 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 Rational Method Composer as well as installation verification.

Installing Rational Method Composer from a CD: task overview

The following are the general steps for installing Rational Method Composer from a product CD:

  1. Ensure that your workstation has enough disk space to store product packages. See Hardware and software requirements.
  2. Start the launchpad program. See Starting the launchpad program for details.
  3. Follow the on-screen instructions in the wizard to complete the installation. See Installing IBM Installation Manager for details. After you have installed Installation Manager, or if it is already on your system, the Install Packages wizard starts automatically.
  4. Start the installation of Rational Method Composer from the launchpad program. For details, see Starting an installation from the launchpad program.
    Note:
    If you exit Installation Manager before completing the product installation, you must restart Installation Manager from the launchpad.
  5. Follow the instructions in the Install Packages wizard to complete the installation. .
  6. Configure your license. By default, a trial license is included. You must configure the license to ensure you have continued access to the product. See Managing licenses.
  7. For Linux: Increase the number of file handles on your workstation. See Increasing the number of file handles on Linux computers.

Installing Rational Method Composer from an electronic image on your workstation: task overview

The following are the general steps for installing Rational Method Composer from an electronic installation image:

  1. Ensure that your workstation has enough space to store both the downloaded packages from IBM Passport Advantage and the extracted installation image. See Hardware and software requirements.
  2. Extract the installation image from the downloaded file and verify that the installation image is complete. See Verifying and extracting electronic images for details.
  3. Follow the steps in the Installing from an electronic image section of this document.

Installing from an electronic image

  1. Complete the Pre-installation tasks.
  2. Start the launchpad program. See Starting the launchpad program for details.
  3. Start the installation of Rational Method Composer from the launchpad program. For details, see Starting an installation from the launchpad program.

    If IBM Installation Manager is not detected on your workstation, then a prompt is displayed for you to install Installation Manager. Follow the on-screen instructions in the wizard to complete the installation. See Installing IBM Installation Manager for details.

    After you have installed Installation Manager, or if it is already on your system, the Install Packages wizard starts automatically.

    Note:
    If you exit Installation Manager before completing the product installation, you must restart Installation Manager from the launchpad.
  4. Follow the instructions in the Install Packages wizard to complete the installation. .
  5. Configure your license. By default, a trial license is included. You must configure the license to ensure you have continued access to the product. See Managing licenses.
  6. For Linux: Increase the number of file handles on your workstation. See Increasing the number of file handles on Linux computers.

Installing Rational Method Composer from an electronic image on a shared drive: task overview

In this scenario, you will place the electronic image on a shared drive so that users in your enterprise can access the installation files for Rational Method Composer from a single location.

The following steps are to be done by the person who places the installation image on a shared drive.

  1. Ensure that your shared drive has sufficient disk space to store both the downloaded files from IBM Passport Advantage and the extracted installation image. See Hardware and software requirements.
  2. Extract the installation image from the downloaded files into an accessible directory on the shared drive and verify that the installation image is complete. See Verifying and extracting electronic images.

To install Rational Method Composer from the installation files on the shared drive:

  1. Change to the disk1 directory on the shared drive that contains the installation image.
  2. Follow the steps that are in Installing from an electronic image.

Installing from the launchpad program

The launchpad program provides you with a single location to view release information and start the installation process.

Use the launchpad program to start the installation in the following scenarios:

To install from the launchpad:

  1. Complete the preinstallation tasks described in Pre-installation checklist, if you have not done so already.
  2. Start the launchpad program. See Starting the launchpad program.
  3. Start the installation of Rational Method Composer. See Starting an installation from the launchpad program.
  4. Follow the on-screen instructions in the Install Packages wizard to complete the installation. See Installing Rational Method Composer by using IBM Installation Manager for details.

Starting the launchpad program

Complete the preinstallation tasks described in Pre-installation checklist, if you have not done so already.

If you are installing from a CD and autorun is enabled on your workstation, then the launchpad starts automatically when you insert the first installation disc into your CD drive. If you are installing from an electronic image, or if autorun is not configured on your workstation, then you must start the launchpad program manually.

To start the launchpad program:

  1. Insert the CD into your CD drive. For Linux: Ensure that you have mounted the CD drive.
  2. If autorun is enabled on your system, the launchpad program automatically opens. If autorun is not enabled on your system:

Starting an installation from the launchpad program

  1. Start the launchpad program.
  2. If you have not done so already, read the release information by clicking Release notes.
  3. When you are ready to begin the installation, click Install Rational Method Composer.
  4. A message window opens to inform you whether the program is detected on your workstation.
  5. Follow the on-screen instructions in the Install Packages wizard to complete the installation. See Installing Rational Method Composer by using IBM Installation Manager for details.

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

If you start the installation of Rational Method Composer from the launchpad, 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 installing Rational Method Composer.

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.

Note:
Installation Manager is installed only once for each user ID on the computer.

Starting IBM Installation Manager

If you start the installation of Rational Method Composer from the launchpad, IBM Installation Manager automatically starts even if it is not already installed.

If you already installed Installation Manager, you can start it in one of these ways:

Installing Rational Method Composer by using IBM Installation Manager

The following steps describe how to install the Rational Method Composer package by using IBM Installation Manager.

  1. (Optional) If the Install Packages wizard did not start automatically, then start it:
    1. Start the Installation Manager.
    2. From the Start page, click Install.
      Note:
      If a new version is found, you are prompted to confirm that you want to install it before you can continue. Click OK to proceed. Installation Manager automatically installs the new version.
      When Installation Manager starts, it searches all of its defined repositories for available packages.
  2. The Install page of Install Packages wizard lists all the packages that are in the defined repositories. If two versions of a package are discovered, only the most recent, or recommended, version of the package is displayed. To display all versions of packages that are found through search, click Show all versions.
  3. Click the Rational Method Composer package to display its description in the Details pane.
  4. To search for updates to the package, click Check for Other Versions and Extensions.
    Note:
    For Installation Manager to search the predefined IBM update repository locations for the installed packages, you must select Search services repositories during installation and updates on the Repositories preference page. 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 all repository locations that you have set. A progress indicator displays that the search is taking place. You can install updates at the same time that you install the base product package.
  5. If updates for the package are found, then they will be displayed in the Installation Packages list on the Install Packages page below their corresponding product. Only recommended updates are displayed by default.
  6. Select the package and 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.
  7. 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.
  8. On the Location page, type the path for the shared resources directory in the Shared Resources Directory field; or accept the default path. The shared resources directory contains resources that can be shared by one or more package groups. Click Next to continue.

    The default path is: C:\Program Files\IBM\SDPShared

    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. To change the directory location, you must uninstall all packages.
  9. On the Location page, either choose an existing package group to install the package into, or create a new one. 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: C:\Program Files\IBM\RMC

    3. Click Next to continue.
  10. 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 package will be installed. Note that your choices apply to all packages installed under this package group.
  11. On the Summary page, review your choices before installing the 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.
  12. When the installation process is complete, a message confirms the success of the process.
    1. Click View log file to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.
    2. In the Install Package wizard, select whether you want to start when you exit.
    3. Click Finish to launch the selected package. The Install Package wizard closes and you are returned to the Start page.

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.

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

Starting Rational Method Composer

You can start Rational Method Composer from the desktop environment or a command-line interface.

For Microsoft Windows operating systems: Click Start -> All Programs -> IBM Rational Method Composer 7.5 -> Method Composer.

To start Rational Method Composer from 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.

Using the Manage Licenses wizard, you can upgrade trial versions of an offering to a licensed version by importing a product activation kit.

For more information on managing licenses for your Rational product, see http://www.ibm.com/support/docview.wss?uid=swg21250404.

License activation

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

Licenses for this product are activated by importing a license activation kit.

Note:
If you are using a trial license, it will expire 30 days after installation. You must activate your product to use it after the expiration date. See the article on license activation and the activation process at http://www.ibm.com/support/docview.wss?uid=swg21250404.

Activation kits

A license activation kit contains the permanent license key for you product. You purchase the activation kit, download the activation kit compressed file to your computer, and then use IBM Installation Manager to import the activation kit (a JAR file) to activate the license for your product.

Importing a license activation kit

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

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(TM) archive (.jar) file. The .jar file contains the permanent license key and must be imported to activate your product.

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 select the Import Activation Kit radio 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.

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

Viewing license information for installed product packages

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

To view license information, complete the following steps:

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

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

Verifying the installation

When the installation process is complete, a message confirms the success of the process. You can open the log file to verify your installation of the product.

To verify the installation:

  1. Click View log file to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.
  2. In the Install Package wizard, select whether you want Rational Method Composer to start when you exit.
  3. Click Finish to launch the selected package. The Install Package wizard closes and you are returned to the Start page of Installation Manager.

Installing software silently

You can install the product package by running Installation Manager in silent installation mode. When you run Installation Manager in silent mode, the user interface is not available. Instead, Installation Manager uses a response file to input the commands that are required to install the product package.

Running Installation Manager in silent mode is helpful because it enables you to use a batch process to install, update, modify and uninstall product packages through scripts.

Note that you must install Installation Manager before you can silently install the package. Refer to Installing IBM Installation Manager for details on installing Installation Manager.

There are two main tasks required for silent installation:

  1. Create the response file.
  2. Run Installation Manager in silent installation mode.

Creating a response file

You can create a response file by recording your actions as you install a product package using IBM Installation Manager. When you record a response file, all of the selections that you make in the Installation Manager interface are stored in an XML file. When you run Installation Manager in silent mode, Installation Manager uses the XML response file to locate the repository that contains the package and select the features to install.

To record a response file for installing (or uninstalling) packages:

  1. On a command line, change to the Eclipse subdirectory in the directory where you installed Installation Manager. For example:
  2. On a command line, type the following command to start Installation Manager, substituting your own file name and location for the response file and (optionally) the log file:
    Note:
    Make sure that the file paths you enter exist; Installation Manager will not create directories for the response file and the log file.
  3. Follow the instructions in the Install Packages wizard to make your installation choices. Stopping when you reach the Summary page. For details, see Installing Rational Method Composer by using IBM Installation Manager.
  4. Click Install, and then when the installation process begins click Cancel.
  5. Click Finish, then close Installation Manager.

An XML response file is created and resides in the location specified in the command.

Running Installation Manager in silent installation mode

You can run Installation Manager in silent installation mode from a command line.

Refer to the Installation Manager online help for additional documentation on how to run it in silent mode. (For example, silently installing from a repository that requires authentication (user ID and password).

You run Installation Manager in silent mode appending the -silent argument to the Installation Manager start command launcher.exe.

The following table describes the arguments used with the silent installation command:

Argument Description
-input
Specifies an XML response file as the input to Installation Manager. A response file contains commands that Installation Manager runs.
-log
(Optional) Specifies a log file that records the result of the silent installation. The log file is an XML file.

To run Installation Manager in silent installation mode:

  1. On a command line, change to the eclipse subdirectory in the directory where you installed Installation Manager. For example:
  2. Enter and run the following command, substituting your own locations for the response file and, optionally, the log file:

Installation Manager runs in silent installation mode; it reads the response file and writes a log file to the directory you specified. While you must have a response file when running in silent installation mode, log files are optional. The result of this execution should be a status of 0 on success and non-zero number on failure.

Silently installing updates to all currently installed products

You can silently search for and install updates for all currently installed products.

To search for and silently install updates for all available products:

  1. On a command line, change to the eclipse subdirectory in the directory where you installed Installation Manager.
  2. Enter and run the following command, substituting your own locations for the response file and, optionally, the log file:

All available product updates known to Installation Manager are installed.

Response file commands

If you want to use the silent installation capabilities of Installation Manager, you must create a response file that contains all of the commands that Installation Manager must run. You can create a response file by recording your actions as you install the package, but you can also create or edit a response file manually.

There are two categories of commands for the response file:

Silent installation preference commands

Specify preferences in the Preferences window, or by identifying preferences as keys in a response file for use during a silent installation.

Note:
You can specify more than one preference in a response file.

When you define preferences in a response file, your XML code will look similar to the following example:

<preference>
	name = "the key of the preference"
	value = "the value of the preference to be set" 
</preferences>

Use the following table to identify keys and their associated values for silent installation preferences:

Key Value Notes
com.ibm.cic.common.core.preferences.logLocation Specifies the location of Installation Manager log file. Important: This key is optional and is designed for testing and debugging. If you do not specify a location for the log file, both silent installation and the GUI version of Installation Manager will use the same location.
com.ibm.cic.license.policy.location Specifies a URL that defines where the remote license policy file resides.
com.ibm.cic.common.core.preferences.http.proxyEnabled True or False False is the default value.
com.ibm.cic.common.core.preferences.http.proxyHost Host name or IP address
com.ibm.cic.common.core.preferences.http.proxyPort Port number
com.ibm.cic.common.core.preferences.http.proxyUseSocks True or False False is the default value.
com.ibm.cic.common.core.preferences.SOCKS.proxyHost Host name or IP address
com.ibm.cic.common.core.preferences.SOCKS.proxyPort Port number
com.ibm.cic.common.core.preferences.ftp.proxyEnabled True or False False is the default value.
com.ibm.cic.common.core.preferences.ftp.proxyHost Host name or IP address
com.ibm.cic.common.core.preferences.ftp.proxyPort Port number
com.ibm.cic.common.core.preferences.eclipseCache Common component directory

Silent installation commands

Use this reference table to learn more about response file commands that you can run during a silent installation.

Response file commands Description

Profile

<profile 
id="the profile (package group) id" 
installLocation="the install location of
 the profile">
<data key="key1" value="value1"/>
<data key="key2" value="value2"/>

</profile>
Use this command to create a package group (or installation location). If the specified package group already exists, then the command has no effect. When you create the profile, the silent installation will also create two installation contexts; one for Eclipse and one for native. A profile is an installation location.

You can use the <data> element for setting profile properties.

The following list contains the keys that are currently supported keys and related values:

  • The eclipseLocation key specifies an existing Eclipse location value, such as c:\myeclipse\eclipse.
  • The cic.selector.nl key specifies the Natural Language (NL) locale selections, such as zh, ja, and en.
Note:
Separate multiple NL values with commas.

The following list contains the currently supported language codes:

  • English (en)
  • French (fr)
  • Italian (it)
  • Simplified Chinese (zh)
  • Russian (ru)
  • Traditional Chinese (Taiwan) (zh_TW)
  • Traditional Chinese (Hong Kong) (zh_HK)
  • German (de)
  • Japanese (ja)
  • Polish (pl)
  • Spanish (es)
  • Czech (cs)
  • Hungarian (hu)
  • Korean (ko)
  • Portuguese (pt_BR)

Repositories

<server>
<repository location="http://example/
repository/">
<repository location="file:/C:/
repository/">
<!--add more repositories below-->
<...>
      </server>
Use this command to specify the repositories that are used during a silent installation. Use a URL or UNC path to specify remote repositories; use directory paths to specify local repositories.

Install

<install>
<offering profile= "profile id" 
features= "feature ids" 
id= "offering id" version= "offering 
version"></offering>

<!--add more offerings below>
<...>

</install>
Use this command to specify the installation packages that will be installed.

The profile ID must match an existing profile or a profile created by the set profile command.

Feature IDs can be optionally specified by a comma-delimited list, such as "feature1, feature2" and so on. If no feature IDs are specified, all the default features in the specified offering will be installed.

Note:
Required features will be included for installation, even if they are not explicitly specified in the comma-delimited list.

<install modify="true"> or <uninstall modify="true"> (optional attribute)

<uninstall modify="true">
<offering profile="profileID"
 id="Id" version="Version" 
features="-"/>
</uninstall>

Use the <install modify="true"> attribute on install and uninstall commands to indicate that you want to modify an existing install. If the attribute is not set to true, the value defaults to false. If the intent of the modify operation is only to install additional language packs, then a hyphen "-" should be used in the offering feature id list to indicate no new features are being added.

Important:
You must specify "modify=true" and a hyphen "-" feature list as specified in the example; otherwise, the install command will install the offering's default features and the uninstall command will remove all the features.

Uninstall

<uninstall>
<offering profile= "profile id" 
features= "feature ids" 
id= "offering id" version= "offering 
version"></offering>

<!--add more offerings below>
<...>

</uninstall>
Use this command to specify the packages that will be uninstalled.

The profile ID must match an existing profile or a profile specified in a profile command. Further, if there are no feature IDs specified, all the features in the specified offering will be uninstalled; if there are no offering IDs specified, all the installed offerings in the specified profile will be uninstalled.

Rollback

<rollback>
<offering profile= "profile id"
 id= "offering id" 
version= "offering version">
</offering>

<!--add more offerings below
<...>

</rollback>
Use this command to roll back to the specified offerings from the version currently installed on the specified profile. You cannot specify features in a roll back command.

InstallAll

<installALL/>
Note:
This command is equivalent to using
-silent -installAll 
.
Use this command to silently search for and install all available packages.

UpdateAll

<updateALL/>
Note:
This command is equivalent to using
-silent -updateAll 
.
Use this command to silently search for and update all available packages.

License

<license policyFile="policy file
 location"/>

For example:

<license policyFile="c:\mylicense.opt"/> 
Use this command to generate a response file containing a license command by starting the license wizard after starting Installation Manager in record mode.

During record mode, if you set flex options through the license management wizard, the options you set will be recorded in a license policy file named "license.opt" in the same directory as the generated response file; the response file will contain a license command that references the policy file.

Wizard

<launcher -mode wizard -input 
< response file >
Use this command to start Installation Manager in UI mode. The UI mode starts Installation Manager in either the install wizard or the uninstall wizard. However, in this case, the response file can only contain preference commands and install commands or preference command and uninstall commands; you can not mix install and uninstall commands in the same response file when you run Installation Manager in UI mode.

Reference: Sample response file

You can use an XML-based response file to specify predefined information such as silent installation preferences, repository locations, installation profiles, and so on. Response files are beneficial for teams and organizations that want to install installation packages silently and to standardize the locations and preferences for installation packages.

Sample response file
<agent-input >

<!-- add preferences -->
<preference name="com.ibm.cic.common.core.preferences. http.proxyEnabled" 
value="c:/temp"/>
<!-- create the profile if it doesn't exist yet -->
<profile id="my_profile" installLocation="c:/temp/my_profile"></profile>

<server>
<repository location= 
"http://a.site.com/local/products/sample/20060615_1542/repository/"></repository>
/server>

<install>
	<offering profile= "my_profile" features= "core" id= "ies" 
version= "3.2.0.20060615">
	</offering>
/install>

</agent-input>

Silent install log files

You can use silent install log files to examine the results of a silent installation session.

The silent installation functionality creates an XML-based log file that records the result of the silent installation execution (as long as a log file path is specified using -log <your log file path>.xml). If your silent installation session is successful, the log file will contain just the root element of <result> </result>; however, if errors occur during the installation, the silent install log file will contain error elements with messages such as:

<result>
	<error> Cannot find profile: profile id</error>
	<error> some other errors</error>
</result>

For detailed analysis, you can look at the logs generated in the Installation Manager data area. By using a preference command, you can optionally set the data area to your preferred location, as shown in the response file topic.

Managing IBM Installation Manager - Additional information

Setting repository preferences in Installation Manager

When you start the installation of Rational Method Composer from the launchpad program, the location of the repository that contains the product package is automatically defined in IBM Installation Manager. If you start Installation Manager directly (For example, by installing Rational Method Composer from a repository located on a Web server) then you must specify the repository preference before you begin your product package installation. The repository preference is the URL for the directory that contains the product package in Installation Manager. You can set these repository locations on the Repositories page in the Preferences window.

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

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 repository location, then you are prompted to enter a user ID and password. The new or changed repository location is listed. If the repository is not connected, a red x is displayed in the Connection column.
    Note:
    For Installation Manager to search the default repository locations for the installed packages, ensure the preference Search services repositories during installation and updates on the Repositories preference page is selected. This preference is selected by default.
  6. Click OK to exit.

Modifying installed product packages

The Modify Packages wizard in the IBM Installation Manager enables you to change the feature and language 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.

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.

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 product package group and click Next.
  3. On the Languages page, select the languages for the package group and 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 features that you want to install or remove. Some products do not have optional features.
    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.
    3. Click Next
  5. On the Summary page, review your choices before modifying the installation package and click Modify.
  6. Optional: When the modification process completes, click View Log File to see the complete log.
  7. Click Finish to close the wizard.

Updating installed product packages

Package updates provide fixes and updates to installed product packages. You can use the Update Packages wizard in IBM Installation Manager to install updates for product packages that were installed by using IBM Installation Manager.

Internet access is required unless your repository preferences points to a 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.

Important:

To find and install product package updates:

  1. Start IBM Installation Manager.
  2. On the Start page of IBM Installation Manager, click Update.
  3. Optional: If a required version of IBM Installation Manager is not detected on your computer, you must continue with the update of Installation Manager. Follow the instructions in the wizard to complete the update.
  4. In the Update Packages wizard, select the product package group that you want to update or click the Update All check box and click Next. Installation Manager searches for updates in its repositories and the predefined update sites for the product.
  5. On the Update page, if updates for a package are found, they are displayed in the Updates list below their corresponding package and only recommended updates are displayed by default. Complete the following steps:
    1. To display all updates found for the available packages, click Show all.
    2. To learn more about an update, click the update and review its description under Details. 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.
    3. 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 or cleared.
    4. Click Next.
  6. 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. If you agree to the terms of all the license agreements, click I accept the terms of the license agreements and Click Next.
  7. On the Features page, select the features that you want to update and complete the following steps:
    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.
    3. Click Next
  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.
  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.

Reverting updates to previous versions

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

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.

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. Start IBM Installation Manager.
  2. On the Start page, click Roll Back.
  3. In the Roll Back Packages wizard, from the Package Group Name list, select the package that you want to revert to the previous version and click Next.
  4. Follow the instructions in the wizard.

Uninstalling software

You can use the Uninstall option in IBM Installation Manager to uninstall software that were installed by using Installation Manager from your computer.

For Windows, you can use the Control Panel and, for Linux and UNIX(R), you can use the Uninstall IBM Installation Manager icon on your computer's desktop to uninstall IBM Installation Manager.

Uninstalling product packages

You can use the Uninstall option in IBM Installation Manager to uninstall a product package from a single installation location. You can also uninstall all the installed packages from every installation location.

To uninstall a product package, you must log in to the system by using the same user account that you used to install the product package. You must close the programs that you installed by using IBM Installation Manager.

To uninstall a product package, complete the following steps:

  1. Start IBM Installation Manager.
  2. On the Start page click Uninstall.
  3. On the Uninstall Packages page, from the Installation Packages list, select the product package that you want to uninstall and click Next.
  4. On the Summary page, review the list of packages that will be uninstalled and click Uninstall. The Complete page is displayed after the packages are removed.
  5. Click Finish.

Uninstalling IBM Installation Manager

You can follow the instructions below to uninstall IBM Installation Manager.

Before you can uninstall IBM Installation Manager, you must uninstall all of the packages, including products that were installed by IBM Installation Manager. You must close Installation Manager before attempting to uninstall the program. You must log in to the computer by using the same user account that you used to install Installation Manager.

To uninstall Installation Manager, complete the following steps:

Notices

(C) Copyright IBM Corporation 2000, 2008. All rights reserved.

Note to 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:

IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, 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.

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
3600 Steeles Avenue East
Markham, Ontario
Canada L3R 9Z7


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:

Intel(R), Itanium(R), and Pentium(R) are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

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

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

UNIX is a registered trademark of The Open Group in the United States and other countries.

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