Merge pull request #852 from odpi/initial-load

Add new types and OMVS descriptions for EO data

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

@@ -21,8 +21,8 @@ Release 4.3 continues the process of improving Egeria's usability.  These change
 
     Each directory in the assembly includes a README.md file to explain its contents.
 
-??? functional "New OMAG server stand alone runtime"
-    We are releasing tech preview for the stand-alone OMAG server spring boot launcher application. This is the first milestone achieved as result of the work planned in the Cloud Native workgroup. It is step forward to enable additional deployment/operation model more suitable for orchestrated container runtime environment such as Kubernetes. Functionally, it runs the same set of OMAG server capabilities/services as if you are running 'virtual' server instance on an OMAG platform. Irrespective of the operating style the OMAG servers are always interoperable.
+??? functional "New OMAG server standalone runtime"
+    We are releasing tech preview for the standalone OMAG server spring boot launcher application. This is the first milestone achieved as result of the work planned in the Cloud Native workgroup. It is step forward to enable additional deployment/operation model more suitable for orchestrated container runtime environment such as Kubernetes. Functionally, it runs the same set of OMAG server capabilities/services as if you are running 'virtual' server instance on an OMAG platform. Irrespective of the operating style the OMAG servers are always interoperable.
 
     We are working to update the guides on the website to address this new feature.
 
@@ -37,7 +37,7 @@ Release 4.3 continues the process of improving Egeria's usability.  These change
     The utilities located in `egeria-dev-projects.git` are now located in `egeria.git` under the `open-metadata-resources` module.  They are now included automatically in the `omag-server-platform` assembly.  These utilities are used in the [Developer Dojo](/education/egeria-dojo/developer/overview).  This will be updated to use the new assembly once release 4.3 is shipped.
 
 ??? functional "Extended integration connector function"
-    [Integration connectors](/concepts/integration-connector) 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).
+    [Integration connectors](/concepts/integration-connector) 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 "New configuration command for when a cohort member moves platform"
     Servers that are [members of a cohort](/concepts/cohort-member) regularly broadcast their network address to other members to allow them to dynamically configure their federated query support.  This network address is configured in the OMAG Server's [configuration document](/concepts/configuration-document) as the `localRepositoryRemoteConnection`'s endpoint address.  When an OMAG Server is relocated to a new platform, this address must change.  There is a new administration command called [`resetRemoteCohortURL`]() with URL `POST {platformURLRoot}/open-metadata/admin-services/users/{userId}/servers/{serverName}/local-repository/configuration/remote-repository-connector-url`.  The new URL is passed in the request body:

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

@@ -5,4 +5,12 @@
 
 _**These are DRAFT release notes.  The notes will be updated until & when 4.4 is released**_
 
+??? functional "Open Metadata Types"
+    * A new classification called [*RootCollection*](/types/0/0021-Collections) can be added to a collection entity to indicate that it is the root of collection hierarchy.
+    * The [*Collection*](/types/0/0021-Collections) entity has a new attribute called *collectionType* that can be used to identify the concept that the collection represents.
+    * A new classification called [*PersonalProject*](/types/1/0130-Projects) can be added to a project entity to indicate that this is an informal project that have been created by an individual to help them organize their work.
+    * A new classification called [*DataScope*](/types/2/0210-Data-Stores) can be added to a referenceable entity (typically a DataStore or DataSet) to define the scope of the associated data resource in space and time.
+
+
+
 --8<-- "snippets/abbr.md"

site/docs/services/omvs/collection-manager/overview.md

