Configuring on SAP XI

The XI adapter for TN5250 is used to connect the Integration Server to back-end applications. It enables messages to be exchanged by converting the XI message format to TN5250 service call and converting the result of the service call back to an XI message. When you wish to create a communication path from the Integration Server or the PCK to a program or subprogram on the remote host, a number of configuration steps are required.

 

To convert XI messages to a TN5250 service call you will need to:

1. Retrieve the WSDL file of an ApplinX procedure group.

2. Tasks performed from the Design: Integration Builder tool:

   1. Create an external definition.

   2. Create a message interface. (For each Web method you will need to create a separate message interface.)

   3. Activate your settings.

3. Tasks performed from the Configuration: Integration Builder tool:

   1. Define a service.

   2. Define a communication channel.

   3. Define the receiver determination.

   4. Define the interface determination.

   5. Define the receive agreement.

   6. Activate your settings.

---

Retrieving the WSDL File of an ApplinX Procedure Group

A WSDL file can be created either using Eclipse Plug-in for ApplinX or via the http://localhost:2380/applinx address on your browser. The WSDL file contains one or more Web methods for a specific Web service.

• Eclipse Plug-in for ApplinX

• The ApplinX 2380 HTTP Interface

Eclipse Plug-in for ApplinX

Refer to ApplinX User Guide, the ApplinX Plug-in for Eclipse Appendix for details regarding how to install and work with the plug-in.

Right-click on a Procedure Group and select Generate WSDL.

The ApplinX 2380 HTTP Interface

The WSDL file can be retrieved using the ApplinX Web interface. In other words, you can connect to the ApplinX Server through your browser and retrieve the WSDL file from the server using procedures (Web methods).

To retrieve the WSDL file using the ApplinX Web interface

1. Type the following http address: http://<ApplinX server:Web interface port>/applinx (for example: http://localhost:2380/applinx) in your browser to connect to the ApplinX server. A list of host applications defined in the ApplinX Server appears.

2. Click the requested application. A list of Procedure Groups (Web Services) for the application appears.

3. Click [wsdl(wrapped)] next to the name of the relevant procedure group. The WSDL file will be opened as an xml file.

4. Save the file with a suitable name, with the .wsdl extension.

Creating an External Definition

To create an External Definition

1. Open the Design Integration Builder.

2. In the node of your product namespace, right-click the External Definition node, and select New....

   

   The Create Object: External Definition screen is displayed.

   

3. Enter a suitable name and click Create to create the External Definition. The Edit External Definition screen is displayed.

   

4. Ensure that the selected category is "wsdl".

5. Click on the Import external definitions button. The Open dialog box is displayed.

6. Browse and locate the WSDL file retrieved in Retrieving the WSDL File of an ApplinX Procedure Group.

7. Save the External Definition.

Creating a Message Interface

For each Web Method, it is necessary to create a separate Message Interface.

To create a Message Interface

1. Open the Design Integration Builder.

2. Right-click the Message Interfaces node, and select New....

   

   The Create Object: Message Interface screen is displayed.

   

3. Enter a suitable name and click Create to create the Message Interface. The Edit Message Interface screen is displayed.

   

4. Ensure that "Inbound" is the Category selected.

5. Ensure that "Synchronous" is the Mode selected.

6. Click on the Display Input Help icon to browse and select the input message.

7. Click on the Display Input Help icon to browse and select the output message.

8. Save the Message Interface.

Defining a Service

To define a service

1. Open the Configuration Integration Builder.

2. Expand the Service without party node, right-click the Business Service node, and select New....

   

   The Business Service screen is displayed.

   

3. Enter a suitable name for the service and click Create. The Edit Service screen is displayed.

   

4. In the Receiver tab, Inbound Interfaces, click the Insert Line Below Selection icon icon. An empty row will be added.

5. Click the Display List of Permitted Values icon to display the Select Interface screen.

6. Select the message interface that you defined in Creating an External Definition. Click OK.

7. Save your definitions.

Defining a Communication Channel

 

To define a communication channel

1. In the Edit Service screen, click the Create Object icon in order to create a new communication channel.

   

   The Communication Channel is displayed.

   

2. Enter a name for the communication channel and click Create. The Edit Communication Channel screen is displayed.

   

3. In the Parameters tab, Adapter Type, click the Display Input Help icon to display the list of adapters.

   

4. Select TN5250 and click OK. The contents of the Parameters tab change accordingly.

   

5. Select the Message Protocol as 5250.

6. Enter the Connection Parameters: the IP name or address of the ApplinX server (mandatory) and the corresponding port number (2380 is the default port number).

7. Define the Application Parameters: the name of the application to connect to, the relevant service in ApplinX and the method.

   Note:
   In order for the method name to be the same as the communication channel name, type * as the method name.

8. Set the adapter to Active to enable messages to be exchanged.

9. Save your changes.

Note:
You need to define a separate communication channel for each ApplinX Web method that you want to use.

Defining the Receiver Determination

To define the receiver determination

1. In the Configuration Integration Builder, right-click Receiver Determination and select New....

   

   The Receiver Determination screen is displayed.

   

2. In the Service field, click the Display List of Permitted Values icon to display the list of services.

   

3. Select the service that is to provide the data to ApplinX.

4. Enter the name of the message interface that you defined in Creating a Message Interface.

5. Enter the namespace that you used when creating the message interface.

6. Click Create. The Edit Receiver Determination screen is displayed.

   

7. In the Configured Receivers area, click on the Insert Line Below Selection icon. An empty row will be added.

8. In the Services cell, click on the icon and select the service you defined in Defining a New Service.

9. Click Save.

Defining the Interface Determination

To define the interface determination

1. In the Configuration Integration Builder, right-click Interface Determination and select New....

   

   The Interface Determination screen is displayed.

   

2. In the Service field, click the Display List of Permitted Values icon to display the list of services.

   

3. Select the service that is to provide the data to ApplinX and click OK.

4. Enter the name of the message interface that you defined in Creating a Message Interface.

5. Enter the namespace that you used when creating the message interface.

6. Click the Display List of Permitted Values icon to display the list of services. Select the service that you defined in Defining a Service.

7. Click Create. The Edit Interface Determination screen is displayed.

   

   Click the Display Input Help icon to display the list of interfaces. Select the relevant interface and click OK.

8. Click Save.

Defining the Receiver Agreement

To define a receiver agreement

1. In the Configuration Integration Builder, right-click Receiver Agreement and select New....

   

   The Receiver Agreement screen is displayed.

   

2. In the Sender, Service field, click the Display List of Permitted Values icon to display the list of services. Select the service that you defined in Defining a Service.

3. In the Receiver, Service field, select the service that is to provide the data to ApplinX.

4. Enter the name of the message interface that you defined in Creating a Message Interface.

5. Enter the namespace that you used when creating the message interface.

6. Click Create. The Edit Receiver Agreement screen is displayed.

   

7. Enter the Receiver Communication Channel defined in Defining a Communication Channel.

8. Click Save.