IBM Data Studio, Version 1.1.1

Installation guide


Note

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

Second Edition (December 2007)

This edition applies to version 1.1.1 of IBM Data Studio and to all subsequent releases and modifications until otherwise indicated in new editions.

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

Contents

Overview
IBM Installation Manager
Installation requirements
Hardware requirements
Software requirements
User privileges requirements
Planning to install
Installation scenarios
Deciding which features to install
Features
Installation repositories
Setting repository preferences in Installation Manager
Package groups and the shared resource directory
Extending an existing Eclipse IDE
Verifying and extracting electronic images
Extracting the downloaded files
Preinstallation tasks
Installation tasks
Installing Data Studio from CDs: task overview
Installing Data Studio from an electronic image on your workstation: task overview
Installing from an electronic image
Installing Data Studio from an electronic image on a shared drive: task overview
Installing from the Launchpad program
Starting the Launchpad program
Starting an installation from the Launchpad program
Installing IBM Data Studio using the IBM Installation Manager graphical interface
Managing IBM Installation Manager
Installing Installation Manager on Windows
Starting Installation Manager on Windows
Uninstalling Installation Manager on Windows
Installing silently
Creating a response file with Installation Manager
Recording a response file with the Installation Manager installer
Silently installing and uninstalling Installation Manager
Silently installing Installation Manager
Silently uninstalling Installation Manager from Windows
Silently uninstalling Installation Manager on other platforms
Installing and running Installation Manager in silent mode
Searching for and silently installing all available products
Silently installing updates to all currently installed products
Response file commands
Silent install preference commands
Silent installation commands
Reference: Sample response file
Silent install log files
Increasing the number of file handles on Linux workstations
Modifying installations
Reverting updates to previous versions
Updating Data Studio
Uninstalling Data Studio
Notices
Trademarks and service marks

Overview

This installation guide provides instructions for installing and uninstalling IBM(R) Data Studio.

Important:
Refer to the release notes for information about installation issues and limitations for Data Studio.

IBM Installation Manager

IBM Installation Manager is a program that helps you install the Data Studio product package on your computer. It also helps you update, modify, and uninstall any package that you install. A package can be a product, a group of components, or a single component that is specifically designed for Installation Manager to install.

IBM Installation Manager offers several time-saving features, which you can use to complete the following tasks:

For more information about IBM Installation Manager, visit the Installation Manager Information Center at http://publib.boulder.ibm.com/infocenter/install/v1m0r0/index.jsp.

Installation requirements

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

Hardware requirements

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

Hardware Requirements
Processor Minimum 2GHz or higher
Memory Minimum: 1GB RAM; For best results: 2GB RAM
Disk space Disk space requirements vary by release and edition. Refer to the release notes for each product for details. Additional disk space is required for the resources that you develop.
Note:
  • Disk space requirements can be reduced or increased depending on the features that you install.
  • Additional disk space is required if you download the product package to install this product.
  • Additional disk space is required if you use FAT32 instead of NTFS.
  • An additional 500 MB of disk space is required in the directory pointed to by your environment variable TEMP.
Display 1024 x 768 display minimum using 256 Colors (or higher for best results)
Other hardware Microsoft(R) mouse or compatible pointing device

Software requirements

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

Operating system

The following operating systems are supported for this product.

Note:
The listed operating systems support all of the languages that are supported by Data Studio.

Note:
This version of the IBM Data Studio was developed for use with Eclipse 3.2.2, using JDK 1.5. If you are extending an existing Eclipse environment, refer to Extending an existing Eclipse IDE for more information.

Additional software requirements

User privileges requirements

You must have a user ID that meets the following requirements before you can install Data Studio.

Planning to install

Read all the topics in this section before you begin to install 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 scenarios

There are a number of scenarios that you can follow when installing Data Studio.

The following are some of the factors that might determine your installation scenario:

These are the typical installation scenarios you might follow:

Note that in the latter three scenarios you can choose to run the Installation Manager program in silent mode to install Data Studio. For details on running Installation Manager in silent mode, see Installing silently.

Installing from CDs

In this installation scenario, you have the CDs that contain the product package files, and typically you are installing Data Studio on your own workstation. Refer to Installing Data Studio from CDs: task overview for an overview of the steps.

Installing from a downloaded electronic image on your workstation

In this scenario, you have downloaded the installation files from IBM Passport Advantage and you will install Data Studio on your own workstation. Refer to Installing Data Studio from an electronic image on your workstation: task overview for an overview of the steps.

