| Tip |
|---|
This proposed functionality has not been implemented in Sample Data Generator. |
In light of the In The Weeds discussion on 4/23/2021, capturing here some additional documents and thoughts on the state of Sample Data Generator. Please note that these comments were derived from analysis towards the end of 2019 so they may be out-of-date.
...
EdFi.CalendarGenerator.Console Command Options
| Short Option | Long Option | Description | Required | Value |
|---|---|---|---|---|
| -t | -termType | Type of term used by school | Semester (default) No others currently supported | |
| -g | -gradingPeriodLength | Length (in weeks) of grading period. | Y | Must be either 6 or 9 |
| -s | -schoolStartDate | Date on which school year begins | Y | |
| -i | -schoolId | Id(s) of schools for which you want calendar data to be generated | (space separated) | |
| -f | schoolFile | Path to School.csv file that contains target School Ids | ||
| -w | -workDays | Number of teacher-only work days per grading period | 0 (default) | |
| -b | badWeatherDays | Number of bad weather days per grading period | 0 (default) | |
| -o | -outputPath | Path where output files will be stored | "" (default) |
Note: The included sample data has -outputPath set to "./EducationOrgCalendar".
...
EdFi.MasterScheduleGenerator.Console Command Options
| Short Option | Long Option | Description | Required | Value |
|---|---|---|---|---|
| -y | -schoolYear | School year to generate (in form 2016-2017) | Y | |
| -s | -schoolFile | Path to the School.csv | ".\\School.csv" (default) | |
| -c | -courseFile | Path to the Course.csv file | ".\\Course.csv" (default) | |
| -p | -classPeriodFile | Path to the ClassPeriod.csv file | ".\\ClassPeriod.csv" | |
| -l | -locationFile | Path to the Location file | ".\\Location.csv" | |
| -o | -outputPath | Path where output files should be written | ".\" (default) |
Produces:
- /MasterSchedule
- /CourseOffering.csv
- /Section.csv
...
The question becomes how is DataPeriod intended to be used by the SDG? Is the given example of a single school year, is this a simplistic representation of the actual school calendar which works for the intended use cases, or is it a misconfiguration that causes sub-optimal realistic data generation? We need to understand this since our scope of work is to enhance the school calendar to support multiple years.
The documentation for Data Periods states:
The SDG has the capability to simulate the passage of time through a given school year via the concept of data periods. At the most basic level, a data period is simply a period of time for which the SDG will generate and output data. Mutators, when present, run at the end of each data period.
Date period Name elements will be used when crafting output file names so that data can easily be grouped by time period for bulk loading. The most frequent use case is data periods which neatly align with school calendar periods such as grading periods, terms, or school years.
Also, in the SDG extension example:
- You'll place any business logic for generating one-time data into GenerateCore; logic for data that should be generated per data period should be placed in GenerateAdditiveData.
...