Installing the Optim server components

The Optim™ server environment includes the required components for computers that will manage run time operations.

Installation overview

Test Data Management Solution

To install IBM InfoSphere Optim Test Data Management Solution, first use the Optim Repository launchpad to install the repository, and then use the Optim Client and Optim Server launchpads to complete the installation.

IBM InfoSphere Optim Test Data Management Solution requires an installation of IBM InfoSphere Optim Manager and IBM InfoSphere Optim Proxy:

IBM InfoSphere Optim Manager
The following components must be installed on an IBM InfoSphere Optim Manager computer:
  • IBM InfoSphere Optim Manager
  • IBM WebSphere® Application Server Community Edition (WAS-CE)
  • IBM InfoSphere Optim Repository Services
IBM InfoSphere Optim Proxy
The following components must be installed on an IBM InfoSphere Optim Proxy computer:
  • IBM InfoSphere Optim Proxy
  • IBM InfoSphere Optim Repository Services
  • IBM InfoSphere Optim Solutions
Data Growth Solution and Solution for Application Retirement
To install IBM InfoSphere Optim Data Growth Solution or IBM InfoSphere Optim Solution for Application Retirement, install the IBM InfoSphere Optim Solutions component from this launchpad.

To install IBM InfoSphere Optim Solutions, use the IBM InfoSphere Optim installer.

For the most up to date IBM InfoSphere Optim system requirements, see the technote on the Web: http://www.ibm.com/support/docview.wss?uid=swg27024294.

Installing IBM InfoSphere Optim Manager

IBM InfoSphere Optim Manager (manager) is a web application that you can use to configure, run, monitor, and manage services. You also use manager to configure the components that are used to run these services. Optim Manager is also known as the manager. The Optim Manager functions are also available from a public web services interface, Optim Service Interface.

The Optim Manager components can be installed on supported Linux, UNIX, and Windows platforms.

Running the repository during installation is recommended, as the installation process can configure the repository location for the Optim Manager. You can also configure the repository location after installation.

To install the Optim Manager components, use IBM Installation Manager.

The following components must be installed on an Optim Manager computer:

IBM InfoSphere Optim Manager

Optim Manager is a web application that is used to run and monitor Optim data management services. Use this version of Optim Manager only with the same version of other Optim solution components.

The Optim Manager functions are also available from a public web services interface, Optim Service Interface. Optim Service Interface is based on RESTful Web services and is an optional component that can be used in place of Optim Manager.

Optim Manager and Optim Service Interface require an installation of a J2EE application server, such as IBM WebSphere Application Server Community Edition (WAS-CE).

The Optim Manager installation copies two Web Archive (WAR) files to the computer: optim.war (for Optim Manager) and optim-service-interface.war (for Optim Web Service Interface).

IBM WebSphere Application Server Community Edition (WAS-CE)

IBM WebSphere Application Server Community Edition (WAS-CE) is a lightweight J2EE application server. It is based upon Apache Geronimo technology developed by the Apache Software Foundation. If you plan on using WAS-CE as your application server, install only this instance of WAS-CE on this machine. This version of WAS-CE is optimized for use with the version of Optim solution components that is delivered with this version of WAS-CE.

WAS-CE is not available for HP platforms.

IBM InfoSphere Optim Repository Services

InfoSphere Optim Repository Services is the client software for the InfoSphere Optim Repository Server database. InfoSphere Optim Repository Services is required for IBM InfoSphere Optim components to connect to InfoSphere Optim Repository Server. InfoSphere Optim Repository Services is an IBM Informix® client. Before you install InfoSphere Optim Repository Services, uninstall any Informix® client software that is on the computer.

Installing IBM InfoSphere Optim Proxy

The Optim Proxy components can be installed on supported Linux, UNIX, and Windows platforms.

Running the repository during installation is recommended, as the installation process can configure the repository location for the Optim Proxy. You can also configure the repository location after installation.

To install Optim Proxy and Optim Repository Services, use IBM Installation Manager.

To install IBM InfoSphere Optim Solutions, use the IBM InfoSphere Optim installer.

The following components must be installed on an Optim Proxy computer:

IBM InfoSphere Optim Proxy

Optim Proxy is a distributed process that executes data management services on Manager. For fastest processing, install the Optim Proxy on the same machine as the data source or on a computer with a fast connection to the data source. Use this version of Optim Proxy only with the same version of other Optim solution components.

The Optim Proxy computer requires an installation of IBM InfoSphere Optim.

IBM InfoSphere Optim Repository Services

InfoSphere Optim Repository Services is the client software for the InfoSphere Optim Repository Server database. InfoSphere Optim Repository Services is required for IBM InfoSphere Optim components to connect to InfoSphere Optim Repository Server. InfoSphere Optim Repository Services is an IBM Informix® client. Before you install InfoSphere Optim Repository Services, uninstall any Informix client software that is on the computer.

IBM InfoSphere Optim Solutions

The IBM InfoSphere Optim solutions manage enterprise data throughout every stage of the information lifecycle, enabling your company to assess, classify, subset, archive, store, and access enterprise application data.

Using IBM Installation Manager to install the IBM Optim Server components

Use the Installation Manager product to install, update, and uninstall the Optim Server components.

For information about configuring and using the Optim Manager environment, refer to the documentation location on the installation disc.

Installation roadmap for the IBM Optim Server components

The installation roadmap lists the high-level steps for installing the IBM Optim Server components.

This roadmap describes a typical installation using the Installation Manager Install wizard. If you are installing the product silently, see the Silent installation road maps.

Silent installation road maps

The typical silent installation path is to use the Installation Manager installer to install Installation Manager, and then to use Installation Manager to record a response file, then to silently install software packages. Optionally, you can use the Installation Manager installer to install Installation Manager and software packages at the same time. When you install in silent mode, the user interface is not available; instead, a response file inputs the commands that are required to install the software packages.

There are two main road maps for performing a silent installation.
  1. Use Installation Manager to silently install software packages:
    1. Install Installation Manager using the Installation Manager installer.
    2. Record a response file using Installation Manager, or Create a response file manually.
    3. Run the Installation Manager in silent mode to perform the operation silently.
  2. Use the Installation Manager installer to silently install software packages:
    1. Create a response file manually that includes commands to install Installation Manager and other packages.
    2. Run the Installation Manager installer with the response file.

Installation introduction

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

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 or Unix operating systems, this is the "root" or any user who is using "sudo" to start Installation Manager. On a Microsoft Windows XP operating system, a user with write administrative privileges is any user who is a member of the "Administrators" group. On a Microsoft Windows Vista, Windows Server 2008, or Windows 7 operating system, this is the user who is using "Run As Administrator" to start Installation Manager or launch pad.
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 their 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 this product 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:
    • On Windows: C:\Program Files\IBM\InstallationManager
    • On Linux or Unix systems: /opt/IBM/InstallationManager
  • Non-admin installation:
    • On Windows systems: user.home\IBM\InstallationManager
    • On Linux or Unix systems: user.home/IBM/InstallationManager
Installation Manager shared resources directory Shared resources directory
  • Admin installation:
    • On Windows systems: C:\Program Files\IBM\SDP70Shared
    • On Linux or Unix systems: /opt/IBM/SDP70Shared
  • Non-admin installation:
    • On Windows systems: user.home\IBM\SDPS70hared
    • On Linux or Unix systems: user.home/IBM/SDP70Shared
Product installation directory Product directory
  • Admin installation:
    • On Windows systems:
      • Optim Manager and WebSphere Application Server Community Edition (WAS-CE):C:\IBM\InfoSphere\Optim\shared
      • Optim Proxy: C:\IBM\InfoSphere\Optim\proxy
      • Optim Repository Services: C:\IBM\InfoSphere\Optim\repo\services
    • On Linux or Unix systems:
      • Optim Manager and WebSphere Application Server Community Edition (WAS-CE):/opt/IBM/InfoSphere/Optim/shared
      • Optim Proxy: /opt/IBM/InfoSphere/Optim/proxy
      • Optim Repository Services: /opt/IBM/InfoSphere/Optim/repo/services
  • Non-admin installation:
    • On Windows systems:
      • Optim Manager and WebSphere Application Server Community Edition (WAS-CE):user.home\IBM\InfoSphere\Optim\shared
      • Optim Proxy: user.home\IBM\InfoSphere\Optim\proxy
      • Optim Repository Services: user.home\IBM\InfoSphere\Optim\repo\services
    • On Linux or Unix systems:
      • Optim Manager and WebSphere Application Server Community Edition (WAS-CE):/user.home/IBM/InfoSphere/Optim/shared
      • Optim Proxy: /user.home/IBM/InfoSphere/Optim/proxy
      • Optim Repository Services: /user.home/IBM/InfoSphere/Optim/repo/services
Product workspace directory workspace directory
  • Admin installation:
    • Optim Proxy
      • On Windows systems: C:\IBM\InfoSphere\Optim\proxywork
      • On Linux or Unix systems: /opt/IBM/InfoSphere/Optim/proxywork
  • Non-admin installation:
    • Optim Proxy
      • On Windows systems: user.home\IBM\InfoSphere\Optim\proxywork
      • On Linux or Unix systems: /opt/IBM/InfoSphere/Optim/proxywork

Planning the installation

Read all of the following topics 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 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 if required, and uninstall the packages from your system.

Version 1.5.2 of Installation Manager is included with the product. All instructions in this Installation Guide assume that you are using the included version of Installation Manager. If you upgrade later to a higher version of Installation Manager, some of the instructions might not be accurate. The Installation Manager information center is on the Web at: http://pic.dhe.ibm.com/infocenter/install/v1r5/index.jsp

Installation Manager includes six wizards that make it easy to maintain packages through their life cycles:
  • The Install wizard walks you through the installation process. You can install a package by simply accepting the defaults, or you can modify the default settings to create a custom installation. Before you install, you are provided with a complete summary of your selections throughout the wizard. Using the wizard you can install one or more packages at one time.
  • The Update wizard will search for available updates to packages that you have installed. An update might be a released fix, a new feature, or a new version of the product. Details of the contents of the update are provided in the wizard. You can choose whether to apply an update
  • The Manage Licenses wizard helps you set up the licenses for your packages. Use this wizard to change your trial license to a full license, to set up your servers for floating licenses and to select which type of license to use for each package. Not all product packages require licenses.
  • The Roll Back wizard enables you to revert to a previous version of a package.
  • The Uninstall wizard will remove a package from your computer. You can uninstall more than one package at a time.
  • With the Modify wizard you can modify certain elements of a package that you have already installed. During the first installation of the package, you select the features that you want to install. If you find later that you require other features, you can use the modify packages wizard to add them to your package. You can also remove features and add or remove languages.
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 the product by using the launchpad from the product DVD, IBM Installation Manager automatically starts even if it is not already installed. If the correct version of Installation Manager is not installed, Installation Manager will prompt you to upgrade to the correct version.

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 the product 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 manually:
  • On Windows systems: Click Start > All Programs > IBM Installation Manager > IBM Installation Manager
  • For Linux or Unix: Change to Installation Manager directory/eclipse and run IBMIM

Installation requirements

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

Hardware and software requirements for IBM Optim Server

Before you can install the product, 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.

For the most up to date IBM InfoSphere Optim system requirements, see the technote on the Web: http://www.ibm.com/support/docview.wss?uid=swg27024294.

Important: Do not attempt to install the product on operating systems other than those that are listed in the system requirements. Installation Manager might run on other operating systems, but the product package installation can fail. If installation fails, uninstallation sometimes also fails.
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. For information about how to choose between these two options, see the topic: Installation terminology

