Installing and Customizing the Adapter

Overview

This chapter explains how to install, configure, and uninstall Adapter for OFTP. The instructions use the IBM webMethods Installer and the IBM webMethods Uninstaller wizards. For complete information about the wizards or other installation methods, or to install other webMethods products, see the Installing IBM webMethods Products for your release.

Requirements

The Adapter for OFTP in the IBM webMethods Installer consists of two components, OFTP and OFTPforTN. The two components correspond to the following two packages:

  • WmOFTP (OFTP Gateway package)
  • WmOFTPforTN (OFTP for Trading Networks package)

To install IBM webMethods Adapter for OFTP, you need to install both the packages.

Where you install the packages depends on whether you are using a DMZ.

Using a DMZ? Machine on which to install the packages
Yes
  • Install the WmOFTP package on the machine within the DMZ. This machine is referred to as the OFTP Gateway.
  • Install the WmOFTPforTN package on the machine outside DMZ.
No

Install both, the WmOFTP and WmOFTPforTN on the same machine.

For a list of operating systems, and webMethods products supported byAdapter for OFTP, see IBM webMethods Adapters System Requirements.

Adapter for OFTP has no hardware requirements beyond those of its host Integration Server.

The Integration Server Home Directory

Beginning with Integration Server 9.6, you can create and run multiple Integration Server instances under a single installation directory. Each Integration Server instance has a home directory under Integration Server_directory\instances\instance_name that contains the packages, configuration files, log files, and updates for the instance.

For more information about running multiple Integration Server instances, see the IBM webMethods Integration Server Administrator’s Guide for your release.

If you are using Integration Server 9.5 and lower, the Integration Server home directory is Integration Server_directory. For example, on Integration Server 9.5 the adapter package is installed in the Integration Server_directory\packages directory.

This guide uses the packages_directory as the home directory in Integration Server classpaths. For Integration Server 9.6 and above, the packages_directory is Integration Server_directory\instances\instance_name\packages directory. For Integration Server 9.5 and lower, the packages_directory is Integration Server_directory\packages directory.

Installing the Adapter

About this task

Note: You must uninstall Adapter for OFTP 7.1 before installing Adapter for OFTP 9.0 . Installing adapter versions 7.1 and 9.0 on the same Integration Server may cause conflicts when running adapter services.

To install Adapter for OFTP :

Procedure

  1. Download Installer.
  2. If you are installing the adapter on an existing Integration Server, shut down the Integration Server.
  3. Start the Installer wizard.
  4. Choose the webMethods release that includes the Integration Server on which you want to install the adapter.
  5. Specify the installation directory as follows:
    • If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server.
    • If you are installing both the host Integration Server and the adapter, specify the installation directory to use.
  6. In the product selection list, select Adapters > webMethods Adapter 9.0 for OFTP.

    If you are using Integration Server 9.6 and above, you can choose to install the package in the default instance. In this case, IBM webMethods Installer installs the adapter in both locations, Integration Server_directory\packages and the default instance packages directory located in Integration Server_directory\instances\instance_name\packages.

  7. After the installation completes, close the Installer.
  8. Copy the following .jar files from rvsEVO_installation_directory\lib directory to packages_directory\OFTP\code\jars directory.
    • rvs-client-api-6.x.x.jar
    • rvs-common-exception-1.1.jar
    • rvs-data-6.x.x.jar
    • rvs-datahelper-1.17.6.1.jar
    • rvs-evo-server-tools-6.x.x.jar
    • rvs-identity-data-1.0.jar
    • rvs-util-6.x.x.jar
    • rvs-view-data-1.15.jar
  9. Start the host Integration Server.

    For instructions on installing the rvsEVO Server software, see the documentation on T-Systems rvs website.

Configuring the Adapter

About this task

The following table lists the tasks required to configure Adapter for OFTP .

Task Description
Stage 1 Configure the rvsEVO Software
Stage 2 Configure the OFTP Gateway - Basic Parameters
Stage 3 Configure the Adapter for OFTP - Remote Server

Stage 1: Configure the rvsEVO Software

About this task

You must configure the rvsEVO server station, partner stations, private keys, and exchange certificates between the local rvsEVO station and partner stations, using the rvsEVO Administrator GUI.

