Module groups

Lesson 17 of 25 7 min read

Create a module group, add its modules and member types, move a type between groups, and remove a member without breaking its messages.

When many integration types do the same job in the same way, a module group lets you set the module once and share it. This lesson shows you the Module Groups list, how to create a group, and how to manage its modules and member types safely.

Config-driven integration types

This lesson doesn't apply to config-driven integration types. Don't add a config-driven type to a module group.

The list of groups

Open Administration → Routing → Module Groups.

The Module Groups page listing groups with their message type, number of modules and number of member types — The Module Groups page

Group	The name and id. Select the name to open the group.
Message type	The one message type of the group.
Modules	How many modules the group has.
Member types	How many integration types are in the group.
Actions	Rename, and Delete in the menu.

Use the Search box to find a group by its name or id.

Add a group

Select Add. The Add module group dialog opens.
In Id, type the id, for example ftp-send. You can't change it later.
In Name, type a name.
In Message type, select the one message type of the group. You can't change it later.
Select Create. The group page opens.

The Add module group dialog with Id, Name and Message type fields — The Add module group dialog

To delete a group, open the menu on its row and select Delete. You can't delete a group while it has routes, modules or member types. Remove them first.

The group page

Select a group name in the list to open its page.

A module group page with its message type at the top, a Modules card, a Member types card and a routes card — The module group page

The text at the top gives the message type of the group. The buttons at the top are Rename, Refresh and Delete.

A group route doesn't make messages arrive

Each member type must also send the group's message type to a service on its own Routing tab. A group handles layer 2 only; layer 1 is always per type.

Rendering diagram...

Modules

The Modules card lists the modules that the group's routes can name. All member types can also use them in their own routes.

To add a module:

In Module to add, type part of the module name or key, then select it. The list shows only modules of the group's message type.
Select Add.

To remove a module, select Remove on its row, then confirm. Routes that already use it stay. Member types can no longer select it, unless it's available to them directly.

Member types

The Member types card lists the integration types that use the group's routes. Select a type name to open its Modules tab.

To add a type:

In Integration type to add, type part of the type name or id, then select it.
Select Add.

An integration type can be in only one group for each message type. If the type is already in a different group for the same message type, a dialog asks: Move it from group name?

Select Move. Supply Lens removes the type from the other group, then adds it to this group.
Select Cancel to make no change.

A dialog asking whether to move the integration type from its current group, with Move and Cancel buttons — The dialog that offers to move a type from another group

Before you select Move, check what the type was getting from the old group. After the move it gets this group's routes instead.

To remove a type:

Select Remove on its row.
A dialog asks you to confirm. Read the warning.
Select Remove.

Removing a member can make its messages fail

The type stops using the group routes immediately. If it has no route of its own, and no published map, profile or coded module, its messages find no module and fail.

Taking one type out of a group

The Acme SFTP type is in the FTP send group, but Hilltop Coffee's partner now needs a different Send module for every organisation. Before removing Acme SFTP from the group, you add its own Send route on its Modules tab with Any document and All organisations. That route now wins over the group route anyway (the type beats its group). Then you remove Acme SFTP from the group, knowing its Send messages still have a module.

Recap

A module group shares routes for one message type across many types. Its id and message type are permanent.
The group page has Modules, Member types and routes cards.
A group doesn't route messages to a service: each member's Routing tab must still be Live.
A type can be in one group per message type. Adding it to another offers Move.
Removing a member stops it using group routes immediately. Give it its own route first if it needs one.

Complete and continue

Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.

The Modules page Group routes