Installing from an electronic image on a shared drive

In this scenario, you will place the electronic image on a shared drive so that users in your enterprise can access the installation files for Data Studio from a single location. Refer to Installing Data Studio from an electronic image on a shared drive: task overview for an overview of the steps.

Deciding which features to install

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

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

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

Features

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

Feature Description Selected for installation by default
Data Studio Core Features Includes support for connecting to and browsing data sources and the objects contained in a connection, and creating, running, and tuning SQL statements and XML queries. Yes
SQL Routine Development Provides tooling for developing, testing, and deploying SQL stored procedures and user-defined functions, including wizards, editors, and an integrated stored procedure debugger. Yes
Database Object Management Provides tools for database administration, including an editor for creating and altering data objects and data object privileges. Yes
XML Development Provides tooling for XML application development, including wizards for creating and registering XML schema documents and inserting XML data into XML columns, editors for XML, XSD, and DTD files, and a graphical mapping editor that allows you to annotate XML schemas for shredding. Yes
Java Routine Development Provides tooling for developing, testing, and deploying Java stored procedures, including wizards, editors, and an integrated stored procedure debugger. Yes
pureQuery for Java Provides tools that make it easy to develop Java applications that access databases or in-memory data. The tooling enhances the Java editor with complete assistance for building, validating, and running SQL statements. You can also use the tooling to build pureQuery applications around existing code, SQL, or databases. Yes
SQLJ Development Provides tools for building SQLJ applications, including an SQLJ editor with built in syntax highlighting, an SQLJ translator that translates SQLJ files to pure Java files and produces SQLJ serialized profiles, and an SQLJ debugger that enables you to debug SQLJ files directly. There are also built-in customization features that are available when you are developing SQLJ applications for DB2. Yes
Web Services Development Tools Provides support for creating and deploying Web services that allow client applications to access data in DB2 databases by means of database operations, such as SQL SELECT and DML statements, as well as calls to stored procedures. Yes
WebSphere Application Server Community Edition Installer WebSphere Application Server Community Edition is a free J2EE server for building and managing Java applications. Select this option to copy the installer for WebSphere Application Server Community Edition into the <install dir>\dwb\bin directory on your computer for later installation. You must run the *.exe file from this location to install WebSphere Application Server Community Edition on your computer. No
ClearCase Enablement The Rational ClearCase 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. No
Development Center Project Migration Provides tooling for Development Center project migration. Install this feature if you have artifacts, such as stored procedures, that you want to migrate from a Development Center project. No

Installation repositories

IBM Installation Manager retrieves product packages from specified repository locations.

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

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

Setting repository preferences in Installation Manager

When you start the installation of Data Studio from the Launchpad program, the location of the repository that contains the product package you are installing is automatically defined in IBM Installation Manager when it starts. However, if you start Installation Manager directly (for example, installing Data Studio from a repository located on a Web server) then you must specify the repository preference (the URL for the directory that contains the product package) in Installation Manager before you can install the product package. Specify these repository locations on the Repositories page of the Preferences window. By default, Installation Manager uses an embedded URL in each product to connect to a repository server through the Internet and search for installable packages and new features. Your organization may require you to redirect the repository to use intranet sites.

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

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

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

Package groups and the shared resource directory

When you install the Data Studio package with IBM Installation Manager, you must choose a package group and a shared resource directory.

Package groups

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

If you have products on your computer that were previously installed with Installation Manager, sharing a package group is the method that you use to enable shared installations.

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

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

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

You can install Data Studio into an existing package group only if the product and version in the existing package group is compatible with Data Studio. In most cases, if the existing product is not compatible, you will see an error and the shared installation will fail. However, in some cases Installation Manager will not block the shared installation of incompatible products, which can cause unpredictable installation results. For a list of products that can share a package group with Data Studio, see the release notes for each Data Studio release.

Shared resources directory

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

Important:
You can specify the shared resources directory once: the first time that you install a package. We suggest that you use your largest drive for this. You cannot change the directory location unless you uninstall all packages.

Extending an existing Eclipse IDE

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

If you have products on your computer that were previously installed with the Eclipse update mechanism, extending an Eclipse IDE is the method that you use to enable shared installations. This type of installation should be attempted with caution, since installing product combinations using this method can cause unpredictable installation or product behavior.

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

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

