Interfaces

Adding PI/PO Interface

About this task

You must define an outbound interface for each type of MessageObject you want to send to a business partner and an inbound interface for each type of MessageObject you expect to receive from a business partner.

Important: You must define each interface exactly as it is defined in the PI Integration Repository.

To define inbound and outbound interfaces

Procedure

  1. Start Integration Server Administrator.
  2. In the Adapters menu in Integration Server Administrator's navigation area, click webMethods Adapter for PI/PO. The system displays the Servers page.
  3. In the webMethods Adapter for PI/PO navigation area, click Interfaces. The system displays the Interfaces page.
  4. Click Add PI/PO Interfaces. The system displays the Add Interfaces page.
    Field Description
    Interface
    Name Required. Specify the name of the interface that is defined in the PI Integration Repository.
    Namespace Required. Specify the namespace of the interface that is defined in the PI Integration Repository. You can use the namespace to differentiate multiple interfaces that have the same name but different signatures and meanings. Typically, the interface namespace is a URI.
    Mode and Direction
    Mode Required. Specify the delivery mode to connect to the PI/PO server. Possible values are:
    • Synchronous.
    • Asynchronous. Default.
    Direction Required. Specify whether the interface defines an inbound or outbound task. Possible values are:
    • Inbound. Interface for an inbound task.
    • Outbound. Interface for an outbound task.
    Message Types
    Input Name Required.
    • In synchronous and asynchronous inbound messages, specify the message type of the request message the interface will take as input from your business partner.
    • In synchronous outbound messages, specify the message type of the response message the interface will receive from your business system if no application error occurs during processing.
    Namespace Required. Specify the namespace for the message type.
    Output Name Required.
    • In synchronous inbound messages, specify the message type of the response message the interface will return to your business partner if no application error occurs on your backend system during processing.
    • In synchronous and asynchronous outbound messages, specify the message type of the request message the interface will send to your business partner.
    Namespace Required. Specify the namespace for the message type.
    Fault Name Required.
    • In synchronous inbound messages, specify the message type of the reply message the interface will return to your business partner if an application error occurs on your backend system during processing.
    • In synchronous outbound messages, specify the message type of the reply message the interface will receive from your business system if an application error occurs during processing.
    Namespace Required. Specifies the namespace for the message type.
    Specification
    Name Name of the specification that XI Adapter uses to generate an Integration Server specification from the interface using the Integration Server Document Type that correspond to the interface's message types. For more information, see IBM webMethods Designer Online Help.
  5. Repeat the steps to define all interfaces you want to use to send or receive MessageObjects.

Viewing Interfaces

About this task

To view Interfaces

Procedure

  1. Start Integration Server Administrator.
  2. In the Adapters menu in Integration Server Administrator's navigation area, click webMethods Adapter for PI/PO. The system displays the Servers page.
  3. In the webMethods Adapter for PI/PO navigation area, click Interfaces. The system displays the Interfaces page.
    • The Interfaces page lists the Name, Namespace, Mode, Direction for each Interface. For description of each field, see the table of fields in Adding PI/PO Interface.
    • You can sort the table by a particular column by clicking the column's heading.
    • You can sort the column in ascending or descending order.
    • You remove an Interface from the list by clicking icon in the Delete column.
      Note: Before you can delete an interface, you must delete all service endpoint associations that specify the interface.

Generating an XML Schema Definition for a Message Type

About this task

You can generate an XML schema definition (XSD) for any of the message types you specify for an interface.

To generate an XSD

Procedure

  1. Start Integration Server Administrator.
  2. In the Adapters menu in Integration Server Administrator's navigation area, click webMethods Adapter for PI/PO. The system displays the Servers page.
  3. In the webMethods Adapter for PI/PO navigation area, click Interfaces. The system displays the Interfaces page.
  4. Click the interface that specifies message types for which you want to generate XSDs. Depending on whether the interface is inbound or outbound, the system displays the Show Inbound Interface or Show Outbound Interface page respectively.
  5. Locate the message type for which you want to generate an XSD and click for that message type. The system generates the XSD file from the Integration Server Document Type you associated with the message type and stores the file in the Integration Server_directory\instances\instance_name\packages\WmXI\xdocs directory.