Merge pull request #829 from mandy-chessell/dev-dojo

Add deployedImplementationType to top-level entities

site/docs/release-notes/4-3.md

@@ -7,16 +7,30 @@
 _**These are DRAFT release notes, initially copied from the previous release
 The notes will be updated until & when 4.3 is released**_
 
+??? functional "Open Metadata Types"
+    * The  [*HostClusterMember*](/types/0/0035-Complex-Hosts) relationship has new properties *memberRole* and *additionalProperties* to improve ability to describe a host cluster operation.
+    * The  [*DataSet*](/types/0/0010-Base-Model), [*DataStore*](/types/2/0210-Data-Stores), [*DeployedAPI*](/types/2/0212-Deployed-APIs), [*DeployedSoftwareComponent*](/types/2/0215-Software-Components) and [*DataFeed*](/types/2/0223-Events-and-Logs) entity types each have a new attribute called *deployedImplementationType* to describe the technology supporting the associated component.  This addition is to enable integration connectors to be more precise in describing the technology they are cataloguing.  This attribute is also used in [*SoftwareServerPlatform*](/types/0037-Software-Server-Platforms), [*SoftwareServer*](/types/0/0040-Software-Servers) and [*SoftwareCapability*](/types/0/0042-Software-Capabilities) entity types; along with the [ServerPurpose](/types/0/0041-Server-Purpose) and [*CloudPlatform*](/types/0/0090-Cloud-Platforms-and-Services) classification.  There are subtypes of *DataStore* (*LogFile*, *GraphStore*, *MetadataRepository*) have been modified because they already include the property and duplicate properties in the type hierarchy cause indexing problems in some repositories.  Similarly, there were duplicated *deployedImplementationType* properties in the [*ServerPurpose*](/types/0/0041-Server-Purpose) classification affecting *RepositoryProxy* and *MetadataServer* classifications. 
+
+
 ??? functional "Integration Connector function"
     Integration connectors can now check to see if they are in the middle of refresh() processing.  This is valuable in multi-threaded operation, for example when processing events.  Typically many of the events that are generated while the connector is being called to `refresh()` are caused by the connector's activity.  There is a new method on the integration context called [`isRefreshInProgress()`](https://odpi.github.io/egeria/org/odpi/openmetadata/frameworks/integration/context/IntegrationContext.html).  It returns true if the connector is currently running its `refresh()` method.  An example of how to use this method is found in the [developer guide](/guides/developer/integration-connectors/overview/#registering-a-listener-with-open-metadata).
 