For information about rvsEVO configuration, see the documentation on T-Systems rvs website.

Stage 2: Configure the OFTP Gateway - Basic Parameters

About this task

To configure the OFTP Gateway

Procedure

  1. At the machine where the OFTP Gateway package is installed, start the host Integration Server and login to Integration Server Administrator.
  2. In the Adapters menu of the navigation area, click IBM webMethods Adapter for OFTP.
  3. Provide inputs to the parameters in the Connection page.
    Adapter configurations for rvsEVO
    Parameter Description
    RMI Service Host

    The name or IP address of the machine on which rvsEVO is installed.

    RMI Service Port

    The client port number of the rvsEVO's RMI service. The default port number is 3755.

    RMI Service Name

    The name of the rvsEVO service. The default service name is rvsEVO.

    rvs username

    The user name of your rvs software. This is the name you have entered during the installation of rvsEVO.

    rvs password

    The password for accessing your rvs software. This is the password you entered during the installation of rvsEVO.

    Working directory

    The directory used by the OFTP Gateway for storing temporary files.

    Note: The working directory must be created manually by the administrator.
    Security Configurations
    Parameter Description
    Security Feature Set

    The format of encryption set for the transfer of file to the partner. You can choose one of the following encryption formats:

    • ComSecure-V1
    • ComSecure-V2
    • OFTP2.0

    Choose None to not encrypt the file.

    Compression

    Enable or disable file compression. Select the check box to enable compression.

    Encryption

    Enable or disable file encryption. Select the check box to encrypt the file.

    Encryption Algorithm

    The algorithm used for file encryption. You can choose one of the following encryption algorithms:

    • AES
    • 3DES

    Choose None to not use an encryption algorithm.

    File Signature

    Enable or disable file signature. Select the check box to enable file signature.

    Request Signed EERP/NERP

    Enable or disable signed EERP or NERP request from your partner. Select the check box to enable EERP or NERP request.

    Note: The send job fails if the partner does not send a signed EERP or NERP.
    Note: The adapter considers the Security Configurations parameter values set in Integration Server Administrator if the values are not set in the wm.oftp.tn:deliverOftp service.

    For more information on security configuration features, see the rvsEVO User Manual on T-Systems rvs website.

  4. Click the Save button to save the parameters entered.
    Note: If you change one of the parameters described above, you have to click the Save button again to update the value.
  5. Click the Test button to perform the adapter connection test.

    The test results are displayed in the return code and error text fields.

    Return Code Description
    0

    The connection to rvsEVO is established.

    -1

    An error occurred while trying to connect to rvsEVO.

    error message: RvsServer.testLogon(): connection failed to host <IP address>

Stage 3: Configure the Adapter for OFTP - Remote Server

About this task

To configure the Adapter for OFTP

Procedure

  1. At the machine where the WmOFTPforTN package is installed, start the host Integration Server and login to Integration Server Administrator.
  2. In the Settings menu of the navigation area click Remote Servers.
  3. Click Create Remote Server Alias and enter the following information:
    Parameter Description
    Alias

    Name that you want to use for the alias.

    Host Name or IP Address

    Host name or IP address of the remote server for which you are creating the alias.

    Port Number

    Port number on which the remote server listens for incoming requests from the server.

    User Name

    User name for a user account on the remote server.

    Password

    Password for the user account.

Uninstalling the Adapter

About this task

To uninstall Adapter for OFTP

Procedure

  1. Shut down the host Integration Server. You do not need to shut down any other webMethods products or applications that are running on your machine.
  2. Start IBM webMethods Uninstaller, selecting the webMethods installation directory that contains the host Integration Server.
  3. In the product selection list, select Adapters > webMethods Adapter 9.0 for OFTP.
  4. After Uninstaller completes, restart the host Integration Server.

Results

Uninstaller removes all Adapter for OFTP -related files that were installed. However, Uninstaller does not delete files created after you installed the adapter (for example, user-created or configuration files), nor does it delete the adapter directory structure. You can go to the Integration Server_directory\packages directory and Integration Server_directory\instances\instance_name\packages directory. Delete the WmOFTP directory.