Implications of using an administrative or non-administrative 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-administrative Case where you install as Administrative
Non-administrative (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 or Microsoft Windows 7: An error message occurs.
  • For Microsoft Windows Vista or Microsoft Windows 7: You are prompted to log on with an Admin user ID.
Administrative 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
Additional requirements for Linux and Unix operating systems

If you use a Linux or Unix 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.

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.

The following tables show the features of the product that you can install for each package. 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.

IBM InfoSphere Optim Manager
Feature Description
Optim Manager WAR File The Optim Manager WAR file provides a web-based GUI that is used to run and monitor Optim data management services. After installation, deploy the Optim Manager WAR file to your preferred application server, such as IBM WebSphere Application Server Community Edition (WAS-CE).
Optim Service Interface WAR File The Optim Service Interface WAR file provides an API that is used to run and monitor Optim data management services. After installation, deploy the Optim Service Interface WAR file to your preferred application server, such as IBM WebSphere Application Server Community Edition (WAS-CE).
Optim Designer and Optim Manager Documentation All of the available Optim Designer and Optim Manager Documentation in PDF format.
Command-line application for the service interface A Java-based command-line application that can be used to submit requests to the services interface. The service interface must be deployed to an application server before you can use this application.
IBM InfoSphere Optim Proxy
Feature Description
Optim Proxy The Optim Proxy is a distributed process that executes data management services on Manager. For fastest processing, install the Optim Proxy on the same machine as the data source or on a computer with a fast connection to the data source. Use this version of Optim Proxy only with the same version of other Optim solution components.
IBM WebSphere Application Server Community Edition (WAS-CE)
Feature Description
IBM WebSphere Application Server Community Edition (WAS-CE) IBM WebSphere Application Server Community Edition (WAS-CE) is a lightweight J2EE application server. It is based upon Apache Geronimo technology developed by the Apache Software Foundation. If you plan on using WAS-CE as your application server, install only this instance of WAS-CE on this machine. This version of WAS-CE is optimized for use with the version of Optim solution components that is delivered with this version of WAS-CE.
IBM InfoSphere Optim Repository Services
Feature Description
Optim Repository Client Installs the files to access an Optim Repository on a remote machine or virtual machine running locally. This option is required on any machine where Optim is installed.

Installation considerations

Part of planning entails making decisions about things such as installation locations, working with other applications, or extending Eclipse. This information 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.
  • A package group represents a directory in which products might share resources with other products in the same package group. This option is also sometimes called "shell sharing."
  • Not all products can share a package group, in which case the option to use an existing package group will be disabled.
  • When you install a product using Installation Manager, you either create a package group or install the product into an existing package group. A new package group is assigned a name automatically; however, you choose the installation directory for the package group.
  • After you create a package group you cannot change the installation directory. The installation directory contains files and resources shared by the products installed into that package group.
  • When you install multiple products at the same time, all products are installed into their respective package groups.
Optim Server packages

Optim Server includes several installation packages.

The following installation packages are available.

IBM WebSphere Application Server Community Edition (WAS-CE)

IBM WebSphere Application Server Community Edition (WAS-CE) is a lightweight J2EE application server. It is based upon Apache Geronimo technology developed by the Apache Software Foundation. If you plan on using WAS-CE as your application server, install only this instance of WAS-CE on this machine. This version of WAS-CE is optimized for use with the version of Optim solution components that is delivered with this version of WAS-CE.

WAS-CE is not available for HP platforms.

IBM InfoSphere Optim Manager

Optim Manager is a web application that is used to run and monitor Optim data management services. Use this version of Optim Manager only with the same version of other Optim solution components.

The Optim Manager functions are also available from a public web services interface, Optim Service Interface. Optim Service Interface is based on RESTful Web services and is an optional component that can be used in place of Optim Manager.

Optim Manager and Optim Service Interface require an installation of a J2EE application server, such as IBM WebSphere Application Server Community Edition (WAS-CE).

The Optim Manager installation copies two Web Archive (WAR) files to the computer: optim.war (for Optim Manager) and optim-service-interface.war (for Optim Web Service Interface).

IBM InfoSphere Optim Proxy

Optim Proxy is a distributed process that executes data management services on Manager. For fastest processing, install the Optim Proxy on the same machine as the data source or on a computer with a fast connection to the data source. Use this version of Optim Proxy only with the same version of other Optim solution components.

The Optim Proxy computer requires an installation of IBM InfoSphere Optim.

IBM InfoSphere Optim Repository Services

InfoSphere Optim Repository Services is the client software for the InfoSphere Optim Repository Server database. InfoSphere Optim Repository Services is required for IBM InfoSphere Optim components to connect to InfoSphere Optim Repository Server. InfoSphere Optim Repository Services is an IBM Informix® client. Before you install InfoSphere Optim Repository Services, uninstall any Informix client software that is on the computer.

Coexistence considerations

Coexistence refers to the installed products on the same computer.

Package group coexistence considerations

You can install multiple compatible packages into the same package group. This is sometimes also referred to as "shell sharing".

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.

The Optim components can be installed at the same time.

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.

The Optim version 9.1.0 components cannot exist on the same system as previous versions of the Optim components.

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®, verify that you have all the required parts and extracted the download files correctly.
  2. (For Linux or Unix) If you are installing from physical media, mount your DVD drive.
  3. (For Linux or Unix) 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 or Unix) Increase the number of file handles on your computer.
  5. Ensure that you are logged on to your computer with an appropriate user ID.
  6. Optional: If you are installing from an intranet site, specify the repository.

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:
  • Ensure that you preserve the directory structure of compressed files when you extract them.
  • Extract the contents of all of the compressed files to the same directory. For Linux or Unix, do not include spaces in the directory names, or you won't be able to run the command to start the launchpad from a command line.
  • You must not mix files from one install kit with another install kit.
  • Some launchpads require multiple compressed files or DVDs. When downloading a launchpad that requires multiple compressed files, the files must be extracted into the same directory.

Mounting a drive

With some operating systems, such as Linux or Unix, 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 or Unix:
  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.

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.

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

This task is only necessary to complete if you are installing from a repository other than the default repository on the Internet or the product media. For example, your organization might require you to redirect the repository to use intranet sites.

The repository is located in the /repo directory on the installation disc.

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.

Installing software

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

Installing Optim Server with the Installation Manager Install wizard

This topic provides the instructions for installing Optim Server with the Installation Manager Install wizard.

Complete any necessary pre-installation tasks.

This information describes how to start the product package installation for a typical installation. You typically install the product package using the installation launchpad and the Installation Manager Install wizard. For information about how to install the product package silently, see the silent installation information.

For products that are installed by IBM Installation Manager, starting the installation process causes IBM Installation Manager to start even if it is not already installed. You will then install Installation Manager on your computer during the process of installing the product package. The installation wizard is pre-configured with the location of the repository that contains the installation package.
Note: If a new version of Installation Manager is found when you start the installation, 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.

The launchpad includes options to perform either an administrative or a non-administrative installation.

To install IBM InfoSphere Optim Server with the Installation Manager Install wizard:
  1. Insert the product DVD into your DVD drive. For Linux and Unix, ensure that you have mounted the DVD drive.

    If autorun is enabled on your computer, the launchpad automatically opens.

    To start the installation manually, follow the next step.

  2. Optional: To start the installation manually, run launchpad.exe or launchpad.sh, which is located in the root directory of the DVD.
    As an alternative if you have already installed Installation Manager separately, you can also start the installation process by following these steps:
    1. Start Installation Manager.
    2. Configure the Installation Manager repository preferences.
    3. Run the Installation Manager Install wizard to install the product package.
  3. Optional: If you are installing with the launchpad, read the product information.
  4. Optional: If you are installing with the launchpad, click Install the IBM InfoSphere Optim Manager Components to open the Installation Manager Install wizard.
  5. In the Install Packages page of the Installation Manager Install wizard, select the packages to install.
  6. You can install updates at the same time that you install the base product package, if updates are available. 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 manually in the Installation Manager Preferences window.
  7. 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.
  8. Click Next.
  9. 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.
  10. 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 you 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.
  11. Click Next to continue.
  12. 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.
  13. On the Features page under Languages, select the languages for the package group. The corresponding national language translations for the user interface and documentation for the product package will be installed.
  14. On the next Features page, select the package features that you want to install.
    1. Optional: To see the dependency relationships between features, select Show Dependencies.
    2. Optional: Click a feature to view its brief description under Details.
    3. Select or clear features in the packages. Installation Manager will automatically enforce any dependencies with other features and display updated download size and disk space requirements for the installation.
    4. When you are finished selecting features, click Next to continue.
  15. On the next Features pages, do the following according to the installation package:
    Optim Manager, Optim Proxy, and Optim Repository Services
    Enter and validate client connection information for the Optim Repository.
    Optim Proxy
    Enter and validate the proxy user name information for the Optim Repository. Enter the location of the work directory and IBM InfoSphere Optim installation directory.
    After completing the pages, click Next to continue.
  16. On the Summary page, review your choices before installing the product package. If you want to change the choices that you made on previous pages, click Back, and make your changes. When you are satisfied with your installation choices, click Install to install the package. A progress indicator shows the percentage of the installation completed.
  17. When the installation process is complete, a message confirms the success of the process.
    1. Click View log file to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.
    2. Click Finish to launch the selected package. The Install Package wizard closes and you are returned to the Start page of Installation Manager.
  18. Close Installation Manager.
Complete any necessary post-installation tasks.

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.

Silent installation road maps

The typical silent installation path is to use the Installation Manager installer to install Installation Manager, and then to use Installation Manager to record a response file, then to silently install software packages. Optionally, you can use the Installation Manager installer to install Installation Manager and software packages at the same time. When you install in silent mode, the user interface is not available; instead, a response file inputs the commands that are required to install the software packages.

There are two main road maps for performing a silent installation.
  1. Use Installation Manager to silently install software packages:
    1. Install Installation Manager using the Installation Manager installer.
    2. Record a response file using Installation Manager, or Create a response file manually.
    3. Run the Installation Manager in silent mode to perform the operation silently.
  2. Use the Installation Manager installer to silently install software packages:
    1. Create a response file manually that includes commands to install Installation Manager and other packages.
    2. Run the Installation Manager installer with the response file.
Using the Installation Manager installer

The Installation Manager installer is the tool used to install Installation Manager silently. It can also be used to install packages.

The Installation Manager installer is a command-line utility. Run the Installation Manager installer to silently install and uninstall Installation Manager. You can also install software packages using the Installation Manager installer.

If you do not already have Installation Manager installed on your computer, you might choose to use the Installation Manager installer to install both Installation Manager and packages together using a single command. This sample response file provides an example for installing Installation Manager and a software package. If you already have Installation Manager installed on your computer, you can simply use Installation Manager to install packages .

Installing Installation Manager silently

Use the Installation Manager installer to install Installation Manager silently.

The Installation Manager installer is used to install the Installation Manager. You can install the Installation Manager as an administrator, or in non-administrator modes. Follow the example below to install Installation Manager.

  1. Unzip the Installation Manager installer. The Installation Manager kit is available from: http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/v7/im/. Select the version number that you want to install, for example 143/, then select the zips directory.
  2. Switch to the InstallerImage_platform subdirectory.
  3. Enter one of the following commands:
    • To install as an administrator on Windows: installc.exe -log <log file path and name> For example: installc.exe -log c:\mylogfile.xml
    • To install as non-administrator on Windows: userinstc.exe -log <log file path and name> For example: installc.exe -log c:\mylogfile.xml
    • For other platforms as an administrator: ./installc -log <log file path and name> For example,./installc -log /root/mylogs/mylogfile.xml
    • For other platforms as non-administrator: ./userinstc -log <log file path and name> For example,./userinstc -log /root/mylogs/mylogfile.xml
After you install Installation Manager silently, you can use Installation Manager or the Installation Manager installer to silently install packages.
Changing the default installation location

You can change the default location for installing Installation Manager by modifying the install.xml response file.

The Installation Manager installer uses a default response file to install Installation Manager installer. You can modify the file to change the default installation location.
  1. Go to the InstallerImage_platform directory
  2. Locate the response file install.xml
  3. Modify the location for installing Installation Manager by adding profile information and using the data key and value attributes to specify the installation location. The installation location must be a directory named eclipse.
Changes were made to the default install.xml response file to change the installation location to C:\IBM\InstallationManager.
<?xml version="1.0" encoding="UTF-8"?>
<agent-input clean='true' temporary='true'>

<!-- add a profile and specify the installation location using the data value attribute. The location must end in \eclipse -->
<profile kind='self' installLocation='C:\IBM\InstallationManager\eclipse' id='IBM Installation Manager'>
<data key='eclipseLocation' value='C:\IBM\InstallationManager\eclipse'/>
</profile>

<server>
<repository location='.'/>
</server>

<!-- add the profile information but do not modify the features, id, and version number -->
<install>
<offering profile='IBM Installation Manager' features='agent_core,agent_jre' id='com.ibm.cic.agent' version='1.4.3.20110624_0100'/>
</install>
</agent-input>
Silently installing packages using the Installation Manager installer

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

To install software packages using the Installation Manager installer, you must first create a response file.

