Skip to content

Metadata Completeness Score

The metadata completeness score package computes a score based on the completeness (amount of enrichment) to each asset. The score is attached to each asset as custom metadata. The scoring criteria and the in scope assets are configurable from during the workflow setup.

Configuration

Configuration

  • Mode: whether the score is computed for all assets (full) or just for the ones updated since the last time the score was computed (incremental), default: Incremental
  • In Scope Assets: comma separated asset types. Please refer to the following link for the list of asset types: https://developer.atlan.com/models/
  • Connection (optional): list of in scope connections. If a connection is not selected and a non-glossary asset type is selected in In Scope Assets, all connections will be applied.
  • Custom Metadata Name: name of the custom metadata that contains the score. The custom metadata is automatically created by the workflow.

  • Custom Metadata Score Attribute Name: name of the custom metadata attribute that contains the score. If empty the default value is Score

    Warning

    The created custom metadata is not editable from the UI.

Generic Score Configuration

Score value components applicable to all asset types.

  • Description Score: score value component if the asset has a description.
  • Owner Score: score value component if the asset has at least one owner.
  • Tag Score: score value component if the asset has at least "Number of tags" tags assigned.
  • Number of tags: number of tags that have to be linked to an asset to increase the score, default: 1
  • Verified Score: score value component if the asset has a Verified certificate.
  • Draft Score: score value component if the asset has a Draft certificate.
  • Link Score: score value component if the asset has at least one linked resource.
  • Readme Characters Threshold: number of readme characters to be used as threshold to compute the component of the score related to the readme.
  • Readme Above Threshold Score: score value component if the asset has at least one readme with more characters than the ones defined in Readme Characters Threshold.
  • Readme Below Threshold Score: score value component if the asset has at least one readme with less or equal characters than the ones defined in Readme Characters Threshold.

Asset Score Configuration

Score value components applicable to physical assets only.

  • Term Score: score value component if the asset has at least one linked term.
  • Custom Metadata Scores: comma separated list of custom metadata scores. Each element must follow the format: Custom metadata name@@@Attribute name@@@Score. E.g. Products@@@Transactions@@@50,SLA@@@Update Frequency@@@5

Glossary Score Configuration

Score value components applicable to glossary assets only.

  • Linked Asset Score: score value component if the glossary term has at least one linked asset.
  • Related Term Score: score value component if the glossary term has at least one linked related term.
  • Custom Metadata Scores: comma separated list of custom metadata scores. Each element must follow the format: Custom metadata name@@@Attribute name@@@Score. E.g. Products@@@Transactions@@@50,SLA@@@Update Frequency@@@5

What it does

The package performs the following steps:

  • Check if the custom metadata with name defined in the input parameter Custom Metadata Name exists.

  • If the custom metadata exists --> update the definition based on the in scope assets and connections defined in the Configuration section.

  • If the custom metadata does not exist --> create the custom metadata based on the in scope assets and connections defined in the Configuration section.

    Custom metadata attribues

    The custom metadata contains three attributes:

    • Score: asset score.
    • Missing metadata: list of metadata that have to be added to increase the score.
    • Score contributors: list of metadata that contributed to increase the score.

  • Evaluate the execution mode:

    • Fetch all assets accoring to the filters specified in the Configuration section.
    • Compute the score of each asset.
    • Compute the missing metadata of each asset.
    • Update the custom metadata attributes with the score, the missing metadata values and the score contributors.
    • Fetch assets that have been updated since the last workflow run accoring to the filters specified in the Configuration section. During the first run of the worklow the full mode is assumed.
    • Compute the score of each asset.
    • Compute the missing metadata of each asset.
    • Update the custom metadata attributes with the score, the missing metadata values and the score contributors.