IBM Rational Data Architect, Version 7.5

Installation guide


Note

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

This edition applies to version 7.5 of IBM Rational Data Architect and to all subsequent releases and modifications until otherwise indicated in new editions. Instructions are written for version 1.2 of Installation Manager, which is included with Rational Data Architect Version 7.5.

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

Contents

Installation introduction
Installation terminology
Installation default values and conventions
What's new for installers
Planning the installation
Installation Manager overview
Installation roadmap
Silent installation roadmap
Installation requirements
Hardware and software requirements
User privilege requirements
Planning what features to install
Installation considerations
Installation directories
Coexistence considerations
Compatibility with other products
Extending an existing Eclipse IDE
Upgrading from another release
Web-based help content
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 files
Installing software
Installing from the launchpad
Starting the launchpad
Installing IBM Installation Manager
Starting IBM Installation Manager
Installing Rational Data Architect
Installing silently
Installing packages silently
Installing Installation Manager and packages together silently
Reference: Sample response file
Response file commands
Starting Installation Manager in wizard mode
Searching for and silently installing all available products
Silently installing updates to all currently installed products
Silently installing from authenticated repositories
Silently uninstalling Installation Manager
Deploying and installing to the enterprise
Post-installation tasks
Post-installation checklist
Starting Rational Data Architect
Managing licenses
License activation
Types of licenses
Viewing license information for installed product packages
Configuring Web-based help
Accessing Web-based help
Downloading help content with the Local Help System Updater site
Updating help content
Removing help content
Setting up an intranet server for help content
Changing the way you access help content
Specifying the repository
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

For the most up to date version of this document, see the Rational Data Architect information center.

This section contains instructions for installing, updating, and uninstalling your product.

Installation terminology

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

These terms are used in the installation topics.

Admin user
A user who has write administrative privileges. In the context of installing, having write administrative privileges means that the user can 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, a user with write administrative privileges 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.
Extension
A type of product package that provides additional function to another product package. You cannot install the extension without also installing the package that it extends.
Installation directory
The location of product artifacts after the package is installed.
Non-admin user
A user who does not have write administrative privileges. In the context of installing, this means that this user can only install into the home directory.
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.) Sharing a package group is sometimes also referred to as "shell sharing."
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 or Web 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 in use for Rational(R) Data Architect and the 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
  • Admin installation:
    • For Windows: C:\Program Files\IBM\Installation Manager
    • For Linux.: /opt/IBM/Installation Manager
  • Non-admin installation:
    • For Windows: user.home\IBM\Installation Manager
    • For Linux.: user.home/IBM/Installation Manager
Installation manager shared resources directory Shared resources directory
  • Admin installation:
    • For Windows: C:\Program Files\IBM\SDPShared
    • For Linux.: /opt/IBM/SDPShared
  • Non-admin installation:
    • For Windows: user.home\IBM\SDPShared
    • For Linux.: user.home/IBM/SDPShared
Rational Data Architect installation directory Rational Data Architect directory
  • Admin installation:
    • For Windows: C:\Program Files\IBM\SDP
    • For Linux.: /opt/IBM/SDP
  • Non-admin installation:
    • For Windows: user.home\IBM\SDP
    • For Linux.: user.home/IBM/SDP
Rational Data Architect workspace directory workspace directory
  • For Windows: user.home\IBM\rationalsdp\workspace
  • For Linux.: user.home/IBM/rationalsdp/workspace

What's new for installers

If you are familiar with the previous version of this product, you will note some differences in the installation of this version.

These important differences might affect the way you plan and implement your installation:

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 Manager overview

IBM(R) 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 the packages, manage the licenses for your packages, and uninstall the packages from your system.

The prerequisite version of Installation Manager (version 1.2) is included with Rational Data Architect. You can also download Installation Manager directly from www.ibm.com. All instructions in this Installation Guide assume that you are using Installation Manager Version 1.2. If you upgrade later to a higher version of Installation Manager, some of the instructions might not be accurate. The Installation Manager Version 1.2 information center is on the Web at: http://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp

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

Installation roadmap

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

Roadmap for installing Rational Data Architect

Perform(TM) these tasks to install Rational Data Architect:

  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. Complete one of the following tasks to install the product:
  6. Follow the instructions in the Install Packages wizard to install or update Installation Manager, if necessary, and install the product and verify the installation.
  7. Perform any necessary post-installation tasks, such as configuring the appropriate product license.

If you are planning a silent installation of the product, see Silent installation roadmap.

Silent installation roadmap

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

Roadmap for installing Rational Data Architect silently

