Using the Integration Server Wrapper

This document describes how to use the Integration Server Wrapper.

Step 1: Start the Integration Server Wrapper Wizard

Start of instruction setTo start the Integration Server Wrapper wizard

  1. In the context menu of a Software AG IDL file, choose Integration Server > Generate webMethods IS Connection.

    This starts the wizard with a list of existing Integration Server Wrapper connections.

    Note:
    If the selected IDL file is not valid because of a syntax error, an error dialog comes up and the wizard does not start.

  2. If you are using the wizard for the first time without any predefined Integration Server connections, continue with Step 2a: Create a New Integration Server Connection.

    Or:
    If Integration Server Connections are already defined, or if you want to communicate with an additional Integration Server, continue with Step 2b: Use an Existing Integration Server Connection.

graphics/using_start.png

Step 2a: Create a New Integration Server Connection

graphics/using_createNew.png

Start of instruction setTo create a new Integration Server connection

  1. Define the new Integration Server connection on the wizard page.

    Notes:

    1. The only required field is Server. Enter the hostname of the Integration Server including an optional port number. If no port number is specified, port number defaults to "5555". The Integration Server Authentication can be passed with the User and Password fields.
    2. Optional settings are for secure connections. The Truststore for HTTPS contains all signed certificates and must be a valid truststore.
    3. The check box Verify host name checks that the hostname is entered in the stored certificate.
    4. When the Integration Server has Client Authentication enabled, you can specify your Keystore file and keystore Password.
    5. For managing Integration Server connections, see Integration Server Preferences.

  2. Choose Next and continue with Step 3: Select the Connection Type.

Step 2b: Use an Existing Integration Server Connection

graphics/using_useExisting.png

Start of instruction setTo use an existing Integration Server connection

  1. Select Choose an existing Integration Server Connection and an Integration Server connection from the list.

    The selected connection is verified by a ping command. If the response is valid, the Next button is enabled. If invalid, an error message is displayed.

  2. Continue with Step 3: Select the Connection Type.

Start of instruction setTo create an additional Integration Server connection

Step 3: Select the Connection Type

Note:
This section describes how to select the connection type for EntireX Adapter version 9.0 or above. For earlier versions, see Select the Connection Type for EntireX Adapter 8.2 or Below.

graphics/using_connectionType.png

In this step you can either create a new Integration Server connection or update adapter services to an existing Integration Server connection.

Start of instruction setTo create a new connection

  1. Select a connection type from the drop down list.

  2. Click Next and continue with Step 4a: Define Adapter Services for an RPC Connection.

    Or:
    Step 4b: Define Adapter Services for an RPC Listener or a Reliable RPC Listener, depending on the selected connection type.

Start of instruction setTo update an existing connection

  1. Select a connection from List of Connections.

    As a result, you are informed on how many adapter services will be created, modified or left unchanged.

    The update process can be characterized as follows:

    • The metadata is updated for each IDL program.

    • An adapter service is created for each new IDL program.

    • An existing adapter service is updated if it is contained in the IDL file for the update.

    • A connection remains unchanged with respect to its type and settings (broker ID, server address, user ID, etc.).

  2. Click Finish.

Example

A connection is created with IDL programs A and B. Later, the update operation uses IDL programs A and C. After the update, the service for A is modified, the service for B is unchanged, and the service for C is new.

Select the Connection Type for EntireX Adapter 8.2 or Below

graphics/using_connectionType_8.png

Start of instruction setTo select a connection type forEntireX Adapter 8.2 or below

  1. Select a Connection type from the list of available types.

    Notes:

    1. Some connection types require a license.
    2. The connection types for Reliable RPC require an IDL file with IN parameters only. If the selected IDL file contains OUT parameters, the connection types for Reliable RPC are not available.
    3. Listeners can be generated only for connection types RPC, Direct RPC and Reliable RPC.

  2. Click Next and continue with Step 4a: Define Adapter Services for an RPC Connection.

    Or:
    Step 4b: Define Adapter Services for an RPC Listener or a Reliable RPC Listener, depending on the selected connection type.

Step 4a: Define Adapter Services for an RPC Connection

graphics/using_define-rpc.png

Start of instruction setTo create a connection and related adapter services

  1. Select a package for the created objects.

  2. Define a folder name. If the folder does not exist, it will be created.

  3. Define a connection name.

  4. Define the parameters of the connection type. For details, see the EntireX and your webMethods Integration Server Applications.

    As a result, the folder will contain the connection and the adapter services (one for each IDL program). The name of a service is the same as the respective IDL program.

The default settings for new RPC adapter services are:

  • the Default package; if not available, the first package

  • the IDL library name for the Folder Name

  • the IDL library name with the suffix "Connection" for the Connection Name

Notes:

  1. The check box Overwrite existing Objects in Integration Server is useful for re-generating objects created previously. However, you cannot overwrite an RPC Listener Connection or a reliable RPC Listener Connection with a connection of a different type. If the connection is deleted with the Adapter Administration UI, it is not possible to overwrite the objects. In this case, you have to delete the adapter services in the Designer.
  2. When creating a connection, a package dependency is added such that the selected package depends on webMethods EntireX (the package WmEntireX) with the version currently used.

Step 4b: Define Adapter Services for an RPC Listener or a Reliable RPC Listener

graphics/using_define-listener.png

Start of instruction setTo create a connection and related adapter services

  1. Select a package for the created objects.

  2. Define a folder name. If the folder does not exist, it will be created.

  3. Define a connection name.

  4. Define the parameters of the connection type. For details, see the EntireX and your webMethods Integration Server Applications.

    As a result, the folder will contain the connection and the adapter services (one for each IDL program). The name of a service is the same as the respective IDL program.

The default settings for new RPC adapter services are:

  • the Default package; if not available, the first package

  • the IDL library name for the Folder Name

  • the IDL library name with the suffix "Connection" for the Connection Name

Notes:

  1. The check box Overwrite existing Objects in Integration Server is useful for re-generating objects created previously. However, you cannot overwrite an RPC Listener Connection or a reliable RPC Listener Connection with a connection of a different type. If the connection is deleted with the Adapter Administration UI, it is not possible to overwrite the objects. In this case, you have to delete the adapter services in the Designer.
  2. When creating a connection, a package dependency is added such that the selected package depends on webMethods EntireX (the package WmEntireX) with the version currently used.

Step 5: Finish the Wizard

Start of instruction setTo finish the Wizard