Skip to content

Commit

Permalink
Merge pull request #996 from mandy-chessell/oak2025
Browse files Browse the repository at this point in the history
Add actor concept definition
  • Loading branch information
mandy-chessell authored Jan 22, 2025
2 parents f15457f + 9452d28 commit bfb8bc1
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 6 deletions.
17 changes: 17 additions & 0 deletions site/docs/concepts/actor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Actor

An *actor* is a person, group of people, or an automated process that is operating in the open metadata ecosystem. There are three types of actor:

* An *Actor Profile* describes a person, team or automated process operating in the open metadata ecosystem.
* An *Actor Role* describes a collection of responsibilities in the open metadata ecosystem. An actor profile can be *appointed* to a role to show that he/she/they/it are performing those responsibilities.
* A *User Identity* describes a user account that is defined to a user account. A user account can be linked to an actor profile to provide information on who/what is using the user account.

--8<-- "snippets/abbr.md"
2 changes: 2 additions & 0 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

## A

- [Action](/concepts/action)
- [Action Target](/concepts/action-target)
- [Actor](/concepts/actor)
- [Analytics Integrator OMIS](/services/omis/analytics-integrator/overview)
- [Anchor](/concepts/anchor)
- [Anchor Grouping](/concepts/anchor)
Expand Down
12 changes: 6 additions & 6 deletions site/docs/types/1/0110-Actors.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

# 0110 Actors

*Actors* are the people, teams or machines that drive activity in the organization's landscape.
[*Actors*](/concepts/actor) are the people, teams or machines that drive activity in the organization's landscape.

![UML](0110-Actors.svg "Collecting information about user identities and the people and systems behind them")

## ActorProfile
## ActorProfile entity

An `ActorProfile` describes an entity to store and link information about an actor in open metadata. It inherits from [`Referenceable`](/types/0/0010-Base-Model) so it has a unique name.

Expand All @@ -21,11 +21,11 @@ The subtypes of *ActorProfile* add further information about actors:
- [Team](/types/1/0115-Teams) for profiles describing teams.
- [ITProfile](/types/1/0117-IT-Profiles) for profiles describing specific IT processes and systems.

## ProfileLocation
## ProfileLocation relationship

The `ProfileLocation` relationship identifies an association between an ActorProfile and a [Location](/types/0/0025-Locations), such as a person's primary work location. The `associationType` property records the purpose of the association. Its value can be defined in a [ValidValueSet](/types/5/0545-Reference-Data).

## ContactDetails
## ContactDetails entity

`ContactDetails` describe the mechanisms to contact an actor - this is typically linked to actor profiles for people and teams.

Expand All @@ -42,15 +42,15 @@ The `ProfileLocation` relationship identifies an association between an ActorPro

- `contactMethodValue` - the address or account name or number to use for this contact method.

## UserIdentity
## UserIdentity entity

Most metadata repositories are run in a secure mode requiring incoming requests to include the requester’s security credentials. Therefore, we have an identifier for each unique logged on security identity (aka userId). This identity is recorded in the header of the metadata elements when they are created or updated.

`UserIdentity` provides a structure for storing details about a particular userId. Initially we have a simple string for the userId - but this could be extended to include more sophisticated identification information.

- `distinguishedName` - the fully qualified name in LDAP.

## ProfileIdentity
## ProfileIdentity relationship

`ProfileIdentity` links the `ActorProfile` to one or more `UserIdentity` entities. This allows the calling user's profile to be retrieved from the incoming userId. The attributes for `ProfileIdentity` help to pick the right `UserIdentity` based on [`PersonRole`](/types/1/0112-People) when navigating from the `ActorProfile` to multiple `UserIdentity` entities:

Expand Down
1 change: 1 addition & 0 deletions site/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,7 @@ nav:
- Basic Concepts: concepts/basic-concepts.md
- Action: concepts/action.md
- Action Target: concepts/action-target.md
- Actor: concepts/actor.md
- Anchor: concepts/anchor.md
- Asset: concepts/asset.md
- Asset Log Message: concepts/asset-log-message.md
Expand Down

0 comments on commit bfb8bc1

Please sign in to comment.