diff --git a/site/docs/concepts/placeholder.md b/site/docs/concepts/placeholder.md new file mode 100644 index 0000000000..de92b5ec17 --- /dev/null +++ b/site/docs/concepts/placeholder.md @@ -0,0 +1,9 @@ + + + + +# 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. \ No newline at end of file diff --git a/site/docs/concepts/survey-action-engine.md b/site/docs/concepts/survey-action-engine.md index 10cd1c63b7..afc7b4a958 100644 --- a/site/docs/concepts/survey-action-engine.md +++ b/site/docs/concepts/survey-action-engine.md @@ -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 diff --git a/site/docs/concepts/survey-report.md b/site/docs/concepts/survey-report.md index d3a532c483..5cbc5bf183 100644 --- a/site/docs/concepts/survey-report.md +++ b/site/docs/concepts/survey-report.md @@ -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" diff --git a/site/docs/frameworks/ocf/connection.svg b/site/docs/frameworks/ocf/connection.svg new file mode 100644 index 0000000000..dbdbc6e8d0 --- /dev/null +++ b/site/docs/frameworks/ocf/connection.svg @@ -0,0 +1,4 @@ + + + +
Connection
Connector Type
Endpoint
Which connector implementation to use
Where the resource is located
 \ No newline at end of file diff --git a/site/docs/frameworks/ocf/overview.md b/site/docs/frameworks/ocf/overview.md index 5fdcf4258a..853f1713f8 100644 --- a/site/docs/frameworks/ocf/overview.md +++ b/site/docs/frameworks/ocf/overview.md @@ -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. @@ -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). diff --git a/site/docs/release-notes/5-0.md b/site/docs/release-notes/5-0.md index 77f22373a5..60032970da 100644 --- a/site/docs/release-notes/5-0.md +++ b/site/docs/release-notes/5-0.md @@ -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. diff --git a/site/docs/services/omas/index.md b/site/docs/services/omas/index.md index b85a68c7d0..0bf80c0eb4 100644 --- a/site/docs/services/omas/index.md +++ b/site/docs/services/omas/index.md @@ -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) | diff --git a/site/docs/services/omes/engine-services-event-action-server-side.svg b/site/docs/services/omes/engine-services-event-action-server-side.svg index fc734872ab..d80d070faf 100644 --- a/site/docs/services/omes/engine-services-event-action-server-side.svg +++ b/site/docs/services/omes/engine-services-event-action-server-side.svg @@ -1,4 +1,4 @@ -
