Supply Lens

Scenario: a coded integration and an AS2 partner

Lesson 19 of 25 7 min read

Set up a new coded integration type end to end, then a new AS2 partner type, and check each one is working.

This lesson puts the earlier modules together into the two most common set-up jobs: a new coded integration (one whose work is done by modules in the code) and a new AS2 partner. Follow along and you'll have a checklist you can reuse on real jobs.

Task 1: set up a new coded integration

The steps

  1. Add the integration type. In the Routing section, select Coded integration. Untick the message types the integration doesn't do.
  2. Open the Routing tab. Make sure each supported row shows Live.
  3. Open the Modules tab. If the integration has no published maps or profiles, and its code doesn't select a module:
    • make the integration's modules available to the type;
    • set a module route for each message type, with Any document and All organisations.
  4. Use Preview to make sure each message type gets the correct module.
Rendering diagram...

A new marketplace type for Hilltop Coffee

Developers have built a coded integration for a fictional marketplace, Brightwater Market, that Hilltop Coffee will use to receive orders and send shipment updates. The code has three modules (fictional keys): brightwater-order-receive (Receive), brightwater-order-parse (Parse) and brightwater-shipment-create (Create). Send uses a fourth, brightwater-send.

  1. You add the type with id brightwater-market and select Coded integration. All four message types are needed, so you leave all four ticked. You select Create.
  2. On the Routing tab, all four rows show Live.
  3. Nobody has published maps or profiles for this type, and the developers confirm the code doesn't select its own modules. You check the four modules are on the Modules page (a developer added them), then make each one available on the type's Modules tab.
  4. You set four routes with Set module: one per message type, each with Any document and All organisations. Each appears as Default.
  5. You run Preview for each message type with no organisation. Each shows the expected module.

Tip

If Preview shows a module but the Modules page shows Not found in the Integrations service on it, the key in the list doesn't match the code. Fix that before a customer goes live.

Task 2: set up a new AS2 partner

The steps

  1. Add the integration type. In the Routing section, select AS2 partner.
  2. Open the Routing tab. Make sure Send and Receive show Live.
  3. If the partner needs Create or Parse maps, use published maps and profiles, or add the module routes.

Remember that AS2 Service can only Send and Receive. Translation (Create and Parse) has to be handled some other way: by published maps and profiles, or by module routes on a service that can do Create and Parse.

A retail partner over AS2

A fictional supermarket chain, Fenwick Foods, will send orders to Hilltop Coffee over AS2.

  1. You add the type with id fenwick-foods-as2 and select AS2 partner. Send and Receive are ticked and handled by AS2 Service. If the preset had left those rows clear with a note, you'd know AS2 Service was switched off and would stop and find out why.
  2. On the Routing tab, Send and Receive both show Live.
  3. The orders arrive as EDI files that need parsing. You discuss with the team whether to use a published parse map or a module route. Whichever you choose, the Parse row must also be supported and routed to a service that can Parse, or those messages would be lost.

Good to know

The guide says to use published maps and profiles, or module routes, for the Create or Parse side of an AS2 partner. It doesn't prescribe which. Agree the approach with the team before you start.

Recap

  • Coded integration: preset, untick what isn't needed, check every row is Live, make modules available, set default routes, then Preview.
  • Skip module routes when published maps and profiles, or the code, select the work.
  • AS2 partner: preset, check Send and Receive are Live, then handle Create or Parse with maps and profiles or module routes.
  • Any message type you support must be routed to a service that can do it.
Complete and continue

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

Group routesScenario: a config-driven integration type