diff --git a/site/docs/concepts/collection.md b/site/docs/concepts/collection.md index 70206f1046..73d56b6552 100644 --- a/site/docs/concepts/collection.md +++ b/site/docs/concepts/collection.md @@ -1,15 +1,59 @@ ---- -hide: -- toc ---- - # Collections -A collection is a reusable list of metadata elements. [Assets](/concepts/asset) and other resources can be linked to a collection. The collection itself can then be added to a another collection, say for a [community](/concepts/community) or a [personal profile](/concepts/personal-profile). +A collection is a reusable list of metadata elements. [Assets](/concepts/asset) and other [referenceable](/concepts/referenceable) metadata elements can be linked to a collection. The collection itself can then be added to another collection, or linked to, say a [community](/concepts/community) or a [personal profile](/concepts/personal-profile). + +Collections have classifications to indicate how they are being used. Below are some examples of collections deployed in different scenarios. The type definitions for collections are found in [model 0021](/types/0/0021-Collections). + +## Asset catalog hierarchy + +Some asset catalogs organize their catalogued resources in a hierarchical folder structure, where each folder represents a particular theme. This allows people to browse the entries in a systematic way. Since the folder structure organizes similar assets together, it is easier to compare entries and pick the best one for the use case. + +Collections can be used to provide the folder structure. The top of the hierarchy is typically classified with the *RootCollection* classification. The nested collections linked underneath it are classified with the *Folder* classification. The relationships linking the hierarchy and the assets together are of type *CollectionMembership*. + +![Asset Folder Structure](collections-asset-catalog.svg) + +## Product catalog organization + +[Digital products](/concepts/digital-product) offer data sets and services that have been developed for a particular purpose. They are typically versioned and may offer the data/function in multiple formats. + +Collections are used in two ways around digital products. Each digital product is represented using a collection with the [*DigitalProduct*](/types/7/0710-Digital-Service) classification attached. The digital products are often organized in a folder hierarchy, like the asset catalog. + +![Product catalog](collections-product-catalog.svg) + +## Home collections + +Home collections are used to organize elements for a particular person, team, project or community. They are linked to the element representing the people they are supporting using the [ResourceList](/types/0/0019-More-Information) relationship. An example of a home collection could be a favourites list. + +![Home collections](collections-home-collections.svg) + +## Work Item List + +[ToDos](/concepts/to-do) describe actions for people to perform. They are attached to one or more chosen [*actors*](/types/1/0110-Actors). Collections with the *WorkItemList* can be used to organize these *ToDos* to help prioritize the work. + +![Work Item List](collections-work-item-list.svg) + +## Results Sets + +Collections can be used by automated services, typically [governance services](/concepts/governance-service), to gather the results of their processing together. Such a collection would have the *ResultsSet* classification attached to it. + +For example, the results set collection shown below is from a governance service that is identifying assets that should be archived (for example, by reviewing their [Retention](/types/4/0422-Governance-Action-Classifications) classification). + +![Service Results Sets](collections-results-set-1.svg) + +This next example is from a governance service that is periodically processing a saved query, building up the results set over time as new metadata is created. + +![Search Results Sets](collections-results-set-2.svg) + +## Recent Access + +User interfaces can keep track of the metadata elements that a particular user is working with so they can quickly access them. Such a collection would be chained off of the individual's *Person* element using the *ResourceList* relationship. The collection would have the *RecentAccess* classification attached. +![Recent Access](collections-recent-access.svg) +???+ education "Further Information on Collections" + The [Collection Manager OMVS](/services/omvs/collection-manager/overview) provides a specialist API for managing collections. --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/concepts/collections-asset-catalog.svg b/site/docs/concepts/collections-asset-catalog.svg new file mode 100644 index 0000000000..11fff83785 --- /dev/null +++ b/site/docs/concepts/collections-asset-catalog.svg @@ -0,0 +1,4 @@ + + + +
Folder
Collection
Folder
Collection
Folder
Collection
Folder
Collection
Asset
Asset
Asset
Asset
Asset
RootCollection
Asset Hierarchy
Collection
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
 \ No newline at end of file diff --git a/site/docs/concepts/collections-home-collections.svg b/site/docs/concepts/collections-home-collections.svg new file mode 100644 index 0000000000..977d9c0d4d --- /dev/null +++ b/site/docs/concepts/collections-home-collections.svg @@ -0,0 +1,4 @@ + + + +