You can use the Installation Manager installer to silently install Installation Manager and software packages at the same time. Optionally, use the installer to install Installation Manager, then use Installation Manager to install packages silently.

To silently install packages using the Installation Manager installer, from the InstallerImage_platform directory, enter the following command:

  • For Windows as administrator: installc.exe -acceptLicense input <response file path and name> -log <log file path and name>. For example: installc.exe -acceptLicense input c:\myresponse\responsefile.xml -log c:\mylog\silent_install_log.xml.
  • For Windows as non-administrator: userinstc.exe -acceptLicense input <response file path and name> -log <log file path and name>. For example: userinstc.exe -acceptLicense input c:\myresponse\responsefile.xml -log c:\mylog\silent_install_log.xml .
  • For other platforms as administrator: ./installc -acceptLicense input <response file path and name> -log <log file path and name>. For example: ./installc -acceptLicense input /root/myresponse/responsefile.xml –log /root/mylog/silent_install_log.xml
  • For other platforms as non-administrator: ./userinstc -acceptLicense input <response file path and name> -log <log file path and name>. For example: ./userinstc -acceptLicense input /root/myresponse/responsefile.xml –log /root/mylog/silent_install_log.xml
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.
-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.
-acceptLicense
Include the
-acceptLicense
option in your command when the package you are installing requires that you accept the licensing agreement.
-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.
-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.
-showProgress
Displays a progress bar to the console.
-ShowVerboseProgress
Displays progress text to the console. For example, the text "Rebooting the machine to complete the install" is displayed when a reboot is required.
The Installation Manager installer has an initialization or .ini file silent-install.ini (or user-silent-install.ini for non-administrator installations) that includes default values for the arguments in the table. For example, a default silent-install.ini file might look something like this:
-accessRights
admin
-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
If the installation is successful, it will return a status of "0" an unsuccessful operation will return a non-zero number.
When Installation Manager installer is run, it reads the response file and (optionally) writes to a log file to the directory specified. If you specified a log file and directory, the log file will be empty if operation was successful, for example:
<?xml version="1.0" encoding="UTF-8"?>
<result>
</result>
The log file will contain an error element if the operation was not completed successfully.
A log file for Installation Manager is also available. The default locations for the Installation Manager log file are
  • For Windows as non-admin: C:\Documents and Settings\<my id>\Application Data\IBM\Installation Manager\logs
  • For Windows as admin: C:\Documents and Settings\All Users\Application Data\IBM\Installation Manager\logs
  • For other platforms: /var/ibm/InstallationManager/logs
Installing silently with Installation Manager

Launch Installation Manager in silent mode with a response file to install, uninstall, update, or modify packages silently. Installation Manager is the tool that you typically use to install packages silently.

If you do not already have Installation Manager installed on your computer, you can also use the Installation Manager installer to install both Installation Manager and packages together silently using a single command.

Silently installing packages using Installation Manager

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

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

To run Installation Manager in silent mode, run the following command from the eclipse subdirectory in the directory where you installed Installation Manager:
  • For Windows: imcl.exe -acceptLicense input <response file path and name> -log <log file path and name>. For example: imcl.exe -acceptLicense input c:\mylog\responsefile.xml -log c:\mylog\silent_install_log.xml
  • For other platforms: ./imcl -acceptLicense input <response file path and name> -log <log file path and name>. For example: ./imcl -acceptLicense input /root/mylog/responsefile.xml –log /root/mylog/silent_install_log.xml
The following table describes the arguments that are 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.
-acceptLicense
Include the
-acceptLicense
option in your command when the package you are installing requires that you accept the licensing agreement.
-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) Specifies that all available updates are installed.
-installAll
(Optional) Specifies that all available products are installed.
-showProgress
Displays a progress bar to the console.
-ShowVerboseProgress
Displays progress text to the console. For example, the text "Rebooting the machine to complete the install" is displayed when a reboot is required.
-accessRights
Specifies whether the Installation Manager operates in admin or nonAdmin mode. For nonAdmin mode, this argument should always be used with the 'nonAdmin' parameter:
-accessRights nonAdmin
For admin mode, this argument should be used with the '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, the -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:
-accessRights
admin
-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
If the installation is successful, it will return a status of "0" an unsuccessful operation will return a non-zero number.
When Installation Manager installer is run, it reads the response file and (optionally) writes to a log file to the directory specified. If you specified a log file and directory, the log file will be empty if operation was successful, for example:
<?xml version="1.0" encoding="UTF-8"?>
<result>
</result>
The log file will contain an error element if the operation was not completed successfully.
A log file for Installation Manager is also available. The default locations for the Installation Manager log file are
  • For Windows as non-admin: C:\Documents and Settings\<my id>\Application Data\IBM\Installation Manager\logs
  • For Windows as admin: C:\Documents and Settings\All Users\Application Data\IBM\Installation Manager\logs
  • For other platforms: /var/ibm/InstallationManager/logs
Silently installing all available products using Installation Manager

You can search for and silently install all available products using the Installation Manager.

Follow these steps to find and install all available products 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:
    • For Windows: imcl.exe -acceptLicense -installAll
    • For other platforms: ./imcl -acceptLicense -installAll
All connected repositories are searched, and all available products that are found are installed.
Silently installing updates to all installed products using Installation Manager

You can use Installation Manager to silently search for and install updates for all currently installed products.

Follow these steps to find and install all available updates for products that are installed:
  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:
    • For Windows: imcl.exe -acceptLicense -updateAll
    • For other platforms: ./imcl -acceptLicense -updateAll
All available product updates that are known to Installation Manager are installed.
Silently installing from authenticated repositories with Installation Manager

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

Installation Manager uses the Eclipse infrastructure (www.eclipse.org) 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 available from www.eclipse.org.

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

  1. Start Installation Manager in the user interface (UI) mode and specify the following command-line parameters: -keyring <file> -password <password>. For example, IBMIM -keyring c:\my_directory\im.keyring
  2. When you use Installation Manager in UI mode and access a protected repository, a window opens so that 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.
  3. Use the -keyring <file> -password <password> command line parameter when starting Installation Manager in silent mode. During silent install, the credentials for the protected repository are retrieved from the key ring file specified in the command line. For example:
    1. On Windows: imcl.exe -acceptLicense input <input file path and name> -keyring <key ring file path and name> -password <password>
    2. On other platforms: ./imcl -acceptLicense input <input file path and name> -keyring <key ring file path and name> -password <password>
Silently installing the Optim components

Use Installation Manager in silent mode to install the Optim components from a command line.

  1. Copy the scripts directory of the product DVD to the computer you will use for the silent install.
  2. Edit the response file for the component you are installing. For a list of Optim component response files, see Optim silent install response files.

    To edit the response files:

    1. Enter the location of the Optim components installation repository in the installLocation attribute of the profile parameter. For example, profile id='IBM Optim Designer' installLocation='C:/IBM/InfoSphere/Optim/designer'.

      A repository location can be in a remote server, or it can be a fully qualified or relative path to a local disk, network drive, or optical media. For example: http://server1.ibm.com/optim/repo, C:\tmp\optim910\repo, ..\repo.

    2. Specify values for the keys in the response files. For a description of the Optim component response file keys, see Optim silent install response files.
  3. Edit the batch file to specify the components to install. The batch files are located in the scripts directory that contains the response files. For Windows, use SilentInstallOptim.bat. For UNIX and Linux, use silentinstalloptim.sh.
    1. To edit the batch file, remove the comment from the line that contains the response file you want to use. For Windows, remove the characters "REM" from the line. For UNIX and Linux, remove the character "#" from the line.

      For example, to use the Optim Designer response file, installDesginer.xml, remove the comment from the following line: imcl.exe -input installDesigner.xml -acceptLicense -log silentp_install_designer_log.xml.

  4. Open the command line to the directory that contains the Installation Manager install tool. For Windows, the default path is C:\Program Files\IBM\Installation Manager\eclipse\tools. For UNIX and Linux, the default path is /opt/IBM/InstallationManager/eclipse/tools.
  5. Run the batch file.
Optim silent install response files

Use the Optim silent install response files to install the Optim components silently.

The following response files are located in the scripts directory of the product DVD.

installDesginer.xml
Optim Designer response file
installDesignerOLHelp.xml
Optim Designer Online Help response file
installManager.xml
Optim Manager response file
installProxy.xml
Optim Proxy response file
installRepoManager.xml
Optim Repository Manager response file
installRepoServer.xml
Optim Repository Server response file
installRepoServices.xml
Optim Repository Services response file
installRepository.xml
Optim Repository response file
installWasce.xml
WAS-CE response file

The following keys are included in the Optim component response files:

data key='user.informixUserName[,_optional_component_name_]' value='informix'

The informix user name.

The repository requires the user name 'informix' as the database server user name. This value must not be changed.

Installers
All
Valid values
informix
Default value
informix
data key='user.createInformixUser[,_optional_component_name_]' value='false'

The create informix user name flag.

Set to true if the 'informix' user name does not exist on the Repository Server machine or false otherwise. If set to true, both user.informixPassword and user.informixConfirmPassword must be passed in. If set to false, user.informixPassword is required and user.informixConfirmPassword is ignored. If set to false, the Repository Server installer will validate the informix user name and password using PAM services on the repository machine.

Installers
Repository Server
Valid values
true or false
Default value
true (for the Repository Server installer), false otherwise
data key='user.informixPassword[,_optional_component_name_]' value='QESfYn5kMoal7aIzlmMcbQ=='

The informix user password (encrypted).

This field is only used during validation and is not stored in any file. The password is used by the informix user on the repository machine. This field is used to validate the password of the informix user. This field is only required when user.createInformixUser=true. To generate this value, run the installer in record mode or use the Installation Manager imutilsc utility.

Installers
All
Valid values
The encrypted version of any non-blank password that is valid for the operating system of the repository.
Default value
QESfYn5kMoal7aIzlmMcbQ==
data key='user.informixConfirmPassword[,_optional_component_name_]' value='QESfYn5kMoal7aIzlmMcbQ=='

The informix confirm password (encrypted).

This field is only used during validation and is not stored in any file. The password used by the informix user on the repository machine. This field is used to validate the password of the informix user. This field is only required when user.createInformixUser=true. To generate this value, run the installer in record mode or use the Installation Manager imutilsc utility.
Installers
Repository Server
Valid values
The encrypted version of any non-blank password that is valid for the repository operating system.
Default value
QESfYn5kMoal7aIzlmMcbQ==
data key='user.optimEncryptedInformixPassword[,_optional_component_name_]' value='4psqeWt0KzUWWX2cED7U4w=='

The Optim encrypted informix password (encrypted).

This value is stored as the informix password in the eclipse.ini file of Optim Proxy, Optim Repository Manager, and Optim Designer. It is also stored in the Optim Manager and Optim Interface Service WAR files. To generate this value, run the installer in record mode. You can also use the optimcmd tool, that is installed as part of the Optim Manager, to generate new password values. In addition, whenever a new password is used during a wizard mode installer, this value is stored in the following files: Windows 7 - C:\Users\All Users\IBM\Installation Manager\.settings\optim.properties, Windows XP - C:\Documents and Settings\All Users\IBM\Installation Manager\.settings\optim.properties, UNIX - ~/var/ibm/InstallationManager/.settings/optim.properties.

Installers
All
Valid values
The Optim encrypted version of any non-blank password that is valid for the repository operating system.
Default value
4psqeWt0KzUWWX2cED7U4w==
data key='user.saltEncryptedInformixPassword[,_optional_component_name_]' value='sakI0nkxk02Wk'

The salt encrypted informix password (encrypted).

A salt encrypted password is used by most Linux and UNIX system to create passwords. The Repository Server installer passes this value to the operating system when it is necessary to create the informix user on a Linux and UNIX machine. To generate this value, run the installer in record mode on a Linux or UNIX system. You can also generate a new salt encrypted password by using the perl crypt() method. For more information refer to the URL: http://www.perlscriptsjavascripts.com/tutorials/howto/encrypt_unix_passwords.html. If you are unable to generate a salt encrypted password, manually create the user in the repository operating system before installing the Repository Server component, then specify false for user.createInformixUser.

Installers
Repository Server
Valid values
The salt encrypted version of any non-blank password that is valid for the repository operating system.
Default value
sakI0nkxk02Wk
data key='user.optimUserName[,_optional_component_name_]' value='optim'

The optim user name.

