Add an integration type with its routing
Lesson 7 of 25 7 min read
Add a new integration type and set its routing in the same dialog, using presets, so that there is never a moment when messages are lost.
When you add an integration type, you can set its routing in the same dialog. Doing both at once prevents a gap where the type supports a message type but has no service, which would lose messages. This lesson walks you through the Add integration type dialog, its presets, and what to do if Supply Lens refuses the routing.
Open the dialog
- Open Administration → Integrations → Integration Types.
- Select Add. The Add integration type dialog opens.
Fill in the details
| Id | The id of the type, in lower-case words with hyphens, for example acme-sftp. You cannot change it later. It cannot be the name of an HTTP client that a coded integration uses. |
|---|---|
| Name | The name that users see. |
| Description | Optional. A description of the type. |
| Enabled and Visible | Switches for the type. Set them as necessary. |
Choose the id carefully
The id is permanent. Coded integrations usually name their HTTP client after themselves, so don't reuse the name of a coded integration as the id of a new type.
Set the routing
The Routing section has one row for each message type. Each row has three controls:
| Supported | The check box with the message type name. Tick it if the type does this message type. |
|---|---|
| Handled by | The service that gets these messages. Available only when the row is ticked. It shows only services that are on and can do this message type. |
| Enabled | Turns the route on or off. A route that is off keeps its service but does not get messages. Shows only on a ticked row. |
When you tick a row, Handled by gets a service automatically. Main integrations service is the default.
Presets
Presets fill in the rows quickly:
| Button | Result |
|---|---|
| Coded integration | Ticks all four rows and sets each one to Main integrations service. |
| AS2 partner | Ticks Send and Receive only, and sets both to AS2 Service. |
| Clear | Removes all ticks. |
A preset uses only its own service. If that service is off, or can't do a message type, the preset doesn't swap in a different service. It leaves those rows clear, and a note tells you which rows and why. For example:
AS2 Service is switched off or does not handle Receive and Send, so the AS2 partner preset left those rows unticked.
After a preset, untick any message type the integration doesn't do. For example, a coded integration that only sends orders and receives shipments might not need all four.
Never tick a row and leave Handled by empty
If a row is ticked with no service, the messages of that type are lost. If the type doesn't do a message type, leave the row clear.
Module routes come later
You don't set module routes in this dialog. Set them on the type's Modules tab after you add the type. A config-driven type needs no module routes at all.
Save
- Select Create.
- If the save is correct, the type page opens.
- If Supply Lens refuses the routing, the dialog stays open. The error shows below the table and the row with the problem shows in red. Supply Lens saves nothing: correct the row and select Create again.
A common reason for a refusal is Routing 'message type': Service 'x' does not exist or is disabled. A row named a service that is off. Another administrator may have switched it off after you opened the dialog. Turn the service on, or choose a different service for that row, then select Create again.
Adding Acme SFTP
You add an integration type for Hilltop Coffee's new SFTP partner. In Id you type acme-sftp, in Name Acme SFTP. The partner sends shipment files and receives order files, and the translation is coded.
You select Coded integration, which ticks all four rows with Main integrations service. All four are needed here (Create and Send for orders out, Receive and Parse for shipments in), so you leave them. You select Create, and the type page opens. Next you'll check the Routing tab shows every row as Live.
Recap
- Set the routing in the Add integration type dialog, so that there's no gap with a supported message type and no service.
- The id is permanent and must not be a coded integration's HTTP client name.
- Presets: Coded integration (all four, Main integrations service), AS2 partner (Send and Receive, AS2 Service), Clear.
- A preset never swaps in a different service. It leaves rows clear and tells you why.
- If Supply Lens refuses the routing, nothing is saved. Fix the red row and select Create again.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.