Perform these tasks to install Rational Data Architect silently:

  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. Complete one of the following tasks, depending on your installation scenario:
  6. Perform any necessary post-installation tasks, such as configuring the appropriate product license.

Installation requirements

Installation requires the correct hardware, operating system, software, and other factors.

Hardware and software requirements

Verify that your hardware and software meet or exceed the minimum requirements. If your hardware and software do not meet the minimum requirements, you might be unable to install or run the product.

Before you can install the product, verify that your system meets the minimum hardware requirements. For an up-to-date list of minimum requirements, go to this Web page: http://www.ibm.com/software/data/integration/rda/requirements/index.html

This version of Rational Data Architect was developed for use with Eclipse 3.4, using JDK 1.6 SR 2. If you are extending an existing Eclipse environment, refer to Extending an existing Eclipse IDE for more information.

Additional requirements for Linux operating systems

If you use a Linux operating system, then you must check that your computer meets the requirements listed in this topic.

Environment variable might need setting for Firefox or Mozilla browsers

You might need to set the environment variable MOZILLA_FIVE_HOME to the folder containing your Firefox or Mozilla installation. For example, setenv MOZILLA_FIVE_HOME /usr/lib/firefox-1.5.

Firefox browsers must be dynamically linked

To support the SWT browser widget, your Firefox browser must be dynamically linked, which means it was not downloaded from mozilla.org, but was compiled from source. This is typically the case when the Firefox comes as part of the distribution (that is, it is in a place such as /usr/lib/firefox).

One way to ensure that this is true is to see if it is the browser that is pointed at by /etc/gre.conf. The purpose of this gre.conf file is to point at an embeddable browser.

SUSE Linux might require a fix for invisible text problem

If your operating system is SUSE Linux Enterprise Desktop 10 SP1 or SUSE Linux Enterprise Server 10 SP1, then you might need the following operating system update to resolve a problem with text not being displayed in some editors:http://support.novell.com/techcenter/psdb/44ab155e3202595389c101e6cf7e20f2.html.

User privilege requirements

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

Your user ID must not contain double-byte characters.

There are two methods of installation: administrative and non-administrative.

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

Table 2. The following table describes what happens when user ID's with different access privileges are used when installing
User ID authority Case where you install as Non-admin Case where you install as Admin
Non-admin (current user)
  • If Installation Manager is not already installed, it is installed for the current user only.
  • After Installation Manger is installed, products can only be installed for the current user.
  • For operating systems other than Microsoft Windows Vista: An error message occurs.
  • For Microsoft Windows Vista: You are prompted to log on with an Admin user ID.
Admin An error message occurs.
  • If not already installed, Installation Manager is installed for All Users.
  • Any products installed with this Installation Manager are for All Users

Planning what features to install

You can customize your software product by selecting which features to install.

When you install the 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.

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

This table shows the features of IBM Rational Data Architect that you can 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
Rational Data Architect Core Functionality The Rational Data Architect core functionality includes support for physical, logical, glossary, and domain data modeling. If you have WebSphere(R) Federation Server installed, you can also use the core functionality to enhance and extend the information that you have accessed with the WebSphere Federation Server federated functions.
BIRT Visual Report Designer Provides a solution for producing reports, charts, and documents from a variety of data sources using Business Intelligence and Reporting Tools (BIRT) functionality.
Rational RequisitePro(R) Integration Provides capabilities for associating data model elements with requirements. You can use the RequisitePro integration to create, manage, and track project requirements. This feature can only be used if the Rational RequisitePro product is installed.
Rational ClearCase(R) SCM Adapter Provides support for sharing data projects by using Rational ClearCase. After installation, you must enable this functionality on the Capabilities page of the Preferences window. This feature can only be used if you have a ClearCase client and a configured ClearCase server.
UML-to-LDM Transformation Use the UML-to-LDM transformation feature to transform UML models into logical data models, or to transform logical data models into UML models.
LDM-to-XSD Transformation Use the LDM-to-XSD transformation feature to transform logical data models into XSD files or to transform XSD files into logical data models.
Model Import/Export Use the model import/export feature to import and export data models from Rational Data Architect to other modeling tools such as ERwin, IBM Rational Rose(R), and Sybase PowerDesigner. You can also configure this feature to support additional data model formats.
Information Server Integration Use the Information Server Integration feature to transfer metadata between Rational Data Architect version 7 and the metadata repository of IBM InfoSphere Information Server. You can transfer glossary model metadata back and forth from Rational Data Architect to the metadata repository. You can also export physical data model metadata from Rational Data Architect to the metadata repository. To use this feature, you must have Microsoft XML Core Services (MSXML) 4.0 Service Pack 2 installed on the same computer and one of the following products: IBM WebSphere Information Services Director; IBM WebSphere Information Analyzer; or IBM WebSphere DataStage(TM) and QualityStage Designer.
IBM Optim Integration Use this feature to export a physical data model that has been annotated with data privacy metadata to an Optim mapping.
DB2(R) Database Development Use the DB2 database development feature to develop DB2 stored procedures and user-defined functions. Development support includes wizards, editors, and an integrated debugger. Additional support for the XML data type in DB2 for Linux, UNIX(R), and Windows Version 9.1 includes XML schema registration and XML data validation.

