iWay Transaction Adapter for IMS User's Guide > Event Processing With the IMS Adapter > Creating and Modifying an Event Port

Creating and Modifying an Event Port

How to:

You can create, edit, or delete an Event port using iWay Explorer.

You create a port for an IMS Message from the iWay Adapters tab or from the iWay Events tab. You can use an iBSE using the Available Hosts drop-down list in iWay Explorer.

The following dispositions are available when using iWay Explorer in conjunction with an iBSP deployment.

Procedure: How to Create an Event Port for File

To create an event port for File:

  1. Click the iWay Events tab.
  2. In the left pane, expand the IMS 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 as shown in the following image where you choose parameters for the new port.

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

      Note: Ensure that you specify a name that conforms to standards set by IMS. For example, when using IMS, periods are not allowed. You must remove all instances of this character.

    2. In the Description field, type a brief description.
    3. From the Disposition Protocol drop-down list, select FILE.
    4. In the Disposition 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=[pre-defined port name or another disposition url]

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

      errorTo

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

  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.

Procedure: How to Create an Event Port for iBSP

To create an Event port for iBSP:

  1. Click the iWay Events tab.
  2. In the left pane, expand the IMS 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 iBSE.
    4. In the Disposition 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.

      responseTo

      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.

  5. 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.

Procedure: How to Create a Port for the MSMQ Disposition

To create a port for an MSMQ disposition using iWay Explorer:

  1. Click the iWay Events tab.
  2. In the left pane, expand the IMS 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 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]

      The following table defines the parameters for the disposition.

      Parameter

      Description

      host

      Machine name where the Microsoft Queuing system is running.

      Queue Type

      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 private queue where messages are placed.

      errorTo

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

  5. 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.

Procedure: How to Create an Event Port for the JMS Queue Disposition

To create a port for a JMS queue disposition using iWay Explorer:

  1. Click the iWay Events tab.
  2. In the left pane, expand the IMS 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 JMSQ.
    4. 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]

      The following table lists and defines the 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 the JNDI provider that 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 where error logs are sent. Optional.

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

  5. 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.

Procedure: How to Create a Port for the SOAP Disposition

To create a port for a SOAP disposition:

  1. Click the iWay Events tab.
  2. In the left pane, expand the IMS 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]

      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/ibse/IBSEServlet/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 and open the Service Description hyperlink in a new window. The WSDL URL appears in the Address field.

      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.

      To find this value, navigate to the iWay Business Services tab and open the Service Description hyperlink in a new window. Perform a search for soapAction.

      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

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

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

      errorTo

      Location where error logs are sent. Optional.

      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.

Procedure: How to Create an Event Port For HTTP

To create an Event port for HTTP:

  1. In the left pane of iWay Explorer, select the iWay Events tab.
  2. Expand the IMS 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.

  5. In the Port Name field, type a name for the Event port.
  6. In the Description field, type a brief description for the port (optional).
  7. From the Disposition Protocol drop-down list, select HTTP.
  8. In the Disposition field, enter an HTTP destination.

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

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

    The following table lists and describes the parameters for the HTTP disposition when using an iBSP deployment.

    Parameter

    Description

    myurl

    URL target for the post operation, for example,

    http://myhost:1234/docroot

    responseTo

    Location to which responses are posted. Optional.

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

  9. 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.

Procedure: How to Create a Port for the MQSeries Disposition

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

  1. Click the iWay Events tab.
  2. In the left pane, expand the IMS 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 MQSeries.
    4. 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]

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

      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. Predefined port name or another full URL. Optional.

  5. 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.

Procedure: How to Edit an Event Port

To edit an event port:

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

    The Edit Port pane opens on the right.

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

Procedure: How to Delete an Event Port

To delete an 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.