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 identity and lookup child elements is not enforced.
- High-level Reasoning: In some cases, the annotation for a child element of an identity or lookup follows the same pattern as that of the child element itself within the parent entity. In other cases, a unique annotation is used. A consistent pattern should be followed for annotation of identity / lookup child elements. For example, the annotation for StudentGradebookEntry.GradebookEntryReference.GradebookEntryIdentity.SectionReference should match the annotation for GradebookEntry.SectionReference.
- Changes Made: Used Metaed to generate annotation of the child elements of an identity or lookup to exactly reflect the annotation of the child element itself within the parent entity (Example: The annotation of GradebookEntry.SectionReference is used in every case in which Section is referenced as part of a GradebookEntry identity or lookup)
Original ticket description follows:
For consistency, for Identity child elements and Lookup child elements, the annotation will be pulled directly from the Domain.Child element annotation. Some examples:
the annotation of the GradebookEntryReferenceType.GradebookEntryIdentity.SectionReference would read as "The Section associated with the GradebookEntry." which is the annotation from the GradebookEntry.SectionReference element
the annotation of the GradebookEntryReferenceType.GradebookLookup.SectionReference would read as "The Section associated with the GradebookEntry." which is also the annotation from the GradebookEntry.SectionReference element
the annotation of the GradebookEntryReferenceType.GradebookLookup.GradebookEntryType would read as "The type of the GradebookEntry: for example, homework, assignment, quiz, unit test, oral presentation, etc." which is the annotation from the GradebookEntry.GradebookEntryType element
This pattern supports the MetaEd generation for annotations of Identity and Lookup child elements. This pattern also ensures consistent annotation across the child elements of Domain/Association and related Identity/Lookup child elements.