Installing data handlers

You can install data handlers as part of either the IBM WebSphere InterChange Server or the WebSphere Business Integration Adapters product. The following sections describe the installation environment and the steps to install data handlers:

Data handlers in IBM WebSphere InterChange Server

The IBM WebSphere InterChange Server product includes the base data-handler file, CwDataHandlers.jar. Therefore, this product includes the data handlers that Table 3 lists. The Server Access Interface process (within InterChange Server) can access any of the data handlers in the CwDataHandlers.jar file. The InterChange Server Installer automatically installs this data-handler file. For the use of the InterChange Server Installer, follow the instructions in the System Installation Guide for UNIX or for Windows.

Note:
To use additional IBM-delivered data handlers with InterChange Server, you must purchase the IBM WebSphere Business Integration Adapters product. This product includes all IBM-delivered data handlers as well as the sample data-handler code to assist in the development of custom data handlers.

When the installation is complete, the files in Table 6 are installed in the product directory on your system.

Table 6. Installed file structure for data handlers in WebSphere InterChange Server

Directory Description
DataHandlers Contains the file CwDataHandler.jar for compiled versions of the IBM-delivered data handlers.
repository\edk Contains text files with meta-object definitions for data handlers called in the context of the Server Access Interface (used with the InterChange Server integration broker).
Note:
In this chapter, backslashes (\) are used as the convention for directory paths. For UNIX installations, substitute slashes (/) for backslashes. All pathnames are relative to the product directory, which is the directory where the WebSphere business integration system is installed.

Data handlers in IBM WebSphere Business Integration Adapters

The IBM WebSphere Business Integration Adapters product includes all IBM-delivered data handlers (see IBM-delivered data handlers). To install the data handlers, use the WebSphere Business Integration Adapters Installer, which installs them automatically.

To install the separate XML or EDI data handlers, you must follow the instructions in Installing data handlers using the graphical installer or Installing data handlers silently.

When the installation is complete, the files in Table 7 are installed in the product directory on your system.

Table 7. Installed file structure for data handlers in WebSphere Business Integration Adapters

Directory Description
DataHandlers Contains the file CwDataHandler.jar for compiled versions of the IBM-delivered base data handlers. Also contains an empty jar file, CustDataHandler.jar, which is intended to hold any custom data handlers you might develop.
DevelopmentKits\edk\DataHandler Contains a template file (StubDataHandler.java) for a custom data handler and a batch file (make_datahandler.bat)to compile a custom data handler.
DevelopmentKits\edk\DataHandler\Samples Contains source code for the sample FixedWidth, NameValue, and Delimited data handlers.
repository\DataHandlers Contains text files with meta-object definitions for data handlers called in the context of a connector.
Note:
In this chapter, backslashes (\) are used as the convention for directory paths. For UNIX installations, substitute slashes (/) for backslashes. All pathnames are relative to the product directory, which is the directory where the WebSphere business integration system is installed.

Installing data handlers using the graphical installer

You must do the following to install the separate XML and EDI data handlers using the graphical installer:

  1. Invoke Installer as described in for your data handler.
  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.
  5. The product directory screen allows you to specify where to install the data handlers. The product directory must contain an installation of a compatible version of the adapter framework. You may specify another directory, but it must contain an installation of a compatible version of the adapter framework.

    On the Windows platform, the field defaults to the value contained in the CROSSWORLDS environment variable, which is set by the either the WebSphere InterChange Server Installer or the WebSphere Business Integration Adapters Installer for adapter framework.

    On the UNIX platform, the installer queries an entry in a file created by either the adapter framework installer or the WebSphere InterChange Server installer.

    For more information on installing WebSphere InterChange Server, see the System Installation Guide for Windows

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

  6. The summary screen lists the features you selected for installation, the specified product directory, and the amount of disk space required. Read the information to verify it and then click Next.
  7. If you are installing on a Windows computer then Installer presents the program folder selection screen for some data handlers. 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.
  8. After Installer finishes successfully, click Finish.

Installing data handlers silently

You must do the following to perform a silent installation of the separate XML and EDI data handlers:

  1. Prepare a response file to install the data handler using the desired options listed in Table 8.

    Table 8. Silent installation options for data handlers

    Option name Option values
    -W installLocation.active
     
    

    -W installLocation.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 .

    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.

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

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

Copyright IBM Corp. 1997, 2003