Creating an Event Port

In this section:

You can listen for Siebel Integration Object events by configuring ports and channels. There are two methods to create an event in iWay Explorer, through the iWay Adapters tab or the iWay Events tab. This section describes both methods.


Top of page

x
Creating an Event Port From the iWay Adapters Tab

For Siebel Integration Objects, you can bypass the iWay Events tab and create an event port directly from the iWay Adapters tab.



x
Procedure: How to Create an Event Port From the iWay Adapters Tab

To create an event port from the iWay Adapters tab:

  1. Select the Integration Object node you created.
  2. Move the pointer over Operations and select Create iWay Event Port.

    The following image shows the Create iWay Event Port pane that opens on the right where you can create a port.

    1. In the Event Port Name field, type a name for the port.
    2. In the Event Port Description field, provide a brief description of the port.
    3. From the Disposition Protocol drop-down list, select the required disposition, for example, FILE.
  3. Click Next.

    The following image shows the navigation pane on the left and the Specify Disposition pane that opens on the right and has information about the disposition type, a field for the disposition URL, a Help button, and three action buttons.

  4. Type the disposition URL and click Finish.

Top of page

x
Creating an Event Port From the iWay Events Tab

The following procedures describe how to create an event port from the iWay Events window for various dispositions using iWay Explorer.

The following dispositions are available when using the servlet iWay Explorer in conjunction with an iBSP implementation.

Note: The MAIL disposition option will be supported in a future release.

To create an event port for Siebel Integration Objects, you must first indicate the location of the XDR schema for that object. For more information, see Creating an Event Port.

You also can create an event port directly from the iWay Adapters tab. For more information, see Creating an Event Port From the iWay Adapters Tab.



x
Procedure: How to Create an Event Port for the File Disposition

To create a specific event port for the File disposition:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The following image shows the Create New Port pane that opens on the right.

    1. In the Port Name field, type a name for the event port.
    2. In the Description field, provide a brief description of the port.
    3. From the Disposition Protocol drop-down list, select FILE.
    4. In the Disposition field, provide a destination where the event data is written.

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

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

      For example:

      ifile://D:\in\x.txt;errorTo=ifile://D:\error
    5. Provide values for the parameters from the following table.

      The following table includes the name and description of each parameter.

      Parameter

      Description

      location

      The destination and filename of the document where event data is written, for example, D:\in\x.txt.

      errorTo

      Predefined port name or another disposition URL to which error logs are sent. Optional.

  5. 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 event port you created.

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



x
Procedure: How to Create an Event Port for iBSP

You can call iWay Business Services created through the iWay Business Services Provider (iBSP).

To create an event port for iBSP:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The Create Event Port pane opens on the right.

    1. In the Port Name field, type a name for the connection.

      The name is used to build a repository entry as well as to identify the connection.

    2. In the Description field, type a description for the target name you just created.
    3. From the Disposition Protocol drop-down list, select iBSP.
    4. In the Disposition field, enter an iBSP 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]
    5. Provide values for the parameters from the following table.

      The following table includes the name and description of each parameter.

      Parameter

      Description

      svcName

      Name of the service created with iBSP.

      mthName

      Name of the method created for the web service.

      responseTo

      Location where responses to the web service are posted. A predefined port name or another full URL. Optional.

      errorTo

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

  5. 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 event port you created.

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



x
Procedure: How to Create an Event Port for a JMS Queue

To create an event port for a JMS queue:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The Create Event Port pane opens on the right.

    1. Type a name for the event port and provide a brief description.
    2. From the Disposition Protocol drop-down list, select JMSQ.
    3. In the Disposition field, enter a JMS destination.

      When pointing iWay Explorer to an iBSP 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]
    4. Provide values for the parameters from the following table.

      The following table includes the name and description of each parameter.

      Parameter

      Description

      queue

      JNDI name of a queue to which events are emitted.

      Connection Factory

      A resource that contains information about the JMS Server.

      jndiurl

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

      java.naming.provider.url

      jndifactory

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

      user

      A valid user name required to access a JMS server.

      password

      A valid password required to access a JMS server.

      errorTo

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

  5. 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 event port you created.

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



x
Procedure: How to Create an Event Port for MSMQ

