Override Routing Scenario

In this example of an override routing scenario, your organization expects to receive documents of a single Document Type from multiple Partners.

If IHub has been configured to receive a document of this Document Type, IHub routes the document to an internal API.

However, one partner uses a variation of the Document Type, so you must override the standard Map that you use to transform that partner’s Document Type to your internal Document Type before routing.

If IHub has not been configured to receive a document of this Document Type, IHub rejects the document.

img-override-routing-scenario-overview
Figure 1. Override Routing Scenario Overview

Background Reading

Actors, Relationships and Artifacts

Introduces foundational IHub terminology.

Transaction-Processing Framework

Explains how IHub works.

Actors

In this scenario, there are three Actors:

  • Partner A (configured as PartA)

  • Partner B (configured as PartB)

  • Partner C (configured as PartC)

  • YourCompany B2B

  • Any

Relationships

There are four Relationships in this scenario. Artifacts are distributed among the relationships according to how they are used. For example, the internal Endpoint API is used in all scenarios, so it is configured in the *YourCompany B2B : Any* Relationship. The Endpoints RecFromA, RecFromB, and RecFromC are used only by specific partners; therefore they are configured in the relationships that correspond to those partners. Table 1 describes these Relationships and identifies their contents.

Table 1. Override Routing Scenario Relationships
Relationship Description Contains

YourCompany B2B : Any

Universal relationship between your company any partner

Contains Artifacts used across all partners with whom you do business

YourCompany B2B : PartA

Your organization’s relationship with the partner with whom you are doing business (in this case, PartA)

Contains artifacts used only with Partner PartA

YourCompany B2B : PartB

Your organization’s relationship with Partner |B

Contains artifacts used only with Partner PartB

YourCompany B2B : PartC

Your organization’s relationship with Partner PartC

Contains artifacts used only with Partner PartC

Artifacts

This tables and flow diagrams in this section identifies:

  • Artifacts that must be configured in order for a given document to be routed (that is, not rejected)

  • The Relationship in which the artifacts are configured

YourCompany B2B : Any

Artifacts in this Relationship are accessible from all Partner Relationships. Therefore, these artifacts, tabulated in Table 2, appear in each of the Transaction diagrams that follow.

Table 2. Override Routing Scenario Artifacts - YourCompany B2B : Any
Artifact Artifact Name Description Configured on page

Document Type

Y

Document Type you use internally in your company

Document Types

Document Type

X

Document Type you use internally in your company

Document Types

Map

Y-to-X

Transforms a document of Document Type Y to a document of Document Type X

Maps

Source Channel

Y-to-X

Channel that transforms a document of Document Type Y into a document of Document Type X

Channels

Endpoint

API

Endpoint that points to an internal API

Endpoints

Target Channel

X-to-API

Channel that sends a document of the internal Document Type X to Endpoint API

Channels

YourCompany B2B : PartA

img-override-routing-scenario-artifacts-parta
Figure 2. Override Routing Scenario Artifacts in YourCompany B2B : PartA
Table 3. Override Routing Scenario Artifacts - YourCompany B2B : PartA
Artifact Artifact Name Description Configured on page

Endpoint

RecFromA

Endpoint that points to an internal API

Endpoints

Transaction

Y-to-X-to-API

Combination of the Source Channel Y-to-X and the Target Channel X-to-API. It receives a document of Y, maps it to a document of X and then sends it to Endpoint API. In this Transaction, the From Partner is configured as PartA and the To Partner as YourCompany B2B.

Transaction Designer

YourCompany B2B : PartB

img-override-routing-scenario-artifacts-partb
Figure 3. Shared Routing Scenario Artifacts in YourCompany B2B : PartB
Artifact Artifact Name Description Configured on page

Endpoint

RecFromB

Endpoint that points to an internal API

Endpoints

Transaction

Y-to-X-to-API

Combination of the Source Channel Y-to-X and the Target Channel X-to-API. It receives a document of Y, maps it to a document of X and then sends it to Endpoint API. In this Transaction, the From Partner is configured as PartB and the To Partner as YourCompany B2B.

Transaction Designer

YourCompany B2B : PartC

img-override-routing-scenario-artifacts-partc
Figure 4. Shared Routing Scenario Artifacts in YourCompany B2B : PartC
Artifact Artifact NamDescription Configured on page Endpoint

RecFromC

Endpoint that points to an internal API

Endpoints

Document Type

Y'

Document Type you expect to receive from this partner that is a variation on the standard for this Document Type.

Document Types

Source Channel

Y'-to-X

Maps document of Y' to document of X

Channels

Transaction

Outcomes

If all artifacts in the following table are configured appropriately, then the outcome of any of the partners in the scenario sending a document of Y to the Endpoint specific to their relationship with YourCompany B2B is that IHub will route the document to that Endpoint.

If any artifact in the relationship between the partner and YourCompany B2B or in *YourCompany B2B : Any* is incorrectly configured (or not configured at all), then IHub will reject the document.

For more information, see Outcome Details.

Outcome Details

Document Accepted and Routed

Partner PartA sends a document of Document Type Y to Endpoint RecFromA
img-override-routing-scenario-outcome-parta-success
Figure 5. Override Routing Scenario Outcome, PartA, Success

Integration Hub:

  • Receives the document at Endpoint RecFromA

  • Attempts to resolve routes

  • Finds Transaction Y-to-X-to-API

  • Executes Y-to-X-to-API, which transforms the document to X

  • Sends the document to Endpoint API.

PartB sends document (Y) to Endpoint RecFromB
img-override-routing-scenario-outcome-partb-success
Figure 6. Override Routing Scenario Outcome, PartB, Success

Integration Hub:

  • Receives Document Y at Endpoint RecFromB

  • Attempts to resolve routes

  • Finds Transaction Y-to-X-to-API

  • Executes Y-to-X-to-API, which transforms the document to X

  • Sends the document to Endpoint API.

PartC sends document (Y') to Endpoint RecFromC
img-override-routing-scenario-outcome-partc-success
Figure 7. Override Routing Scenario Outcome, PartC, Success

Integration Hub:

  • Receives the document at Endpoint RecFromC

  • Attempts to resolve routes

  • Finds Transaction Y'-to-X-to-API

  • Executes that transaction, which transforms the document to X

  • Sends the document to Endpoint API.

Document Rejected

Partner PartA sends a document of Document Type Z to Endpoint RecFromA. Document Type Z is not configured in Relationship *YourCompany B2B : Any*; IHub rejects the document.

Integration Hub:

  • Receives the document

  • Attempts to resolve Routes

  • Does not find a corresponding Transaction

  • Rejects the document.