IBM Data Studio, Version 2.2.1.1
Installation Guide
Note
Before using this information and the product it supports, read
the information in Notices.
This edition applies to version 2.2.1.1 of IBM Data
Studio and to all subsequent releases and modifications until otherwise
indicated in new editions. Instructions are written for version 1.4.2
of Installation Manager, which is included with Data Studio Version
2.2.1.1.
Copyright International Business Machines Corporation 2011.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Installing IBM
Data Studio (IDE package)
You use the Installation Manager product to install, update, and
uninstall the Data Studio product.
Installation roadmap for IBM
Data Studio (IDE package)
The installation roadmap lists the high-level steps for
installing IBM
Data Studio (IDE package).
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.
Roadmap for installing the product package
Perform
these tasks to install the product:
- Verify that your computer
and user ID meet the minimum requirements for installing the product.
- Review the rest of the planning
information .
- Complete any necessary
pre-installation tasks.
- Install the product using
the Installation Manager Install wizard.
- Perform any necessary
post-installation tasks.
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.
- Use Installation Manager to silently install software packages:
- Install Installation Manager using the Installation Manager installer.
- Record a response
file using Installation Manager, or Create a response file manually,
.
- Run the Installation Manager
in silent mode to perform the operation silently.
- Use the Installation Manager installer to silently install software
packages:
- Create a response file manually that
includes commands to install Installation Manager and other packages.
- 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 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
operating system, this is the user who is using "Run As Administrator"
to start Installation Manager.
- Extension
- A type of product package that provides additional function to
another product package. You cannot install the extension without
also installing the package that it extends.
- Installation directory
- The location of product artifacts after the package is installed.
- Non-admin user
- A user who does not have write administrative privileges. In the
context of installing, this means that this user can only install
into the home directory.
- Package
- An installable unit of a software product. Software product packages
are separately installable units that can operate independently from
other packages of that software product.
- Package group
- A package group represents a directory in which different product
packages share resources with other packages in the same group. When
you install a package using Installation Manager, you can create a
new package group or install the packages into an existing package
group. (Some packages cannot share a package group, in which case
the option to use an existing package group is disabled.) Sharing
a package group is sometimes also referred to as "shell sharing."
- Repository
- A persistent storage area where packages are available for download.
A repository can be disc media, a folder on a local hard disk, or
a server or Web location.
- Shared resources directory
- In some instances, product packages can share resources. These
resources are located in a directory that the packages share.
Installation default values and conventions
The installation documentation uses conventions such as Shared
resources directory that infer specific directory locations.
This topic describes the conventions in use for 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\Installation Manager
- On Linux systems: /opt/IBM/Installation
Manager
- Non-admin installation:
- On Windows systems: user.home\IBM\Installation
Manager
- On Linux systems: user.home/IBM/Installation
Manager
|
Installation manager shared resources directory |
Shared resources directory |
- Admin installation:
- On Windows systems: C:\Program
Files\IBM\SDPShared
- On Linux systems: /opt/IBM/SDPShared
- Non-admin installation:
- On Windows systems: user.home\IBM\SDPShared
- On Linux systems: user.home/IBM/SDPShared
|
Product installation directory |
Product directory |
- Admin installation:
- On Windows systems: C:\Program
Files\IBM\DS2.2
- On Linux systems: /opt/IBM/DS2.2
- Non-admin installation:
- On Windows systems: user.home\IBM\DS2.2
- On Linux systems: user.home/IBM/DS2.2
|
Product workspace directory |
workspace directory |
- On Windows systems: user.home\IBM\rationalsdp\workspace
- For Linux: user.home/IBM/rationalsdp/workspace
|
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.3.0 of Installation Manager is included with the product.
You can also download Installation Manager Version 1.3.x directly
from www.ibm.com. 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://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp
Installation Manager includes six wizards that make it easy to
maintain packages through their life cycles:
- 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.
About this task
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.
You will then install Installation Manager on your computer during
the process of installing the product.
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.
About this task
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:
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
Data Studio (IDE package)
Verify that your hardware and software meet or exceed the
minimum requirements. If your hardware and software do not meet the
minimum requirements, you might be unable to install or run the product.
Before you can install the product, verify that your system meets
the minimum hardware requirements.
For the most up to date system requirements, see the technote on
the Web: http://www.ibm.com/support/docview.wss?uid=swg27016018
Hardware |
Requirements |
Processor |
Minimum 2GHz or higher |
Memory |
Minimum: 1GB RAM; For best results: 2GB RAM |
Disk space |
Minimum: 2 GB of
disk space is required for product package installation. Additional
disk space is required for the resources that you develop.
- Disk space requirements can be reduced or increased depending
on the features that you install.
- Additional disk space is required if you download the product
package to install this product.
|
Display |
1024 x 768 display minimum using 256 Colors (or higher for
best results) |
Other hardware |
Microsoft mouse
or compatible pointing device |
Eclipse and JDK versions |
This version of the product was developed for use with Eclipse
3.4.2, using the IBM JDK 1.6
SR 7. These versions are included with the product
package. If you are extending an existing Eclipse environment, these
versions of Eclipse and the JDK are prerequisites. Refer to Extending an existing Eclipse
IDE for more information. |
- Compatible operating systems
-
Do not attempt to install the product on operating
systems other than those that are listed. Installation Manager might
run on other operating systems, but the product package installation
can fail. If installation fails, uninstallation sometimes also fails.
Supported
operating systems are listed on the product system requirements Web
page: http://www.ibm.com/support/docview.wss?uid=swg27016018
Data Studio has
the following software requirements on the client platform:
- To run SQL statements, you must have access to the IBM Java Database
Connectivity (JDBC) Type 4 driver. This JDBC Type 4 driver is included
with Data Studio.
You can select a different JDBC driver if necessary.
On Linux systems, if the class location
of your JDBC driver (db2jcc.jar and license) is not automatically
populated, check the DB2INSTANCE environment variable. This variable
should be set to the local DB2® instance
name, for example, export DB2INSTANCE=db2inst1. The value of the variable
is case sensitive. Otherwise, you can specify the location manually.
- To run commands and utilities that cannot be run through the JDBC
driver, you must use one of the following alternative protocols that
the workbench supports:
- The DB2 Administration Server
(DAS) protocol, which is supplied by DB2 for Linux, UNIX, and Windows
- The Secure Shell (SSH) protocol
- The Microsoft Windows Server Message Broker
(SMB) protocol
- To browse and access the file system on a remote server, the Secure
File Transfer (SFTP) protocol is used.
For information about the configuration and set up that
is required for using DAS, SSH, or SMB, and SFTP, see Configuration for remote operations.
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: Installing IBM Data Studio (IDE package) with
the Installation Manager Install wizard.
Implications of using an admin or non-admin user ID
when installing
Table 2. The following table describes what happens when user ID's with different access privileges are used when installing
User ID authority |
Case where you install as Non-admin |
Case where you install as Admin |
Non-admin (current user) |
- If Installation Manager is not already installed, it is installed
for the current user only.
- After Installation Manger is installed, products can only be installed
for the current user.
|
- For operating systems other than Microsoft Windows Vista:
An error message occurs.
- For Microsoft Windows Vista: You are prompted
to log on with an Admin user ID.
|
Admin |
An error message occurs. |
- If not already installed, Installation Manager is installed for
All Users.
- Any products installed with this Installation Manager are for
All Users
|
Additional requirements for Linux operating
systems
If you use a Linux operating
system, then you must check that your computer meets the requirements
listed in this topic.
Environment variable might need setting for Firefox
or Mozilla browsers
You might need to set the environment
variable MOZILLA_FIVE_HOME to the folder containing your Firefox or
Mozilla installation. For example, setenv MOZILLA_FIVE_HOME /usr/lib/firefox-1.5.
Firefox browsers must be dynamically linked
To
support the SWT browser widget, your Firefox browser must be dynamically
linked, which means it was not downloaded from mozilla.org, but was
compiled from source. This is typically the case when the Firefox
comes as part of the distribution (that is, it is in a place such
as /usr/lib/firefox).
One way to ensure that this is true is
to see if it is the browser that is pointed at by /etc/gre.conf. The
purpose of this gre.conf file is to point at an embeddable browser.
SUSE Linux might
require a fix for invisible text problem
If your operating
system is SUSE Linux Enterprise
Desktop 10 SP1 or SUSE Linux Enterprise
Server 10 SP1, then you might need the following operating system
update to resolve a problem with text not being displayed in some
editors:http://support.novell.com/techcenter/psdb/44ab155e3202595389c101e6cf7e20f2.html.
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 the same package group.
Coexistence considerations
Coexistence refers to the installed products on the same
computer.
Compatibility with other products
If you have a previous version of the product, or if you
plan to install multiple products on the same workstation, review
this information.
Eclipse-based products that have been installed with Installation Manager can
share a package group with other compatible products that have been
installed with Installation Manager.
The following Eclipse 3.4.2-based products are compatible and can
share a package group:
- IBM Data Studio Version
2.2.1
- IBM Optim™ Database Administrator Version 2.2.3
- IBM Optim Development Studio Version 2.2.1
- IBM Optim Query Tuner client Version 2.2.1
- IBM InfoSphere™ Data Architect Version 7.5.3
For information about other products that are compatible, see the
following technote: http://www-01.ibm.com/support/docview.wss?rs=2042&uid=swg21279139
For the most up to date list of compatible products and more information
about known compatibility issues and workarounds, see the following
technote:http://www.ibm.com/support/docview.wss?rs=3360&uid=swg27014124
The following limitation exists for shared installations:
- If you install more than one product into a shared package group,
when you launch the product, the splash screen of the first installed
product is always launched. However, after the splash screen, the
correct product opens.
If you have installed other Eclipse 3.4.2-based products using
a mechanism other than Installation Manager, you
can attempt to install Data Studio into
the same Eclipse IDE, using the Extend an existing Eclipse
IDE option in Installation Manager. However,
be aware that this type of installation will fail if the Eclipse environment
is not exactly compatible with this version of Data Studio.
Package group coexistence considerations
You can install multiple compatible products 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.
Any number of eligible products
can be installed to a package group. When a product is installed,
the product functions are shared with all of the other products in
the package group. If you install a development product and a testing
product into one package group, when you start either of the products,
you have both the development and testing functions available to you
in your user interface. If you add a product with modeling tools,
all of the products in the package group will have the development,
testing, and modeling functions available.
Coexistence between package groups
Multiple
instances of a product package can exist on the same computer and
they are automatically installed into separate package groups. The
product packages can be at different versions or fix levels.
If
you update a product package, you update only that instance of the
product.
Extending an existing Eclipse IDE
When you install the product package, you can choose to
extend an Eclipse integrated development environment (IDE) already
installed on your computer by adding the functions that the product
package contains.
The product package contains a compatible version of the Eclipse
IDE or workbench; this bundled workbench is the base platform on top
of which the functionality in the product is provided. If you have
an Eclipse IDE on your workstation, then you have the option to extend it,
that is, add to your current Eclipse IDE the additional functionality
provided in the product.
Extending an
Eclipse IDE adds the functions of the newly installed product, but
maintains your IDE preferences and settings. Previously installed
plug-ins are also still available.
Your Eclipse IDE and JRE must be at least at the minimum version
levels that the product requires. See the product system requirements
for details on the required versions. Installation Manager checks
that the Eclipse instance that you specify meets the requirements
for the installation package.
Web-based help content
Some help systems are configured to use remote help so that you
can pull in content from the Web dynamically. With remote help, you always
have the latest content available from within your product. Some help systems
are not configured to access help content on the Web; in such cases, help
content is included with the installation.
If
your product is configured to use remote help, you can obtain help three ways.
One of these options will be best for you, depending on your needs and situation:
- The help content can be accessed on the Web so that you can have the smallest
installation footprint and the most up-to-date information.
- The help content can be downloaded and accessed on your computer so that
you can work disconnected from the Internet with periodic updates.
- The help content can be deployed on an intranet server so that you can
work behind a firewall with administrative updates.
If your help system supports remote help, you can change your access decision
any time. If you install multiple products together, you can use different
locations for the help for each product, depending on installation footprint,
frequency of use, and internet policies. If internet speed is an issue, a
longer one-time download and local access might be preferable. Later help
updates include only differences.
If you are an administrator and you want users to access help content from
an intranet server, see the Installation Manager information center for instructions
on how to install the help WAR file on a server.
Pre-installation tasks
Before you install, you might need to prepare or configure your
computer.
Pre-installation checklist
Review the following information and ensure the pre-installation
steps are completed as required.
Procedure
__ 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)
If you are installing from physical media, mount your DVD drive.
__ 3.
(For Linux)
If you want the product to be used by users other than root, then
set the umask variable to 0022 before you install the product.
To set this variable, log in as root user, start a terminal session,
and type umask 0022.
__ 4.
(For Linux)
Increase the number of file handles on your computer.
__ 5.
Ensure that you are logged on to your computer with an
appropriate user ID.
__ 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.
About this task
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.
About this task
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,
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.
When you are finished extracting all of the compressed files,
the directory where you extracted the contents will have subdirectories
with the following names:
Table 3. Subdirectories created after extracting compressed file contents
Subdirectory name |
Required or optional |
disk1 |
required |
documentation |
required |
launchpad |
required |
Increasing the number of file handles on Linux computers
For best product performance, increase the number of file
handles above the default of 1024 handles.
Before you begin
Important:
Before you work with your product,
increase the number of file handles. Most products use more than the
default limit of 1024 file handles per process. A system administrator
might need to make this change.
About this task
Ensure that you complete the following steps correctly. If
this procedure is not completed correctly, your computer will not
start.
To increase the number of file handles on a Linux computer, complete the following steps:
Procedure
- Log in as root. If you do not have root access, you will
need to obtain it before continuing.
- Change to the etc directory.
Attention: If you decide to increase the number of file handles
in the next step, do not leave an empty initscript file on
your computer. If you do so, your computer will not start the next
time that you restart it.
- Use the vi editor to edit the initscript file in the etc directory.
If this file does not exist, type vi initscript to
create it.
- On the first line, type ulimit -n 4096.
The point is that 4096 is significantly larger than 1024, the default
on most Linux computers.
Important:
Do not set the number of handles too
high, because doing so can negatively impact system-wide performance.
- On the second line, type eval exec "$4".
- Save and close the file after making sure you have completed
steps 4 and 5.
- Optional: Restrict the number of handles available
to users or groups by modifying the limits.conf file in the etc/security directory.
Both SUSE Linux Enterprise
Server (SLES) Version 9 and Red Hat Enterprise Linux Version 4.0 have this file by default.
If you do not have this file, consider using a smaller number in step
4 in the previous procedure (for example, 2048). Do this so that
most users have a reasonably low limit on the number of open files
that are allowed per process. If you use a relatively low number in
step 4, it is less important to do this. However, if you set a high
number in step 4 earlier and you do not establish limits in the limits.conf
file, computer performance can be significantly reduced.
The
following sample limits.conf file restricts all users, and then sets
different limits for others afterwards. This sample assumes that you
set handles to 8192 in step 4.
* soft nofile 1024
* hard nofile 2048
root soft nofile 4096
root hard nofile 8192
user1 soft nofile 2048
user1 hard nofile 2048
Note that the * in
the preceding example sets the limits for all users first. These limits
are lower than the limits that follow. The root user has a higher
number of allowable handles open, while number available to user1
is between the two. Make sure that you read and understand the documentation
contained in the limits.conf file before making changes.
Mounting a drive
With some operating systems, such as Linux, you must mount the appropriate drive
before you can access data on the product disc.
Before you begin
Important:
Insert the product disc into the drive
before mounting the drive.
Procedure
To mount a drive in Linux:
- Log in as a user with root authority.
- 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.
- Log out.
What to do next
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.
Before you begin
Note:
Before starting the installation process, be sure to
obtain the installation package repository URL from your administrator
or IBM.
About this task
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.
To
specify a repository, complete the following steps:
Procedure
- Start IBM Installation
Manager.
- On the Start page, click File -> Preferences.
- In the Preferences widow, click Repositories. The Repositories page opens, showing available repositories,
their locations, and whether they are connected.
- On the Repositories page, click Add
Repository.
- 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.
- Click OK to close the Preferences window.
Installing software
To install your product package, follow the procedures
and information in these topics.
Installing IBM Data Studio (IDE package) with
the Installation Manager Install wizard
This topic provides the instructions for installing Data Studio with
the Installation Manager Install wizard.
Before you begin
Complete any necessary pre-installation
tasks.
About this task
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.
Procedure
To install IBM Data Studio with
the Installation Manager Install wizard:
- Insert the product DVD into your DVD drive. For Linux,
ensure that you have mounted the DVD drive.
If
autorun is enabled on your computer, the launchpad automatically opens.
If
autorun is not enabled on your computer, follow the next steps below
to start the installation manually.
- Optional: To start the installation manually,
complete one of these steps:
- On Windows systems:
Run setup.exe, which is located in the root directory
of the DVD.
Note:
On Windows Vista
or Windows 7 systems, you
must run this file as an administrator if you plan to perform an administrative
installation.
The launchpad opens. Select a language and
click OK.
- For Linux:
Run setup, which is located in the root directory
of the DVD.
The launchpad opens. Select a language and click OK.
As an alternative if you have already installed Installation
Manager separately, you can also start the installation process by
following these steps:
- Start Installation Manager.
- Configure the Installation
Manager repository preferences.
- Run the Installation Manager Install wizard to install the product
package.
If you install using this method, the installation can
be an administrative or a non-administrative installation, based on
whether you installed Installation Manager as an administrative or
a non-administrative user.
- Optional: If you are installing with the launchpad,
read the product information.
- If you are installing with the launchpad, expand Install
Product and click on Administrative Installation or Non-Administrative
Installation.
- In the Installation Manager Install wizard, ensure that IBM Data Studio is
selected.
- 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.
- 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.
- Click Next.
- 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.
- If you agree to the terms of all of the license agreements,
click I accept the terms of the license agreements.
- Click Next to continue.
- 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.
- Click Next to continue.
- 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:
- Click Create a new package group.
- 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.
- On the next Location page, you can choose to extend an
Eclipse IDE already installed on your system, adding the functionality
in the packages that you are installing. This page is not
available if you selected to share a package group in the last step.
- If you do not want to extend an Eclipse IDE, click Next to
continue.
- To extend an existing Eclipse IDE:
- Select Extend an existing Eclipse.
- In the Eclipse IDE field, type or navigate
to the location of the folder that contains the eclipse executable
file (eclipse.exe or eclipse.bin). Installation manager will check
if the Eclipse IDE version is valid for the package that you are installing.
The Eclipse IDE JVM field displays the Java Virtual Machine (JVM) for the
IDE that you specified.
- Click Next to continue.
- 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.
- On the Common Configurations page,
specify how you want to access help.
If you select to
download and install the help locally, you will be prompted to do
so the first time you start the product.
You can change this
selection later by modifying the Help -> Contents preferences page.
- 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.
- When the installation process is complete, a message confirms
the success of the process.
- 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.
- In the Install Package wizard, select whether you want
the product to start when you exit.
- Click Finish to launch the selected
package. The Install Package wizard closes and you are returned to
the Start page of Installation Manager.
- Close Installation Manager.
- If you started the installation from the launchpad, close
the launchpad.
What to do next
Complete any necessary post-installation
tasks.
- Related concepts
- Coexistence considerations
Coexistence refers to the installed products on the same computer.
- Installation terminology
Understanding these terms and conventions can help you take full advantage of the installation information and your product.
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.
- Use Installation Manager to silently install software packages:
- Install Installation Manager using the Installation Manager installer.
- Record a response
file using Installation Manager, or Create a response file manually,
.
- Run the Installation Manager
in silent mode to perform the operation silently.
- Use the Installation Manager installer to silently install software
packages:
- Create a response file manually that
includes commands to install Installation Manager and other packages.
- 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.
About this task
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.
Procedure
- 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 130/,
then select the zips directory.
- Switch to the InstallerImage_platform subdirectory.
- Enter one of the following commands:
- To install as an administrator on Windows: installc --launcher.ini
silent-install.ini -log <log file path and name> For
example: installc --launcher.ini silent-install.ini -log
c:\mylogfile.xml
- To install as non-administrator on Windows: userinstc --launcher.ini
user-silent-install.ini -log <log file path and name> For
example: userinstc --launcher.ini user-silent-install.ini
-log c:\mylogfile.xml
- For other platforms as an administrator: install
--launcher.ini silent-install.ini -log <log file path and name> For
example, install --launcher.ini silent-install.ini -log
/root/mylogs/mylogfile.xml
- For other platforms as non-administrator: userinst
--launcher.ini user-silent-install.ini -log <log file path and
name> For example, userinst --launcher.ini
user-silent-install.ini -log /root/mylogs/mylogfile.xml
Results
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.
About this task
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.
Procedure
- Go to the InstallerImage_platform directory
- Locate the response file install.xml
- 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.
Example
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.2.0.20080624_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.
Before you begin
To install software packages using the Installation Manager
installer, you must first create
a response file.
About this task
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
--launcher.ini silent-install.ini -input <response file path and
name> -log <log file path and name>. For example: installc.exe
--launcher.ini silent-install.ini -input c:\myresponse\responsefile.xml
-log c:\mylog\silent_install_log.xml.
- For Windows as non-administrator: userinstc.exe
--launcher.ini user-silent-install.ini -input <response file path
and name> -log <log file path and name>. For example: userinstc.exe
--launcher.ini user-silent-install.ini -input c:\myresponse\responsefile.xml
-log c:\mylog\silent_install_log.xml .
- For other platforms as administrator: install
--launcher.ini silent-install.ini -input <response file path and
name> -log <log file path and name>. For example: install
--launcher.ini silent-install.ini -input /root/myresponse/responsefile.xml
-log /root/mylog/silent_install_log.xml
- For other platforms as non-administrator: userinst
--launcher.ini user-silent-install.ini -input <response file path
and name> -log <log file path and name>. For example: userinst
--launcher.ini user-silent-install.ini -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. |
-silent |
Specifies that the Installation Manager installer or Installation
Manager should be run in silent mode. |
-input |
Specifies an XML response file as the
input to Installation Manager installer or the Installation Manager.
A response file contains commands that installer or Installation Manager
runs. |
-log |
(Optional) Specifies a log file that records the result of
the silent installation. The log file is an XML file.
If your silent
installation session is successful, the log file will contain just
the root element of <result> </result>. However,
if errors occur during the installation, the silent install log file
will contain error elements and messages. |
-updateAll |
(Optional) All available updates to are installed. |
-installAll |
(Optional) All available products are installed. |
--launcher.ini silent-install.ini |
Specifies the location of the product .ini file to use.
If this argument is not specified, the executable will check for a
file in the same directory as the launcher with the same name and
the extension ".ini". For example, installc.exe checks for installc.ini.
The silent-install.ini file that is located in the same directory
as the installc.exe file contains the initialization parameters for
installing silently and should always be present. |
--launcher.ini user-silent-install.ini |
Specifies the location of the product .ini file to use
for a non-administrator install. If this argument is not specified,
the executable will check for a file in the same directory as the
launcher with the same name and the extension ".ini". For example,
install.exe checks for install.ini. The silent-install.ini file that
is located in the same directory as the install.exe file contains
initialization parameters that are applicable to installing silently
and should always be present. |
-accessRights |
Defines whether the IM operates in admin or nonAdmin mode.
For nonAdmin mode this argument should always be used with 'nonAdmin'
parameter:
-accessRights nonAdmin For admin mode it should
be used with admin parameter:
-accessRights admin
If
this argument is not used, the default value is set based on current
user permissions.
Note:
For Windows XP
users who are members of Administrator group, the default is always -accessRights
admin. For these users to run in nonAdmin mode -accessRights
nonAdmin argument should be passed explicitly. |
-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
Results
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.
About this task
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: IBMIMc.exe
--launcher.ini silent-install.ini -input <response file path and
name> -log <log file path and name>. For example: IBMIMc.exe
--launcher.ini silent-install.ini -input c:\mylog\responsefile.xml
-log c:\mylog\silent_install_log.xml
- For other platforms: IBMIM
--launcher.ini silent-install.ini -input <response file path and
name> -log <log file path and name>. For example: IBMIM
--launcher.ini silent-install.ini -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. |
-silent |
Specifies that the Installation Manager installer or Installation
Manager should be run in silent mode. |
-input |
Specifies an XML response file as the
input to Installation Manager installer or the Installation Manager.
A response file contains commands that installer or Installation Manager
runs. |
-log |
(Optional) Specifies a log file that records the result of
the silent installation. The log file is an XML file.
If your silent
installation session is successful, the log file will contain just
the root element of <result> </result>. However,
if errors occur during the installation, the silent install log file
will contain error elements and messages. |
-updateAll |
(Optional) Specifies that all available updates are installed. |
-installAll |
(Optional) Specifies that all available products are installed. |
--launcher.ini silent-install.ini |
Specifies the location of the product .ini file to use.
If this argument is not specified, the executable will check for a
file in the same directory as the launcher with the same name and
the extension .ini. For example, IBMIM.exe checks for IBMIM.ini and
install.exe checks for install.ini. The silent-install.ini file that
is located in the same directory as the IBMIM.exe file contains initialization
parameters that are applicable to installing silently and should always
be present. |
--launcher.ini user-silent-install.ini |
Specifies the location of the product .ini file to use
for Windows as non-admin.
If this argument is not specified, the executable will check for a
file in the same directory as the launcher with the same name and
the extension ".ini". For example, IBMIM.exe checks for IBMIM.ini.
The user-silent-install.ini file that is located in the same directory
as the IBMIM.exe file contains initialization parameters that are
applicable to installing silently and should always be present. |
-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
Results
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.
Procedure
Follow these steps to find and install all available
products using Installation Manager in silent mode:
- On a command line, change to the eclipse subdirectory in
the directory where you installed Installation Manager.
- Enter and run the following command:
- For Windows: IBMIMc.exe
--launcher.ini silent-install.ini -installAll
- For other platforms: IBMIM
--launcher.ini silent-install.ini -installAll
Results
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.
Procedure
Follow these steps to find and install all available
updates for products that are installed:
- On a command line, change to the eclipse subdirectory in
the directory where you installed Installation Manager.
- Enter and run the following command:
- For Windows: IBMIMc.exe
--launcher.ini silent-install.ini -updateAll
- For other platforms: IBMIM
--launcher.ini silent-install.ini -updateAll
Results
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.
About this task
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.
Procedure
To access authenticated repositories in silent mode,
complete the following steps:
- 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
- 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.
- 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:
- On Windows: IBMIMc.exe
--launcher.ini silent-install -input <input file path and name>
-keyring <key ring file path and name> -password <password>
- On other platforms: IBMIM
--launcher.ini silent-install -input <input file path and name>
-keyring <key ring file path and name> -password <password>
Silently uninstalling Installation Manager
Use the uninstall script to silently uninstall Installation
Manager.
Procedure
The uninstall script is stored in the Installation Manager
uninstall directory. Follow these steps to silently uninstall Installation
Manager:
- 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
- Enter the following command:
- On Windows as administrator: uninstallc.exe
--launcher.ini silent-uninstall.ini
- On Windows as non-administrator:userinstc.exe
--launcher.ini silent-uninstall.ini
- On other platforms, enter: uninstall --launcher.ini
silent-uninstall.ini
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.
About this task
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 create 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.
Procedure
To record a response file, complete the following steps:
- 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
- On a command line, type one of the following commands to
start the Installation Manager, substituting your own file name and
location for the response file and (optionally) the log file. You
can record a response file and perform an installation or update at
the same time, or you can record a response file without performing
an installation or update.
- To record a response file while performing an installation
or update:
- To record a response file without performing an installation
or update, add the optional -skipInstall <agentDataLocation> argument
to the command. For example:
For Windows: IBMIM -record c:\mylog\responsefile.xml
-skipInstall c:\temp\recordData
When you add the -skipInstall <agentDataLocation>argument:
- The packages are not installed or uninstalled. The artifacts are
not downloaded and the actions are not executed.
- Installation Manager saves the data to the location that you specified.
- Recording the response file is faster, because the Installation
Manager is not performing actions, it is just recording the data.
<agentDataLocation> must be a writable
directory, with the following additional characteristics:
- If you are generating a response file for an initial installation
of a product, the <agentDataLocation> directory
must be empty.
- If you are generating a response file to record license management,
updates, or modifications to the product, you must use the same <agentDataLocation> in
the next recording session. These changes are added to the agent data
location.
- 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.
- Click Finish, then close Installation Manager.
Results
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)
- 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 above are default values for this preference; typically, install
packages provide their own values for this preference. |
You cannot change this location if you have already installed
a package. |
com.ibm.cic.agent.core.pref.offering.service.repositories.areUsed |
True or False |
Change this preference to False to disable
it. When 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 are also included on the product DVD, in
the sampleResponseFiles 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="IBM Software 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.
Procedure
- On a command line, change to the eclipse subdirectory in
the directory where you installed Installation Manager.
- Enter and run the following command:
- For Windows: IBMIMc.exe
--launcher.ini silent-install.ini -exportInstallData <installDataFile>.
Where <installDataFile> is the name of the
file to be generated that contains the exported data in .zip file
format.
- For other platforms: IBMIM --launcher.ini
silent-install.ini -exportInstallData <installDataFile>.
Where <installDataFile> is the name of the
file to be generated that contains the exported data in .zip file
format.
Results
A .zip file that contains the installation data is created.
Using the Installation Manager installer to perform other operations
If you cannot instal 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.
Procedure
To find and install all available products using Installation
Manager installer, complete the following steps:
- Switch to the InstallerImage_platform subdirectory.
- Enter and run the following command:
- For Windows as
admin: installc.exe --launcher.ini silent-install.ini
-installAll
- For Windows as
non-admin: userinstc.exe --launcher.ini user-silent-install.ini
-installAll
- For other platforms: install --launcher.ini
silent-install.ini -installAll
Results
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.
Procedure
To find and install all available updates for products
that are installed, complete the following steps:
- Switch to the InstallerImage_platform subdirectory.
- Select, enter and run the appropriate command:
- For Windows as
admin: installc.exe --launcher.ini silent-install.ini
-updateAll
- For Windows as
non-admin: userinstc.exe --launcher.ini user-silent-install.ini
-updateAll
- For other platforms: install --launcher.ini
silent-install.ini -updateAll
Results
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.
Before you begin
You must have Installation Manager installed to install a
software package from an authenticated repository.
About this task
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.
Procedure
To access authenticated repositories in silent mode,
complete the following steps:
- 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
- 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.
- 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.
- On a command line, enter the appropriate command:
- On Windows as admininstallc.exe
--launcher.ini silent-install -input <input file path and name>
-keyring <key ring file path and name> -password <password>
- On Windows as non-adminuserinstc.exe
--launcher.ini user-silent-install -input <input file path and
name> -keyring <key ring file path and name> -password <password>
- On other platforms, use install --launcher.ini
silent-install -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.3 at http://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp.
Post-installation tasks
After you have installed your product package, complete the post-installation
tasks or configure your product package as required.
Post-installation checklist
After you have installed your product, complete several
tasks to configure and verify the installation.
About this task
Review the following information and ensure the post-installation
steps are completed as required.
Procedure
__ 1.
Verify your installation and ensure that you can start
your product.
__ 2.
Configure your environment for remote
operations, if applicable.
Starting the product
You can start the product from the desktop environment
or a command-line interface.
Procedure
- For Windows operating
systems: Click Start -> All Programs -> package_group_name -> IBM
Data Studio .
- To start the product from a command-line interface:
- On Windows: Type
this command: product_installation_directory\eclipse.exe
- On Linux: Type
this command: .product_installation_directory/eclipse
For more information about the available command-line start
options, see Running Eclipse. For example, if you installed
multiple national language translations, you can start the product
in another locale with the -nl option:
- Example
- To start the product with the English locale, type this command: product_installation_directory\eclipse.exe
-nl en_US
Configuring Web-based help
You might need to set up or change how you access help
content.
Accessing Web-based help
Help for your product is available on a product information
center on the Internet. You can view this help from within the product.
Before you begin
During installation, select the option to access help from
a remote information center. This is the default selection.
If
you did not select this option during installation, change the help access method to
specify accessing help from a remote information center.
About this task
Your product help system can retrieve content installed with
the product, as well as content from a remote server running an information
center. The information center for your product has the most current
help content and when your product is configured to retrieve content
from a remote information center, the contents of the information
center can be accessed by selecting Help -> Help Contents to open your help
system.
The information center for your product is available from
one of the following URLs:
Procedure
To check your connection to the information center, complete
the following steps:
- Open the Preferences dialog
- Select Help -> Content
- Ensure that Include help content from a remote
infocenter is selected.
- Ensure that the URL for your product information center
is in the list of available information centers. If your information
center is not listed, complete the following steps:
- Click Add
- In the Name field, enter a name
for the connection.
- In the Host field, enter publib.boulder.ibm.com
- In the Path field, enter one
of the following paths, depending on your product:
Product |
Path |
InfoSphere Data
Architect |
/infocenter/rdahelp/v7r5 |
Data Studio (IDE package) |
/infocenter/idmhelp/ds-v2r2 |
Optim Database
Administrator |
/infocenter/idmhelp/admin-v2r2 |
Optim Development
Studio |
/infocenter/idmhelp/dev-v2r2 |
Optim Query
Tuner client |
/infocenter/idmhelp/tune-v2r2 |
- Select Use default port
- Click OK
- Select the entry for your product information center.
- Click Test Connection.
Installing help content locally with the Local Help Updater
This topic explains how to download, remove, and update
help content with the Local Help Updater. Most help content is not
installed when you install your product. To access all help content
locally, you need download it, either from the product's public
remote update site or using a update site ZIP file.
Before you begin
During installation, select the help access option, Download
help and access the content locally.
If you did
not select this option during installation, change the help access method to
specify local download and install.
Procedure
To install local help content:
- Optional: For better performance, download
a ZIP file that contains update site files.
Although
this step improves performance during installation, if you install
local help this way you will not be automatically notified when updates
to your local help are available.
- Download the update site for the documentation you want
to install from the following Web page: http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/
- Extract the ZIP file to a temporary directory.
- With your product open, click Help -> Local Help Updater. The Updater site opens.
- Specify the location of the help that you want to download.
- If you downloaded and extracted a ZIP file, add the location
of the extracted update site on the Internal Sites tab.
Click the Add toolbar button, verify that the Local radio
button is checked, then browse to the location of the update site
and select the site.xml file.
- To specify the location of the public update site for your
product, select your product name from the list on the Public
Sites tab.
- The Available Features list will be populated with a list
of the help that is available for download. If you are using a public
update site, this might take a few minutes. Select the help content
that you need.
- Click Install. The
help content is downloaded and installed. A progress bar opens and
tracks the status of the download.
- When the download is completed, open the help in the product
by selecting Help -> Help
Contents.
Results
The help that you selected is installed on your system.
Updating help content
Use the Local Help Updater to ensure that you have the
latest help content.
Before you begin
You have installed
help content locally, using a public update site.
About this task
Updates are automatically installed each time you start
the product, if you have an Internet connection and you used a public
update site to install the content locally.
If you downloaded
a ZIP file containing an update site for better performance during
installation, you will not be notified by the Local Help Updater when
new help content is available. You can check for updates at this Web site, or you can monitor the product
support page for technotes announcing new help content.
Procedure
To update the help without restarting the product, complete
the following steps:
- Close the product help system window.
- Open the Local Help Updater by selecting Help -> Local Help Updater. The Updater site opens.
- Click the Installed Features tab.
- Click Search for Updates. If updates to the content you have installed are available,
they are installed to your system. A progress bar indicates the status
of the request.
- When the update is completed, open the help in the product
by selecting Help -> Help
Contents.
Removing help content
You can use the Local Help Updater to remove installed
help content.
Before you begin
You have downloaded help features using the Local Help Updater.
Procedure
To remove installed help content, complete the following
steps:
- Close the product help system window.
- Open the Local Help Updater by clicking Help -> Local Help Updater. The Updater site opens.
- Click the Installed Features tab.
- Select the features that you want to remove, then click Remove The help features you selected are removed from your system.
A progress bar indicates the status of the request.
- When the removal is completed, open the help in the product
by selecting Help -> Help
Contents.
Setting up an intranet server for help content
You can set up an intranet server behind a firewall to
provide help content to users. In this way, users do not have to download
and save help content to their computers.
Before you begin
You have a server available that can be accessed by users
behind a firewall.
About this task
See the Installation Manager information center for
the instructions for setting up an intranet server for help content.
The
WAR file that is needed to set up IBM
Data Studio (IDE package) help
on an intranet server is located on the product DVD, in the enterprise folder.
Changing the way you access help content
You can change the way that you access help content.
Before you begin
During
the installation process, a help content access method was selected.
However, you can modify your preferences to change the help content
access method at any time. Close the help browser before you change
the way you access help content.
Procedure
To change the way that you access help content, complete
the following steps:
- Click Windows -> Preferences. The Preferences window opens.
- Expand the Help entry, and then
click Content. A list of the information center
or centers opens. Depending on the access method that was chosen,
complete one of the following procedures.
- To access help content on an intranet server, follow these
steps:
- Click Add; then name the intranet
connection, specify the intranet URL for the server that contains
the help content, and then click OK.
- Disable any other remote infocenters.
- Click OK to close Preferences.
- Click Help -> Help
Contents, to open your help.
- To download and access help content locally, follow these
steps:
- Ensure that Include help content from a remote
infocenter is selected.
- Enable the Local option, or complete the next step if
the Local option is not available.
- Click Add; then enter a name
for the local help connection. Specify the localhost Host IP address 127.0.0.1 and
path /help. Select any unused port number,
and then click OK.
- Disable any other remote infocenters.
- Save any work and close and restart the product.
- Follow the instructions in Installing help content locally with the Local Help Updater to download help content.
- To access help content from an IBM Web
site, follow these steps:
- Ensure that Include help content from a remote
infocenter is selected.
- Click Add; then name the connection,
specify the Internet URL for the IBM Web
site that contains the help content, and then click OK.
This URL might already be available in the list of connections. If
it is listed, select the connection and click Enable.
- Disable any other remote infocenters.
- Click OK to close Preferences.
- Click Help -> Help
Contents, to open your help.
Configuration for remote operations
To use the workbench to run SQL statements, utilities,
and commands, or to browse and access files, on remote servers, the DB2 Administration Server (DAS),
the Secure Shell (SSH) protocol, or the Microsoft Windows Server
Message Broker (SMB) protocol and the Secure File Transfer (SFTP)
protocol must be properly configured.
Depending on the operating system of the target server on which
you want to run commands or utilities, the workbench uses the DB2 Administration Server (DAS),
the Secure Shell (SSH) protocol, or the Microsoft Windows Server
Message Broker (SMB) protocol. The following table shows which protocol
the workbench uses:
Table 4. Protocol that is used to run commands and utilities on remote servers
Operating system |
Method for remote commands and utilities |
Windows |
When connecting to a local database on Windows, DAS is used.
When
connecting to remote databases, SSH is first attempted. If SSH is
unavailable or is not set up properly, then DAS is attempted, with
these exceptions:
- For remote DB2 for Linux, UNIX, and Windows V9.7
servers, protocols are attempted in the following order: SSH, SMB,
and then DAS.
- For remote DB2 for Linux, UNIX, and Windows V8.2
servers, only DAS is used.
|
Linux or UNIX |
SSH is used. |
When you browse and access remote file systems, the SFTP protocol
is always used. When you browse for files remotely on a Windows system from within the workbench
product, you must look in the default directory (/cygdrive/c)
to find the Windows drives
and the associated file systems paths. No other Windows file system directory paths are valid
when you use the workbench product to run commands.
Requirements for DAS or SSH and SFTP on the local
client
To use DAS, a connection to a locally installed DB2 database or connection to a DB2 UDB Administration Client (DAC)
is required. If you do not have a locally installed DB2 database, DAC is required to communicate
with the IBM Data Server Client
and the DB2 Administration Server
(DAS).
You must also have connectivity to the DAC that is running
on the same machine as the database. You need a connection to the
DAC to communicate with the IBM Data
Server Client and the DB2 Administration
Server (DAS). The IBM Data Server
Client connectivity libraries can be provided by either of the following
ways:
- By a local DB2 instance
- By the DAC
In either case, make sure the bin directory is in the
path before you start the workbench. (In Linux, this is handled by sourcing $INST_HOME/sqllib/db2profile.)
The DB2 UDB Administration Client
is available from developerWorks® at http://www.ibm.com/developerworks.
For
example, to install the IBM Data
Server Client on a Linux system,
complete the following steps:
- Install the IBM Data Server
Client.
- Create a DB2 instance.
- Source db2profile in $INST_HOME/sqllib/ before you start the workbench.
(For example, add it to your .bashrc.)
To use the SSH and SFTP protocols, no additional configuration
is required on the client. The workbench product comes pre-configured
with an SSH and SFTP client.
Requirements for DAS, SSH, or SMB and SFTP on the
remote server
To use DAS on a Windows system, the DB2 Administration Server (DAS) must be started,
and port 523 must be open.
To use the SSH and SFTP protocols
on Linux or UNIX system, the SSH and SFTP daemons must be
started. If they are not running, start them or ask your system administrator
to start them. SSH requires that port 22 be open.
To use the
SSH and SFTP protocols on a Windows system,
an OpenSSH environment must be set up. The workbench supports SSH
communication to DB2 for Linux, UNIX, and Windows servers
that run in a Cygwin emulation environment through Portable Operating
System Interface for UNIX (POSIX).
In its Open Source distribution, the Cygwin environment includes the
OpenSSH server implementation of the SSH and SFTP protocol (Cygwin
Net packages openssl, openssh). The workbench uses the Secure File
Transfer protocol (SFTP) for all file system browsing and remote file
transfer. Therefore, SFTP must be enabled.
Setting up the OpenSSH
environment on a target server that runs on a Windows system requires installing Cygwin,
configuring the daemon to run as an automatic service, and synchronizing
the Cygwin environment user accounts and groups with the Operating
System user repository to allow remote log in to the remote Windows system. You can download
and install Cygwin from http://cygwin.com.
For information about installing and configuring Cygwin on a Windows server, see Installing Cygwin on a Windows server and Configuring Cygwin on a Windows server.
To use SMB on a Windows system, port 445 must
be open. SMB also has the following requirements:
For more information about the configuration that is required
for the various editions of the Windows operating
system for SMB, see Configuring Windows operating
systems for using SMB.
Installing Cygwin on a Windows server
The following instructions for installing Cygwin are provided
for your convenience and to ensure that your Cygwin environment works
correctly with Data Studio.
About this task
These instructions are based on Cygwin 1.5.25-15. Over time,
changes occur that might make these instructions inaccurate. For the
most current instructions for installing Cygwin, see the official
documentation for Cygwin at http://cygwin.com.
Procedure
To install Cygwin, complete the following steps:
- Go to http://cygwin.com.
- Click Install or update now, and
click Run when you are prompted to run or save
the file.
- On the Cygwin Net Release Setup Program dialog, click Next.
- Specify C:\cygwin as the directory
into which to install Cygwin, and click Next.
Attention: Choosing a different installation directory
can result in the Cygwin environment not working correctly with
Data Studio.
- Optional: Select a directory into which to store the downloaded
installation files, and click Next.
- Select an ftp download site, and click Next. The Select Packages list is displayed.
- Select the packages to include in your installation. The
Base package is included by default. In addition to the Base package,
select the following packages to include:
- Expand the Admin category, and
click the icon for cygrunsrv: NT/W2K service initiator.
- Expand the Net category, and
click the icon for openssh. When
you select openssh, openssl is
automatically selected.
- Click Next.
The package files are downloaded and stored in the specified
directory. When the downloading is complete, Cygwin is installed.
What to do next
After Cygwin is installed, you must configure CYGWIN sshd
to run as an automatic service, and then you must start the service.
Configuring Cygwin on a Windows server
After Cygwin is installed, you must configure CYGWIN sshd
to run as an automatic service, start the service, and update Cygwin
environment user accounts and groups for users to log in to the remote
server on the Windows system.
Procedure
To configure your Cygwin environment to work correctly
with the workbench, complete the following steps:
- Right click My Computer, and click Properties -> Advanced -> Environment Variables to modify
the PATH variable and to create a new environment variable. In either
the User or System variables section (use the System variables if
any account using this machine can use Cygwin):
- Select the PATH variable, click Edit,
and append ;c:cygwin\bin to the end of the
existing variable string.
- Click New to add a new environment
variable that is named CYGWIN. In the Variable name text
box, enter CYGWIN, and in the Variable
value text box, enter binmode tty ntsec.
- Save the changes by clicking OK until
the My Computer window closes.
- Start Cygwin. You can double-click the shortcut on your
desktop if one was created when you installed Cygwin. A
command window is opens.
- Run the ssh-host-config command by typing ssh-host-config after
the $ prompt.
By default, privilege separation is set
to Yes when OpenSSH 3.3 or newer versions are used. You must specify
No to the privilege separation option and set the service to allow
public key authentication that uses the sshd-server account.
Respond
to the prompts that are displayed as follows:
- When you are asked Query: Should privilege
separation be used?, enter no.
- When you are asked Query: Do you want to
install sshd as a service?, enter the appropriate response
based on your environment:
- Enter yes to install sshd as a service.
- Enter no if sshd is already installed as
a service.
- When you are asked Query: Enter the value
of CYGWIN for the daemon: [ntsec], enter ntsec
tty.
- Start the sshd service. In a Windows command prompt, type net
start sshd or, in a bash prompt, type cygrunsrv
-start sshd. To verify that the sshd service
is running, you can type ps -a and check that
/usr/sbin/sshd is in the list of running processes, or you can click Control Panel -> Administrative Tools -> Control Services to do this
checking.
To stop the service, in a Windows command prompt, type net
stop sshd. Alternatively, you can change to the C:\cygwin\bin directory
(or open a bash shell) and type cygrunsrv -stop sshd.
- After start the service, test the service by entering the
following information from a bash prompt: ssh localhost
-l your_username. If you are informed that the authenticity
of localhost cannot be established and are asked Are you
sure you want to continue connecting?, enter yes.
When you are prompted for your account password on localhost, enter
the password that you use when you log on to the computer.
- Create the accounts that will be able to log in to the
computer:
- Create the Windows accounts
first. Click Start -> Settings -> Control Panel -> User Accounts. Make each user a member of the Administrators group.
Complete this step for each user that you want to add before you create
the corresponding Cygwin accounts.
- Make a backup copy of the /etc/passwd file.
- Synchronize the Cygwin environment user accounts with
the operating system user repository. Run the following command: mkpasswd
-l > /etc/passwd
- After the users and groups are synchronized in the Cygwin
environment, stop and start the sshd service The sshd service
reads the /etc/passwd only when the service starts again, which causes
the account for a user to be recognized.
- If you need to create groups of accounts, create the Windows groups first. Then synchronize
the Cygwin user groups. After creating the Windows groups, run the following command: mkgroup
-l > /etc/passwd. When you add groups, you also
need to stop and start the sshd service to have the new group recognized.
- Verify that the Cygwin sshd service has been added as a
service that starts automatically. To complete this verification,
click Start -> Settings -> Control Panel -> Administrative Tools -> Services.
Configuring Windows operating
systems for using SMB
When you use the workbench to run utilities and commands
on a remote server and the Microsoft Windows Server Message Broker
(SMB) protocol is used, additional configuration of the Windows operating system might be required,
depending on the edition of the Windows system.
About this task
For information about when the SMB protocol is used, see Configuration for remote operations.
To use the Microsoft Windows Server Message Broker
(SMB) protocol on a Windows XP
system, you might need to disable firewalls.
About this task
Windows XP includes
a built-in firewall called the Internet Connection Firewall (ICF).
By default, ICF is disabled on Windows XP
systems. Windows XP Service
Pack 2 comes with the Windows Firewall
enabled by default. If either firewall is enabled on a Windows XP target, the firewall will block
attempted accesses by Optim Database
Administrator.
Procedure
To allow access on Windows XP
Service Pack 2, select the File and Printer Sharing box
in the Exceptions tab of the Windows Firewall
configuration.
For Windows 2008
operating systems, shares must be shared for the Guest or Everyone
accounts, and password protected sharing must be disabled for the Microsoft Windows Server Message Broker (SMB) protocol
to be used.
Procedure
To disable password protected sharing, complete the following
steps:
- Click Control Panel -> Networking and Sharing Center.
- Click the down arrow that is next to Password
protected sharing.
- Click Turn off password protected sharing.
- Click Apply, and exit the control
panel.
What to do next
In addition, you might need to disable User Account Control
if your account is not a domain user account. For information about
disabling User Account control, see Configuring Windows Vista
operating systems for using SMB.
For Windows Vista
operating systems, shares must be shared for the Guest or Everyone
accounts, and password protected sharing must be disabled for the Microsoft Windows Server Message Broker (SMB) protocol
to be used.
Procedure
To disable password protected sharing, complete the following
steps:
- Click Control Panel -> Networking and Internet -> Networking
and Internet.
- Click the down arrow that is next to Password
protected sharing.
- Click Turn off password protected sharing.
- Click Apply, and exit the control
panel.
What to do next
The new User Account Control feature in Windows Vista requires users to complete
several steps before Optim Database
Administrator can communicate with Windows Vista
targets. If you have a domain user account, ensure that the local
and the target machine are both members of a Windows domain. If you are a member of a
local administrators group and you use a local user account, complete
the following three steps to be able to perform administrative tasks
on the target machine:
- Enable the built-in Administrator account and use it to connect.
To enable the built-in Administrator account, open the Windows Control Panel and click Administrative Tools -> Local Security
Policy -> Local Policies -> Security
Settings -> Security Options. Then double-click on Accounts: Administrator
account status, and select enable.
- Disable User Account Control if a different Administrator user
account is to be used to connect to the Vista target. To disable User
Account Control, open the Windows Control
Panel and click Administrative ToolsLocal
Security PolicyLocal PoliciesSecurity
Settings Security Options. Then
double-click on User Account Control: Run all administrators
in Admin Approval Mode, and select disable.
Changing this setting requires a system reboot.
- Disable User Account Control when you administer a workstation
with a local user account (Security Account Manager user account).
Otherwise, you will not connect as a full administrator and will not
be able to perform administrative tasks.
To disable User Account
Control, complete the following steps:
- Click Start, click Run,
type regedit, and then press Enter.
- Locate and click the following registry subkey: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System
- If the LocalAccountTokenFilterPolicy registry entry does not exist,
follow these steps:
- On the Edit menu, point to New, and then click DWORD
Value.
- Type LocalAccountTokenFilterPolicy, then
press Enter.
- Right-click LocalAccountTokenFilterPolicy,
then click Modify.
- In the Value data box, type 1,
then click OK.
- Restart your computer.
Alternatively, you can modify the registry entry manually by
typing the following command from a command line: cmd /c
reg add HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\system
/v LocalAccountTokenFilterPolicy /t REG_DWORD /d 1 /f
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.
Before you begin
By default, Internet access is required unless the repository
preferences points to a local update site. See the Installation Manager
help for more information.
Note:
Close all programs that were installed
using Installation Manager before modifying.
Procedure
To modify an installed product package, complete the
following steps:
- Start IBM Installation
Manager.
- On the Start page, click Modify.
- In the Modify Packages wizard, select the product package
group and click Next.
- 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.
- On the Features page, select the features that you want
to install or remove. Some products do not have optional features.
- To learn more about a feature, click the feature and
review the brief description under Details.
- 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.
- Click Next
- On the Summary page, review your choices before modifying
the installation package and click Modify.
- Optional: When the modification process completes,
click View Log File to see the complete log.
- 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.
Before you begin
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.
Procedure
To find and install product package updates, complete
the following steps:
- Start IBM Installation
Manager.
- On the Start page of IBM Installation
Manager, click Update.
- 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.
- 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.
- 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:
- To display all updates found for the available packages,
click Show all.
- 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.
- 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.
- Click Next.
- 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.
- On the Features page, select the features that you want
to update and complete the following steps:
- To learn more about a feature, click the feature and
review the brief description under Details.
- 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.
- Click Next
- On the Summary page, review your choices before installing
the updates.
- If you want to change the choices you made on previous
pages, click Back, and make your changes.
- When you are satisfied, click Update to
download and install the updates. A progress indicator shows the percentage
of the installation completed.
- 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.
- Click Finish to close the wizard.
- 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.
Before you begin
During the rollback process, Installation Manager must access
files from the earlier version of the package. By default, these files
are stored on your computer when you upgrade to a new package. If
you have deleted the files that are saved locally for rollback or
cleared the Save files for rollback check box
in the Preferences page (File > Preferences > Files for
Rollback) while upgrading, you will not be able to roll
back to the previous version without the media or repositories that
were used to install that version of the package.
About this task
Use the rollback feature if you have applied an update
to a product package and decide later that you want to remove the
update and revert to the earlier version of the product. When you
use the rollback feature, Installation Manager uninstalls the updated
resources and reinstalls the resources from the previous version.
You can only roll back one version level at a time.
For more
information, see the Installation Manager online help or Information
Center.
Procedure
To revert an update to a previous version, complete the
following steps:
- Start IBM Installation
Manager.
- On the Start page, click Roll Back.
- 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.
- Follow the instructions in the wizard.
Uninstalling software
You can use the Uninstall option
in IBM Installation Manager
to uninstall software that were installed by using Installation Manager
from your computer.
About this task
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.
Before you begin
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.
Procedure
To uninstall a product package, complete the following
steps:
- Start IBM Installation
Manager.
- On the Start page click Uninstall.
- On the Uninstall Packages page, from
the Installation Packages list, select the
product package that you want to uninstall and click Next.
- 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.
- Click Finish.
Uninstalling IBM Installation
Manager
You can follow the instructions below to uninstall IBM Installation Manager.
Before you begin
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.
About this task
To uninstall Installation Manager, complete the following
steps:
- To uninstall Installation Manager from Windows, complete the following steps: :
- Click Start -> Control
Panel.
- In the Control Panel window, click Add
or Remove Programs.
- In the Add or Remove Programs window, select IBM
Installation Manager and click Remove.
- In the Add or Remove Programs dialog box,
click Yes to continue with the removal.
- To uninstall Installation Manager from Linux, complete the following steps:
- Open a terminal window and run /var/ibm/InstallationManager/uninstall/uninstall if
this was an installation by root.
- In the IBM Installation
Manager Uninstall Packages wizard, click Next;
then click Uninstall.
Notices
Note to U.S. Government Users Restricted Rights - Use, duplication
or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
This information was developed for products and services offered
in the U.S.A. IBM may not offer the products, services, or features
discussed in this document in other countries. Consult your local IBM representative
for information on the products and services currently available in
your area. Any reference to an IBM product,
program, or service is not intended to state or imply that only that IBM product,
program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual
property right may be used instead. However, it is the user's responsibility
to evaluate and verify the operation of any non-IBM product, program,
or service.
IBM may have patents or pending patent applications
covering subject matter described in this document. The furnishing
of this document does not grant you any license to these patents.
You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information,
contact the IBM Intellectual Property Department in your country
or send inquiries, in writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, Japan
The following paragraph does not apply to the
United Kingdom or any other country where such provisions are inconsistent
with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES
THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Some states do not allow disclaimer of express or implied warranties
in certain transactions, therefore, this statement may not apply to
you.
This information could include technical inaccuracies or typographical
errors. Changes are periodically made to the information herein; these
changes will be incorporated in new editions of the publication. IBM may
make improvements and/or changes in the product(s) and/or the program(s)
described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided
for convenience only and do not in any manner serve as an endorsement
of those Web sites. The materials at those Web sites are not part
of the materials for this IBM product and use of those Web sites
is at your own risk.
IBM may use or distribute any of the information
you supply in any way it believes appropriate without incurring any
obligation to you.
Licensees of this program who wish to have information about it
for the purpose of enabling: (i) the exchange of information between
independently created programs and other programs (including this
one) and (ii) the mutual use of the information which has been exchanged,
should contact:
Intellectual Property Department
IBM Corporation
Silicon Valley Lab
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.
Such information may be available, subject to appropriate terms
and conditions, including in some cases, payment of a fee.
The licensed program described in this documentation and all licensed
material available for it are provided by IBM under
terms of the IBM Customer Agreement, IBM International
Program License Agreement or any equivalent agreement between us.
Information concerning non-IBM products was obtained from the suppliers
of those products, their published announcements or other publicly
available sources. IBM has not tested those products
and cannot confirm the accuracy of performance, compatibility or any
other claims related to non-IBM products. Questions on the capabilities
of non-IBM products should be addressed to the suppliers of those
products.
All statements regarding IBM's future direction or intent are subject
to change or withdrawal without notice, and represent goals and objectives
only.
Trademarks and service marks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks
of International Business Machines Corporation in the United States,
other countries, or both. These and other IBM trademarked terms are
marked on their first occurrence in this information with the appropriate
symbol (® or ™), indicating US registered or common law trademarks
owned by IBM at the time this information was published. Such trademarks
may also be registered or common law trademarks in other countries.
A complete and current list of IBM trademarks is available on the
Web at http://www.ibm.com/legal/copytrade.shtml
Microsoft and Windows are trademarks of Microsoft Corporation in
the United States, other countries, or both.
Linux is a trademark of Linus Torvalds in the United States, other
countries, or both.
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.