Skip to content

Commit

Permalink
Change marker for placeholder variables
Browse files Browse the repository at this point in the history
Signed-off-by: Mandy Chessell <[email protected]>
  • Loading branch information
mandy-chessell committed Nov 11, 2024
1 parent ce0ae64 commit ed00d50
Show file tree
Hide file tree
Showing 24 changed files with 1,175 additions and 251 deletions.
14 changes: 9 additions & 5 deletions site/docs/concepts/placeholder.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

# Placeholders

A placeholder is a replaceable value. It is distinguished by a double set of curly braces - `{{placeholder}}`. Placeholders allow concrete values to be substituted when an element is either created of used. They are found in many technologies. For example, both Postman and IntelliJ's HTTP client use placeholders in their REST API definitions to denote network addresses or identifiers. These values are supplied when the REST request is made through an environment file.
A placeholder is a replaceable value.
It is typically distinguished by a double set of curly braces - `{{placeholder}}`.
Placeholders allow concrete values to be substituted when an element is either created of used. They are found in many technologies. For example, both Postman and IntelliJ's HTTP client use placeholders in their REST API definitions to denote network addresses or identifiers. These values are supplied when the REST request is made through an environment file.

Egeria has support for placeholders both in its [configuration documents](/concepts/configuration-document) and its [template](/features/templated-cataloguing/overview) support that is used when creating metadata.

Expand All @@ -14,7 +16,7 @@ The placeholders in the configuration document are called *placeholder variables

```
###
# Set up the common properties needed to call your event bus. The value of {{kafkaEndpoint}} is resolved in the
# Set up the common properties needed to call your event bus. The value of ~{kafkaEndpoint}~ is resolved in the
# application.properties file using the `platform.placeholder.variables` property.
POST {{baseURL}}/open-metadata/admin-services/users/{{adminUserId}}/servers/active-metadata-store/event-bus
Expand All @@ -23,16 +25,16 @@ Content-Type: application/json
{
"producer":
{
"bootstrap.servers":"{{kafkaEndpoint}}"
"bootstrap.servers":"~{kafkaEndpoint}~"
},
"consumer":
{
"bootstrap.servers":"{{kafkaEndpoint}}"
"bootstrap.servers":"~{kafkaEndpoint}~"
}
}
```
The value to substitute for `{{kafkaEndpoint}}` is provided in the OMAG Server Platform's `application.properties` file, like this:
The value to substitute for `~{kafkaEndpoint}~` is provided in the OMAG Server Platform's `application.properties` file, like this:
```
platform.placeholder.variables=\
{\
Expand All @@ -41,6 +43,8 @@ platform.placeholder.variables=\
```
It is read and used on each server start up.

Notice that placeholder variables use `~{` and `}~` as delimiters to avoid confusion with Intellij HTTP variables.

??? education "Further information on placeholder variables"

