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.
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.
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 |
---|---|---|---|
X |
Document Type you use internally in your company |
||
API |
Endpoint that points to an internal API |
||
Backup |
Endpoint that points to the API that backs up all received documents |
||
X-to-API |
Channel that sends a document of the internal Document Type X to Endpoint API |
YourCompany B2B : PartA
Artifact | Artifact Name | Description | Configured on page |
---|---|---|---|
RecFromA |
Endpoint on which to receive documents from Partner A |
||
Y |
Document Type you expect to receive from a Partner |
||
Y-to-X |
Transforms a document of Document Type Y to a document of Document Type X |
||
Y-to-X |
Channel that transforms a document of Document Type Y into a document of Document Type X |
||
Y (passthru) |
Channel that transforms a document of Document Type Y into a document of Document Type X |
||
X-to-API |
Channel that sends a document of the internal Document Type X to Endpoint API |
||
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. |
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.
Relationship | Artifact Type | ||||||
---|---|---|---|---|---|---|---|
Partners |
Document Types |
Maps |
Endpoints |
Channels |
Transactions |
||
Source |
Target |
||||||
YourCompany B2B : Any |
NA |
X |
None |
Backup |
None |
X-to-API |
None |
YourCompany B2B : Partner A |
A |
Y |
Y-to-X |
RecFromA |
Y-to-X |
X-to-API |
Y-to-X-to-API |
Outcome Details
Partner A sendsĀ Document Y to Endpoint 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.
-