Configuring a Channel

How to:

After you have successfully configured and published a process flow using iWay Designer, you must configure a channel using the iWay Service Manager Administration Console to process the incoming data and route this data to the process flow.

The following hierarchical list shows the channel components that are used in this tutorial along with their naming conventions:


Top of page

x
Procedure: How to Configure a File Listener

To configure a File listener using the iWay Service Manager Administration Console:

  1. Ensure that iWay Service Manager is started on your system.
  2. From the Windows Start menu, select All Programs, iWay 6.1 Service Manager, and then Console.

    The main page of the iWay Service Manager Administration Console opens.

  3. Click Registry in the top pane.

  4. In the left pane, select Listeners.

    The Listeners pane opens, as shown in the following image.

    The table that is provided lists existing listeners and a short description for each.

  5. Click Add.

    The Listener Type pane opens.

  6. Select File from the Type drop-down list and click Next.

    The configuration parameters pane for the File listener opens.

  7. Provide the appropriate configuration properties, as defined in the following table.

    Parameter

    Value

    Input Path

    C:\xml2tbl\in

    Destination

    C:\xml2tbl\out\emp_#.xml

    Suffix In Filter

    xml

  8. Accept the default values for the remaining parameters that are provided.
  9. Click Next.

    The Name and Description pane opens.

  10. In the Name field, type xml2table_fl.
  11. In the Description field, type an optional description, for example, xml file listener for xml2table process.
  12. Click Finish.

    The new File listener (xml2table_fl) is added to the list in the Listeners pane.

    You are now ready to define an inlet and associate it with the new File listener (xml2table_fl).



x
Procedure: How to Define an Inlet for Your Channel

To define an inlet for your channel:

  1. Click Registry in the top pane of the iWay Service Manager Administration Console.
  2. In the left pane, select Inlets.

    The Inlets pane opens, as shown in the following image.

    The table that is provided lists each inlet that is defined with a brief description.

  3. Click Add.

    The New Inlet Definition pane opens.

  4. In the Name field, type xml2table_in.
  5. In the Description field, type an optional description, for example, This inlet is associated with a File listener (xml2table_fl).

  6. Click Finish.

    The Construct Inlet pane opens.

    The table that is provided is used to list the components that are currently registered with the inlet.

  7. Click Add.

    The Select component type pane opens.

  8. Select Listener from the list of component types and click Next.

    The Select a listener definition pane opens, as shown in the following image.

  9. Select xml2table_fl from the list and click Finish.

    You are returned to the Construct Inlet pane, which now includes the File listener (xml2table_fl) you registered with your inlet (xml2table_in).

    If you return to the main Inlets pane, you will notice that the new inlet you just defined (xml2table_in) has been added to the list, as shown in the following image.

    You are now ready to define a route and associate it with the process flow (xml2table_rt) that you created earlier and published to the iWay Registry using iWay Designer.


Top of page

x
Procedure: How to Define a Route for Your Channel

To define a route for your channel:

  1. Click Registry in the top pane of the iWay Service Manager Administration Console.
  2. In the left pane, select Routes.

    The Routes pane opens, as shown in the following image.

    The table that is provided lists each route that is defined with a brief description.

  3. Click Add.

    The New Route Definition pane opens.

  4. In the Name field, type xml2table_rt.
  5. In the Description field, type an optional description, for example, This route is associated with a process flow (xml2table).

  6. Click Finish.

    The Construct Route pane opens.

    The table that is provided is used to list the components that are currently registered with the route.

  7. Click Add.

    The Select component type pane opens.

  8. Select Process from the list of component types and click Next.

    The Select a process definition pane opens, as shown in the following image.

  9. Select xml2table from the list and click Finish.

    You are returned to the Construct Route pane, which now includes the process flow (xml2table) you registered with your route (xml2table_rt).

    If you return to the main Routes pane, you will notice that the new route you just defined (xml2table_rt)) has been added to the list, as shown in the following image.

    You are now ready to construct your channel using the iWay components (inlet and route) that you have defined.


Top of page

