Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update templates and placeholders #897

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Update templates and placeholders #897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a00cb2
Update templates and placeholders
mandy-chessell Feb 12, 2024
3866f1d
Merge branch 'main' of https://github.com/odpi/egeria-docs into code2024
mandy-chessell Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions site/docs/concepts/placeholder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->


# Placeholders

A placeholder is a replaceable value. It is distinguished by a double set of curly braces - `{{placeholder}}`. Placeholders allow concrete values to be substituted when an element is either created of used. They are found in many technologies. For example, both Postman and IntelliJ's HTTP client use placeholders in their REST API definitions to denote network addresses or identifiers. These values are supplied when the REST request is made through an environment file.

Egeria has support for placeholders both in its [configuration documents](/concepts/configuration-document) and its [template](/features/templated-cataloguing/overview) support that is used when creating metadata.
4 changes: 2 additions & 2 deletions site/docs/concepts/survey-action-engine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ hide:

# 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 engine* is a type of [governance engine](/concepts/governance-engine) that describes a set of related [survey action services](/concepts/survey-action-service). 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).
When a survey action 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
Expand Down
4 changes: 2 additions & 2 deletions site/docs/concepts/survey-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ A *survey report* contains one or more sets of related properties that a [survey

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)
![Asset with discovery analysis reports](/frameworks/saf/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"
---8<-- "docs/frameworks/saf/annotation-intro.md"


!!! education "Further information"
Expand Down
4 changes: 4 additions & 0 deletions site/docs/frameworks/ocf/connection.svg
View file
Open in desktop
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/frameworks/ocf/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ It links to an optional:

Connector types and endpoints can be reused in multiple connections.

![Connection structure](connection.png)
![Connection structure](connection.svg)

Connections are typically managed in a metadata repository, but they can also be manually populated.

Expand Down Expand Up @@ -184,7 +184,7 @@ The *connector type* is a set of properties that defines the supported capabilit

The connector type is linked to the [connection](#connection) objects that request this type of connector.

![Connection Structure](connection.png)
![Connection Structure](connection.svg)

!!! education "Further information"
- The open metadata type for a connector type is defined in [model 0201](/types/2/0201-Connectors-and-Connections).
Expand Down
1 change: 1 addition & 0 deletions site/docs/release-notes/5-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Release 5.0 is a major functional release focused on usability, both from the po
* The [*DataFile*](/types/2/0220-Files-and-Folders) type has a attribute called *fileExtension*. New types that inherit from *DataFile* have been defined for a wide range of file types: [*SpreadsheetFile*](/types/2/0220-Files-and-Folders), [*XMLFile*](/types/2/0220-Files-and-Folders), [*AudioFile*](/types/2/0221-Document-Stores), [*VideoFile*](/types/2/0221-Document-Stores), [*3DImageFile*](/types/2/0221-Document-Stores), [*RasterFile*](/types/2/0221-Document-Stores), [*VectorFile*](/types/2/0221-Document-Stores), [*SourceCodeFile*](/types/2/0280-Software-Development-Assets), [*ExecutableFile*](/types/2/0280-Software-Development-Assets), [*ScriptFile*](/types/2/0280-Software-Development-Assets), [*BuildInstructionFile*](/types/2/0280-Software-Development-Assets), [*YAMLFile*](/types/2/0280-Software-Development-Assets), [*PropertiesFile*](/types/2/0280-Software-Development-Assets), and [*ArchiveFile*](/types/2/0226-Archive-Files). There is also a new relationship called [*ArchiveFileContents*](/types/2/0226-Archive-Files) to identify the contents of an archive file.
* There are new attributes called *isCaseSensitive* and *category* for [*ValidValueDefinition*](/types/5/0545-Reference-Data) that provides additional information used to match valid values. In addition, there are two new types of valid value relationship: *ValidValueAssociation* and *ConsistentValidValues*.
* The [*ConnectorType*](/types/2/0201-Connectors-and-Connections) entity has a new attribute called *deployedImplementationType* to allow a connector writer to record the [deployed implementation type](/concepts/deployed-implementation-type) that the connector works with.
* The [*Template*](/types/0/0011-Managing-Referenceables) classification has three new properties: *placeholderProperties*, *replacementProperties*, *additionalProperties*. This model also includes a new relationship called *CatalogTemplate* to identify a template for a particular type of technology.

??? warning "XTDB repository connector is now in egeria.git"
The XTDB repository connector is now located in the core Egeria git repository which means it is always available in the containers and distributions. This change is in recognition that XTDB is our premier metadata repository. There are three new administration commands to simplify the configuration of an XTDB repository.
Expand Down
2 changes: 1 addition & 1 deletion site/docs/services/omas/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Open Metadata Access Services (OMAS) provide domain-specific services for da

The access services are as follows:

| OMAS | Description | Supplied APIs and events to |
| OMAS | Description | Supplies APIs and events to |
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Asset Consumer](/services/omas/asset-consumer/overview) | The Asset Consumer OMAS is designed for applications that are using [OCF](/frameworks/ocf/overview) connectors to access data stores, APIs and functions such as analytics. The Asset Consumer OMAS provides a factory function for the connectors, the ability to retrieve all of the metadata about the asset and the ability to add feedback on the asset. | [Search Integrator OMIS](/services/omis/search-integrator/overview), [Asset Catalog OMVS](/services/omvs/asset-catalog/overview) |
| [Asset Lineage](/services/omas/asset-lineage/overview) | The Asset Lineage OMAS listens to relevant lineage related events on the enterprise topic level and publishes these on the Asset Lineage OutTopic, combined with relevant context information on the described entities. These events are listened to by the open lineage services governance server. | [Lineage Warehouse Services](/services/lineage-warehouse-services) |
Expand Down
2 changes: 1 addition & 1 deletion site/docs/services/omes/engine-services-event-action-server-side.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion site/docs/services/omes/engine-services-survey-action-server-side.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions site/docs/services/omes/engine-services.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<mxfile modified="2024-02-11T16:04:15.538Z" host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/23.0.2 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="cmeWuzQe5S52hZPrl2Yp" version="23.0.2" type="device" pages="5">
<mxfile modified="2024-02-12T08:14:59.655Z" host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/23.0.2 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="fsZE9LwB6crFcSTEaoNK" version="23.0.2" type="device" pages="5">
<diagram id="9QGye9qF3GlcTXH40-j3" name="engine-host-internals">
<mxGraphModel dx="1242" dy="1989" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
Expand Down Expand Up @@ -456,7 +456,7 @@
<mxCell id="-X61TCMz17pQ7-oCpkFn-86" value="Governance&lt;br&gt;Action Service&lt;br&gt;Handler" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;shadow=1;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="367.06" y="895" width="95.95" height="60" as="geometry" />
</mxCell>
<mxCell id="-X61TCMz17pQ7-oCpkFn-87" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.25;entryY=0;entryDx=0;entryDy=0;exitX=1;exitY=0.75;exitDx=0;exitDy=0;" parent="1A0xML21-OaG5q6vJsk9-1" source="-X61TCMz17pQ7-oCpkFn-81" edge="1" target="-X61TCMz17pQ7-oCpkFn-89">
<mxCell id="-X61TCMz17pQ7-oCpkFn-87" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.25;entryY=0;entryDx=0;entryDy=0;exitX=1;exitY=0.75;exitDx=0;exitDy=0;" parent="1A0xML21-OaG5q6vJsk9-1" source="-X61TCMz17pQ7-oCpkFn-81" target="-X61TCMz17pQ7-oCpkFn-89" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="729.6999999999998" y="915" as="targetPoint" />
</mxGeometry>
Expand Down Expand Up @@ -787,7 +787,7 @@
<mxCell id="FyZ2uhYOsPDK-eVkyUqT-51" value="Engine Host Services" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="200.98000000000002" y="1670.5" width="370" height="134.5" as="geometry" />
</mxCell>
<mxCell id="FyZ2uhYOsPDK-eVkyUqT-52" value="Metadata Server" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxCell id="FyZ2uhYOsPDK-eVkyUqT-52" value="Metadata Access Server" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="731.98" y="1630" width="170" height="440" as="geometry" />
</mxCell>
<mxCell id="FyZ2uhYOsPDK-eVkyUqT-53" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" parent="1A0xML21-OaG5q6vJsk9-1" target="FyZ2uhYOsPDK-eVkyUqT-59" edge="1">
Expand Down Expand Up @@ -935,7 +935,7 @@
<mxCell id="sAEZ9zLw-kv7bl9qyUTz-2" value="Engine Host Services" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="204.43" y="2200.5" width="370" height="134.5" as="geometry" />
</mxCell>
<mxCell id="sAEZ9zLw-kv7bl9qyUTz-3" value="Metadata Server" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxCell id="sAEZ9zLw-kv7bl9qyUTz-3" value="Metadata Access Server" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="735.4300000000001" y="2160" width="170" height="440" as="geometry" />
</mxCell>
<mxCell id="sAEZ9zLw-kv7bl9qyUTz-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" parent="1A0xML21-OaG5q6vJsk9-1" target="sAEZ9zLw-kv7bl9qyUTz-10" edge="1">
Expand Down Expand Up @@ -1074,26 +1074,26 @@
<mxCell id="sAEZ9zLw-kv7bl9qyUTz-43" value="Audit Log (Repository Services)" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="201.93" y="2575" width="370" height="60" as="geometry" />
</mxCell>
<mxCell id="zmipmboTy6oqKyg7FrRs-0" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.25;entryDx=0;entryDy=0;" edge="1" parent="1A0xML21-OaG5q6vJsk9-1" source="zmipmboTy6oqKyg7FrRs-1" target="-X61TCMz17pQ7-oCpkFn-81">
<mxCell id="zmipmboTy6oqKyg7FrRs-0" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.25;entryDx=0;entryDy=0;" parent="1A0xML21-OaG5q6vJsk9-1" source="zmipmboTy6oqKyg7FrRs-1" target="-X61TCMz17pQ7-oCpkFn-81" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="562.98" y="874" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="zmipmboTy6oqKyg7FrRs-1" value="" style="shape=partialRectangle;whiteSpace=wrap;html=1;bottom=1;right=1;left=1;top=0;fillColor=none;routingCenterX=-0.5;" vertex="1" parent="1A0xML21-OaG5q6vJsk9-1">
<mxCell id="zmipmboTy6oqKyg7FrRs-1" value="" style="shape=partialRectangle;whiteSpace=wrap;html=1;bottom=1;right=1;left=1;top=0;fillColor=none;routingCenterX=-0.5;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="649.0000000000001" y="854" width="30" height="40" as="geometry" />
</mxCell>
<mxCell id="zmipmboTy6oqKyg7FrRs-2" value="Out&lt;br&gt;Topic" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];;autosize=1;" vertex="1" parent="1A0xML21-OaG5q6vJsk9-1">
<mxCell id="zmipmboTy6oqKyg7FrRs-2" value="Out&lt;br&gt;Topic" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];;autosize=1;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="644.0000000000001" y="859" width="40" height="30" as="geometry" />
</mxCell>
<mxCell id="zmipmboTy6oqKyg7FrRs-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0.75;exitY=0;exitDx=0;exitDy=0;" edge="1" parent="1A0xML21-OaG5q6vJsk9-1" target="zmipmboTy6oqKyg7FrRs-1" source="-X61TCMz17pQ7-oCpkFn-89">
<mxCell id="zmipmboTy6oqKyg7FrRs-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0.75;exitY=0;exitDx=0;exitDy=0;" parent="1A0xML21-OaG5q6vJsk9-1" source="-X61TCMz17pQ7-oCpkFn-89" target="zmipmboTy6oqKyg7FrRs-1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="734" y="870" as="sourcePoint" />
</mxGeometry>
</mxCell>
<mxCell id="zmipmboTy6oqKyg7FrRs-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1A0xML21-OaG5q6vJsk9-1" source="zmipmboTy6oqKyg7FrRs-1" target="zmipmboTy6oqKyg7FrRs-1">
<mxCell id="zmipmboTy6oqKyg7FrRs-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" parent="1A0xML21-OaG5q6vJsk9-1" source="zmipmboTy6oqKyg7FrRs-1" target="zmipmboTy6oqKyg7FrRs-1" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="zmipmboTy6oqKyg7FrRs-5" value="OutTopic&lt;br&gt;Events" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];;autosize=1;" vertex="1" parent="1A0xML21-OaG5q6vJsk9-1">
<mxCell id="zmipmboTy6oqKyg7FrRs-5" value="OutTopic&lt;br&gt;Events" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];;autosize=1;" parent="1A0xML21-OaG5q6vJsk9-1" vertex="1">
<mxGeometry x="575.0400000000001" y="841.2" width="60" height="30" as="geometry" />
</mxCell>
</root>
Expand Down
Loading
Loading