Details
-
Improvement
-
Resolution: Done
-
Major
-
Data Standard v2.0
-
None
-
None
Description
Summary of outcomes for Data Standard 2.1
- Problem Addressed: Consistency of annotation for extended reference identity / lookup is not enforced.
- High-level Reasoning: A consistent pattern should be followed for annotation of identity / lookup in extended references.
- Changes Made: Used MetaEd to generate annotation using the following patterns:
When reference contains identity only: "Identity of a [Domain of the parent Reference Type]"
When reference contains identity and lookup:
Identity: "Encapsulates the possible attributes that can be used to lookup the identity of a/an [Domain of parent extended reference type]
Lookup: "Encapsulates alternative attributes that can be used to lookup the identity of a/an [Domain of parent extended reference type]
Original ticket description follows:
For consistency, propose the following patterns be the standard naming convention for elements of Extended Reference Types:
a. for Extended Reference Types that contain only an Identity child element, the annotation of the child element would read as "Identity of the [Domain of the parent Reference Type]". Some examples:
the annotation of the AcademicWeekReferenceType.AcademicWeekIdentity would read "Identity of the academic week."
the annotation of the CalendarDateReferenceType.CalendarDateIdentity would read as "Identity of the calendar date."
b. for the Extended Reference Types that contain both an identity child element and a lookup child element,
- the annotation of the identity child element would read as "Encapsulates primary attributes that can be used to lookup the identity of the [Domain of parent extended reference type]"
- whereas the annotation of the lookup child element would read as "Encapsulates alternative attributes that can be used to look up the identity of the [Domain of parent extended reference type]."
For example,
the annotation of the GradebookEntryReferenceType.GradebookEntryIdentity would read as "Encapsulates primary attributes that can be used to lookup the identity of the gradebook entry." and
the annotation of the GradebookEntryReferenceType.GradebookEntryLookup would read as "Encapsulates alternative attributes that can be used to lookup the identity of the gradebook entry."