ResourceList
ResourceList
Callie Quartile
Person
Callie Quartile
Callie Quartile
Project
Patient
Onborading
Callie's Favourite Assets
HomeCollection
Patient Onboarding
Project Resources
HomeCollection
 \ No newline at end of file diff --git a/site/docs/concepts/collections-product-catalog.svg b/site/docs/concepts/collections-product-catalog.svg new file mode 100644 index 0000000000..927fc3abd5 --- /dev/null +++ b/site/docs/concepts/collections-product-catalog.svg @@ -0,0 +1,4 @@ + + + +
Folder
Agriculture Insights
Collection
Folder
Earth Observation
Satellite Feeds
DigitalProduct
Landstat 8
Band 1 
Data Folder
Tiles
Data Folder
RootCollection
Product Catalog
Collection
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
CollectionMembership
DigitalProduct
Land Use Classification
CollectionMembership
Band 2 
Data Folder
Band 11
Data Folder
DigitalProduct
Level-1B
DigitalProduct
Level-2A
DigitalProduct
Level-1C
Folder
Sentinel 2
 \ No newline at end of file diff --git a/site/docs/concepts/collections-recent-access.svg b/site/docs/concepts/collections-recent-access.svg new file mode 100644 index 0000000000..ae3d043117 --- /dev/null +++ b/site/docs/concepts/collections-recent-access.svg @@ -0,0 +1,4 @@ + + + +
Callie Quartile
Person
Callie Quartile
Callie's Recent
Accesses
RecentAccess
ResourceList
 \ No newline at end of file diff --git a/site/docs/concepts/collections-results-set-1.svg b/site/docs/concepts/collections-results-set-1.svg new file mode 100644 index 0000000000..74fad29dde --- /dev/null +++ b/site/docs/concepts/collections-results-set-1.svg @@ -0,0 +1,4 @@ + + + +
Archive Candidate
Collection
Asset
Asset
Asset
CollectionMembership
ResultsSet
 \ No newline at end of file diff --git a/site/docs/concepts/collections-results-set-2.svg b/site/docs/concepts/collections-results-set-2.svg new file mode 100644 index 0000000000..428d461f85 --- /dev/null +++ b/site/docs/concepts/collections-results-set-2.svg @@ -0,0 +1,4 @@ + + + +
Search Results
Collection
CSV Asset
CSV Asset
CSV Asset
CollectionMembership
ResultsSet
Find All
CSV Files
SavedSearch
SavedResults
 \ No newline at end of file diff --git a/site/docs/concepts/collections-work-item-list.svg b/site/docs/concepts/collections-work-item-list.svg new file mode 100644 index 0000000000..71647534b2 --- /dev/null +++ b/site/docs/concepts/collections-work-item-list.svg @@ -0,0 +1,4 @@ + + + +
