The Modules tab
Lesson 12 of 25 7 min read
Read an integration type's module groups and module routes, and understand the Applies column, which tells you which route actually runs.
The Modules tab tells you which module runs the messages of an integration type, and lets you change it. This lesson teaches you to read it, especially the Applies column, which does the precedence work from the How routing and modules work module for you.
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.
The note at the top
The tab starts with this note:
These are defaults. A published map or profile for an organisation always runs first, and some integrations choose their module in code. A route here applies only when neither does.
This is the two-layer lookup you learned earlier, repeated on the screen so nobody forgets it.
Module groups of the type
Below the note, the tab shows the module groups the type is in. Each group shows as a chip with its message type, for example FTP send (Send). Select a chip to open the group.
If the type isn't in a group, the tab shows Not a member of any module group.
The Module routes card
The Module routes card has one table for each message type that has routes.
| Document type | The document type of the route, or Any document. |
|---|---|
| Module | The name and key of the module. A route for one organisation shows an arrow (↳) before the module. |
| Organisations | All organisations, or the name of one organisation. |
| Source | This type, or Group: and the group name. Select the group name to open the group. |
| Applies | The result of the precedence rules. See below. |
| Enabled | Turns the route on or off. |
| Edit and Delete icons | The pencil and the bin. They show only for the routes of this type, not for group routes. |
The Applies column
- DefaultThis route runs for all organisations that do not have their own route.
- OverrideThis route runs for the one organisation that it names.
- OverriddenThis route is on, but a different route wins. Usually the type has its own route, and this route is from its group.
- IgnoredThis route is off, so the service does not use it.
The order of the rows
For each document type, the table lists:
- the Default first;
- then the Override rows, each with an arrow (↳) pointing from the route it replaces;
- then the routes that don't run: Overridden, then Ignored.
So you can read a table top to bottom: what runs for everyone, who is different, and what is there but not running.
Group routes are read-only here
Group routes show on the type's tab so that you can see which route wins. You can't change them here. Change them on the group page.
No module routes
If the type has no routes, the card shows No module routes. That's correct for many types: their messages use a published map or profile, or a module that the code selects.
Worked example
Using the Acme SFTP Send routes from earlier, the Send table would read:
| Document type | Module | Organisations | Source | Applies |
|---|---|---|---|---|
| Any document | acme-sftp-send | All organisations | This type | Default |
| Any document | ↳ acme-sftp-send-legacy | Hilltop Coffee | This type | Override |
| Any document | ftp-send | All organisations | Group: FTP send | Overridden |
| Any document | ↳ acme-sftp-send-legacy | Riverside Bakery | This type | Ignored |
(Module keys are fictional.) The tab has done the precedence work for you: the group route is beaten by the type's own default, and Riverside Bakery's route is off.
Why isn't the group route running?
A colleague added ftp-send to the FTP send group and expected Acme SFTP to use it. On Acme SFTP's Modules tab, the group route shows Overridden, because Acme SFTP has its own Default route for Send. If the group route should run, delete the type's own route, and the dialog will confirm the group route takes over. If Acme SFTP really needs its own module, leave things as they are.
Recap
- The Modules tab note reminds you that module routes are defaults.
- Group chips show the module groups the type is in.
- Applies shows the outcome: Default, Override, Overridden or Ignored.
- Rows are ordered: Default, then Overrides with ↳, then Overridden, then Ignored.
- Group routes show here but are changed on the group page.
- No module routes is normal for many types.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.