Routes
The Routes screen manages the data exchanges that Xchange runs. On the left is the list of all routes, on the right the selected one with its tabs.
What a route is is explained under Routes.
Permissions
The screen follows the Routes permission:
| Level on Routes | What you can do |
|---|---|
| None | the Routes menu item is missing |
| Read only | view every route and each of its tabs; the fields are grayed out, New route and Delete are missing |
| Full | create, change all editable fields, delete |
In the example: A. Vogt has Full and builds the routes. M. Brandt has Read only — Brandt sees the same tabs, all values read-only.

Layout
| Area | Content |
|---|---|
| List (left) | all routes, grouped by connection — the internal routes under "SAP Business One" — plus a search field and the New route button |
| Detail (right) | the selected route in tabs, with a header; the footer appears only when it has something to report |
Both are one page: a click on a row opens it on the right, and the list stays in place. While the detail is open the list is narrow, and its other columns move under the name.
The list
| Column | Content |
|---|---|
| Name | the name of the route |
| Direction | a tag reading Import, Export or Internal |
| Type | Processing or Dispatch |
| Object | what the route actually transfers, read off its configuration, under the name the system uses for it — for an export or internal route the fetch endpoint, for an import route the target path of its primary step, for an action as write intent its path. The column stays empty for a dispatch route and as long as no path is entered |
| Last modified | within the last 24 hours the time since the change, after that the date and time; the exact point in time appears when you point at it with the mouse |
The list is grouped by connection, the groups in alphabetical order. An internal route has no connection; it sits in the group "SAP Business One", which always comes first. Within a group the dispatch route comes first, then the import routes, then the export routes, and the internal routes last; at equal rank, object and then name decide. A route without an object comes first. The order is fixed.
In the example: Under "Kessler Logistik", "Statusmeldungen Kessler" is at the top as the dispatch route. The four import routes follow: first "Fehlzustellung Kessler", whose object is still empty, then "Abholung Kessler", "Transport Kessler" and "Zustellung Kessler", all three on DeliveryNotes. At the very bottom is the export route "Lieferaufträge Kessler".
The direction tag of a dispatch route reads Import — after all, it receives. You recognize it by its different icon and by the Type column.
The search field above it filters by name and description. The description appears under the name only when the search matched it. The search term is kept in the page address and survives a reload and a return from the detail — see History — The filters are in the address.
An editing icon can also appear under the name: the route is open elsewhere right now. The tooltip says where — "Currently being edited by LHOFFMANN" names the other person, "You have this record open in another session" means you yourself in a second window.
If the list is empty or the search finds nothing, the screen says so:
| Situation | Display |
|---|---|
| No route yet | No route created yet — "Create your first route — it defines which data is exchanged." |
| Search without results | No results — "No route matches your search." |
| Service Layer not reachable | Data not available — "Service Layer currently not reachable — entries cannot be loaded right now." |
| Loading failed | Loading failed — "Failed to load routes." |
Creating a route
New route opens a dialog with up to five entries, from top to bottom:

