Multi-Route Routing Scenario

In this example of a multi-route routing scenario, your organization receives a Document from a Partner. PortX has been configured to process the document in two ways:

Route a copy of the document to an internal API
Route a copy of the document directly to a destination you use to backup received documents. This routing is referred to as passthru because it does not require a map.

img-multi-route-routing-scenario-overview

Figure 1. Multi-Route 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)
YourCompany B2B
Any

Relationships

There are two relationships in this scenario.

Table 1. Multi-route 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, Partner PartA)	Contains artifacts used only with PartA

Artifacts

The tables and flow diagrams in this section identify:

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

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
Endpoint	Backup	Endpoint that points to the API that backs up all received documents	Endpoints
Target Channel	X-to-API	Channel that sends a document of the internal Document Type X to Endpoint API	Channels

Artifact

Artifact Name

Description

Configured on page

Document Type

Document Type you use internally in your company

Document Types

Endpoint

API

Endpoint that points to an internal API

Endpoints

Endpoint

Backup

Endpoint that points to the API that backs up all received documents

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-multi-route-routing-scenario-transaction-y-to-x-to-api

Figure 2. Transaction Y-to-X-to-API

img-multi-route-routing-scenario-transaction-y-passthru

Figure 3. Transaction Y (passthru)

Artifact	Artifact Name	Description	Configured on page
Endpoint	RecFromA	Endpoint on which to receive documents from Partner A	Endpoints
Document Type	Y	Document Type you expect to receive from a Partner	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
Source Channel	Y (passthru)	Channel that transforms a document of Document Type Y into a document of Document Type X	Channels
Target Channel	X-to-API	Channel that sends a document of the internal Document Type X to Endpoint API	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 A and the To Partner as YourCompany B2B.	Transaction Designer

Artifact

Artifact Name

Description

Configured on page

Endpoint

RecFromA

Endpoint on which to receive documents from Partner A

Endpoints

Document Type

Document Type you expect to receive from a Partner

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

Source Channel

Y (passthru)

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

Channels

Target Channel

X-to-API

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

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 A and the To Partner as YourCompany B2B.

Transaction Designer

Outcomes

If all artifacts in the following table are configured appropriately, then the outcome of any of a Partners in the scenario sending a document of Document Type Y to the Endpoint specific to their relationship with YourCompany B2B is that PortX will route the document both to that Endpoint and also to a destination at which all received documents are stored.

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 PortX will reject the document.

For more information, see Outcome Details.

Table 2. One Document, Multiple Internal Routes Routing Scenario Artifact Summary
Relationship	Artifact Type
	Partners	Document Types	Maps	Endpoints	Channels		Transactions
					Source	Target
YourCompany B2B : Any	NA	X	None	Backup API	None	X-to-API	None
YourCompany B2B : Partner A	A	Y	Y-to-X	RecFromA	Y-to-X Y (passthru)	X-to-API	Y-to-X-to-API

Outcome Details

Partner A sends Document Y to Endpoint API

img-multi-route-routing-scenario-a-sends-x-to-api

Figure 4. Partner A Sends-X-to-API

Integration Manager:

Receives Document Y
Attempts to resolve routes
- Finds Two Transactions:
  - Y-to-DocC-to-API
  - Y-to-Passthrough
Executes both transactions,
- One transaction maps the document to Document Type X, then sends it to Endpoint API.
- The other sends the document to the Endpoint Backup.