Installation considerations

Part of planning entails making decisions about things such as installation locations, working with other applications, extending Eclipse, or configuring help content. This section provides information that helps you with these decisions.

Installation directories

IBM Installation Manager uses two directories when installing product artifacts.

Shared resources directory

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

Package groups

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

Coexistence considerations

Coexistence refers to the installed products on the same computer.

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.

Compatibility with other products

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

Rational Data Architect Version 7.5 can share a package group with other compatible products that have been installed with Installation Manager.

The following products have been tested with Rational Data Architect Version 7.5. Other products have not been tested and you should not attempt to install Rational Data Architect with them in a shared package group.

Important:
See the "Installation limitations" section of the release notes for important information about limitations for shared installations.

If you have installed other Eclipse 3.4 based products using a mechanism other than Installation Manager, you can attempt to install Rational Data Architect into the same Eclipse IDE, using the Extend an existing Eclipse IDE option in Installation Manager. However, be aware that this type of installation will fail if the Eclipse environment is not exactly compatible with Rational Data Architect Version 7.5.

See the Rational Data Architect support page for additional technotes about extending an Eclipse 3.4 IDE.

Extending an existing Eclipse IDE

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

Rational Data Architect is bundled with a version of the Eclipse IDE or workbench; this bundled workbench is the base platform on top of which the functionality in Rational Data Architect is provided. If you have an Eclipse IDE on your workstation, then you have the option to extend it, that is, add to your current Eclipse IDE the additional functionality provided in Rational Data Architect.

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

Your Eclipse IDE and JRE must be at least at the minimum version levels that the product requires. See the product system requirements for details on the required versions. Installation Manager checks that the Eclipse instance that you specify meets the requirements for the installation package.

Upgrading from another release

If you have a previous version of the product, review the information in this section.

You cannot change a previous version of IBM Rational Data Architect that is already installed on your computer to the current version. In other words, it is not possible to upgrade to the latest version.

However, the latest version of Rational Data Architect can coexist with earlier versions on the same computer and you can migrate your workspace and projects to the latest version.

Web-based help content

Some help systems are 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:

If your help system supports remote help, you can change your access decision any time. If you install multiple products together, you can use different locations for the help for each product, depending on installation footprint, frequency of use, and internet policies. If internet speed is an issue, a longer one-time download and local access might be preferable. Later help updates include only differences.

If you are an administrator and you want users to access help content from an intranet server, see the Installation Manager information center for instructions on how to install the help WAR file on a server.

Pre-installation tasks

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

Pre-installation checklist

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

__   1.
If you are installing from an electronic image downloaded from IBM Passport Advantage(R), verify that you have all the required parts and extracted the download files correctly.
__   2.
(For Linux) If you are installing from physical media, mount your DVD drive.
__   3.
(For Linux) If you want the product to be used by users other than root, 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.
__   5.
Ensure that you are logged on to your computer with an appropriate user ID.

Increasing the number of file handles on Linux computers

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

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

Ensure that you complete the following steps correctly. If this procedure is not completed correctly, your computer will not start.

To increase the number of file handles on a Linux computer, complete the following steps:

  1. Log in as root. If you do not have root access, you will need to obtain it before continuing.
  2. Change to the etc directory.
    Attention: If you decide to increase the number of file handles in the next step, do not leave an empty initscript file on your computer. If you do so, your computer will not start the next time that you restart it.
  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 available to users or groups by modifying the limits.conf file in the etc/security directory. Both SUSE Linux Enterprise Server (SLES) Version 9 and Red Hat Enterprise Linux Version 4.0 have this file by default. If you do not have this file, consider using a smaller number in step 4 in the previous procedure (for example, 2048). Do this so that most users have a reasonably low limit on the number of open files that are allowed per process. If you use a relatively low number in step 4, it is less important to do this. However, if you set a high number in step 4 earlier and you do not establish limits in the limits.conf file, computer performance can be significantly reduced.

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

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

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

Mounting a drive

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

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

