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

To create an event port for File:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, File_Test.
    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 iBSP deployment, specify the destination file using the following format:

      ifile://location;[errorTo=errorDest]

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

      Parameter

      Description

      location

      Full directory path and file name to which the data is written.

      errorDest

      Location to which error logs are sent. Optional.

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

  5. Click OK.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

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

The iBSP disposition enables an event to launch an iWay Business Services method. To create a port for an iBSP disposition using iWay Explorer:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, iBSP_Test.
    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 iBSP destination using the following format:
      ibse:svcName.mthName;[responseTo=responseTo];[errorTo=errorDest]

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

      Parameter

      Description

      svcName

      Name of the service created with iBSP.

      mthName

      Name of the method created for the web service.

      responseTo

      Location to which responses to the web service are posted. Optional.

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

      errorDest

      Location to which error logs are sent. Optional.

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

  5. Click OK.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

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

The MSMQ disposition supports public and private queues. To create a port for an MSMQ disposition using iWay Explorer:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, MSMQ_Test.
    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 format:
      msmq://host/private$/qName;[errorTo=errorDest]

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

      Parameter

      Description

      host

      Name of the host on which the Microsoft Queuing system runs.

      queueType

      Type of queue. 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.

      qName

      Name of the queue in which messages are placed.

      errorTo

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

  5. Click OK.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

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

The JMSQ disposition enables an event to be enqueued to a JMS queue. To create a port for a JMSQ disposition using iWay Explorer:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, JMSQ_Test.
    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 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]

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

      Parameter

      Description

      queue

      JNDI name of a queue to which events are emitted.

      Connection Factory

      Resource that contains information about the JMS Server.

      jndiurl

      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

      JNDI context.INITIAL_CONTEXT_FACTORY provided by the JNDI service provider.

      user

      Valid user name required to access a JMS server.

      password

      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.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

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

To create a port for a SOAP disposition using iWay Explorer:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, SOAP_Test.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select SOAP.
    4. In the URL 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]

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

      Parameter

      Description

      wsdl-url

      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, you can navigate to the iWay Business Services tab and open the Service Description link in a new window. The WSDL URL appears in the Address field.

      Alternatively, you can open the WSDL file in a third-party XML editor (for example, XMLSPY) and view the SOAP request settings.

      soapaction

      Method that is 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, XML Spy) and view the SOAP request settings to find this value.

      method

      Web service method you are using. Value is found in the WSDL file.

      namespace

      XML namespace you are using. Value is found in the WSDL file.

      responseTo

      Location to which responses are posted. Can be a predefined port name or another URL. Optional.

      The URL must be complete, including the protocol.

      errorTo

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

  5. Click OK.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

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

The HTTP disposition uses an HTTP URL to specify an HTTP end point to which the event document is posted. To create a port for an HTTP disposition using iWay Explorer:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, HTTP_Test.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select HTTP.
    4. In the URL field, enter an HTTP destination.

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

      ihttp://url;responseTo=respDest

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

      Parameter

      Description

      url

      URL target for the post operation.

      respDest

      Location to which responses are posted. A predefined port name or another full URL. Optional.

      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.

  5. Click OK.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

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

The MQSeries disposition enables an event to be enqueued to an MQSeries queue. Both queue manager and queue name may be specified. To create a port for an MQSeries disposition using iWay Explorer:

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

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

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

  4. Perform the following steps:
    1. In the Name field, type a name for the port, for example, MQSeries_Test.
    2. In the Description field, type a brief description.
    3. From the Protocol drop-down list, select MQ Series.
    4. In the URL field, enter an MQSeries destination.

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

      mqseries:/qManager/qName;host=[hostname];
      port=[port];channel=[channnelname];
      errorTo=[pre-defined port name or another disposition url]

      The following table lists and describes 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

      Host on which the MQ Server is located (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 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.

    In the left pane, the new event port appears under the ports node. In the right pane, summary information associated with the event port you created is displayed.

    You are ready to associate the event port with a channel.


Top of page

x
Procedure: How to Edit a Port

To edit a port:

  1. In the left pane, right-click the port you want to modify.
  2. Select Edit from the context menu.

    The Edit Port dialog box opens.

  3. Make the required changes to the port configuration and click OK.

Top of page

x
Procedure: How to Delete a Port

To delete a port:

  1. In the left pane, right-click the port you want to delete.
  2. Select Delete from the context menu.

    The port is removed from the list in the left pane.


Top of page

x
Using the Default Event Port

When using iWay Explorer to connect to Salesforce 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