The Modules page
Lesson 16 of 25 6 min read
The catalogue of every module a route can name, the "Not found in the Integrations service" warning, and how to add, edit and delete modules.
Before a route can name a module, the module must be in the platform's list of modules. This lesson shows you that list, how to keep it accurate, and how to spot a module that is listed but doesn't actually exist in the code.
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.
Open Administration → Routing → Modules.
The list
| Module | The name and key of the module. It can also show a warning (see below). |
|---|---|
| Message type | The message type that the module runs. |
| Description | The description, if there is one. |
| Available to | The integration types that the module is available to directly. The module groups that contain it show as Group: chips. Select a chip to open that type or group. |
| Actions | Edit, and Delete in the menu. |
Use the Search box to find a module by its name or key.
A listed module isn't necessarily a real module
Adding a module to this list doesn't make the module exist. The service code must also contain a module with the same key. Think of the list as a catalogue of names that the code is expected to answer to.
The "Not found in the Integrations service" warning
The warning Not found in the Integrations service shows when both of these are true:
- A route that is on names the module, for an integration type that sends that message type to the Integrations service.
- The Integrations service doesn't contain a module with that key.
Messages that need this module fail. Tell a developer. This isn't something you can fix on the screens: either the key is wrong, or the code hasn't been released.
AS2 and Peppol contain their own modules, for example as2-send and peppol-invoice-create. This page doesn't show the warning for them.
Add a module
- Select Add. The Add module dialog opens.
- In Key, type the key that the service code uses, for example
shopify-order-create. You can't change the key later. - In Name, type a name.
- Optional: type a Description.
- In Message type, select the message type that the module runs. You can't change it later.
- Select Create.
If the key is in the list already, the dialog tells you: A module with the key 'x' is catalogued already. Edit that one instead.
Copy the key from the developer
The key must match the code exactly, and you can't change it later. Ask the developer for the exact key and paste it, rather than typing it from memory.
Edit a module
- Select Edit on the row.
- Change the Name or Description.
- Select Update.
You can't change the key or the message type, because the module's routes and groups were checked against its message type.
Delete a module
- Open the menu on the row and select Delete.
- A dialog asks you to confirm. Select Delete.
You can't delete a module while a route, an integration type or a group names it. The dialog tells you why. Remove those links first.
A typo in a module key
You added a module for a new coded integration, with the key acme-sftp-oder-create, made it available to Acme SFTP and set a Create route. The next morning the Modules page shows Not found in the Integrations service on that module, and Hilltop Coffee's orders fail at Create.
The key has a typo, and you can't edit a key. So you add a new module with the correct key (checked with the developer), make it available to Acme SFTP, and change the Create route to use it. Then you delete the old route (if any is left), withdraw the old module from the type, and delete the old module.
Recap
- The Modules page lists every module a route can name.
- A listed module must also exist in the service code with the same key.
- Not found in the Integrations service means an enabled route names a module the Integrations service doesn't have. Messages fail: tell a developer.
- Key and message type are permanent. Name and description can be edited.
- You can't delete a module while a route, type or group names it.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.