To create an event port for MSMQ:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The Create Event Port pane opens on the right.

    1. In the Port Name field, type a name for the connection, for example, Queue1_on_NTK.

      The name is used to build a repository entry as well as to identify the connection.

    2. In the Description field, type a description for the target name you just created.
    3. From the Disposition Protocol drop-down list, select MSMQ.
    4. In the Disposition field, enter a MSMQ destination in the form of:
      msmq:/host/private$/qName;
      errorTo=[pre-defined port name or another disposition url]
    5. Provide values for the parameters from the following table.

      The following table includes the name and description of each parameter.

      Parameter

      Description

      host

      Machine name where the Microsoft Queuing system is running.

      Queue Type

      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.

      For private queues, enter Private$.

      qName

      Name of the private queue where messages are placed.

      errorTo

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

  5. 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 event port you created.

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



x
Procedure: How to Create a Port for a SOAP Disposition

To create a port for a SOAP disposition:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The Create New Port pane opens on the right.

    1. In the Port Name field, type a name for the event.
    2. In the Description field, type a brief description.
    3. From the Disposition Protocol drop-down list, select SOAP.
    4. In the Disposition field, enter a 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]
    5. Provide values for the parameters from the following table.

      The following table includes the name and description of each parameter.

      Parameter

      Description

      wsdl-url

      The URL to the WSDL file that is required to create the SOAP message. For example:

      http://localhost:7001/ibse/IBSEServlet/
      test/webservice.ibs?wsdl

      where:

      webservice

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

      This value can be found by navigating to the iWay Business Services tab and opening the Service Description link in a new window. The WSDL URL appears in the Address field.

      You also can 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 that will be 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, opening the Service Description link in a new window, and performing 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 can be found in the WSDL file.

      namespace

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

      responseTo

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

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

      errorTo

      The location to which error logs are sent. Optional.

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

  5. 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 event port you created.



x
Procedure: How to Create an Event Port for an HTTP Disposition

To create an event port for an HTTP disposition:

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The Create Event Port pane opens on the right.

    1. Type an event port name and a brief description.
    2. From the disposition protocol drop-down list, select HTTP.
    3. From the Disposition field, enter an HTTP destination.

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

      ihttp://[myurl];
      responseTo=[pre-defined port name or another disposition url];

      The following table includes the name and description of each parameter.

      Parameter

      Description

      url

      Is the URL target for the post operation, for example

      http://myhost:1234/docroot

      responseTo

      Is the location where responses are posted (optional).

      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 event port you created.

  5. Click OK.

    The port appears under the ports node in the left pane.



x
Procedure: How to Create an Event Port for an MQSeries Disposition

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

  1. Click the iWay Events tab.
  2. In the left pane, expand the Siebel node.
  3. Select the ports node.
  4. Move the pointer over Operations and select Add a new port.

    The Create Event Port pane opens on the right.

    1. Type an event port name and a brief description.
    2. From the disposition protocol drop-down list, select MQSeries.
    3. In the Disposition field, enter an MQSeries destination.

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

      mqseries:/qManager/qName;host=[hostname];
      port=[port];channel=[channnelname];
      errorTo=[pre-defined port name or another disposition url]
    4. Provide values for the parameters from the following table.

      The following table includes the name and description of each parameter.

      Parameter

      Description

      qManager

      Is the name of the queue manager to which the server must connect.

      qName or respqueue

      Name of the queue where messages are placed.

      host

      The host on which the MQ Server is located (MQ Client only).

      port

      The number to connect to an MQ Server queue manager (MQ client only).

      channel

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

      errorTo

      Location where error documents are sent. This can be a predefined port name or another full URL. Optional.

  5. Click OK.

    The newly created event port appears under the port section of the event adapter in the left pane.


Top of page

x
Editing or Deleting an Event Port

The following procedures provide information on how to modify or delete an event port.



x
Procedure: How to Edit an Event Port

To edit an existing event port:

  1. In the left pane, select the event port you want to edit.
  2. In the right pane, move the pointer over Operations and select Edit.

    The following image shows the Edit Port pane that opens on the right. It includes a field for typing the port name, a field for typing a description, a drop-down list for selecting the disposition protocol, and a field for specifying the disposition. It also includes a Help button and two action buttons.

  3. Make the required changes to the Description, Disposition Protocol, or Disposition fields, and click OK.

    Note: The Edit Port pane does not allow you to change the name of the port, only the parameters.



x
Procedure: How to Delete an Event Port

To delete an existing event port:

  1. Select the event port you want to delete.
  2. In the right pane, move the pointer over Operations and select Delete.

    A confirmation dialog box opens.

  3. To delete the event port you selected, click OK.

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