Turn off, delete and preview routes
Lesson 14 of 25 6 min read
Turn a route on or off, delete one safely by reading what takes over, and use Preview to check which module the routes select.
Removing or disabling a module route changes what runs, sometimes for every organisation. This lesson shows you how to do it safely, and how to use the Preview card to check the result before a real message tests it 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.
Add or change a route
As a reminder: select Set module to add a route, or the Edit icon on a row to change that route. Both open the Set module dialog.
Turn a route on or off
Use the route's Enabled switch. A route that is off shows as Ignored, and the service doesn't use it. This is the gentle way to stop a route while keeping it for later.
Delete a route
- Select the Delete icon (bin) on the row.
- A dialog asks you to confirm. Read the warning.
- Select Delete.
The dialog tells you what will happen:
- If a different route takes over, for example the route of a module group of the type, the dialog names it.
- If the route is for one organisation, that organisation goes back to the default route.
- If the route doesn't run (Overridden or Ignored), nothing changes for messages.
Deleting the default can make messages fail
If you delete the route that runs for all organisations, and no other route takes over, the messages find no module and fail. They don't fail if a published map or profile, or the integration's code, selects a module. The dialog warns you when this applies.
Preview
The Preview card tells you which module the routes select for one message, using the precedence rules.
- Select a Message type.
- Select a Document type, or keep Any document.
- Optional: select an organisation. Leave it empty to see the default.
- Select Preview.
The result is one of two:
- Module name (key) runs, unless a published map or profile, or the integration's code, chooses first.
- No route matches. This shows in orange. The messages fail unless a published map or profile, or the code, selects a module.
What Preview can't see
The Preview uses module routes only. It doesn't know about published maps and profiles, or about modules that the code selects. So:
| Preview says | It could still be that… |
|---|---|
| A module runs | A published map or profile, or the code, runs instead. |
| No route matches | Nothing is wrong, because a published map or profile, or the code, selects the work. That's normal for config-driven types. |
Removing Hilltop Coffee's override
Hilltop Coffee has an Override on Acme SFTP's Send messages and no longer needs it. Before you delete it, you run Preview for Send, Any document and Hilltop Coffee: it shows the override module. You delete the override; the dialog says Hilltop Coffee goes back to the default route. You run Preview again with Hilltop Coffee and now see the Default module. Done, with no guesswork.
Recap
- Turning a route off makes it Ignored. It stays for later.
- The delete dialog says what takes over: a group route, the default, or nothing changes.
- Deleting the all-organisations route with nothing to take over makes messages fail, unless a map, profile or the code selects the work.
- Preview shows which module the routes select for a message, document type and organisation.
- Preview sees module routes only, not published maps and profiles or coded choices.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.