Engine Host OMAG Server
Engine Host Services
Metadata Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Data Science OMAS
REST API calls
Admin
REST API
Event
Action
Engine
Service
Admin
REST API
Event Action Engine Handler
Governance Services Map
Stewardship
Action
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Event Action
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Access Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Data Science OMAS
REST API calls
Admin
REST API
Event
Action
Engine
Service
Admin
REST API
Event Action Engine Handler
Governance Services Map
Stewardship
Action
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Event Action
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services-survey-action-server-side.svg b/site/docs/services/omes/engine-services-survey-action-server-side.svg index e2010689af..da2a4d9b40 100644 --- a/site/docs/services/omes/engine-services-survey-action-server-side.svg +++ b/site/docs/services/omes/engine-services-survey-action-server-side.svg @@ -1,4 +1,4 @@ -
Engine Host OMAG Server
Engine Host Services
Metadata Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Asset Owner OMAS
REST API calls
Admin
REST API
Survey
Action
Engine
Service
Admin
REST API
Survey Action Engine Handler
Governance Services Map
Asset
Owner
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Survey Action
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Access Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Asset Owner OMAS
REST API calls
Admin
REST API
Survey
Action
Engine
Service
Admin
REST API
Survey Action Engine Handler
Governance Services Map
Asset
Owner
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Survey Action
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services.drawio b/site/docs/services/omes/engine-services.drawio index 58ea1f310c..9f8b6293eb 100644 --- a/site/docs/services/omes/engine-services.drawio +++ b/site/docs/services/omes/engine-services.drawio @@ -1,4 +1,4 @@ - + @@ -456,7 +456,7 @@ - + @@ -787,7 +787,7 @@ - + @@ -935,7 +935,7 @@ - + @@ -1074,26 +1074,26 @@ - + - + - + - + - + - + diff --git a/site/docs/services/omes/index.md b/site/docs/services/omes/index.md index 512dca0790..31d913dd03 100644 --- a/site/docs/services/omes/index.md +++ b/site/docs/services/omes/index.md @@ -8,7 +8,7 @@ hide: # Open Metadata Engine Services (OMES) -The engine services run in the [engine host](/concepts/engine-host). They provide the special services that are available to the [governance services](/concepts/governance-services) through their context. There is an engine service for each type of governance service. Each engine service also maps the calls from the governance service to calls to the services of a [metadata access server](/concepts/metadata-access-server). The table below summarizes the engine services, the type of governance service they support and the service on the metadata access server that they call. +The engine services run in the [engine host](/concepts/engine-host). They provide the special services that are available to the [governance services](/concepts/governance-service) through their context. There is an engine service for each type of governance service. Each engine service also maps the calls from the governance service to calls to the services of a [metadata access server](/concepts/metadata-access-server). The table below summarizes the engine services, the type of governance service they support and the service on the metadata access server that they call. | Name of the Engine Service | Type of Governance Service supported | Partner service in the metadata | |-----------------------------------------------------------------------------|--------------------------------------------------------------------------|---------------------------------------------------------------------| diff --git a/site/docs/types/0/0011-Managing-Referenceables.md b/site/docs/types/0/0011-Managing-Referenceables.md index df6ec5722e..91ecdf2569 100644 --- a/site/docs/types/0/0011-Managing-Referenceables.md +++ b/site/docs/types/0/0011-Managing-Referenceables.md @@ -21,6 +21,14 @@ The *Template* classification indicates that a [*Referenceable*](/types/0/0010-B ![Example of the use of a Template classification](template-use-case-2.svg) +The properties for the *Template* classification are: + +* *name* - name of the template, designed to help the selection of the correct template. +* *description* - further information on the purpose of the template. +* *placeholderProperties* - provides the names of the [placeholder properties](/concepts/placeholder) mapped to a description/guidance of the value to supply when the template is used. +* *replacementProperties* - provides the names of the attributes in the top-level entity created from the template that should be replaced. Again each attribute name is mapped to a description of the value to supply and its use. replacement properties can be used for attributes of type string, boolean, int and long. +* *additionalProperties* - allows additional information about the template to be supplied + Templates can include relationships. If the relationship links to an entity that has the same anchor as the starting entity, the entity and the relationship is replicated. If the linked entity is part of a different anchor, only the relationship is created. In the example above, the glossary term has a different anchor to the asset. Therefore any assets created with *tAsset* as a template will be linked to the same glossary term. ## TemplateSubstitute classification @@ -43,12 +51,7 @@ The *sourceVersionNumber* identifies the version number of the template used whe ## CatalogTemplate relationship -The *CatalogTemplate* relationship links an *OpenMetadataRoot* entity that describes a class of technology with a [template](/features/templated-cataloguing/overview) for creating a catalog entry for a resource of this class. The attributes are used to help a user select the template, and then provide new property values to override the values in the template. - -* *templateName* - provides a name for the template. -* *templateDescription* - describes what the template contains. -* *replacementProperties* - lists properties whose values from the template should be overridden when creating a new element from the template. The map is from attribute name to the value to replace it with. This can be used for numeric and boolean values as well as string values. -* *placeholderProperties* - lists properties that contains strings to override placeholder strings, formatted with two sets of curly-braces, such as `{{placeholder}}`. The map is from placeholder name to value to replace it with. +The *CatalogTemplate* relationship links an *OpenMetadataRoot* entity that describes a class of technology with a [template](/features/templated-cataloguing/overview) for creating a catalog entry for a resource of this class. ??? deprecated "Deprecated types" - *LastAttachment* - use *LatestChange* instead diff --git a/site/docs/types/0/0011-Managing-Referenceables.svg b/site/docs/types/0/0011-Managing-Referenceables.svg index 40bc26ed82..64d44098e0 100644 --- a/site/docs/types/0/0011-Managing-Referenceables.svg +++ b/site/docs/types/0/0011-Managing-Referenceables.svg @@ -1,4 +1,4 @@ -
0011 - Managing Referenceables
0011 - Managing Referenceables
«classification»
LatestChange
«classification»...
changeTarget : LatestChangeTarget
changeAction : LatestChangeAction
classificationName : string
attachmentGUID : string
attachmentType : string
relationshipType : string
user : string
description : string
changeTarget : LatestChangeTarget...
«enumeration»
LatestChangeTarget
«enumeration»...
ENTITY_STATUS = 0
ENTITY_PROPERTY = 1
ENTITY_CLASSIFICATION = 2
ENTITY_RELATIONSHIP = 3
ATTACHMENT = 4
ATTACHMENT_STATUS = 5
ATTACHMENT_PROPERTY = 6
ATTACHMENT_CLASSIFICATION = 7
ATTACHMENT_RELATIONSHIP = 8
OTHER = 99
ENTITY_STATUS = 0...
«enumeration»
LatestChangeAction
«enumeration»...
CREATED = 0
UPDATED = 1
DELETED = 2
OTHER = 99
CREATED = 0...
«relationship»
SourcedFrom
«relationship»...
sourceVersionNumber : long
sourceVersionNumber : long
templateElement
templateElement
0..1
0..1
*
*
resultingElement
resultingElement
«entity»
Referenceable
«entity»...
«classification»
Template
«classification»...
name : string
description : string
additionalProperties : map<string, string>
name : string...
«classification»
TemplateSubstitute
«classification»...
«entity»
OpenMetadataRoot
«entity»...
*
*
implementationTypes
implementationTypes
templatesForCataloguing
templatesForCataloguing
*
*
templateName : string
templateDescription : string
replacementProperties : map<string, string>
placeholderProperties : map<string, string>
templateName : string...
«relationship»
CatalogTemplate
«relationship»...
«entity»
OpenMetadataRoot
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0011 - Managing Referenceables
«classification»
LatestChange
changeTarget : LatestChangeTarget
changeAction : LatestChangeAction
classificationName : string
attachmentGUID : string
attachmentType : string
relationshipType : string
user : string
description : string
«enumeration»
LatestChangeTarget
ENTITY_STATUS = 0
ENTITY_PROPERTY = 1
ENTITY_CLASSIFICATION = 2
ENTITY_RELATIONSHIP = 3
ATTACHMENT = 4
ATTACHMENT_STATUS = 5
ATTACHMENT_PROPERTY = 6
ATTACHMENT_CLASSIFICATION = 7
ATTACHMENT_RELATIONSHIP = 8
OTHER = 99
«enumeration»
LatestChangeAction
CREATED = 0
UPDATED = 1
DELETED = 2
OTHER = 99
«relationship»
SourcedFrom
sourceVersionNumber : long
templateElement
0..1
*
resultingElement
«entity»
Referenceable
«classification»
Template
name : string
description : string
placeholderProperties : map<string, string>
replacementProperties : map<string, string>
additionalProperties : map<string, string>
«classification»
TemplateSubstitute

