Which module route applies

An integration type can have several module routes that could match the same message: one for all organisations, one for a single customer, one inherited from a group. This lesson teaches you the rules the service uses to pick one, so that you can predict the result before you open the Preview.

What a module route is made of

A module route is a rule for one combination of:

• an integration type, or a module group the type belongs to;
• a message type;
• a document type, or Any document;
• all organisations, or one organisation.

It names one module, and it can be enabled or disabled.

The three precedence rules

When more than one route matches a message, the service applies these rules, in this order:

1. A route for one organisation applies before a route for all organisations.
2. A route for one document type applies before a route for any document.
3. A route for the integration type applies before a route for its module group.

The service ignores a route that is disabled.

Worked example

The Acme SFTP integration type is in the module group FTP send for the Send message type. These Send routes exist:

(The module keys are fictional.)

A Send message for Hilltop Coffee. Route 3 is for Hilltop Coffee, so rule 1 picks it over routes 1 and 2. acme-sftp-send-legacy runs.

A Send message for Riverside Bakery. Route 4 is for Riverside Bakery, but it's off, so the service ignores it. That leaves routes 1 and 2, both for all organisations and any document. Rule 3 picks the type's own route over the group's. acme-sftp-send runs.

A Send message for any other organisation. Same as Riverside Bakery: route 2 beats the group route 1. acme-sftp-send runs.

So in this example the group route never runs. On the Modules tab it would show as Overridden. You'll meet that label in the Module configuration module.

Module groups

A module group lets one module route apply to many integration types. For example, the group FTP send can give the same Send module to all SFTP integration types, so you set the route once rather than on every type.

Two rules shape how groups work:

• A group is for one message type only.
• An integration type can be in only one group for each message type.

Because of rule 3, a type's own route always beats its group's route for the same message, document type and organisations. That gives you a clean pattern: set the common case once on the group, and override on the one type that is different.