Comprehensive install and uninstall information

The information in this section describes how to install WebSphere Business Integration Adapters (WBIA).

You install the WBIA product by running a platform-specific executable for the installer. Table 5 lists the installer executable for each operating system. The installer executables are located in the WebSphereBI directory on the product CD.


Table 5. Platform-specific executables for WBIA Installer

Operating system WBIA Installer executable file
Windows setupwin32.exe
AIX setupAIX.bin
Solaris setupsolarisSparc.bin
HP-UX setupHP.bin

You can use the installer executable file to perform the installation in the following ways:

Note:
These procedures assume that you are installing from a product CD. If you obtain your software from Passport Advantage, make sure you have downloaded it. Refer to your Passport Advantage information for those downloading instructions.
Note:
If you are installing the adapters to communicate with InterChange Server, you must install the broker first. See the installation guide for InterChange Server on the appropriate platform for information on how to install the broker.
Important:
Make sure you are logged in as the WebSphere business integration system administrator before you install the adapters. When you install on a UNIX computer, the permissions of the folders and files that are created are set based on the permissions of the user account that performs the installation.
Important:
You must not install WBIA as root. The entry that is added to the Object Data Manager (ODM) when installing as root prevents you from using SMIT to uninstall other applications, so you should not install WBIA as root.

Invoking the graphical WBIA Installer

The graphical WBIA installer presents you with a wizard that allows you to make choices about the installation of the WBIA product. Although the installer is Java-based and therefore platform-independent, there are different ways of invoking the installer for each platform. This section describes the approaches for both Windows and UNIX computers.

Invoking Installer in a Windows environment

To invoke Installer in a Windows environment, navigate to the WebSphereBI directory of the product CD and execute setupwin32.exe.

Invoking Installer in a UNIX environment

The WBIA installer in a UNIX environment is invoked through a .bin file specific to the platform, located in the WebSphereBI directory. Table 5 provides the name of the .bin file for each platform.

Follow the steps in one of the following sections to invoke the installer depending on how you are working with the UNIX computer:

If you are running CDE on the UNIX computer

If you are running the Common Desktop Environment (CDE) and working on the UNIX computer directly then you can navigate to the WebSphereBI directory of the product CD and double-click the .bin file specific to the operating system.

You can also navigate to the WebSphereBI directory of the product CD and execute the .bin file at the command line. The following example shows how to do so on a Solaris computer:

# ./setupsolarisSparc.bin

If you are connecting to the UNIX computer through X emulation software

If you are using a Windows computer to connect to the UNIX computer through X emulation software do the following to invoke the installer:

  1. Determine the IP address of the Windows computer that you are using to connect to the UNIX computer.

    You can execute the ipconfig command at the Windows command line interface to display the IP address of the Windows computer.

  2. Set the DISPLAY environment variable on the UNIX computer to the IP address determined in step 1.

    You must be sure to follow the IP address with a colon and the identifier for the monitor or display on the Windows client computer. If the Windows client computer only has a single monitor then the display value is 0.0.

    The following example shows the DISPLAY environment variable being set to the single monitor on a Windows computer whose IP address is 9.26.244.30:

    DISPLAY=9.26.244.30:0.0
    
  3. Export the DISPLAY environment variable by executing the following command:
    export DISPLAY
    
  4. Start the X emulation client on the Windows computer and connect to the UNIX computer.
  5. Navigate to the WebSphereBI directory of the product CD at the command line of the X emulation client.
  6. Execute the .bin file specific to the operating system. For example, if the UNIX computer was running AIX then you would execute the following command:
    # ./setupAIX.bin
    

    The graphical installer starts on the Windows computer that you are using to connect to the UNIX computer.

Using the graphical WBIA Installer

Once running, the WBIA Installer prompts you to make your installation choices and then performs the installation.

When you select an adapter to install, the runtime components and the data handlers required to support it are automatically selected for installation. However, if Installer determines that current versions of the runtime components are already on the system, then they are not installed.

