diff --git a/site/docs/concepts/karma-point-plateau.md b/site/docs/concepts/karma-point-plateau.md index 4749ef0aa1..86e12b3a15 100644 --- a/site/docs/concepts/karma-point-plateau.md +++ b/site/docs/concepts/karma-point-plateau.md @@ -6,8 +6,8 @@ A karma point plateau identifies a significant contribution to open metadata. By default, a karma point plateau is achieved for every 500 [karma points](karma-point.md) awarded. -However the threshold for the karma point plateau can be -[changed at server start up](/concepts/karma-point-plateau). +However, the threshold for the karma point plateau can be +[changed at server configuration](/concepts/karma-point-plateau). The Community Profile OMAS generates a [Karma Point Plateau Event](/concepts/karma-point-plateau) diff --git a/site/docs/concepts/karma-point.md b/site/docs/concepts/karma-point.md index 559130dc01..842792b9a7 100644 --- a/site/docs/concepts/karma-point.md +++ b/site/docs/concepts/karma-point.md @@ -3,7 +3,7 @@ # Karma Point -A karma point is a reward given to an individual for making a contribution to open metadata. +A karma point is a reward given to an actor profile for making a contribution to open metadata. This may be for: * Creating some information @@ -11,14 +11,11 @@ This may be for: * Linking information together * Removing obsolete information -Karma points are awarded automatically. They are stored in an individual's [personal profile](/concepts/personal-profile). -When an individual's karma point total reaches a multiple of the karma point notification threshold, +Karma points are awarded automatically. They are stored in an actors's [actor profile](/concepts/personal-profile). +When an actor's karma point total reaches a multiple of the karma point notification threshold, the Community Profile OMAS sends a notification on its [OutTopic](/concepts/out-topic). - - -## Related information - -* [Configuring the notification threshold for karma points] +!!! info "Related information" + * [Configuring the notification threshold for karma points](/guides/admin/servers/by-section/access-services-section/#enable-access-services) --8<-- "snippets/abbr.md" diff --git a/site/docs/features/people-roles-organizations/overview.md b/site/docs/features/people-roles-organizations/overview.md index c5d1d4b276..1151933935 100644 --- a/site/docs/features/people-roles-organizations/overview.md +++ b/site/docs/features/people-roles-organizations/overview.md @@ -277,8 +277,19 @@ Organization data is widely distributed across an organization's systems. Each ### Collaboration metadata ### Contribution records + +A [contribution record](/types/1/0125-Contribution) is used to accumulate information about an actor's (individual or automation) contribution. It is linked (1-1) with the actor's [actor profile](/types/1/0110-Actors) element. + ### Karma points and karma point plateaus +[Karma points](/concepts/karma-point) recognize actors (both individuals and automation) based on their contributions (create, update, delete) to open metadata. Each karma point is award through the userId making the change. However, they are only accumulated in a contribution record if the userId is linked to an [actor profile](/types/1/0110-Actors). Therefore, it is necessary to create a user identity linked to an actor profile for each user that you want to be awarded karma points. + +The [karma point plateau](/concepts/karma-point-plateau) identifies a threshold for karma points that should be recognised as significant. The default threshold is 500 karma points. + +Karma points and/or karma point plateaus can be used to add gamification into the open metadata ecosystem in order to reward the highest contributors. Since karma points may be awarded to both individuals and automation, it is reasonable to maintain different league tables for people from automated processes. + ## Summary +People are a key part of governance. Their needs, training, and recognition for their efforts are central to a successful governance program. Egeria's collaboration metadata area and associated services allows you to maintain a company-wide perspective and control of who is responsible for different actions across the different organization silos, tools and systems. The integration capability of Egeria makes it possible to keep this information in sync with key Human Resources (HR) and management systems. + --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/release-notes/december-2024.md b/site/docs/release-notes/december-2024.md new file mode 100644 index 0000000000..7056156cb1 --- /dev/null +++ b/site/docs/release-notes/december-2024.md @@ -0,0 +1,37 @@ + + + +# December 2024 + +Welcome to the Egeria community's December 2024 newsletter. Since our [last newsletter](/release-notes/october-2024), the community has developed some exciting new capabilities as well as improving the function, reliability and performance of existing features. + +## New Native Open Metadata Repository built in PostgreSQL + +## Visualization using Mermaid + +## New Governance Action Processes + +## Extensions to the View Services + +## Improvements to the Secrets stores + +## Roles and contribution records for teams and automation + +## Extensions to pyegeria + +## Full release notes for V5.2 + +The full release notes for version 5.2 can be found on [Egeria's website](https://egeria-project.org/release-notes/previous/#release-52-december-2024). + +## Future plans + +Plans for release 5.3 are open, and we are looking for suggestions. + +## Connecting with the project + +With our new focus on Python and supporting data practitioners directly, the community is looking for new contributors to the project. If these topics interest you, then please contact us and we can help you get started. + +!!! info "Connecting with the community" + Go to our [community guide](/guides/community){target=blank} to find out more about the activities of the Egeria project nd ho to get engaged. + +--8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/release-notes/october-2024.md b/site/docs/release-notes/october-2024.md index 91b70650af..a1431f4d04 100644 --- a/site/docs/release-notes/october-2024.md +++ b/site/docs/release-notes/october-2024.md @@ -3,12 +3,12 @@ # October 2024 -Welcome to the Egeria community's October 2024 newsletter. Since our [last newsletter](/release-notes/june-2023), the community has been focused on adding support for Unity Catalog and improving the user experience in the *egeria workspaces*. +Welcome to the Egeria community's October 2024 newsletter. Since our [last newsletter](/release-notes/june-2024), the community has been focused on adding support for Unity Catalog and improving the user experience in the *egeria workspaces*. ## Full release notes for V5.1 -The full release notes for version 5.0 can be found on [Egeria's website](https://egeria-project.org/release-notes/5-1/). +The full release notes for version 5.1 can be found on [Egeria's website](https://egeria-project.org/release-notes/previous/#release-50-july-2024). ## Future plans diff --git a/site/docs/release-notes/previous.md b/site/docs/release-notes/previous.md index c5e761107e..8f93ea5144 100644 --- a/site/docs/release-notes/previous.md +++ b/site/docs/release-notes/previous.md @@ -2,9 +2,15 @@ -# Earlier releases +# All releases -???+ info "Release 5.0 (July 2024)" +??? info "Release 5.2 (In progress - expected December 2024)" +--8<-- "snippets/release-notes/5-2.md" + +??? info "Release 5.1 (October 2024)" + --8<-- "snippets/release-notes/5-1.md" + +??? info "Release 5.0 (July 2024)" --8<-- "snippets/release-notes/5-0.md" ??? info "Release 4.3 (September 2023)" diff --git a/site/docs/services/omvs/metadata-explorer/overview.md b/site/docs/services/omvs/metadata-explorer/overview.md index fb33cd8c1c..effff3cc7b 100644 --- a/site/docs/services/omvs/metadata-explorer/overview.md +++ b/site/docs/services/omvs/metadata-explorer/overview.md @@ -14,7 +14,7 @@ The Metadata Explorer OMVS has 11 different types of search operation. The firs * getMetadataElementGUIDByUniqueName - Retrieve the metadata element's unique identifier (guid) using its unique name (again, typically the *qualifiedName* attribute but other attributes can be used if they are unique - such as *pathName* for a file). * getMetadataElementHistory - Retrieve all the versions of an element. -The next two operations retrieve the relationships linked to an element, and the element attached at the far end of each relationship. +The next four operations retrieve the relationships linked to an element, and the element attached at the far end of each relationship. * getAllRelatedMetadataElements - Retrieve the metadata elements connected to the supplied element. * getRelatedMetadataElements - Retrieve the metadata elements connected to the supplied element via a specific relationship type. @@ -85,8 +85,8 @@ SequencingOrder is used for search requests against a metadata collection. It d * CREATION_DATE_OLDEST: return in the order that the elements were created with the oldest ones first. * LAST_UPDATE_RECENT: return in the order of the latest update with the most recent first. * LAST_UPDATE_OLDEST: return in the order of the latest update with the oldest first. -* PROPERTY_ASCENDING: return in ascending order of the values in a sequencing property. The sequencing property will be supplied in the * sequencingparameter. -* PROPERTY_DESCENDING: return in descending order of the values in a sequencing property. The sequencing property will be supplied as a parameter. +* PROPERTY_ASCENDING: return in ascending order of the values in a sequencing property. The sequencing property will be supplied in the *sequencing* parameter. +* PROPERTY_DESCENDING: return in descending order of the values in a sequencing property. The sequencing property will be supplied in the *sequencing* parameter. Note: not all repositories support ordering. The results may vary between repository types. @@ -97,7 +97,7 @@ Each access service can be set up to support a restrictive set of governance zon By default, all requests are routed via Feedback Manager OMVS to Asset Manager OMAS. If you wish the request to be routed via a different view service (OMVS) or access service (OMAS) it is possible to use one or other of these request parameters: * viewServiceURLMarker optional view service URL marker (overrides accessServiceURLMarker) to route the request via a different view service and onto its default access service. -* accessServiceURLMarker optional access service URL marker used to identify which back end service +* accessServiceURLMarker optional access service URL marker used to identify which back end service. The URL marker is derived from the name of the requested service - take the short two-word service name, convert to lower case and add a hyphen between the two words - so Feedback Manager OMVS's URL Marker is feedback-manager. diff --git a/site/docs/types/1/0112-People.md b/site/docs/types/1/0112-People.md index 6a30a52735..d3b21eabbd 100644 --- a/site/docs/types/1/0112-People.md +++ b/site/docs/types/1/0112-People.md @@ -3,15 +3,15 @@ # 0112 People, their personal network and their roles -This model describes the metadata elements that describe a person and their roles and contribution in the organization. +This model describes the metadata elements that describe a person. This is an extension of the [ActorProfile](/types/1/0110-Actors). ![UML](0112-People.svg "Describing the profile for a person") -## Person +## Person entity `Person` extends [`ActorProfile`](/types/1/0110-Actors/#actorprofile) to capture more information about a person. Many of the properties are inspired by the LDAP `inetOrgPerson` attributes (see [RFC 2798](https://datatracker.ietf.org/doc/rfc2798/)). -Typically the `name` is set to a person's preferred name. The `qualifiedName` may be the identifier from an external system or the `employeeNumber` and/or some combination of names to ensure it is unique. Then the properties are as follows: +Typically, the `name` is set to a person's preferred name. The `qualifiedName` may be the identifier from an external system or the `employeeNumber` and/or some combination of names to ensure it is unique. Then the properties are as follows: - `title` takes the courtesy title of the person. - `givenNames` is set to a space separated list of names that are not the person's surname (or family name). @@ -24,17 +24,10 @@ Typically the `name` is set to a person's preferred name. The `qualifiedName` m - `preferredLanguage` is on or more spoken or written language identifiers preferred by the person. - `isPublic` indicates whether the information in the profile can be shared with colleagues or is only visible to the user(s) that connect with one of the linked user identities or systems that are part of the open metadata ecosystem. -## Peer +## Peer relationship The *Peer* relationship links two people together as peers in an organization. Peers represents a list of a person's close/important colleagues. The perspective on who is a close/important colleague is a personal perspective. Therefore the *Peer* relationship separates the concept of who has linked to a person (*myFollowers*) from who they have specifically linked to (*myPeers*). -## Contribution Record - -The *ContributionRecord* accumulates achievements of an individual. Specifically Egeria supports [Karma Points](/concepts/karma-point). These are awarded for participation in open metadata and governance. The number of karma points awarded to the individual is recorded in their *ContributionRecord* entity. - -- `isPublic` indicates whether the values in the contribution record can be shared with colleagues or is only visible to user(s) that connect with one of the linked user identities or systems that are part of the open metadata ecosystem. -- `karmaPoints` captures the total number of points that the individual has earned from their activity. - ## Further information diff --git a/site/docs/types/1/0112-People.svg b/site/docs/types/1/0112-People.svg index 1a9792f81f..9aa2ac4316 100644 --- a/site/docs/types/1/0112-People.svg +++ b/site/docs/types/1/0112-People.svg @@ -1,4 +1,4 @@ -
0112 - People
«entity»
Person
title : string
initials : string
givenNames : string
surname : string
fullName : string
pronouns : string
jobTitle : string
employeeNumber : string
employeeType : string
preferredLanguage : string
residentCountry : string
timeZone :  string
isPublic : boolean
«relationship»
PersonalContribution
«entity»
ActorProfile
«relationship»
Peer
*
*
peers
peers
«entity»
ContributionRecord
isPublic : boolean
karmaPoints : long
contributionRecord
contributor
0..1
0..1
«entity»
Referenceable
 \ No newline at end of file +
