Available modules
Lesson 15 of 25 5 min read
Which modules a route can name, the two ways a module becomes available to an integration type, and how to make one available or withdraw it.
A module route can't name just any module. The module must first be available to the integration type. This lesson explains the two ways that happens and how to manage it from the Available modules card.
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.
Two ways a module is available
A module is available to a type in one of two ways:
- It's made available to the type directly.
- It's in a module group that the type is in.
The Available modules card
| Message type | The message type of the module. |
|---|---|
| Module | The name and key of the module. |
| Through | This type if it is available directly. Group: and the name if it comes from a group. It can show both. |
| Withdraw | A button that shows only for a module that is available directly. |
Make a module available
- In Module to make available, type part of the module name or key, then select the module in the list.
- Select Make available.
The module must already be in the list of all modules (the Modules page). If you can't find it, it may not have been added yet.
Withdraw a module
- Select Withdraw on the row.
- A dialog asks you to confirm. Select Withdraw.
If you withdraw a module:
- routes that already use it stay;
- new routes can't use it, unless a group of the type gives it.
Tip
Withdrawing is a way to stop people choosing a module for new routes. It isn't a way to stop a module running. To stop a module running, change or delete the routes that name it.
You can only withdraw a module that is available directly. A module that comes through a group is managed on the group page.
To add or change a module itself, go to the Modules page, covered in the next module.
A new Create module for Acme SFTP
Developers release a new Create module for Acme SFTP, acme-sftp-order-create-v2 (a fictional key). It's already on the Modules page. On Acme SFTP's Modules tab, you type v2 in Module to make available, select it and select Make available. It appears in the card with Through: This type. Now it shows in the Module list of the Set module dialog, and you can change the Create route to use it.
Recap
- A route can only name a module that is available to the type or group.
- Available means made available directly, or given by a module group the type is in.
- Make available adds a module directly; Withdraw removes a direct one.
- Withdrawing doesn't change existing routes. It only stops new routes using the module.
- Modules themselves are added and edited on the Modules page.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.