Skip to content

Commit be83695

Browse files
mandy-chessellmandy-chessell
authored
Merge pull request #1059 from mandy-chessell/oak2025
Move status from header to enum attributes
2 parents 8154fcd + 3827fc4 commit be83695

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+324
-542
lines changed

‎saved/connectors/repositories/xtdb/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
[Reference copies](/guides/cts/profiles/reference-copies) | :material-check-all: CONFORMANT_FULL_SUPPORT
1717
[Metadata maintenance](/guides/cts/profiles/metadata-maintenance) | :material-check-all: CONFORMANT_FULL_SUPPORT
1818
[Dynamic types](/guides/cts/profiles/dynamic-types) | :material-help: UNKNOWN_STATUS
19-
[Graph queries](/guides/cts/profiles/graph-queries) | :material-check-all: CONFORMANT_FULL_SUPPORT
2019
[Historical search](/guides/cts/profiles/historical-search) | :material-check-all: CONFORMANT_FULL_SUPPORT
2120
[Entity proxies](/guides/cts/profiles/entity-proxies) | :material-check-all: CONFORMANT_FULL_SUPPORT
2221
[Soft-delete and restore](/guides/cts/profiles/soft-delete-and-restore) | :material-check-all: CONFORMANT_FULL_SUPPORT

‎site/docs/concepts/business-capability.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
hide:
3+
- toc
4+
---
5+
6+
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
7+
<!-- Copyright Contributors to the Egeria project 2020. -->
8+
9+
# Business Capability
10+
11+
--8<-- "snippets/work-in-progress.md"
12+
13+
--8<-- "snippets/abbr.md"

‎site/docs/concepts/instance-status.md‎

Lines changed: 9 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- toc
4+
---
5+
16
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
27
<!-- Copyright Contributors to the Egeria project. -->
38

@@ -8,71 +13,10 @@ Most types of metadata element (instances) may be in one of two status:
813
- ACTIVE - this means it is visible in the repositories.
914
- DELETED - this means it has been soft-deleted and can only be retrieved via a special query. For repositories that support history, it is possible to move the element back to the status it was before it was deleted using the `restore()` method.
1015