Note:
If you click Cancel while the business integration adapters are installing, some files will still appear in the newly created directory. The number of files depends on how far the process had progressed before installation was canceled.

Do the following to proceed through the installer:

  1. At the "language selection" prompt, choose the desired language from the drop-down menu and click OK.




  2. At the "Welcome" screen click Next.




  3. At the "IBM License Acceptance Panel", click I accept the terms in the license agreement and then click OK.




  4. At the "broker selection" screen click the radio button for the type of integration broker with which the adapters will communicate and then click Next.




  5. At the "installation directory" screen, either type the full path of the directory into which the adapters should be installed, click Browse to select a directory, or accept the default path, then click Next.
    Important:
    You must specify an installation directory that does not have spaces in the path.

    Table 6 shows the default adapter installation directories for the different integration brokers on the different supported platforms.


    Table 6. Default adapter installation directories

    Broker type Default Windows directory Default UNIX directory
    WebSphere MQ Integrator Broker C:\WebSphereAdapters /$HOME/WebSphereAdapters
    WebSphere InterChange Server C:\IBM\WebSphereICS /$HOME/IBM/WebSphereICS
    WebSphere Application Server C:\WebSphereAdapters /$HOME/WebSphereAdapters




    Important:
    If your broker is WebSphere InterChange Server then you must specify the WebSphere InterChange Server product directory at this screen. If you do not specify the same directory for the adapter installation as for the broker installation then the adapters will not be able to run.
  6. If you selected WebSphere InterChange Server as your broker in step 4 then Installer presents an informational screen at this time. Read the information and then click Next.




  7. At the "component selection" screen, enable checkboxes for the adapters and features you want to install and then click Next.




    Different features are available for installation depending on the broker. For instance, if you chose WebSphere MQ Integrator Broker or WebSphere Application Server as your broker then the adapter runtime and tools are available for selection. If you chose WebSphere InterChange Server, though, these are not available because the tools and runtime are installed as part of the broker installation.

    Different features are also available for installation depending on the operating system. For example, the tools are only supported in Windows environments and are therefore only available for selection when you run the installer on a Windows computer.

  8. The "summary" screen lists the features selected for installation, the specified product directory, and the amount of disk space required. Read the information to verify it and then click Next.




  9. Do the following depending on which broker you selected during step 4:
  10. If the following are true then Installer next presents the "workbench selection" screen where you specify how you want the tools required to work with the integration components installed:

    Choose Add System Manager files to an existing Workbench installation if you want to add the plug-ins to an existing installation of WSADIE 5.0.1. You will be required to specify the product directory of the existing installation of WSADIE 5.0.1 at the next Installer screen, as described in step 11.

    Important:
    The plug-ins will not work if there are spaces in the path of the workbench product directory. If there are spaces in the path of your existing WSADIE 5.0.1 installation then you must not make this installation choice.

    Choose Install Workbench with System Manager files if you want to install WebSphere Studio Workbench 2.0.3 and add the plug-ins to that installation. The workbench is installed in a subdirectory of the adapter installation directory named Tools\WSWB203 if you make this selection.

    Click Next after making your selection.




  11. If you were presented with the "workbench selection" screen as described in step 10 and you chose Add System Manager files to an existing Workbench installation then Installer next presents the "workbench installation directory" screen. Type the path to the WSADIE 5.0.1 product directory or click Browse to select the directory, then click Next.
    Important:
    The plug-ins will not work if there are spaces in the path of the workbench product directory. If there are spaces in the path of your existing WSADIE 5.0.1 installation then you must click Back and select Install Workbench with System Manager files instead.




  12. If you are installing on a Windows computer then installer next presents the "select program folder" screen. Type the name of the program group in which shortcuts for the adapters should be created or accept the default program group and then click Next.




  13. After Installer finishes successfully, click Finish.

Performing a silent installation