@@ -0,0 +1,41 @@
+---
+hide:
+- toc
+---
+
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+--8<-- "snippets/content-status/in-development.md"
+
+# Collection Manager OMVS
+
+The Collection Manager Open Metadata View Services (OMVS) is a REST API designed to back user interfaces (UIs) that support the maintenance and browsing of hierarchies of [collections](/concepts/collection) and their members.
+
+Collections are used to organize elements.  Elements (including other collections) are linked to a collection to show that they are a member of the collection.  An element can be a member of none, one or multiple collections.
+
+There are different types of collections:
+
+* **Collection Hierarchy** - A collection hierarchy is the root node of a hierarchy of collections.  Its members are typically other collections.
+* **Folder** - a collection folder is a collection that is part of a collection hierarchy structure.  It may have members that are collections and/or other types of collections.
+* **Digital Product** - A digital product is a collection of [assets](/concepts/asset) that have been especially crafted to support a specific use case (or related use cases).  The assets may represent different versions of the product or customized versions of the same data for different purposed, or supporting different non-functional requirements.
+
+The Collection Manager OMVS supports:
+
+* The creation and maintenance of the properties associated with a collection.  New collections can be created using another collection as a template.
+* The management of the members of a collection.
+* The attachment of a collection as a resource of an entity such as a project, community or user's profile.
+* The ability to mark a collection as a template and search for the template collections in the open metadata ecosystem.
+* The ability to search collections, with or without particular classifications and properties and navigate through a collection's membership.
+
+
+
+
+
+---8<-- "snippets/abbr.md"
+
+
+
+
+
+

site/docs/services/omvs/index.md

@@ -9,7 +9,11 @@ The view services are as follows:
 
 | OMVS                                                                  | Summary                                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 |-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [My Profile](/services/omvs/my-profile/overview)                      | **Locate, retrieve and update information relating to the calling user's profile.**                           | The My Profile OMVS is for user interfaces supporting a personalized experience.  A registered user is able to maintain information about themselves and their network as well as set up and use personalized collections of metadata elements.                                                                                                                                                                                                                                                                               |
+| [My Profile](/services/omvs/my-profile/overview)                      | **Locate, retrieve and update information relating to the calling user's profile.**                           | The My Profile OMVS is for user interfaces supporting a personalized experience.  A registered user is able to maintain information about themselves, their roles and their network.                                                                                                                                                                                                                                                                                                                                          |
+| [Collection Manager](/services/omvs/collection-manager/overview)      | **Locate, retrieve and update collections and their membership.**                                             | The Collection Manager OMVS is for user interfaces supporting the ability to search for and navigate through hierarchies of collections.  A registered user is able to maintain the contents of collections and attach specific collections to their profile, project or community.                                                                                                                                                                                                                                           |
+| [Notification Manager](/services/omvs/notification-manager/overview)  | **Locate, retrieve and update the types of user notifications that should be produced.**                      | The Notification Manager OMVS is for user interfaces supporting personalized notifications to specific users.  A registered user is able to define which types of notification should be produced and who they should be delivered to.                                                                                                                                                                                                                                                                                        |
+| [Notification Inbox](/services/omvs/notification-inbox/overview)      | **Locate, retrieve and process the notifications for the calling user.**                                      | The Notification Inbox OMVS is for user interfaces supporting personalized notifications to the calling user.  A registered user is able to view their notifications, update their status and delete them.                                                                                                                                                                                                                                                                                                                    |
+| [Project Manager](/services/omvs/project-manager/overview)            | **Locate, retrieve and update information relating to projects.**                                             | The Project Manager OMVS is for user interfaces supporting projects, either for a group of people or personalized sandboxes for individuals.  A registered user is able to maintain information about a project and link it with other projects, users and resources.                                                                                                                                                                                                                                                         |
 | [Glossary Author](/services/omvs/glossary-author/overview)            | **Develop new glossary terms and categories.**                                                                | The Glossary Author OMVS is for user interfaces supporting the creating and editing of glossary content, such as glossary terms and categories.  The changes made are immediately visible to all users.                                                                                                                                                                                                                                                                                                                       |
 | [Glossary Browser](/services/omvs/glossary-browser/overview)          | **Search and view the contents of specific glossaries and their links to governance definitions and assets.** | The Glossary Browser OMVS is for user interfaces that wish to provide search facilities within a single glossary (or glossaries) along with the ability to browse the structure of the glossary and view an element within a glossary along with connected governance classifications, governance definitions, user feedback and attached assets.                                                                                                                                                                             |
 | [Glossary Workflow](/services/omvs/glossary-workflow/overview)        | **Develop new glossary terms and categories in a controlled workflow process.**                               | The Glossary Workflow OMVS is for user interfaces supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process.  This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved.                                                                                                                                                                                       |