11-
Some elements have an advanced lifecycle which means they can pass through multiple statuses during their lifetime.
12-
13-
Egeria does not define the order or conditions that must be met to change status. This is left to the deploying organization to decide their own governance processes.
14-
15-
## Valid status values
16-
17-
The list of valid values for status is defined by the [Open Metadata Framework (OMF)](/frameworks/omf/overview)'s *ElementStatus* enum. These are matched by the [Open Metadata Repository Services (OMRS)](/services/omrs) in its *InstanceStatus* enum. This is the complete list.
18-
19-
| Java/JSON name | Ordinal | Name | Description |
20-
|-------------------------|---------|-------------------------|-----------------------------------------------------------|
21-
| UNKNOWN | 0 | Unknown | Unknown instance status. |
22-
| DRAFT | 1 | Draft | The content is incomplete. |
23-
| PREPARED | 2 | Prepared | The content is ready for review. |
24-
| PROPOSED | 3 | Proposed | The content is in review. |
25-
| APPROVED | 4 | Approved | The content is approved. |
26-
| REJECTED | 5 | Rejected | The request or proposal is rejected. |
27-
| APPROVED_CONCEPT | 6 | Approved concept | The request or proposal is approved for development. |
28-
| UNDER_DEVELOPMENT | 7 | Under development | The instance is being developed. |
29-
| DEVELOPMENT_COMPLETE | 8 | Development complete | The development of the instance is complete. |
30-
| APPROVED_FOR_DEPLOYMENT | 9 | Approved for deployment | The instance is approved for deployment. |
31-
| STANDBY | 10 | StandBy | The instance is deployed in standby mode. |
32-
| ACTIVE | 15 | Active | The instance is approved and in use. |
33-
| FAILED | 20 | Failed | The instance is not in use due to failure. |
34-
| DISABLED | 21 | Disabled | The instance is shutdown or disabled. |
35-
| COMPLETE | 22 | Complete | The activity associated with the instance is complete. |
36-
| DEPRECATED | 30 | Deprecated | The instance is out of date and should not be used. |
37-
| OTHER | 50 | Other | The instance is in a locally defined state. |
38-
| DELETED | 99 | Deleted | The instance has been deleted and is no longer available. |
39-
40-
## Open Metadata Types with advanced lifecycles
41-
42-
The table below summarizes the types with advanced lifecycles and the instances that are permitted. In all cases the default initial status is DRAFT.
43-
44-
| Type Name | DRAFT | PREPARED | PROPOSED | APPROVED | REJECTED | APPROVED_CONCEPT | UNDER_DEVELOPMENT | DEVELOPMENT_COMPLETE | APPROVED_FOR_DEPLOYMENT | STANDBY | ACTIVE | FAILED | DISABLED | COMPLETE | DEPRECATED | OTHER | DELETED |
45-
|-------------------------------|-------|----------|----------|----------|----------|------------------|-------------------|----------------------|-------------------------|---------|--------|--------|----------|----------|------------|-------|---------|
46-
| Process | X | | X | X | | | | | | | X | | | | | | X |
47-
| ControlledGlossaryTerm | X | X | X | X | X | | | | | | X | | | | X | X | X |
48-
| GovernanceDefinition | X | | X | X | | | | | | | X | | | | X | X | X |
49-
| DigitalService | X | X | X | X | X | X | X | X | X | | X | | X | | X | X | X |
50-
| InformationSupplyChain | X | X | X | X | X | | | | | | X | | X | | X | X | X |
51-
| InformationSupplyChainSegment | X | X | X | X | X | | | | | | X | | X | | X | X | X |
52-
| SolutionComponent | X | X | X | X | X | | | | | | X | | X | | X | X | X |
53-
| SolutionPort | X | X | X | X | X | | | | | | X | | X | | X | X | X |
54-
| SolutionBlueprint | X | X | X | X | X | | | | | | X | | X | | X | X | X |
55-
56-
57-
58-
## Defining advanced lifecycles in new types
59-
60-
When new types are being defined with an advanced lifecycle, a list of valid instance status values is set into the type definition (TypeDef).
61-
62-
```java
63-
64-
ArrayList<InstanceStatus> validInstanceStatusList = new ArrayList<>();
65-
66-
validInstanceStatusList.add(InstanceStatus.DRAFT);
67-
validInstanceStatusList.add(InstanceStatus.PROPOSED);
68-
validInstanceStatusList.add(InstanceStatus.APPROVED);
69-
validInstanceStatusList.add(InstanceStatus.ACTIVE);
70-
validInstanceStatusList.add(InstanceStatus.DELETED);
71-
72-
entityDef.setValidInstanceStatusList(validInstanceStatusList);
73-
entityDef.setInitialStatus(InstanceStatus.DRAFT);
74-
75-
```
16+
This status is maintained by the open metadata repositories.
7617

18+
When a query is made to retrieve open metadata elements, only elements in ACTIVE status are returned. However, it is possible to request that elements that have been soft-deleted are returned using the `limitResultsByStatus` option. This is a list of status values, so if set to `[DELETED]`, only soft-deleted elements matching the query request are returned. Returning all known elements that match the query request is achieved by setting the `limitResultsByStatus` option to `[ACTIVE, DELETED]`.
7719

20+
The ability to retrieve soft-deleted elements is particularly useful for connectors trying to ascertain if a remote system has a new element, or one that we have seen before, but was deleted from the open metadata ecosystem. Depending on the ownership of the element, the element may be deleted from the remote system, or the catalog entry in open metadata is recreated.
7821

22+
--8<-- "snippets/abbr.md"

