Scenario: give one organisation a different module
Lesson 21 of 25 5 min read
Add an Override module route for a single organisation, check it with Preview, and know when an override is the wrong tool.
Sometimes one customer needs an integration type to behave differently from everyone else, for example while a new module is trialled. A module route for one organisation, an Override, does that without touching anyone else. This lesson walks through adding one and checking it.
The steps
- Open the integration type, then the Modules tab.
- Select Set module.
- Select the Message type and Document type.
- In Organisation, select the organisation. Type two or more letters to search.
- Select the Module, then select Set module.
- The new route shows as Override, with an arrow (↳), below the Default.
- Use Preview with that organisation to make sure.
Worked example
Trialling a new Create module for Hilltop Coffee
Developers have written acme-sftp-order-create-v2 (a fictional key) for Acme SFTP. They want it tried on Hilltop Coffee's orders before anyone else gets it.
- On Acme SFTP's Modules tab, you first check Available modules. The v2 module isn't listed, so you make it available.
- You select Set module: Message type Create, Document type Any document (to match the existing Default), Organisation Hilltop Coffee, Module
acme-sftp-order-create-v2, Enabled on. - No "route for this combination exists already" message appears, so this is a new route. You select Set module.
- In the Create table, the new route shows as Override, with ↳, under the Default.
- You run Preview for Create, Any document and Hilltop Coffee: v2 runs. You run it again with no organisation: the Default module runs for everyone else.
When the trial succeeds, you'll change the Default route to v2 with Edit, then delete the override, which the delete dialog confirms sends Hilltop Coffee back to the default.
When an override won't work
An override is still a module route, so it's still only a default for that organisation. It won't take effect if:
- the organisation has a published map or profile for that integration type and document type; or
- the integration's code selects its own module.
In those cases, Preview still shows the override module (it can't see maps, profiles or coded choices), but the real messages use something else. If an override seems to have no effect, check those two first.
Tip
Match the document type of the Default you are overriding. Rule 1 means a one-organisation route wins whatever its document type, but aligned rows make the table much easier for the next person to read.
Recap
- An Override is a module route with one Organisation selected.
- It shows as Override with ↳ under the Default.
- Check it with Preview for that organisation, and without an organisation for everyone else.
- A published map or profile, or a coded choice, still runs before an override.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.