x
Procedure: How to Construct Your Channel

After you have defined the inlet (xml2table_in) and route (xml2table_rt), you can combine these components and construct a channel using the iWay Service Manager Administration Console. Every channel is required to have an inlet, a route, and an outlet.

In this example, a predefined default outlet will be used and associated with the new channel.

  1. Click Registry in the top pane of the iWay Service Manager Administration Console.
  2. In the left pane, select Channels.

    The Channels pane opens, as shown in the following image.

    The table that is provided lists each channel that is defined with a brief description.

  3. Click Add.

    The New Channel Definition pane opens.

  4. In the Name field, type xml2table_ch.
  5. In the Description field, type an optional description, for example, This channel contains an inlet (xml2table_in), route (xml2table_rt), and outlet (default.outlet).

  6. Click Finish.

    The Construct Channel pane opens.

    The table that is provided is used to list the components that are currently registered with the channel.

  7. Click Add.

    The Select component type pane opens.

  8. Select Inlet from the list of component types and click Next.

    The select an inlet definition pane opens.

  9. Select xml2table_in from the list and click Finish.

    You are returned to the Construct Channel pane, which now includes the inlet (xml2table_in) you defined earlier.

    You are now ready to add a route to the channel.

  10. Click Add.

    The Select component type pane opens.

    Notice that only the Route and Outlet component types are listed, since you have already added an inlet to the channel.

  11. Select Route from the list of component types and click Next.

    The select one or more route definitions pane opens.

  12. Select xml2table_rt from the list and click Finish.

    You are returned to the Construct Channel pane, which now includes the inlet (xml2table_in) and route (xml2table_rt) you defined earlier.

  13. Click the set default icon in the Conditions column for xml2table_rt to designate this route as the default.

    You are now ready to add an outlet to the channel.

  14. Click Add.

    The Select component type pane opens.

  15. Select Outlet from the list of component types and click Next.

    The select one or more outlet definitions pane opens.

  16. Select default.outlet from the list and click Finish.

    You are returned to the Construct Channel pane, which now includes the inlet (xml2table_in), route (xml2table_rt), and outlet (default.outlet).

    If you return to the main channels pane, you will notice that the channel you just constructed (xml2table_ch) has been added to the list, as shown in the following image.

    After you have designed your channel, you are ready to build and deploy the channel into a run-time environment.


Top of page

x
Procedure: How to Build and Deploy Your Channel

To build and deploy your channel:

  1. Click Registry in the top pane of the iWay Service Manager Administration Console.
  2. In the left pane, select Channels.

    The Channels pane opens, as shown in the following image.

  3. Select the check box next to xml2table_ch and click Build.

    The build result pane for the channel (xml2table_ch) opens.

  4. Click Deployments in the top pane of the iWay Service Manager Administration Console.

    The Deployments pane opens, showing links to Channels, Services, Metrics, and Web Services, in the left pane. By default, Channels is selected and the Channel Management pane is displayed, as shown in the following image.

  5. Click Deploy.

    The Available Channels pane opens.

  6. Select xml2table_ch and click Deploy.

    You are returned to the Channel Management pane. Notice that xml2table_ch is now included in the list of deployed channels.

    Note: Once a channel is deployed, you must also start it. A deployed channel is not started automatically. Notice the red X in the Status column for xml2table_ch.

  7. Select the check box next to xml2table_ch, which is already deployed, and click Start.

    A green checkmark now displays in the Status column, indicating that xml2table_ch is started.

    You can now test your new channel (xml2table_ch) to ensure that it is running properly.


Top of page

x
Procedure: How to Test Your Channel

To test your channel:

  1. Browse to the following folder on your file system:
    C:\xml2tbl
  2. Copy and paste the EmpData.xml sample XML document to the following folder:
    C:\xml2tbl\in

    To view a copy of the EmpData.xml sample XML document, see Employee XML Document (EmpData.xml).

  3. Using a third-party query tool, execute the SQL Insert statement that you prepared and tested.

    Check to see that a new record is listed in the database table.


iWay Software