You might extend your existing Eclipse IDE, for example, because you want to gain the functionality provided in the Data Studio package, but you also want to have the preferences and settings in your current IDE when you work with the functionality from the Data Studio package. You also might want to work with plug-ins you have installed that already extend the Eclipse IDE. However, be aware that if you have previously extended an Eclipse IDE by installing any other features or plugins, or if you are trying to extend an Eclipse product (that is, there are additional features and plugins in your installation other than just base Eclipse), it is possible that these features might not be compatible with Data Studio. If they are not compatible, you will see error messages indicating that features need to be updated to a different version. To fix these incompatibilities, you must locate the appropriate versions and update each incompatible feature as indicated by the error messages.

Your existing Eclipse IDE must be the correct version to be extended. See Software requirements for details. In addition, Installation Manager checks that the Eclipse instance you specify meets the requirements for the installation package, and the installation will not proceed if the requirements are not met.

Verifying and extracting electronic images

You can compare the published MD5 values with the checksum of the downloaded files to check if the downloaded file is corrupt or incomplete.

Extracting the downloaded files

Extract each compressed file to the same directory.

Preinstallation tasks

Before you install the product, complete these steps:

  1. Confirm that your system meets the requirements described in the section Installation requirements.
  2. Confirm that the directory pointed to by your environment variable TEMP has at least 100 MB free. This is in addition to the space required for installing the product.
  3. Confirm that your user ID meets the required access privileges for installing the product. See User privileges requirements.
  4. Read the section Planning to install.

Installation tasks

The following sections provide an overview of the installation scenarios that are described in the section Installation scenarios. You can access detailed instructions from links in the main steps.

Installing Data Studio from CDs: task overview

In this installation scenario, you have the CDs that contain the installation files, and typically you are installing Data Studio on your own workstation.

The following are the general steps for installing from CDs:

  1. Complete the preinstallation steps listed in Preinstallation tasks.
  2. Insert the first installation CD into your CD drive.
  3. If autorun is enabled on your system, the Data Studio Launchpad program automatically opens. If autorun is not enabled, start the Launchpad program. Refer to Starting the Launchpad program for details.
  4. Start the installation of Data Studio from the launchpad. For details, see Starting an installation from the Launchpad program.

    If IBM Installation Manager is not detected on your workstation, you are prompted to install it and then the installation wizard starts. Follow the on-screen instructions in the wizard to complete the installation of Installation Manager. See Installing Installation Manager on Windows for details.

    When the installation of Installation Manager completes, or if it is already on your computer, Installation Manager starts and automatically begins the Install Packages wizard.

  5. Follow the on-screen instructions in the Install Packages wizard to complete the installation. For details, see Installing IBM Data Studio using the IBM Installation Manager graphical interface.

Installing Data Studio from an electronic image on your workstation: task overview

The following are the general steps for installing Data Studio from an electronic installation image.

  1. Ensure that your workstation has sufficient space to store both the files you must download from IBM Passport Advantage and the extracted installation image. Refer to Hardware requirements.
  2. Download all required parts for the product image from IBM Passport Advantage to a temporary directory.
  3. Extract the installation image from the downloaded file and verify that the installation image is complete. See Verifying and extracting electronic images for details.
  4. Continue with the steps in Installing from an electronic image below.

Installing from an electronic image

  1. Complete the preinstallation steps listed in Preinstallation tasks.
  2. Start the launcher.
  3. Start the launchpad program. Refer to Starting the Launchpad program for details.
  4. Start the installation of Data Studio from the Launchpad. For details, see Starting an installation from the Launchpad program.

    If IBM Installation Manager is not detected on your workstation, you are prompted to install it and then the installation wizard starts. Follow the on-screen instructions in the wizard to complete the installation of Installation Manager. See Installing Installation Manager on Windows for details.

    When the installation of Installation Manager completes, or if it is already on your system, Installation Manager starts and automatically begins the Install Packages wizard.

  5. Start the installation of Data Studio from the launcher.

    If IBM Installation Manager is not detected on your workstation, you are prompted to install it and then the installation wizard starts. Follow the on-screen instructions in the wizard to complete the installation of Installation Manager. See Installing Installation Manager on Windows for details.

    When the installation of Installation Manager completes, or if it is already on your system, Installation Manager starts and automatically begins the Install Packages wizard.

  6. Follow the on-screen instructions in the Install Packages wizard to complete the installation. For complete details, see Installing IBM Data Studio using the IBM Installation Manager graphical interface.
  7. Increase the number of file handles on your workstation. For details, see Increasing the number of file handles on Linux workstations.