The user name used by the Optim components to access the repository. The user name must exist in the operating system of the repository. The user name 'optim' is pre-defined in the repository component.

Installers
All
Valid values
Any user name that is valid for the Repository Manager operating system.
Default value
optim
data key='user.createOptimUser' value='false'

The create optim user name flag.

Set to true if the 'optim' user name does not exist on the Optim Repository Manager machine or false otherwise. If set to true, both the user.optimPassword and user.optimConfirmPassword must be passed in. If set to false, the user.optimPassword is required and the user.optimConfirmPassword is ignored. If set to false, the Repository Manager installer will validate the optim user name and password using PAM services on the Optim Repository Manager machine.

Installers
Repository Manager
Valid values
true or false
Default value
false
data key='user.optimPassword[,_optional_component_name_]' value='QESfYn5kMoal7aIzlmMcbQ=='
The confirm optim user name password (encrypted).
This field is only used during validation and is not stored in any file. The password used by the optim user on the repository machine. This field is used to validate the password of the optim user. This field is only required when user.createOptimUser=true. To generate this value, run the installer in record mode or use the Installation Manager imutilsc utility.
Installers
Repository Manager
Valid values
The encrypted version of any non-blank password that is valid for the repository operating system.
Default value
QESfYn5kMoal7aIzlmMcbQ==
data key='user.optimEncryptedOptimPassword[,_optional_component_name_]' value='4psqeWt0KzUWWX2cED7U4w=='

The Optim encrypted optim password (encrypted).

This value is stored as the optim password in the eclipse.ini file of the Optim Proxy, Optim Repository Manager, and Optim Designer. It is also stored in the Optim Manager and Optim Interface Service WAR files. To generate this value, run the installer in record mode. You can also use the optimcmd tool, that is installed as part of the Optim Manager, to generate new password values. In addition, whenever a new password is used during a wizard mode installer, this value is stored in the file: Windows 7 - C:\Users\All Users\IBM\Installation Manager\.settings\optim.properties, Windows XP - C:\Documents and Settings\All Users\IBM\Installation Manager\.settings\optim.properties, UNIX - ~/var/ibm/InstallationManager/.settings/optim.properties.

Installers
All
Valid values
The Optim encrypted version of any non-blank password that is valid for the repository operating system.
Default value
4psqeWt0KzUWWX2cED7U4w==
data key='user.saltEncryptedOptimPassword[,_optional_component_name_]' value=''

The salt encrypted optim password (encrypted).

A salt encrypted password is used by most Linux and UNIX system to create passwords. The Repository Server installer passes this value to the operating system when it is necessary to create the optim user on a Linux and UNIX machine. To generate this value, run the installer in record mode on a Linux or UNIX system. You can also generate a new salt encrypted password by using the perl crypt() method. For more information refer to the URL:http://www.perlscriptsjavascripts.com/tutorials/howto/encrypt_unix_passwords.html. If you are unable to generate a salt encrypted password, manually create the user in the repository operating system before installing the Repository Server component, then specify false for user.createInformixUser.

Installers
Repository Server
Valid values
The salt encrypted version of any non-blank password that is valid for the repository operating system.
Default value
sakI0nkxk02Wk
data key='user.informixInstallDirectory[,_optional_component_name_]' value='/opt/IBM/InfoSphere/Optim/repo/server/ids11750'

The Informix installation directory.

The fully qualified installation directory of the Informix database server. Informix is installed as part of the Repository Server component. This directory is the value "ids11750" appended to the Repository Server installation directory.

Installers
Repository Server and Repository Manager
Valid values
The fully qualified installation directory of the Informix database server.
Default value
/opt/IBM/InfoSphere/Optim/repo/server/ids11750
data key='user.installingRepository' value='false'

The installing Optim Repository flag.

When set, the Optim Repository is being installed. This informational value is generated by the installer.

Installers
Optim Repository
Valid values
true or false
Default value
false
data key='user.installingRepositoryManager' value='false'

The installing Repository Manager flag.

When set, the Repository Manager is being installed. This informational value is generated by the installer.

Installers
Repository Manager
Valid values
true or false
Default value
false
data key='user.installingRepositoryServer' value='false'

The installing Repository Server flag.

When set, the Repository Server is being installed. This informational value is generated by the installer.

Installers
Repository Server
Valid values
true or false
Default value
false
data key='user.isPAMAvailable[,_optional_component_name_]' value='false'

A flag indicating if PAM is available.

Set to true if the repository operation system contains the PAM modules.

Installers
Repository Manager and Repository Server
Valid values
true or false
Default value
false for Windows or true for Linux and UNIX
data key='user.proxyWorkDirectory[,_optional_component_name_]' value='C:\IBM\InfoSphere\Optim\data\proxywork'

The Optim Proxy work directory.

The directory used by the Optim Proxy component to store temporary run time information. This directory will be created if it does not exist. You must specify a directory that is outside of the installation directory.

Installers
Optim Proxy
Valid values
Any valid operating system directory.
Default value
Windows: C:\IBM\InfoSphere\Optim\data\proxywork, Linux and UNIX ~/IBM/InfoSphere/Optim/data/proxywork
data key='user.optimInstallDirectory[,_optional_component_name_]' value='C:\IBM\InfoSphere\Optim\rt\bin'

The IBM InfoSphere Optim installation directory.

The directory where you have installed, or plan to install, the IBM InfoSphere Optim product.
Installers
Optim Proxy
Valid values
Any valid operating system directory.
Default value
Windows: C:\IBM\InfoSphere\Optim\rt\bin, Linux and UNIX ~/IBM/InfoSphere/Optim/rt/bin
data key='user.optimDirectoryName[,_optional_component_name_]' value='PODREPO'

The private Optim directory name.

The name of the private Optim directory that is contained in the repository. You should only change this value if you plan on having multiple repositories.

Installers
Repository Manager
Valid values
The directory name must be 4 to 12 uppercase characters long and begin with the characters POD.
Default value
PODREPO
data key='user.performImport' value='true'

The perform repository import option.

When set, the installer will configure an import script that you must run after the install or update to import your data from a previous export. If this is the first time you are installing this component, set user.performImport to false and user.skipRepositoryImport to true.

Note: You must perform an export of your data prior to an update or uninstall or you will lose all of the data in the repository. You cannot perform an export during a silent uninstall or update because it requires user interaction. To perform an import, use the optimcmd tool found in the tools/optimcmd directory of the current installer. To run this installer in silent mode, set user.performImport to false and user.skipRepositoryImport to true.
Installers
Repository Server and Optim Repository
Valid values
true or false
Default value
true
data key='user.skipRepositoryImport' value='false'

The skip repository import option.

When set, the installer will configure an import script that you must run after the install or update to import your data from a previous export. If this is the first time you are installing this component, set user.performImport to false and user.skipRepositoryImport to true.

Note: You must perform an export of your data prior to an update or uninstall or you will lose all of the data in the repository. You cannot perform an export during a silent uninstall or update because it requires user interaction. To perform an import, use the optimcmd tool found in the tools/optimcmd directory of the current installer. To run this installer in silent mode, set user.performImport to false and user.skipRepositoryImport to true.
Installers
Repository Server and Optim Repository
Valid values
true or false
Default value
false
data key='user.performExport' value='true'

The perform export option.

When set, an export of the repository database files will occur.

Note: You must perform an export of your data prior to an update or uninstall or you will lose all of the data in the repository. You cannot perform an export during a silent uninstall or update because it requires user interaction. To perform an export, use the installer in Wizard mode or the optimcmd tool found in the tools/optimcmd directory of the current installer. To run this installer in silent mode, and bypass exporting your data, set user.performExport to false and user.skipRepositoryExport to true.
Installers
Repository Server and Optim Repository
Valid values
true or false
Default value
true
data key='user.skipRepositoryExport' value='false'

The skip export option.

When set, an export of the repository database files will not occur.

Note: You must perform an export of your data prior to an update or uninstall or you will lose all of the data in the repository. You cannot perform an export during a silent uninstall or update because it requires user interaction. To perform an export, use the installer in wizard mode or the optimcmd tool found in the tools/optimcmd directory of the current installer. To run this installer in silent mode, and bypass exporting your data, set user.performExport to false and user.skipRepositoryExport to true.
Installers
Repository Server and Optim Repository
Valid values
true or false
Default value
false
data key='user.repositoryExportDirectory' value='C:\IBM\InfoSphere\Optim\data'

The repository export directory.

The directory used by the repository or Optim Server components to store exported repository data. This directory must exist. When doing an import, the export files must exist. When doing an export, any existing export files will be deleted. You must specify a directory that is outside of the installation directory.

Installers
Repository Server and Optim Repository
Valid values
Any valid operating system directory.
Default value
Windows: C:\IBM\InfoSphere\Optim\data, UNIX and Linux: ~/IBM/InfoSphere/Optim/data
data key='user.repositoryDirectory[,_optional_component_name_]' value='/opt/IBM/InfoSphere/Optim'

The repository database directory.

The directory used by the Optim Repository Server component to store the repository database. The directory will be created if it does not exist. When doing an install, any existing files will be deleted. You must specify a directory that is outside of the installation directory.

Note: The directory "optimrepo" is appended to the specified directory.
Installers
Repository Server
Valid values
Any valid operating system directory.
Default value
/opt/IBM/InfoSphere/Optim
data key='user.repositoryServerInstalled' value='false'

The Repository Server installation complete flag.

When set, the Repository Server has been installed. This informational value is generated by the installer.

Installers
Repository Server
Valid values
true or false
Default value
false
data key='user.repositoryServerInstalled' value='false'

The Repository Server install directory.

This value is used by the Repository Manager installer to 'source' the Informix environment variables prior to starting the Repository Manager.

Installers
Repository Server and Repository Manager
Valid values
A valid Linux or UNIX path to the Repository Server installation location.
Default value
/opt/IBM/InfoSphere/Optim/repo/server
data key='user.repositoryHostName[,_optional_component_name_]' value='optimrepository'

The repository host name.

The machine host name or IP address of the repository machine. This value should NOT be set to localhost.

Installers
All
Valid values
A valid machine host name or IP address. localhost is not valid.
Default value
optimrepository
data key='user.repositoryPortNumber[,_optional_component_name_]' value='9088'

The repository port number.

The TCP port number used by the Repository Server. When this variable is provided for the Repository Server installer, the value must not be in use or reserved by the operating system. The default value is typically reserved on the operating system file /etc/services. You must manually remove the selected port number entry from the file before installing the Repository Server. When this variable is provided for any Optim client or server installer, you must manually add the following entry optimrepo 9088/tcp to the operating system 'services' file. This file can be found in the following locations: Windows - C:\WINDOWS\system32\drivers\etc\services, UNIX/Linux - /etc/services.

Installers
All
Valid values
A port number must be between 1 and 65534. Values under 1024 are not recommended.
Default value
9088
data key='user.repositoryServerName[,_optional_component_name_]' value='optimrepo'

The Repository Server name.

This value must not be changed.

Installers
All
Valid values
optimrepo
Default value
optimrepo
data key='user.repositoryServiceName[,_optional_component_name_]' value='optimrepo'

The repository service name.

This value must not be changed.

Installers
All
Valid values
optimrepo
Default value
optimrepo
data key='user.repositoryManagerPortNumber[,_optional_component_name_]' value='8088'

The repository port number.

The TCP port number used by the Repository Manager. When this variable is provided for the Repository Manager installer, the value must not be in use or reserved by the operating system. The default value is typically reserved on the operating system file /etc/services. You must manually remove the selected port number from the file before installing the Repository Manager.

Installers
All
Valid values
A port number must be between 1 and 65534. Values under 1024 are not recommended.
Default value
8088
data key='user.repositoryManagerURL' value='http://Repository_Host:Repository_Manager_Port/status/init/'

The Repository Manager URL.

This URL is dynamically built by the installer to validate that the repository manager is running. It is for informational purposes only.

Installers
All
Valid values
http://Repository_Host:Repository_Manager_Port/status/init/
Default value
http://optimrepository:8088/status/init/
data key='user.runClientValidation[,_optional_component_name_]' value='true'

The client validation flag.

A value of true will validate all of the values provided for an installer. To ensure that the components are configured correctly, always specify a value of true.

Installers
Optim Designer, Optim Manager, Optim Proxy, Optim Repository, and Optim Repository Services
Valid values
true or false
Default value
true
data key='user.runServerValidation[,_optional_component_name_]' value='true'

