Next Release
Release 5.3 (April 2025)¶
These are DRAFT release notes. The notes will be updated until & when 5.3 is released
Open Metadata Types
- The ExternalId entity has a new attribute called externalInstanceTypeName to allow the capture of the type name of an instance from a third party system.
- A new entity type called SolutionActorRole allows new roles that interact with a solution to be modelled.
- A new relationship called SolutionComponentActor allows the Actors using a solution component to be identified.
- The SolutionComponent entity has a new attribute called solutionComponentType to allow the solution architect to distinguish between different types of components.
- The InformationSupplyChain relationship has a new attribute called label for use in lineage graphs.
- The SolutionLinkingWire relationship has new attributes label and description for use in lineage graphs.
- The FileSystem classification has new attributes canonicalMountPoint and localMountPoint for normalizing file path names in a heterogeneous open metadata ecosystem.
- A new relationship called DataMapping provides a dedicated relationship for fine-grained (column-level) lineage.
- Types GovernanceDomainDefinition, GovernanceDomainSet, GovernanceClassificationLevel, GovernanceClassificationSet, GovernanceStatusSet and GovernanceStatusLevel have been deprecated in favour of using standard valid metadata values.
- New types for describing data dictionaries and data specifications are available in models 0580 Data Dictionaries and 0581 Data Field Implementation.
- The definition for a data class and the relationships associated with them have been updated in model 0540 Data Classes.
- There is a new relationship called SemanticDefinition to allow glossary terms to be attached to data definitions to provide a semantic definition to the data definition.
- The CommentType has a new valid value of "REQUIREMENT".
- The ProjectCharter entity now has a display name.
- The Anchors has a new attribute called anchorScopeGUID. It is used to identify an element that scopes/groups/owns the anchor element. For example, a glossary term is is own anchor and its anchor scope GUID is its owning glossary. This attribute allows fast scope based searches.
- The GlossaryTerm has a new attribute called aliases. It is used to identify alternative names for the glossary term.
- The position attribute in the team roles (model 0119) has been renamed to positionName to avoid confusion with the integer position attribute found in various data/schema definitions.
- The position, minCardinality and maxCardinality attributes in the SchemaAttribute entity has been moved to the AttributeForSchema and NestedSchemaAttribute relationships to match the style of DataFields.
Cascaded Delete
A number of delete API operations support a boolean cascadedDelete option. This adds extra checks and functionality to delete requests.
The default value is false which means that the element can not be deleted if certain dependent elements are still attached. These elements are not typically anchored to this element but have an important relationship.
If cascadedDelete is true, the element can be deleted irrespective of its related elements. It may also delete some of these related elements along with its anchored elements.
The table below shows the specific behaviour for each affected open metadata type. Notice that setting cascadeDelete=true is a powerful option that can delete a lot of metadata - so use with care ...
| Type Name | cascadeDelete=false | cascadeDelete=true |
|---|---|---|
| Glossary | The delete will fail if the glossary is attached to either glossary terms or glossary categories via the TermAnchor or CategoryAnchor relationships, respectively. | The glossary will be deleted along with the glossary terms and glossary categories linked via the TermAnchor and CategoryAnchor relationships, respectively. |
| GlossaryCategory | The delete will fail if a glossary category has child categories linked via the CategoryHierarchyLink relationship. | The glossary category will be deleted along with the child glossary categories linked via the CategoryHierarchyLink relationship. |
| Comment | The delete will fail if a comment has child comments linked via the AttachedComment relationship. | The comment will be deleted along with the child comments linked via the AttachedComment relationship. |
| Collection | The delete will fail if a collection has member elements linked via the CollectionMembership relationship. | The collection will be deleted along with the member elements linked via the CollectionMembership relationship. |
| DataStructure | The delete will fail if a data structure has member data fields linked via the MemberDataField relationship. | The data structure will be deleted along with the member data fields linked via the MemberDataField relationship. |
| DataField | The delete will fail if a data field has nested data fields linked at end 2 via the NestedDataField relationship. | The data field will be deleted along with the nested data fields linked via the NestedDataField relationship. |
| DataClass | The delete will fail if the data class is attached to other data classes at end 2 via the DataClassHierarchy or DataClassComposition relationships. | The data class will be deleted along with the other data classes linked at end 2 via the DataClassHierarchy and DataClassComposition relationships. |
| Asset | The delete will fail if the asset is attached to other data sets at end 2 the DataSetContent relationship. | Processing determined by asset's specific type. |
| ITInfrastructure | The delete will fail if an IT infrastructure asset has assets linked at end 1 via the DeployedOn relationship. | The IT infrastructure asset will be deleted along with the assets linked via the DeployedOn relationship. |
| Database | The delete will fail if the database is attached to other deployed database schemas via the DataSetContent relationship. | The database will be deleted along with the deployed database schemas linked via the DataSetContent relationship. |
| FileFolder | The delete will fail if the folder is attached to either folders or files via the FolderHierarchy or NestedFile relationships, respectively. | The folder will be deleted along with the folders and files linked via the FolderHierarchy and NestedFile relationships, respectively. |
Implementation details
The rules for cascaded deletes are coded in the generic handlers. Specifically in method validateCascadedDelete in class OpenMetadataAPIGenericHandler. This means that the same delete logic runs regardless of the API call used to request the delete operation.
Updated View Service: Project Manager OMVS
The Project Manager OMVS now has a new call to retrieve a project with its dependent projects, resources and assigned people. This is supplied as nested JSON and also as a mermaid graph.
New View Service: Solution Architect OMVS
Solution Architect OMVS supports the management and querying of Information Supply Chains and Solution Components.
New View Service: Data Designer OMVS
Data Designer OMVS supports the management and querying of Data Structures, Data Fields and data classes.
New View Service: Classification Explorer OMVS
Classification Explorer OMVS supports enables the caller to issue queries to understand how metadata elements are linked and classified.
Increased resilience in error handling
Rename of Open Connector Framework Wrapper Beans
In order to distinguish the bean names used in the Open Connector Framework (OCF) from the beans used in the Open Metadata Framework (OMF), the Bean Wrapper classes of the OCF have been renamed as follows:
- ConnectionProperties -> ConnectionDetails
- ConnectorTypeProperties -> ConnectorTypeDetails
- EndpointProperties -> EndpointDetails
- EmbeddedConnectionProperties -> EmbeddedConnectionDetails
- RelatedAssetProperties -> RelatedAssetDetails
- ConnectedAssetProperties -> ConnectedAssetDetails
- VirtualConnectionProperties -> VirtualConnectionDetails
Reversal of open metadata relationship ends
The following relationships have had their ends reversed (ie what was end 1 is now end 2 and vice versa). This is to ensure the graph visualizations makes sense and to ensure that operations that use the anchor support (such as delete element) are able to reliably navigate to dependent elements by travelling from end1 to end2. The update is permitted because these relationships are not known to be in use. * AssetLocation * TeamLeadership * TeamMembership * PersonRoleAppointment * TeamRoleAppointment * ITRoleAppointment * Meetings * NoteLogAuthorship * GovernanceDefinitionScope * GovernedBy * GovernanceResponsibilityAssignment * GovernanceDefinitionMetric * SchemaTypeImplementation * DesignModelElementsInScope
The following relationships have been deprecated and replaced. The replacements have swapped ends for the same reasons as above. However, the deprecated relationships are currently in use and the new types allow elements using these relationships to still operate correctly, giving time to migrate them to the new relationships. * ConnectionToAsset replaced by AssetConnection * ConnectionEndpoint replaced by ConnectToEndpoint
Removal of deprecated types and attributes
As Egeria has developed over the years, the type system has also evolved. This has meant that some of the original types have been deprecated in favour of new types. At this point in time, none of the egeria code (either in the Java runtime, samples or python pyegeria libraries) and so this is a good time to slim down the type system by removing the deprecated types and attributes. The following has been removed:
- GovernanceDomainDescription
- GovernanceDomainSet
- GovernanceClassificationLevel
- GovernanceClassificationSet
- GovernanceStatusSet
- GovernanceStatusLevel
- HostLocation
- ContentManager
- NamingConventionRule
- RelationalColumnType
- RuntimeForProcess
- SoftwareServerPlatformDeployment
- DeployedVirtualContainer
- HostNetwork
- SoftwareServerDeployment
- TermISATypeOFRelationship
- GlossaryTermEvolution
- HostOperatingPlatform
- DataStoreEncoding
- PersonalContribution
- AssetServerUse
- ProcessInput
- SoftwareServerSupportedCapability
- SchemaTypeSnippet
- EngineActionExecutor
- TabularColumnType
- DesignModelElementOwnership
- ProcessOutput
- ProjectScope
- SimpleDocumentType
- DesignModelGroupOwnership
- DesignModelGroupHierarchy
- StructDocumentType
- MapDocumentType
- KnownDuplicateLink
- BoundedSchemaType
- ArraySchemaType
- SetSchemaType
- BoundedSchemaElementType
- ArrayDocumentType
- SetDocumentType
- GovernanceConfidentialityLevel
- SubjectAreaGovernance
- ZoneGovernance
- RelationalView
- DerivedSchemaAttribute
- SchemaQueryImplementation
- DerivedRelationalColumn
- SchemaLinkElement
- LinkedType
- SchemaLinkToType
- GovernanceRoleAssignment
- BusinessCapabilityControls
- DigitalServiceImplementation
- InformationSupplyChainImplementation
- SolutionComponentImplementation
- ResponsibilityStaffContact
- AssetOwnership
- GroupedMedia
- IsATypeOfRelationship
- DataContentForDataSet
- PrimaryCategory
- DataFieldValues
- ExternalGlossaryLink
- ExternallySourceGlossary
- LibraryCategoryReference
- LibraryTermReference