+??? functional "Open Metadata Integration Services (OMISs) updates"
+    * [Category Integrator OMIS](/services/omis/catalog-integrator/overview) supports the stewardship services from [Asset Manager OMAS](/services/omas/asset-manager/overview) through the [`StewardshipExchangeService`](https://odpi.github.io/egeria/org/odpi/openmetadata/integrationservices/catalog/connector/StewardshipExchangeService.html).
+    * A number of fixes have been made to the context methods of the OMISs that were incorrectly exposing the `userId`, `externalSourceGUID` and `externalSourceName` parameters.  These have been corrected so these values come from the connector's configuration.  The affected OMISs are:
+
+        * [Catalog Integrator OMIS](/services/omis/catalog-integrator/overview)
+        * [Display Integrator OMIS](/services/omis/display-integrator/overview)
+        * [Infrastructure Integrator OMIS](/services/omis/infrastructure-integrator/overview)
+        * [Lineage Integrator OMIS](/services/omis/lineage-integrator/overview)
+        * [Security Integrator OMIS](/services/omis/security-integrator/overview)
+
+??? functional "Apache Atlas Integration Connector"
+    The [Apache Atlas Integration Connector](/connectors/integration/apache-atlas-catalog-integration-connector) has been enhanced to catalog Assets and Lineage from Apache Atlas into the open metadata ecosystem.  It maintains [semantic assignment](/types/3/0370-Semantic-Assignment) relationships between the glossary terms, exchanged in the first release of the connector, with the Apache Atlas assets it finds.
+
 
 ??? functional "Conformance Test Suite"
     There is a new option on the repository workbench to allow you to restrict the number of different types of instances that are tested.  By default, all combinations of the types supported by the technology under test, are used when testing the instance methods.  For native repository connectors, that can add up to a lot of tests, taking many hours to run.  In 4.3, we have introduced a new option called *testEntityTypes* that is [added to the workbench configuration](/guides/admin/servers/configuring-a-conformance-test-server). It is set to a list of entity types such as `["Asset", "InformalTag"]` and the tests are restricted to these types, their super types and any relationships and classifications that can connector to these entity types. 
 
-??? functional "Open Metadata Types"
-    * The  [*HostClusterMember*](/types/0/0035-Complex-Hosts) relationship has new properties *memberRole* and *additionalProperties* to improve ability to describe a host cluster operation.
-    * The  [*DeployedSoftwareComponent*](/types/2/0215-Softeware-Components) entity has a new properties called *deployedImplementationType* to describe the technology supporting a process.
-
 
 --8<-- "snippets/abbr.md"

site/docs/types/0/0010-Base-Model.md

@@ -7,11 +7,11 @@ The base model is the starting point for the open metadata type model.
 
 ![UML](0010-Base-Model.svg)
 
-## OpenMetadataRoot
+## OpenMetadataRoot entity
 
 *OpenMetadataRoot* is the root entity for all open metadata entity types.
 
-## Referenceable
+## Referenceable entity
 
 *Referenceable* is the super type for many of the open metadata entity types. A *Referenceable* entity is something that is important enough to be assigned a unique (qualified) name within its type. This unique name is called the *qualifiedName* and may be set to the unique identifier value used outside the open metadata ecosystem. Alternatively, it is often set to a concatenation of an element's type name along with a number of its properties to create a unique string.
 
@@ -20,7 +20,7 @@ Referenceable also has provision for storing additional properties. This is a se
 * [Further information on the use of Referenceable.](/concepts/referenceable)
 * [Further information on external identifiers](/features/external-identifiers/overview)
 
-## Asset
+## Asset entity
 
 An [Asset](/concepts/asset) is a metadata entity that describes a [resource](/concepts/resource) (either physical or digital) that is of value and so needs to be managed and governed.  [*Infrastructure*](#infrastructure), [*Process*](#process), [*DataStore*](/types/2/0210-Data-Stores), [*DataFeed*](/types/2/0223-Events-and-Logs), [*DeployedAPI*](/types/2/0212-Deployed-APIs), [*DataSet*](#dataset) and [*RunnableSoftwareComponent*](/types/2/0282-Released-Software-Components) are subtypes of *Assets*.
 
@@ -44,7 +44,7 @@ The values set in an *Asset* entity tend to be focused around the implementation
 
 More information on assets can be found in the [Metadata Manager](/patterns/metadata-manager/overview) overview.
 
-### Infrastructure
+### Infrastructure entity
 
 *Infrastructure* represents both the physical and digital assets that the organization runs its business on. [*ITInfrastructure*](/types/0/0030-Hosts-and-Platforms) is a subtype of *Infrastructure* describing Information Technology (IT) infrastructure that runs IT services.  There is more information on the different types of *ITInfrastructure* in:
 
@@ -54,7 +54,7 @@ More information on assets can be found in the [Metadata Manager](/patterns/meta
 - [0040 Software servers](/types/0/0040-Software-Servers)
 - [0042 Software capabilities](/types/0/0042-Software-Capabilities)
 
-### Process
+### Process entity
 
 *Process* describes a well-defined set of processing steps and decisions that drive a particular aspect of the organization's business. Most processes are automated with software (see [*DeployedSoftwareComponent*](/types/2/0215-Software-Components/#deployedsoftwarecomponent)) but they may also be a manual procedure. An automated process can be invoked from a remote server through a [*DeployedAPI*](/types/2/0212-deployed-apis/#deployedapi).
 
@@ -68,24 +68,26 @@ Processes have an advanced lifecycle.  They can have the following [instance sta
 
 The *formula* attribute can describe its behaviour, *formulaType* describes the notation language used to describe the formula.
 
-### DataSet
+### DataSet entity
 
-*DataSet* represents a collection of related data. This data does not need to be stored together. The *formula* property describes the logic used to populate the DataSet, *formulaType* describes the notation language used to describe the formula.  See [*DataStore*](/types/2/0210-Data-Stores) for the `Asset` that represents a physical store and the [*DataContentForDataSet*](/types/2/0210-Data-Stores/#datacontentfordataset) relationship links the DataSet to the asset(s) that describe the data sources.
+*DataSet* represents a collection of related data. This data does not need to be stored together. The *formula* property describes the logic used to populate the DataSet, *formulaType* describes the notation language used to describe the formula, and *deployedImplementationType* describes the technology supporting the implementation of the technology. 
 
-## SampleData
+See [*DataStore*](/types/2/0210-Data-Stores) for the `Asset` that represents a physical store and the [*DataContentForDataSet*](/types/2/0210-Data-Stores/#datacontentfordataset) relationship links the DataSet to the asset(s) that describe the data sources.
+
+## SampleData relationship
 
 The *SampleData* relationship links an *Asset* entity describing a collection of sample data that originates from the resource represented by the *Referenceable* entity.
 
-## Anchors
+## Anchors classification
 
 The *Anchors* classification is used internally by the open metadata ecosystem to optimize the lookup of the entity at the root of a cluster of elements that represents a larger object. Currently, there is support for objects uniquely "owned" by an entity to store the GUID of that entity.
 
 !!! info "Further information on the use of Anchors"
     * [Anchor Management](/concepts/anchor).
 
-## Memento
+## Memento classification
 
-Finally, the *Memento* classification identifies that the Referenceable refers to a real-world asset/artifact that has either been deleted or archived offline. The metadata element has been retained to show its role in the [lineage of other assets/artifacts](/features/lineage-management/overview). The properties in this classification identifies the archive processing and any information that helps to locate the asset/artifact in the archive (if applicable).
+Finally, the *Memento* classification identifies that the Referenceable entity it is attached to, refers to a real-world asset/artifact that has either been deleted or archived offline. The entity has been retained to show its role in the [lineage of other assets/artifacts](/features/lineage-management/overview). The properties in this classification identifies the archive processing and any information that helps to locate the asset/artifact in the archive (if applicable).