Installing Data Studio from an electronic image on a shared drive: task overview

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

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

  1. Ensure that your shared drive has sufficient disk space to store both the files you must download from IBM Passport Advantage and the extracted installation image. Refer to Hardware requirements for details.
  2. Download all required parts for the product image from IBM Passport Advantage to a temporary directory on the shared drive.
  3. Extract the installation image from the downloaded files into an accessible directory on the shared drive and verify the installation image is complete. See Verifying and extracting electronic images for details.

To install Data Studio from the installation files on the shared drive:

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

Installing from the Launchpad program

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

Use the launchpad program to start the installation of Data Studio in the following cases:

By starting the installation process from the Launchpad program, IBM Installation Manager will start preconfigured with the location of the repository that contains the Data Studio package. If you install and start Installation Manager directly, then you must set repository preference manually.

To install from the launchpad:

  1. Complete the preinstallation tasks described in Preinstallation tasks, if you have not done so already.
  2. Start the launchpad program. See Starting the Launchpad program.
  3. Start the installation of Data Studio. See Starting an installation from the Launchpad program.

Follow the on-screen instructions in the Install Packages wizard to complete the installation. For complete details, see Installing IBM Data Studio using the IBM Installation Manager graphical interface.

Starting the Launchpad program

Complete the preinstallation tasks described in Preinstallation tasks, if you have not done so already.

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

To start the Launchpad program:

  1. Insert the IBM Data Studio CD into your CD drive.
  2. If autorun is enabled on your system, the IBM Data Studio launchpad program automatically opens. If autorun is not enabled on your system:

Starting an installation from the Launchpad program

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

Installing IBM Data Studio using the IBM Installation Manager graphical interface

The following steps describes installing the IBM Data Studio package with the Installation Manager GUI.

  1. The Install page lists all the packages that Installation Manager finds in the repositories that it searches. If two different versions of a package are discovered, only the most recent, or recommended, version of the package is displayed.
  2. Click the IBM Data Studio package to display its description in the Details pane.
  3. To search for updates to the IBM Data Studio package, click Check for updates. Installation Manager searches for updates at the predefined Web site for the product package. It also searches any repository locations that you have set. A progress indicator shows the search is taking place. You can install updates at the same time that you install the base product package.
  4. If updates for the IBM Data Studio package are found, then they will be displayed in the Packages list on the Install Packages page below their corresponding package. Only recommended updates are displayed by default.
  5. Select the IBM Data Studio package and any updates to the package that you want to install. Updates that have dependencies are automatically selected and cleared together. Click Next to continue.
    Note:
    To install multiple packages at the same time, then all the packages will be installed into the same package group.
  6. On the Licenses page, read the license agreement for the selected package. If you selected more than one package to install, there might be a license agreement for each package. On the left side of the License page, click each package version to display its license agreement. The package versions that you selected to install (for example, the base package and an update) are listed under the package name.
    1. If you agree to the terms of all of the license agreements, click I accept the terms of the license agreements.
    2. Click Next to continue.
  7. On the Location page, type the path for the shared resources directory in the Shared Resources Directory field; or, accept the default path. The shared resources directory contains resources that can be shared by one or more package groups. Click Next to continue.
    Important:
    You can specify the shared resources directory only the first time that you install a package. Use your largest disk for this to help ensure adequate space for the shared resources of future packages. You cannot change the directory location unless you uninstall all packages.
  8. On the Location page, either choose an existing package group to install the IBM Data Studio package into, or create a new one. A package group represents a directory in which packages share resources with other packages in the same group. For more information about package groups, refer to Package groups and the shared resource directory. To create a new package group:
    1. Click Create a new package group.
    2. Type the path for the installation directory for the package group. The name for the package group is created automatically.
    3. Click Next to continue.
  9. On the next Location page, you can choose to extend an existing Eclipse IDE already installed on your system, adding the functionality in the packages that you are installing. You must have the minimum version of Eclipse that contains compatible features and plugins to select this option. For more information about extending an Eclipse IDE, see Extending an existing Eclipse IDE.
  10. On the Features page under Languages, select the languages for the package group. The corresponding national language translations for the user interface and documentation for the IBM Data Studio package will be installed. Note that your choices apply to all packages installed under this package group.
  11. On the Summary page, review your choices before installing the IBM Data Studio package. If you want to change the choices you made on previous pages, click Back and make your changes. When you are satisfied with your installation choices, click Install to install the package. A progress indicator shows the percentage of the installation completed.
  12. When the installation process is completed, 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 IBM Data Studio 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.

