Creating, Editing, or Deleting a Channel

How to:

All defined event ports must be associated with a channel. You can create, edit, or delete a channel for your event adapter using iWay Explorer. For information on creating a channel, see How to Create a Channel. For information on editing a channel, see How to Edit a Channel. For information on deleting a channel, see How to Delete a Channel.

You can also create a channel using one of the following protocols:


Top of page

x
Procedure: How to Create a Channel

To create a channel using iWay Explorer:

  1. Click the iWay Events tab.
    1. In the left pane, expand the PeopleSoft node.

      The ports and channels nodes appear.

    2. Click the channels node.
  2. In the right pane, move the pointer over Operations and select Add a new channel.

    The Add a new PEOPLESOFT channel pane opens on the right as shown in the following image.

    1. In the Channel Name field, type a name, for example, TEST_CHANNEL.
    2. In the Description field, type a brief description (optional).
    3. From the Channel Type drop-down list, select a channel type, for example, HTTP Listener.
  3. Click Next.

    The Edit channels pane opens on the right as shown in the following image where you enter the listener port number and choose the synchronization type from the drop-down list.

    Note: The adapter supports only Request-Response and Request-Ack synchronization types.

  4. Enter information specific to your PeopleSoft system and the channel you are creating.

    Note: Https is not supported by the adapter.

  5. Click Next.

    The Select Ports pane opens as shown in the following image. Current ports appear on the left and available ports appear on the right. Arrow buttons are active to use to move the port from one list to the other. Back, Finish, and Cancel buttons are active.

    1. Select an event port from the list of current ports.
    2. To transfer the port to the list of available ports, click the single right arrow button. To associate all event ports, click the double right arrow button.
  6. Click Finish.

    The channel appears in the left pane under the channels port with an X over the icon to indicate that the channel is disconnected as shown in the following image.

    A summary window opens in the right pane, showing the channel description, channel status, and available ports. All the information in the summary is associated with the channel you created.

    You must start the channel to activate your event configuration.

  7. In the right pane, move the pointer over Operations and select Start the channel.

    When the channel is activated, the X over the icon in the left pane disappears.

    To stop the channel at any time, you can move the pointer over Operations and select the option to stop the channel.


Top of page

x
Procedure: How to Create an HTTP Channel

To create an HTTP channel using iWay Explorer:

  1. Click the iWay Events tab.
    1. In the left pane, expand the PeopleSoft node.

      The ports and channels nodes appear.

    2. Click the channels node.
  2. In the right pane, move the pointer over Operations and select Add a new channel.

    The Add a new PEOPLESOFT channel pane opens on the right.

    1. Type a name for the channel, for example, NewChannel.
    2. Type a brief description (optional).
    3. From the drop-down list, select HTTP Listener.
  3. Click Next.

    The Edit Channels pane opens on the right.

  4. Provide the required values based on the list of parameters and their descriptions in the following table.

    Parameter

    Description

    Listener port

    Port on which to listen for PeopleSoft event data.

    HTTPS

    For a secure HTTP connection, select this check box.

    Synchronization Type

    Choose from three synchronization options:

    • REQUEST
    • REQUEST_RESPONSE
    • REQUEST_ACK

  5. Click Next.

    The Select Ports pane opens.

    1. Select an event port from the list of current ports.
    2. To transfer the port to the list of available ports, click the single right arrow button. To associate all the event ports, click the double right arrow button.
  6. Click Finish.

    The channel appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.

    You must start the channel to activate your event configuration.

    In the right pane, a summary provides the channel description, channel status, and available ports. All the information is associated with the channel you created.

  7. In the right pane, move the pointer over Operations and select Start the channel.

    When the channel is activated, the X over the icon in the left pane disappears.

    To stop the channel at any time, you can move the pointer over Operations and select the option to stop the channel.



x
Procedure: How to Create a File Channel

