From ef1d1ad7c486e7dd5fbda8c05ed7bfe2a5b04f8b Mon Sep 17 00:00:00 2001 From: Steven Arnold <48261255+stevenarnold-ed-fi@users.noreply.github.com> Date: Mon, 10 Jun 2024 14:48:14 +0000 Subject: [PATCH] [DATASTD-2173] - Path domain (#99) * Update plan to pathway * Updating pathway to path after internal conversations * Update Path.metaed * Update build-model.yml --- .github/workflows/build-model.yml | 12 ++++++------ ...metaed => PathMilestoneStatusEvent.metaed} | 10 +++++----- ...ent.metaed => PathPhaseStatusEvent.metaed} | 6 +++--- Descriptor/PathMilestoneStatus.metaed | 3 +++ ...neType.metaed => PathMilestoneType.metaed} | 4 ++-- ...seStatus.metaed => PathPhaseStatus.metaed} | 2 +- Descriptor/PlanMilestoneStatus.metaed | 3 --- DomainEntity/{Plan.metaed => Path.metaed} | 10 +++++----- ...nMilestone.metaed => PathMilestone.metaed} | 19 ++++++++++--------- DomainEntity/PathPhase.metaed | 18 ++++++++++++++++++ DomainEntity/PlanPhase.metaed | 19 ------------------- ...{StudentPlan.metaed => StudentPath.metaed} | 12 ++++++------ .../StudentPathMilestoneStatus.metaed | 19 +++++++++++++++++++ ...s.metaed => StudentPathPhaseStatus.metaed} | 16 ++++++++-------- .../StudentPlanMilestoneStatus.metaed | 18 ------------------ Interchange/Path.metaed | 11 +++++++++++ Interchange/Plan.metaed | 11 ----------- ...neCode.metaed => PathMilestoneCode.metaed} | 4 ++-- ...neName.metaed => PathMilestoneName.metaed} | 2 +- Shared/PathName.metaed | 4 ++++ Shared/PathPaseName.metaed | 4 ++++ Shared/PlanName.metaed | 4 ---- Shared/PlanPaseName.metaed | 4 ---- 23 files changed, 108 insertions(+), 107 deletions(-) rename Common/{PlanMilestoneStatusEvent.metaed => PathMilestoneStatusEvent.metaed} (72%) rename Common/{PlanPhaseStatusEvent.metaed => PathPhaseStatusEvent.metaed} (78%) create mode 100644 Descriptor/PathMilestoneStatus.metaed rename Descriptor/{PlanMilestoneType.metaed => PathMilestoneType.metaed} (62%) rename Descriptor/{PlanPhaseStatus.metaed => PathPhaseStatus.metaed} (77%) delete mode 100644 Descriptor/PlanMilestoneStatus.metaed rename DomainEntity/{Plan.metaed => Path.metaed} (76%) rename DomainEntity/{PlanMilestone.metaed => PathMilestone.metaed} (51%) create mode 100644 DomainEntity/PathPhase.metaed delete mode 100644 DomainEntity/PlanPhase.metaed rename DomainEntity/{StudentPlan.metaed => StudentPath.metaed} (63%) create mode 100644 DomainEntity/StudentPathMilestoneStatus.metaed rename DomainEntity/{StudentPlanPhaseStatus.metaed => StudentPathPhaseStatus.metaed} (65%) delete mode 100644 DomainEntity/StudentPlanMilestoneStatus.metaed create mode 100644 Interchange/Path.metaed delete mode 100644 Interchange/Plan.metaed rename Shared/{PlanMilestoneCode.metaed => PathMilestoneCode.metaed} (53%) rename Shared/{PlanMilestoneName.metaed => PathMilestoneName.metaed} (71%) create mode 100644 Shared/PathName.metaed create mode 100644 Shared/PathPaseName.metaed delete mode 100644 Shared/PlanName.metaed delete mode 100644 Shared/PlanPaseName.metaed diff --git a/.github/workflows/build-model.yml b/.github/workflows/build-model.yml index 198b4d5..f412c10 100644 --- a/.github/workflows/build-model.yml +++ b/.github/workflows/build-model.yml @@ -6,23 +6,23 @@ on: inputs: data_model_version: type: string - description: "data_model_version: The data standard version corresponding to the Ed-Fi Model branch. Default: 5.0.0" + description: "data_model_version: The data standard version corresponding to the Ed-Fi Model branch. Default: 5.1.0" ODS_version: type: string - description: "ODS_version: The Ed-Fi ODS/API version corresponding to the Ed-Fi Model branch. Default: 7.1" + description: "ODS_version: The Ed-Fi ODS/API version corresponding to the Ed-Fi Model branch. Default: 7.2" tpdm_version: type: string description: "tpdm_version: The TPDM version being built. Default: 1.2.0" ed_fi_model_ref: type: string - description: "ed_fi_model_ref: The reference name from the Ed-Fi Model repo to pull. Default: DS-5.0-ME-3.x" + description: "ed_fi_model_ref: The reference name from the Ed-Fi Model repo to pull. Default: DS-5.1-ME-3.x" pull_request: env: - data_model_version: "5.0.0" - ODS_version: "7.1" + data_model_version: "5.1.0" + ODS_version: "7.2" tpdm_version: "1.2.0" - ed_fi_model_ref: "DS-5.0-ME-3.x" + ed_fi_model_ref: "DS-5.1-ME-3.x" node_version: "18" jobs: diff --git a/Common/PlanMilestoneStatusEvent.metaed b/Common/PathMilestoneStatusEvent.metaed similarity index 72% rename from Common/PlanMilestoneStatusEvent.metaed rename to Common/PathMilestoneStatusEvent.metaed index e883bf7..5a41098 100644 --- a/Common/PlanMilestoneStatusEvent.metaed +++ b/Common/PathMilestoneStatusEvent.metaed @@ -1,10 +1,10 @@ -Common PlanMilestoneStatusEvent +Common PathMilestoneStatusEvent documentation "An event recongnizing the change in status for the milestone" - descriptor PlanMilestoneStatus - documentation "The student's status associated with the plan milestone." + descriptor PathMilestoneStatus + documentation "The student's status associated with the Path milestone." is part of identity - date PlanMilestoneStatusDate - documentation "The month, day and year associated with the change in the plan milestone status." + date PathMilestoneStatusDate + documentation "The month, day and year associated with the change in the path milestone status." is part of identity shared string EdFi.Description documentation "Additional information associated with the milestone status achieved." diff --git a/Common/PlanPhaseStatusEvent.metaed b/Common/PathPhaseStatusEvent.metaed similarity index 78% rename from Common/PlanPhaseStatusEvent.metaed rename to Common/PathPhaseStatusEvent.metaed index 878e72a..fc41414 100644 --- a/Common/PlanPhaseStatusEvent.metaed +++ b/Common/PathPhaseStatusEvent.metaed @@ -1,8 +1,8 @@ -Common PlanPhaseStatusEvent +Common PathPhaseStatusEvent documentation "An event recongnizing the change in status for the phase" - descriptor PlanPhaseStatus + descriptor PathPhaseStatus documentation "The student's status associated with entering or completing the phase" is part of identity - date PlanPhaseStatusDate + date PathPhaseStatusDate documentation "The month, day and year on which the status was achieved for the phase" is part of identity diff --git a/Descriptor/PathMilestoneStatus.metaed b/Descriptor/PathMilestoneStatus.metaed new file mode 100644 index 0000000..7726823 --- /dev/null +++ b/Descriptor/PathMilestoneStatus.metaed @@ -0,0 +1,3 @@ +Descriptor PathMilestoneStatus + documentation "The student's status associated with the path milestone." + diff --git a/Descriptor/PlanMilestoneType.metaed b/Descriptor/PathMilestoneType.metaed similarity index 62% rename from Descriptor/PlanMilestoneType.metaed rename to Descriptor/PathMilestoneType.metaed index 54bb447..2ce87d0 100644 --- a/Descriptor/PlanMilestoneType.metaed +++ b/Descriptor/PathMilestoneType.metaed @@ -1,2 +1,2 @@ -Descriptor PlanMilestoneType - documentation "The type of milestone defined for the student's plan." +Descriptor PathMilestoneType + documentation "The type of milestone defined for the student's path." diff --git a/Descriptor/PlanPhaseStatus.metaed b/Descriptor/PathPhaseStatus.metaed similarity index 77% rename from Descriptor/PlanPhaseStatus.metaed rename to Descriptor/PathPhaseStatus.metaed index 4c8d640..5bd9d08 100644 --- a/Descriptor/PlanPhaseStatus.metaed +++ b/Descriptor/PathPhaseStatus.metaed @@ -1,2 +1,2 @@ -Descriptor PlanPhaseStatus +Descriptor PathPhaseStatus documentation "The student's status associated with entering or completing the phase." diff --git a/Descriptor/PlanMilestoneStatus.metaed b/Descriptor/PlanMilestoneStatus.metaed deleted file mode 100644 index 709e45c..0000000 --- a/Descriptor/PlanMilestoneStatus.metaed +++ /dev/null @@ -1,3 +0,0 @@ -Descriptor PlanMilestoneStatus - documentation "The student's status associated with the plan milestone." - diff --git a/DomainEntity/Plan.metaed b/DomainEntity/Path.metaed similarity index 76% rename from DomainEntity/Plan.metaed rename to DomainEntity/Path.metaed index 877c072..b34d481 100644 --- a/DomainEntity/Plan.metaed +++ b/DomainEntity/Path.metaed @@ -1,11 +1,11 @@ -Domain Entity Plan +Domain Entity Path documentation "A scheme for achieving milestones organized by phases for students to follow and be tracked against." domain entity EdFi.EducationOrganization - documentation "A reference to the Education Organization associated with the plan." + documentation "A reference to the Education Organization associated with the path." is part of identity - shared string PlanName - documentation "The name of the plan." + shared string PathName + documentation "The name of the path." is part of identity domain entity EdFi.GraduationPlan - documentation "The graduation plan associated with this plan." + documentation "The graduation plan associated with this path." is optional diff --git a/DomainEntity/PlanMilestone.metaed b/DomainEntity/PathMilestone.metaed similarity index 51% rename from DomainEntity/PlanMilestone.metaed rename to DomainEntity/PathMilestone.metaed index 0669782..a156644 100644 --- a/DomainEntity/PlanMilestone.metaed +++ b/DomainEntity/PathMilestone.metaed @@ -1,15 +1,16 @@ -Domain Entity PlanMilestone - documentation "A significant event or achievement as part of a plan." - shared string PlanMilestoneName +Domain Entity PathMilestone + documentation "A significant event or achievement as part of a path." + shared string PathMilestoneName documentation "The descriptive name of the milestone." is part of identity - descriptor PlanMilestoneType - documentation "The type of milestone defined for the student's plan." + descriptor PathMilestoneType + documentation "The type of milestone defined for the student's path." is part of identity - shared string PlanMilestoneCode - documentation "The code or identifier associated with an element associated with the plan milestone (e.g., course, certification, etc)" + shared string PathMilestoneCode + documentation "The code or identifier associated with an element associated with the path milestone (e.g., course, certification, etc)" is optional + role name PathMilestoneCode shared string EdFi.Description - documentation "Additional information describing the plan's milestone to be achieved." + documentation "Additional information describing the path's milestone to be achieved." is optional - role name PlanMilestone + role name PathMilestone diff --git a/DomainEntity/PathPhase.metaed b/DomainEntity/PathPhase.metaed new file mode 100644 index 0000000..28d6eb3 --- /dev/null +++ b/DomainEntity/PathPhase.metaed @@ -0,0 +1,18 @@ +Domain Entity PathPhase + documentation "A stage in the process of a student achieving milestones." + domain entity Path + documentation "A reference to the path associated with the phase." + is part of identity + shared string PathPhaseName + documentation "The name of the phase associated with the path." + is part of identity + integer PathPhaseSequence + documentation "Indicates the number in order, starting with 1, that the phases are organized into." + is optional + shared string EdFi.Description + documentation "Additional information describing the path's phase" + is optional + role name PhasePath + domain entity PathMilestone + documentation "A reference to the path milestones associated with this phase" + is optional collection \ No newline at end of file diff --git a/DomainEntity/PlanPhase.metaed b/DomainEntity/PlanPhase.metaed deleted file mode 100644 index 2978d1a..0000000 --- a/DomainEntity/PlanPhase.metaed +++ /dev/null @@ -1,19 +0,0 @@ -Domain Entity PlanPhase - documentation "A stage in the process of a student achieving milestones." - domain entity Plan - documentation "A reference to the plan associated with the phase." - is part of identity - shared string PlanPhaseName - documentation "The name of the phase associated with the plan." - is part of identity - integer PlanPhaseSequence - documentation "Indicates the number in order, starting with 1, that the phases are organized into." - is optional - shared string EdFi.Description - documentation "Additional information describing the plan's phase" - is optional - role name PhasePlan - domain entity PlanMilestone - documentation "A reference to the plan milestones associated with this phase" - is optional collection - role name PlanPhasePlan \ No newline at end of file diff --git a/DomainEntity/StudentPlan.metaed b/DomainEntity/StudentPath.metaed similarity index 63% rename from DomainEntity/StudentPlan.metaed rename to DomainEntity/StudentPath.metaed index bb64264..cb70bd3 100644 --- a/DomainEntity/StudentPlan.metaed +++ b/DomainEntity/StudentPath.metaed @@ -1,11 +1,11 @@ -Domain Entity StudentPlan - documentation "The entity representing the association or assignment of the student to the plan being pursued." +Domain Entity StudentPath + documentation "The entity representing the association or assignment of the student to the path being pursued." domain entity EdFi.Student - documentation "A reference to the student associated with the plan." + documentation "A reference to the student associated with the path." is part of identity - domain entity Plan - documentation "A reference to the plan associated with or assigned to the student." + domain entity Path + documentation "A reference to the path associated with or assigned to the student." is part of identity common EdFi.Period - documentation "The time periods for which the student was assigned and pursing the plan." + documentation "The time periods for which the student was assigned and pursing the path." is optional collection diff --git a/DomainEntity/StudentPathMilestoneStatus.metaed b/DomainEntity/StudentPathMilestoneStatus.metaed new file mode 100644 index 0000000..b8ee4f1 --- /dev/null +++ b/DomainEntity/StudentPathMilestoneStatus.metaed @@ -0,0 +1,19 @@ +Domain Entity StudentPathMilestoneStatus + documentation "The status of the student's achievement of the path milestone." + domain entity StudentPath + documentation "A reference to the student's path assignment or association." + is part of identity + domain entity PathMilestone + documentation "A reference to the PathMilestone against which the status is being recorded." + is part of identity + bool CompletionIndicator + documentation "Indicator on whether the student has completed the path milestone." + is optional + common PathMilestoneStatusEvent + documentation "The student's milestone status and the date of the status change." + is optional + domain entity PathPhase + documentation "The phase in time when the milestone status was achieved." + is optional + merge PathPhase.Path.PathName with StudentPath.Path.PathName // comment this out and add the role name and code gen works + diff --git a/DomainEntity/StudentPlanPhaseStatus.metaed b/DomainEntity/StudentPathPhaseStatus.metaed similarity index 65% rename from DomainEntity/StudentPlanPhaseStatus.metaed rename to DomainEntity/StudentPathPhaseStatus.metaed index a066745..14cef1f 100644 --- a/DomainEntity/StudentPlanPhaseStatus.metaed +++ b/DomainEntity/StudentPathPhaseStatus.metaed @@ -1,16 +1,16 @@ -Domain Entity StudentPlanPhaseStatus - documentation "The status of the student's association with the plan's phase." - domain entity StudentPlan - documentation "A reference to the student's plan assignment or association." +Domain Entity StudentPathPhaseStatus + documentation "The status of the student's association with the path's phase." + domain entity StudentPath + documentation "A reference to the student's path assignment or association." is part of identity - merge StudentPlan.Plan.PlanName with PlanPhase.Plan.PlanName - domain entity PlanPhase + merge StudentPath.Path.PathName with PathPhase.Path.PathName + domain entity PathPhase documentation "A reference to the phase in time associated with the status." is part of identity bool CompletionIndicator - documentation "Indicator on whether the student has completed the phase associated with the plan." + documentation "Indicator on whether the student has completed the phase associated with the path." is optional - common PlanPhaseStatusEvent + common PathPhaseStatusEvent documentation "The student's phase status and the date of the status change." is optional collection common EdFi.Period diff --git a/DomainEntity/StudentPlanMilestoneStatus.metaed b/DomainEntity/StudentPlanMilestoneStatus.metaed deleted file mode 100644 index 2069c63..0000000 --- a/DomainEntity/StudentPlanMilestoneStatus.metaed +++ /dev/null @@ -1,18 +0,0 @@ -Domain Entity StudentPlanMilestoneStatus - documentation "The status of the student's achievement of the plan milestone." - domain entity StudentPlan - documentation "A reference to the student's plan assignment or association." - is part of identity - merge StudentPlan.Plan.PlanName with PlanPhase.Plan.PlanName - domain entity PlanMilestone - documentation "A reference to the PlanMilestone against which the status is being recorded." - is part of identity - bool CompletionIndicator - documentation "Indicator on whether the student has completed the plan milestone." - is optional - common PlanMilestoneStatusEvent - documentation "The student's milestone status and the date of the status change." - is optional collection - domain entity PlanPhase - documentation "The phase in time when the milestone status was achieved." - is optional \ No newline at end of file diff --git a/Interchange/Path.metaed b/Interchange/Path.metaed new file mode 100644 index 0000000..ab1de6c --- /dev/null +++ b/Interchange/Path.metaed @@ -0,0 +1,11 @@ +Interchange Path + + documentation "This interchange defines Paths and all their identifying information" + + domain entity EdFi.Student + domain entity Path + domain entity PathMilestone + domain entity PathPhase + domain entity StudentPath + domain entity StudentPathMilestoneStatus + domain entity StudentPathPhaseStatus diff --git a/Interchange/Plan.metaed b/Interchange/Plan.metaed deleted file mode 100644 index 3bd1d93..0000000 --- a/Interchange/Plan.metaed +++ /dev/null @@ -1,11 +0,0 @@ -Interchange Plan - - documentation "This interchange defines Plans and all their identifying information" - - domain entity EdFi.Student - domain entity Plan - domain entity PlanMilestone - domain entity PlanPhase - domain entity StudentPlan - domain entity StudentPlanMilestoneStatus - domain entity StudentPlanPhaseStatus diff --git a/Shared/PlanMilestoneCode.metaed b/Shared/PathMilestoneCode.metaed similarity index 53% rename from Shared/PlanMilestoneCode.metaed rename to Shared/PathMilestoneCode.metaed index f784667..242bb3a 100644 --- a/Shared/PlanMilestoneCode.metaed +++ b/Shared/PathMilestoneCode.metaed @@ -1,4 +1,4 @@ -Shared String PlanMilestoneCode - documentation "The code or identifier associated with an element associated with the plan milestone (e.g., course, certification, etc)" +Shared String PathMilestoneCode + documentation "The code or identifier associated with an element associated with the path milestone (e.g., course, certification, etc)" min length 1 max length 60 diff --git a/Shared/PlanMilestoneName.metaed b/Shared/PathMilestoneName.metaed similarity index 71% rename from Shared/PlanMilestoneName.metaed rename to Shared/PathMilestoneName.metaed index 059724f..b03a063 100644 --- a/Shared/PlanMilestoneName.metaed +++ b/Shared/PathMilestoneName.metaed @@ -1,4 +1,4 @@ -Shared String PlanMilestoneName +Shared String PathMilestoneName documentation "The name for the milestone" min length 0 max length 60 \ No newline at end of file diff --git a/Shared/PathName.metaed b/Shared/PathName.metaed new file mode 100644 index 0000000..95fa8b8 --- /dev/null +++ b/Shared/PathName.metaed @@ -0,0 +1,4 @@ +Shared String PathName + documentation "The name for the path associated with path milestones" + min length 0 + max length 60 \ No newline at end of file diff --git a/Shared/PathPaseName.metaed b/Shared/PathPaseName.metaed new file mode 100644 index 0000000..05bcb6a --- /dev/null +++ b/Shared/PathPaseName.metaed @@ -0,0 +1,4 @@ +Shared String PathPhaseName + documentation "The name for the path associated with path milestones" + min length 0 + max length 60 \ No newline at end of file diff --git a/Shared/PlanName.metaed b/Shared/PlanName.metaed deleted file mode 100644 index c337040..0000000 --- a/Shared/PlanName.metaed +++ /dev/null @@ -1,4 +0,0 @@ -Shared String PlanName - documentation "The name for the plan associated with plan milestones" - min length 0 - max length 60 \ No newline at end of file diff --git a/Shared/PlanPaseName.metaed b/Shared/PlanPaseName.metaed deleted file mode 100644 index c39c1bd..0000000 --- a/Shared/PlanPaseName.metaed +++ /dev/null @@ -1,4 +0,0 @@ -Shared String PlanPhaseName - documentation "The name for the plan associated with plan milestones" - min length 0 - max length 60 \ No newline at end of file