Page History

...

The Connected Asset OMAS is an API that is available on an OCF connector.  An OCF connector is a connector that supports the Open Connector Framework (OCF). It has 3 sets of APIs:

• An API to access the asset it connects to
• An API to access the metadata about the asset the connector is used to access
• An API to access and use an audit log file for the asset

The Connected Asset OMAS is the second API on an open metadata connector - the one for the metadata about the asset.   It is a generic API for all types of open metadata assets. However, it assumes the asset's metadata model inherits from Asset (see model 0010 in Area 0).

...

• assetSummary - used for displaying details of the asset in summary lists or hover text
  • assetShortDescription - short description about the asset (assetSummary from ConnectionsToAssets - model 0105)
  • assetTypeId - GUID for the type of the asset
  • assetTypeName - name of asset type from the model
  • assetTypeVersion - version id of the type
  • assetName - official name of the asset (name from Asset - model 0010)
  • assetDescription - full description of the asset (description from Asset - model 0010)
  • assetOwner - name of the person or organization that owns the asset (owner from Asset - model 0010)
  • assetClassifications - list of classifications assigned directly to the asset, or its schema/definitions

• assetDetail - used to display all of the information known about the asset with summaries of the relationships to other metadata
  • assetSummary - see above
  • assetProperties - properties and structs for the asset (these are defined in the type model)

• assetUniverse - use to define the broader context for the asset
  • assetDetail - see above
  • assetInfrastructure - details of the underlying infrastructure supporting the asset (all from Area 0)
  • assetDefinitions - details of the schema(s) and definitions associated with the asset (see Area 2 and Area 5 of the model)
  • assetCollaboration - details to the people, products and feedback that are connected to the asset (see Area 3 of the model)
  • assetGovernance - the list of governance requirements, typically associated with the classifications associated with the asset (see Area 4 of the model).
  • assetAnnotations - details of the annotation added by the discovery services (see Area 6 of the model)
  • assetLineage - details of the lineage for the asset (see Area 7 of the model)

The Connected Asset OMAS API is accessed via a connector.  This connector is linked to a specific asset through its connection definition.  A ConnectedAssetOMASAPI object is returned by the connector's getMetadataAPI call.  It is configured with details of the asset's connection and the connection for the metadata repository OMRS connector it must use to retrieve the metadata.

The ConnectedAssetOMASAPI object supports the following methods/operations:

• getAssetSummary - returns the summary information organized in the assetSummary structure described above.
• getAssetDetail - returns detailed information about the asset organized in the assetDetail structure described above.
• getAssetUniverse - returns all of the detail of the asset and information connected to it in organized in the assetUniverse structure described above.
• addAssetTag - allows a new tag (private or public) to be added to the assets metadata (see model 0350 in Area 3).
• addAssetRating - allows a rating to be added to the asset (see model 0350 in Area 3).
• addAssetLike - add a "Like" to the asset (see model 0350 in Area 3).
• addAssetComment - add a comment to the asset (see model 0350 in Area 3).
• addAssetToCollection - add the asset to the requested collection (see model 0320 in Area 3).

Note: the addAssetXXX() methods are only supported if the asset's type inherits from Referenceable (see model 0010 in Area 0).  If the asset's type does not inherit from Referenceable then exception AssetNotReferenceable is returned. See https://github.com/odpi/egeria/tree/master/open-metadata-implementation/access-services