CIM Issues #5066
Address issues with the Names classes construct introduced as of CIM15
Status:
Closed
Priority:
Normal
Author/Contact Info:
Todd Viegut
Base Release:
CIM17
Solution to be Applied To:
CIM18
Solution Version:
CIM18v00
Solution Applied By:
Todd Viegut
Completion Date:
08/06/2021
CIM Keywords:
Breaking Change:
Yes
Breaking Change Description:
NameTypeAuthority class was removed and association role ends renamed.
CIM Impacted Groups:
WG13
Requestor:
Standard(s):
Version:
Clause:
Sub-Clause:
Paragraph:
Table:
Originally Closed in Version:
CIM18
Origination Date:
08/06/2021
Origination ID:
13_320
Originally Assigned To:
Description
There are issues with the existing Names class constructs that we have agreed to address in CIM18.
Proposed Solution
Proposed changes:
- Add a new association i.e. Name (0..n) --> IdentifiedObject (0..1) to handle alternative identifiers distinct and different from alternate names (i.e using the existing association).
- Add new class ObjectType and corresponding association ObjectType (0..1) --> IdentifiedObject (0..n)
- Add a type attribute to the class - Add new class NamingAuthority to replace NameTypeAuthority (which should be deleted).
- Add description , mRID , and name attributes to the class - Add the following attributes to existing classes:
- Add language and mRID attributes to the Name class
- Add mRID attribute to the NameType class
Decision
Upon UCA UML Joint team review we have approved the changes proposed.
Release Notes
The following changes were applied to CIM18 to address insufficiency in the existing Names construct in the 61970 package:
- Add a new association i.e. Name (0..n) --> IdentifiedObject (0..1) to handle alternative identifiers distinct and different from alternate names (i.e using the existing associatoin).
- Added a new class ObjectType to the Core package
- Added attribute type to the ObjectType class
- Added a new association ObjectType (0..1) --> IdentifiedObject (0..n)
- Added a new class NamingAuthority to replace NameTypeAuthority which was also deleted (a breaking change).
- Add description , mRID , and name attributes to this new class
- Added a new association NameType (0..n) --> NamingAuthority (0..1)
- Added a new association Name (0..n) --> NamingAuthority (0..1)
- Added the following attributes to existing classes:
- Added language and mRID attributes to the existing Name class
- Added mRID attribute to the NameType class
- Added a new association between the existing Name and IdentifiedObject classes with the following role end names and cardinality:
- AlternativeIdentifier (0..n) --> UniqueIdentifiedObject (0..1)
- Renamed the role end name for the existing Name --> IdentifiedObject associations. Changed it from it's plural form (i.e. Names) to its singular form. This to conform with formal CIM modeling guidelines
Updated by Todd Viegut over 2 years ago
- Subject changed from There are issues with the existing Names class constructs t to There are issues with the existing Names class constructs
- Proposed Solution updated (diff)
Updated by Todd Viegut over 2 years ago
- Breaking Change changed from No to Yes
- Breaking Change Description set to Classes were removed and association role ends renamed.
- Decision updated (diff)
Updated by Todd Viegut over 2 years ago
- Breaking Change Description changed from Classes were removed and association role ends renamed. to NameTypeAuthority class was removed and association role ends renamed.
Updated by Todd Viegut over 2 years ago
- Subject changed from There are issues with the existing Names class constructs to Address issues with the Names classes construct introduced as of CIM15
Updated by Todd Viegut over 2 years ago
- Solution to be Applied To changed from 61970cim18 to CIM18