You can perform a silent installation of WBIA, where you provide your installation choices in a file rather than at the screens of the installation wizard. This is particularly helpful when you have to perform multiple installations that are identical.

To perform a silent installation, first create a file with your installation choices as described in Preparing the installation response file and then perform the installation using the file as described in Executing the silent installation.

Preparing the installation response file

When performing a silent installation, you prepare a response file that contains your installation choices. IBM provides four response file templates that contain the options for different combinations of integration broker and platform support. The response file templates are located in the WebSphereBI directory on the product CD. Table 7 lists the response file templates for each combination.

Table 7. Response files templates

Integration broker and platform combination Response file template
WebSphere InterChange Server on Windows: settings_WBIAInstaller_ICS.txt
WebSphere Application Server and WebSphere MQ Integrator Broker on Windows: settings_WBIAInstaller_WSMQ.txt
WebSphere InterChange Server on UNIX: settings_WBIAInstaller_ICS_unix.txt
WebSphere Application Server and WebSphere MQ Integrator Broker on UNIX: settings_WBIAInstaller_WSMQ_unix.txt

Table 8 lists the options that can be used during a silent installation. Be sure to read all the information in the Option values column, as it specifies when particular options should be commented out and what the broker and platform compatibilities are.

Table 8. Silent installation options

Option name Option values
brokerType.brokerSelection

Set to 1 for WebSphere MQ Integrator Broker.

Set to 2 for WebSphere InterChange Server.

Set to 3 for WebSphere Application Server.

setWINICSDest.value

Set to the directory path in which InterChange Server is installed.

If you leave this option commented, the product installs to the default directory listed in Table 6.

This option is only relevant for the WICS broker when installed on Windows. Make sure it is commented out when installing for the WMQI or WAS brokers, or when installing on a UNIX computer.

setWINWMQIDest.value

Set to a valid directory path, without spaces, to specify the location in which the WBIA product should be installed.

If you leave this option commented, the product installs to the default directory listed in Table 6.

This option is only relevant for WMQI and WAS brokers when installed on Windows. Make sure it is commented out when installing for the WICS broker, or when installing on a UNIX computer.

setUnixICSDest.value

Set to the directory path in which InterChange Server is installed.

If you leave this option commented, the product installs to the default directory listed in Table 6.

This option is only relevant for the WICS broker when installed on UNIX. Make sure it is commented out when installing for the WMQI or WAS brokers, or when installing on a Windows computer.

setUnixWMQIDest.value

Set to a valid directory path, without spaces, to specify the location in which the WBIA product should be installed.

If you leave this option commented, the product installs to the default directory listed in Table 6..

This option is only relevant for WMQI and WAS brokers when installed on UNIX. Make sure it is commented out when installing for the WICS broker, or when installing on a Windows computer.

-P main_product.active

Set to true to install all of the components available in the WBIA product.

Set to false to install selected components.

-P f_connectors.active

Set to true to install all adapters.

Set to false to install specified adapters.

-P adaptorFrameWork.active

Set to true for adapters to work with WMQI and WAS brokers.

Comment out this option when installing for the WICS broker.

-P WindowEnvSetup.active

Set to true for adapters to work with WMQI and WAS brokers.

Comment out this option when installing for the WICS broker or when installing on UNIX.

-P support.active

Set to true for adapters to work with WMQI and WAS brokers on UNIX.

Comment out this option when installing for the WICS broker or when installing for the WMQI or WAS brokers on Windows.

-P supportFileRequirement.active

Set to true for adapters to work with WMQI and WAS brokers on UNIX.

Comment out this option when installing for the WICS broker or when installing for the WMQI or WAS brokers on Windows.

-P frameworkTOOLS.active

Set to true when WMQI is the broker and Windows is the platform to install the tools used to work with the installed components.

Set to false if WICS or WAS are the broker, if the platform is UNIX, or if you do not want to install the tools.

