Console Bulk Loader

FOR SINGLE-PAGE DOCUMENTATION LIKE THIS, WE COULD EMBED THE CONTENT DIRECTLY IN THIS TOOLS SITE. COPIED FROM ODS / API V3.2.

The Console Bulk Loader (hereafter called the Loader) is a command-line tool that can be used by platform hosts to initially populate an ODS database with XML data conforming to the Ed-Fi Data Standard.

The Loader is built using code generation techniques that take into account the ODS database schema as well as the Ed-Fi XSD Schema definitions and metadata. The Loader can also be used during database initialization to create the Minimal ODS Template database by populating Ed-Fi Descriptors and education organizations into an empty ODS database. The Loader project is called EdFi.Ods.BulkLoad.Console.  It is part of the Ed-Fi-ODS solution. More details on how to use the console bulk loader can be found at /wiki/spaces/ODSAPI32/pages/27100100.

Command-Line Parameters

The Loader accepts the following command-line parameters:

Database

The target ODS database must already exist and be accessible using the “Connection String” (/c) parameter provided. This database must conform to the same database schema that was used to generate the Loader application.

Manifest File

The manifest file is a simple XML document containing a list of the interchange XML files to load. Because files of the same type are loaded in parallel, it is important that files loaded by the same manifest have distinct XML IDs. Large interchange files may show errors when loading due to the highly parallelized nature of the Loader application. Usually, this is resolved by simply re-running the loader with the same settings.

A manifest file takes the following form:

<Interchanges>
	<Interchange>
		<Filename>Standards.xml</Filename>
		<Type>standards</Type>
	</Interchange>
	<Interchange>
		<Filename>EducationOrganization.xml</Filename>
		<Type>educationorganization</Type>
	</Interchange>
</Interchanges>

The manifest file elements are described below:

• The Interchanges element must exist at the root, and may only be present one time.
• The Interchange tag may exist more than once, and contains a single Filename and Type element.
• The Filename element contains the name of the interchange file to be loaded. This may be a long filename. Note that the file must exist in the directory provided by the “Source Folder” (/f) command line parameter at runtime.
• The Type element contains the case-insensitive class name for the resource to be loaded.

Load Order

The load order of data is extremely important when creating a populated ODS database from a minimal one. The load order reflected in the “InterchangeOrderMetadata.xml” file (EdFi.Ods.CodeGen/App_Packages/Ed-Fi/Metadata) contains the correct load order information for the ODS database provided in the Ed-Fi repository. The following load order applies:

1. Descriptors
2. Standards
3. EducationOrganization
4. EducationOrgCalendar
5. MasterSchedule
6. StaffAssociation
7. Student
8. Parent
9. AssessmentMetadata
10. StudentCohort
11. StudentAssessment
12. StudentIntervention
13. StudentTranscript
14. StudentProgram
15. StudentEnrollment
16. StudentDiscipline
17. PostSecondaryEvent
18. StudentAttendance
19. StudentGrade
20. StudentGradebook

Ed-Fi ODS Populated Template

The populated template was generated manually with the Loader using sample XML data contained in the public Ed-Fi-Standard GitHub repository (Ed-Fi-Standard\v3.1\Samples\Sample XML).

Ed-Fi ODS Minimal Template

The minimal template is generated dynamically during the build process. The Ed-Fi descriptors, standards, and education organization sample data are loaded during the "initialize development environment" step of the build process.

Troubleshooting 

This section outlines a few troubleshooting tips related to the Loader.

• The Loader expects valid Ed-Fi Data Standard XML files. If the sample files referenced above load correctly, consider validating the files prior to running the Loader.
• The Loader sometimes has problems loading extremely large datasets (e.g., multiple files of multiple gigabytes). An indication that file size is an issue is when the bulk load operation "completes" but reports thousands of errors. The workaround is to load each file individually by wrapping each file in its own manifest. This approach generally works — but if you continue to receive errors that you suspect to be caused by a large dataset, consider splitting the XML data into smaller files and loading each file in its own manifest.
• The Loader process is an upsert. So, if the Loader reports errors (e.g., when loading an extremely large dataset), simply re-running the loader will add any records that failed due to transient issues.