0112 - People
«entity»
Person
title : string
initials : string
givenNames : string
surname : string
fullName : string
pronouns : string
jobTitle : string
employeeNumber : string
employeeType : string
preferredLanguage : string
residentCountry : string
timeZone :  string
isPublic : boolean
«entity»
ActorProfile
«relationship»
Peer
*
*
peers
peers
 \ No newline at end of file diff --git a/site/docs/types/1/0125-Contribution.md b/site/docs/types/1/0125-Contribution.md new file mode 100644 index 0000000000..abc7fb0421 --- /dev/null +++ b/site/docs/types/1/0125-Contribution.md @@ -0,0 +1,23 @@ + + + +# 0125 Contribution + +A key part of a successful governance program is ensuring that contributors are recognized - both the individuals and the automation that supports them. The contribution record keeps track of the contribution of each actor in the form of [karma points](/concepts/karma-point). Karma points are collected based on the user performing the work and then aggregated into the contribution record of the associated actor profile. + +![UML](0125-Contribution.svg) + +## ContributionRecord entity + +The *ContributionRecord* accumulates achievements of an individual. Specifically Egeria supports [Karma Points](/concepts/karma-point). These are awarded for participation in open metadata and governance. The number of karma points awarded to the individual is recorded in their *ContributionRecord* entity. + +- `isPublic` indicates whether the values in the contribution record can be shared with colleagues or is only visible to user(s) that connect with one of the linked user identities or systems that are part of the open metadata ecosystem. +- `karmaPoints` captures the total number of points that the actor has earned from their activity. + + +## Contribution relationship + +The *Contribution* relationship links the contribution record to the actor profile for the individual or automation that is making the contribution. + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/types/1/0125-Contribution.svg b/site/docs/types/1/0125-Contribution.svg new file mode 100644 index 0000000000..da4660e145 --- /dev/null +++ b/site/docs/types/1/0125-Contribution.svg @@ -0,0 +1,4 @@ + + + +