Managing IBM Installation Manager

Installing Installation Manager on Windows

IBM Installation Manager is installed by the launchpad. For more information on this process, refer to Installing from the Launchpad program.

To install Installation Manager manually:

  1. Run setup.exe from the InstallerImage_win32 folder on the first installation disk.
  2. Click Next on the Welcome screen.
  3. Review the license agreement on the License Agreement page and select I accept the terms in the license agreement to accept. Click Next.
  4. Click the Change button on the Destination Folder page to change the installation location if required. Click Next.
  5. Click Next on the Setup Type page.
  6. Click Install on the Ready to Install Program page. The Completed page opens after the installation is complete.
  7. Click Finish.

Starting Installation Manager on Windows

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

To start Installation Manager manually:

  1. Open the Start menu from the Taskbar.
  2. Select All Programs -> IBM Installation Manager -> IBM Installation Manager.

Uninstalling Installation Manager on Windows

To uninstall Installation Manager manually:

  1. Run setup.exe from the InstallerImager_win32 folder on the first installation disk.
  2. Click Next on the Welcome screen.
  3. Select the Remove button on the Program Maintenance page. Click Next.
  4. Click Next on the Setup Type page.
  5. Click Remove on the Remove the Program page.
  6. Click Finish on the InstallShield Wizard Completed page.

Installing silently

You can install the Data Studio product package by running Installation Manager in silent installation mode. When you run Installation Manager in silent mode, the user interface is not available; instead, Installation Manager uses a response file to input the commands that are required to install the product package. You can also install Installation Manager silently using the Installation Manager installer. You can then use the installer to silently install product packages.

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

Typically, you silently install Installation Manager and the Data Studio package at the same time. The general process is the same as the processes that are described in Recording a response file with the Installation Manager installer and Silently installing and uninstalling Installation Manager. The only difference is that you must run the Installation Manager install program from the <Data Studio media root>/<platform folder>/InstallerImage_<platform> location.

The following tasks are the main tasks that are required for silent installation:

  1. Create the response file.
  2. Run the silent installation command using one of the following methods:

Creating a response file with Installation Manager

You can create a response file by recording your actions as you install a Data Studio product package using Installation Manager, or the Installation Manager installer. 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.

To record a response file for installation (or uninstallation):

  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 the Installation Manager, substituting your own file name and location for the response file and (optionally) the log file:
    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 instructions in the Install Packages wizard to make your installation choices. For details, see Installing IBM Data Studio using the IBM Installation Manager graphical interface.
  4. Click Finish, then close Installation Manager.

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

Recording a response file with the Installation Manager installer

You can use the Installation Manager installer to record the installation of Installation Manager and other products.

To record the installation of Installation Manager, follow these steps:

  1. Unzip the Installation Manager, then go to the InstallerImage_platform directory.
  2. To start recording, enter install -record <response file path and name> -skipInstall <agentDataLocation> -vmargs -Dcom.ibm.cic.agent.hidden=false

Recording a product install with the installer

To start recording a product install with the Installation Manager installer, follow these steps:

  1. Go to the InstallerImage_platform directory in location where you unzipped the Installation Manager.
  2. Open the install.ini file by removing the following lines: -input and @osgi.install.area/install.xml
  3. Enter the following command: install -record <response file path and name> -skipInstall <agentDataLocation>, for example: install -record
  4. Start the Installation Manager and complete the Install Packages wizard.

Silently installing and uninstalling Installation Manager

IBM Installation Manager can be silently installed and uninstalled.

Silently installing Installation Manager

To install Installation Manager silently, unzip the installer and switch to the InstallerImage_platform subdirectory, then use the following commands:

After installation, you can use Installation Manager or the Installation Manager installer to silently install packages.

Note:
You can silently install Installation Manager and the Data Studio package at the same time. The general process is the same as the processes that are described in Recording a response file with the Installation Manager installer and Silently installing and uninstalling Installation Manager. The only difference is that you must run the install program from the <Data Studio media root>/<platform folder>/InstallerImage_<platform> location.

Silently uninstalling Installation Manager from Windows

To silently uninstall Installation Manager:

  1. Create a response file for the uninstallation.
  2. Follow the instructions in Installing and running Installation Manager in silent mode.

Silently uninstalling Installation Manager on other platforms

To silently uninstall Installation Manager on other platforms:

  1. From a terminal window, go to the directory uninstallation directory of Installation Manager. By default, this is/var/ibm/InstallationManager/uninstall).
  2. Run the following command: uninstall --launcher.ini silent-uninstall.ini

