Installing adapters

Follow the instructions in one of the following sections to install an adapter if indicated by the procedural overview in Overview of installation:

Note that on UNIX platforms, filenames are case-sensitive. If you change the case of any filename, the adapter will fail during start-up and log an error. If you receive an error when you attempt to start the adapter, check the filenames of the XSD files in the Connector Configurator repository. The XSD files must have a lower-case .xsd extension. For example, a filename of Customer.XSD will cause the adapter to fail. In this case, you must change the name of the file to Customer.xsd.

Installing adapters using the graphical installer

Do the following to install an adapter using the graphical installer:

  1. Invoke Installer for your adapter as described in Invoking the graphical WBIA installer.
  2. At the language selection prompt, choose the desired language from the drop-down menu and click OK.
  3. At the Welcome screen click Next.
  4. At the IBM license acceptance screen, click I accept the terms in the license agreement and then click OK.
    Note:
    The Installer checks your system for certain software prerequisites at this point. If a prerequisite is not found, the Installer displays a screen informing you of this, and stating that the item must be installed before adapter installation can continue. Install the required software and restart the WebSphere Business Integration Adapters Installer.
  5. The product directory screen allows you to specify where to install the adapters.The adapter installer will try to locate the installation location of the Adapter Framework; if it finds it, this path will be displayed by default. If it does not find it, then the following defaults are displayed: For Windows: C:\IBM\WebSphereAdapters and for UNIX, /opt/IBM/WebSphereAdapters.

    You may specify another directory, but it must contain an installation of a compatible version of the Adapter Framework.

    For information on installing the Adapter Framework, see Installing the adapter framework. For more information on installing WebSphere InterChange Server, see the

    At the product directory screen, perform one of the following tasks:

  6. The summary screen lists the features that will be installed, the specified product directory, and the amount of disk space required. Read the information to verify it and then click Next.
  7. At the IBM WebSphere InterChange Server screen, do one of the following tasks depending on your integration broker:
  8. If you are installing on a Windows computer then Installer presents the program folder selection screen. In the Program Group field, type the name of the program group in which you want to create shortcuts for the adapters or accept the default program group and then click Next.
  9. After Installer finishes successfully, click Finish.

Note:
If your integration broker is ICS and it is installed on a remote system, you must move the adapter's configuration files to the ICS system. Doing so makes the adapter configuration files available to Connector Configurator on the remote ICS machine. To locate the adapter configuration files, see the installed file structure table in your adapter user guide. The configuration file is typically named <adapter name>ConnectorTemplate. Then move this file to the directory of the Connector Configurator instance that you will be running on the ICS host machine. For more information on the installed file structure of ICS and Connector Configurator, see the System Installation Guide for your platform. If you are not using an ICS integration broker, or if your ICS broker resides on the same machine as the adapter, you need not transfer adapter configuration files.

Installing adapters silently on Windows systems

Do the following to perform a silent installation of an adapter on Windows systems:

  1. Prepare a response file to install the adapter as described in Preparing the installation response file, using the desired options listed in Table 16.

    Table 16. Silent installation options for adapters for Windows systems

    Option name Option values
    -W destination.path
    

    Set this option to the directory path in which the WebSphere Business Integration Adapters product is to be installed. For example,

    -W destination.path="C:\IBM\WebSphereAdapters"
    

    The install path cannot contain any spaces. The install location must contain a compatible version of the adapter framework.

    -W inputServer.name
    

    If your broker is IBM WebSphere InterChange Server, specify a valid InterChange server name. This name must meet the following criteria: 1. Less than 80 characters. 2. Must not contain space. 3. Must begin with an English alphabetical character (a-z, A-Z). 4. Must contain only English alphabetical and numeric characters.

    If you are not using WebSphere Interchange Server as the broker, comment out this option.

    -W inputShortcuts.folder
    

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

    -W inputServer.adapterService
    

    Set this option to yes if you want the adapter to be registered as a Windows service. Set this option to no if you do not want the adapter to be registered as a Windows service.

    -G createDirectoryResponse= Set this option (yes or no) to specify whether to create the destination directory if it does not already exist.
    -G replaceExistingResponse
    

    Set this option 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 this option 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 this option to yesToAll or yes to replace all files found on the system that are newer than those being copied by the installer.

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

    -G removeExistingResponse
    

    This option specifies whether to remove a response file that exists on the system. Note that this option is for uninstall only. Set this option to yestoall or yes to remove existing response files. Set it to notoall or no to leave existing files on the system.

    -G removeModifiedResponse
    

    This option specifies whether to remove a response file that has been modified since it was last installed. Note that this option is for uninstall only. Set this option to yestoall or yes to remove response files that have been modified. Set it to notoall or no to leave modified files on the system.

  2. Perform the silent installation as described in Executing the silent installation, using the response file prepared in step 1.

Installing adapters silently on UNIX and Linux systems

Do the following to perform a silent installation of an adapter on Windows systems:

  1. Prepare a response file to install the adapter as described in Preparing the installation response file, using the desired options listed in Table 16.

    Table 17. Silent installation options for adapters for UNIX and Linux systems

    Option name Option values
    -W destination.path
    

    Set this option to the directory path in which the WebSphere Business Integration Adapters product is to be installed. For example,

    -W destination.path="C:\IBM\WebSphereAdapters"
    

    The install path cannot contain any spaces. The install location must contain a compatible version of the adapter framework.

    -W inputServer.name
    

    If your broker is IBM WebSphere InterChange Server, specify a valid InterChange server name. This name must meet the following criteria: 1. Less than 80 characters. 2. Must not contain space. 3. Must begin with an English alphabetical character (a-z, A-Z). 4. Must contain only English alphabetical and numeric characters.

    If you are not using WebSphere Interchange Server as the broker, comment out this option.

    -G createDirectoryResponse= Set this option (yes or no) to specify whether to create the destination directory if it does not already exist.
    -G replaceExistingResponse
    

    Set this option 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 this option 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 this option to yesToAll or yes to replace all files found on the system that are newer than those being copied by the installer.

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

    -G removeExistingResponse
    

    This option specifies whether to remove a response file that exists on the system. Note that this option is for uninstall only. Set this option to yestoall or yes to remove existing response files. Set it to notoall or no to leave existing files on the system.

    -G removeModifiedResponse
    

    This option specifies whether to remove a response file that has been modified since it was last installed. Note that this option is for uninstall only. Set this option to yestoall or yes to remove response files that have been modified. Set it to notoall or no to leave modified files on the system.

  2. Perform the silent installation as described in Executing the silent installation, using the response file prepared in step 1.

Recording installation selections

You can record your installation selections to a file by using a special option when invoking the installation program from the command line. At the completion of the install, your installation selections are recorded to the file you specified on the command line. You can use the recorded installation information in this file as a record of your installation settings and as a response file for silent installations on other machines.

To create this file, type the following command from the command line:

<installation launcher executable> -options-record <filename>

For example, type the following command in a command window to record the installation selections of your adapter installation on a Windows computer:

setupwin32.exe -options-record C:\data\settings.txt

Copyright IBM Corp. 1997, 2004