The server validation flag.

A value of true will validate all of the values provided for an installer. To ensure that the components are configured correctly, always specify a value of true.

Installers
Optim Repository, Repository Manager, and Repository Server
Valid values
true or false
Default value
true
data key='user.skipRepositoryValidation' value='false'

The client repository validation flag.

A value of true will validate all of the values provided for an installer against an active repository. To ensure that the components are configured correctly, always specify a value of false.

Installers
Optim Designer, Optim Manager, Optim Proxy, Optim Repository, and Optim Repository Services
Valid values
true or false
Default value
false
Silently uninstalling Installation Manager

Use the uninstall script to silently uninstall Installation Manager.

The uninstall script is stored in the Installation Manager uninstall directory. Follow these steps to silently uninstall Installation Manager:
  1. On a command line, change to the uninstall directory for the Installation Manager.
    • For Windows, the default location for non-administrator is: C:\Documents and Settings\All Users\Application Data\IBM\Installation Manager\uninstall.
    • For Windows, the default location for administrator is: C:\Documents and Settings\<user id>\Application Data\IBM\Installation Manager\uninstall.
    • For other platforms, the default location for non-administrator is: <userhomedirectory>/var/ibm/InstallationManager/uninstall
    • For other platforms, the default location for administrator is: /var/ibm/InstallationManager/uninstall
  2. Enter the following command:
    • On Windows as administrator: uninstallc.exe
    • On Windows as non-administrator:userinstc.exe
    • On other platforms, enter: ./uninstallc
Response files

A response file is an XML file that contains the data needed to perform installation operations in silent mode.

Response files are used by both Installation Manager and the Installation Manager installer to perform installation operations silently. You can record a response file by recording preferences and installation actions in Installation Manager in user interface mode, or you can create one manually using the documented list of response file commands and preferences.

A response file is an XML file that contains data read by Installation Manager in silent mode. Using a response file, you can perform almost any action that you can perform using Installation Manager in wizard mode. For example, with a response file you can specify the location of the repository that contains the packages, which package to install, and which features to install for that package. You can also use a response file to modify your installed package, to apply updates, and to apply a license.Sample response file: Installing Installation Manager and packages

Recording a response file with Installation Manager

You can create a response file by recording your actions in Installation Manager. When you record a response file, all of the selections that you make in Installation Manager are stored in an XML file. When you run Installation Manager in silent mode, Installation Manager uses the data in the XML response file to perform the installation.

When you are recording a response file, you can choose to perform the actions, for example installing a package, or you can choose to just record a response file without performing the actions. Note that when you are recording a response file, preferences that you set, including repository settings, are not stored. Follow these steps to record a response file:
  1. On a command line, change to the eclipse subdirectory in the directory where you installed Installation Manager. For example:
    • For Windows: cd C:\Program Files\IBM\Installation Manager\eclipse
    • For other platforms: cd /opt/IBM/InstallationManager/eclipse
  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:
    • For Windows: IBMIM –record <response file and path name> -log <log file and path name>. For example, IBMIM.exe -record c:\mylog\responsefile.xml -log c:\mylog\record_log.xml
      Note: Ensure the file paths you enter exist; Installation Manager will not create directories for the response file and the log file.
    • For other platforms: IBMIM –record <response file and path name> -log <log file and path name>.
    • You can record a response file without performing any wizard actions by adding the optional -skipInstall <agentDataLocation> argument. Note that <agentDataLocation> must be a writable directory.

      For Windows: IBMIM -record <response file and path name> -skipInstall <a writable directory for agent data location>. For example IBMIM -record c:\mylog\responsefile.xml -skipInstall c:\temp\recordData

      When you add this argument:
      1. The packages are not installed or uninstalled. The artifacts are not downloaded and the actions are not be executed.
      2. Installation Manager saves the data to the location that you specified.
      3. Recording the response file is faster, because the Installation Manager is not performing actions, it is just recording the data.

      You can use the same <agentDataLocation> in the next recording session to record license management, updates, or modifications to the product. These changes will be added to the agent data location.

  3. Follow the on-screen instructions in the appropriate wizard. If you copied the repository to a new location, you can set the location of the repository using the File > Preferences > Repository Location dialog.
  4. Click Finish, then close Installation Manager.
An XML response file is created and saved in the location that you specified in the command.
Creating a response file manually

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 also create or edit a response file manually.

There are two categories of commands for the response file:
  • Preference commands are used to set preferences for Installation Manager that you set from the File > Preferences menu, such as repository location information.
  • Wizard commands are used to emulate the install, update, modify, and uninstall wizards in Installation Manager.
Response file commands

You can use this reference table to learn more about response file commands.

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>
A profile is an installation location. 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 install will also create two installation contexts; one for Eclipse and one for native.

You can use the <data> element to set profile properties.

The following list contains the 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 language codes. Not every language is supported in every product:
  • 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)
  • Brazilian Portuguese (pt_BR)

Repositories

<server>
<repository location="http://example/
repository/">
<repository location=”file:/C:/
repository/”>
<!—add more repositories below-->
<…>
      </server>
Use this command to specify the repositories that are used during a silent installation. Use a URL or UNC path to specify remote repositories; or 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.

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

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 set to "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.

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 that 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 of 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. In addition, if there are no feature IDs specified, then all of the features in the specified offering will be uninstalled; if there are no offering IDs specified, then all of 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 that is 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”/> 
If your product package requires an installed license, use this command to generate a response file that contains 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 that you set will be recorded in a license policy file named “license.opt” in the same directory as the generated response file and 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, the clean attribute is set to 'false'. Installation Manager will use the repository and other preferences that are specified in the response file as well as the existing preferences that are set in the Installation Manager. If a preference is specified in the response file and set in the Installation Manager, the preference that is specified in the response file takes precedence.

If the clean attribute is set to 'true', Installation Manager will use the repository and other preferences that are specified in the response file and the existing preferences that are set in the Installation Manager will not be used.

Temporary

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

By default, the temporary attribute is set to 'false' and the preferences that are set in your response file will be persisted. When you set the temporary attribute to 'true', the preferences that are 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 that is specified in the response file will override the preferences that were 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 that 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 rebootLater is set to 'true', the system will not reboot.

Silent installation preference commands

Although 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
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. Not required for products that do not require an installed license.
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. An FTP proxy is an application-level gateway for FTP. An FTP proxy securely forwards command and data streams between a client and server. This forwarding function is useful to firewalls and FTP masquerades. An FTP proxy also can fix connections to the FTP server and helps provide 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 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 this preference is set to 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 this preference is set to True, the files that are required to roll the package back to a previous version are stored on your system. When this preference is set to 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 specify whether users can make changes to the repositories after the product is installed.
com.ibm.cic.common.core.preferences.directArtifactAccessMode True or False The default is False. Before Installation Manager begins the installation process, all required installation files are downloaded to the shared repository location. When this preference is set to True, Installation Manager accesses the installation files directly from the input repositories during the installation process instead of first downloading and verifying them.
com.ibm.cic.common.core.preferences.searchForUpdates True or False The default is False. When this preference is set to True, Installation Manager searches for updates to itself before performing the silent installation.
Sample response files

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 software packages silently and to standardize the locations and preferences for the packages.

It can be helpful to record a response file and then tailor the contents to suit your needs. See Recording a response file with Installation Manager for more information on recording a response file.

Sample response files for each Optim package are included in the scripts subdirectory of the package installation directories.

Sample response files are also included on the installation disc, in the scripts directory.

Sample response file: Installing Installation Manager and packages

This is a sample response file for installing Installation Manager and a package at the same time.

Sample response file for installing Installation Manager and a software package
<agent-input clean="true" temporary="true">

<!-- add preferences -->
<preference name="com.ibm.cic.common.core.preferences.http.proxyEnabled" 
value="false"/>

<!-- create the profile if it doesn't exist yet -->
<profile id="IBM Software Delivery Platform" installLocation="c:/temp/my_profile"></profile>

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

<!-- add the offerings and features to install. You can install Installation Manager and packages in one response file -->
<install>
<offering id="com.ibm.cic.agent" version="1.3.0.20090114_0637" />
<offering features="com.ibm.rad.sdpcore,com.ibm.rad.jre,com.ibm.rad.webtools_core,com.ibm.rad.pde,com.ibm.rad.data_tools" profile="IBMSoftware Delivery Platform" id="com.ibm.rational.application.developer" version="7006_20080320_1728"/>
</install>

</agent-input>
Sample response file: Installing a package

This is a sample response file for installing a software package.

Sample response file for a software package
<agent-input>

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

<!-- use default installation location and choose the latest version of the offering that is available in the repository -->
<install>
	<offering  features= "core" id= "ies">
	</offering>
</install>

</agent-input>
Running Installation Manager with a response file in wizard mode

You can install, update, modify, or uninstall software packages with Installation Manager in wizard mode, using a response file.

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:

  • server, preference, and install commands
  • server, preference, and update commands
  • server, preference, and modify commands
  • server, preference, and uninstall commands
Export data for problem analysis

You can generate a .zip file that contains data for problem analysis. This file is used by IBM Support to help troubleshoot the problem.

  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:
    • For Windows: imutilsc exportInstallData <outputFileName>. Where <outputFileName> is the name of the file to be generated that contains the exported data in .zip file format.
    • For other platforms: ./imutilsc exportInstallData <outputFileName>. Where <outputFileName> is the name of the file to be generated that contains the exported data in .zip file format.
A .zip file that contains the installation data is created.
Using the Installation Manager installer to perform other operations

If you cannot install Installation Manager, the Installation Manager installer can optionally be used to perform other silent installation operations.

Installing all available products using the Installation Manager installer

You can search for and silently install all available products using the Installation Manager installer.

Follow these steps to find and install all available products using Installation Manager installer:
  1. Switch to the InstallerImage_platform subdirectory.
  2. Enter and run the following command:
    • For Windows as admin: installc.exe -acceptLicense -installAll
    • For Windows as non-admin: userinstc.exe -acceptLicense -installAll
    • For other platforms: ./installc -acceptLicense -installAll
All available products found searching the connected repositories are installed.
Silently installing updates to all products using the Installation Manager installer

You can silently search for and install updates for all installed products with the Installation Manager installer.

Follow these steps to find and install all available updates for products that are installed.
  1. Switch to the InstallerImage_platform subdirectory.
  2. Select, enter and run the appropriate command:
    • For Windows as admin: installc.exe -acceptLicense -updateAll
    • For Windows as non-admin: userinstc.exe -acceptLicense -updateAll
    • For other platforms: ./installc -acceptLicense -updateAll
All available product updates known to Installation Manager are installed.
Silently installing from authenticated repositories using the Installation Manager installer

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

You must have Installation Manager installed to install a software package from an authenticated repository.
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 available from www.eclipse.org.

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

  1. Start Installation Manager in user interface mode and specify the following command-line parameters: -keyring <file> [-password <password>]. For example, installc -keyring c:\my_directory\im.keyring
  2. When you use Installation Manager in wizard mode and access a protected repository, a window opens where you can enter your 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.
  3. From the eclipse directory in the location you installed 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.
  4. On a command line, enter the appropriate command:
    • On Windows as admininstallc.exe -acceptLicense input <input file path and name> -keyring <key ring file path and name> -password <password>
    • On Windows as non-adminuserinstc.exe -acceptLicense input <input file path and name> -keyring <key ring file path and name> -password <password>
    • On other platforms, use ./installc -acceptLicense input <input file path and name> -keyring <key ring file path and name> -password <password>

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.5.0 at http://pic.dhe.ibm.com/infocenter/install/v1r5/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.
Verify your installation and ensure that you can start your product. For information about starting the Optim components, refer to the Configuring Optim Solution Components document.

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:
  • Close all programs that were installed using Installation Manager before updating.
  • During the update process, Installation Manager might prompt you for the location of the repository for the base version of the package. If you installed the product from DVDs or other media, they must be available when you use the update feature.
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 was 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:
  • To uninstall Installation Manager from Windows, complete the following steps: :
    1. Click Start > Control Panel.
    2. In the Control Panel window, click Add or Remove Programs.
    3. In the Add or Remove Programs window, select IBM Installation Manager and click Remove.
    4. In the Add or Remove Programs dialog box, click Yes to continue with the removal.
  • To uninstall Installation Manager from Linux or Unix, complete the following steps:
    1. Click the Uninstall IBM Installation Manager icon on your desktop.

      If the icon is not present, open a terminal window and run the uninstall command from the uninstall directory in the Installation Manager installation directory.

    2. In the IBM Installation Manager Uninstall Packages wizard, click Next; then click Uninstall.