«entity»
OpenMetadataRoot
*
implementationTypes
templatesForCataloguing
*
«relationship»
CatalogTemplate
«entity»
OpenMetadataRoot
 \ No newline at end of file diff --git a/site/docs/types/0/area-0-basic-types-and-infrastructure.drawio b/site/docs/types/0/area-0-basic-types-and-infrastructure.drawio index a7c9aabf91..4d78c3b472 100644 --- a/site/docs/types/0/area-0-basic-types-and-infrastructure.drawio +++ b/site/docs/types/0/area-0-basic-types-and-infrastructure.drawio @@ -1,6 +1,6 @@ - + - + @@ -443,7 +443,7 @@ - + @@ -455,124 +455,124 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - + - + - + - + - - + + - + - + - + - + - - + + - - + + - + - + - + diff --git a/site/mkdocs.yml b/site/mkdocs.yml index f7f2689e36..b36a6542e6 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -791,6 +791,7 @@ nav: - Personal Notes: concepts/personal-notes.md - Personal Profile: concepts/personal-profile.md - Personal Roles: concepts/personal-roles.md + - Placeholders: concepts/placeholder.md - Platform Metadata Security Connector: concepts/platform-metadata-security-connector.md - Platform URL Root: concepts/platform-url-root.md - Presentation Server: concepts/presentation-server.md