0125 - Contribution
«entity»
ActorProfile
«relationship»
Contribution
«entity»
ContributionRecord
isPublic : boolean
karmaPoints : long
profileContributionRecord
contributorProfile
0..1
0..1
«entity»
Referenceable
 \ No newline at end of file diff --git a/site/docs/types/1/area-1-collaboration-overview.svg b/site/docs/types/1/area-1-collaboration-overview.svg index 26f083e8a3..949654a3b5 100644 --- a/site/docs/types/1/area-1-collaboration-overview.svg +++ b/site/docs/types/1/area-1-collaboration-overview.svg @@ -1,4 +1,4 @@ -
Area 1 - Collaboration
0130
Projects
0135
Meetings
0140
Communities
0150
Feedback
0160
Notes
0110
Actors
0112
People
0115
Teams
0155
Crowd Sourcing
0137
Actions
0117
Engine Profiles
0118
Actor Roles
0119
Team Roles
0120
Assignment Scopes
 \ No newline at end of file +
Area 1 - Collaboration
0130
Projects
0135
Meetings
0140
Communities
0150
Feedback
0160
Notes
0110
Actors
0112
People
0115
Teams
0155
Crowd Sourcing
0137
Actions
0117
Engine Profiles
0118
Actor Roles
0119
Team Roles
0120
Assignment Scopes
0125
Contribution
 \ 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 ac76cb77e2..7bed274af6 100644 --- a/site/docs/types/1/area-1-collaboration.drawio +++ b/site/docs/types/1/area-1-collaboration.drawio @@ -1,4 +1,4 @@ - + @@ -82,18 +82,24 @@ - + - + - + - + + + + + + + @@ -249,79 +255,96 @@ - + - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - - - - - + + + + + + + + + + - - + + - - + + - - + + + + - - + + - - + + - + - + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/types/1/index.md b/site/docs/types/1/index.md index f22f17f007..f0aec4113c 100644 --- a/site/docs/types/1/index.md +++ b/site/docs/types/1/index.md @@ -17,6 +17,7 @@ Area 1 collects information from people using their organization's assets. It in - [0118 Actor Roles](/types/1/0118-Actor-Roles) - generic description of a set of responsibilities that need to be performed in an organization. The role can be fulfilled by a person, team and/or engine. - [0119 Team Roles](/types/1/0119-Team-Roles) - responsibilities (roles) within a team. - [0120 Assignment Scopes](/types/1/0120-Assignment-Scopes) - assignment of actors to the resources they are responsible for +- [0125 Contribution](/types/1/0125-Contribution) - a contribution record to reward the people, teams and automated services that are supporting the open metadata ecosystem. - [0130 Projects](/types/1/0130-Projects) - projects for organizing change to the IT landscape - [0135 Meetings](/types/1/0135-Meetings) - meetings where ideas, situations and plans are discussed and reviewed - [0137 Actions for People](/types/1/0137-Actions) - descriptions of actions for people diff --git a/site/mkdocs.yml b/site/mkdocs.yml index e8a39c9e17..b70e318b74 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -311,7 +311,7 @@ nav: - Core Egeria: - Latest Release: release-notes/latest.md - Next Release: release-notes/next.md - - Previous releases: release-notes/previous.md + - All releases: release-notes/previous.md - Roadmap: release-notes/roadmap.md - Content Status: release-notes/content-status.md - Reference: @@ -354,6 +354,7 @@ nav: - Actor Roles: types/1/0118-Actor-Roles.md - Team Roles: types/1/0119-Team-Roles.md - Assignment Scopes: types/1/0120-Assignment-Scopes.md + - Contribution: types/1/0125-Contribution.md - Projects: types/1/0130-Projects.md - Meetings: types/1/0135-Meetings.md - Actions for People: types/1/0137-Actions.md diff --git a/site/snippets/admin/configuring-the-access-services.md b/site/snippets/admin/configuring-the-access-services.md index 1259024bb4..9caf540281 100644 --- a/site/snippets/admin/configuring-the-access-services.md +++ b/site/snippets/admin/configuring-the-access-services.md @@ -179,7 +179,16 @@ The access services can either all be enabled (with default configuration values The service URL marker for each service is shown in the example response given above. -In both cases, it is possible to pass a list of properties to the access service that controls the behavior of each access service. These are sent in the request body. More details of which properties are supported are documented with each access service. +In both cases, it is possible to pass a map of option names to values for the access service that controls the behavior of each access service. The map is sent as the request body. The names of the options available on all access services are: + +* *SupportedZones* - a list of [governance zones](/concepts/governance-zone) that assets must belong to be retrieved through this access service. +* *DefaultZones* - a list of [governance zones](/concepts/governance-zone) that are assigned to any newly created asset. +* *PublishZones* - a list of [governance zones](/concepts/governance-zone) that are assigned to an asset when it is published. + +The following options can be specified on any access service configuration, but they are only processed by [Community Profile OMAS](/services/omas/community-profile/overview). + +* *KarmaPointIncrement* - how many [karma points](/concepts/karma-point) should be awarded to an actor for each contribution (create/update/delete) to the open metadata ecosystem. The default value is 1. +* *KarmaPointPlateau* - how many karma points does an actor need to be awarded a [karma point plateau](/concepts/karma-point-plateau). The default value is 500. ### Disable the access services diff --git a/site/snippets/release-notes/5-2.md b/site/snippets/release-notes/5-2.md index f1ce63fa72..196c58c3de 100644 --- a/site/snippets/release-notes/5-2.md +++ b/site/snippets/release-notes/5-2.md @@ -1,7 +1,7 @@ -## Release 5.2 (Expected December 2024) +## Release 5.2 (December 2024) _**These are DRAFT release notes. The notes will be updated until & when 5.2 is released**_ @@ -10,11 +10,12 @@ _**These are DRAFT release notes. The notes will be updated until & when 5.2 is * The following lineage relationships have a new attribute called *label* to use when visualizing lineage graphs: [DataFlow](/types/7/0750-Data-Passing), [ControlFlow](/types/7/0750-Data-Passing), [ProcessCall](/types/7/0750-Data-Passing), [UltimateSource](/types/7/0755-Ultimate-Source-Destination), and [LineageMapping](/types/7/0770-Lineage-Mapping). * There is a new type calling [ActorRole](/types/1/0118-Actor-Roles) to represent a role that a person, team or software executable can perform in the governance fabric. It has subtypes for *PersonRole*, *TeamRole* and *ITProfileRole* along with relationships to connect them to their respective *ActorProfiles*. * The roles for a team are now in [model 0119 - Team Roles](/types/1/0119-Team-Roles) + * The *ContributionRecord* entity type is now in [model 0125 - Contribution](/types/1/0125-Contribution). A new *Contribution* relationship has been defined to allow contribution records to be attached to any type of actor profile. The *PersonalContribution* relationship has been deprecated. ??? functional "Support for user authentication via the secrets store connectors" [Secret Store Connectors](/concepts/secret-store-connector) are now able to support the authentication of users calling the [Open Metadata View Services (OMVS)](/services/omvs). -??? functional "Extended support for Unity Catalog release 0.2.0" +??? functional "Extended support for Unity Catalog release 0.3.0" The Unity catalog connectors now work with the secrets store. They also support models, update requests and catalog the schemas of tables as well as the input/output parameters and dependencies of a function. ??? functional "Support for mermaid visualization"