-P adaptorDevelopmentKit.active

Set to true when WMQI is the broker and Windows is the platform to install the Adapter Development Kit, which provides the interfaces necessary to develop custom adapters.

Set to false if WICS or WAS are the broker, if the platform is UNIX, or if you do not want to install the Adapter Development Kit.

-P cn<adaptervalue>.active
Set to true to install a specific adapter, where adaptervalue is the value that identifies the adapter.

For example, cnJDBC identifies the Adapter for JDBC.

Refer to the response file templates for the available adapters and the values associated with them.

Not all adapters are available for all brokers and platforms.

Refer to the response file templates to determine if a particular adapter is available for that combination of broker and platform.

-P dataHandler.active

Set to true to enable installation of data handlers.

-P <datahandlervalue>.active

Set to true to install a specific data handler, where datahandlervalue is the value that identifies the data handler.

For example, xmlDataHandler identifies the XML data handler.

Refer to the response file templates for the available data handlers and the values associated with them.

Installer evaluates any data handler dependencies for selected adapters, so you do not have to specify data handlers to be installed just to satisfy adapter requirements. You would need to select data handlers for installation if you plan to use them for adapters you plan to develop and if the data handlers will not be installed by default.

-P AllDataHandlers.active

Set to true to install all data handlers.

Set to false to install specified data handlers.

-W mqDirectoryUserInput.mqLibraryLocation

Set to the path of the java\lib directory within the WebSphere MQ installation on the computer when installing for either the WMQI or WAS brokers.

Comment out this option when installing for the WICS broker.

Comment out this option if you want to use the default values. On the Windows platform, installer searches the Windows registry by default and uses the value it finds there. On the AIX platform, installer uses the default value /usr/mqm/java/lib. On the Solaris and HP-UX platforms, installer uses the default value /opt/mqm/java/lib.

-W workbenchChoice.workbenchList

Set to 1 to add the tools plugins to an existing installation of WebSphere Studio Workbench or WebSphere Studio Application Developer Integration Edition.

Set to 2 to install WebSphere Studio Workbench.

-W workbenchLocation.workbenchLocDirectory
If you specified that WebSphere Studio Workbench be installed by setting the value of the workbenchChoice.workbenchList option to 2, then set this option to the directory in which the workbench should be installed, for example C:\WebSphereAdapters\Tools.
-W inputServer.name

Set to the name of the InterChange Server instance with which the installed adapters will communicate. The name is case-sensitive and must be specified accurately or the adapters will not be able to communicate with the server.

You must make sure this option is not commented and is set to the proper value when installing adapters to communicate with the WICS broker. Comment out the option when installing for WMQI or WAS brokers.

-W inputShortcuts.folder

Set to the name of the program group created for the WBIA product, for example IBM WebSphere Business Integration Adapters.

This option is only relevant on the Windows platform. Comment out this option when installing on UNIX.

-W createReposFile.active

Set to true to create a file that contains the definitions for the components selected for installation.

Set to false to not create a file containing the definitions.

The definition files for individual components are still copied to the repository directory even if you choose not to create this comprehensive file.

-G replaceExistingResponse

Set to yesToAll or yes to replace all files found on the system that have the same name as those being copied by the installer.

Set to noToAll or no to not replace any files found on the system that have the same name as those being copied by the installer.

-G replaceNewerResponses

Set to yesToAll or yes to replace all files found on the system that are newer than those being copied by the installer.

Set to noToAll or no to not replace any files found on the system that are newer than those being copied by the installer.

-G createDirectoryResponse

Set to yes to create the product directory specified by the option if it does not already exist.

Set to no to not have the product directory created if it does not exist.

You must set this option to yes if the specified directory does not exist for the installation to succeed.

-G removeExistingResponse

This option is not relevant for any broker on any platform. Comment out this option.

-G removeModifiedResponse

This option is not relevant for any broker on any platform. Comment out this option.