Uninstall a package silently by using a response file

Use a response file to uninstall a package.

To uninstall a package in silent mode:

  1. Open a command-line utility.
  2. Open the tools directory located in the eclipse directory of the Installation Manager installation directory.
  3. Run the command:
    • Windows: imcl.exe input response_file -log log_file
    • Linux, and UNIX: ./imcl input response_file -log log_file
When the uninstall is complete, a status of 0 is returned. If the uninstall cannot be completed, a non-zero number is returned in a log file.
The default locations for the Installation Manager log file are
  • For Windows as non-admin: C:\Documents and Settings\<my id>\Application Data\IBM\Installation Manager\logs
  • For Windows as admin: C:\Documents and Settings\All Users\Application Data\IBM\Installation Manager\logs
  • For other platforms: /var/ibm/InstallationManager/logs
Table 3. Uninstall commands by operating system
Operating system Command
Windows imcl.exe input c:\response_files\uninstall.xml -log c:\mylog\uninstall_log.xml -acceptLicense
Linux and UNIX ./imcl input /response_files/uninstall.xml -log /mylog/uninstall_log.xml -acceptLicense

Enclose file paths that include spaces with double quotation marks.

Using the installer to install IBM InfoSphere Optim

Use the installer to install IBM InfoSphere Optim on supported Windows, Linux, and UNIX platforms.

Installation Phase

The installation process unloads Optim from the installation DVD to the target workstation and additional workstations or servers.

You begin the installation phase by using the program to load the application software at the first workstation. You must enter your company name and the identification number indicated in the email sent when Optim is shipped to you. You must also designate a destination directory for the application software.

Workstations or File Server

You can install Optim on individual workstations or on a file server for multiple users to share.

Note: Installing Optim on a file server is different from installing the optional Server. Sites that consider installing Optim on a file server would generally tend to be unconcerned with the volume of network traffic and, therefore, may not derive any benefit from remote processing on the Server.

Your decision to install Optim on individual workstations or on a file server does not affect licensing requirements, but there are considerations for either method. The advantages of installing on individual workstations include:

  • Improved performance (the executables are not loaded across a network).
  • Users are not affected by an upgrade made on the file server.
  • Old images are not in use while installing, configuring, or upgrading the software.

In contrast, a single installation on a file server offers the following advantage:

  • Ease of administration, both at installation and when applying maintenance or upgrades.

Regardless of your choice, you should install and configure each additional workstation to create desktop shortcuts and create necessary Windows registry entries.

Installing Optim on a Windows platform

Installing Optim takes only a few minutes. You can install Optim using the installer wizard, console install, or a silent install. When installation completes, use the Configuration program to prepare your workstations to use Optim.

Installing from the installer wizard

You can install IBM InfoSphere Optim using the installer wizard.

  1. Insert the product launchpad DVD into your DVD drive. You can run the installer wizard from the launchpad or manually.

    To run the installer from the launchpad:

    1. If autorun is enabled on your computer, the launchpad automatically opens. (If autorun is not enabled on your computer, start the launchpad manually by running launchpad.exe, which is located in the root directory of the DVD.)
    2. Click Install IBM InfoSphere Optim. The installer Introduction page opens.

    To run the installer manually:

    1. Run IBMOptim.exe, which is located in the distributed\RTWin directory of the DVD. The installer Introduction page opens.

  2. Click Next. The Software License Agreement page opens.
  3. Read and accept the license agreement. Click Next. The Customer Information page opens.
  4. Complete the customer information, using the company name and ID provided by IBM. Click Next. The Type of Installation page opens.
  5. Select an installation option and specify whether the workstation will share user information in the same registry or use a separate registry for each user. Click Next. The Install Location page opens.
  6. Accept the default installation directory or enter the path to a different directory. Click Next.

    If you selected the custom installation option, the Select Components page opens.

    If you selected the full installation option, the Configure Open Data Manager Now? page opens.

  7. If you selected the custom installation option, select the components to install. Click Next.

    If you selected to install Open Data Manager (ODM), the Configure Open Data Manager Now? page opens.

    If you did not select to install ODM, the Shortcut Location page opens.

  8. If you selected to install ODM or perform a full installation, do the following.
    1. On the Configure Open Data Manager Now? page, specify whether to install ODM as part of the Optim installation process or copy the files and install ODM at a later time. Click Next.

      If you selected to install ODM as part of the Optim installation process, the Open Data Manager (ODM) License Information page opens.

      If you selected to install ODM at a later time, the Shortcut Location page opens.

    2. On Open Data Manager (ODM) License Information page, specify the location of your ODM license file or choose a trial license. Click Next. The Shortcut Location page opens.
  9. On the Shortcut Location page, select a location for the component shortcuts. Click Next. The Summary page opens.
  10. Review the installation options. Click Install to start the installation process. The Installing IBM Optim page opens.
  11. When the installation process is complete, the Installation Complete page opens. You can select options to view the Release Notes® and launch the configuration program. Click Done to close the installer wizard.

Installing from the console

In a Windows environment, you can install Optim from the console.

  1. Open the console to the distributed\RTWin directory of the product DVD.
  2. From the prompt, type IBMOptim.exe -i console to begin the installer extract process, which takes approximately 2 - 3 minutes. When the extract process completes, the Introduction screen opens.
  3. Press Enter. The Software License Agreement screen opens.
  4. Press 1 to accept the Software License Agreement. The Customer Information screen opens.
  5. Type the User Name, Company Name, and Company ID. Press Enter. The Customer Input screen opens.
  6. Enter the input option. The Choose Installation Set screen opens.
  7. Select an installation option:
    • 1 - Full installation, which is the default.
    • 2 - Customized installation, which allows you to select Optim features manually.
    • 3 - Installation of registry entries and shortcuts, which is intended for installations where Optim is already installed on a network and you want to access it from your workstation.

    If you select options 1 or 2, the Install Location screen opens. Accept the default install location or type the path name to the location you choose and press Enter.

    If you select option 3, the Specify Network Location screen opens. Accept the default install location or type the path name to the install location and press Enter.

  8. If you selected the customized installation option, the Component Selection screen opens. Type a list of features to install, separated by commas, and press Enter.
  9. If you selected the full installation option or if you selected to install the Optim ODM Interface, the next screen to display depends on whether Open Data Manager (ODM) is currently installed.

    If ODM is installed, the Configure Open Data Manager Now screen opens. Type 1 to configure ODM or 2 to copy the ODM files for installation later and press Enter.

    If ODM is not installed, the Install and Configure Open Data Manager Now screen opens. Type 1 to install and configure ODM or 2 to copy the ODM files for installation later and press Enter.
    • If you select option 1 to install and configure ODM, the Open Data Manager (ODM) License Information screen opens. Type 1 to specify your ODM license file or 2 to use a 30-day trial license and press Enter.
    • If you choose to specify the ODM license file, the Specify ODM License File screen opens. Type the fully-qualified path for the ODM license file and press Enter.
  10. The Choose Shortcut Folder screen opens. Specify where to locate the component shortcuts.
    • If you select option 1 to create shortcuts in the program group, the Input Program Folder Name screen opens. Type the name of the program group folder in which the shortcut icons will be created. Optim will create the program group folder if it does not exist.
    The Pre-Installation Summary screen opens.
  11. Review the settings for the installation. Press Enter to begin the installation.
    • To modify any of the settings, type BACK at the prompt PRESS <ENTER> TO CONTINUE: to display previous installation screens and make changes.
    The Installing... screen displays a progress bar as the installer copies the files.
  12. The Installation Complete screen opens when then install is complete. When the installation completes, you can choose to view the Release Notes and launch the configuration program.

Installing from the silent installer

In a Windows environment, you can install Optim using the silent installer.

The Optim installation includes the optim_installer.properties file located in the distributed\RTWin directory of the product DVD. To use the silent installer, open the optim_installer.properties file and make any modifications to the variables to customize it for your installation. You can modify the following variables:

INSTALLER_UI=SILENT
Install using silent installer.
LICENSE_ACCEPTED=
Set this variable to TRUE to specify that the license agreement is accepted.
CUSTOMER_INFO_USERNAME=username
Customer user name.
CUSTOMER_INFO_COMPANYNAME=companyname
Customer company name.
CUSTOMER_INFO_COMPANYID=companyid
Customer company ID number.
CHOSEN_INSTALL_FEATURE_LIST=
List of Optim features to be installed. Specify values in a list separated by commas. Values are:
Optim
Optim Online Documentation
Optim Archive ODBC Interface
Optim ODM Interface
Sample Files
5.x PST Directory Conversion Files
For example:
CHOSEN_INSTALL_FEATURE_LIST=Optim,Optim Online Documentation,Optim Archive ODBC Interface,
Optim ODM Interface,Sample Files,5.x PST Directory Conversion Files
INSTALL_APP_FOR_ALLUSER=
Specify whether to install Optim for all users or for the current user only. To install Optim for all users, specify:
INSTALL_APP_FOR_ALLUSER=1
To install Optim for the current user only, specify:
INSTALL_APP_FOR_ALLUSER=0
USER_INSTALL_DIR =
The folder where Optim is to be installed.
USER_INSTALL_DIR=C:\\Program Files\\IBM Optim
USER_INPUT_ODM_INSTALL=
USER_INPUT_ODM_COPYONLY=
Use these variables only if you included Optim ODM Interface in the CHOSEN_INSTALL_FEATURE_LIST=. Otherwise, remove these variables from the file. Specifies whether to install and configure ODM now.
To install and configure ODM now, specify:
USER_INPUT_ODM_INSTALL=1
USER_INPUT_ODM_COPYONLY=0
To copy ODM files for later installation, specify:
USER_INPUT_ODM_INSTALL=0
USER_INPUT_ODM_COPYONLY=1
USER_INPUT_ODM_ENABLE_TRIAL=
USER_INPUT_ODM_SPECIFY_LICENSE=
Use these variables only if :
you included Optim ODM Interface in the CHOSEN_INSTALL_FEATURE_LIST=
AND
you specified USER_INPUT_ODM_INSTALL=1 to install and configure ODM now.
Otherwise, remove these variables from the file. Specifies the type of license for ODM.
To specify the ODM license file:
USER_INPUT_ODM_ENABLE_TRIAL=0
USER_INPUT_ODM_SPECIFY_LICENSE=1
To enable a 30-day trial license for ODM:
USER_INPUT_ODM_ENABLE_TRIAL=1
USER_INPUT_ODM_SPECIFY_LICENSE=0
USER_SHORTCUT_NEW_PRG_MENU=
Create shortcut icons in a new program group. Specify:
USER_SHORTCUT_NEW_PRG_MENU=1
Use either USER_SHORTCUT_NEW_PRG_MENU= or USER_SHORTCUT_EXST_PRG_MENU=, do not specify both.
USER_SHORTCUT_EXST_PRG_MENU=
Create shortcut icons in an existing program group. Specify:
USER_SHORTCUT_EXST_PRG_MENU=1
Use either USER_SHORTCUT_NEW_PRG_MENU= or USER_SHORTCUT_EXST_PRG_MENU=, do not specify both.
USER_SHORTCUTS=
Fully-qualified path for the directory in which to create shortcut icons. Specify:
USER_SHORTCUTS=C:\Documents and Settings\All Users\StartMenu\Programs\IBM Optim
Specify USER_SHORTCUTS= if you used either USER_SHORTCUT_NEW_PRG_MENU= or USER_SHORTCUT_EXST_PRG_MENU=.
USER_SHORTCUT_DESKTOP=
Create shortcut icons on the desktop. Specify:
USER_SHORTCUT_DESKTOP=1
USER_SHORTCUT_QCK_LAUNCH_BAR=
Create shortcut icons on the quick launch bar. Specify:
USER_SHORTCUT_QCK_LAUNCH_BAR=1
USER_SHORTCUT_START_MENU=
Create shortcut icons in the Windows Start menu. Specify:
USER_SHORTCUT_START_MENU=1
USER_INPUT_VIEW_REL_NOTES=
Display Release Notes when installation completes.
To display Release Notes:
USER_INPUT_VIEW_REL_NOTES=1
USER_INPUT_LAUNCH_CONFIG=
Launch Optim Configuration when installation completes.
To launch Optim Configuration:
USER_INPUT_LAUNCH_CONFIG=1

