Survey Report¶

A survey report contains one or more sets of related properties that a survey action service has discovered about a resource, its metadata, structure and/or content. These are stored in a set of annotations linked off of the survey report.

The survey report is attached to the asset for the digital resource that was analysed. Over time, the survey reports show how the digital resource's contents are changing.

The survey report is created in the open metadata repository by the Survey Action OMES when it creates an new survey action service instance. The survey action service can retrieve information about the survey report through the survey context.

Annotations¶

An annotation describes one or more related properties about a digital resource. Some annotations refer to the entire digital resource and others refer to a data field within the digital resource. The annotations that describe a single data field are called data field annotations.

The annotation types defined in the Survey Action Framework (SAF) are as follows:

• Classification Annotation - Captures a recommendation of which classifications to attach to this asset. It can be made at the asset or data field level.
• Data Class Annotation - Captures a recommendation of which data class this data field closely represents.
• Resource Profile Annotation - Capture the characteristics of the data values stored in a specific data field in a data source.
• Resource Profile Log Annotation - Capture the named of the log files where profile characteristics of the data values stored in a specific data field. This is used when the profile results are too large to store in open metadata.
• Resource Measurement Annotation - collect arbitrary properties about a digital resource.
• Resource Physical Status Annotation - documents the physical characteristics of a data source asset.
• Fingerprint Annotation - Capture the characteristics of the data values stored in a specific data field or the whole digital resource and express it as a single value.
• Request for Action Annotation - used to trigger governance and stewardship actions.
• Relationship Advice Annotation - document a recommended relationship that should be established with the asset.
• Quality Annotation - document calculated quality scores on different dimensions.
• Schema Analysis Annotation - document the structure of the data (schema) inside the asset.
• Semantic Annotation - documents suggested meanings for this data based on the values and name of the field.

Raise an issue or comment below