You can modify one of the response file templates and use it for the silent installation. In this case you should be sure that any options that are incompatible with others you require are commented out by placing a hash symbol # in front of them. Alternatively, you can create a new response file with the options you require. This approach has the benefit that no unnecessary options or commented description blocks are present to clutter the response file, making it easier to read and edit. If you take this latter approach, it is recommended that you copy a template file and remove the sections and options that are not necessary, rather than typing the necessary options into a new file.

Executing the silent installation

To execute the silent installation, you run the platform-specific installer executable at the command line with several options, including the name of the response file you prepared.

The following example shows how to do so on a Windows computer where the response file template for the WAS and WMQI integration brokers is used, and exists in the C:\data directory:

D:\WebSphereBI>setupwin32.exe -silent -options 
C:\data\settings_WBIAInstaller_WSMQ.txt

The following example shows how to do so on an AIX computer where a custom response file named install.txt was used, and exists in the /home/icsadmin directory:

# ./setupAIX.bin -silent -options /home/icsadmin/install.txt

Installing additional adapters

To install additional adapters, run the WBIA Installer again. The word (installed) is displayed in the component selection screen next to all components that have already been installed on the system.

WBIA directories, files, and environment variables

Installer creates a number of directories, files, and environment variables depending on the selections you made while running Installer.

WBIA directories and files

After the installation is complete, you can view the file system and its contents. Table 9 lists some of the directories you might need to know about. The folders and files created vary depending on the choices made during the installation and on the operating system.

Table 9. WebSphere Business Integration Adapter directories

Directory name Contents
_jvm231
This directory contains the Java Runtime files.
Note:
If you are upgrading from a previous version of WBIA, the existing directory name is retained from that release.
_uninst_WBIA2.3.1
This directory contains files that are required to uninstall the WebSphere Business Integration Adapters product.

For more information on uninstalling WBIA, see Uninstalling WebSphere Business Integration Adapters.

Note:
If you are upgrading from a previous version of WBIA, the existing directory name is retained from that release.
bin
This directory contains the executable files and shell scripts that the business integration adapters use.
connectors
This directory contains files specific to each adapter in the system. It also contains adapter-specific files that you may need to install in the application that the adapter supports.
DataHandlers
This directory contains the .jar files for the data handlers.
DevelopmentKits
This directory contains the files needed to develop connectors.
legal
This directory contains the license files.
lib
This directory contains shared libraries and .jar files for the system.
logs
This directory is provided to contain log and trace files.
messages
This directory contains message text files used by the connectors to generate log and trace messages.
ODA
This directory contains the .jar and .bat files for each Object Discovery Agent.
repository
This directory contains the connector definition files.
templates
This directory contains sample script files for creating and clearing WebSphere MQ queues.

If your integration broker is WebSphere MQ Integrator Broker or WebSphere Application Server, see your broker implementation guide for more information on using these scripts.

If your integration broker is WebSphere InterChange Server, see the installation guide for InterChange Server on the appropriate platform.

Tools

This directory contains the WSWB203 directory, which in turn contains the installation of WebSphere Studio Workbench if you chose to install it.

Environment variables

If you chose WebSphere MQ Integrator Broker or WebSphere Application Server as your broker, Installer takes the actions described in Table 10 to create and update environment variables on the computer. These actions are not taken if you chose WebSphere InterChange Server as your integration broker, because the environment variables required for that broker are created during installation of the broker itself.

Table 10. Actions taken by Installer for environment variables

Environment variable name Installer action
CROSSWORLDS

Creates this environment variable to reference the WBIA product directory, as specified when using Installer.

MQ_LIB

Creates this environment variable to contain the path to the Java\lib directory within the WebSphere MQ installation, as specified when using Installer.

CLASSPATH Adds the following entries:

ProductDir\lib\rt.jar;
ProductDir\DataHandlers\CwDataHandler.jar;

PATH Adds the following entries:

ProductDir\bin\hotspot;
ProductDir\bin\classic;
ProductDir\bin;

Uninstalling WebSphere Business Integration Adapters

The method for uninstalling WBIA or selected adapters depends on how you installed the product.

If you installed the WBIA product from CD, follow the directions in Uninstalling adapters installed from CD.

If you installed the WBIA product using Electronic Software Delivery (ESD), follow the directions in Uninstalling adapters installed from ESD.

Uninstalling adapters installed from CD

You can uninstall adapters that were installed from a CD in the following ways:

Important:
The WBIA Uninstaller does not remove adapters installed from an ESD download. For information on removing adapters installed from an ESD download, see Uninstalling adapters installed from ESD.

Invoking the graphical WBIA Uninstaller

Follow the steps in one of the following sections to invoke the installer depending on the platform on which the WBIA product is installed:

To invoke the uninstaller in a Windows environment

Navigate to the ProductDir/_uninst_WBIA2.3.1 directory and execute the WBIA Uninstaller, uninstaller.exe.

To invoke the uninstaller in a UNIX environment

Navigate to the ProductDir/_uninst_WBIA2.3.1 directory and execute the WBIA Uninstaller, uninstaller.bin.

If you are running the Common Desktop Environment and are working directly on the UNIX computer then you can double-click the uninstaller.bin file.

If you are using X emulation software to connect to the UNIX computer from a Windows computer then you must execute the uninstaller.bin file from the command line, as in the following example:

# ./uninstaller.bin

Using the graphical WBIA Uninstaller

Using the WBIA Uninstaller, do the following to uninstall either the entire system or selected components:

  1. At the language selection prompt, choose the desired language from the drop-down menu and click OK.




  2. At the "Welcome" screen click Next.




  3. At the "component selection" screen, ensure that the components you want uninstalled have checkboxes next to them. By default all WBIA product components are selected for uninstallation; clear the checkbox for any component you want to leave installed, and then click Next.




  4. The "summary" screen lists the components that will be uninstalled and the product directory from which they will be removed. Read the information to verify it and then click Next.




  5. After Uninstaller finishes successfully, click Finish.

Performing a silent uninstallation

To perform a silent uninstallation, you run the platform-specific uninstaller executable in the _uninst_WBIA2.3.1 directory within ProductDir at the command line with the -silent option.

The following example shows how to do so on a Windows computer if the WBIA product is installed in C:\WebSphereAdapters:

C:\WebSphereAdapters\_uninst_WBIA2.3.1>uninstaller.exe -silent

The following example shows how to do so on an AIX computer:

# ./uninstaller.bin -silent
Note:
If you upgraded from a previous version of WBIA, the directory _uninst_WBIA2.3.1, was not created. The old _uninst_WBIA2.x.x uninstallation directory is retained but now contains upgraded contents.
Note:
Silent uninstallation does not uninstall adapters installed from an ESD. For information on how to uninstall adapters that were installed from an ESD, see Uninstalling adapters installed from ESD.

Uninstalling adapters installed from ESD

If you installed a WebSphere Business Integration Adapters adapter using Electronic Software Delivery (ESD), the uninstaller is in a directory labeled _uninstXXX , where XXX identifies the adapter it uninstalls. For example, the uninstaller for the WBIA adapter for JMS is located in a directory named _uninstJMS. To uninstall an adapter that you downloaded using ESD, do the following:

  1. From the command line, navigate to the appropriate uninstall directory.
  2. To launch the uninstaller for an adapter, execute the following command:
    java -cp uninstall.jar run
    

    Note:
    The Java Runtime Environment must be installed to run this command.
    Important:
    To uninstall the entire WebSphere Business Integration Adapters product, navigate to the ProductDir/_uninst_WBIA2.3.1 and execute the WBIA Uninstaller named Uninstaller.exe on Windows and uninstaller.bin on Unix.

Copyright IBM Corp. 1997, 2003