After you specify the variables in the optim_installer.properties file, use one of these commands to start the silent installer.

If the optim_installer.properties file is under the same directory as the IBMOptim.exe file, the file is renamed to installer.properties. Use this command:
IBMOptim.exe –i silent
If the optim_installer.properties file is in a directory different from that for the IBMOptim.exe file, use the command:
IBMOptim.exe -f directorypath\optim_installer.properties

where directorypath is the fully-qualified path to the directory for the optim_installer.properties file.

Configuration Overview

The first step in the Configuration process is to sign a valid exit (i.e., the Optim default exit or a user-supplied exit). You can then use the Configuration program to create the Optim Directory, establish connectivity to databases for Optim, and perform other maintenance tasks.

Use the Configuration program for the following tasks:

  • Configuring the First Workstation, which includes creating the Optim Directory and associated DB Aliases, configuring options, and exporting registry data.
  • Configuring Additional Workstations, which includes importing registry data, creating a registry entry, and specifying a Product Configuration File.
  • Configuring the Optim Server.
  • Using other commands available from the Tasks menu.
  • Initializing and enabling Optim Security, which includes Archive File Security, Functional Security, and Object Security.

Installing Optim on a Linux or UNIX platform

The installation process for Optim on a Linux or UNIX platform differs depending on your environment. Linux and UNIX platforms only support an Optim Server installation.

You can use the Sun Solaris operating environment under SPARC; the Hewlett-Packard HP-UX operating environment; the IBM AIX® operating environment; or the Red Hat Application Server. Note that an Optim Server installed in a UNIX environment cannot access an Optim Directory in an SQL Server database. Configuration files, included with the installation, must be modified to adapt the Server to the requirements of your environment.

After completing the installation and configuration, processing initiated on a Windows workstation can be directed to the Server. Additionally, processing can be initiated from a console using a Command Line Interface.

Note: Red Hat Linux 3 uses separate installers. For this platform, refer to Installing an Optim on Red Hat Linux 3.

Installing from the installer wizard

