diff --git a/site/docs/concepts/governance-service-types.md b/site/docs/concepts/governance-service-types.md index 8b5782d40e..c1126a2ec5 100644 --- a/site/docs/concepts/governance-service-types.md +++ b/site/docs/concepts/governance-service-types.md @@ -2,11 +2,11 @@ -There are nine types of governance services. Related governance services are [packaged together in a specific type of governance engine](/concepts/governance-engine-definition) and enabled in one or more [Engine Host OMAG Servers](/concepts/engine-host). They run in the appropriate [Open Metadata Engine Service (OMES)](/services/omes) as shown in the table below. +There are ten types of governance services. Related governance services are [packaged together in a specific type of governance engine](/concepts/governance-engine-definition) and enabled in one or more [Engine Host OMAG Servers](/concepts/engine-host). They run in the appropriate [Open Metadata Engine Service (OMES)](/services/omes) as shown in the table below. | Governance Service | Description | Governance Engine type | Engine Service | |:---------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------------------------------------------------------------------| -| [Open Discovery Service](/guides/developer/open-discovery-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([resource](/concepts/resource)) in the digital landscape. (For example, if the asset describes a file, the open discovery service analyses the data stored in the file). | [Open Discovery Engine](/concepts/open-discovery-engine) | [Asset Analysis OMES](/services/omes/asset-analysis/overview) | +| [Survey Action Service](/guides/developer/survey-action-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([resource](/concepts/resource)) in the digital landscape. (For example, if the asset describes a file, the survey action service analyses the data stored in the file). Results of the analysis are stored in a [Survey Report](/concepts/survey-report) | [Survey Action Engine](/concepts/survey-action-engine) | [Survey Action OMES](/services/omes/survey-action/overview) | | [Watchdog Governance Service](/guides/developer/governance-action-services/overview) | Monitors changes to open metadata elements and when certain changes occur (such as the creation of a new [Asset](/concepts/asset)) the watchdog service requests action from other governance services by creating either an [Engine Action](/concepts/engine-action), a [Governance Action Process](/concepts/governance-action-process) or an [Incident Report](/concepts/incident-report). | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) | | [Verification Governance Service](/guides/developer/governance-action-services/overview) | Tests the properties of specific open metadata elements to ensure they are set up correctly or do not indicate a situation where governance activity is required. The [results](/concepts/guard) returned from the verification service can be used to trigger other governance services as part of a [Governance Action Process](/concepts/governance-action-process). | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) | | [Triage Governance Service](/guides/developer/governance-action-services/overview) | Makes decisions on how to handle a specific situation or incident. Often this involves a human decision maker. | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) | @@ -15,6 +15,7 @@ There are nine types of governance services. Related governance services are [p | [General Governance Action Service](/guides/developer/governance-action-services/overview) | Some form of governance activity. | [Governance Action Engine](/concepts/governance-action-engine) | [Governance Action OMES](/services/omes/governance-action/overview) | | [Event Action Service](/guides/developer/event-action-services/overview) | Event management around [Context Event](/concepts/context-event). | [Event Action Engine](/concepts/event-action-engine) | [Event Action OMES](/services/omes/event-action/overview) | | [Repository Governance Service](/guides/developer/repository-governance-services/overview) | Performs governance for open metadata repositories such as dynamically maintaining [open metadata archives](/concepts/open-metadata-archive). | [Repository Governance Engine](/concepts/repository-governance-engine) | [Repository Governance OMES](/services/omes/repository-governance/overview) | +| [Open Discovery Service](/guides/developer/open-discovery-services/overview) | Analyses the content of an [Asset's](/concepts/asset) real-world counterpart ([resource](/concepts/resource)) in the digital landscape. (For example, if the asset describes a file, the open discovery service analyses the data stored in the file). | [Open Discovery Engine](/concepts/open-discovery-engine) | [Asset Analysis OMES](/services/omes/asset-analysis/overview) | --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/connectors/connector-catalog.drawio b/site/docs/connectors/connector-catalog.drawio index 43f64242b8..274d2dc8d8 100644 --- a/site/docs/connectors/connector-catalog.drawio +++ b/site/docs/connectors/connector-catalog.drawio @@ -1,4 +1,4 @@ - + @@ -4385,7 +4385,7 @@ - + @@ -4858,7 +4858,7 @@ - + @@ -4869,10 +4869,10 @@ - + - + @@ -4938,7 +4938,7 @@ - + @@ -5046,6 +5046,534 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/guides/developer/survey-action-services/annotation-intro.md b/site/docs/frameworks/saf/annotation-intro.md similarity index 100% rename from site/docs/guides/developer/survey-action-services/annotation-intro.md rename to site/docs/frameworks/saf/annotation-intro.md diff --git a/site/docs/frameworks/saf/asset-to-survey-reports.svg b/site/docs/frameworks/saf/asset-to-survey-reports.svg new file mode 100644 index 0000000000..ad91b44ca3 --- /dev/null +++ b/site/docs/frameworks/saf/asset-to-survey-reports.svg @@ -0,0 +1,4 @@ + + + +
Asset
Asset
Discovery Analysis Report
Discovery Analysis R...
Survey Report
Survey Report
Survey Report
Survey ReportText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/operation-of-a-survey-action-service.md b/site/docs/frameworks/saf/operation-of-a-survey-action-service.md new file mode 100644 index 0000000000..06ec3ebdfa --- /dev/null +++ b/site/docs/frameworks/saf/operation-of-a-survey-action-service.md @@ -0,0 +1,15 @@ + + + +![Operation of a survey action service](/frameworks/saf/survey-action-service-operation.svg) + +1. Each time a survey action service runs, Egeria creates a survey report to describe the status and results of the survey action service's execution. The survey action service is passed a [survey context](/frameworks/saf/overview/#survey-context) that provides access to metadata. +2. The *survey context* is able to supply metadata about the asset and create a connector to the digital resource using the connection information linked to the asset. The survey action service uses the connector to access the digital resource's contents in order to perform the analysis. +3. The survey action service creates *annotations* to record the results of its analysis. It adds them to the survey context which stores them in open metadata attached to the survey report. +4. The annotations can be reviewed and commented on through an external stewardship process. This means choices from, for example, a list of potential options proposed by the survey action services, can be verified and the best one selected by an individual expert. The resulting choices are added to annotation reviews attached to the appropriate annotations. +5. The next time the survey action service runs, a new survey report is created to link new attachments. +6. The survey context provides access to the existing attachments for that asset along with any annotation reviews. The survey action services is able to link its new annotations to the existing annotations as an annotation extension. This means that the stewards can see the history associated with the new information. + + + + diff --git a/site/docs/frameworks/saf/overview.md b/site/docs/frameworks/saf/overview.md index 231d10046e..3409d29919 100644 --- a/site/docs/frameworks/saf/overview.md +++ b/site/docs/frameworks/saf/overview.md @@ -28,12 +28,15 @@ A *survey action pipeline* is a specialized implementation of a [survey action s The aim of the survey action pipeline is to enable a detailed picture of the properties of an asset to be built up by the nested survey action services it calls. Each survey action service is able to access the results of the survey action services that have run before it. - ## Survey report +The survey report is created automatically in the open metadata repository when the survey action service is started. It is linked to the asset. + +![]() + The *survey report* lists the [annotations](#annotations) that were created during the execution of a [survey action service](#survey-action-service). -The survey report is created automatically in the open metadata repository when the survey action service is started. Annotations are published to report as soon as they are created by the survey action service so it is possible to process the annotations from a long-running survey before it has completed. + Annotations are published to report as soon as they are created by the survey action service so it is possible to process the annotations from a long-running survey before it has completed. ### Annotations @@ -54,6 +57,83 @@ Different types of annotations provide different types of information. | Semantic annotation | Documents suggested meanings for this data based on the values and name of the field. | | Suspect duplicate annotation | Identifies other asset definitions that seem to point to the same physical asset. | +#### Schema extraction + +For digital resources that include structured data, *schema extraction* documents the data fields present in the digital resource as a schema. + +Schema extraction uses the [schema analysis annotation](/types/6/0615-Schema-Extraction). It is linked directly off of the survey report. + +[Data field](/types/6/0615-Schema-Extraction) entities, one for each data field in the digital resource, are then linked together to show the structure of the data in the digital resource and this structure is linked off of the schema analysis annotation. + +![schema extraction](survey-action-schema-extraction.svg) + +The schema of the data in the digital resource is defined in a *SchemaType* linked from the digital resource's asset using the *AssetSchemaType* relationship. This may be established before the survey action service runs, or may be derived by the survey action service. + +#### Data profiling + +Profiling analysis looks at the data values in the resource and summarizes their characteristics. There are three types of annotations used in data profiling. + +* [Data Profile Annotation](/types/6/0620-Data-Profiling) - Capture the characteristics of the data values stored in a specific data field in a data source. +* [Data Profile Log Annotation](/types/6/0620-Data-Profiling) - 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. +* [Fingerprint Annotation](/types/6/0620-Data-Profiling) - 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. + +![data profiling](survey-action-data-profiling.svg) + +For structured data, data profiling needs to run after schema extraction to allow the data profiling annotations that refer to a specific data field to be linked from the appropriate data field entity. + +#### Data class discovery + +Data class discovery captures the analysis on how close a data field matches the specification defined in a [data class](/concepts/data-class). + +![Data class discovery](survey-action-data-class-discovery.svg) + +The recommendation for a specific data class are stored in a [data class annotation](/types/6/0625-Data-Class-Discovery) linked off of the appropriate data field. Data class discovery needs to run after schema extraction. It often builds on the information provided by data profiling. + +Subsequent stewardship - either automated or with human assistance - can confirm the correct assignment using the [*DataClassAssignment*](/types/5/0540-Data-Classes) relationship. + +#### Semantic discovery + +Semantic discovery is attempting to define the meaning of the data values in the asset. The result is a recommended glossary term stored as a [semantic annotation](/types/6/0630-Semantic-Discovery). + +![Semantic discovery](survey-action-semantic-discovery.svg) + +These annotations are the metadata discovery equivalent of the *Informal Tag* shown in [0150 - Feedback](/types/1/0150-feedback) in Area 1. It typically takes confirmation by a subject-matter expert to convert this into a [Semantic Assignment](/types/3/0370-Semantic-Assignment). Semantic discovery needs to run after schema extraction. It often builds on the information provided by data profiling and data class discovery. + +#### Classification discovery + +Classification discovery adds recommendations for new classifications that should either be added to the asset, or to a schema attribute in the asset. It uses the [classification annotation](/types/6/0635-Classification-Discovery) to describe the classification and its properties. +If the classification is for the asset, the classification annotation is linked off of the survey report. If it is for a specific schema attribute, it is linked off of the corresponding data field. + +![Classification discovery](survey-action-classification-discovery.svg) + +#### Calculating quality scores + +Quality scores describe how well the data values, typically in a data field, conform to a specification. For example, do the values match a list of valid values. This type of annotation is often used within a [data quality program](/features/data-quality/overview) to provide assessments of the data for different purposes. + +![Quality Scores](survey-action-quality-scores.svg) + +#### Relationship discovery + +Relationship discovery identifies relationships between different resources (or data fields), such as two columns that have a foreign key relationship. + +It is possible to create the relationship as a relationship annotation or attach a relationship advice to the survey report. + +![Relationship discovery](survey-action-relationship-discovery.svg) + +#### Capturing measurements + +The measurement annotations capture a snapshot of the physical dimensions and activity levels at a particular moment in time. For example, it may calculate the size of the data source or the number of users accessing it. + +![Data source measurements](survey-action-data-source-measurement.svg) + +#### Requesting stewardship action + +A RequestForAction entity (RfA) is used when an survey action service performs a test on the data (such as a [quality rule](/features/data-quality/overview)) or has discovered an anomaly in the data landscape compared to its metadata that potentially needs a steward or a curator's action. + +![Request for action](survey-action-request-for-action.svg) + +The [Stewardship Action OMAS](/services/omas/stewardship-action/overview) is designed to respond to the requests for actions (RfAs). + ## Survey context A survey action service is implemented as a specialized [connector](/concepts/connector) that is passed a *survey context* as part of its initialization process. diff --git a/site/docs/frameworks/saf/survey-action-classification-discovery.svg b/site/docs/frameworks/saf/survey-action-classification-discovery.svg new file mode 100644 index 0000000000..bc298bed63 --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-classification-discovery.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Classification
Annotation
Classification...
Classification
Annotation
Classification...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotation
Asset
Asset
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-data-class-discovery.svg b/site/docs/frameworks/saf/survey-action-data-class-discovery.svg new file mode 100644 index 0000000000..d0f82c32b3 --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-data-class-discovery.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Fingerprint
Annotation
Fingerprint...
Data Class
Annotation
Data Class...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-data-profiling.svg b/site/docs/frameworks/saf/survey-action-data-profiling.svg new file mode 100644 index 0000000000..bfeba1acef --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-data-profiling.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Fingerprint
Annotation
Fingerprint...
Schema Analysis
Annotation
Schema Analysis...
Data Profile
Annotation
Data Profile...
Fingerprint
Annotation
Fingerprint...
Schema Attribute
Schema Attribute
Schema Type
Schema Type
Data Profile
Log Annotation
Data Profile...
Log File Asset
Log File Asset
AssociatedAnnotation
AssociatedAnnotation
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-data-source-measurement.svg b/site/docs/frameworks/saf/survey-action-data-source-measurement.svg new file mode 100644 index 0000000000..0ee0c8c08b --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-data-source-measurement.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Annotation
Annotation
Data Source
Measurement
Annotation
Data Source...
Data Source
Physical Status Annotation
Data Source...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotation
Asset
Asset
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-pipeline-example.svg b/site/docs/frameworks/saf/survey-action-pipeline-example.svg new file mode 100644 index 0000000000..e9d84b2fb8 --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-pipeline-example.svg @@ -0,0 +1,4 @@ + + + +
Schema Extraction
Schema Extraction
Data Profiling
Data Profiling
Data Source Measurement
Data Source Measureme...
Classification
Analysis
Classification...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-pipeline-intro.md b/site/docs/frameworks/saf/survey-action-pipeline-intro.md similarity index 100% rename from site/docs/guides/developer/survey-action-services/survey-action-pipeline-intro.md rename to site/docs/frameworks/saf/survey-action-pipeline-intro.md diff --git a/site/docs/frameworks/saf/survey-action-quality-scores.svg b/site/docs/frameworks/saf/survey-action-quality-scores.svg new file mode 100644 index 0000000000..d97ff14f0a --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-quality-scores.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Quality
Annotation
Quality...
Quality
Annotation
Quality...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotation
Asset
Asset
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-relationship-discovery.svg b/site/docs/frameworks/saf/survey-action-relationship-discovery.svg new file mode 100644 index 0000000000..3eab7cf207 --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-relationship-discovery.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Relationship Advice
Annotation
Relationship Advice...
Relationship Advice
Annotation
Relationship Advice...
Relationship
Annotation
Relationship...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotation
Asset
Asset
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-request-for-action.svg b/site/docs/frameworks/saf/survey-action-request-for-action.svg new file mode 100644 index 0000000000..77a95d9ddd --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-request-for-action.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
RequestForAction
RequestForAction
RequestForAction
Annotation
RequestForAction...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotation
Asset
Asset
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-schema-extraction.svg b/site/docs/frameworks/saf/survey-action-schema-extraction.svg new file mode 100644 index 0000000000..5d457846a2 --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-schema-extraction.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Schema Extraction
Annotation
Schema Extraction...
Schema Attribute
Schema Attribute
Schema Type
Schema Type
Schema Attribute
Schema Attribute
Asset
Asset
AssetSchemaType
AssetSchemaType
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-semantic-discovery.svg b/site/docs/frameworks/saf/survey-action-semantic-discovery.svg new file mode 100644 index 0000000000..87adb87e40 --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-semantic-discovery.svg @@ -0,0 +1,4 @@ + + + +
Survey Report
Survey Report
Annotation
Annotation
Fingerprint
Annotation
Fingerprint...
Semantic
Annotation
Semantic...
Schema Attribute
Schema Attribute
AssociatedAnnotation
AssociatedAnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action-service-operation.svg b/site/docs/frameworks/saf/survey-action-service-operation.svg new file mode 100644 index 0000000000..34c68468eb --- /dev/null +++ b/site/docs/frameworks/saf/survey-action-service-operation.svg @@ -0,0 +1,4 @@ + + + +
Asset
Asset
Survey Report
(Run 1)
Survey Report...
Survey Report
(Run 2)
Survey Report...
Annotation
Annotation
Schema Analysis
Annotation
Schema Analysis...
Survey Action
Service
Survey Action...
Run 1
Run 1
Run 2
Run 2
Annotation
Annotation
Annotation
Annotation
Annotation
Annotation
Stewardship
Process
Stewardship...
Steward
Stewa...
Annotation
Review
Annotation...
Annotation
Review
Annotation...
1
1
2
2
Connection
Connection
ConnectorType
ConnectorType
Endpoint
Endpoint
Digital Resource
Digital Re...
3
3
4
4
5
5
AnnotationExtension
AnnotationExtension
6
6
Schema Attribute
Schema Attribute
Schema Type
Schema Type
AssociatedAnnotation
AssociatedAnnotation
7
7Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/frameworks/saf/survey-action.drawio b/site/docs/frameworks/saf/survey-action.drawio index dce76952bc..8b70cddd3d 100644 --- a/site/docs/frameworks/saf/survey-action.drawio +++ b/site/docs/frameworks/saf/survey-action.drawio @@ -1,178 +1,1849 @@ - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - + + - - + + - - + + - - + + - - + + - + - - + + - - + + - + - - + + - + - - + + - + - - + + - - + + - - + + - - + + - + - - + + - - + + - + - - + + - - + + - + - - + + - - + + - - + + - - - - + + + + - - + + - + - - + + - - + + - - + + - - + + - + - + - - + + - - + + - + - + - - + + - - + + - + - + - - + + - - + + diff --git a/site/docs/frameworks/saf/survey-report-structure.svg b/site/docs/frameworks/saf/survey-report-structure.svg new file mode 100644 index 0000000000..da0a18344b --- /dev/null +++ b/site/docs/frameworks/saf/survey-report-structure.svg @@ -0,0 +1,4 @@ + + + +
Asset
Asset
Discovery Analysis Report
Discovery Analysis R...
Survey Report
Survey Report
Survey Report
Survey Report
Annotation
Annotation
Annotation
Annotation
Annotation
Annotation
Schema Type
Schema Type
Schema Attribute
Schema Attribute
AssociatedAnnotations
describing the
whole digital resource
AssociatedAnnotations...
AssociatedAnnotations
describing
a single data field
AssociatedAnnotations...
Annotation
AnnotationText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/asset-to-survey-reports.svg b/site/docs/guides/developer/survey-action-services/asset-to-survey-reports.svg deleted file mode 100644 index 414c78e3d7..0000000000 --- a/site/docs/guides/developer/survey-action-services/asset-to-survey-reports.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Asset
Asset
Discovery Analysis Report
Discovery Analysis R...
Discovery Analysis Report
Discovery Analysis R...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/operation-of-a-survey-action-service.md b/site/docs/guides/developer/survey-action-services/operation-of-a-survey-action-service.md deleted file mode 100644 index 987b3468eb..0000000000 --- a/site/docs/guides/developer/survey-action-services/operation-of-a-survey-action-service.md +++ /dev/null @@ -1,15 +0,0 @@ - - - -![Operation of an open discovery service](/guides/developer/open-discovery-services/open-discovery-service-operation.svg) - -1. Each time an open discovery service runs, Egeria creates a discovery analysis report to describe the status and results of the open discovery service's execution. The open discovery service is passed a [discovery context](/guides/developer/open-discovery-services/overview/#discovery-context) that provides access to metadata. -2. The *discovery context* is able to supply metadata about the asset and create a connector to the digital resource using the connection information linked to the asset. The discovery service uses the connector to access the digital resource's contents in order to perform the analysis. -3. The discovery service creates *discovery annotations* to record the results of its analysis. It adds them to the discovery context which stores them in open metadata attached to the discovery analysis report. -4. The discovery annotations can be reviewed and commented on through an external stewardship process. This means choices from, for example, a list of potential options proposed by the discovery services, can be verified and the best one selected by an individual expert. The resulting choices are added to annotation reviews attached to the appropriate annotations. -5. The next time the open discovery service runs, a new discovery analysis report is created to link new attachments. -6. The discovery context provides access to the existing attachments for that asset along with any annotation reviews. The discovery services is able to link its new annotations to the existing annotations as an annotation extension. This means that the stewards can see the history associated with the new information. - - - - diff --git a/site/docs/guides/developer/survey-action-services/overview.md b/site/docs/guides/developer/survey-action-services/overview.md index 799ed8e937..e413f86c93 100644 --- a/site/docs/guides/developer/survey-action-services/overview.md +++ b/site/docs/guides/developer/survey-action-services/overview.md @@ -4,7 +4,8 @@ # Writing a Survey Action Service ---8<-- "docs/connectors/survey-action/survey-action-service-intro.md" ----8<-- "docs/connectors/survey-action/survey-action-pipeline-intro.md" +---8<-- "docs/frameworks/saf/survey-action-pipeline-intro.md" + ## Implementing survey action services diff --git a/site/docs/guides/developer/survey-action-services/survey-action-classification-discovery.svg b/site/docs/guides/developer/survey-action-services/survey-action-classification-discovery.svg deleted file mode 100644 index f0ed949cfe..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-classification-discovery.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Classification
Annotation
Classification...
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Classification
Annotation
Classification...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-data-class-discovery.svg b/site/docs/guides/developer/survey-action-services/survey-action-data-class-discovery.svg deleted file mode 100644 index fffa43446b..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-data-class-discovery.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Fingerprint
Annotation
Fingerprint...
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Data Class
Annotation
Data Class...
Schema Attribute
Schema Attribute
Schema Type
Schema TypeText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-data-profiling.svg b/site/docs/guides/developer/survey-action-services/survey-action-data-profiling.svg deleted file mode 100644 index 7a6bfc0cf6..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-data-profiling.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Fingerprint
Annotation
Fingerprint...
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Data Profile
Annotation
Data Profile...
Fingerprint
Annotation
Fingerprint...
Schema Attribute
Schema Attribute
Schema Type
Schema Type
Data Profile
Log Annotation
Data Profile...
Log File Asset
Log File AssetText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-data-source-measurement.svg b/site/docs/guides/developer/survey-action-services/survey-action-data-source-measurement.svg deleted file mode 100644 index 3c1f8896df..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-data-source-measurement.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Annotation
Annotation
Data Source
Measurement
Annotation
Data Source...
Data Source
Physical Status Annotation
Data Source...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-pipeline-example.svg b/site/docs/guides/developer/survey-action-services/survey-action-pipeline-example.svg deleted file mode 100644 index b1a27c7d11..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-pipeline-example.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Schema Extraction
Schema Extraction
Data Profiling
Data Profiling
Data Source Measurement
Data Source Measureme...
Classification
Analysis
Classification...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-quality-scores.svg b/site/docs/guides/developer/survey-action-services/survey-action-quality-scores.svg deleted file mode 100644 index 7f7eb73162..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-quality-scores.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Quality
Annotation
Quality...
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Quality
Annotation
Quality...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-relationship-discovery.svg b/site/docs/guides/developer/survey-action-services/survey-action-relationship-discovery.svg deleted file mode 100644 index e5071c0f71..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-relationship-discovery.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Relationship Advice
Annotation
Relationship Advice...
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Relationship Advice
Annotation
Relationship Advice...
Relationship
Annotation
Relationship...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-request-for-action.svg b/site/docs/guides/developer/survey-action-services/survey-action-request-for-action.svg deleted file mode 100644 index 0a3a720776..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-request-for-action.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
RequestForAction
RequestForAction
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
RequestForAction
RequestForActionText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-schema-extraction-with-schema-links.svg b/site/docs/guides/developer/survey-action-services/survey-action-schema-extraction-with-schema-links.svg deleted file mode 100644 index 1d621b6b0d..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-schema-extraction-with-schema-links.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Annotation
Annotation
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Data Field
Data Field
Data Field
Data Field
Schema Attribute
Schema Attribute
Schema Type
Schema Type
Schema Attribute
Schema Attribute
Asset
Asset
AssetSchemaType relationship
AssetSchemaType relationship
Schema Attribute
Schema AttributeText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-schema-extraction.svg b/site/docs/guides/developer/survey-action-services/survey-action-schema-extraction.svg deleted file mode 100644 index 1bec70a427..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-schema-extraction.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Annotation
Annotation
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Data Field
Data Field
Data Field
Data FieldText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-semantic-discovery.svg b/site/docs/guides/developer/survey-action-services/survey-action-semantic-discovery.svg deleted file mode 100644 index 7c4ea01c3e..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-semantic-discovery.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Fingerprint
Annotation
Fingerprint...
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Semantic
Annotation
Semantic...
Schema Attribute
Schema AttributeText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action-service-operation.svg b/site/docs/guides/developer/survey-action-services/survey-action-service-operation.svg deleted file mode 100644 index 74e5469c66..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action-service-operation.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Asset
Asset
Discovery Analysis Report
(Run 1)
Discovery Analysis R...
Discovery Analysis Report
(Run 2)
Discovery Analysis R...
Annotation
Annotation
Annotation
Annotation
Open Discovery
Service
Open Discovery...
Run 1
Run 1
Run 2
Run 2
Annotation
Annotation
Annotation
Annotation
Annotation
Annotation
Stewardship
Process
Stewardship...
Steward
Stewa...
Annotation
Review
Annotation...
Annotation
Review
Annotation...
1
1
2
2
Connection
Connection
ConnectorType
ConnectorType
Endpoint
Endpoint
Digital Resource
Digital Re...
3
3
4
4
5
5
AnnotationExtension
AnnotationExtension
6
6Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/developer/survey-action-services/survey-action.drawio b/site/docs/guides/developer/survey-action-services/survey-action.drawio deleted file mode 100644 index c4c23f0f61..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-action.drawio +++ /dev/null @@ -1,874 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/site/docs/guides/developer/survey-action-services/survey-report-structure.svg b/site/docs/guides/developer/survey-action-services/survey-report-structure.svg deleted file mode 100644 index 2ff524c9de..0000000000 --- a/site/docs/guides/developer/survey-action-services/survey-report-structure.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Discovery Analysis Report
Discovery Analysis R...
Annotation
Annotation
Annotation
Annotation
Annotation
Annotation
Schema Analysis
Annotation
Schema Analysis...
Data Field
Data Field
Annotations describing
the whole digital resource
Annotations describing...
Annotation
Annotation
Data Field
Annotation
Data Field...
Data Field
Data Field
Data Field
Data Field
Annotations describing
a single data field
Annotations describing...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omes/survey-action/overview.md b/site/docs/services/omes/survey-action/overview.md index 5cc1b968e8..0451084886 100644 --- a/site/docs/services/omes/survey-action/overview.md +++ b/site/docs/services/omes/survey-action/overview.md @@ -16,7 +16,7 @@ The Survey Action OMES provides support for [event action engines](/concepts/eve ## Survey action engines -A survey action engine hosts specialized governance services called [survey action services](/concepts/survey-action-services). +A survey action engine hosts specialized governance services called [survey action services](/concepts/survey-action-service). The Survey Action OMES is capable of hosting one or more [survey action engines](/concepts/survey-action-engine). diff --git a/site/docs/types/6/0603-Survey-Reports.svg b/site/docs/types/6/0603-Survey-Reports.svg index 0a5824b60b..e18b926f5b 100644 --- a/site/docs/types/6/0603-Survey-Reports.svg +++ b/site/docs/types/6/0603-Survey-Reports.svg @@ -1,4 +1,4 @@ -
0603 - Survey Reports
0603 - Survey Reports
«entity»
SurveyReport
«entity»...
displayName : string
description : string
purpose : string
analysisParameters : map<string, string>
analysisStep : string
startDate : date
completionDate : date
completionMessage : string
displayName : string...
«entity»
Referenceable
«entity»...
«relationship»
EngineActionSurveyReport
«relationship»...
*
*
0..1
0..1
surveyReports
surveyReports
engineAction
engineAction
«entity»
Asset
«entity»...
«relationship»
AssetSurveyReport
«relationship»...
*
*
0..1
0..1
surveyReports
surveyReports
surveyReportTarget
surveyReportTarget
«entity»
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BexitX%3D1%3BexitY%3D0.5%3BexitDx%3D0%3BexitDy%3D0%3BentryX%3D0%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BendArrow%3Dnone%3BendFill%3D0%3B%22%20edge%3D%221%22%20source%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22684%22%20y%3D%22384.5%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%223%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BRequestForAction%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2291%22%20y%3D%22379%22%20width%3D%22249%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%224%22%20value%3D%22%26lt%3Bspan%26gt%3BdiscoveryActivity%20%3A%20string%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%26lt%3Bspan%26gt%3BactionRequested%20%3A%20string%26lt%3B%2Fspan%26gt%3B%26lt%3Bbr%26gt%3B%26lt%3Bspan%26gt%3BactionProperties%20%3A%20map%26amp%3Blt%3Bstring%2C%20string%26amp%3Bgt%3B%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2292%22%20y%3D%22429%22%20width%3D%22247%22%20height%3D%2259%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%225%22%20value%3D%22%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BendArrow%3Dnone%3BendFill%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BexitX%3D0%3BexitY%3D0.5%3B%22%20edge%3D%221%22%20source%3D%227%22%20target%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%226%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDataFieldAnnotation%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22136.5%22%20y%3D%22257.5%22%20width%3D%22160%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%227%22%20value%3D%22%22%20style%3D%22triangle%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dcenter%3Brotation%3D-90%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22207.5%22%20y%3D%22305.5%22%20width%3D%2217%22%20height%3D%2221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%228%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3BentryX%3D1%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3B%22%20edge%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22638%22%20y%3D%22234%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22567.5%22%20y%3D%22234%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%229%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22636.5%22%20y%3D%22325.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2210%22%20value%3D%22identifiedActions%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22543%22%20y%3D%22325.5%22%20width%3D%22104%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2211%22%20value%3D%22discoveryActivity%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22381.5%22%20width%3D%22106%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2212%22%20value%3D%22requestForAction%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22571%22%20y%3D%22384%22%20width%3D%22113%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2213%22%20value%3D%22%C2%ABrelationship%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDiscoveryActivity%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22486%22%20width%3D%22206%22%20height%3D%2253%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2214%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3B%22%20edge%3D%221%22%20target%3D%2213%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22496%22%20y%3D%22407%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22543.5%22%20y%3D%22515%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2215%22%20value%3D%22description%20%3A%20string%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22538.5%22%20width%3D%22206%22%20height%3D%2231%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2216%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22643.5%22%20y%3D%22361.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2217%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22405%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3EngineAction
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0603 - Survey Reports
0603 - Survey Reports
«entity»
SurveyReport
«entity»...
displayName : string
description : string
purpose : string
user : string
analysisParameters : map<string, string>
analysisStep : string
startDate : date
completionDate : date
completionMessage : string
displayName : string...
«entity»
Referenceable
«entity»...
«relationship»
EngineActionSurveyReport
«relationship»...
*
*
0..1
0..1
surveyReports
surveyReports
engineAction
engineAction
«entity»
Asset
«entity»...
«relationship»
AssetSurveyReport
«relationship»...
*
*
0..1
0..1
surveyReports
surveyReports
surveyReportTarget
surveyReportTarget
«entity»
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BexitX%3D1%3BexitY%3D0.5%3BexitDx%3D0%3BexitDy%3D0%3BentryX%3D0%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BendArrow%3Dnone%3BendFill%3D0%3B%22%20edge%3D%221%22%20source%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22684%22%20y%3D%22384.5%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%223%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BRequestForAction%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2291%22%20y%3D%22379%22%20width%3D%22249%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%224%22%20value%3D%22%26lt%3Bspan%26gt%3BdiscoveryActivity%20%3A%20string%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%26lt%3Bspan%26gt%3BactionRequested%20%3A%20string%26lt%3B%2Fspan%26gt%3B%26lt%3Bbr%26gt%3B%26lt%3Bspan%26gt%3BactionProperties%20%3A%20map%26amp%3Blt%3Bstring%2C%20string%26amp%3Bgt%3B%26lt%3Bbr%26gt%3B%26lt%3B%2Fspan%26gt%3B%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%2292%22%20y%3D%22429%22%20width%3D%22247%22%20height%3D%2259%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%225%22%20value%3D%22%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3Bhtml%3D1%3BendArrow%3Dnone%3BendFill%3D0%3BjettySize%3Dauto%3BorthogonalLoop%3D1%3BexitX%3D0%3BexitY%3D0.5%3B%22%20edge%3D%221%22%20source%3D%227%22%20target%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%226%22%20value%3D%22%C2%ABentity%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDataFieldAnnotation%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22136.5%22%20y%3D%22257.5%22%20width%3D%22160%22%20height%3D%2250%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%227%22%20value%3D%22%22%20style%3D%22triangle%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dcenter%3Brotation%3D-90%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22207.5%22%20y%3D%22305.5%22%20width%3D%2217%22%20height%3D%2221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%228%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3BentryX%3D1%3BentryY%3D0.5%3BentryDx%3D0%3BentryDy%3D0%3B%22%20edge%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22638%22%20y%3D%22234%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22567.5%22%20y%3D%22234%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%229%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22636.5%22%20y%3D%22325.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2210%22%20value%3D%22identifiedActions%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22543%22%20y%3D%22325.5%22%20width%3D%22104%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2211%22%20value%3D%22discoveryActivity%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22381.5%22%20width%3D%22106%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2212%22%20value%3D%22requestForAction%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22571%22%20y%3D%22384%22%20width%3D%22113%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2213%22%20value%3D%22%C2%ABrelationship%C2%BB%26lt%3Bbr%26gt%3B%26lt%3Bb%26gt%3BDiscoveryActivity%26lt%3B%2Fb%26gt%3B%22%20style%3D%22html%3D1%3BstrokeColor%3D%23d79b00%3Balign%3Dcenter%3BfillColor%3D%23ffcd28%3BgradientColor%3D%23ffa500%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22486%22%20width%3D%22206%22%20height%3D%2253%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2214%22%20value%3D%22%22%20style%3D%22endArrow%3Dnone%3Bdashed%3D1%3Bhtml%3D1%3B%22%20edge%3D%221%22%20target%3D%2213%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22496%22%20y%3D%22407%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22543.5%22%20y%3D%22515%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2215%22%20value%3D%22description%20%3A%20string%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BstrokeColor%3D%23000000%3BgradientColor%3D%23ffffff%3Balign%3Dleft%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22393.5%22%20y%3D%22538.5%22%20width%3D%22206%22%20height%3D%2231%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2216%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22643.5%22%20y%3D%22361.5%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2217%22%20value%3D%22*%22%20style%3D%22text%3Bhtml%3D1%3BstrokeColor%3Dnone%3BfillColor%3Dnone%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BwhiteSpace%3Dwrap%3Brounded%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22341.5%22%20y%3D%22405%22%20width%3D%2240%22%20height%3D%2220%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3EngineAction
«entity»...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/6/area-6-discovery.drawio b/site/docs/types/6/area-6-discovery.drawio index 1f51908012..204de9ee46 100644 --- a/site/docs/types/6/area-6-discovery.drawio +++ b/site/docs/types/6/area-6-discovery.drawio @@ -1,4 +1,4 @@ - + @@ -76,34 +76,34 @@ - + - + - + - + - + - + - + - + - + - + @@ -163,7 +163,7 @@ - + @@ -173,17 +173,17 @@ - + - + - - + + - + @@ -209,46 +209,46 @@ - + - + - + - + - + - + - + - + - + diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 3a83637f29..3bb612f24f 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -109,10 +109,11 @@ nav: - Open Metadata Types: guides/developer/open-metadata-archives/defining-new-types.md - Building Utilities: guides/developer/building-utilities/overview.md - Building Connectors: + - Survey Action Services: guides/developer/survey-action-services/overview.md - Integration Connectors: guides/developer/integration-connectors/overview.md - - Open Discovery Services: guides/developer/open-discovery-services/overview.md - Governance Action Services: guides/developer/governance-action-services/overview.md - Repository Governance Services: guides/developer/repository-governance-services/overview.md + - Open Discovery Services: guides/developer/open-discovery-services/overview.md - Repository Connectors: guides/developer/repository-connectors/overview.md - Runtime Connectors: - Audit Log Destination: guides/developer/runtime-connectors/audit-log-destination-connector.md