diff --git a/site/docs/release-notes/4-3.md b/site/docs/release-notes/4-3.md index e6466f071d..dc6df5147c 100644 --- a/site/docs/release-notes/4-3.md +++ b/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: diff --git a/site/docs/release-notes/4-4.md b/site/docs/release-notes/4-4.md index 8d497e4551..a6a9386f7a 100644 --- a/site/docs/release-notes/4-4.md +++ b/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" diff --git a/site/docs/services/omvs/collection-manager/overview.md b/site/docs/services/omvs/collection-manager/overview.md new file mode 100644 index 0000000000..0ce8f9f0bb --- /dev/null +++ b/site/docs/services/omvs/collection-manager/overview.md @@ -0,0 +1,41 @@ +--- +hide: +- toc +--- + + + + +--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" + + + + + + diff --git a/site/docs/services/omvs/index.md b/site/docs/services/omvs/index.md index d402023506..e1785d52ea 100644 --- a/site/docs/services/omvs/index.md +++ b/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. | diff --git a/site/docs/services/omvs/notification-inbox/overview.md b/site/docs/services/omvs/notification-inbox/overview.md new file mode 100644 index 0000000000..e07579b287 --- /dev/null +++ b/site/docs/services/omvs/notification-inbox/overview.md @@ -0,0 +1,34 @@ +--- +hide: +- toc +--- + + + + +--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" + + + + + + diff --git a/site/docs/services/omvs/notification-manager/overview.md b/site/docs/services/omvs/notification-manager/overview.md new file mode 100644 index 0000000000..1e045a1122 --- /dev/null +++ b/site/docs/services/omvs/notification-manager/overview.md @@ -0,0 +1,47 @@ +--- +hide: +- toc +--- + + + + +--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" + + + + + + diff --git a/site/docs/services/omvs/project-manager/overview.md b/site/docs/services/omvs/project-manager/overview.md new file mode 100644 index 0000000000..b27b7c29fd --- /dev/null +++ b/site/docs/services/omvs/project-manager/overview.md @@ -0,0 +1,36 @@ +--- +hide: +- toc +--- + + + + +--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" + + + + + + diff --git a/site/docs/types/0/0021-Collections.md b/site/docs/types/0/0021-Collections.md index cd469c9fa6..9acc96baf4 100644 --- a/site/docs/types/0/0021-Collections.md +++ b/site/docs/types/0/0021-Collections.md @@ -3,25 +3,45 @@ # 0021 Collections -*Collection*s provide a general mechanism for grouping entities together. A collection may be maintained manually, or via an automated process (ie a "smart collection"). The membership of a collection is established via a *CollectionMembership* relationship, which has attributes that allow the rationale and the confidence of the membership to be established. +*Collection*s provide a general mechanism for grouping entities together. A collection may be maintained manually, or via an automated process (ie a "smart collection"). The membership of a collection is established via a [*CollectionMembership* relationship](#collectionmembership-relationship), which has attributes that allow the rationale and the confidence of the membership to be established. A [*Referenceable*](/types/0/0010-Base-Model) entity can be a member of none, one or many collections. + +Since a collection is a *Referenceable* entity, collections can be organized into hierarchies - like a directory structure on the filesystem. ![UML](0021-Collections.svg) ## Collection -The *Collection* entity is provides the node that represents the collection as a whole. The members of the collection are linked to it using the *CollectionMembership* relationship. +The *Collection* entity provides the node that represents the collection as a whole. It inherits from [*Referenceable*](/types/0/0010-Base-Model). + +The attributes for a collection, beyond the standard attributes for *Referenceable* include: + +* *name* - this is the display name for the collection +* *description* - this is the text that describes the characteristics of the members that are to be found in the collection. +* *collectionType* - describes the type of collection that is used to select its icon or display layout. For example, it may be a "theme", or "domain", or something else. ## Collection classifications -The classifications associated with *Collection* allow it to be specialized for particular uses. +The classifications associated with *Collection* allow it to be specialized for particular uses. They help when searching for collections for specific uses. -* [*Folder*](#folder-classification) means the collection can be treated as if it where a folder of metadata elements. -* [*Set*](#set-classification) means the collection is a set of related items. +* [*RootCollection*](#root-collection-classification) means the collection is the top-level node in a collection hierarchy. The members of this collection are typically all collections. +* [*Folder*](#folder-classification) means the collection can be treated as if it where a folder of metadata elements. This classification includes properties to control how the members are displayed. +* [*Set*](#set-classification) means the collection is a set of related entities and no entity is a member more than once. +* [*DigitalProduct*](/types/7/0710-Digital-Service) describes a collection of [assets](/concepts/asset) that represent a digital product. * [*GovernanceStatusSet*](/types/4/0421-Governance-Classification-Levels) for a collection of governance statuses. * [*GovernanceClassificationSet*](/types/4/0421-Governance-Classification-Levels) for a collection of governance classification for a particular governance classification. * [*EventSet*](/types/5/0421-Governance-Classification-Levels) for a collection of related event schemas. +The example below shows part of a collection hierarchy representing a digital product catalog. The collections are shown in green and the assets that provide the content for the digital product are shown in yellow. + +The collection at the root of the collection hierarchy is called "Product Catalog Collection" and has the *RootCollection* classification attached. Its membership consists of collections with the *Folder* classification. The leaf node collections have the *DigitalProduct* classification attach and have the data assets as their members. + +![Collection Hierarchy](collection-hierarchy-example.svg) + +### RootCollection classification + +The *RootCollection* classification indicates that the collection is used to provide the starting node for a hierarchy of collections. + ### Folder classification The *Folder* classification indicates that the collection is used to organize metadata elements. The attributes are used to indicate to the caller how they should be displayed. @@ -40,7 +60,7 @@ The *Folder* classification indicates that the collection is used to organize me ### Set classification -The *Set* classification indicates that the collection is a set of related items. +The *Set* classification indicates that the collection is a set of elements where each element is only included in the collection once. ## CollectionMembership relationship diff --git a/site/docs/types/0/0021-Collections.svg b/site/docs/types/0/0021-Collections.svg index f96e34f333..f167f90812 100644 --- a/site/docs/types/0/0021-Collections.svg +++ b/site/docs/types/0/0021-Collections.svg @@ -1,4 +1,4 @@ - + -
0021 - Collections
0021 - Collections
«entity»
Collection
«entity»...
name : string
description : string
name : string...
«classification»
Set
«classification»...
«relationship»
CollectionMembership
«relationship»...
*
*
*
*
«entity»
Referenceable
«entity»...
membershipRationale : string
expression : string
status: MembershipStatus
userDefinedStatus : string
confidence : int
createdBy : string
steward : string
stewardTypeName : string
stewardPropertyName : string
source : string
notes : string
membershipRationale : string...
collectionMembers
collectionMembers
foundInCollections
foundInCollections
«enumeration»
OrderBy
«enumeration»...
NAME = 0
OWNER = 1
DATE_ADDED = 2
DATE_UPDATED = 3
DATE_CREATED = 4
OTHER = 99
NAME = 0...
«classification»
Folder
«classification»...
orderBy : OrderBy
orderPropertyName : string
orderBy : OrderBy...
UNKNOWN=0
DISCOVERED = 1
PROPOSED = 2
IMPORTED = 3
VALIDATED = 4
DEPRECATED = 5
OBSOLETE = 6
OTHER = 99
UNKNOWN=0...
<<enumeration>>
MembershipStatus
<<enumeration>>...Text is not SVG - cannot display \ No newline at end of file +
0021 - Collections
0021 - Collections
«entity»
Collection
«entity»...
name : string
description : string
collectionType : string
name : string...
«classification»
RootCollection
«classification»...
«relationship»
CollectionMembership
«relationship»...
*
*
*
*
«entity»
Referenceable
«entity»...
membershipRationale : string
expression : string
status: MembershipStatus
userDefinedStatus : string
confidence : int
createdBy : string
steward : string
stewardTypeName : string
stewardPropertyName : string
source : string
notes : string
membershipRationale : string...
collectionMembers
collectionMembers
foundInCollections
foundInCollections
«enumeration»
OrderBy
«enumeration»...
NAME = 0
OWNER = 1
DATE_ADDED = 2
DATE_UPDATED = 3
DATE_CREATED = 4
OTHER = 99
NAME = 0...
«classification»
Folder
«classification»...
orderBy : OrderBy
orderPropertyName : string
orderBy : OrderBy...
UNKNOWN=0
DISCOVERED = 1
PROPOSED = 2
IMPORTED = 3
VALIDATED = 4
DEPRECATED = 5
OBSOLETE = 6
OTHER = 99
UNKNOWN=0...
<<enumeration>>
MembershipStatus
<<enumeration>>...
«classification»
Set
«classification»...Text is not SVG - cannot display \ 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 c05df6a732..167eb00cfb 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 @@ - + - + @@ -1353,13 +1353,16 @@ - + + + + @@ -1376,16 +1379,10 @@ - - - - - - - - + + - + @@ -1440,6 +1437,18 @@ + + + + + + + + + + + + @@ -1451,132 +1460,311 @@ - + - - + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - + - - - diff --git a/site/docs/types/0/automated-collection.svg b/site/docs/types/0/automated-collection.svg new file mode 100644 index 0000000000..505440bda3 --- /dev/null +++ b/site/docs/types/0/automated-collection.svg @@ -0,0 +1,4 @@ + + + +
Archive Candidate
Collection
Archive Candidate...
Asset
Asset
Asset
Asset
Asset
Asset
CollectionMembership
CollectionMembershipText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/0/collection-hierarchy-example.svg b/site/docs/types/0/collection-hierarchy-example.svg new file mode 100644 index 0000000000..0cbff6ee56 --- /dev/null +++ b/site/docs/types/0/collection-hierarchy-example.svg @@ -0,0 +1,4 @@ + + + +
Folder
Folder
Agriculture Insights
Collection
Agriculture Insights...
Folder
Folder
Earth Observation
Satellite Feeds
Earth Observation...
DigitalProduct
DigitalProduct
Landstat 8
Landstat 8
Band 1 
Data Folder
Band 1...
Tiles
Data Folder
Tiles...
RootCollection
RootCollection
Product Catalog
Collection
Product Catalog...
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
DigitalProduct
DigitalProduct
Land Use Classification
Land Use Classificat...
CollectionMembership
CollectionMembership
Band 2 
Data Folder
Band 2...
Band 11
Data Folder
Band 11...
DigitalProduct
DigitalProduct
Level-1B
Level-1B
DigitalProduct
DigitalProduct
Level-2A
Level-2A
DigitalProduct
DigitalProduct
Level-1C
Level-1C
Folder
Folder
Sentinel 2
Sentinel 2Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/1/0130-Projects.md b/site/docs/types/1/0130-Projects.md index d2811038c4..9d6d8cade2 100644 --- a/site/docs/types/1/0130-Projects.md +++ b/site/docs/types/1/0130-Projects.md @@ -3,22 +3,58 @@ # 0130 Projects -Projects are used to organize a specific activity. They control the use of resources and associated costs, so they are used appropriately in order to successfully achieve the project's goals. +Projects are used to organize a specific activity. They can control the use of resources and associated costs, so they are used appropriately in order to successfully achieve the project's goals. +Related projects can be organized into campaigns. Small items of work, typically performed by a single person, can be defined as tasks for a project. + +Notice that the project acts as an anchor for collections of resources that the project is using. Since it is a Referenceable, it can have links to external URLs, such as the project home page, project plan or APIs as well as images (see [0015 Linked Media Types](/types/0/0015-Linked-Media-Types) in Area 0). ![UML](0130-Projects.svg) -## Projects +## Project entity +The project entity represents a single project. It inherits from [*Referenceable*](/types/0/0010-Base-Model) and includes attributes for defining the timeframe for the project and its status. +## Campaign classification -Projects organize resources to build new capability or improve existing capability. Related projects can be organized into campaigns. Small items of work, typically performed by a single person, can be defined as tasks for a project. +The *Campaign* classification describes a collection of related projects that are working towards a common goal. Often this goal is a complex transformation that needs actions from independent teams. The definition of the campaign helps to identify the role of the different projects in achieving the common goal, and providing the umbrella for coordinating specific activities as needed. -Notice that the project acts as an anchor for collections of resources that the project is using. Since it is a Referenceable, it can have links to external URLs, such as the project home page, project plan or APIs as well as images (see [0015 Linked Media Types](/types/0/0015-Linked-Media-Types) in Area 0). +A campaign classification is typically attached to either: + +* a [*Collection*](/types/0/0021-Collections) entity whose members are the related projects. +* a [*Project*](#project-entity) entity where the related projects are linked by the [*ProjectHierarchy*](#projecthierarchy-relationship) relationship. + +## Task classification + +The *Task* classification is attached to a *Project* entity to indicate that this entity represents a small piece of work that is typically assigned to a single person (identified via the [*ProjectTeam*](#projectteam-relationship) relationship). Such a task is linked to a parent project via the [*ProjectHierarchy*](#projecthierarchy-relationship) relationship. + +## PersonalProject classification + +The *PersonalProject* classification is attached to a *Project* entity to indicate that this entity represents an informal project that has been created by single person (identified via the [*ProjectTeam*](#projectteam-relationship) relationship) to help organize a part of their work. These projects are typically not linked to into a project hierarchy. They may be linked to other project entities via the [*ProjectDependency*](#projectdependency-relationship) relationship. + +Personal projects do not typically have a [Project Manager](#projectmanagement-relationship) assigned. + +## ProjectHierarchy relationship + +Projects can be broken down into smaller projects that can be executed by different teams on different timelines with different project manager(s) and a specific slice of the budget. The projects that are broken down in this way are linked together using the *ProjectHierarchy* relationship. + +## ProjectDependency relationship + +A project that needs the results of another project to complete its work can be linked to that project via the *ProjectDependency* relationship. + +## ProjectTeam relationship + +The *ProjectTeam* relationship links a project to the [*Actors*](/types/1/0110-Actor) that will perform the work defined by the project. + +## ProjectManagement relationship + +The *ProjectManagement* relationship links a project to the [PersonRole](/types/1/0112-People) entity that will coordinate and track the efforts of the project team. The role in turn links to the individual(s) appointed to perform the role. + +## ProjectManager entity -The description attribute should be used instead of the scopeDescription in ProjectScope; the scopeDescription attribute has been deprecated. +The *ProjectManager* is a specialized [*PersonRole*](/types/1/0112-People) to represent project management responsibilities. It is linked to the project to be managed via the [*ProjectManagement*](#projectmanagement-relationship) relationship. ??? deprecated "Deprecated types" - - *ProjectScope* relationship is deprecated in favour of the more generic [*AssignmentScope*](/types/1/0120-Assignment-Scopes). + - *ProjectScope* relationship is deprecated in favour of the more generic [*AssignmentScope*](/types/1/0120-Assignment-Scopes). The *description* attribute of the *AssignmentScope* relationship should be used instead of the *scopeDescription* in the ProjectScope relationship; the scopeDescription attribute has been deprecated. - *status* attribute on *Project* is deprecated in favour of the more specific *projectStatus* attribute, which makes it easier to align with an appropriate valid value set. --8<-- "snippets/abbr.md" diff --git a/site/docs/types/1/0130-Projects.svg b/site/docs/types/1/0130-Projects.svg index 5f271f3b0e..af1a6a026e 100644 --- a/site/docs/types/1/0130-Projects.svg +++ b/site/docs/types/1/0130-Projects.svg @@ -1,4 +1,4 @@ - + -
0130 - Projects
0130 - Projects
«entity»
Project
«entity»...
identifier : string
name : string
description : string
startDate : date
plannedEndDate : date
projectStatus : string
identifier : string...
«classification»
Task
«classification»...
«entity»
Referenceable
«entity»...
managedProjects
managedProjects
*
*
managingProject
managingProject
0..1
0..1
«relationship»
ProjectHierarchy
«relationship»...
«classification»
Campaign
«classification»...
dependentProjects
dependentProjects
*
*
dependsOnProjects
dependsOnProjects
*
*
«relationship»
ProjectDependency
«relationship»...
dependencySummary : string
dependencySummary : string
«entity»
Actor
«entity»...
«relationship»
ProjectTeam
«relationship»...
teamRole : string
teamRole : string
*
*
*
*
projectFocus
projectFocus
supportingActors
supportingActors
projectsManaged
projectsManaged
*
*
projectManagers
projectManagers
*
*
«relationship»
ProjectManagement
«relationship»...
«entity»
ProjectManager
«entity»...
«entity»
PersonRole
«entity»...Text is not SVG - cannot display \ No newline at end of file +
0130 - Projects
0130 - Projects
«entity»
Project
«entity»...
identifier : string
name : string
description : string
startDate : date
plannedEndDate : date
projectStatus : string
identifier : string...
«classification»
Task
«classification»...
«entity»
Referenceable
«entity»...
managedProjects
managedProjects
*
*
managingProject
managingProject
0..1
0..1
«relationship»
ProjectHierarchy
«relationship»...
«classification»
Campaign
«classification»...
dependentProjects
dependentProjects
*
*
dependsOnProjects
dependsOnProjects
*
*
«relationship»
ProjectDependency
«relationship»...
dependencySummary : string
dependencySummary : string
«entity»
Actor
«entity»...
«relationship»
ProjectTeam
«relationship»...
teamRole : string
teamRole : string
*
*
*
*
projectFocus
projectFocus
supportingActors
supportingActors
projectsManaged
projectsManaged
*
*
projectManagers
projectManagers
*
*
«relationship»
ProjectManagement
«relationship»...
«entity»
ProjectManager
«entity»...
«entity»
PersonRole
«entity»...
«classification»
PersonalProject
«classification»...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/1/area-1-collaboration.drawio b/site/docs/types/1/area-1-collaboration.drawio index 30ff4c3de5..40a5a4b206 100644 --- a/site/docs/types/1/area-1-collaboration.drawio +++ b/site/docs/types/1/area-1-collaboration.drawio @@ -1,6 +1,6 @@ - + - + @@ -633,7 +633,7 @@ - + @@ -819,6 +819,18 @@ + + + + + + + + + + + + diff --git a/site/docs/types/2/0210-Data-Stores.md b/site/docs/types/2/0210-Data-Stores.md index d3dd511891..57076e7b84 100644 --- a/site/docs/types/2/0210-Data-Stores.md +++ b/site/docs/types/2/0210-Data-Stores.md @@ -19,5 +19,17 @@ The *DataContentForDataSet* relationship defines how data is supplied to a [Data The *DataStoreEncoding* classification provides the ability to store details of the data stores physical characteristics. +## DataScope classification + +The *DataScope* classification identifies the scope of the data stored in the [resource(s)](/concepts/resource) represented by the entity it is attached to. This classification can be attached to any [*Referenceable*](/types/0/0010-Base-Model), but it is typically associated with assets such as *DataStores* and *DataSets*. The attributes of this classification identify the scope of the data in space and time. + +* *minLongitude* - if the data is bound by an area, this is the longitude for bottom-left corner of the bounding box (BBOX) for the area covered by the data. +* *minLatitude* - if the data is bound by an area, this is the latitude for the bottom-left corner of the bounding box (BBOX) for the area covered by the data. +* *maxLongitude* - if the data is bound by an area, this is the longitude for top-right corner of the bounding box (BBOX) for the area covered by the data. +* *maxLatitude* - if the data is bound by an area, this is the latitude for top-right corner of the bounding box (BBOX) for the area covered by the data. +* *minHeight* - if the height above ground is relevant, this is the lowest height that the data covers. +* *maxHeight* - if the height above ground is relevant, this is the highest height that the data covers. +* *startTime* - if the data is bound by time, this is the start time. +* *endTime* - if the data is bound by time, this is the end time. --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/types/2/0210-Data-Stores.svg b/site/docs/types/2/0210-Data-Stores.svg index a4d1ebd95e..3610b77c75 100644 --- a/site/docs/types/2/0210-Data-Stores.svg +++ b/site/docs/types/2/0210-Data-Stores.svg @@ -1,4 +1,4 @@ -
0210 - Data Stores
0210 - Data Stores
«entity»
DataStore
«entity»...
«entity»
Asset
«entity»...
«entity»
DataSet
«entity»...
*
*
dataContent
dataContent
supportedDataSets
supportedDataSets
*
*
queryId : string
query : string
queryId : string...
«relationship»
DataContentForDataSet
«relationship»...
encoding : string
language : string
description : string
properties : map<string, string>
encoding : string...
«classification»
DataStoreEncoding
«classification»...
storeCreateTime : date
storeUpdateTime : date
pathName : string
deployedImplementationType : string
storeCreateTime : date...Text is not SVG - cannot display \ No newline at end of file +
0210 - Data Stores
0210 - Data Stores
«entity»
DataStore
«entity»...
«entity»
Asset
«entity»...
«entity»
DataSet
«entity»...
*
*
dataContent
dataContent
supportedDataSets
supportedDataSets
*
*
queryId : string
query : string
queryId : string...
«relationship»
DataContentForDataSet
«relationship»...
encoding : string
language : string
description : string
properties : map<string, string>
encoding : string...
«classification»
DataStoreEncoding
«classification»...
storeCreateTime : date
storeUpdateTime : date
pathName : string
deployedImplementationType : string
storeCreateTime : date...
«entity»
Referenceable
«entity»...
minLongitude : float
minLatitude : float
maxLongitude : float
maxLatitude : float
minHeight : float
maxHeight : float
startTime : date
endTime : date
minLongitude : float...
«classification»
DataScope
«classification»...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/types/2/area-2-assets.drawio b/site/docs/types/2/area-2-assets.drawio index 300b1dfcc9..096f16e7d3 100644 --- a/site/docs/types/2/area-2-assets.drawio +++ b/site/docs/types/2/area-2-assets.drawio @@ -1,6 +1,6 @@ - + - + @@ -152,7 +152,7 @@ - + @@ -440,7 +440,7 @@ - + @@ -538,7 +538,7 @@ - + @@ -602,6 +602,27 @@ + + + + + + + + + + + + + + + + + + + + +