site/docs/services/omvs/notification-inbox/overview.md

@@ -0,0 +1,34 @@
+---
+hide:
+- toc
+---
+
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+--8<-- "snippets/content-status/in-development.md"
+
+# Notification Inbox OMVS
+
+The Notification Inbox Open Metadata View Services (OMVS) is a REST API designed to back user interfaces (UIs) that support notification for a specific user.
+
+The notifications are defined and managed by the [Stewardship Action OMAS](/services/omas/stewardship-action/overview).
+
+The Notification Inbox OMVS calls the Stewardship Action OMAS to retrieve the list of user notifications for the calling user.  
+
+Each user notification has a status, summary description and a link to one or more elements that the notification refers to.  For example, a notification may indicate that:
+
+* New data is available for a digital product that the user is watching.
+* A new To Do for the user has been created.
+* An asynchronous process initiated by the user has finished.
+
+The user can view the details of the notification, change the status of the notification, or delete it.
+
+
+---8<-- "snippets/abbr.md"
+
+
+
+
+
+

site/docs/services/omvs/notification-manager/overview.md

@@ -0,0 +1,47 @@
+---
+hide:
+- toc
+---
+
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+--8<-- "snippets/content-status/in-development.md"
+
+# Notification Manager OMVS
+
+The Notification Manager Open Metadata View Services (OMVS) is a REST API designed to back user interfaces (UIs) that support the control of notifications.  These notifications define a specific trigger and the action to take.
+
+Examples of triggers include:
+
+* The creation, update or delete of specific metadata elements.
+* The creation, update or delete of specific types of metadata elements.
+* The detection of an unauthorized user action.
+* The completion of a process.
+* The production of a particular type of audit log record.
+
+When the specific trigger occurs, the resulting action could be:
+
+* To create a user notification
+* To create a ToDo for a user
+* To initiate a governance action process 
+* To create an incident report
+* To create an event on a specific topic
+* To call a remote API
+
+The notification definitions are defined and managed by the [Stewardship Action OMAS](/services/omas/stewardship-action/overview).
+
+The Notification Manager OMVS calls the Stewardship Action OMAS to search for, create, update, and delete notification definitions.  Once these definitions are in place, the Stewardship Action OMAS begins monitoring for the requested events, and when they occur, it takes the appropriate actions.
+
+
+
+
+
+
+---8<-- "snippets/abbr.md"
+
+
+
+
+
+

site/docs/services/omvs/project-manager/overview.md

@@ -0,0 +1,36 @@
+---
+hide:
+- toc
+---
+
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+--8<-- "snippets/content-status/in-development.md"
+
+# Project Manager OMVS
+
+The Project Manager Open Metadata View Services (OMVS) is a REST API designed to back user interfaces (UIs) that support projects.
+
+Projects can be organized into a hierarchy and involve many people, or they can be informal, personal projects used by an individual to organize an aspect of their work.  In either case, the people and resources necessary to complete the project can be identified.  The project's definition includes the expected timeline and objective.
+
+The Project Manager OMVS supports:
+
+* The definition of new projects, identifying their scope and timeline.  New projects can be created using a project templates.  The project templates can be created and maintained through the Project Manager OMVS.
+* The linking of related project together.
+* The classification of projects that are either a campaign, task or a personal project.
+* The appointment of a project team and project manager to the project (if applicable).
+* The identification of resources such as digital products and assets that are needed to complete the project.
+* The maintenance of project status, actions and meeting notes.
+
+
+
+
+
+---8<-- "snippets/abbr.md"
+
+
+
+
+
+