* [Configuring the OMAG Server Platform](/guides/admin/configuring-the-omag-server-platform) for setting up the `additional.properties` file
Expand Down
35 changes: 26 additions & 9 deletions site/docs/connectors/repository/postgres/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,32 @@ title: PostgreSQL Repository Database Schema
---
erDiagram
entity ||--o{ mapping_properties : "optional third party mapping"
relationship ||--o{ mapping_properties : "optional third party mapping"
entity |o--|| instance_properties : "entity properties"
classification |o--|| instance_properties : "classification properties"
relationship |o--|| instance_properties : "relationship properties"
instance_properties ||--o{ instance_property_value : manages
instance_property_value |o--o| instance_properties : "is collection to"
classification ||--o{ classification_property_value : "has properties"
classification }o--|| entity : "attached to entity"
entity ||--o{ entity_property_value : "has properties"
relationship ||--o{ relationship_property_value : "has properties"
relationship }o--|| entity : end1
relationship }o--|| entity : end2
```

## Debugging

Logging levels can be set up in the `application.properties` file. To log each SQL command issues, add the following:

```
logging.level.org.odpi.openmetadata.adapters.connectors.resource.jdbc=DEBUG
```

To log how queries are built up from the values supplied on the repository API, add the following:

```
logging.level.org.odpi.openmetadata.adapters.repositoryservices.postgres.repositoryconnector.database=DEBUG
```

--8<-- "snippets/abbr.md"
Expand Down
686 changes: 676 additions & 10 deletions site/docs/release-notes/egeria-status.drawio

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/docs/release-notes/functional-organization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion site/docs/release-notes/functional-organization.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 0 additions & 16 deletions site/docs/types/1/0112-People.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,6 @@ The *ContributionRecord* accumulates achievements of an individual. Specifically
- `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.

## PersonRole

Open metadata separates the person from the roles they perform. This is because people often perform many roles and these change over time. Also roles may be put in place before the person is appointed to it and the person appointed can change from time to time.

The PersonRole entity is extended in multiple places to show different types of roles. For example:

- ['TeamLeader'](/types/1/0115-Teams/#teamleader) and ['TeamMember'](/types/1/0115-Teams/#teammember)
- ['GovernanceRole'](/types/4/0445-Governance-Roles/#governancerole)
- ['ProjectManager'](/types/1/0130-Projects)

## PersonRoleAppointment

The *PersonRole* entity is linked to a *Person* entity with the *PersonRoleAppointment* relationship to show that the person has been appointed. It is common for [effectivity dates](/features/effectivity-dates) to be set on this relationship.




## Further information

Expand Down
2 changes: 1 addition & 1 deletion site/docs/types/1/0112-People.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 2 additions & 10 deletions site/docs/types/1/0115-Teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,10 @@ Team are groups of people organized to support a specific goal or responsibility

A team is a group of people who are working to a common goal. This is recorded in the `Team` entity which is an extension of ['ActorProfile'](/types/1/0110-Actors/#actorprofile).

## TeamLeadership and TeamMembership

The responsibilities of a team are divided into roles described by ['PersonRole'](/types/1/0112-People/#personrole). This in turn links to the people or person appointed to fulfil the role. The `TeamLeadership` and `TeamMembership` relationships link the team to its roles and allow a distinction to be made between the leaders and members of the team. A team can have multiple leadership and membership roles.

## TeamStructure

`TeamStructure` is used to link teams into an organization's hierarchical department structure. Typically the



## TeamLeader and TeamMember

`TeamLeader` and `TeamMember` extend from ['PersonRole'](/types/1/0112-People/#personrole). They provide a base type to distinguish between roles that are leadership roles and those which are not.

## Related types

[Organization](/types/4/0440-Organizational-Controls/#organization) is the top-level team of an organization.
Expand All @@ -33,6 +23,8 @@ Long-standing teams are often responsible for particular [*business capabilities

## Further information

The roles within a team are shown on [Model 0119 - Team Roles](/types/1/0119-Team-Roles).

[People, Roles and Organizations](/features/people-roles-organizations/overview) describes how metadata about teams is populated and used.

The [Community Profile OMAS](/services/omas/community-profile/overview) provides support for managing team structure.
Expand Down
4 changes: 2 additions & 2 deletions site/docs/types/1/0115-Teams.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions site/docs/types/1/0118-Actor-Roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# 0118 Actor Roles

Roles describe collections of responsibilities. These responsibilities can be fulfilled by a person, team or engine.

![UML](0118-Actor-Roles.svg "Describing the role for an actor profile")

## ActorRole entity

Open metadata separates the [ActorProfile](/type/1/0110-Actors) from the roles they perform. This is because people often perform many roles and these change over time. Also roles may be put in place before the person is appointed to it and the person appointed can change from time to time.

## PersonRole entity

The *PersonRole* entity is extended in multiple places to show different types of roles. For example:

- ['TeamLeader'](/types/1/0119-Team-Roles/#teamleader) and ['TeamMember'](/types/1/0119-Team-Roles/#teammember)
- ['GovernanceRole'](/types/4/0445-Governance-Roles/#governancerole)
- ['ProjectManager'](/types/1/0130-Projects)

## PersonRoleAppointment

The *PersonRole* entity is linked to a *Person* entity with the *PersonRoleAppointment* relationship to show that the person has been appointed. It is common for [effectivity dates](/features/effectivity-dates) to be set on this relationship.


## Further information

The roles within a team are shown on [Model 0119 - Team Roles](/types/1/0119-Team-Roles).

[People, Roles and Organizations](/features/people-roles-organizations/overview) describes how metadata about people is populated and used.

The [Community Profile OMAS](/services/omas/community-profile/overview) provides support for managing a [person's profile](/concepts/personal-profile). It also supports the ability to query a person's [roles](/concepts/personal-roles) and their [peer network](/concepts/peer-network).

The [Organization Integrator OMIS](/services/omis/organization-integrator/overview) supports the synchronization of information about people between open metadata and external systems.

--8<-- "snippets/abbr.md"
4 changes: 4 additions & 0 deletions site/docs/types/1/0118-Actor-Roles.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions site/docs/types/1/0119-Team-Roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# 0115 Teams

Team are groups of people organized to support a specific goal or responsibility of the organization.

![UML](0115-Teams.svg "Describing a team")

## Team

A team is a group of people who are working to a common goal. This is recorded in the `Team` entity which is an extension of ['ActorProfile'](/types/1/0110-Actors/#actorprofile).

## TeamLeadership and TeamMembership

The responsibilities of a team are divided into roles described by ['PersonRole'](/types/1/0112-People/#personrole). This in turn links to the people or person appointed to fulfil the role. The `TeamLeadership` and `TeamMembership` relationships link the team to its roles and allow a distinction to be made between the leaders and members of the team. A team can have multiple leadership and membership roles.

## TeamStructure

`TeamStructure` is used to link teams into an organization's hierarchical department structure. Typically the



## TeamLeader and TeamMember

`TeamLeader` and `TeamMember` extend from ['PersonRole'](/types/1/0112-People/#personrole). They provide a base type to distinguish between roles that are leadership roles and those which are not.

## Related types

[Organization](/types/4/0440-Organizational-Controls/#organization) is the top-level team of an organization.

Long-standing teams are often responsible for particular [*business capabilities*](/types/4/0440-Organizational-Controls/#businesscapability). Teams can also be linked to [projects](/types/1/0130-Projects).

## Further information

[People, Roles and Organizations](/features/people-roles-organizations/overview) describes how metadata about teams is populated and used.

The [Community Profile OMAS](/services/omas/community-profile/overview) provides support for managing team structure.

The [Organization Integrator OMIS](/services/omis/organization-integrator/overview) supports the synchronization of team information between open metadata and external systems.


--8<-- "snippets/abbr.md"
4 changes: 4 additions & 0 deletions site/docs/types/1/0119-Team-Roles.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions site/docs/types/1/area-1-collaboration-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ed00d50

Please sign in to comment.