-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #881 from mandy-chessell/code2024
Add new pages for survey actions.
- Loading branch information
Showing
70 changed files
with
3,464 additions
and
758 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
hide: | ||
- toc | ||
--- | ||
|
||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Survey Action Engines | ||
|
||
A *survey action engine* describes a set of related [service action services](/guides/developer/survey-action-services/overview). Each survey action service implements a specific type of analysis. This analysis is looking into the content of a [digital resource](/concepts/resource) and storing its findings in annotations within a [survey report](/concepts/survey-report) that is linked of the resource's [Asset](/concepts/asset) in the metadata repository. | ||
|
||
A survey action is hosted in the [Survey Action Open Metadata Engine Service (OMES)](/services/omes/survey-action/overview) running on one or more [Engine Host OMAG Servers](/concepts/engine-host). | ||
|
||
![Survey Action Engine](/connectors/survey-action/survey-action-service.svg) | ||
|
||
When an open discovery engine is called, it is passed a governance request type and request parameters. This is mapped to a call to an open discovery service through the [open discovery engine definition](/concepts/governance-engine-definition). | ||
|
||
![Survey Action Engine Definition Structure](/guides/developer/open-metadata-archives/survey-action-engine-definition.svg) | ||
> Logical structure of a survey action engine definition showing how the governance request types map to the survey action service definitions | ||
!!! education "Further information" | ||
|
||
The Open Metadata Types used to define the survey action engines are located in [model 0461 Governance Engines](/types/4/0461-Governance-Engines). | ||
|
||
|
||
---8<-- "snippets/abbr.md" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
hide: | ||
- toc | ||
--- | ||
|
||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Survey Action Service | ||
|
||
---8<-- "docs/connectors/survey-action/survey-action-service-intro.md" | ||
|
||
## Survey Action Pipeline | ||
|
||
---8<-- "docs/guides/developer/open-discovery-services/discovery-pipeline-intro.md" | ||
|
||
!!! education "Further information" | ||
|
||
* [Writing Survey Action Services](/guides/developer/survey-action-services/overview) | ||
* [Configuring Survey Action Services into a Governance Engine](/guides/developer/open-metadata-archives/creating-governance-engine-packs) | ||
|
||
--8<-- "snippets/abbr.md" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
hide: | ||
- toc | ||
--- | ||
|
||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Survey Report | ||
|
||
A *survey report* contains one or more sets of related properties that a [survey action service](/concepts/survey-action-service) has discovered about a resource, its metadata, structure and/or content. These are stored in a set of [annotations](#annotations) linked off of the survey report. | ||
|
||
The survey report is attached to the [asset](/concepts/asset) for the [digital resource](/concepts/resource) that was analysed. Over time, the survey reports show how the digital resource's contents are changing. | ||
|
||
![Asset with discovery analysis reports](/guides/developer/survey-action-services/asset-to-survey-reports.svg) | ||
|
||
The survey report is created in the open metadata repository by the [Survey Action OMES](/services/omes/survey-action/overview) when it creates an new survey action service instance. The survey action service can retrieve information about the survey report through the [survey context](/guides/developer/open-discovery-services/overview/#discovery-analysis-report-store). | ||
|
||
## Annotations | ||
|
||
---8<-- "docs/guides/developer/survey-action-services/annotation-intro.md" | ||
|
||
|
||
!!! education "Further information" | ||
[Metadata Discovery and Stewardship](/features/discovery-and-stewardship/overview) | ||
|
||
--8<-- "snippets/abbr.md" |
Large diffs are not rendered by default.
Oops, something went wrong.
4 changes: 4 additions & 0 deletions
4
site/docs/connectors/survey-action/apache-atlas-survey-action-service-analysis.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
...ocs/connectors/survey-action/apache-atlas-survey-action-service-graph-links.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
site/docs/connectors/survey-action/apache-atlas-survey-action-service-profile.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.