Sterling Gentran:Server for Windows Adapter

The Sterling Gentran:Server® for Windows adapter transfers data between Sterling B2B Integrator and Sterling Gentran:Server for Windows as part of a business process.

The following table provides an overview of the Sterling Gentran:Server for Windows adapter:

System name GenSrvNT
Graphical Process Modeler (GPM) category All Services and Applications > Sterling Gentran:Server
Description Enables you to transfer data between Sterling B2B Integrator and Sterling Gentran:Server for Windows as part of a business process within Sterling B2B Integrator.
Preconfigured? No
Requires third-party files? Requires third-party files:
  • An installed and configured copy of Sterling Gentran:Server for Windows version 3.1.1 or higher
  • The host name of the computer where Sterling Gentran:Server for Windows is installed
  • The name of the Sterling Gentran:Server for Windows mailbox that this adapter configuration will use to exchange data with Sterling B2B Integrator
  • The adapter client .jar file installed, configured, and running.
Platform availability Platform availability:
  • Microsoft Windows
  • Sun Solaris
  • HP-UX
  • IBM-AIX
  • United Linux
  • RedHat AS
Related services No
Application requirements No
Initiates business processes? Yes
Invocation Runs by a scheduler or another adapter in a business process.

Requirements

To configure and use the Sterling Gentran:Server for Windows adapter, you must be familiar with Sterling Gentran:Server for Windows and must have:
  • An installed and configured copy of Sterling Gentran:Server for Windows version 3.1.1 or higher
  • The host name of the computer where Sterling Gentran:Server for Windows is installed
  • The name of the Sterling Gentran:Server for Windows mailbox that this adapter configuration will use to exchange data with Sterling B2B Integrator
  • The Sterling Gentran:Server for Windows adapter client .jar file installed, configured, and running

How the Sterling Gentran:Server for Windows Adapter Works

The Sterling Gentran:Server for Windows adapter is used in a business process to exchange data between Sterling B2B Integrator and Sterling Gentran:Server for Windows.

The following sections summarize how the Sterling Gentran:Server for Windows adapter works in a business process.

Sterling B2B Integrator Receives Data from Sterling Gentran:Server for Windows

The following procedure illustrates how Sterling B2B Integrator receives data from Sterling Gentran:Server for Windows:
  1. Using the scheduling parameters set for the adapter in Sterling B2B Integrator, the Sterling Gentran:Server for Windows adapter polls Gentran:Server for Windows to check if it has data in the Sterling B2B Integrator mailbox.
  2. If data is in the mailbox, the Sterling Gentran:Server for Windows adapter retrieves the data through the remote RMI service of the adapter and the Sterling B2B Integrator gateway.
  3. When Sterling B2B Integrator receives the data, the Sterling Gentran:Server for Windows adapter starts the business process defined in the adapter configuration.

Sterling B2B Integrator Sends Data to Sterling Gentran:Server for Windows

The following procedure illustrates how Sterling B2B Integrator sends data to Sterling Gentran:Server for Windows:
  1. The Sterling Gentran:Server for Windows adapter can be called in a business process to send data to Sterling Gentran:Server for Windows.
  2. Using the Sterling Gentran:Server for Windows adapter remote RMI service and Sterling B2B Integrator, the data is sent to Gentran:Server for Windows.
  3. The Sterling B2B Integrator gateway creates the appropriate message and sends the data to the receiver.

Implementing the Sterling Gentran:Server for Windows Adapter

To implement the Sterling Gentran:Server for Windows adapter, complete the following tasks:
  1. Activate your license for the Sterling Gentran:Server for Windows adapter. See An Overview of Implementing Services.
  2. Install the Sterling Gentran:Server for Windows adapter. See Installing the Adapter Client on Sterling Gentran:Server for Windows.
  3. Install the adapter client on Sterling Gentran:Server for Windows. See Installing the Adapter Client on Sterling Gentran:Server for Windows.
  4. Install Sterling B2B Integrator Gateway on Sterling Gentran:Server for Windows. See Installing Application Gateway in Sterling Gentran:Server for Windows.
  5. Create a Sterling B2B Integrator Mailbox on Sterling Gentran:Server for Windows. See Creating a Application Mailbox in Sterling Gentran:Server for Windows.
  6. Create a Sterling Gentran:Server for Windows adapter configuration. See Creating a Service Configuration.
  7. Configure the Sterling Gentran:Server for Windows adapter. See Configuring the Sterling Gentran:Server for Windows Adapter.
  8. Use the configured services in a business process.

Installing Java on Sterling Gentran:Server for Windows

Sterling B2B Integrator installs a copy of the appropriate Java Development Kit (JDK) required for proper operation. You must ensure that there is a JDK installed on the machine where Sterling Gentran:Server for Windows is installed and that it matches the same JDK version as the one installed with Sterling B2B Integrator (wherever it is installed). If Sterling B2B Integrator is installed on the same machine as Gentran:Server for Windows then the correct JDK version will automatically be installed when Sterling B2B Integrator is installed. The system requirements for this installation are Java Runtime Environment/Java Virtual Machine version 1.3.

Installing the Adapter Client on Sterling Gentran:Server for Windows

