Basic Routing Scenario

In this example of a basic routing scenario, your organization receives a document from a Partner. If IHub has been configured to receive a document of this Document Type, IHub routes the document to an internal API. If IHub has not been configured to receive a document of this Document Type, IHub rejects the document.

img-basic-routing-scenario-overview
Figure 1. Basic 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)

  • YourCompany B2B

  • Any

Relationships

There are two Relationships in this scenario:

Table 1. Basic Routing Scenario Relationships
Relationship Description Contains

YourCompany B2B : Any

Universal Relationship between your company and any Actor

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

Artifacts

This section identifies:

  • Artifacts that must be configured in order for the document in this scenario to be routed (that is, not rejected)

  • The Relationship (either YourCompany B2B : Any or YourCompany B2B : PartA) in which the Artifacts are configured

img-basic-routing-scenario-artifacts
Figure 2. Basic Routing Scenario Artifacts
Table 2. Basic Scenario Artifacts - YourCompany B2B : Any
Artifact Artifact Name Description Configured on page

Document Type

X

Document Type you use internally in your company

Document Types

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

Endpoint

API

Endpoint from which you expect to receive documents from PartA.

Endpoints

Table 3. Basic Scenario Artifacts - YourCompany B2B : PartA
Artifact Artifact Name Description Configured on page

Endpoint

RecFromA

Endpoint at which you expect to receive documents from PartA

Endpoints

Document Type

Y

Document Type that includes a document you expect to receive from PartA

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

Includes the process that maps and sends a document of Y to a document of X

Channels

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

Outcomes

If the Artifacts in the previous section have been configured correctly, then document discussed above will be accepted and routed.

Otherwise, the document will be rejected.

Document Accepted and Routed

All Artifacts are correctly configured; IHub routes an incoming document of Document Type Y from Partner PartA to Endpoint RecFromA.

img-basic-routing-scenario-outcome-success
Figure 3. Basic Routing Scenario Outcome (Success)

Integration Hub:

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.

img-basic-routing-scenario-outcome-rejection
Figure 4. Basic Routing Scenario Outcome (Rejection)

Integration Hub:

  • Receives incoming document

  • Attempts to resolve Routes

  • Does not find a corresponding Transaction

  • Rejects the document.