For Linux:

  1. Log in as a user with root authority.
  2. Insert the DVD 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 DVD.
  3. Log out.

Some window managers can automatically mount your DVD drive for you. Consult your computer documentation for more information.

Verifying and extracting electronic images

If you download the installation files from IBM Passport Advantage, you must extract the electronic image from the compressed files before you can install the software.

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

Extracting the files

When extracting the installation files from the downloaded compressed files, do the following things:

When you are finished extracting all of the compressed files, the directory where you extracted the contents will have subdirectories with the following names:

Table 3. Subdirectories created after extracting compressed file contents
Subdirectory name Required or optional
disk1 required
disk2 required
documentation optional
enterprise optional
launchpad optional

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 launchpad

The launchpad program provides you with a single location to start the installation process. When you install with the launchpad, you are performing an administrative installation.

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

To perform a non-administrative installation, switch to the InstallerImage_<platform> folder in the disk1 directory, and run userinst.exe (for Windows), or userinst (for Linux).

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

Starting the launchpad

The launchpad performs an administrative installation of the product. To perform a non-administrative installation, switch to the InstallerImage_<platform> folder in the disk1 directory, and run userinst.exe (for Windows), or userinst (for Linux).

To start the launchpad, complete the following steps.

  1. Insert the IBM Rational Data Architect DVD into your DVD drive. For Linux. Ensure that you have mounted the DVD drive.
  2. If autorun is enabled on your computer, the Rational Data Architect launchpad program automatically opens. If autorun is not enabled on your system, complete one of these steps:

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 IBM Rational Data Architect by using the launchpad from the product DVD, 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 Data Architect.

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 IBM Rational Data Architect 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 Data Architect

This topic provides the instructions for installing Rational Data Architect.

In the instructions that follow, it is assumed that you started your installation from the launchpad.

To install IBM Rational Data Architect, complete the following steps:

  1. Start the launchpad. The file that you run is different, depending on whether you are installing as an administrator or as a non-administrator.
  2. In the launchpad dialog-box, click Install Product for an administrative installation.
    Note:
    If a new version of IBM Installation Manager 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, stops, restarts, and resumes.
    IBM Installation Manager starts.
  3. Ensure that IBM Rational Data Architect is selected.
  4. You can install updates at the same time that you install the base product package. To search for updates to the packages, click Check for Other Versions and Extensions. 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.
  5. To learn more about the packages that you can install, click the package name. A description of the package is displayed in the Details pane.
  6. Click Next.
  7. On the Licenses page, read the license agreements for the selected packages. On the left-hand side of the License page, click each package version to display its license agreement.
    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.
  8. If you are installing Installation Manager: On the Location page, type the path for the shared resources directory in the Shared Resources Directory field, or accept the default path. If you are installing on Linux, ensure that you do not include any spaces in the directory path. The shared resources directory contains resources that can be shared by one or more package groups.
    Important:
    You can specify the shared resources directory only at the time that install Installation Manager. 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.
  9. Click Next to continue.
  10. On the Location page, create a package group to install the product package into, or select an package group. A package group represents a directory in which packages share resources with other packages in the same group. To create a new package group:
    1. Click Create a new package group.
    2. Type the path for the installation directory for the package group. (If you are installing on Linux, ensure that you do not include any spaces in the directory path.) The name for the package group is created automatically.
    After you select a package group, click Next.
  11. On the next Location page, you can choose to extend an Eclipse IDE already installed on your system, adding the functionality in the packages that you are installing.
  12. On the Features page under Languages, select the languages for the package group. The corresponding national language translations for the user interface and documentation for the product package will be installed.
  13. 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.
  14. On the help system configuration page, select one of the following options and then click Next:
  15. On the Summary page, review your choices before installing the product package. If you want to change the choices that you made on previous pages, click Back, and make your changes. When you are satisfied with your installation choices, click Install to install the package. A progress indicator shows the percentage of the installation completed.
  16. When the installation process is complete, a message confirms the success of the process.
    1. Click View log file to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.
    2. In the Install Package wizard, select whether you want the product to start when you exit.
    3. Click Finish to launch the selected package. The Install Package wizard closes and you are returned to the Start page of Installation Manager.
  17. Close Installation Manager.

Installing silently

You can install a product package silently by using either Installation Manager in silent installation mode or by using the Installation Manager installer. When you run Installation Manager in silent mode, the user interface is not available; instead, a response file inputs the commands that are required to install the product package.

Refer to the Silent installation roadmap for more information.

There are two ways to install packages silently:

  1. Use the Installation Manager installer to silently install both Installation Manager and product packages together.
  2. Install the Installation Manager, then use it in silent mode to install packages.

