From f2fa10dcb6fc6e7bf8a927ee4d66846f4a6c328a Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Tue, 30 Jan 2024 21:19:35 +0000 Subject: [PATCH 1/2] Add file resource connector pages Signed-off-by: Mandy Chessell --- site/docs/connectors/connector-catalog.drawio | 113 +++++----- .../resource/avro-file-resource-connector.svg | 4 - .../resource/basic-file-resource-connector.md | 19 ++ .../basic-folder-resource-connector.md | 19 ++ .../basic-folder-resource-connector.svg | 4 + .../resource/csv-file-resource-connector.md | 19 ++ .../data-folder-resource-connector.md | 19 ++ site/docs/guides/admin/egeria-admin.drawio | 207 +++++++++--------- .../servers/configuring-a-view-server.md | 2 +- .../servers/configuring-an-engine-host.md | 102 +-------- .../servers/configuring-the-view-services.md | 2 +- .../servers/engine-host-config-doc-example.md | 80 +++++++ .../admin/servers/engine-host-config-old.svg | 4 + .../admin/servers/engine-host-config.svg | 4 +- site/docs/release-notes/5-0.md | 3 + .../services/omes/survey-action/overview.md | 4 +- site/docs/types/6/0610-Annotations.svg | 2 +- site/docs/types/6/0620-Data-Profiling.svg | 4 +- .../types/6/0660-Data-Source-Measurements.svg | 3 +- site/docs/types/6/area-6-discovery.drawio | 68 +++--- site/mkdocs.yml | 1 + 21 files changed, 388 insertions(+), 295 deletions(-) delete mode 100644 site/docs/connectors/resource/avro-file-resource-connector.svg create mode 100644 site/docs/connectors/resource/basic-file-resource-connector.md create mode 100644 site/docs/connectors/resource/basic-folder-resource-connector.md create mode 100644 site/docs/connectors/resource/basic-folder-resource-connector.svg create mode 100644 site/docs/connectors/resource/csv-file-resource-connector.md create mode 100644 site/docs/connectors/resource/data-folder-resource-connector.md create mode 100644 site/docs/guides/admin/servers/engine-host-config-doc-example.md create mode 100644 site/docs/guides/admin/servers/engine-host-config-old.svg diff --git a/site/docs/connectors/connector-catalog.drawio b/site/docs/connectors/connector-catalog.drawio index 274d2dc8d8..0b13b60fb8 100644 --- a/site/docs/connectors/connector-catalog.drawio +++ b/site/docs/connectors/connector-catalog.drawio @@ -1,6 +1,6 @@ - + - + @@ -64,7 +64,7 @@ - + @@ -1118,70 +1118,70 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1216,7 +1216,7 @@ - + @@ -1251,99 +1251,102 @@ - + - + - + - + - + - + - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + diff --git a/site/docs/connectors/resource/avro-file-resource-connector.svg b/site/docs/connectors/resource/avro-file-resource-connector.svg deleted file mode 100644 index 9cf7edcf49..0000000000 --- a/site/docs/connectors/resource/avro-file-resource-connector.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Avro File Connector
Avro File Connector
Avro File
Avro FileText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/connectors/resource/basic-file-resource-connector.md b/site/docs/connectors/resource/basic-file-resource-connector.md new file mode 100644 index 0000000000..ee8cd1ab8f --- /dev/null +++ b/site/docs/connectors/resource/basic-file-resource-connector.md @@ -0,0 +1,19 @@ + + + +# Basic File Resource Connector + +???+ info "Connector summary" + - Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector) + - Source Module: [basic-file-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/data-store-connectors/file-connectors/basic-file-connector){ target=gh }. + - Jar File Name: `basic-file-connector.jar` + - Supported Asset Type: [DataFile](/types/2/0220-Files-and-Folders) + +The basic file resource connector provides support to read and write to a file using the Java File object. + +![BasicFileConnector](basic-file-resource-connector.svg) + + + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/connectors/resource/basic-folder-resource-connector.md b/site/docs/connectors/resource/basic-folder-resource-connector.md new file mode 100644 index 0000000000..924ee316da --- /dev/null +++ b/site/docs/connectors/resource/basic-folder-resource-connector.md @@ -0,0 +1,19 @@ + + + +# Basic Folder Resource Connector + +???+ info "Connector summary" + - Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector) + - Source Module: [basic-file-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/data-store-connectors/file-connectors/basic-file-connector){ target=gh }. + - Jar File Name: `basic-file-connector.jar` + - Supported Asset Type: [FileFolder](/types/2/0220-Files-and-Folders) + +The basic folder resource connector provides support to read and write the files in a folder (directory) using the Java File object. + +![BasicFolderConnector](basic-folder-resource-connector.svg) + + + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/connectors/resource/basic-folder-resource-connector.svg b/site/docs/connectors/resource/basic-folder-resource-connector.svg new file mode 100644 index 0000000000..600339b59d --- /dev/null +++ b/site/docs/connectors/resource/basic-folder-resource-connector.svg @@ -0,0 +1,4 @@ + + + +
Basic Folder Connector
File
Folder
 \ No newline at end of file diff --git a/site/docs/connectors/resource/csv-file-resource-connector.md b/site/docs/connectors/resource/csv-file-resource-connector.md new file mode 100644 index 0000000000..de7479b120 --- /dev/null +++ b/site/docs/connectors/resource/csv-file-resource-connector.md @@ -0,0 +1,19 @@ + + + +# CSV File Resource Connector + +???+ info "Connector summary" + - Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector) + - Source Module: [csv-file-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/data-store-connectors/file-connectors/csv-file-connector){ target=gh }. + - Jar File Name: `csv-file-connector.jar` + - Supported Asset Type: [CSVFile](/types/2/0220-Files-and-Folders) + +The CSV file resource connector provides support to read and write to a CSV file using the Java File object. It can extract the column headers, and retrieve/count the rows in the file. + +![CSVFileConnector](csv-file-resource-connector.svg) + + + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/connectors/resource/data-folder-resource-connector.md b/site/docs/connectors/resource/data-folder-resource-connector.md new file mode 100644 index 0000000000..124d798c82 --- /dev/null +++ b/site/docs/connectors/resource/data-folder-resource-connector.md @@ -0,0 +1,19 @@ + + + +# Data Folder Resource Connector + +???+ info "Connector summary" + - Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector) + - Source Module: [data-folder-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/data-store-connectors/file-connectors/data-folder-connector){ target=gh }. + - Jar File Name: `data-folder-connector.jar` + - Supported Asset Type: [DataFolder](/types/2/0220-Files-and-Folders) + +The Data Folder resource connector provides support to read and write the files in a folder (directory) using the Java File object. The files are assumed to holder the records of a single data source represented by the folder. + +![DataFolderConnector](data-folder-resource-connector.svg) + + + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/guides/admin/egeria-admin.drawio b/site/docs/guides/admin/egeria-admin.drawio index dbafadd948..203e8b8f11 100644 --- a/site/docs/guides/admin/egeria-admin.drawio +++ b/site/docs/guides/admin/egeria-admin.drawio @@ -1,6 +1,6 @@ - + - + @@ -215,7 +215,7 @@ - + @@ -324,7 +324,7 @@ - + @@ -542,38 +542,38 @@ - + - + - + - + - + - + - + - + - + - + @@ -581,207 +581,207 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1021,7 +1021,7 @@ - + @@ -1324,7 +1324,7 @@ - + @@ -1550,7 +1550,7 @@ - + @@ -3696,7 +3696,7 @@ - + @@ -4180,7 +4180,7 @@ - + @@ -4212,7 +4212,7 @@ - + @@ -4248,33 +4248,33 @@ - + - + - + - + - + - + - + - + - + - + @@ -4327,23 +4327,23 @@ - - + + - + - + - + - + @@ -4351,7 +4351,7 @@ - + @@ -4422,6 +4422,15 @@ + + + + + + + + + diff --git a/site/docs/guides/admin/servers/configuring-a-view-server.md b/site/docs/guides/admin/servers/configuring-a-view-server.md index 7c8376f428..edacb2de34 100644 --- a/site/docs/guides/admin/servers/configuring-a-view-server.md +++ b/site/docs/guides/admin/servers/configuring-a-view-server.md @@ -3,7 +3,7 @@ # Configuring a [view server](/concepts/view-server) -A *View Server* is configured by creating a [configuration document](/concepts/configuration-document). Below is the outline structure of the server's configuration document. +A *[View Server](/concepts/view-server)* is configured by creating a [configuration document](/concepts/configuration-document). Below is the outline structure of the server's configuration document. ![Configuration for a view server](view-server-config.svg) diff --git a/site/docs/guides/admin/servers/configuring-an-engine-host.md b/site/docs/guides/admin/servers/configuring-an-engine-host.md index 64edaf28c6..023240fb3f 100644 --- a/site/docs/guides/admin/servers/configuring-an-engine-host.md +++ b/site/docs/guides/admin/servers/configuring-an-engine-host.md @@ -3,10 +3,14 @@ # Configuring an [engine host](/concepts/engine-host) -An *Engine Host* is configured by creating a [configuration document](/concepts/configuration-document). Below is the outline structure of the server's configuration document. +An *[Engine Host](/concepts/engine-host)* is configured by creating a [configuration document](/concepts/configuration-document). Below is the outline structure of the server's configuration document. ![Configuration for an engine host](engine-host-config.svg) +??? deprecated "Configuration for an engine host prior to release 5.0" + Prior to release 5.0, the list of engines to run in an engine host was configured under each engine service. It was necessary to align the type of governance engine with the correct engine service. + ![Configuration for an engine host prior to release 5.0](engine-host-config.svg) + The configuration document is built up using a series of administration calls: ??? info "Configuring the basic properties" @@ -22,98 +26,10 @@ The configuration document is built up using a series of administration calls: --8<-- "docs/guides/admin/servers/configuring-the-engine-host-services.md" ??? example "Example configuration of an engine host" - This is an example of the configuration for an engine host. It has a single engine service ([Asset Analysis OMES](/services/omes/asset-analysis/overview)) and the default audit log. Both the [Governance Engine OMAS](/services/omas/governance-engine/overview) used by the engine host services and the [Discovery Engine OMAS](/services/omas/discovery-engine/overview) used by the Asset Analysis OMES are running on the metadata access server called `myserver`. - - ```json - { - "class": "OMAGServerConfigResponse", - "relatedHTTPCode": 200, - "omagserverConfig": { - "class": "OMAGServerConfig", - "versionId": "V2.0", - "localServerId": "8b745d03-5ffc-4978-81ab-bd3d5156eebe", - "localServerName": "myserver", - "localServerType": "Open Metadata and Governance Server", - "localServerURL": "https://localhost:9443", - "localServerUserId": "OMAGServer", - "maxPageSize": 1000, - "engineHostServicesConfig": { - "omagserverPlatformRootURL": "https://localhost:9443", - "omagserverName": "myMetadataServer", - "engineServices": [ - { - "class": "EngineServiceConfig", - "engineId": 6000, - "engineQualifiedName": "Asset Analysis", - "engineServiceFullName": "Asset Analysis OMES", - "engineServiceURLMarker": "asset-analysis", - "engineServiceDescription": "Analyses the content of an asset's real world counterpart, generates annotations in an open discovery report that is attached to the asset in the open metadata repositories .", - "engineServiceWiki": "https://egeria.odpi.org/open-metadata-implementation/engine-services/asset-analysis/", - "engines" : [ {"engineId" : "daff1dca-984b-4b8a-8a8f-febaf72b82a8", - "engineName" : "engine1", - "engineUserId" : "engine1UserId"}, - {"engineId" : "a80aa0f8-2ea0-4f84-b613-d68becba2693", - "engineName" : "engine2", - "engineUserId" : "engine2UserId"} ], - "engineServiceOperationalStatus": "ENABLED", - "engineServiceAdminClass": "org.odpi.openmetadata.engineservices.assetanalysis.admin.AssetAnalysisAdmin", - "omagserverPlatformRootURL": "https://localhost:9443", - "omagserverName": "myMetadataServer" - } - ]}, - "repositoryServicesConfig": { - "class": "RepositoryServicesConfig", - "auditLogConnections": [ - { - "class": "Connection", - "headerVersion": 0, - "displayName": "Console", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "class": "ElementType", - "headerVersion": 0, - "elementOrigin": "LOCAL_COHORT", - "elementVersion": 0, - "elementTypeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "elementTypeName": "ConnectorType", - "elementTypeVersion": 1, - "elementTypeDescription": "A set of properties describing a type of connector." - }, - "guid": "4afac741-3dcc-4c60-a4ca-a6dede994e3f", - "qualifiedName": "Console Audit Log Store Connector", - "displayName": "Console Audit Log Store Connector", - "description": "Connector supports logging of audit log messages to stdout.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.auditlogstore.console.ConsoleAuditLogStoreProvider" - }, - "configurationProperties": { - "supportedSeverities": [ - "", - "Information", - "Event", - "Decision", - "Action", - "Error", - "Exception", - "Security", - "Startup", - "Shutdown", - "Asset", - "Types", - "Cohort" - ] - } - } - ] - }, - "auditTrail": [ - "Tue Dec 08 18:38:32 GMT 2020 me updated configuration for engine service asset-analysis.", - "Tue Dec 08 18:43:47 GMT 2020 me set up default audit log destinations." - ] - } - } - ``` + This is an example of the configuration for an engine host called `engine-host`. It is configured to run 3 engines called `FileProvisioning`, `AssetSurvey` and `AssetGovernance`. It makes calls to the `active-metadata-store` [Metadata Access Store](/concepts/metadata-access-store). + + --8<-- "docs/guides/admin/servers/engine-host-config-doc-example.md" + This configuration document is shipped as one of the sample configurations in the `omag-server-platform` assembly. --8<-- "snippets/abbr.md" diff --git a/site/docs/guides/admin/servers/configuring-the-view-services.md b/site/docs/guides/admin/servers/configuring-the-view-services.md index 062e4b8dc9..7191c359a1 100644 --- a/site/docs/guides/admin/servers/configuring-the-view-services.md +++ b/site/docs/guides/admin/servers/configuring-the-view-services.md @@ -130,7 +130,7 @@ View services can be configured into a view server either altogether or individu !!! post "POST - configure multiple view services" ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/configuration + {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services ``` Again the request body must contain a `ViewServiceRequestBody` object. This object is used to configure each of the registered view services. diff --git a/site/docs/guides/admin/servers/engine-host-config-doc-example.md b/site/docs/guides/admin/servers/engine-host-config-doc-example.md new file mode 100644 index 0000000000..9dd74b4c5d --- /dev/null +++ b/site/docs/guides/admin/servers/engine-host-config-doc-example.md @@ -0,0 +1,80 @@ + + + + +```json +{ + "class": "OMAGServerConfigResponse", + "relatedHTTPCode": 200, + "omagserverConfig": { + "class": "OMAGServerConfig", + "versionId": "V2.0", + "localServerId": "099d1128-b466-4426-bca2-b6087f394f72", + "localServerName": "engine-host", + "localServerURL": "https://localhost:9443", + "localServerUserId": "enginehostnpa", + "maxPageSize": 1000, + "repositoryServicesConfig": { + "class": "RepositoryServicesConfig", + "auditLogConnections": [ + { + "class": "Connection", + "headerVersion": 0, + "qualifiedName": "Console- default", + "displayName": "Console", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.auditlogstore.console.ConsoleAuditLogStoreProvider" + }, + "configurationProperties": { + "supportedSeverities": [ + "Unknown", + "Information", + "Decision", + "Action", + "Error", + "Exception", + "Security", + "Startup", + "Shutdown", + "Asset", + "Cohort" + ] + } + } + ] + }, + "engineHostServicesConfig": { + "class": "EngineHostServicesConfig", + "engineList": [ + { + "class": "EngineConfig", + "engineId": "4fe58760-ec4c-4f23-89c2-f7ae979e0e8b", + "engineQualifiedName": "AssetSurvey", + "engineUserId": "generalnpa" + }, + { + "class": "EngineConfig", + "engineId": "a80b17a8-ce6f-4cbc-b8bc-ff71b594f175", + "engineQualifiedName": "FileProvisioning", + "engineUserId": "generalnpa" + }, + { + "class": "EngineConfig", + "engineId": "1a86651a-c9c1-4aee-8a83-4c028d89f774", + "engineQualifiedName": "AssetGovernance", + "engineUserId": "generalnpa" + } + ], + "omagserverPlatformRootURL": "https://localhost:9443", + "omagserverName": "active-metadata-store" + }, + "auditTrail": [ + "Fri Jan 26 15:13:20 GMT 2024 garygeeke updated configuration for local server's userId to enginehostnpa.", + "Fri Jan 26 15:13:54 GMT 2024 garygeeke updated configuration for Engine Host Services access service root url to https://localhost:9443.", + "Fri Jan 26 15:14:10 GMT 2024 garygeeke updated engine list." + ] + } +} +``` \ No newline at end of file diff --git a/site/docs/guides/admin/servers/engine-host-config-old.svg b/site/docs/guides/admin/servers/engine-host-config-old.svg new file mode 100644 index 0000000000..0dc1b8510c --- /dev/null +++ b/site/docs/guides/admin/servers/engine-host-config-old.svg @@ -0,0 +1,4 @@ + + + +
