Skip to content

Commit 0e110d3

Browse files
Merge pull request #1000 from mandy-chessell/oak2025
Change governance domain definitions to use valid values
2 parents 325c6bc + 49a241f commit 0e110d3

32 files changed

+176
-331
lines changed

site/docs/concepts/collection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Home collections are used to organize elements for a particular person, team, pr
3939

4040
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.
4141

42-
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).
42+
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-Governed-Data-Classifications) classification).
4343

4444
![Service Results Sets](collections-results-set-1.svg)
4545

site/docs/guides/planning/governance-program/governance-domain-definitions.svg

+2-2
Loading

site/docs/guides/planning/governance-program/governance-program-planning.drawio

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<mxfile host="Electron" modified="2023-11-17T13:22:37.333Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="gVbaf2clTMyOt-k-hYU1" version="21.6.8" type="device" pages="7">
1+
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/26.0.9 Chrome/128.0.6613.186 Electron/32.2.5 Safari/537.36" version="26.0.9" pages="7">
22
<diagram id="gaeeWlbyKK2-ta_VzILe" name="governance-domain">
3-
<mxGraphModel dx="1194" dy="775" 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">
3+
<mxGraphModel dx="1242" dy="831" 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">
44
<root>
55
<mxCell id="0" />
66
<mxCell id="1" parent="0" />
@@ -79,7 +79,7 @@
7979
<mxCell id="0RXOnSef8UXWCk25OGyF-1" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.25;exitY=1;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="0RXOnSef8UXWCk25OGyF-2" target="0RXOnSef8UXWCk25OGyF-3" edge="1">
8080
<mxGeometry relative="1" as="geometry" />
8181
</mxCell>
82-
<mxCell id="0RXOnSef8UXWCk25OGyF-2" value="Governance &lt;br&gt;Domain&lt;br&gt;Set" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
82+
<mxCell id="0RXOnSef8UXWCk25OGyF-2" value="domainIdentifier" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
8383
<mxGeometry x="255" y="585" width="120" height="60" as="geometry" />
8484
</mxCell>
8585
<mxCell id="0RXOnSef8UXWCk25OGyF-3" value="Governance&lt;br&gt;Domain&lt;br&gt;Definition" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
@@ -106,17 +106,14 @@
106106
<mxPoint x="315" y="675" as="sourcePoint" />
107107
</mxGeometry>
108108
</mxCell>
109-
<mxCell id="0RXOnSef8UXWCk25OGyF-9" value="Governance&lt;br&gt;Domain&lt;br&gt;Definition" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
109+
<mxCell id="0RXOnSef8UXWCk25OGyF-9" value="Governance&lt;br&gt;Domain&lt;br&gt;Description" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
110110
<mxGeometry x="385" y="705" width="120" height="60" as="geometry" />
111111
</mxCell>
112-
<mxCell id="DDb2UtIfti2ZPekRbWEM-1" value="CollectionMembership" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
113-
<mxGeometry x="215" y="735" width="140" height="30" as="geometry" />
114-
</mxCell>
115112
</root>
116113
</mxGraphModel>
117114
</diagram>
118115
<diagram id="mArv101Qo0KCMiXSAoCN" name="bridging-to-organization">
119-
<mxGraphModel dx="2848" dy="775" 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">
116+
<mxGraphModel dx="2896" dy="831" 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">
120117
<root>
121118
<mxCell id="S5lS58ZmbvXcH93iUld8-0" />
122119
<mxCell id="S5lS58ZmbvXcH93iUld8-1" parent="S5lS58ZmbvXcH93iUld8-0" />

site/docs/guides/planning/governance-program/overview.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ Each domain is typically the responsibility of a different executive in the orga
3939
![Governance Domain Examples](/guides/planning/governance-program/governance-domain-examples.svg)
4040
> Examples of different governance domains within an organization.
4141