There are two main tasks required for any silent installation:

  1. Create the response file. See Creating a response file with Installation Manager for details.
  2. Run either installation tool in silent installation mode.

Installing packages silently

Creating a response file with Installation Manager to install a package

You can create a response file by recording your actions as you install a product package by using Installation Manager. When you record a response file, all of the selections that you make in the Installation Manager GUI 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, select the features to install, and so on.

In this scenario, you already have Installation Manager installed on your computer.

To record a response file for installation (or uninstallation), complete the following steps:

  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:
  3. Follow the on-screen instructions in the Install wizard to make your installation choices.
  4. Click Finish, then close Installation Manager.

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

Silently installing packages by using Installation Manager

Use Installation Manager in silent mode to install product packages from a command line.

After installing Installation Manager, use it in silent mode to install packages. This file explains how to install packages by using Installation Manager.

To run Installation Manager in silent mode, run the following command from the eclipse subdirectory:

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

Argument Description
-vm
Specifies the Java launcher. In silent mode, always use java.exe on Windows, and java on other platforms.
-nosplash
Specifies that the splash screen should be suppressed.
--launcher.suppressErrors
Specifies that the JVM error dialog should be suppressed.
-silent
Specifies that the Installation Manager installer or Installation Manager should be run in silent mode.
-input
Specifies an XML response file as the input to Installation Manager installer or the Installation Manager. A response file contains commands that installer or Installation Manager runs.
-log
(Optional) Specifies a log file that records the result of the silent installation. The log file is an XML file.

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

-updateAll
(Optional) All available updates to are installed.
-installAll
(Optional) All available products are installed.
--launcher.ini silent-install.ini

Specifies the location of the product .ini file to use. If this argument is not specified, the executable will check for a file in the same directory the launcher with the same name and the extension .ini. For example, IBMIM.exe checks for IBMIM.ini and install.exe checks for install.ini. The silent-install.ini file located in the same directory as the IBMIM.exe file contains initialization parameters that are applicable to installing silently and should always be present.

-accessRights
Defines whether the IM operates in admin or nonAdmin mode. For nonAdmin mode this argument should always be used with 'nonAdmin' parameter:
-accessRights nonAdmin
For admin mode it should be used with admin parameter:
-accessRights admin

If this argument is not used, the default value is set based on current user permissions.

Note:

For Windows XP users who are members of Administrator group, the default is always -accessRights admin. For these users to run in nonAdmin mode -accessRights nonAdmin argument should be passed explicitly.

The Installation Manager has an initialization or .ini file silent-install.ini that includes default values for the arguments in the table. For example, the silent-install.ini file might look something like this:

-vm
C:\Program Files\IBM\Installation Manager\eclipse\jre_5.0.2.sr5_20070511\jre\bin\java.exe
-nosplash
--launcher.suppressErrors
-silent
-vmargs
-Xquickstart
-Xgcpolicy:gencon

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

Installing Installation Manager and packages together silently

Creating a response file to install Installation Manager and packages together

You can create a response file by recording your actions as you install both Installation Manager and a product package by using the Installation Manager installer. When you record a response file, all of the selections that you make 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, select the features to install, and so on.

In this scenario, you do not have Installation Manager on your computer.

To silently install packages using the Installation Manager installer that is included with Rational Data Architect:

  1. On a command line, change to the InstallerImage_platform sub-directory in the disk1 directory.
  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.

    You can record a response file without installing or uninstalling a product by adding the optional -skipInstall <agentDataLocation>. Note that <agentDataLocation> must be a writable directory. The argument causes Installation Manager to save the installation data without installing the product. You can use the same <agentDataLocation> in the next recording session to record updates or modifications to the product, or to record license management. Note that the products installed or preferences, including repository settings, that you may have set on install when not using the -skipInstall argument are not be stored. Using -skipInstall will make installation faster because the IM is not installing the product, it is just recording the installation data.

    Note:
    Ensure the file paths you enter exist; Installation Manager will not create directories for the response file and the log file.
  3. Follow the on-screen instructions in the Install wizard to make your installation choices.
  4. Click Finish, then close Installation Manager.

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

Silently installing Installation Manager and packages by using the Installation Manager installer

Use the Installation Manager installer to install Installation Manager and other software packages.

You can use the Installation Manager installer to silently install Installation Manager as well as other packages. Optionally, use the installer to install Installation Manager, then use Installation Manager to install packages silently. This file contains instructions for installing software packages using the Installation Manager installer.