Callie Quartile
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
ToDo
Person
Callie Quartile
Callie's Daily
Tasks
WorkItemList
ActionAssignment
ResourceList
 \ No newline at end of file diff --git a/site/docs/concepts/collections.drawio b/site/docs/concepts/collections.drawio new file mode 100644 index 0000000000..3b48aff261 --- /dev/null +++ b/site/docs/concepts/collections.drawio @@ -0,0 +1,678 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/concepts/governance-action-processes.drawio b/site/docs/concepts/governance-action-processes.drawio index e557e204d9..44a06ff98c 100644 --- a/site/docs/concepts/governance-action-processes.drawio +++ b/site/docs/concepts/governance-action-processes.drawio @@ -1,703 +1,751 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -721,13 +769,13 @@ - + - + - + @@ -735,22 +783,22 @@ - + - + - + - + - + - + @@ -759,39 +807,39 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -799,10 +847,10 @@ - + - + @@ -811,15 +859,15 @@ - + - + - + @@ -828,120 +876,120 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -949,10 +997,10 @@ - + - + @@ -961,16 +1009,16 @@ - + - + - + - + @@ -979,122 +1027,122 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1102,51 +1150,51 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1156,77 +1204,77 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1473,173 +1521,173 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/site/docs/types/0/0021-Collections.md b/site/docs/types/0/0021-Collections.md index 7eafd7135c..4f2238064d 100644 --- a/site/docs/types/0/0021-Collections.md +++ b/site/docs/types/0/0021-Collections.md @@ -24,14 +24,16 @@ The attributes for a collection, beyond the standard attributes for *Referenceab The classifications associated with *Collection* allow it to be specialized for particular uses. They help when searching for collections for specific uses. -* [*RootCollection*](#root-collection-classification) means the collection is an independent, top-level node in a collection hierarchy. The members of this collection are typically all collections. -* [*HomeCollection*](#home-collection-classification) means the collection is the top-level node in a collection hierarchy anchored to a specific [Referenceable](/types/0/0010-Base-Model). The members of this collection may or may not be collections. +* [*RootCollection*](#rootcollection-classification) means the collection is an independent, top-level node in a collection hierarchy. The members of this collection are typically all collections. +* [*HomeCollection*](#homecollection-classification) means the collection is the top-level node in a collection hierarchy anchored to a specific [Referenceable](/types/0/0010-Base-Model). The members of this collection may or may not be 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. * [*ResultsSet*](#resultsset-classification) means the collection is a set of related results. -* [*DigitalProduct*](/types/7/0710-Digital-Service) describes a collection of [assets](/concepts/asset) that represent a digital product. +* [*RecentAccess*](#recentaccess-classification) means the collection is a set of elements that have been recently accesses by a user. +* [*WorkItemList*](#workitemlist-classification) means the collection is a set of elements that have been recently accesses by a user. +* [*DigitalProduct*](/types/7/0710-Digital-Service) describes a collection of [assets](/concepts/asset) that represent a [digital product](/concepts/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. +* [*EventSet*](/types/5/0535-Event-Schemas) 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. @@ -51,21 +53,21 @@ The *HomeCollection* classification indicates that the collection is used to pro 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. -* *orderBy* indicates the preferred ordering sequence +* *orderBy* indicates the preferred ordering sequence. It uses the [OrderBy](#orderby-enumeration) enumeration. * *orderPropertyName* indicates which property to use if the *orderBy* attribute is set to `OTHER`. -### OrderBy enumeration +### ResultsSet classification -* *Name* - Order by name property. -* *Owner* - Order by owner property. -* *DateAdded* - Order by date added to the metadata collection. -* *DateUpdated* - Order by date that the asset was updated. -* *DateCreated* - Order by date that the asset was created. -* *Other* - Order by another property. +The *ResultsSet* classification indicates that the collection is a set of elements that are the results from a specific request or query. -### ResultsSet classification +### RecentAccess classification + +The *RecentAccess* classification indicates that the collection is a set of elements that have been accessed recently. + +### WorkItemList classification + +The *WorkItemList* classification indicates that the collection is organizing a set of elements (typically [ToDos](/types/1/0137-Actions), or [Tasks](/types/1/0130-Projects)). -The *ResultsSet* classification indicates that the collection is a set of elements where each element is only included in the collection once. ## CollectionMembership relationship @@ -89,6 +91,15 @@ The attributes for the *CollectionMembership* relationship establish the level o * The *status* attribute indicates the status of the member in the collection. It is a [MembershipStatus](#membershipstatus-enumeration) value. * The *userDefinedStatus* provides a status value when *status=OTHER*. +## OrderBy enumeration + +* *Name* - Order by name property. +* *Owner* - Order by owner property. +* *DateAdded* - Order by date added to the metadata collection. +* *DateUpdated* - Order by date that the asset was updated. +* *DateCreated* - Order by date that the asset was created. +* *Other* - Order by another property. +* ## MembershipStatus enumeration The values for the *MembershipStatus* enumeration are: 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 16da3adfae..09f82c37fb 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 @@ - + - + @@ -1531,324 +1531,8 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +