Creating an Event Port

In this section:

How to:

The following procedures describe how to create an event port using iWay Explorer.

When you use iWay Explorer with an iWay Business Services Provider (iBSP) implementation, the following port dispositions are available:


Top of page

x
Procedure: How to Create an Event Port for File

To create an event port for File:

  1. Click the iWay Events node.
  2. In the left pane, expand the Oracle node.

    The following image shows the options (Add Port and Refresh) that are available in the left pane when you right-click the Ports node.

  3. Right-click the Ports node and select Add Port from the menu.

    The following image shows the Add Port dialog box that opens, where you supply information about the port.

    1. In the Name field, type a name for the port.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select FILE.
    4. In the URL field, type a File destination to which event data is written.

      When pointing iWay Explorer to an iBSE deployment, specify the destination file using the following format:

      ifile://[location];errorTo=[pre-defined port name or another disposition url]

      The following table lists and defines the parameters for the disposition.

      Parameter

      Description

      location

      Destination and file name of the document where event data is written, for example,

      ifile://D:\in\x.txt;errorTo=ifile://D:\error

      errorDest

      Predefined port name or another disposition URL where error logs are sent.

  4. Click OK.

    In the left pane, the event port appears under the ports node. In the right pane, summary information associated with the event port you created appears. In this example, the event port is named OraWIPevents.

You are ready to associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Procedure: How to Create an Event Port for iBSE

To create an event port for iBSE:

  1. In the left pane, click the iWay Events node.
  2. Expand the Oracle node.
  3. Right-click the Ports node and select Add Port from the menu.

    The Add Port dialog box opens, as shown in the following image.

    1. In the Name field, type a name for the port.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select iBSE.
    4. In the URL field, enter an iBSE destination in the form of:
      ibse:svcName.mthName;responseTo=[pre-defined port name or another
       disposition url]; errorTo=[pre-defined port name or another
       disposition url]

      The following table lists and defines the parameters for the disposition.

      Parameter

      Description

      svcName

      Name of the service created with iBSE.

      mthName

      Name of the method created for the business service.

      response To

      Location where responses to the business service are posted. Predefined port name or another full URL. Optional.

      errorTo

      Location where error documents are sent. Predefined port name or another full URL. Optional.

  4. Click OK.

    The port appears under the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the event port you created.

You can now associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Procedure: How to Create an Event Port for MSMQ

To create an event port for MSMQ queue using iWay Explorer:

  1. Click the iWay Events node.
  2. In the left pane, expand the Oracle node.
  3. Right-click the Ports node and select Add Port from the menu.

    The Add Port dialog box opens.

    1. In the Name field, type a name for the port.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select MSMQ.
    4. In the URL field, enter an MSMQ destination in the form of:
      msmg:/host/private$/qName;errorTo=[pre-defined port name or 
      another disposition url]

      The following table lists and defines the parameters for the disposition.

      Parameter

      Description

      host

      Machine name where the Microsoft Queuing system is running.

      queueType

      For private queues, enter Private$. Private queues are queues that are not published in Active Directory. They appear only on the local computer that contains them. Private queues are accessible only by Message Queuing applications that recognize the full path name or format name of the queue.

      queueName

      Name of the private queue where messages are placed.

      errorTo

      Location where error documents are sent.

      Predefined port name or another full URL. Optional.

  4. Click OK.

    The port appears under the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the port you created.

You are ready to associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Procedure: How to Create an Event Port for JMSQ

To create an event port for a JMS queue using iWay Explorer:

  1. Click the iWay Events node.
  2. In the left pane, expand the Oracle node.
  3. Right-click the Ports node and select Add Port from the menu.

    The Add Port dialog box opens.

    1. In the Name field, type a name for the port.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select JMSQ.
    4. In the URL field, enter a JMS destination.

      When pointing iWay Explorer to an iBSE deployment, use the following format:

      jmsq:myQueueName@myQueueFac;jndiurl=[myurl];jndifactory=
      [myfactory];user=[user];password=[xxx];errorTo=[pre-defined port
      name or another disposition url]

      The following table lists and defines parameters for the disposition.

      Parameter

      Description

      queue

      Name of a queue to which events are emitted.

      Connection Factory

      A resource that contains information about the JMS Server.

      jndi_url

      The URL to use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is used. This value corresponds to the standard JNDI property,

      java.naming.provider.url

      jndi_factory

      Is JNDI context.INITIAL_CONTEXT_FACTORY and is provided by the JNDI service provider.

      user

      User ID associated with this queue.

      password

      Password for the user ID.

      errorTo

      Location to which error logs are sent. Optional.

      Predefined port name or another disposition URL. The URL must be complete, including the protocol.

  4. Click OK.

    The port appears under the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the port you created.

You can now associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Procedure: How to Create an Event Port for SOAP