42-
Governance domains are represented by [*Governance Domain Descriptions*](/types/4/0401-Governance-Definitions/#governancedomaindescription) entities in open metadata. They are organized into a *GovernanceDomainSet* collection.
42+
Governance domains are represented by [*Valid Value Definition*](/types/5/0545-Reference-data) entities in open metadata. They are organized into a *ValidValueSet* collection using the [Valid Metadata Values](/guides/planning/valid-values/overview) services.
4343

4444
![Governance Domain Descriptions](/guides/planning/governance-program/governance-domain-definitions.svg)
45-
> The governance domain descriptions organized in a governance domain set
45+
> The governance domain descriptions organized in a valid value set under the `domainIdentifier` attribute
4646
47-
The governance domain descriptions include the *domainIdentifier* property, a *displayName* and a *description*. The *domainIdentifier* property is an integer and by convention "0" means "applies to all domains". For example:
47+
The governance domain descriptions include the *preferredValue* for the *domainIdentifier* property, a *displayName* and a *description*. The *domainIdentifier* property is an integer and by convention "0" means "applies to all domains". For example:
4848

4949
| Domain Identifier | Display Name | Description |
5050
|:------------------|:-------------------------------|:----------------------------------------------------------------------------------------------------------|
@@ -59,9 +59,7 @@ The governance domain descriptions include the *domainIdentifier* property, a *d
5959

6060

6161
??? education "Defining governance domains"
62-
Governance domain descriptions can be defined in an [Open Metadata Archive](/concepts/open-metadata-archive) or through the [Governance Program OMAS](/services/omas/governance-program/overview).
63-
64-
The [egeria-samples.git repository](https://github.com/odpi/egeria-samples) includes a sample called [Sample metadata archives for Coco Pharmaceuticals](https://github.com/odpi/egeria-samples/tree/main/sample-metadata-archives/coco-metadata-archives) that creates open metadata archives with basic definitions for Coco Pharmaceuticals. This includes the definition of this organization's governance domains with their communities and governance officers.
62+
Governance domain descriptions can be defined in an [Open Metadata Archive](/concepts/open-metadata-archive) or through the [Valid Metadata OMVS](/services/omvs/valid-metadata/overview).
6563

6664
## Governance Leadership
6765

@@ -96,7 +94,7 @@ These different approaches allow you to have enough detail in your open metadata
9694

9795
![Governance Roles](/guides/planning/governance-program/governance-roles.svg)
9896

99-
The [Governance Program OMAS](/services/omas/governance-program/overview) supports the setting up of governance roles. The [Community Profile OMAS](/services/omas/community-profile/overview) supports the appointment of people to roles.
97+
The [Governance Officer OMVS](/services/omvs/governance-officer/overview) supports the setting up of governance roles. The [People Organizer OMVS](/services/omvs/people-organizer/overview) supports the appointment of people to roles.
10098

10199

102100
## Governance Leadership Communities
@@ -196,9 +194,10 @@ The organization of the subject areas is orthogonal to the governance domains. S
196194
* [Setting up the subject area definitions :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-resources/open-metadata-samples/access-services-samples/governance-program-client-samples/governance-subject-area-sample){ target=gh }
197195
* [Setting up glossary categories for each subject area :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-resources/open-metadata-samples/access-services-samples/subject-area-client-samples/subject-area-definition-sample){ target=gh } ready for subject area owners to start defining glossary terms associated with their subject area.
198196

199-
* The [Governance Program OMAS](/services/omas/governance-program/overview) supports the setting up of subject area definitions.
200-
* [Digital Architecture OMAS](/services/omas/digital-architecture/overview) supports the definition of reference data and quality rules for the subject area.
201-
* [Asset Manager OMAS](/services/omas/asset-manager/overview) supports the management of glossaries and the exchange of subject area information with other catalogs and quality tools.
197+
* [Governance Officer OMVS](/services/omvs/governance-officer/overview) supports the setting up of subject area definitions.
198+
* [Reference Data OMVS](/services/omvs/reference-data/overview) supports the definition of reference data for the subject area.
199+
* [Data Designer OMVS](/services/omvs/data-designer/overview) supports the definition of quality rules for the subject area.
200+
* [Asset Manager OMAS](/services/omvs/asset-manager/overview) supports the management of glossaries and the exchange of subject area information with other catalogs and quality tools.
202201

203202
## Governance classification, tagging and linking
204203

@@ -229,7 +228,7 @@ The labels may be assigned directly to the asset, or to elements, such as schema
229228

230229
## Setting up the levels for your governance classifications
231230

232-
The values used in governance classifications show the specific group that the classified asset belongs to. Often an organization has their own levels defined, and they can be set up in [`GovernanceClassificationLevel`](/types/4/0421-Governance-Classification-Levels/) definitions.
231+
The values used in governance classifications show the specific group that the classified asset belongs to. Often an organization has their own levels defined, and they can be set up using the [valid metadata values](/guides/planning/valid-values/overview) definitions.
233232

234233
![Figure 5](/guides/planning/governance-program/governance-program-level-definition.svg)
235234
> **Figure 5:** Governance classifications that use governance level definitions

site/docs/patterns/metadata-manager/categories-of-metadata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The categories of metadata listed below help you organize your metadata needs ar
5454
* [Reference data](/types/5/0545-Reference-Data) describing valid values and mappings for data values,
5555
* [Technical controls](/types/4/0430-Technical-Controls) defining quality rules and processing rules - such as anonymization/encryption requirements,
5656
* [Terms and conditions](/types/4/0483-Terms-And-Conditions) of use,
57-
* [Governance action classifications](/types/4/0422-Governance-Action-Classifications) such as level of confidentiality, expected retention period, how critical this type of data is ...,
57+
* [Governed data classifications](/types/4/0422-Governed-Data-Classifications) such as level of confidentiality, expected retention period, how critical this type of data is ...,
5858
* [Data classes](/concepts/data-class) are logical types for data used to characterize data during analysis.
5959
* [Standard/preferred schemas](/concepts/schema) and [associated implementation snippets](/types/5/0504-Implementation-Snippets) to guide developers to improve the consistency of data representation across the digital landscape.
6060

site/docs/practices/common-data-definitions/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Typically, the common data definitions consist of:
2121

2222
The common data definitions in open metadata are part of the *Subject Area Materials* and are grouped into [subject areas](/concepts/subject-area). The core materials that cover the meaning of data are described in one or more [glossaries](/practices/common-data-definitions/anatomy-of-a-glossary). These are augmented by [valid values](/practices/common-data-definitions/open-metadata-for-common-definitions), [reference data](/practices/common-data-definitions/open-metadata-for-common-definitions) and [quality rules](/practices/common-data-definitions/open-metadata-for-common-definitions).
2323

24-
[Governance action classifications](/types/4/0422-Governance-Action-Classifications) may be added to these definitions which in turn link to governance requirements. This determines how data that is linked to the subject area material should be governed.
24+
[Governed data classifications](/types/4/0422-Governed-Data-Classifications) may be added to these definitions which in turn link to governance requirements. This determines how data that is linked to the subject area material should be governed.
2525

2626
Tools used by the organization to, for example, create new data stores, data visualizations, or APIs, or analytics models are pre-populated with concrete data definitions by automated tool bridges. Each tool bridge extracts the relevant definitions from the metadata catalog, generates the concrete definitions and loads them into the tool. Where possible, these definitions include tags that link the definitions back to the common data definitions.
2727

site/docs/practices/common-data-definitions/semantic-to-implementation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@
134134
![Figure 10](/practices/common-data-definitions/semantic-to-implementation-schema-assignment.svg)
135135
> Figure 10: Using assignment relationships to create a rich description of the data stored in a schema attribute (data field)
136136

137-
??? info "Governance action classifications"
137+
??? info "Governed data classifications"
138138

139-
[Governance action classifications](/types/4/0422-Governance-Action-Classifications) can be attached to most types of metadata elements. They can also be assigned to glossary terms to indicate that the classification applies to all data values associated with the glossary term. The governance action classifications have attributes that identify a particular *level* that applies to the attached element. The definition for each [level](/types/4/0421-Governance-Classification-Levels) can be linked to appropriate Governance Definitions that define how digital resources classified at that level should be governed. Governance Classification Levels are linked to Governance Definitions using the [GovernedBy](/types/4/0401-Governance-Definitions) relationship.
139+
[Governed data classifications](/types/4/0422-Governed-Data-Classifications) can be attached to most types of metadata elements. They can also be assigned to glossary terms to indicate that the classification applies to all data values associated with the glossary term. The governed data classifications have attributes that identify a particular *level* that applies to the attached element. The definition for each [level](/guides/planning/valid-values/overview) can be linked to appropriate Governance Definitions that define how digital resources classified at that level should be governed. Governance Classification Levels are linked to Governance Definitions using the [GovernedBy](/types/4/0401-Governance-Definitions) relationship.
140140

141141
![Figure 11](/practices/common-data-definitions/semantic-to-implementation-governance-classification.svg)
142142
> Figure 11: Classifying glossary terms to identify the governance definitions that apply to all data values associated with the glossary term

site/docs/services/omas/governance-program/overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ The labels may be assigned directly to the asset, or to elements, such as schema
8585

8686
## Setting up the levels for your governance classifications
8787

88-
The values used in governance classifications show the specific group that the classified asset belongs to. Often an organization has their own levels defined ,and they can be set up in [`GovernanceClassificationLevel`](/types/4/0421-Governance-Classification-Levels/) definitions.
88+
The values used in governance classifications show the specific group that the classified asset belongs to. Often an organization has their own levels defined ,and they can be set up using the [Valid Metadata Values](/guides/planning/valid-values/overview) services.
8989

90-
Egeria has a set of default values that can be set up using the [`createStandardGovernanceClassificationLevels`](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceprogram/api/GovernanceClassificationLevelInterface.html) method. Alternatively you can set up your own values through the [GovernanceClassificationManager](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceprogram/client/GovernanceClassificationLevelManager.html) client.
90+
Egeria has a set of default values that are set up when the [Core Content Pack](/content-packs/). Alternatively you can set up your own values through the [GovernanceClassificationManager](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceprogram/client/GovernanceClassificationLevelManager.html) client.
9191

9292
## Governance Status Identifiers
9393

site/docs/types/0/0021-Collections.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ The classifications associated with *Collection* allow it to be specialized for
3131
* [*RecentAccess*](#recentaccess-classification) means the collection is a set of elements that have been recently accesses by a user.
3232
* [*WorkItemList*](#workitemlist-classification) means the collection is a set of elements that have been recently accesses by a user.
3333
* [*DigitalProduct*](/types/7/0710-Digital-Service) describes a collection of [assets](/concepts/asset) that represent a [digital product](/concepts/digital-product).
34-
* [*GovernanceStatusSet*](/types/4/0421-Governance-Classification-Levels) for a collection of governance statuses.
35-
* [*GovernanceClassificationSet*](/types/4/0421-Governance-Classification-Levels) for a collection of governance classification for a particular governance classification.
3634
* [*EventSet*](/types/5/0535-Event-Schemas) for a collection of related event schemas.
3735

3836
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.
@@ -113,7 +111,7 @@ The values for the *MembershipStatus* enumeration are:
113111
* *Obsolete* - The membership must no longer be used.
114112
* *Other* - Another membership status that is set up in the *userDefinedStatus* attribute.
115113

116-
They can be used to support a simple stewardship workflow. For example, consider an [engine action](/concepts/engine-action) that scans through the [assets](/concepts/asset) examining each one's [Retention](/types/4/0422-Governance-Action-Classifications) classification. If the values in the classification indicate that the [resource](/concepts/resource) that it represents should be archived, it may link the asset into a collection.
114+
They can be used to support a simple stewardship workflow. For example, consider an [engine action](/concepts/engine-action) that scans through the [assets](/concepts/asset) examining each one's [Retention](/types/4/0422-Governed-Data-Classifications) classification. If the values in the classification indicate that the [resource](/concepts/resource) that it represents should be archived, it may link the asset into a collection.
117115

118116
![Candidate assets for archive](archive-candidate-collection.svg)
119117

site/docs/types/3/0340-Dictionary.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Its attributes are:
4343

4444
* *defaultValue* - Value that is used when an instance of the data field is created.
4545
* *sampleValues* - List of sample values for the data field.
46-
* *dataPattern* - A regular expression that characterizes the values in the data field.
47-
* *namePattern* - A regular expression that characterizes the name of the data field.
46+
* *dataPatterns* - Regular expressions that characterize the values in the data field.
47+
* *namePatterns* - Regular expressions that characterize the name of the data field.
4848

4949

5050
--8<-- "snippets/abbr.md"

0 commit comments

Comments
 (0)