To install the Sterling Gentran:Server for Windows adapter client on Sterling Gentran:Server for Windows:
  1. In the /<install_dir>/packages folder on the computer where Sterling B2B Integrator is installed, locate the GSNTClient.jar file.
  2. Move a copy of the GSNTClient.jar file to the GentranInstallation/bin folder on the computer where Sterling Gentran:Server for Windows is installed.
  3. Unpack the GSNTClient.jar file in the GentranInstallation/bin folder. GSNTClient.jar contains the following files:
    • GenSrvNtAdapter.jar (Note: do not unpack the GenSrvNtAdapter.jar file!)
    • runremotermi.bat
    • SterlingIntegrator<ver>.dll
    • Manifest.mf
  4. Rename the appropriate version of SterlingIntegrator<ver>.dll to SterlingIntegrator.dll. Note that the version of SterlingIntegrator.dll corresponds with the version number of Sterling Gentran:Server for Windows.

Installing Sterling B2B Integrator Gateway in Sterling Gentran:Server for Windows

To install a Sterling B2B Integrator gateway in Sterling Gentran:Server for Windows:
  1. Run regedit on the computer where Sterling Gentran:Server for Windows is installed and navigate to:

    HKEY_LOCAL_MACHINE\Software\IBM®\Gentran\Mailbox\version#\Client\Gateways

  2. Right-click the Client\Gateways folder and select New > String Value.
  3. In the String Value Name box, type STERLINGIntegrator as the name of the gateway.
  4. In the Data box, type SterlingIntegrator.dll to assign the file to the Sterling B2B Integrator gateway.

    The xx in SterlingIntegratorxx.dll relates to the version number of Sterling Gentran:Server for Windows that you have installed on your computer.

  5. Navigate to:

    HKEY_LOCAL_MACHINE\Software\IBM\Gentran\Mailbox\version#\Server\Gateways

  6. Right-click the Server\Gateways folder and select New > String Value.
  7. In the String Value Name box, type STERLINGIntegrator as the name of the gateway.
  8. In the Data box, type SterlingIntegrator.dll to assign the file to the Sterling B2B Integrator gateway.
  9. Start the Mailbox service to establish the new gateway settings.

Creating a Sterling B2B Integrator Mailbox in Sterling Gentran:Server for Windows

The SterlingIntegrator.dll file must be placed in the registry before you can create the Sterling B2B Integrator mailbox using the Sterling B2B Integrator gateway.

To create a Sterling B2B Integrator mailbox in Sterling Gentran:Server for Windows:
  1. In Sterling Gentran:Server for Windows, start MailBox Server Manager.
  2. Right-click Mailboxes and select Create.
  3. Type a unique name as the name of the mailbox you are creating and click Next twice.
  4. Click Yes, use this mailbox as a gateway, select Sterling B2B Integrator as the type of gateway to use with this mailbox, and then click Next.
  5. On the summary page, confirm that the information you entered is correct, and then click Finish.

    Depending on your system configuration, the mailbox properties window may open.

  6. Open the Sterling Gentran:Server Mailbox Manager client, right-click Client\Gateway, and select Properties.
  7. Type the content type and subtype of messages and attachments when receiving messages.
  8. Click Edit Recipients and select the receivers to send the message to.

Using Remote RMI in Sterling Gentran:Server for Windows

To use remote RMI in Gentran:Server for Windows:
  1. In the runremotermi.bat file, note the port number at the end of the last line in the file. This is the port number required in the RMI server address during configuration of the Sterling Gentran:Server for Windows adapter.

    If this port number changes, you must change the configuration of the Sterling Gentran:Server for Windows adapter.

  2. Run the runremotermi.bat file.

Configuring the Sterling Gentran:Server Windows Adapter

To configure the Sterling Gentran:Server for Windows adapter, you must specify field settings in Sterling B2B Integrator and in the GPM.

Sterling B2B Integrator Configuration

The following table describes the fields used to configure the Sterling Gentran:Server for Windows adapter in Sterling B2B Integrator:

Note: The names in parentheses represent the corresponding field names in the GPM. This information is provided for your reference.
Field Description
Name Unique and meaningful name for the adapter configuration. Required.
Description Meaningful description for the adapter configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Note: See Using Service Groups.
Host Name (gentranhost) Name of the computer where Sterling Gentran:Server for Windows is installed.
Mailbox Name (remoteMailbox) Name of the mailbox created in Sterling Gentran:Server for Windows that this configuration of the adapter will use.
Note: This mailbox must have Sterling B2B Integrator listed as its gateway.
RMI Server Address (remoteAddr) Address of the RMI server that is installed on the same computer as Sterling Gentran:Server for Windows. The format to enter this address is ipadr:port/rmiServerName.
Start a Business Process When Data is Received? (bootstrap) Whether the adapter should start a business process. Valid values are Yes and No. Required.
Business process (initialWorkFlowId) Business process to start when the Sterling Gentran:Server for Windows adapter receives data. Required only if you selected Yes in the Start a Business Process When Data is Received? field.
Do not use schedule If this field is selected, this service does not start a business process and does not run on a schedule. Required for receiving data from Sterling B2B Integrator.
Run service based on timer every Valid values are the hour and minutes at which to run the service. Indicate whether you want the service to run at startup.
Run service daily at Valid values are the hour and minutes at which to run the service, daily. Indicate whether you want the service to run at startup.
Run service weekly on Valid values are the day of the week, the hour, and the minutes at which to run the service. Indicate whether you want the service to run at startup.

GPM Configuration

The following table describes the fields used to configure the Sterling Gentran:Server for Windows adapter in the GPM:

Field Description
Config Name of the adapter configuration.
Action Action that this configuration of the adapter performs. Valid values are Receive from Sterling Gentran:Server and Send to Sterling Gentran:Server.