Skip to content

Commit

Permalink
Add content for V4.4
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 Dec 12, 2023
1 parent 35d3e21 commit cc98759
Show file tree
Hide file tree
Showing 56 changed files with 12,154 additions and 319 deletions.
16 changes: 16 additions & 0 deletions site/docs/concepts/action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Action

An *action* is a metadata entity that describes an activity required by the governance defined for the open metadata ecosystem. There are two types of action:

* A [To Do](/concepts/to-do) is an action that must be performed by a third party, typically a person.
* An [Engine Action](/concepts/engine-action) is an automated action that is performed by a [governance engine](/concepts/governance-engine).

--8<-- "snippets/abbr.md"
13 changes: 13 additions & 0 deletions site/docs/concepts/context-event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->

# Context Event

A *Context Event* describes an event in time. It may be a moment in time or a time period. It is used to explain anomalies or changes in data or activities. It is also used to provide scope and timelines to projects and other activities.

--8<-- "snippets/abbr.md"
27 changes: 27 additions & 0 deletions site/docs/concepts/event-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. -->

# Event Action Engines

An *event action engine* describes a set of related [event action services](/guides/developer/event-action-services/overview). Each event action service implements a specific type of event management. This event management is built around [context events](/concepts/context-event) and actions.

An event action engine is hosted in the [Event Action Open Metadata Engine Service (OMES)](/services/omes/event-action/overview) running on one or more [Engine Host OMAG Servers](/concepts/engine-host).

![Event Action Engine](/connectors/event-action/event-action-service.svg)

When an event action engine is called, it is passed a governance request type and request parameters. This is mapped to a call to an [event action service](/concepts/event-action-service) through the [event action engine definition](/concepts/governance-engine-definition).

![Event Action Engine Definition Structure](/guides/developer/open-metadata-archives/event-action-engine-definition.svg)
> Logical structure of an event action engine definition showing how the governance request types map to the event action service definitions
!!! education "Further information"

The Open Metadata Types used to define the event action engines are located in [model 0461 Governance Engines](/types/4/0461-Governance-Engines).


---8<-- "snippets/abbr.md"
18 changes: 18 additions & 0 deletions site/docs/concepts/event-action-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->

# Event Action Service

---8<-- "docs/connectors/event-action/event-action-service-intro.md"

!!! education "Further information"

* [Writing Event Action Services](/guides/developer/event-action-services/overview)
* [Configuring Event Action Services into a Governance Engine](/guides/developer/open-metadata-archives/creating-governance-engine-packs)

--8<-- "snippets/abbr.md"
4 changes: 2 additions & 2 deletions site/docs/concepts/governance-engine-call.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: 2 additions & 2 deletions site/docs/concepts/governance-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ When a governance engine is called, it is passed a [governance request type](/co
The unique name of the governance engine defined in the governance engine definition is added to the [OMES configuration](/guides/admin/servers/configuring-an-engine-host/#configure-engine-service). When the [engine host](/concepts/engine-host) starts up the OMES, it reads the *governance engine definition* from its partner [metadata access server](/concepts/metadata-access-server) to complete its initialization. The engine host monitors changes in the governance engine definition so the services within the governance engine can be dynamically maintained.

Calls to the governance engine are made by creating [engine actions](/concepts/engine-action in the open metadata ecosystem. The engine host is monitoring for new governance actions for the governance engine. When one occurs, it claims the governance action and passes on the request to the governance engine to run. The claim process is used since there may be multiple engine hosts running that governance engine and only one of them should process the request.
Calls to the governance engine are made by creating [engine actions](/concepts/engine-action) in the open metadata ecosystem. The engine host is monitoring for new engine actions for the governance engine. When one occurs, it claims the engine action and passes on the request to the governance engine to run. The claim process is used since there may be multiple engine hosts running that governance engine and only one of them should process the request.

![Calling a governance engine](governance-engine-call.svg)
> A governance action can be created anywhere in the open metadata ecosystem. The result is an event that is passed via its connected metadata access server to the engine host. If the request is for a governance engine that it is hosting, the engine host claims the governance action and passes the request to the governance engine.
> An engine action can be created anywhere in the open metadata ecosystem. The result is an event that is passed via its connected metadata access server to the engine host. If the request is for a governance engine that it is hosting, the engine host claims the governance action and passes the request to the governance engine.
??? education "Further information"

Expand Down
Loading

0 comments on commit cc98759

Please sign in to comment.