Merge pull request #936 from mandy-chessell/code2024

June newsletter

saved/getting-started-text.md

@@ -0,0 +1,16 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the ODPi Egeria project. -->
+
+
+There are a couple of options available to you:
+
+**Running Egeria**
+
+The [Getting Started with Egeria](https://getting-started-with-egeria.pdr-associates.com/introduction.html) blog provides a step-by-step guide to building, installing, configuring and running Egeria on your machine, or in a docker container.
+
+**Developing with Egeria in IntelliJ**
+
+See [Setting up IntelliJ to develop components for Egeria](https://egeria-project.org/education/tutorials/developer-intellij-tutorial/overview/).
+
+
+

site/docs/concepts/index.md

@@ -79,14 +79,12 @@
 - [Data Domain](/concepts/subject-area)
 - [Data Manager](/services/omas/data-manager/overview)
 - [Data Manager OMAS](/services/omas/data-manager/overview)
-- [Data Privacy OMAS](/services/omas/data-privacy/overview)
 - [Data Science OMAS](/services/omas/data-science/overview)
 - [Database Integrator OMIS](/services/omis/database-integrator/overview)
 - [Default Zones](/concepts/governance-zone)
 - [Deployed Implementation Type](/concepts/deployed-implementation-type)
 - [Design Lineage](/features/lineage-management/overview)
 - [Design Model OMAS](/services/omas/design-model/overview)
-- [DevOps OMAS](/services/omas/dev-ops/overview)
 - [Digital Architecture OMAS](/services/omas/digital-architecture/overview)
 - [Digital Product](/concepts/digital-product)
 - [Digital Resource](/concepts/digital-resource)
@@ -351,7 +349,6 @@
 - [Security Connector for OMAG Server Platform](/concepts/platform-metadata-security-connector)
 - [Security Integrator OMIS](/services/omis/security-integrator/overview)
 - [Security Manager OMAS](/services/omas/security-manager/overview)
-- [Security Officer OMAS](/services/omas/security-officer/overview)
 - [Security Tags](/concepts/security-tags)
 - [Server Capabilities](/concepts/software-capability)
 - [Server Chassis](/services/platform-chassis)

site/docs/frameworks/saf/annotation-intro.md

@@ -3,7 +3,7 @@
 
 An *annotation* describes one or more related properties about a [digital resource](/concepts/digital-resource). Some annotations refer to the entire digital resource and others refer to a data field within the digital resource.   The annotations that describe a single data field are called *data field annotations*.
 
-![Structure of survey reports](/guides/developer/open-discovery-services/survey-report-structure.svg)
+![Structure of survey reports](/frameworks/saf/survey-report-structure.svg)
 
 The annotation types defined in the [Survey Action Framework (SAF)](/frameworks/saf/overview) are as follows:
 

site/docs/frameworks/saf/survey-action-pipeline-intro.md

@@ -1,13 +1,13 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the ODPi Egeria project. -->
 
-There is a lot of common functions that are used repeatedly during the discovery process.
+There is a lot of common functions that are used repeatedly during the surveying process.
 
-An *open discovery pipeline* is a specialized implementation of an [open discovery service](/concepts/open-discovery-service) that runs a set of open discovery services against a single [digital resource](/concepts/digital-resource).  The implementation of the open discovery pipeline determines the order that these open discovery services are run. 
+A *survey action pipeline* is a specialized implementation of a [survey action service](/concepts/survey-action-service) that runs a set of survey action services against a single [digital resource](/concepts/digital-resource).  The implementation of the pipeline determines the order that these services are run. 
 
-![Open discovery pipeline example](/guides/developer/open-discovery-services/open-discovery-pipeline-example.svg)
+![Survey action pipeline example](/frameworks/saf/survey-action-pipeline-example.svg)
 
-Each open discovery service in the pipeline is able to access the results of the open discovery services that have run before it through the [discovery context](/guides/developer/open-discovery-services/overview/#discovery-context).  The combined results of the open discovery pipeline are grouped into a single [discovery analysis report](/concepts/discovery-analysis-report) linked off of the asset.
+Each service in the pipeline is able to access the results of the services that have run before it through the [survey context](/frameworks/saf/overview/#survey-context).  The combined results of the pipeline are grouped into a single [survey report](/concepts/survey-report) linked off of the asset.
 
-The aim of the open discovery pipeline is to enable reusable open discovery service implementations to be choreographed together for different types of digital resource.
+The aim of the survey action pipeline is to enable reusable survey action service implementations to be choreographed together for different types of digital resource.
 

site/docs/guides/community.md

@@ -9,7 +9,7 @@ This project welcomes contributors from any organization or background, provided
 
 ### Live discussions
 
-We have weekly community meeting to which all are welcome.  We cover demos, releases, meetups and other activities going on in the community ([agenda and minutes :material-dock-window:](https://wiki.lfaidata.foundation/display/EG/Community+Meetings){ target=wiki }).  These calls run January to June, September to November.  July, August and December are popular vacation times, and so we stop the calls while the attendance is low.
+We have weekly community meeting to which all are welcome.  We cover demos, releases, meetups and other activities going on in the community.  These calls run January to June, September to November.  July, August and December are popular vacation times, and so we stop the calls while the attendance is low.
 
 <iframe src="https://calendar.google.com/calendar/embed?height=600&amp;wkst=1&amp;bgcolor=%23ffffff&amp;ctz=Europe%2FLondon&amp;src=YjVxaGRyNXFkYmZscDhkbHA3MGxtb2RtMHNmdmlocWxAaW1wb3J0LmNhbGVuZGFyLmdvb2dsZS5jb20&amp;color=%234285F4&amp;showCalendars=0&amp;showPrint=0&amp;title=Egeria%20Calendar" style="border-width:0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
 

site/docs/guides/contributor/release-process/egeria-core-release.md

@@ -39,7 +39,7 @@ If an urgent release is required with, for example, a critical security fix, the
 ??? success "4. Update main from `x.y-SNAPSHOT` to `x.z-SNAPSHOT`"
     - `git checkout main`
     - `git pull upstream main`
-    - Edit all files (command line or IDE) to replace `x.y-SNAPSHOT` with the next version, e.g. change `1.3-SNAPSHOT` to `1.4-SNAPSHOT`. Most of the changes are in `pom.xml` or gradle files, however some code and documentation also has references to our versions and all need modifying.
+    - Edit all files (command line or IDE) to replace `x.y-SNAPSHOT` with the next version, e.g. change `1.3-SNAPSHOT` to `1.4-SNAPSHOT`. Most of the changes are in gradle files, however some code and documentation also has references to our versions and all need modifying.
     - If using an IDE like IntelliJ, make sure you have all hits by searching again as [by default only a limited number of hits are shown :material-dock-window:](https://youtrack.jetbrains.com/issue/IDEA-157855){ target=intellij }.
     - Commit
     - Create a PR, have reviewed / approved and merged as usual - aim to do this as quickly as reasonable so that there is no potential for version clash
@@ -64,7 +64,7 @@ If an urgent release is required with, for example, a critical security fix, the
 ??? success "7. Create a release in GitHub"
     - [Create the GitHub release :material-github:](https://github.com/odpi/egeria/releases){ target=gh }. Use `Vx.y` as the tag, and ensure the correct branch is set for the target, i.e. `egeria-release-x.y`
     - Fill in the release notes using a title of `Release x.y`. Select the option to include automated release notes. The content will need to be trimmed by deleting from the top to the point where the release being worked on appears ie for release 3.8, look for the update to 3.8-SNAPSHOT and cut up until that point.
-    - Contact the release lead (Nigel Jones) to release the updated maven artifacts (this copies them from the staging repository on oss.sonatype.org to the release repository, which is what is picked up via maven central search)
+    - Contact the release lead (Mandy Chessell) to release the updated maven artifacts (this copies them from the staging repository on oss.sonatype.org to the release repository, which is what is picked up via maven central search)
     - Artifacts will be available on Maven Central within minutes, but may take a few hours to appear in searches.
     - Source archives will be added to the release on GitHub.
     - this step will also create and publish container images to quay.io and docker.io .

site/docs/guides/developer/pyegeria/overview.md

@@ -0,0 +1,7 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+# Python for Egeria (pyegeria)
+
+
+--8<-- "snippets/abbr.md"

site/docs/release-notes/5-0.md

@@ -10,7 +10,6 @@ Release 5.0 is a major functional release focused on usability, both from the po
 * *Simplified up and running* - improvements to the OMAG Server Platform and administration services to make it easier to set up and run, plus new sample server configurations that mean you can get Egeria up and running without needing to understand the administration services.
 * *A python client* - pyegeria provides a python API covering Egeria's administration and operational services plus many of the Open Metadata View Services (OMVSs) provides access to Egeria through this popular programming language for administrators and data professionals.  
 * *Content pack of connector metadata* - metadata to pre-configure the connectors supplied with Egeria, and provide valid value sets describing technology types and file types.
-* *UI back-end consolidation* - updates to the view server to allow both Egeria UIs to connect to it whether it is running in the OMAG Server Platform or OMAG Server Runtime.  This eliminates the need to run the Egeria UI application.
 * *Digital Product Support* - new APIs for creating a [digital product catalog](/concepts/digital-product).
 * *Survey Support* - new framework, services and report utility to support the surveying of digital resources to understand its contents before embarking on wholesale cataloguing and governance.
 * *Reduction of technical debt* - there has been internal code changes to remove deprecated code, remove the duplication of type information, and many bug fixes :).
@@ -139,49 +138,19 @@ Release 5.0 is a major functional release focused on usability, both from the po
     [Valid Metadata OMVS](/services/omvs/valid-metadata/overview) supports the retrieval and maintenance of valid values for open metadata.
 
 ??? functional "Improved anchor support"
-    Anchor classifications now include the type name of the anchor entity.  This allows the Anchor classification to be used to search for string values in any element that is anchored to a particular type of element.
+    Anchor classifications now include the type name and domain of the anchor entity.  This allows the Anchor classification to be used to search for string values in any element that is anchored to a particular type of element.
 
-??? functional "Consolidation of UI Backend Services"
-    Today there are two approaches to providing the backend services for a UI:
-
-    * The OMAG Server Platform provides a set of view services. These are used by the React UI.
-    * There is also a set of services in the Egeria UI Application. These are used by the General User UI.
-
-    The issue with this approach is when the same service is needed for both UIs, it has to be implemented twice, one in each runtime. 
-
-    There is now a common approach for backend services, centered around the [view server](/concepts/view-server). This can run in the OMAG Server Platform, or the new single server OMAG Server runtime.  The Open Metadata View Services (OMVSs) running in the view server will provide all the services for the UIs. To make this possible, new services for token management have been added to the OMAG Server Platform and OMAG Server runtimes.  There are also updates to the view services.  The change is summarized in the diagram below:
-
-    ![UI API migration](/user-interfaces/ui-migration-api-styles.svg)
-
-    More details of the changes are described below:
-
-    ??? functional "New View Service: Asset Catalog OMVS"
-        [Asset Catalog OMVS](/services/omvs/asset-catalog/overview) is a new view service that supports the `/assets` and `/lineage` services from Egeria UI Application.  There are two versions of each call, one of which is deprecated.  The deprecated version exactly matches the API supported by the Egeria UI application, however, it does not manage exceptions in the way expected by an Egeria API.  It will remain in place until the existing UI components are updated to support Egeria's standard exception handling.
-
-    ??? functional "Updates to Glossary Browser OMVS"
-        [Glossary Browser OMVS](/services/omvs/glossary-browser/overview) has been extended to support the `/glossary` services from the Egeria UI application.  They are deprecated because they do not support the standard exception handling, but are in place to support existing UI components.  Once the UI components have been updated to support the main API then these new services will be removed.
-
-    ??? danger "Changes to view service REST API URLs"
-        The following Open Metadata View Services (OMVSs) (and all future OMVSs) support the new URL pattern of `{{baseURL}}/servers/{{server}}/api/open-metadata/{{serviceURLRoot}}/...`
-
-        * [Asset Catalog OMVS](/services/omvs/asset-catalog/overview)
-        * [Automated Curation OMVS](/services/omvs/automated-curation/overview)
-        * [Collection Manager OMVS](/services/omvs/automated-curation/overview)
-        * [Glossary Browser OMVS](/services/omvs/glossary-browser/overview)
-        * [Glossary Manager OMVS](/services/omvs/glossary-manager/overview)
-        * [My Profile OMVS](/services/omvs/my-profile/overview)
-        * [Notification Manager OMVS](/services/omvs/notification-manager/overview)
-
-        The following OMVSs will continue to support the original URL pattern of `{{baseURL}}/servers/{{server}}/open-metadata/view-services/{{serviceURLRoot}}/...` until the React UI components are updated to support the new style of URL.
-
-        * [Dynamic Infrastructure and Operations OMVS](/services/omvs/dino/overview)
-        * [Glossary Author OMVS](/services/omvs/glossary-author/overview)
+??? functional "Removal of JavaScript User Interfaces"
+    The original intention with the UIs was to consolidate their backend services onto the OMAG Server Platform/Runtime.  Unfortunately, neither UI code based is building and the security scanners are reporting serious CVEs with the JavaScript code bases.  There is no-one left in the community that is able to work with the JavaScript and so, for now these UIs have been deprecated.  The runtime services that support the UIs have also been deprecated and removed from the runtime build.  The code is temporarily still in the repository and will be cleaned up in a future release if no progress is made on the JavaScript code.
 
     ??? deprecated "Deprecation of Egeria UI Application"
-        Due to the addition of the new View Services and support for tokens in the OMAG Server Platform and OMAG Server runtimes, the Egeria UI Application is now deprecated.  New UI components should use the [Open Metadata View Services (OMVS)](/services/omvs).
+        Due to the addition of the new View Services and support for tokens in the OMAG Server Platform and OMAG Server runtimes, the Egeria UI Application is now deprecated.  New UI components should use the [Open Metadata View Services (OMVS)](/services/omvs).  The Egeria UI Application assembly, and the open metadata assembly have also been deprecated.
+
+    ??? deprecated "Asset Catalog, OMAS Subject Area OMAS and Glossary View OMAS"
+        The function of these services has now moved to Glossary Manager OMAS, Glossary Browser OMVS and Asset Catalog OMVS. 
 
-    ??? deprecated "Asset Catalog OMAS and Glossary View OMAS"
-        The Glossary View OMAS and Asset Catalog OMAS function has now moved to Glossary Browser OMVS and Asset Catalog OMVS respectively and so Glossary View OMAS and Asset Catalog OMAS are no longer needed.  They will remain in the codebase to support the Egeria UI Application and will be removed at the same time as this runtime.
+    ??? deprecated "Repository Explorer OMVS, Type Explorer OMVS, Dynamic Infrastructure Explorer OMVS, Server Author OMVS, Glossary Author OMVS are now deprecated"
+        These services have been removed from Egeria's build, but their code is temporariliy still in the Egeria.git repository. 
 
 ??? functional "New file extensions to Egeria' standard files"
     Files produced by Egeria supplied connectors now have specific file extensions to help identify them in the file system.  Previously they used the file extension for their format 9such as `.json`.
@@ -220,6 +189,9 @@ Release 5.0 is a major functional release focused on usability, both from the po
 ??? 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.
 
+??? deprecated "Deprecation of Data Engine Proxy and Data Engine OMAS"
+    These services have been deprecated since they are specialized for IBM's Information Server product.  IF support for this product is required in the future then it will be reimplemented in the Integration Daemon.
+
 ??? danger "Removal of the Anonymous Repository Services"
     The anonymous versions to the OMRS Metadata Collection REST APIs have been removed from Egeria's runtimes since they do not include caller information, and therefore provide opportunities for a denial of service attack.  These services were deprecated in version 2 of Egeria.
 

site/docs/release-notes/egeria-status.drawio

@@ -1,4 +1,4 @@
-<mxfile host="Electron" modified="2024-06-06T10:43:43.663Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.4.8 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="m2tD36BFkNTA2ENK3HL-" version="24.4.8" type="device" pages="29">
+<mxfile host="Electron" modified="2024-06-06T12:38:19.302Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.4.8 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="qYAbzvg3A-f7NuEXOnZH" version="24.4.8" type="device" pages="29">
   <diagram id="Gro3B2_n27xaSj8Dfh9V" name="overview">
     <mxGraphModel dx="1941" dy="941" 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>