[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

@@ -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:  

Common/PlanMilestoneStatusEvent.metaed → 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."

Common/PlanPhaseStatusEvent.metaed → 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

Descriptor/PathMilestoneStatus.metaed

@@ -0,0 +1,3 @@
+Descriptor PathMilestoneStatus
+    documentation "The student's status associated with the path milestone."
+

Descriptor/PlanMilestoneType.metaed → 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."

Descriptor/PlanPhaseStatus.metaed → Descriptor/PathPhaseStatus.metaed

@@ -1,2 +1,2 @@
-Descriptor PlanPhaseStatus
+Descriptor PathPhaseStatus
     documentation "The student's status associated with entering or completing the phase."

DomainEntity/Plan.metaed → 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

DomainEntity/PlanMilestone.metaed → 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

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

DomainEntity/StudentPlan.metaed → 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

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
+

DomainEntity/StudentPlanPhaseStatus.metaed → 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

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

Shared/PlanMilestoneCode.metaed → 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

Shared/PlanMilestoneName.metaed → 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

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

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