You can install Optim using the installer wizard.

  • You may need to give executable permission to install.bin, which is located in the distributed/platform_type directory of the product launchpad DVD (for example distributed/RTAIX).
  • Clear the following directories if they exist:/tmp/softech and absoluteInstallLocation/rt/bin/etc/*
  • Create /tmp/softech if it does not exist
  1. Insert the product launchpad DVD into your DVD drive. You can run the installer wizard from the launchpad or manually.

    To run the installer from the launchpad:

    1. If autorun is enabled on your computer, the launchpad automatically opens. (If autorun is not enabled on your computer, start the launchpad manually by running launchpad.sh, which is located in the root directory of the DVD.)
    2. Click Install IBM InfoSphere Optim and select the platform you are using. The installer Introduction page opens.

    To run the installer manually:

    1. Run install.bin, which is located in the distributed/platform_type directory of the DVD.

      To use a console to open the installer, open the console to the distributed/platform_type directory of the product DVD, and type ./install.bin.

      The installer Introduction page opens.
  2. Click Next. The Welcome page opens.
  3. Click Next. The Software License Agreement page opens.
  4. Read and accept the license agreement. Click Next. The Choose Destination Location page opens.
  5. Accept the default installation directory or enter the path to a different directory. Click Next. The Shutdown Information page opens.
  6. Follow instructions about stopping Optim Servers that are running. Click Next. The Type of Installation page opens.
  7. Select a type of installation. Click Next.

    If you selected the custom installation option, the Component Selection page opens.

    If you selected the full installation option, the ODM Installation Information page opens.

  8. If you selected the custom installation option, select the components to install on the Component Selection page. Click Next.

    If you selected to install Open Data Manager (ODM), the ODM Installation Information page opens.

    If you did not select to install ODM, the Summary page opens.

  9. If you selected to install ODM or perform a full installation, use the ODM Installation Information page to specify whether to install ODM as part of the Optim installation process or copy the files and install ODM at a later time. Click Next.

    If you selected Install and Configure ODM Now, the Open Data Manager (ODM) License Information page opens.

    If you selected Only Copy the ODM Files, the Summary page opens.

  10. If you selected Install and Configure ODM Now, select a license option on the Open Data Manager (ODM) License Information page. If you choose to specify a license file, enter the location of the license file. Click Next. The Summary page opens.
  11. On the Summary page, review the installation summary.
  12. Click Install to begin the installation process. The Installing page opens and displays the progress of the installation.
  13. After the installation process completes, the post-installation pages open. Use these pages to do the following:
    1. Read about the rtedit command file.
    2. Read about additional files that you must modify before starting the Optim Server.
    3. Select files to open in an editor. You can also edit the files after closing the installer wizard.
    4. Sign the default Optim exit. You can also sign the exit after closing the installer wizard.
    5. View the release notes.
  14. After viewing the post-installation pages, click Done to close the installer wizard.

Installing from the console installer

In a UNIX or Linux environment, you can run the installer from the console to install Optim server. The information in this section applies to all UNIX or Linux platforms except Red Hat Linux 3 .

The following commands are available during the console installation process:
back
Return to a previous screen.
quit
Cancel the installation.
  1. Open a console to the distributed/platform_type directory of the product DVD (for example distributed/RTAIX).
  2. Enter the following command: ./install.bin -i console. The console installation process begins and the Introduction screen opens.
  3. Press Enter. The Welcome screen opens.
  4. Press Enter. The Software License Agreement screen opens.
  5. Press 1 to accept the agreement. The Install Location screen opens.
  6. Enter a directory where the Optim server will be installed. You can accept the default or enter the path to another directory. Press Enter. The Shutdown Information screen opens.
  7. Follow instructions about stopping Optim Servers that are running. Press Enter. The Choose Install Set screen opens.
  8. Select an installation option:
    • 1 - Full installation. This option installs all components of Optim: Optim Server Executable Files, Sample Files, and the Open Data Manager (ODM) Interface. You continue with the ODM Installation Information screen.
    • 2 - Customized installation. This option allows you to select the components of Optim to install. You continue with the Choose Product Features screen.
  9. If you select the customized installation option, the Choose Product Features screen opens. Type a list of features to install, separated by commas, and press Enter.
  10. If you selected the full installation option or if you selected to install the Optim ODM Interface, the Install and Configure Open Data Manager Now? screen opens. Specify whether to install ODM as part of the Optim installation process or copy the files and install ODM at a later time.

    If you select Install and Configure ODM Now, the Open Data Manager (ODM) License Information page opens.

    If you select Only Copy the ODM Files, the Pre-Installation Summary page opens.

  11. If you selected Install and Configure ODM Now, select a license option on the Open Data Manager (ODM) License Information page. Press Enter.

    If you choose to specify a license file, the Specify ODM File page opens. Type the location of the license file and press Enter.

    The Pre-Installation Summary screen opens.
  12. On the Pre-Installation Summary screen, review the settings for the installation. Press Enter to begin the installation. The Installing... screen displays a progress bar as the installer copies the files.
  13. After the installation process completes, the post-installation pages open. Use these pages to do the following:
    1. Read about the rtedit command file.
    2. View the results of the ODM installation.
    3. Read about additional files that you must modify before starting the Optim Server.
    4. Sign the default Optim exit. You can also sign the exit after closing the installer wizard.
    5. View the release notes.
  14. After viewing the post-installation pages, press Enter to exit the installer.

Installing from the silent installer

You can use the silent installer in supported UNIX and Linux platforms to install the Optim Server.

The Optim installation includes the optim.installer.properties file in the distributed/platform_type directory of the product DVD (for example distributed/RTAIX). To use the silent installer, open the optim.installer.properties file and make any modifications to the variables to customize it for your installation. You can modify the following variables:

INSTALLER_UI=SILENT
Install using silent installer.
LICENSE_ACCEPTED=TRUE
Specify that the license agreement is accepted.
USER_INSTALL_DIR=directory
Fully-qualified path to the destination directory to install Optim.
CHOSEN_FEATURE_LIST=
Specify the list of features enabled. Files related to these features are copied into the installation directory. Values are:
Optim for Optim Server executables
Sample for Optim sample files
ODM for Open Data Manager
Specify the values in a comma-separated feature list. The values you specify for CHOSEN_FEATURE_LIST= must match the values you specify for CHOSEN_INSTALL_FEATURE_LIST=.
CHOSEN_INSTALL_FEATURE_LIST=
The list of features to install. Values are:
Optim for Optim Server executables
Sample for Optim sample files
ODM for Open Data Manager
Specify the values in a comma-separated feature list. The values you specify for CHOSEN_INSTALL_FEATURE_LIST= must match the values you specify for CHOSEN_FEATURE_LIST=.
CHOSEN_INSTALL_SET=
The type of installation. Values are:
Full installs all Optim features. If you choose this value, ensure that both CHOSEN_INSTALL_FEATURE_LIST= and CHOSEN_FEATURE_LIST= include all the features.
Custom installs features specified in CHOSEN_INSTALL_FEATURE_LIST=.

USER_INPUT_ODM_NOW= and USER_INPUT_ODM_LATER= should be included in the properties file only if you are installing the ODM feature. Otherwise, remove them from the file.

USER_INPUT_ODM_NOW=
Installs and configures ODM now. Values are:
1 install ODM now
0 do not install ODM now
USER_INPUT_ODM_LATER=
Copy the ODM files. Values are:
1 copy the files.
0 do not copy the files.
Include USER_INPUT_ODM_USERLIC= and USER_INPUT_ODM_TRIAL= only if both these conditions are met:
  • you are installing ODM (CHOSEN_INSTALL_FEATURE_LIST contains ODM), and
  • you are installing and configuring ODM now (USER_INPUT_ODM_NOW=1).

Otherwise, remove USER_INPUT_ODM_USERLIC= and USER_INPUT_ODM_TRIAL= from the file.

USER_INPUT_ODM_USERLIC=
Specify whether a valid ODM license file will be used. Values are:
1 a valid license file will be used to install ODM.
0 there is no valid license file to install ODM.
USER_INPUT_ODM_TRIAL=
Specify whether a trial license will be used for ODM. Values are:
1 use a default 30-day trial license.
0 do not use a 30-day trial license.

Include ODM_LICENSE_FILE_FULL_PATH= only if allthese conditions are met:

  • you are installing ODM (CHOSEN_INSTALL_FEATURE_LIST contains ODM) and
  • you are installing and configuring ODM now (USER_INPUT_ODM_NOW=1) and
  • you are using a valid ODM license file (USER_INPUT_ODM_USERLIC=1).

Otherwise, remove ODM_LICENSE_FILE_FULL_PATH= from the file.

ODM_LICENSE_FILE_FULL_PATH=pathtolicensefile
Specify the fully-qualified path to the ODM license file.
USER_INPUT_DELETE_FILES=
Specify whether to delete the temporary files created during the installation. Values are:
1 delete the temporary files.
0 do not delete the temporary files.
USER_INPUT_DONOT_DELETE=
Specify to prevent deleting the temporary files created during the installation. Values are:
1 do not delete the temporary files.
0 delete the temporary files.

After you specify the variables in the optim.installer.properties file, use one of the following commands to start the silent installer.

If the optim.installer.properties file is in the same directory as install.bin, use the command:
./install.bin –i silent
If the optim.installer.properties file is in a directory different from that for install.bin, use the command:
./install.bin -fdirectorypathoptim.installer.properties

where directorypath is the fully-qualified path to the directory for the optim.installer.properties file.

After the installation completes, see Configuration to establish defaults for the Server.

Installing an Optim on Red Hat Linux 3

You can install Optim on Red Hat Linux 3 using the installer wizard or the command line.

Installing from the installer wizard on Red Hat Linux 3

You can install Optim using the installer wizard.

Note: A graphical workstation is required to run the setup program, and a defined DISPLAY environment variable must point to the workstation. To ensure that you have the proper environment for running setup, open a terminal session and issue the following command: echo $DISPLAY. The command should return a valid identifier for your graphical workstation. If not, see your System Administrator.
You can begin Optim Server installation from a graphical interface in one of two ways:
  • Mount the Optim Server DVD. From File Manager or a console window, navigate to the DVD-ROM drive and start setup.
  • If you copied the contents of the Optim Server DVD to a network drive, navigate to the drive from File Manager or a console window, and start setup.
  1. Double-click the setpup file, located in the distributed/RtRHEL3 directory of the product DVD. The Action: Run window opens.
  2. Do not enter options or arguments. Click OK to continue. The Run window opens before the installer wizard starts and opens the Welcome page.
  3. Click Next. The Welcome page opens.
  4. Click Next. The Software License Agreement page opens.
  5. Read and accept the license agreement. Click Next. The choose destination location page opens.
  6. Accept the default installation directory or enter the path to a different directory. Click Next. The shutdown information page opens.
  7. Follow instructions about stopping Optim Servers that are running. Click Next. The select features page opens.
  8. Select the features to install. Click Next.

    If you do not select the Optim - Open Data Manager Interface option, the summary page opens.

    If you select the Optim - Open Data Manager Interface option, the Open Data Manager (ODM) installation information page opens.

  9. If you selected to install ODM, use the ODM installation information page to specify whether to install ODM as part of the Optim installation process or copy the files and install ODM at a later time. Click Next.

    If you selected Install and Configure ODM Now, the Open Data Manager (ODM) license information page opens.

    If you selected Only Copy the ODM Files, the summary page opens.

  10. If you selected Install and Configure ODM Now, select a license option on the Open Data Manager (ODM) license information page. Click Next.
    1. If you selected to specify a license file, click Next, enter the location of the license file, and click Next.
    2. If you selected a 30-day trial license, click Next.
    The summary page opens.
  11. On the summary page, review the installation summary.
  12. Click Next to begin the installation process. The installing page opens and displays the progress of the installation.
  13. After the installation process completes, the post-installation pages open. Use these pages to do the following:
    1. Read about the rtedit command file.
    2. Read about additional files that you must modify before starting the Optim Server.
    3. Select files to open in an editor. You can also edit the files after closing the installer wizard.
    4. Sign the default Optim exit. You can also sign the exit after closing the installer wizard.
    5. View the release notes.
  14. After viewing the post-installation pages, click Finish to close the installer wizard.
Installing from the command line on Red Hat Linux 3

To install the Server from the command line, use the setup options file, setupopts, located on the product DVD.

Editing setupopts - Red Hat Linux 3

To install the Server, mount the product DVD and copy setupopts from the root directory to a location for which you have write access. You can edit the file using an ASCII editor. Enable a keyword by removing the leading ‘###' characters from the line. Define a parameter for a keyword by editing the characters after the ‘='.

Running the Setup Process - Red Hat Linux 3

Open a console to thedistributed/RtHEL3 directory of the product DVD. Run the setup process from the command line, using the following command:

   ./setup -silent -options <file-name>

For example, if setupopts is in the /users/name directory, enter the following:

   ./setup -silent -options /users/name/setupopts

If you are upgrading or installing on a machine that has one or more Servers installed in another directory, you must manually shut down all Server processing. To shut down a Server, you must log on as the processing user account for each Server and run the following command before manually shutting the Server down.

   rt/mw/bin/mwadm stop
Syntax Conventions - Red Hat Linux 3

The syntax conventions used to describe the setupopts keywords are as follow:

parameter
Parameters can be entered in UPPER, lower, or Mixed case. Defaults are shown in bold text.
text
Variable parameter text is shown in lower-case italics.
[ ]
Delimiter for optional keywords or parameters.
{ }
Delimiter for a choice from which you must select one.
|
Separates options.
Keywords - Red Hat Linux 3
–W LicensePanel.selection=
The Optim license agreement. You must accept the license agreement to continue the installation.
1
“I accept the terms of the license agreement.”
2
“ I do not accept the terms of the license agreement.”
 -W LicensePanel.selection=1
–P installLocation=
The directory path for installing the Server. If the directory name contains spaces, enclose it in double quotation marks.
-P installLocation=/opt/IBM/Optim/rt
–P ProgramFeature.active=
Install the Server. This option installs all files needed to run the Server in a Solaris, HP-UX, or AIX operating environment, including shell scripts and configuration files.
true
Install the Server.
false
Do not install the Server.
-P ProgramFeature.active=true
–P SampleFeature.active=
Install sample Extract Files.
true
Install sample Extract Files.
false
Do not install the sample Extract Files.
-P SampleFeature.active=true
–P ODMFeature.active=
Install the Optim Open Data Manager (ODM) interface feature, which requires a product license.
true
Install the Optim ODM interface feature.
false
Do not install the Optim ODM interface feature.
Note: If you set -P ODMFeature.active=true, you must define a value for
-W ConfigureODMPromptPanel.ConfigureODMChoice
.
-P ODMFeature.active=false
–W ConfigureODMPromptPanel.ConfigureODMChoice=
If the Optim ODM feature is installed, indicate when it is configured.
1
Configure ODM now. This option prompts you for the Attunity license file and automatically installs the ODM Server.
2
Configure ODM later. This option copies the ODM Server installation files to your machine. To complete the ODM Server installation, you must install the ODM Server and register the ODM license manually.
-W ConfigureODMPromptPanel.ConfigureODMChoice=2
Note: If you choose to configure ODM now, -W ConfigureODMPromptPanel.ConfigureODMChoice=1, you must define a value for -W ODMLicensePanel.ODMLicenseField.
–W ODMLicensePanel.ODMLicenseField=
If you choose to configure ODM now, -W ConfigureODMPromptPanel.ConfigureODMChoice=1, enter the fully qualified name for the Attunity license file. If the directory contains spaces, enclose it in double quotation marks.
Note: If you do not have an Attunity license file, enter
-W ConfigureODMPromptPanel.ConfigureODMChoice=2.
-W ODMLicensePanel.ODMLicenseField=/opt/ODM/license.txt
–W UpdateFilesPanel.Update_rtsetenv=
This keyword allows you to edit the RTSETENV shell script during the installation process, using the default text editor. The RTSETENV shell script is included in a user “.profile” or “.login” script to define the operating environment for the Server. This script sets up the Server daemon or command line environment on login. The operating environment requires certain environment variables to create default settings.
0
Do not edit RTSETENV during installation.
1
Edit RTSETENV during installation. (If you are not installing from a graphical interface, this option will cause an error.)
-W UpdateFilesPanel.Update_rtsetenv=0
–W UpdateFilesPanel.Update_rtserver=
This keyword allows you to edit the RTSERVER shell script during the installation process, using the default text editor. The RTSERVER shell script contains a series of useful commands that allow you to manipulate the Server process. This script does not need modification.
0
Do not edit RTSERVER during installation.
1
Edit RTSERVER during installation. (If you are not installing from a graphical interface, this option will cause an error.)
-W UpdateFilesPanel.Update_rtserver=0
–W UpdateFilesPanel.Update_rt4s=
This keyword allows you to edit the RT4S shell script during the installation process, using the default text editor. The RT4S shell script is used to start or stop init(1) processing for the Server. This script should be executed only as part of the system boot procedure. Generally, the script does not need modification, unless the Server is installed in a directory other than the default directory, /opt/IBM/Optim, or the Server will be run under a user account other than root.
0
Do not edit RT4S during installation.
1
Edit RT4S during installation. (If you are not installing from a graphical interface, this option will cause an error.)
-W UpdateFilesPanel.Update_rt4s=0
–W UpdateFilesPanel.Update_pstserv=
This keyword allows you to edit the pstserv configuration file during the installation process, using the default text editor. The pstserv configuration file (pstserv.cfg) is used to configure the system to run the Server daemon. Before you run that daemon, you must modify the file to reflect your site requirements.
0
Do not edit pstserv during installation.
1
Edit pstserv during installation. (If you are not installing from a graphical interface, this option will cause an error.)
-W UpdateFilesPanel.Update_pstserv=0
–W UpdateFilesPanel.Update_pstlocal=
This keyword allows you to edit the pstlocal configuration file during the installation process, using the default text editor. The pstlocal configuration file (pstlocal.cfg) is used to configure the system for running the Command Line Utility.
0
Do not edit pstlocal during installation.
1
Edit pstlocal during installation. (If you are not installing from a graphical interface, this option will cause an error.)
-W UpdateFilesPanel.Update_pstlocal=0
–W UpdateFilesPanel.Update_locale=
This keyword allows you to edit the locale.conf file during the installation process, using the default text editor. The locale.conf file provides locale conversion information between platforms. You can use this file to provide additional locale conversion information.
0
Do not edit locale.conf during installation.
1
Edit locale.conf during installation. (This option will cause an error unless installing from a graphical interface.)
-W UpdateFilesPanel.Update_locale=0
–W View_Readme.Value=
This keyword allows you to open the readme.txt file, using the default text editor. The readme.txt file contains installation notes and information.
0
Do not open readme.txt during installation.
1
Open readme.txt during installation. (If you are not installing from a graphical interface, this option will cause an error.)
-W View_Readme.Value=0   

Configuration

Configuration files and shell scripts are installed with the executable files when you install the Server in a supported UNIX environment. These objects establish defaults for the Server and must be customized to reflect your network environment. Use a text editor (for example, vi, emacs, CDE Text Editor, textedit, or xedit) to modify these files.

Configuration Files

Configuration files are ASCII text files and are installed in the /etc directory that is subordinate to the PSTHOME directory. PSTHOME is an environment variable, set during installation, that points to the directory in which the Server is installed.

The configuration file names for the Server are:

pstserv.cfg
Configures prosvce, the Server daemon.
pstlocal.cfg
Configures local command line.

The appropriate Configuration file is loaded and validated when pr0svce or the Command Line Utility starts up. You can also use pr0svce -v to validate pstserv.cfg or pr0cmnd -v to validate pstlocal.cfg.

To reload the configuration file for prosvce while it is running, use pr0svce -u from a console under the user account for the daemon (or use pr0svce -u userid from root). After all clients have logged off, the file is read, reloaded, and validated. A console message and system log verify the file has been loaded.

Note: Use pr0svce -L (or use pr0svce -L userid from the root account) to determine if the system is waiting to reload.
Shell Scripts

The installed shell scripts are:

RTSETENV
Defines the operating environment for the Server. Installed in the PSTHOME directory and designed to be included in a user .profile or .login script to set up the environment for the Server or command line on login.
RTSERVER
Provides commands that allow you to manipulate the Server process. Installed in /sbin, subordinate to the PSTHOME directory.
RT4S
Used to start or stop the Server from init processing. Installed in /sbin, subordinate to the PSTHOME directory, RT4S should be executed only as part of the system boot procedure.
Conventions

The following conventions are used in shell scripts and .cfg files:

  • One parameter per line.
  • Blank lines and leading and trailing blanks within a line are ignored.
  • Use double quotes or the escape character (\) to pass a special character to processing:
    • Enclose a string that includes ‘# ' in double quotes (e.g., "text#here").
    • To include a double quote (") within a quoted string, use the escape character, \ (e.g., \").
    • Precede a special character that is not in a quoted string with the ‘escape' character, \ (e.g., \#, \\).
  • References to environment variables are in the form ${environmentvariablename}. An environment variable that does not exist equates to a NULL string (“ ”). For example, AAA${NOT_EXIST}BBB is treated as AAABBB.
  • Parameters and keywords are not case-sensitive. Directories, file names, User IDs, and passwords are case-sensitive.
  • Keywords shown as 0 (zero) in the following text can also be entered as f, or false, while keywords shown as 1 can be entered as t, or true.
  • Comments are allowed after an entry and must begin with ‘# '.
Syntax

The syntax conventions used to describe the configuration files, shell scripts, and commands are:

parameter
Parameters and keywords can be entered in UPPER, lower, or Mixed case.
text
Variable text is shown in lower-case italics.
( )
Delimiter to group a series of qualifiers.
[ ]
Delimiter for optional parameters or settings.
{ }
Delimiter for a choice from which you must select one.
< >
Delimiter for a choice from which you may select any or none.
|
Separates options.

Notices

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-0032, Japan

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

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

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

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

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

IBM Corporation
Software Interoperability Coordinator, Department 49XA
3605 Highway 52 N
Rochester, MN 55901
U.S.A.

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

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

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

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

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

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before the products described become available.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

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

Trademarks

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

IBM
IBM logo
DB2
AIX
Informix
InfoSphere
Optim

Netezza® is a registered trademark of IBM International Group B.V., an IBM Company.

Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both.

Apache Derby is a trademark of The Apache Software Foundation.

Eclipse is a trademark of Eclipse Foundation, Inc.

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

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

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

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

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