Scenario: a config-driven integration type
Lesson 20 of 25 7 min read
Set up the routing side of a config-driven integration type, link it to the Maps & Profiles set-up, and check the right map or profile runs.
A config-driven integration type does its work with published maps and profiles instead of modules. It still needs routing, and it must stay out of module routes and groups. This lesson walks through the full set-up of a new config-driven 3PL type, showing where this course ends and Maps & Profiles in Prism takes over.
The steps
- Add the integration type. In the Routing section, tick each message type the integration does. Choose the service for each row, usually Main integrations service.
- Open the Routing tab. Make sure each supported row shows Live.
- Don't add module routes on the Modules tab. Don't add the type to a module group.
- On the Details tab, set Categories. Organisations see a type in the add integration dialog only when it's in a category.
- Set up the type in Administration → Maps & Profiles: a Connect Profile so that organisations can connect it, a Client Profile if its send or receive profiles need one, and Settings Schemas if it needs a settings form.
- In each organisation's Maps & Profiles screens, create and publish a map or profile for each supported message type.
- To see which map or profile runs, use What actually runs in the organisation's Maps & Profiles screens. Don't use the Preview on the Modules tab.
Step 6 uses this table:
| Message type | Map or profile |
|---|---|
| Create | Create map |
| Parse | Parse map |
| Receive | Receive profile |
| Send | Send profile |
Worked example
Northgate Logistics, a config-driven 3PL
Hilltop Coffee is moving its warehousing to Northgate Logistics, a fictional 3PL with a REST API. The team will build the integration as config rather than code. Northgate takes warehouse orders and returns shipment confirmations, so the type needs all four message types: Create and Send for orders out, Receive and Parse for shipments back.
Routing (this course).
- In Administration → Integrations → Integration Types you select Add. Id
northgate-logistics, name Northgate Logistics. In Routing you tick all four rows. Each gets Main integrations service automatically. (The Coded integration preset would give the same result, but ticking the rows yourself makes you think about each one.) You select Create. - On the Routing tab, all four rows show Live.
- You leave the Modules tab alone: it shows No module routes, which is correct.
- On Details, you add the type to the 3PL category and select Save. Without a category, Hilltop Coffee couldn't find it when adding an integration.
Maps & Profiles (previous course).
- In Administration → Maps & Profiles you add a client profile for Northgate's API, a connect profile for
northgate-logistics, and a settings shape because the 3PL needs a warehouse code. - In Hilltop Coffee's Settings → Maps & Profiles, the team creates and publishes a create map and send profile for warehouse orders, and a receive profile and parse map for shipments.
- You use What actually runs for each kind, integration type and document type. Each shows the published definition.
A check that catches people out. Out of habit, a colleague opens the Modules tab and runs Preview for Create. It shows No route matches in orange. That isn't a fault: the Preview can't see published maps and profiles. What actually runs is the right tool here.
Routing is the step people forget
If you skip step 1 or 2, the maps and profiles never run. A supported row with no service is Not routed, and its messages are lost before any map or profile is used.
Recap
- Config-driven types need routing: tick each message type and assign a service, usually Main integrations service.
- Check every supported row is Live.
- No module routes, no module groups.
- Set Categories on Details so organisations can find the type.
- Then follow Maps & Profiles in Prism: connect, client and settings set-up, then publish a map or profile per message type.
- Check with What actually runs, not the Modules tab Preview.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.