To silently install both Installation Manager and packages using the Installation Manager installer that is included with Rational Data Architect, from the InstallerImage_platform sub-directory in the disk1 directory, enter the following command:

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

Argument Description
-vm
Specifies the Java launcher. In silent mode, always use java.exe on Windows, and java on other platforms.
-nosplash
Specifies that the splash screen should be suppressed.
--launcher.suppressErrors
Specifies that the JVM error dialog should be suppressed.
-silent
Specifies that the Installation Manager installer or Installation Manager should be run in silent mode.
-input
Specifies an XML response file as the input to Installation Manager installer or the Installation Manager. A response file contains commands that installer or Installation Manager runs.
-log
(Optional) Specifies a log file that records the result of the silent installation. The log file is an XML file.

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

-updateAll
(Optional) All available updates to are installed.
-installAll
(Optional) All available products are installed.
--launcher.ini silent-install.ini

Specifies the location of the product .ini file to use. If this argument is not specified, the executable will check for a file in the same directory the launcher with the same name and the extension .ini. For example, IBMIM.exe checks for IBMIM.ini and install.exe checks for install.ini. The silent-install.ini file located in the same directory as the IBMIM.exe file contains initialization parameters that are applicable to installing silently and should always be present.

-accessRights
Defines whether the IM operates in admin or nonAdmin mode. For nonAdmin mode this argument should always be used with 'nonAdmin' parameter:
-accessRights nonAdmin
For admin mode it should be used with admin parameter:
-accessRights admin

If this argument is not used, the default value is set based on current user permissions.

Note:

For Windows XP users who are members of Administrator group, the default is always -accessRights admin. For these users to run in nonAdmin mode -accessRights nonAdmin argument should be passed explicitly.

The Installation Manager installer has an initialization or .ini file silent-install.ini that includes default values for the arguments in the table. For example, the silent-install.ini file might look something like this:

-vm
C:\Program Files\IBM\Installation Manager\eclipse\jre_5.0.2.sr5_20070511\jre\bin\java.exe
-nosplash
--launcher.suppressErrors
-silent
-vmargs
-Xquickstart
-Xgcpolicy:gencon

When the Installation Manager installer 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.

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

Response file commands

If you want to use the silent installation capabilities of Installation Manager, you need to create a response file that contains all of the commands that Installation Manager must run. The recommended way to do this is to create a response file by recording your actions as you install a package. However, you can create or edit a response file manually.

There are two categories of commands for the response file:

Silent installation commands

You can use this reference table to learn more about response file commands for use 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. Currently, when creating 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 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 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" selected="true"></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.

The version number is not required. If no version is specified, the Installation Manager will install the most recent product with the specified id and any available updates and fixes.

The "selected" attribute is optional. By default, "selected" is "true". When selected is set to "false", silent install will not install the package. While running in the wizard mode, the package will be displayed in the package selection page but not selected initially.

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

Update (in wizard mode)

<update>
<offering profile= "profile id">
</update>
Use this command to specify the profile that will be updated. The profile ID must match an existing profile.
Note:
This command can only be used in wizard mode to invoke the update wizard; it does not work in silent mode.

Modify (in wizard mode)

<modify>
<offering profile= "profile id">
</modify>
Use this command to specify the profile that will be modified. The profile ID must match an existing profile.
Note:
This command can only be used in wizard mode to invoke the update wizard; it does not work in silent mode.

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

<uninstall modify="true">
<offering profile="profile id"
 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. The default value is 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 "-" for the features 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.

Additional response file attributes

Response file attribute Description

Clean

<agent-input clean="true">
</agent-input>

By default, clean="false". Installation Manager will use the repository and other preferences specified in the response file as well as the existing preferences set in the Installation Manager. If a preference is specified in the response file and the Installation Manager, the one in the response file takes precedence.

If set to clean="true", Installation Manager will use the repository and other preferences specified in the response file; the existing preferences set in the Installation Manager will not be used.

Temporary

<agent-input clean="true" temporary="false">
</agent-input>

By default, temporary is set to 'false' and the preferences set in your response file will be persisted. When you set temporary="true", the preferences set in the response file will not be persisted.

You can use the temporary and clean attributes together, for example, if you set clean to true and temporary to false, after running the silent install the repository setting specified in the response file will override the preferences set in the previous sessions using Installation Manager.

License agreement acceptance

<agent-input acceptLicense="false">
</agent-input>

By default, you do not agree to accept the licenses an installation package carries when using Installation Manager in silent installation mode. If the package you are installing has a license agreement that must be accepted, the silent installation operation will fail. To accept the license agreement, you must set the attribute to <agent-input acceptLicense="true">. By doing so, you agree to accept the license agreements for every package specified in the response file.

