0735 Solution Ports and Wires¶
Solution components need well-defined interfaces. These may be APIs or other types of request and information exchange mechanisms such as eventing.
SolutionPort entity¶
The interfaces for a solution component are defined using a SolutionPort entity. Each port represents the interface for a particular type of consumer. The port may offer multiple technology mechanisms (APIs, events, ...) to the consumer. However, if these mechanisms are used for different purposes, they are better represented as different ports.
- direction - Which way is data flowing?
SolutionComponentPort relationship¶
The SolutionComponentPort relationship links a solution component to one of its ports.
- role - Role that this artifact plays in implementing the abstract representation.
- description - Description of the element or associated resource in free-text.
SolutionLinkingWire relationship¶
The SolutionLinkingWire is a multi-link relationship that shows the linkage between solution components, optionally via their ports, to other elements in the architecture.
- The iscQualifiedNames attribute allows linkage to the information supply chains that identify critical data flows for the organization.
- The label and description attributes help to explain how/why the lineage flow progresses.
- The oneWay attribute indicates that information flow is in one direction.
- The integrationStyle attribute indicates the type of technology used to implement the linkage.
- The frequency attribute indicates how often the data flows.
- The protocol attribute indicates the type of protocol used to implement the linkage.
-
The dataExchanged attribute describes the type of data exchanged.
-
iscQualifiedNames - List of unique names of the information supply chains that this wire belongs to.
- oneWay - Is the data flowing one-way or bidirectional?
- integrationStyle - Mechanism to flow data and control along the segment.
- protocol - Name of the protocol used to connect to the endpoint.
- frequency - How frequently is this expected to run? e.g.real-time, hourly, daily, on batch completion?
- dataExchanged - A full explanation of what data flows and why.
SolutionPortDelegation relationship¶
Solution components can be decomposed into smaller solution components. The SolutionPortDelegation relationship shows which ports in the parent solution components map to the ports of the solution components it is decomposed into.
- role - Role that this artifact plays in implementing the abstract representation.
- description - Description of the element or associated resource in free-text.
Example¶
The diagram below shows a set of linked solution components and their linkage to the assets that implement them.
Further information
- The implementation of this information supply chain is build out in the Automated Curation Open Metadata Lab.
- More detail on the modelling of the information supply chain implemented by these solution components can be found in 0720 Information Supply Chains.
Raise an issue or comment below