Skip to content

Route

Jump to bottom
assimbly edited this page May 24, 2022 · 10 revisions

Routes

What is a route?

Routes define the integration flow. A flow can contain one or multiple routes.

Each route contains multiple steps that look something like this:

<route>
    <from uri="file:home/customers/new"/>
    <log message="Received a new customer!"/>
    <to uri="file:home/customers/old"/>
</route>

The route above is defined with the help of Camel XML DSL. In each step of the route there is an action to process data. Such actions can be picking up of a file, filter, log the message and so on. See Camel Documentation or Camel in Action for all possibilities.

Typically the routes together form a service you can find on an Enterprise Service Bus.

Create a route

There are multiple ways to create new routes:

1. GUI

The default way to create a new flow is to use the gui.

  • On the flows page click the Action button and choose "Create Routes".
  • Give the flow a name.
  • Select an existing route or click on the plus button to add a new route.

When the route is added or modified an XML editor is opened. There you can edit the route as XML.

2. Editor

Use a text editor to a text editor (like Notepad++ or Visual Studio Code) and create an XML file. The XML file can be either in Assimbly format or in Camel XML format.

On the deployment page (administration --> deployment) there is an import button where a XML configuration can be imported.

3. Clone

When clicking on the name of flow in the main page you get a view of the flow configuration. When clicking on the "Clone" button the wizard opens with this configuration. There you can change every part of the configuration (for example giving the flow a new name) and save the configuration.

Running a flow

A flow have 5 basic actions:

  • Start
  • Stop
  • Pause
  • Resume
  • Restart

From the main page the actions which are available have active buttons. When you start a flow you can see the status of flow change from inactive to active. In case of an error the status button gets red. You can hover the status button to get more info.

Running from the deploy directory

Routes can also run by saving the route as files in the deploy directory.

Alternative ways to run a flow

There are various other ways of running flows like using the API.

Clone this wiki locally