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 in the Integration Server Wrapper documentation.

  2. Choose Next and continue with Step 3: Create or Update an Adapter Connection.

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: Create or Update an Adapter Connection.

Start of instruction setTo create an additional Integration Server connection

Step 3: Create or Update an Adapter Connection

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. Connection types are described under EntireX Adapter Connections in the EntireX Adapter documentation and Introduction to the Integration Server Wrapper.

    Note:
    The list of connection types is filtered: connection types that require a license are only shown if a corresponding license file is available. Reliable RPC connections are only shown if all IDL programs contain only IN parameters. Also, if a server mapping file is available, only those connection types that support the interface type specified in the server mapping file are shown.

  2. Click Next and continue with Step 4a: Create a Connection and Related Adapter Services.

    Or:
    Step 4c: Create a Connection and Related Adapter Listener, depending on the selected connection type.

Start of instruction setTo update an existing connection or listener

  1. Select a connection from List of Connections. The list of connections is filtered by connection type as described in the note above.

    As a result, you are informed on how many adapter services or adapter listeners 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 or one adapter listener is created.

    • An existing adapter service or adapter listener 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.

The checkbox Map Software AG IDL data types to String specifies how to map IDL data types to Integration Server data types. The default is to map all data types (except binary) to String. See Mapping IDL Data Types to IS Data Types. If the IDL file has been extracted from an Integration Server package, this option is not available because the value was set by the extraction and should not be changed.

Start of instruction setTo create or update a REST resource

  • Check Create or Update REST resource if you want to create REST V2 resources for your connection. This functionality is not available for Listener connections. An additional dialog will appear to define the destination of the resource See Step 4b: Create or Update a REST Resource.

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.

Step 4a: Create a Connection and Related Adapter Services

graphics/using_define-rpc.png

Start of instruction setTo create a connection and related adapter services

  1. Select an existing package or create a new 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 Connection Parameters for RPC Connections in the EntireX Adapter documentation.

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

Note:
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: Create or Update a REST Resource

The following screen appears if checkbox Create or Update REST resource is checked in Step 3.

graphics/using_define-rest-fragment.png

Start of instruction setTo create or update a REST resource

  1. Select a package.

    graphics/using_define-rpc-rest.png

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

  3. Define the REST Resource name.

  4. Check Update existing Resource if you want to add additional services to an existing resource.

  5. Check Create or Update simplified REST services for this REST resource if you want to generate additional services with a simplified REST API. This allows you to use a simple HTTP-GET method without a payload.

    Note:
    This applies only to APIs where input signature parameters do not contain arrays.

For more information see:

  • REST Developer's Guide in the webMethods Integration Server documentation for information on using the generated REST resources

Step 4c: Create a Connection and Related Adapter Listener

graphics/using_define-listener.png

Start of instruction setTo create a connection and related listener

  1. Select an existing package or create a new 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.

    As a result, the folder will contain the connection and the adapter listener.

The default settings for new listener 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

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

Note:
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