External references¶

Most elements in open metadata include a URL attribute. This allows a link to an additional source of information to be included in the metadata element. For example, a metadata element describing a software component such as a connector may include a URL that points to its implementation or design document on a site like GitHub.

Some external sources are significant in their own right. Open metadata supports elements called external references that describe the information in these external sources. They can then be listed in collections or referenced directly by other metadata elements.

There are six types of external references:

• External Reference (generic)
• External Data Source
• External Model Source
• External Source Code
• Cited Document
• Related Media

A list of external references can be attached to any referenceable such as a personal profile, a community, a team, a governance definition, or an asset.

The External Links API supports the create and maintenance of all external reference types. External references can also be organized into collections for easier management and discovery. Collections are maintained by the Collection Manager API.

External Reference¶

ExternalReference is the generic type for all external references. It is typically used directly to describe web pages.

The ExternalReferenceLink relationship is used to connect the external reference to a related metadata element. This relationship is a multi-link so the related element can link to the external reference multiple times with different labels and descriptions.

External Data Source¶

An ExternalDataSource element is a type of external reference that describes a data source such as a digital product or data set in an external data catalog or marketplace. The URL in the link to the catalog entry page for the data source. External data sources are also linked to their related elements using ExternalReferenceLink relationships. This may be, for example, the equivalent digital product description in the open metadata ecosystem, or a project that is using the external data source.

If an asset describes a digital resource that is derived from the external data source, the asset should be linked to the external data source using a lineage relationship such as DataFlow or DataSetContent.

External Model Source¶

An ExternalModelSource element is a type of external reference that describes a model source in a marketplace or library. The URL in the link to the catalog entry page for the model source. External model sources are also linked to their related elements using ExternalReferenceLink relationships. This may be, for example, the equivalent digital product description in the open metadata ecosystem, or a asset that is using the external model source.

Most external models are downloaded and deployed locally to allow for training and to keep the data it is using secure. If, however, the external model is being called by one of your processes, represented by the Process element, then the external model source should be linked to the process using a lineage relationship such as DataFlow .

External Source Code¶

An ExternalSourceCode element is a type of external reference that describes the source code for a software component. External source code elements are also linked to their related elements using ExternalReferenceLink relationships.

Cited Document¶

A CitedDocument element is a type of external reference that describes a multi-section document. The related elements are linked to the cited document using CitedDocumentLink relationship which allows the relevant section to be identified.

Related Media¶

The RelatedMedia is a special type of external reference that describes a media file such as an image or video file. The related elements are linked to the cited document using CitedDocumentLink relationship which allows the intended use of the media to be identified.

Raise an issue or comment below