To create a File channel using iWay Explorer:

  1. Click the iWay Events tab.
    1. In the left pane, expand the PeopleSoft node.

      The ports and channels nodes appear.

    2. Click the channels node.
  2. In the right pane, move the pointer over Operations and select Add a new channel.

    The Add a new PEOPLESOFT channel pane opens on the right.

    1. Type a name for the channel, for example, NewChannel.
    2. Type a brief description (optional).
    3. From the drop-down list, select File Listener.
  3. To open the Edit Channels pane, click Next.
    1. In the Request tab, enter values based on the descriptions in the following table.

      Parameter

      Description

      Polling Location

      Target file system location for the PeopleSoft XML file.

      File Mask

      File name to use for the output file generated as a result of the operation.

    2. In the Response tab, enter values for the parameters based on the descriptions in the following table.

      Parameter

      Description

      Synchronization Type

      Choose from three options:

      • REQUEST
      • REQUEST_RESPONSE
      • REQUEST_ACK

      Response/Ack Directory

      Target file system location for the PeopleSoft XML file.

    3. In the Advanced tab, enter values for the parameters based on the descriptions in the following table.

      Parameter

      Description

      Error Directory

      Directory to which documents with errors are written.

      Poll interval (msec):

      Interval (in milliseconds) when to check for new input. Optional. Three seconds is the default.

      Processing Mode

      Sequential indicates single processing of requests.

      Threaded indicates processing of multiple requests simultaneously.

      Thread limit

      If you selected threaded processing, indicates the maximum number of requests that can be processed simultaneously.

  4. Click Next.

    The Select Ports pane opens.

    1. Select an event port from the list of current ports.
    2. To transfer the port to the list of available ports, click the single right arrow button. To associate all the event ports, click the double right arrow button.
  5. Click Finish.

    The channel appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.

    You must start the channel to activate your event configuration.

    In the right pane, a summary provides the channel description, channel status, and available ports. All the information is associated with the channel you created.

  6. Move the pointer over Operations and select Start the channel.

    When the channel is activated, the X over the icon in the left pane disappears.

    To stop the channel at any time, you can move the pointer over Operations and select the option to stop the channel.



x
Procedure: How to Create a TCP Channel

To create an TCP channel using iWay Explorer:

  1. Click the iWay Events tab.
    1. In the left pane, expand the PeopleSoft node.

      The ports and channels nodes appear.

    2. Click the channels node.
  2. In the right pane, move the pointer over Operations and select Add a new channel.

    The Add a new PEOPLESOFT channel pane opens on the right.

    1. Type a name for the channel, for example, NewChannel.
    2. Type a brief description (optional).
    3. From the drop-down list, select TCP Listener.
  3. Click Next.

    The Edit Channels window opens on the right.

  4. Enter values for the parameters based on the descriptions in the following table:

    Property Name

    Property Description

    Host

    Host machine on which the adapter is installed.

    Port Number

    Socket number on which iWay Service Manager listens for incoming messages from a client application.

    Synchronization Type

    Choose from the following synchronization options:

    • RECEIVE_REPLY
    • RECEIVE_ACK
    • RECEIVE

    Is Length Prefix

    For PeopleSoft events that return data that is not in XML format. The TCP/IP event application must prefix the data with a 4-byte binary length field when writing data to the TCP/IP port.

    Is XML

    For PeopleSoft events that return data in XML format. No preparser is required.

    Is Keep Alive

    Maintains continuous communication between the event transaction and the channel.

  5. Click Next.

    The Select Ports pane opens.

    1. Select an event port from the list of current ports.
    2. To transfer the port to the list of available ports, click the single right arrow button. To associate all the event ports, click the double right arrow button.
  6. Click Finish.

    The channel appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.

    You must start the channel to activate your event configuration.

    In the right pane, a summary provides the channel description, channel status, and available ports. All the information is associated with the channel you created.

  7. Move the pointer over Operations and select Start the channel.

    When the channel is activated, the X over the icon in the left pane disappears.

    To stop the channel at any time, you can move the pointer over Operations and select the option to stop the channel.



x
Procedure: How to Edit a Channel

To edit a channel:

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

    The Edit channel pane opens on the right and includes current information for Channel Name, Description, and Channel Type as shown in the following image.

  3. Make the required changes to the channel configuration fields.
  4. Click Next to continue making changes on the next pane.
  5. When you are finished making your changes, click Finish.

Top of page

x
Procedure: How to Delete a Channel

To delete a channel:

  1. In the left pane, select the channel you want to delete.
  2. In the right pane, move the pointer over Operations and select Delete.

    A confirmation dialog box opens, as shown in the following image.

  3. To delete the channel you selected, click OK.

    The channel disappears from the list in the left pane.


iWay Software