Connected Asset Properties¶
Connected Asset Properties are the properties known about an asset accessed through a connector. These properties are presented at three levels:
Figure 1: The structure of the connected asset properties
Asset Summary¶
AssetSummary holds asset properties that are used for displaying details of an asset in summary lists or hover text. It includes the following properties:
- type - metadata type information for the asset
- guid - globally unique identifier for the asset
- url - external link for the asset
-
qualifiedName - The official (unique) name for the asset. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages.
(Sourced from the qualifiedName attribute in Referenceable - model 0010)
-
resourceName - The name of the resource. This is extracted from the resource's implementation when it is catalogued.
(Sourced from name attribute within Asset - model 0010))
-
displayName - A consumable name for the resource for use on user interfaces and messages. This is typically the business name that.
(Sourced from displayName attribute within GlossaryTerm - model 0330 - linked via the Supplementary Properties) relationship.
-
displaySummary - A short description for the resource for use in summary tables on user interfaces or messages.
(Sourced from summary attribute within GlossaryTerm - model 0330 - linked via the Supplementary Properties) relationship.
-
abbreviation - A short for the asset for use in summary tables on user interfaces or messages.
(Sourced from abbreviation attribute within GlossaryTerm - model 0330 - linked via the Supplementary Properties) relationship.
-
usage - A short for the asset for use in summary tables on user interfaces or messages.
(Sourced from usage attribute within GlossaryTerm - model 0330 - linked via the Supplementary Properties) relationship.
-
resourceDescription - Description of the resource extracted from the resource's implementation when it was catalogued.
(Sourced from description attribute within Asset - model 0010))
-
displayDescription - full description of the resource - typically from a business perspective.
(Sourced from description attribute within GlossaryTerm - model 0330 - linked via the Supplementary Properties) relationship.
-
connectionDescription - short description about the resource from the perspective of a connection. The connection may restrict the access to the resources data and so this information is specific to the connection use.
(Sourced from assetSummary within ConnectionsToAsset - model 0205) and only filled out if the request for the asset is via a connection.
-
owner - name of the person or organization that owns the asset/resource.
(Sourced from the AssetOwnership Classification - model 0445).
-
zoneMembership - list of governance zones assigned to the asset.
(Sourced from the AssetZoneMembership classification - model 0445))
-
classifications - full list of the classifications assigned to the asset along with their properties.
Asset Detail¶
AssetDetail extends AssetSummary to provide all the properties directly related to this asset. It includes:
-
schema - details of the schema type associated with the asset.
-
external identifiers - list of identifiers for this asset/resource that are used in other systems.
-
related media references - list of links to external media (images, audio, video) about this asset/resource.
-
note logs - list of NoteLogs for this asset, often providing more detail on how to use the resource and its current status.
-
external references - list of links to additional information about this asset/resource.
-
connections - list of connections defined to access this resource.
-
licenses - list of licenses associated with the asset/resource.
-
certifications - list of certifications that have been awarded to this asset/resource.
Asset Universe¶
AssetUniverse extends AssetDetail which extend AssetSummary. AssetUniverse adds information about the common open metadata entities related to this asset.
-
meanings - glossary term(s) assigned to this asset via the SemanticAssignment relationship.
-
reference values - valid values(s) assigned to this asset via the ReferenceValueAssignment relationship.
-
search keywords - search keywords assigned to this asset.
-
feedback - details of the likes, reviews and comments, that are connected to the asset.
-
knownLocations - details of the known locations of the resource.
-
lineage - details of the lineage for the resource.
-
relatedAssets - details of the assets linked to this asset.
Implementation details¶
The Connector Broker does not have access to a metadata repository because the OCF is metadata repository neutral. When it creates a connector, the connected asset properties are null.
The Open Metadata Access Services (OMASs) such as Asset Consumer OMAS and Asset Owner OMAS include the connector broker in their clients and support APIs for managing connections and creating connectors.
Connectors created by the Egeria access services will include the Connected Asset Properties object configured to retrieve metadata from the same open metadata repository where the OMAS is running.
The Connected Asset Properties are retrieved from the open metadata repositories by OCF Metadata Management. It will use the same user id that was used to create the connector.
Raise an issue or comment below