Defining a Route

How to:

Routes contain references to transforms, processes, and outlets. A route describes the path that a document takes during its passage through the system, after the inlet converts the input message to a document that can be processed. Multiple routes can be defined for the same channel if desired.

Transforms convert the document information to a common format suitable for general business processing. For example, similar messages from two trading partners might differ slightly in format; a common format is often desirable for business processing. Transforms are constructed using iWay Transformer. For more information, see the iWay Transformer User’s Guide.

Processes perform the actual business operations on the document. A business process is composed of one or more services, with appropriate switching, testing, iteration, and error handling. Processes can call on other processes and Web services, and in turn can be packaged as Web services for external consumption. Business processes are constructed using iWay Designer. For more information, see the iWay Designer User’s Guide.

Outlets pass the processed document to one or more designated recipients. They convert the document to a transport format and then emit the message.


Top of page

x
Procedure: How to Define a Route

To define a route using the iWay Service Manager Administration Console:

  1. In the left console pane of the Registry menu, 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. If you click the document schematic icon in the References column for a specific route, you will see which components are referencing that route. (If you click the eye icon in the View column for a specific route, and then the process icon between the two arrows, you will see a visual depiction of that route.)

  2. Click Add.

    The New Route Definition pane opens, as shown in the following image.

  3. Enter a name, for example, SampleRoute, and description for the route.
  4. Click Finish.

    The Construct Route pane opens, as shown in the following image.

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

  5. Click Add.

    The Select component type pane opens, as shown in the following image.

    The table that is provided lists the component types you can select and register with the route you are defining.

    • In Transformer - Exit sequences that apply to a message before processing occurs. For more information on creating transformations, see the iWay Transformer User’s Guide.
    • Process - Stateless, lightweight, and short-lived microflows that are executed by iWay Service Manager on messages and documents as they pass through the system. The simplest process contains a move service, which is first placed into a flow then added to a process. For more information on process flows, see the iWay Designer User’s Guide.
    • Out Transformer - Exit sequences that apply to the message after processing occurs. For more information on creating transformations, see the iWay Transformer User’s Guide.
    • Outlet - Conduits that consist of Preemitters, Encryptors, and Emitters. For more information, see the iWay Service Manager User’s Guide.

    Note: Each route that is being defined is required to have a registered process. The remaining components are optional during route configuration.

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

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

    The table that is provided lists existing process flows you can select for the route you are defining.

  7. Select move and click Finish.

    As shown in the following image, you are returned to the Construct Route pane, which now includes the process (move) you registered with your route (SampleRoute).

    You can now add additional components, such as a transformer or an outlet.

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


iWay Software