Reboot later

<agent-input rebootLater="false">
</agent-input>
By default, rebootLater is set to 'false' and if the response file installs any package that requires rebooting the system on Windows, Installation Manager will reboot the system after the execution of the response file is finished.

When set to 'true', the system will not reboot.

Silent installation preference commands

While you typically specify preferences using the Preferences window, you can also specify preferences (identified 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">
</preference>

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

Key Value Notes(R)
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 UI 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 Proxy servers enable connection to remote servers from behind the firewall. False is the default value. Use this option to enable an HTTP or SOCKS proxy. After the proxy is enabled, the proxy will be used for all server communications.
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 Proxy servers enable connection to remote servers from behind the firewall. False is the default value. Enable this option so that you can specify a SOCKS proxy host address (required) and a SOCKS proxy port number (optional).
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. FTP proxy is an application-level gateway for FTP. It functions between a client and a server, forwarding command and data streams. Beside this basic function, which makes the program helpful on firewall or masqueraders, it offers fixing the FTP server (for example, for connections into a protected LAN) and proxy authentication.
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 c:\IBM\common (Windows)

/opt/IBM/common (Linux)

Note:
The paths above are default values for this preference; typically, install packages provide their own values for this preference.
You cannot change this location if you have already installed a package.
com.ibm.cic.agent.core.pref.offering.service.repositories.areUsed True or False Change this preference to 'False' to disable it. When 'True', all linked repositories will be searched when products are installed or updated.
com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts True or False Change this preference to 'False' to disable it. When true, the files required to roll the package back to a previous version are stored on your system. When false, these files are not stored. If you do not store these files, you must connect to your original repository or media to roll back.
com.ibm.cic.common.core.preferences.repositoryLocations_EDITABLE True or False Use this preference to prevent or allow users to make changes to the repositories once the product is installed.

Starting Installation Manager in wizard mode

You can start Installation Manager in wizard mode from a command line.

Installation Manager can be run in silent mode or wizard mode. To start Installation Manager in wizard mode, enter the following on the command line:IBMIM -mode wizard -input <response> where <response> is the response file path and name.

Based on the commands in your response file, Installation Manager will start in one of the following wizards: install, update, modify, or uninstall. Your response file can only contain commands for one of the Installation Manager wizards. For example, the response file can include either:

Searching for and silently installing all available products

You can silently search for and install all available products.

Follow these steps to find and install all available products by using Installation Manager in silent mode:

  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 products known to Installation Manager are installed.

Silently installing updates to all currently installed products

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

To find and install all available updates for products that are installed, complete the following steps:

  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.

Silently installing from authenticated repositories

You can silently install from an authenticated repository; however, authenticated repositories need the appropriate credentials for access.

Installation Manager uses the Eclipse infrastructure to save credentials in a file called a key ring file. While the contents of the key ring file are encrypted, you can provide an additional level of security by specifying a password to open the key ring file. For additional information on key ring files, refer to the Eclipse workbench user's guide.

To access authenticated repositories in silent mode, complete the following steps:

  1. Create a key ring file and provide the appropriate credentials in the file.
  2. Start Installation Manager in the user interface (UI) mode and specify the following command-line parameters: -keyring <file> [-password <password>]. For example, use the following commands on the appropriate platform:
  3. When you use Installation Manager in UI mode and access a protected repository, a window opens where you can enter the credentials. Enter the correct credentials and then save them. Ensure that the Save password check box is selected. The credentials are saved into the specified key ring file.
  4. Start Installation Manager in silent mode and specify the following command line parameter: -keyring <file> [-password <password>]. During silent install, the credentials for the protected repository are retrieved from the key ring file specified in the command line.
    1. On Windows, use launcher.exe --launcher.ini silent-install -input <input file path and name> -updateAll -log <log file path and name> -keyring <key ring file path and name> -password <password> where launcher is IBMIMc for the Installation Manager and installc for the Installation Manager installer.
    2. On other platforms, use launcher --launcher.ini silent-install -input <input file path and name> -updateAll -log <log file path and name> -keyring <key ring file path and name> -password <password> -keyring /tmp/keyring.txt -password my1secret where launcher is IBMIM for the Installation Manager and install for the Installation Manager installer.

Silently uninstalling Installation Manager

Use the uninstall script to uninstall 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 silently uninstall Installation Manager, complete the following steps:

  1. Go to the uninstall directory for the Installation Manager.
  2. Enter the following command:

Deploying and installing to the enterprise

If you need to install the product to multiple systems, refer to the available articles on the installation Web site.

The Installation Manager information center contains articles that will help you install your product in an enterprise environment. Visit the information center for Installation Manager 1.2 at http://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp.

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 Data Architect .
__   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 Data Architect

You can start Rational Data Architect from the desktop environment or a command-line interface.

For Microsoft Windows operating systems: Click Start -> All Programs -> IBM Software Delivery Platform -> IBM Rational Data Architect 7.5 -> IBM Rational Data Architect.

To start Rational Data Architect 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. 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 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 a license to continue using the product, you have options on how to activate licensing for your product.

Licenses for this product are activated in two ways:

Note:
If you are using a trial license, it will expire 30 or 60 days after installation. You need to 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.

Floating license enforcement

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

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

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 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, complete the following steps:

  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.

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

Activating floating licenses

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

Before activating 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 at http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/v7/rcl/701/docs/install_instruction/install.html.

To activate floating licenses as the license type for specified packages and configure license server connections, complete the following steps:

  1. Start IBM Installation Manager.
  2. On the Start page, click Manage Licenses.
  3. On the Manage License page, select a installed product package, select the Configure Floating license support option, and click Next.
  4. On the Licenses page, read the license agreement for the selected package. If you agree to the terms of all of the license agreements, click I accept the terms of the license agreements and click Next to continue.
  5. On the Floating License Support page, select the Enable Floating license enforcement and 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. 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. 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. 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.

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

Types of licenses

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

Authorized User License

An IBM Rational Authorized User license 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.

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.

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.

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

Your product help system can retrieve content installed with the product, as well as 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.

During installation, your product was configured to access the help from the product information center.

The information center for your product is available from the following URL: http://publib.boulder.ibm.com/infocenter/rdahelp/v7r5/index.jsp.

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

  1. Open the Preferences dialog
  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, enter a name for the connection.
    3. In the Host field, enter publib.boulder.ibm.com
    4. In the Path field, enter /infocenter/rdahelp/v7r5
    5. Select Use default port
    6. Click OK
  5. Select the entry for your product information center.
  6. Click Test Connection.

Downloading help content with the Local Help System Updater site

This topic explains how to download, remove, and update 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.

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.

To download the help content from the Local Help System Updater site, complete the following steps:

  1. With your product open, click Help -> Local Help Updater. The Updater site opens.
  2. In the x pane, select the location of the help you want 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.

The help that you selected is installed on your system. The files will be updated automatically when an Internet connection is available.

Updating help content

Use the Local Help System updater to ensure that you have the latest help content.

You have installed help features from the Local Help System Updater Web site.

Updates are automatically installed each time you start the product, if you have an Internet connection.

To update the help without restarting the product, complete the following 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.
  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 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

You can use the Local Help System Updater to remove installed help content.

You have downloaded help features using the Local Help System Updater.

To remove installed help content, complete the following steps:

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

Setting up an intranet server for help content

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

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

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

The WAR file that is needed to set up Rational Data Architect help on an intranet server is located on the product DVD, in the enterprise folder.

Changing the way you access help content

You can change the way that you access help content.

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

To change the way that you access help content, complete the following steps:

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

Specifying the repository

A repository is a location for storing installation or update package data. By default, IBM Installation Manager uses an embedded URL in each product package to connect to a repository server through the Internet and search for available installation packages and new features. You can set these repository locations on the Repositories page in the Preferences window. Your organization might 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 or IBM.

To specify a repository, complete the following steps:

  1. Start IBM Installation Manager.
  2. On the Start page, click File -> Preferences.
  3. In the Preferences widow, click Repositories. The Repositories page opens, showing available repositories, their locations, and whether they are connected.
  4. On the Repositories page, click Add Repository.
  5. In the Add repository dialog box, type the URL of the repository location or use Browse to find a .zip or JAR file that contains a repository, a diskTag.inf file, or the repository.config file of an expanded repository; then click OK. The new repository location is listed. If the repository is not connected, a red x is displayed in the Connection column.
    Note:
    Updates to packages can be stored in service repositories, for example IBM support sites or local update repositories, which might be linked to the repositories you have listed in the previous procedure. To search for updated packages in these linked service repositories, make sure Search service repositories during installation and updates is selected. This option is selected by default.
  6. Click OK to close the Preferences window.

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. Start IBM Installation Manager.
  2. On the Start page, click Modify.
  3. In the Modify Packages wizard, select the product package group and click Next.
  4. 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.
  5. 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
  6. On the Summary page, review your choices before modifying the installation package and click Modify.
  7. Optional: When the modification process completes, click View Log File to see the complete log.
  8. 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, such as a fix pack, 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, 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

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.

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

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

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.