Skip to end of metadata
Go to start of metadata

The SDG is a command-line application that must be run from either the Windows Command Prompt or Windows Powershell.

Data Standard Support

When the SDG is installed, multiple versions are installed for each supported Ed-Fi Data Standard. The data standard version number is included in the filename of the executable and each version will have its own sample directory. Below is a reference of each Ed-Fi data standard version, the supported Ed-Fi ODS/API version it applies to, the SDG executable and corresponding sample directory.

Ed-Fi Data Standard VersionEd-Fi ODS/API VersionSDG ExecutableSDG Sample Directory
2.22.5EdFi.SDG.v22.exeC:\Ed-Fi\Samples\v22
3.13.1EdFi.SDG.v31.exeC:\Ed-Fi\Samples\v31

Below are examples provided for your first run of the SDG, which generates a limited set of sample data.  From here, this example can be used to build towards your specific data cases.  In the examples below, XX will be used to denote your targeted data standard.  For example, if you are targeting the Ed-Fi Data Standard 3.1 and  EdFi.SDG.vXX.exe is mentioned below, the actual executable will be EdFi.SDG.v31.exe.

Command Line Arguments

Below is a list of currently available command line arguments for the SDG. You can get a list of arguments available to the application by running with the /? switch.

Run in Powershell
EdFi.SDG.vXX.exe /?


ArgumentDescriptionRequiredDefault
-c / -configXmlPathProvides the path to the XML configuration file for this run.Yes(none)
-d / -dataFilePathProvides the path to the input CSV data files.No.\DataFiles\
-m / -outputModeOne of {"Standard", "Seed"}. See further documentation about Seed Data.NoStandard
-o / -outputPathPath where output files should be saved. Note: this folder must already exist.No.\ (i.e. Current Directory)
-s / -seedFilePathPath to an input or output seed file. Used for running in seed output mode. See further documentation about Seed Data.No(none)
-w / -allowOverwriteIf provided, files in the outputPath can be overwritten with newly generated data.Nofalse


For example, a typical run of the SDG looks like this:

EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\


Outputting seed data:

EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ -m Seed -s C:\Temp\SDG\SeedRecords.txt


Using seed data as input:

EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ -s C:\Temp\SDG\SeedRecords.txt


Allowing output files to be overwritten (use with caution!):

EdFi.SDG.vXX.exe -c C:\Ed-Fi\Samples\vXX\SampleDataGenerator\SampleConfig.xml -d C:\Ed-Fi\Samples\vXX\SampleDataGenerator\DataFiles\ -o C:\Temp\SDG\Output\ -AllowOverwrite

Output

The output of the SDG is a set of XML files that adhere to the Ed-Fi Bulk Data Exchange for XML specifications. These XML files will be properly formatted Interchange files for use with any of the available Ed-Fi Bulk Load tools for loading to an Ed-Fi ODS. The location of these files are controlled by the -outputPath argument (explained above).

  • For non-student-specific files, the output file name will be {Ed-Fi-Interchange-Name}.xml
    • Example: Descriptors.xml
    • Example: EducationOrganization.xml
  • For student-specific files, the output file name will be {Ed-Fi-Interchange-Name}-{SchoolName}-{DataPeriod}-{BatchId}.xml
    • Example (with batching ON): Student-Northridge High School-First Six Weeks-0001.xml
    • Example (with batching OFF): Student-Northridge High School-First Six Weeks.xml

Contents

  • No labels