To create an event port for a SOAP disposition:

  1. Click the iWay Events node.
  2. In the left pane, expand the Oracle node.
  3. Right-click the Ports node and select Add Port from the menu.

    The Add Port dialog box opens.

    1. In the Name field, type a name for the port.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select SOAP.
    4. In the URL field, enter an SOAP destination, using the following format:
      soap:[wsdl-url];soapaction=[myaction];method=[web service
      method];namespace=[namespace];responseTo=[pre-defined port name or
      another disposition URL];errorTo=[pre-defined port name or another
      disposition url]

      The following table lists and defines the parameters for the disposition.

      Parameter

      Description

      wsdl-url

      The URL to the WSDL file that is required to create the SOAP message, for example

      http://localhost:7001/ibsp/IBSPServlet/test/ webservice.ibs?wsdl

      where:

      webservice

      Is the name of the web service you created using iWay Explorer.

      To find this value, navigate to the iWay Business Services tab, expand the Services node, select the service you created, and click Service Description on the right. The WSDL URL appears in the Address field of the window that opens.

      You can also open the WSDL file in a third party XML editor (for example, XMLSPY) and view the SOAP request settings to find this value.

      soapaction

      The method called by the SOAP disposition. For example:

                                      webservice.method@test@@

      where:

      webservice

      Is the name of the web service you created using iWay Explorer.

      method

      Is the method being used.

      test

      Is the license that is being used by the web service.

      This value can be found by navigating to the iWay Business Services tab and opening the Service Description link in a new window. Perform a search for soapAction.

      You can also open the WSDL file in a third party XML editor (for example, XMLSPY) and view the SOAP request settings to find this value.

      method

      The web service method you are using. This value is found in the WSDL file.

      namespace

      The XML namespace you are using. This value is found in the WSDL file.

      responseTo

      The location to which responses are posted, which can be a predefined port name or another URL. Optional.

      errorTo

      Location to which error logs are posted which can be a predefined port name or another URL. Optional.

  4. Click OK.

    The event port appears under the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the evnet port you created.

You are ready to associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Procedure: How to Create an Event Port for HTTP

To create an event port for an HTTP disposition using iWay Explorer:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Oracle node.
  3. Right-click the Ports node and select Add Port from the menu.

    The Add Port dialog box opens.

    To connect iWay Explorer to an iBSE deployment, follow the steps in How to Create an Event Port for iBSE.

    The following table lists and describes the disposition parameters for HTTP.

    Parameter

    Description

    url

    URL target for the post operation.

    respDest

    Location where responses are posted. Predefined port name or another full URL. Optional.

    Predefined port name or another disposition URL. The URL must be complete, including the protocol.

    host

    Name of the host on which the web server resides.

    port

    Port number on which the web server is listening.

    uri

    Universal resource identifier that completes the url specification.

You can now associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Procedure: How to Create an Event Port for MQSeries

To create an event port for an MQSeries queue using iWay Explorer:

  1. Click the iWay Events node.
  2. In the left pane, expand the Oracle node.
  3. Right-click the Ports node and select Add Port from the menu.

    The Add Port dialog box opens.

    1. In the Name field, type a name for the port.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select MQSeries.
    4. In the URL field, enter an MQSeries destination.

      When pointing iWay Explorer to an iBSE deployment, use the following format:

      mqseries:/qManager/qName;host=[hostName];
      port=[port];channel=[channelname];
      errorTo=[predefined port name or another disposition url]

      The following table lists and defines the disposition parameters for MQSeries.

      Parameter

      Description

      qManager

      Name of the queue manager to which the server must connect.

      qName or respqueue

      Name of the queue where messages are placed.

      host

      Name of the host on which MQSeries resides (MQ client only).

      port

      Number to connect to an MQ server queue manager (MQ client only).

      channel

      Case-sensitive name of the channel that connects with the remote MQ Server queue manager (MQ client only). The default channel name is SYSTEM.DEF.SVRCONN.

      errorTo

      Location where error documents are sent. Predefined port name or another full URL. Optional.

  4. Click OK.

    The port appears under the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the even port you created.

You can now associate the event port with a channel. For more information, see Creating a Channel.


Top of page

x
Editing or Deleting an Event Port

The following procedures describe how to edit or delete an event port using iWay Explorer.



x
Procedure: How to Edit an Event Port

To edit an existing event port using iWay Explorer:

  1. Right-click the event port you want to edit.

    The following image shows the options (Edit and Delete) that appear in the left pane when you right-click the event port. In this example, the event port is named FilePort.

  2. Select Edit from the menu.

    The following image shows a sample Edit Port dialog box that opens.

  3. Make the required changes to the event port configuration fields.
  4. Click OK.


x
Procedure: How to Delete an Event Port

To delete an existing event port using iWay Explorer:

  1. Right-click the event port you want to delete.
  2. Select Delete from the menu.
  3. The event port disappears from the list in the left pane.

Top of page

x
Using the Default Event Port

When using iWay Explorer to connect to Oracle E-Business Suite and listen for events, a default event port is available at all times as shown in the following image.

The default event port can be used for testing purposes or when you do not want to route event data to a specific port you configured. The default port is enabled when you start a channel that does not have a specific event port assigned.

The default event data is actually a file disposition that writes to an out.xml file in the following output directory:

ifile://./eventOut/out.xml

iWay Software