Set a module route
Lesson 13 of 25 6 min read
Use the Set module dialog to add or change a route, understand why there is only one route per combination, and fix the most common refusal.
The Set module dialog is how every module route is added or changed, on both the integration type's Modules tab and a module group page. This lesson walks you through its fields, the "one route per combination" rule, and what to do when Supply Lens refuses the route.
Config-driven integration types
This lesson doesn't apply to config-driven integration types. Published maps and profiles choose the work for these types, so they need no module routes.
Open the dialog
On the Modules tab, select Set module to add a route, or the Edit icon (pencil) on a row to change that route.
The fields
| Message type | The message type of the route. On a group page this is fixed: it is the message type of the group. |
|---|---|
| Document type | One document type, or Any document. For Send and Receive, keep Any document: one transport module carries all document types. |
| Organisation | Leave it empty for All organisations. Select an organisation to add an override for that organisation only. Type two or more letters to search. |
| Module | The module to run. The list shows only modules of the selected message type that are available to the type or group. |
| Enabled | On by default. A route that is off is ignored. |
Send and Receive: Any document
Send and Receive move data; they don't translate it. One transport module carries all document types, so keep Any document for those message types.
If the module you want isn't in the Module list, it isn't available to the type or group yet. Make it available first (see Available modules), or check it's in the right message type.
One route for each combination
There's only one route for each combination of organisation, document type and message type. If you save a combination that already has a route, Supply Lens changes that route. It doesn't add a second one.
So when you pick a combination that already has a route, the dialog fills in its module and Enabled value, and this message shows:
A route for this combination exists already. Saving changes its module and switch.
Read that message carefully. If you meant to add a new override, you've probably picked the wrong organisation or document type.
Change a route
When you open the dialog with Edit, the title is Change module. You can change only the Module and Enabled. You can't change the message type, document type or organisation.
To move a route to a different combination, add the new route, then delete the old one.
Save
- Select Set module.
- If Supply Lens refuses the route, the error shows in the dialog.
The most common refusal is:
Integration type 'x' does not support message type 'y'; add that routing support first.
That's layer 1 protecting you: there's no point routing to a module if the messages never reach a service. Select Open the Routing tab, tick Supported for that message type, choose a service, then try again.
Another refusal you may see is Module 'x' serves message type 'y', not 'z'. Select a module of the correct message type.
Giving Acme SFTP its Create module
Acme SFTP's coded Create module, acme-sftp-order-create (a fictional key), is available to the type. You select Set module, choose Create, leave Document type as Any document and Organisation empty, pick the module, and keep Enabled on. You select Set module, and a new Default row appears in the Create table.
A week later you need to change it to a newer module. You select the Edit icon on that row. The dialog title is Change module and only Module and Enabled can be changed, which is exactly what you need.
Recap
- Set module adds or changes a route on a type's Modules tab or a group page.
- Keep Any document for Send and Receive.
- Leave Organisation empty for all organisations; pick one for an override.
- There's one route per organisation, document type and message type. Saving an existing combination changes it.
- Change module can change only the module and Enabled.
- "Does not support message type" means fix routing first: Open the Routing tab.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.