0610 Annotations¶

An annotation captures specific discovered characteristics of a real-world digital resource.

Annotations are created by the analysis steps in the survey action service. The attributes of the annotation capture the details of the analysis. There are subclasses of Annotation to capture additional details. Each annotation is linked to the report it was generated from. It also links to other elements that the annotation relates to. Strings are used in many of the attributes to keep the model open for capturing analysis from third-party tools.

Annotation entity¶

The Annotation entity inherits from OpenMetadataRoot and adds the following attributes:

• annotationType - descriptive string that acts as an identifier for the specific annotation type. This is a simple means to sub-type any one of the annotation subclasses.
• summary - a human-readable string to describe the annotation.
• confidence - an indicator of the certainty that the annotation is correct.
• expression - this attribute is used to provide more detail on how the asset is related to the annotation.
• explanation - another description field to assist human analysts reviewing the analysis results.
• analysisStep - identifier of the step in the survey action service that detected the annotation.
• jsonProperties - the properties that were used to initiate the survey action service.
• additionalProperties - additional properties published by the survey action service.

The types that follow provide more specialized annotations.

• 0615 Schema Extraction
• 0620 Resource Profiling
• 0625 Data Class Discovery
• 0630 Semantic Discovery
• 0635 Classification Discovery
• 0640 Quality Scores
• 0650 Relationship Discovery
• 0660 Measurements

• 0690 Request for Action

• sampleSize - Count of elements in the sample.

• samplePercent - Percentage of total elements in the sample.
• samplingMethod - Description of the technique used to create the sample.
• units - The units of measure used in the data value.
• absoluteUncertainty - The range of variation in the accuracy of the measurement expressed in the units of the measurement.
• relativeUncertainty - The range of variation in the accuracy of the measurement expressed as a percentage.

DataFieldAnnotation entity¶

The DataFieldAnnotation type is used as a marker to indicate that the annotations that inherit from it will typically refer to a single schema attribute (data field) rather than the whole resource.

• dataType - The name of a primitive data type.
• matchingValues - Count of values that match the data class specification.
• nonMatchingValues - Count of values that do not match the data class specification.

ReportedAnnotation relationship¶

The ReportedAnnotation relationship links an annotation to the SurveyReport entity. It is used with survey action services.

AssociatedAnnotation relationship¶

The AssociatedAnnotation relationship links an annotation to an element that it describes.

AnnotationExtension relationship¶

The AnnotationExtension relationship allows an annotation from a later run of the survey action service to add information to an annotation from a previous run.

AnnotationMatch relationship¶

The link between an annotation and the matching element, such as a data class, data grain, or glossary term.

• method - Method used to identify data class.
• threshold - What was the percentage of matching values used to determine that the data class matched.

Raise an issue or comment below