Versions Compared

Old Version 23

changes.mady.by.user Gabrielle Garonzik

Saved on

compared with

New Version 24

changes.mady.by.user Gabrielle Garonzik

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About Ed-Fi Tracker

TODO: Expand this section.

The Ed-Fi Alliance tracks issues and feature requests in JIRA. This allows the Ed-Fi Community to:

...

Expand
titleSubmit an Issue

Submit an Issue

Issues should be entered for bugs and enhancement requests for our core tech components. Questions can be posted to this forum.

Step-by-Step Guide

This section provides a walk through of submitting an issue to the Alliance.

  1. Select the project to which you want to submit your issue. See the article Technical Community Guidelines for a summary of projects and access requirements.
  2. Click the "Create" button.
  3. Select the Issue Type.

    We ask that you use the following issue types:
    • Bug - Bugs/defects you have found on the code.
    • Improvement - Suggested improvement or refactoring of the code for existing functionality.
    • Question - Request for how to information or best practices.
    • New Feature - New features with supporting use case.
  4. Enter following information:
    • Summary. A brief description of the issue.
    • Fix Version/s. The specific version, if any, affected by the issue.
    • Issue Description. Be detailed.
      • For bugs, please include the steps to reproduce the bug.
      • For improvements and questions, please include use case details.
      • For new feature requests, please include additional details of the user story (details below).
    • Attachments. Attach any screen shots and/or code that can add clarity to the issue.

Issues are assigned to the core technical team project lead. The project lead is the point of contact for code reviews and responsible for integrating pull request submissions into the Ed-Fi core code base.

...

Best Practices and Clarification

Info

TODO: Insert an example of a ticket that is requesting the best way to store data elements. How to record multiple course parts in the StudentAcademicRecord and CourseTranscript is an example of this.

Reporting a Bug

TODO: Insert an example of a ticket that is requesting a fix for data that is currently included in the data standard. The StudentProgramAttendanceEvent needing a StudentProgramAssociation is an example of this. StartTime and EndTime for CalendarDate is another.

New Feature Request

...

Summary: As a school administrator, I want to know the best way to record a student's credits to the course transcript for a course that has multiple parts.

Issue Type: Question

Fix Version/s: v3.0

Description: I would like to know how to properly record data around courses with multiple parts and student credits. Specifically, I need to address the following use cases:

  • Use Case 1 - A student was enrolled in a course with two parts offered in the Fall and Spring, passed both semesters, and earned credits for both course parts.
  • Use Case 2 - A student was enrolled in a course with two parts offered in the Fall and Spring, failed the first semester and passed the second semester, and earned credits for both course parts.
  • Use Case 3 - A student was enrolled in a course with two parts offered in the Fall and Spring, failed the first semester and passed the second semester, and earned credits for ONLY the second course part.
  • Use Case 4 - A student was enrolled in a course with two parts offered in the Fall and Spring, failed both semesters, and did not earn any credits.

Reporting a Bug

Info

Summary: StudentProgramAttendanceEvent can have records without a corresponding StudentProgramAssociation.

Issue Type: Bug

Fix Version/s: v2.0, v2.2, v3.0, v3.1

Description: It has come to our attention that because the StudentProgramAttendanceEvent has separate references for Student, Program, and EducationOrganization, that an attendance event record can be created without the student having a StudentProgramAssociation record. Unless there is a use case where this would be necessary, we would recommend replacing the three separate references with a single StudentProgramAssociation reference instead.

New Feature Request

Info

Summary: As a SIS vendor, I would like to request an Enrollment/Membership type on the StudentSchoolAssociation to accommodate state implementation requirements.

Issue Type: New Feature

Fix Version/s: v3.1

Description: A handful of state implementations record additional information on student enrollment/membership beyond knowing which school is the PrimarySchool for the student. We come across this need repeatedly in the field and would like to standardize how and where the information is recorded. Adding a EnrollmentTypeDescriptor with the most commonly recorded values as part of core would remove the need for extensions across multiple implementations and provide the flexibility to add custom descriptor values.