Skip to content

Commit

Permalink
Add new pages for survey actions.
Browse files Browse the repository at this point in the history
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
  • Loading branch information
mandy-chessell committed Jan 8, 2024
1 parent 706b573 commit 8897402
Show file tree
Hide file tree
Showing 70 changed files with 3,464 additions and 758 deletions.
5 changes: 5 additions & 0 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@
- [Open Discovery Framework (ODF)](/frameworks/odf/overview)
- [Governance Action Framework (GAF)](/frameworks/gaf/overview)
- [Event Action Framework (EAF)](/frameworks/eaf/overview)
- [Survey Action Framework (EAF)](/frameworks/saf/overview)


## G
Expand Down Expand Up @@ -379,6 +380,10 @@
- [Subject Area Domain](/concepts/subject-area)
- [Subject Area OMAS](/services/omas/subject-area/overview)
- [Subsystem](/concepts/omag-subsystem)
- [Survey Report](/concepts/survey-report)
- [Survey Action Engine](/concepts/survey-action-engine)
- [Survey Action Framework (SAF)](/frameworks/saf/overview)
- [Survey Action Service](/concepts/survey-action-service)
- [Supported Zones](/concepts/governance-zone)


Expand Down
27 changes: 27 additions & 0 deletions site/docs/concepts/survey-action-engine.md
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"
22 changes: 22 additions & 0 deletions site/docs/concepts/survey-action-service.md
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"
27 changes: 27 additions & 0 deletions site/docs/concepts/survey-report.md
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"
774 changes: 747 additions & 27 deletions site/docs/connectors/connector-catalog.drawio

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8897402

Please sign in to comment.