‎site/docs/guides/cts/index.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ The functions expected of an open metadata repository are numerous. These functi
4747
| [Metadata maintenance](/guides/cts/repository-workbench/profiles/metadata-maintenance) | The technology under test supports requests to create, update and purge metadata instances. |
4848
| [Effectivity dating](/guides/cts/repository-workbench/profiles/effectivity-dating) | The technology under test supports effectivity dating properties. |
4949
| [Dynamic types](/guides/cts/repository-workbench/profiles/dynamic-types) | The technology under test supports changes to the list of its supported types while it is running. |
50-
| [Graph queries](/guides/cts/repository-workbench/profiles/graph-queries) | The technology under test supports graph-like queries that return collections of metadata instances. |
5150
| [Historical search](/guides/cts/repository-workbench/profiles/historical-search) | The technology under test supports search for the state of the metadata instances at a specific time in the past. |
5251
| [Entity proxies](/guides/cts/repository-workbench/profiles/entity-proxies) | The technology under test is able to store stubs for entities to use on relationships when the full entity is not available. |
5352
| [Soft-delete and restore](/guides/cts/repository-workbench/profiles/soft-delete-restore) | The technology under test allows an instance to be soft-deleted and restored. |
@@ -90,8 +89,6 @@ This workbench runs the following profiles, in the following order:
9089
| [Relationship history retrieval](../performance-profiles/relationship-history-retrieval) | tests the performance of `getRelationship` (with non-null `asOfTime`) and `getRelationshipHistory` methods |
9190
| [Entity history search](../performance-profiles/entity-history-search) | tests the performance of the same search operations as Entity Search, but in each case with a non-null `asOfTime` |
9291
| [Relationship history search](../performance-profiles/relationship-history-search) | tests the performance of the same search operations as Relationship Search, but in each case with a non-null `asOfTime` |
93-
| [Graph queries](../performance-profiles/graph-perf-queries) | tests the performance of `getRelationshipsForEntity`, `getEntityNeighborhood`, `getRelatedEntities` and `getLinkingEntities` methods |
94-
| [Graph history queries](../performance-profiles/graph-history-queries) | tests the performance of the same operations as Graph Queries, but in each case with a non-null `asOfTime` |
9592
| [Entity re-home](../performance-profiles/entity-re-home) | tests the performance of `reHomeEntity` method |
9693
| [Relationship re-home](../performance-profiles/relationship-re-home) | tests the performance of `reHomeRelationship` method |
9794
| [Entity declassify](../performance-profiles/entity-declassify) | tests the performance of `declassifyEntity` and `purgeClassificationReferenceCopy` methods |

‎site/docs/guides/cts/performance-profiles/entity-history-search.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ The [Open Metadata Repository Services (OMRS)](/services/omrs) interface for a m
3232
| `repository-entity-search-history-performance-findEntitiesByProperty-any` | Repository performs historical search by two property values, sorting by the second property, of first page of instances of a type. |
3333
| `repository-entity-search-history-performance-findEntitiesByProperty-none` | Repository performs historical search by two property value, sorting by the first property, of first page of instances of a type. |
3434
| `repository-entity-history-retrieval-performance-findEntities` | See the detailed logic of the [entity retrieval](entity-retrieval.md) profile. |
35-
| `repository-graph-history-query-performance-findEntities` | See the detailed logic of the [graph history query](graph-history-queries.md) profile. |
3635

3736
!!! tip "Search variations"
3837
When `findEntitiesByProperty` is run by the assertions starting with `repository-entity-search-history-performance...`, the tests prefer non-string properties (if any exist for the type) given that the `findEntitiesByPropertyValue` searches will already heavily exercise string-based queries.

‎site/docs/guides/cts/performance-profiles/entity-search.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ The [Open Metadata Repository Services (OMRS)](/services/omrs) interface for a m
4343
| `repository-entity-retype-performance-findEntitiesByProperty` | See the detailed logic of the [entity retype](entity-retype.md) profile. |
4444
| `repository-entity-undo-performance-findEntities` | See the detailed logic of the [entity undo](entity-undo.md) profile. |
4545
| `repository-entity-update-performance-findEntitiesByProperty` | See the detailed logic of the [entity update](entity-update.md) profile. |
46-
| `repository-graph-query-performance-findEntities` | See the detailed logic of the [graph query](graph-query.md) profile. |
4746
| `repository-relationship-creation-performance-findEntities` | See the detailed logic of the [relationship creation](relationship-creation.md) profile. |
4847

4948
In addition, these tests will record into the Environment profile the `totalEntitiesFound`.

‎site/docs/guides/cts/performance-profiles/graph-history-queries.md‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)