Shared Routing Scenario

In this example of a shared routing scenario, your organization wants to receive a document Document from two Partners, map it to an internal standard, and send it to a backend database.

img-shared-routing-scenario-overview
Figure 1. Shared Routing Scenario Overview

Background Reading

Actors, Relationships and Artifacts

Introduces foundational PortX terminology.

Transaction-Processing Framework

Explains how PortX works.

Actors

In this scenario, there are three Actors:

  • Partner A (configured as PartA)

  • Partner B (configured as PartB)

  • YourCompany B2B

  • Any

Relationships

There are three Relationships in this scenario:

Table 1. Shared Routing Scenario Relationships
Relationship Description Contains

YourCompany B2B : Any

Universal relationship between your company any partner

Contains a rtifacts 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 the partner with whom you are doing business (in this case, PartB)

Contains artifacts used only with Partner PartB

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, or YourCompany B2B : PartB) in which the artifacts are configured

Table 2. Shared 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

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

Channels

Endpoint

API

Endpoint that points to an internal API

Endpoints

Target Channel

Y-to-API

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

Channels

YourCompany B2B : PartA

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

Endpoint

RecFromA

Endpoint from which you expect to receive documents from PartA.

Endpoints

Transaction

Y-to-X-to-API (PartA)

Combination of Source Channel Y-to-X and Target Channel X-to-API It receives a document of Document Type Y, maps it to a document of Document Type 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-shared-routing-scenario-artifacts-partb
Figure 3. Shared Routing Scenario Artifacts in YourCompany B2B : PartB
Table 4. Shared Routing Scenario Artifacts - YourCompany B2B : PartB
Artifact Artifact Name Description Configured on page

Endpoint

RecFromB

Endpoint from which you expect to receive documents from PartB

Endpoints

Transaction

Y-to-X-to-API (PartB)

Combination of Source Channel Y-to-X and Target Channel X-to-API. It receives a document of Document Type Y, maps it to a document of Document Type 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

Outcomes

Document Accepted and Routed

PartA sends Document of Document Type Y to Endpoint RecFromA

img-shared-routing-scenario-outcome-parta-success
Figure 4. Shared Routing Scenario Outcome, PartA, Success

Integration Manager:

  • Receives Document Y

    • Attempts to resolve routes

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

  • Executes that transaction, which maps the transaction to X

  • Sends Document X to Endpoint API.

img-shared-routing-scenario-outcome-partb-success
Figure 5. Shared Routing Scenario Outcome, PartB, Success

PartB sends Document of Document Type Y to Endpoint RecFromB

Integration Manager:

  • Receives Document Y

  • Attempts to resolve routes

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

    • Executes that transaction, which maps the transaction to X

  • Sends Document X to Endpoint API.

Document Rejected

PartC sends Document of Document Type Y to Endpoint RecFromB

img-shared-routing-scenario-outcome-rejection
Figure 6. Shared Scenario Outcome (Rejection)

Integration Manager:

  • Receives document Y

  • Attempts to resolve routes

    • Does not find a transaction in which PartC is the From Partner

  • Rejects the document.