How To: Load the ODS with Sample XML Data using Bulk Load Client Utility

This article describes the steps needed to populate an Ed-Fi ODS with sample XML data, using the Ed-Fi Bulk Load Client utility.

The steps can be summarized as:

Detail on each step follows.

Step 1. Build the Ed-Fi Bulk Load Client

• Ensure that you have an instance of the Ed-Fi ODS / API running locally that has been set up following the Getting Started - Installation Steps.
• Within Visual Studio, Open Ed-Fi-ODS\Utilities\DataLoading\LoadTools.sln.
• Select Build > Build Solution.

• You can verify that the console application has been built by browsing to Ed-Fi-ODS\Utilities\DataLoading\EdFi.BulkLoadClient.Console\bin\Debug\net48\EdFi.BulkLoadClient.Console.exe

Step 2. Download Scripts and Sample Data

• Download and Extract Ed-Fi-SampleDataLoad.zip to a local folder. We recommend C:\Ed-Fi-SampleDataLoad.
  Ed-Fi-SampleDataLoad.zip contains all the scripts and directory structure used in this how-to article.

• Download the Sample XML to Ed-Fi-SampleDataLoad\Sample XML

• Download the Descriptors to Ed-Fi-SampleDataLoad\Bootstrap

• Move the following files from Ed-Fi-SampleDataLoad\Sample XML to Ed-Fi-SampleDataLoad\Bootstrap

  • Standards.xml

  • EducationOrganization.xml

  • CreditCategoryDescriptor.xml
  • IndicatorDescriptor.xml
  • IndicatorGroupDescriptor.xml
  • IndicatorLevelDescriptor.xml

Step 3. Create an Empty Sandbox

• Open Ed-Fi-ODS-Implementation\Application\EdFi.Ods.Admin.Web\AdminCredential.config.

• Add an empty sandbox by inserting the below line in the <sandboxes> element.

  <sandbox name="Empty Demonstration Sandbox" key="emptyKey" secret="emptySecret" type="Empty" refresh="true" />

  The AdminCredential.config file contains configuration for the Sandbox Administration website. It allows you to setup default users and sandbox databases for use with the ODS / API. The sandboxes will be created on startup of the website.

Step 4. Update Claim Set to Load Descriptors, Standards and Education Organizations

• Execute EnableBootstrapClaimset.sql by opening the file in SSMS and clicking Execute.

  EnableBootstrapClaimset.sql

  USE [EdFi_Admin]
  GO
  
  UPDATE [dbo].[Applications]
  SET [ClaimSetName] = 'Bootstrap Descriptors and EdOrgs'
  WHERE [ApplicationName] = 'Default Sandbox Application Empty'
  GO

Step 5. Run the Bootstrap Script to Load Descriptors, Standards and Education Organizations

• Open a PowerShell session.
• Navigate to Ed-Fi-SampleDataLoad directory (e.g., C:\Ed-Fi-SampleDataLoad).
• Execute LoadBootstrapData.ps1.

  The script will run the Bulk Load Client loading data from the Bootstrap folder to the Empty Sandbox Database.

  If your local copy of EdFi.BulkLoadClient.Console.exe is in a different location than the root of the drive, you can modify the LoadBootstrapData.ps1 script to adjust. The script contains a parameter that defines the local path to the Ed-Fi-ODS repository. This is set by default to C:\Ed-Fi-ODS but can be changed to be appropriate for your environment.

Step 6. Update Claim Set to Load Sample Data

• Execute EnableSandboxClaimsetAndEducationOrganization.sql by opening the file in SSMS and clicking Execute.

  EnableSandboxClaimsetAndEducationOrganization.sql

  USE [EdFi_Admin]
  GO
  
  UPDATE [dbo].[Applications]
  SET [ClaimSetName] = 'Ed-Fi Sandbox'
  WHERE [ApplicationName] = 'Default Sandbox Application Empty'
  GO
  
  INSERT INTO [dbo].[ApplicationEducationOrganizations] ([EducationOrganizationId], [Application_ApplicationId])
  VALUES (255901, (
      SELECT [ApplicationId]
      FROM [dbo].[Applications]
      WHERE [ApplicationName] = 'Default Sandbox Application Empty'))
  GO
  
  INSERT INTO [dbo].[ApiClientApplicationEducationOrganizations] ([ApiClient_ApiClientId],[ApplicationEducationOrganization_ApplicationEducationOrganizationId])
  SELECT [ApiClients].[ApiClientId], [ApplicationEducationOrganizations].[ApplicationEducationOrganizationId]
  FROM [dbo].[ApiClients]
  CROSS JOIN [dbo].[Applications]
  INNER JOIN [dbo].[ApplicationEducationOrganizations]
  ON [Applications].[ApplicationId] = [ApplicationEducationOrganizations].[Application_ApplicationId]
  WHERE [ApiClients].[Name] = 'Empty Demonstration Sandbox'
  AND [Applications].[ApplicationName] = 'Default Sandbox Application Empty';
  GO

  This will change the claim set for the empty sandbox database back to the Ed-Fi Sandbox claimset and add 255901 as an authorized Education Organization. The script assumes that the sandbox name in AdminCredential.config is set to Empty Demonstration Sandbox but can be modified to be appropriate for your environment.

Step 7. Run the Bootstrap Script to Load Sample Data

• Open a PowerShell session.
• Navigate to Ed-Fi-SampleDataLoad directory (e.g., C:\Ed-Fi-SampleDataLoad).
• Execute LoadSampleData.ps1.

  The script will run the Bulk Load Client to load data from the Sample XML folder to the Empty Sandbox Database.

  If your local copy of EdFi.BulkLoadClient.Console.exe is in a different location than the root of the drive, you can modify the LoadSampleData.ps1 script to adjust. The script contains a parameter that defines the local path to the Ed-Fi-ODS repository. This is set by default to C:/Ed-Fi-ODS but can be changed to be appropriate for your environment.