| Field | Meaning |
|---|---|
| Name | Required, at most 150 characters. |
| Direction | Required. Import, Export or Internal. |
| Type | Required. Processing or Dispatch; Dispatch can be chosen only with direction Import. |
| Data origin | Required. Dataset, Queue or Dispatch input — only what fits the direction and type is offered. |
| Connection | Required. The counterpart of the route. With direction Internal the field is missing: the route reads and writes in SAP Business One and has no counterpart. |
The default is Import, Processing and the first fitting data origin. If you point at direction, type or data origin with the mouse, the tooltip "Immutable after creation." appears.
The dialog reports an empty required field only when you choose Create: the field turns red with the hint Required, and the dialog stays open. As soon as you fill the field in, the marking disappears.
The dialog also opens in two other places, then already prefilled: when you create a target route for a rule on the Dispatch tab, and from the hint on the dispatch input on the Automation tab.
Which combinations exist
Direction and type together determine which data origin you can choose:
| Direction | Type | Selectable data origin |
|---|---|---|
| Import | Processing | Dataset, Queue, Dispatch input |
| Import | Dispatch | only Queue |
| Export | Processing | only Dataset |
| Internal | Processing | only Dataset |
If you choose direction Export or Internal, the type jumps to Processing. If only one data origin is left, it is still shown — selected and operable. If you go via Dispatch and back to Processing, the data origin you chose before is back.
When there is no connection
If no connection has been created, the selection is replaced by "No connection configured yet." and, next to it, Create connection, which leads straight there. The link appears only if you may create connections. An internal route can be created without any connection.
Create creates the route and opens it on the right. If that fails, the dialog reports "Could not create the route. Please try again." and stays open.
Header and footer
The header carries the name of the route, next to it its direction tag and below it the connection; for an internal route this line is absent.
| Element | Effect |
|---|---|
| Delete | removes the route together with its entire configuration (below) |
| Full screen / Exit full screen / Close | control how much space the detail gets |
| Messages (footer) | appears as soon as there is an error or a warning, carries a number and opens the list of messages |
| The bar for working through the list (footer) | is there while you work through the checklist — with Previous and Next; see Configuration Snapshots — The checklist |
| The autosave bar (footer) | shows Saving… and Saved, in case of a fault Error saving with Retry, and when the Service Layer is not reachable Waiting for Service Layer |
Xchange saves every entry by itself; there is no Save button. If someone else has changed the same route in the meantime, the bar offers Reload and Save anyway.
Two strips can appear above the tab bar — they apply to the whole route, across all tabs:
| Strip | Text | When |
|---|---|---|
| Conflict | "This record was modified by LHOFFMANN", "This record has been modified in the meantime" or "You changed this record in another session" | Your change met a newer one. If you close the strip, Xchange reloads the route. |
| Presence | "Currently being edited by LHOFFMANN — your changes may conflict" or "You are already editing this record in another session — your changes may conflict" | The route is open elsewhere. If both apply, the strip names the other person. |
What distinguishes the three conflict messages and what you do then is described under Two editors on the same object.
Three situations replace the entire content of the detail:
| Situation | Display |
|---|---|
| Service Layer not reachable | Data not available — "Service Layer currently not reachable — entries cannot be loaded right now." |
| Runtime store not reachable | Data not available — "Runtime store currently not reachable — entries cannot be loaded right now." |
| Route no longer there | Route is no longer available — "This route was deleted or removed after the configuration changed.", plus Back to routes |
The messages
The Messages button in the footer and the list it opens exist on routes and value tables; here they are described for both. A connection has the same button, but counts and orders differently — that is described there.
The number counts the errors, and with zero errors the warnings. A red button with a 3 means three errors, an orange one with a 3 three warnings. The color tells you what is counted. On a value table, a gray button counts the missing required entries when neither errors nor warnings are open.
On a route the messages are ordered by tab. Above each group is the tab they belong to — General, Source data, Mapping, Dispatch, Behavior, Automation.
Each message names its place first. On a route that is the trigger, the additional data, the step, the row or the rule, each with its number, e.g. Row 4: … or Rule 1: …. On a value table it is the entry, e.g. Entry 3: "Source value" is missing. A click on a message takes you to its place.
The number appears only on the button. At the place itself there is a warning sign without a number: red for an error, orange for a warning, gray for missing entries. It sits
- on the tab. The tooltip says what is waiting there — Contains errors, Contains warnings or Has missing entries.
- on a trigger, on additional data and on a dispatch rule, next to the name or the condition, e.g. This trigger has validation issues.
- on the Mapping tab on steps, lists, additional rows and field rows — what it indicates in each case is described under The mapping row.
A single field shows its error in red instead. On a route, missing entries show only through the gray warning sign; the list of messages carries errors and warnings there. On a value table it also carries the Missing required entries group.
A field is marked red as soon as you have edited it, and everywhere after Validate has run on the Configuration Snapshots. Until then it stays quiet, even if the messages already list it. On a value table, after Validate only what the check found turns red — see Value Tables — Entries. If you find nothing red on the screen for a message, a click on it still takes you there.
The messages and the Validate action are two different things. The messages run along while you edit and apply to the open route. Validate on the Configuration Snapshots takes the whole draft and writes the checklist that activation depends on.
General
The first tab carries the entries that make up the route.
| Field | Meaning |
|---|---|
| Name | Required, at most 150 characters. The name under which the route appears in lists. |
| Description | Free, multi-line text, at most 254 characters. The search in the list finds it too. |
| Direction | Display only — Import, Export or Internal. |
| Type | Display only — Processing or Dispatch. |
| Data origin | Display only. For type Dispatch it always shows Queue. |
| Connection | Required, and the only one of the creation entries that can be changed. An internal route does not have the field. |
In the example: "Artikel Webshop" shows direction Export, type Processing, data origin Dataset and connection "Webshop Cambira" here. "Statusmeldungen Kessler" shows the same six fields, only the data origin is Queue, because it is a dispatch route.
The other tabs
They have their own pages:
| Tab | Shown for | Page |
|---|---|---|
| Source data | every route | Routes — Source data |
| Mapping | type Processing | Routes — Mapping |
| Dispatch | type Dispatch | Routes — Dispatch |
| Behavior | type Processing | Routes — Behavior |
| Automation | every route, always as the last one | Routes — Automation |
Mapping and Dispatch exclude each other — every route carries exactly one of the two.
Deleting a route
Delete asks for confirmation. For "Transport Kessler" the question reads: The route "Transport Kessler" and its entire configuration will be deleted. This action cannot be undone. You confirm with Delete.
The whole route is deleted, with source data, mapping or dispatch, and all triggers. Xchange then reports "Route deleted" and closes the detail. If deleting fails, Xchange reports "Failed to delete route."
What else applies
- A change here takes effect only after activation. It is in the draft and applies in operation only with the activated configuration snapshot — see Configuration Snapshots.
- Direction, type and data origin stay what they were at creation. For a different setup, create a new route — see Routes.
- A route is started and paused on Execution, per route.
- Whether a route is complete is shown by the Messages button in the footer: it collects the open points from all tabs.
See also
- The first route (getting started) — the way from the empty list to the finished route
- Two editors on the same object (guide) — what the conflict messages mean and what you do
- Connections (reference) — the counterpart that carries a route
- Routes (core concept) — what a route is and what its three entries determine
- Permissions (core concept) — what the levels on Routes mean