Installing and running Installation Manager in silent mode

Use the Installation Manager installer to install Installation Manager, then use Installation Manager to install product packages in silent installation mode from a command line.

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

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.

Both the Installation Manager installer and the Installation Manager have an initialization or .ini file silent-install.ini that includes default values for the arguments in the table.

The Installation Manager installer is used to install the Installation Manager. Follow these steps to install the Installation Manager silently.

To install Installation Manager silently, unzip the installer and switch to the eclipse subdirectory, then use the following commands:

After Installation Manager is installed, you can use it to install other products. You can also use the Installation Manager installer to install the products.

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

If you want to silently install products using the Installation Manager installer, from the eclipse directory, enter the following command:

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

Searching for and silently installing all available products

You can silently search for and install updates for all available products.

To search for and silently install all available products:

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

All available 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 search for and silently install updates for all available products:

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

All available product updates known to Installation Manager are installed.

Response file commands

If you want to use the silent installation capabilities of Installation Manager, you 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 the IBM Data Studio package. However, you can create or edit a response file manually.

There are two categories of commands for the response file:

Silent install 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" 
</preferences>

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. installDataLocation Specifies the installation location of Installation Manager data.
Important:
This key is optional and is designed for use in testing and debugging. If you do not specify an installation location for Installation Manager, the silent installation and UI version of Installation Manager will use the same location.
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 False is the default value.

com.ibm.cic.common.core. preferences.

http.proxyHost

Host name or IP address

com.ibm.cic.common.core. preferences.

http.proxyPort

Port number

com.ibm.cic.common.core. preferences.

http.proxyUseSocks

True or False False is the default value.

com.ibm.cic.common.core. preferences.

SOCKS.proxyHost

Host name or IP address

com.ibm.cic.common.core. preferences.

SOCKS.proxyPort

Port number

com.ibm.cic.common.core. preferences.

ftp.proxyEnabled

True or False False is the default value.

com.ibm.cic.common.core. preferences.

ftp.proxyHost

Host name or IP address

com.ibm.cic.common.core. preferences.

ftp.proxyPort

Port number

com.ibm.cic.common.core. preferences.eclipseCache

Common component directory

Silent installation commands

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

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

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

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

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

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

Uninstall

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

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

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

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

Rollback

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

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

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

InstallAll

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

UpdateAll

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

License

<license policyFile="policy file
 location"/>

For example:

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

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

Wizard

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

Reference: Sample response file

You can use an XML-based response file to specify predefined information such as silent installation preferences, repository locations, installation profiles, and so on. Response files are beneficial for teams and 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>

Silent install log files

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

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

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

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

Increasing the number of file handles on Linux workstations

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

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

To increase your file descriptors:

  1. Log in as root. If you do not have root access you will need to obtain it before continuing.
  2. Change to the etc directory
  3. Use the vi editor to edit the initscript file in the etc directory. If this file does not exist, type vi initscript to create it.

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

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

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

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

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

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

Modifying installations

The Modify Packages wizard in the IBM Installation Manager enables you to change the language and feature selections of an installed product package.

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

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

To modify an installed product package:

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

Reverting updates to previous versions

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

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 install a package. If you installed the package from a repository, the files are not available on your computer. You must have listed in your Preferences (File > Preferences > Repository) the repository from which you installed the previous version of the product. If you installed the product from CDs or other media, they must be available when you use the rollback feature.

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

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

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

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

Updating Data Studio

You can install updates for packages that were installed with IBM Installation Manager.

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

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

To find and install product package updates:

  1. From the Start page of the Installation Manager, click Update Packages.
  2. In the Update Packages page, select the location where the Data Studio product package is installed and then click Next. Installation Manager searches for updates in its repositories and the predefined update sites for Data Studio. A progress indicator shows the search is taking place
  3. If updates are found, they are shown on the Updates page. By default, only recommended updates are displayed and they are selected by default. Click Show All to display all available updates. Accept the default selections or select other updates and click Next.
  4. On the Licenses page, read the license agreement for the updates. If you agree to the terms of all of the license agreements, click I accept the terms of the license agreements and then click Next.
  5. Review the details on the Summary page and then click Update. When the update process finished, the Complete page displays the results.
  6. Optional: Click the View Log File link to see the complete log.
  7. Click Finish to close the wizard.

Uninstalling Data Studio

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

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

To uninstall the packages:

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

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(R) 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.