Local Server Id
Local Server Id
Local Server Name
Local Server Name
Local Server Type
Local Server Type
Organization Name
Organization Name
Local Server UserId
Local Server UserId
Local Server Password
Local Server Password
Max Page Size
Max Page Size
Repository Services 
Repository Services 
Engine Services
Engine Services
Audit Trail
Audit Trail
Keeping track of changes. 
Keeping track of changes. 
Common services and
configuration values 
for the server independent
of personality.
Common services and...
Configuration to control
the activation of the
engine services
Configuration to contro...
Repository Services
Repository Services
Audit Log Destinations
Audit Log Destinations
Engine Service Description
Engine Service Description
Engine Id
Engine Id
Engine Qualified Name
Engine Qualified Name
Engine User Id
Engine User Id
Local Server URL Root
Local Server URL Root
Default value for the
platform that this server should
be deployed to.
Default value for the...
Engines
Engines
Remote Service Root URL
Remote Service Root URL
Remote Service Server Name
Remote Service Server Name
Engine Host Services
Engine Host Services
Governance Engine OMAS Root URL
Governance Engine OMAS Root URL
Governance Engine OMAS Server Name
Governance Engine OMAS Server NameText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/guides/admin/servers/engine-host-config.svg b/site/docs/guides/admin/servers/engine-host-config.svg index 0dc1b8510c..312c8abb4b 100644 --- a/site/docs/guides/admin/servers/engine-host-config.svg +++ b/site/docs/guides/admin/servers/engine-host-config.svg @@ -1,4 +1,4 @@ - + -
Local Server Id
Local Server Id
Local Server Name
Local Server Name
Local Server Type
Local Server Type
Organization Name
Organization Name
Local Server UserId
Local Server UserId
Local Server Password
Local Server Password
Max Page Size
Max Page Size
Repository Services 
Repository Services 
Engine Services
Engine Services
Audit Trail
Audit Trail
Keeping track of changes. 
Keeping track of changes. 
Common services and
configuration values 
for the server independent
of personality.
Common services and...
Configuration to control
the activation of the
engine services
Configuration to contro...
Repository Services
Repository Services
Audit Log Destinations
Audit Log Destinations
Engine Service Description
Engine Service Description
Engine Id
Engine Id
Engine Qualified Name
Engine Qualified Name
Engine User Id
Engine User Id
Local Server URL Root
Local Server URL Root
Default value for the
platform that this server should
be deployed to.
Default value for the...
Engines
Engines
Remote Service Root URL
Remote Service Root URL
Remote Service Server Name
Remote Service Server Name
Engine Host Services
Engine Host Services
Governance Engine OMAS Root URL
Governance Engine OMAS Root URL
Governance Engine OMAS Server Name
Governance Engine OMAS Server NameText is not SVG - cannot display \ No newline at end of file +
Local Server Id
Local Server Id
Local Server Name
Local Server Name
Local Server Type
Local Server Type
Organization Name
Organization Name
Local Server UserId
Local Server UserId
Local Server Password
Local Server Password
Max Page Size
Max Page Size
Repository Services 
Repository Services 
Engine Services
Engine Services
Audit Trail
Audit Trail
Keeping track of changes. 
Keeping track of changes. 
Common services and
configuration values 
for the server independent
of personality.
Common services and...
Configuration to control
the activation of the
engine services
Configuration to contro...
Repository Services
Repository Services
Audit Log Destinations
Audit Log Destinations
Engine Service Description
Engine Service Description
Engine Id
Engine Id
Engine Qualified Name
Engine Qualified Name
Engine User Id
Engine User Id
Local Server URL Root
Local Server URL Root
Default value for the
platform that this server should
be deployed to.
Default value for the...
Engine List
Engine List
Remote Service Root URL
Remote Service Root URL
Remote Service Server Name
Remote Service Server Name
Engine Host Services
Engine Host Services
Governance Engine OMAS Root URL
Governance Engine OMAS Root URL
Governance Engine OMAS Server Name
Governance Engine OMAS Server NameText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/release-notes/5-0.md b/site/docs/release-notes/5-0.md index e64a240d94..631c52526a 100644 --- a/site/docs/release-notes/5-0.md +++ b/site/docs/release-notes/5-0.md @@ -156,6 +156,9 @@ Release 5.0 is a major functional release focused on usability, both from the po ??? functional "IntelliJ HTTP Client" The `omag-server-platform` assembly created during an egeria build now includes script files that exercise Egeria's REST API services using IntelliJ's HTTP Client. These mirror the Postman collections that are also found in the assembly. +??? info "Default Audit Log console output has changed" + The default audit log output to the console for newly configured servers will no longer include the `Event` log entries and the `Types` log entries. Existing servers will continue to log as before. The audit log entries displayed on the console by a server can be changed using the [Administration Services](/guides/admin/servers/configuring-a-metadata-access-store/#configure-the-audit-log). + ??? info "Management of open metadata type definitions" As the Egeria code base evolved, sets of definitions for the unique identifiers and type names of the open metadata types appeared in multiple modules. There was a set in the open metadata archive helper, the generic handlers, multiple OMASs and the Governance Action Framework. This was in addition to the original definitions in the open metadata type archive itself. In release 5.0, these copies of the open metadata type identifiers have been consolidated into one set found in the Governance Action Framework. There is still work to change the type definitions in the open metadata type archive to use the definitions from the GAF. This change removes the inconsistencies and gaps in the definitions. It also makes it easier to discover where a particular open metadata type is used. diff --git a/site/docs/services/omes/survey-action/overview.md b/site/docs/services/omes/survey-action/overview.md index 0451084886..9a19255375 100644 --- a/site/docs/services/omes/survey-action/overview.md +++ b/site/docs/services/omes/survey-action/overview.md @@ -10,7 +10,7 @@ hide: # Survey Action Open Metadata Engine Service (OMES) -The Survey Action OMES provides support for [event action engines](/concepts/event-action-engine) that are part of the [Survey Action Framework (SAF)](/frameworks/saf/overview). +The Survey Action OMES provides support for [survey action engines](/concepts/survey-action-engine) that are part of the [Survey Action Framework (SAF)](/frameworks/saf/overview). ![Survey Action OMES](/services/omes/engine-services-survey-action-server-side.svg) @@ -20,6 +20,6 @@ A survey action engine hosts specialized governance services called [survey acti The Survey Action OMES is capable of hosting one or more [survey action engines](/concepts/survey-action-engine). -The survey action engine services call the [Stewardship Action Open Metadata Access Service (OMAS)](/services/omas/stewardship-action/overview) running in a [metadata access server](/concepts/metadata-access-server) to retrieve information about events and to store the results of the survey action services' work. +The survey action engine services call the [Asset Owner Open Metadata Access Service (OMAS)](/services/omas/asset-owner/overview) running in a [metadata access server](/concepts/metadata-access-server) to retrieve information about assets and to store the results of the survey action services' work. --8<-- "snippets/abbr.md" diff --git a/site/docs/types/6/0610-Annotations.svg b/site/docs/types/6/0610-Annotations.svg index 33adc0a7b2..f9c287c6ed 100644 --- a/site/docs/types/6/0610-Annotations.svg +++ b/site/docs/types/6/0610-Annotations.svg @@ -1,4 +1,4 @@ -
0610 - Annotations
0610 - Annotations
«entity»
Annotation
«entity»...
annotationType : string
summary : string
confidenceLevel : int
expression : string
explanation : string
analysisStep : string
jsonProperties : string
additionalProperties : map<string, string>
annotationType : string...
*
*
0..1
0..1
fromSurveyReport
fromSurveyReport
reportedAnnotations
reportedAnnotations
«entity»
SurveyReport
«entity»...
«relationship»
ReportedAnnotation
«relationship»...
extendedAnnotations
extendedAnnotations
*
*
*
*
«relationship»
AnnotationExtension
«relationship»...
annotationExtensions
annotationExtensions
«entity»
OpenMetadataRoot
«entity»...
«entity»
OpenMetadataRoot
«entity»...
«relationship»
AssociatedAnnotation
«relationship»...
*
*
*
*
associatedAnnotations
associatedAnnotations
annotationSubject
annotationSubject
«entity»
DataFieldAnnotation
«entity»...
«entity»
Annotation
«entity»...
*
*
0..1
0..1
fromDiscoveryAnalysisReport
fromDiscoveryAnalysi...
reportedAnnotations
reportedAnnotations
«entity»
OpenDiscoveryAnalysisReport
«entity»...
«relationship»
DiscoveredAnnotation
«relationship»...Text is not SVG - cannot display \ No newline at end of file +
0610 - Annotations
0610 - Annotations
«entity»
Annotation
«entity»...
annotationType : string
summary : string
confidenceLevel : int
expression : string
explanation : string
analysisStep : string
jsonProperties : string
additionalProperties : map<string, string>
annotationType : string...
*
*
0..1
0..1
fromSurveyReport
fromSurveyReport
reportedAnnotations
reportedAnnotations
«entity»
SurveyReport
«entity»...
«relationship»
ReportedAnnotation
«relationship»...
extendedAnnotations
extendedAnnotations
*
*
*
*
«relationship»
AnnotationExtension
«relationship»...
annotationExtensions
annotationExtensions
«entity»
OpenMetadataRoot
«entity»...
«entity»
OpenMetadataRoot
«entity»...
«relationship»
AssociatedAnnotation
«relationship»...
*
*
*
*
associatedAnnotations
associatedAnnotations
annotationSubject
annotationSubject
«entity»
DataFieldAnnotation
«entity»...
«entity»
Annotation
«entity»...
*
*
0..1
0..1
fromDiscoveryAnalysisReport
fromDiscoveryAnalysi...
reportedAnnotations
reportedAnnotations
«entity»
OpenDiscoveryAnalysisReport
«entity»...
«relationship»
DiscoveredAnnotation
«relationship»...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/6/0620-Data-Profiling.svg b/site/docs/types/6/0620-Data-Profiling.svg index a4cd234d75..c0d4c0d73c 100644 --- a/site/docs/types/6/0620-Data-Profiling.svg +++ b/site/docs/types/6/0620-Data-Profiling.svg @@ -1,4 +1,4 @@ - + -
0620 - Data Profiling
0620 - Data Profiling
«entity»
DataProfileAnnotation
«entity»...
length : int
inferredDataType : string
inferredFormat : string
inferredLength : int
inferredPrecision : int
inferredScale : int
profileProperties : map<string, string>
profileFlags : map<string, boolean>
profileCounts : map<string, long>
valueList : array<string>
valueCount : map<string, int>
valueRangeFrom : string
valueRangeTo : string
averageValue : string
length : int...
«entity»
DataFieldAnnotation
«entity»...
«entity»
DataProfileLogAnnotation
«entity»...
«entity»
LogFile
«entity»...
*
*
dataProfileLogFiles
dataProfileLogFiles
*
*
dataProfileAnnotations
dataProfileAnnotations
«relationship»
DataProfileLogFile
«relationship»...
«entity»
FingerprintAnnotation
«entity»...
fingerprint : string
fingerprintAlgorithm : string
hash : long
hashAlgorithm : string
fingerprint : string...Text is not SVG - cannot display \ No newline at end of file +
0620 - Data Profiling
0620 - Data Profiling
«entity»
DataProfileAnnotation
«entity»...
length : int
inferredDataType : string
inferredFormat : string
inferredLength : int
inferredPrecision : int
inferredScale : int
profileProperties : map<string, string>
profileFlags : map<string, boolean>
profileCounts : map<string, long>
valueList : array<string>
valueCount : map<string, int>
valueRangeFrom : string
valueRangeTo : string
averageValue : string
length : int...
«entity»
DataFieldAnnotation
«entity»...
«entity»
DataProfileLogAnnotation
«entity»...
«entity»
Asset
«entity»...
*
*
dataProfileData
dataProfileData
*
*
dataProfileAnnotations
dataProfileAnnotations
«relationship»
DataProfileData
«relationship»...
«entity»
FingerprintAnnotation
«entity»...
fingerprint : string
fingerprintAlgorithm : string
hash : long
hashAlgorithm : string
fingerprint : string...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/6/0660-Data-Source-Measurements.svg b/site/docs/types/6/0660-Data-Source-Measurements.svg index 3a9decedc6..93390c4a01 100644 --- a/site/docs/types/6/0660-Data-Source-Measurements.svg +++ b/site/docs/types/6/0660-Data-Source-Measurements.svg @@ -1,3 +1,4 @@ + -
0660 - Data Source Measurements
0660 - Data Source Measurements
«entity»
DataSourceMeasurementAnnotation
«entity»...
dataSourceProperties : map<string, string>
dataSourceProperties : map<string, string>
«entity»
Annotation
«entity»...
«entity»
DataSourcePhysicalStatusAnnotation
«entity»...
sourceCreateTime : date
sourceUpdateTime : date
size : int
encoding : string
sourceCreateTime : date...Viewer does not support full SVG 1.1 \ No newline at end of file +
0660 - Data Source Measurements
0660 - Data Source Measurements
«entity»
DataSourceMeasurementAnnotation
«entity»...
dataSourceProperties : map<string, string>
dataSourceProperties : map<string, string>
«entity»
Annotation
«entity»...
«entity»
DataSourcePhysicalStatusAnnotation
«entity»...
sourceCreateTime : date
sourceUpdateTime : date
size : long
encoding : string
sourceCreateTime : date...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 765cc5f2ab..87a732d7ec 100644 --- a/site/docs/types/6/area-6-discovery.drawio +++ b/site/docs/types/6/area-6-discovery.drawio @@ -1,6 +1,6 @@ - + - + @@ -163,7 +163,7 @@ - + @@ -396,7 +396,7 @@ - + @@ -419,7 +419,7 @@ - + @@ -481,85 +481,85 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -895,7 +895,7 @@ - + @@ -931,13 +931,13 @@ - + - + @@ -946,7 +946,7 @@ - + @@ -1163,7 +1163,7 @@ - + @@ -1191,7 +1191,7 @@ - + diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 35fd3d937a..97606cf291 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -52,6 +52,7 @@ nav: - JDBC Connector: connectors/resource/jdbc-resource-connector.md - Basic File Connector: connectors/resource/basic-file-resource-connector.md - CSV File Connector: connectors/resource/csv-file-resource-connector.md + - Basic Folder Connector: connectors/resource/basic-folder-resource-connector.md - Data Folder Connector: connectors/resource/data-folder-resource-connector.md - System: - Apache Atlas REST Connector: connectors/system/apache-atlas-rest-connector.md From 17fa3135444dfcb771dba3a4b86c2838bfecafa5 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Tue, 30 Jan 2024 21:21:35 +0000 Subject: [PATCH 2/2] Fix broken link #890 Signed-off-by: Mandy Chessell --- site/docs/concepts/governance-request-type.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/docs/concepts/governance-request-type.md b/site/docs/concepts/governance-request-type.md index d8b0aeedec..4fd3d69fb0 100644 --- a/site/docs/concepts/governance-request-type.md +++ b/site/docs/concepts/governance-request-type.md @@ -4,7 +4,7 @@ # Governance Request Type -The *governance request type* defines the descriptive name of a specific governance action that the organization wishes to run. It is passed to the activated [governance service](/concepts/governance-service) along with some request parameters (name-value pairs of properties) and its [action targets](/concepts/acton-target) when it starts. The governance request type, request parameters and action targets collectively instruct the governance service on the action to perform. +The *governance request type* defines the descriptive name of a specific governance action that the organization wishes to run. It is passed to the activated [governance service](/concepts/governance-service) along with some request parameters (name-value pairs of properties) and its [action targets](/concepts/action-target) when it starts. The governance request type, request parameters and action targets collectively instruct the governance service on the action to perform. The governance request type is also used to identify which governance service to run. It is mapped to a [governance service](/concepts/governance-service) implementation along with an initial set of request parameters in a [governance engine definition](/concepts/governance-engine) as shown in Figure 1.