academicSessions.csv

ManageBac Academic Sets — comprised of Academic Years and their associated Academic Terms — are represented in the academicSessions.csv file. This custom specification allows these entities to be specified in one file to satisify functional requirements.

Column Order and Optionality

The columns of the academicSessions.csv file must be in the following order:

	Column Name	Required?	Can be blank?	Explanation
1	sourcedId	yes	no	Required by OneRoster
2	status	yes	must be blank for bulk, must be populated for delta	Follows OneRoster convention
3	dateModified	yes	must be blank for bulk, must be populated for delta	Follows OneRoster convention
4	title	yes	no	Required by OneRoster
5	type	yes	no	Required by OneRoster
6	startDate	yes	no	Required by OneRoster
7	endDate	yes	no	Required by OneRoster
8	parentSourcedId	yes	yes	Required by MB for type -> term
9	schoolYear	yes	yes	Required by OR, but can be blank as it is ignored
10	metadata.managebac.orgSourcedId	yes	no	Required by MB. The value must be a sourcedId of the org of type -> ext:program

Relational Columns

Given that ManageBac's Academic Years must have at least one Academic Term, this file uses a combination of the type and the parentSourcedId columns to express the relationship. In addition, ManageBac requires that a year and associated terms be associated to a Program. The following required relational columns describe these relationships:

Column Name	Description	Example Values
sourcedId	Uniquely identifies the record	Used referentially
type	The kind of academic session	"year" | "term" | "semester"
parentSourcedId	Refers to the parent organization	"zxc-ksdf_org_1"
metadata.managebac.orgSourcedId	Associated to org of type ext:program	"xcv-zxc_org_1_diploma"

The type column can take three possible values that ManageBac supports:

Value	Description
schoolYear	A collection of terms
term	A date range for when classes are scheduled
semester	A synonym for "term".

Import Validations

• A row whose type -> schoolYear must have a blank parentSourcedId

• There must be at least one type -> term row for every type -> schoolYear row that is associated via parentSourcedId.

• There must be one row type -> schoolYear for each type => ext:program in orgs.csv

• Rows of type -> schoolYear must have startDate and endDate that fall within range the ManageBac's calendar for the Program resolved by metadata.managebac.orgSourcedId. The corresponding startDate and endDate of associated type -> terms must also fall within range of the same Program.

• All type -> schoolYear and type -> terms that are associated with each other, via the parentSourcedId column for type -> term rows constitute a ManageBac Academic Set. They must all resolve to the same type -> ext:program in orgs.csv via metadata.managebac.orgSourcedId.

• The startDate and endDate of an Academic Set cannot overlap each other.

  • Can the endDate = next startDate?

Export behavior

• A row of type -> schoolYear for each Program with a blank parentSourcedId

• A type -> term row for each Academic Term in each Program, associated to the parent type -> schoolYear row, comprising a ManageBac Academic Set.

• Each row belonging to the same Academic Set's metadata.managebac.orgSourcedId resolves to the same type -> ext:program row in orgs.csv.

Core Columns

Description of the columns for core columns for term and schoolYear rows:

Column Name	Description	On Import
title	The name of the record	Ignored, may be blank
startDate	When the term begins	Helps to match on existing records
endDate	When the term ends (the last day of term)	Helps to match on existing records

Import Validations

• Every row must have a sourcedId that uniquely identifies the row

• The startDate must be prior to endDate

Export behavior

For each enabled Program, the associated academic year and child academic terms are exported.

Non-core Columns

Column Name	Description	On Import
schoolYear	The year of the last academic term of the current academic year	Ignored

The following columns values depend on the import or export mode:

Column Name	Bulk	Delta
status	Must be present but emtpy	Must be present and either "active" or "tobedeleted"
dateLastModified	Must be present but empty	Must be present and a date

Example file

sourcedId	status	dateLastModified	title	type	startDate	endDate	parentSourcedId	schoolYear	metadata.managebac.orgSourcedId
9bbd...d4e0			August 2018 – July 2019	schoolYear	2018-08-01	2019-07-31		2019	6a9d...2d8f_myp
4a18...ccf02			First Term	term	2018-08-01	2018-12-31	9bbd...d4e0	2019	6a9d...2d8f_myp
2693...613f			Second Term	term	2019-01-01	2019-07-31	9bbd...d4e0	2019	6a9d...2d8f_myp
d895...f35f			August 2018 – July 2019	schoolYear	2018-08-01	2019-07-31		2019	6a9d...2d8f_diploma
3099...fff8c			First Term	term	2018-08-01	2018-12-31	d895...f35f	2019	6a9d...2d8f_diploma
3142...4644			Second Term	term	2019-01-01	2019-07-31	d895...f35f	2019	6a9d...2d8f_diploma