Version: 5.4

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

This article uses the core sample data released with Ed-Fi Data Standard v3.3.1-b. If you have an extension that extends core entities with additional required fields, the core sample data may fail to fulfill those additional requirements and fail to load.

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:

Step 1. Install the Ed-Fi Bulk Load Client
Step 2. Download Scripts and Sample Data
Step 3. Create an Empty Sandbox
Step 4. Create API Client for Empty Sandbox
Step 5. Run the Bootstrap Script to Load Descriptors, Standards and Education Organizations
Step 6. Update Claim Set to Load Sample Data
Step 7. Run the Bootstrap Script to Load Sample Data

Detail on each step follows.

Step 1. Install 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 - Source Code Installation.
Ensure .NET 8.0 SDK is installed.
Add Ed-Fi package source by running the following command in PowerShell:

if (-not [Net.ServicePointManager]::SecurityProtocol.HasFlag([Net.SecurityProtocolType]::Tls12)) {
   [Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12
}

Register-PackageSource -Name Ed-FiAzureArtifacts -Location https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json -ProviderName NuGet

Install the Ed-Fi Bulk Load Client from a PowerShell prompt using the following command:

c:\>mkdir {YourInstallFolder}
c:\> dotnet tool install EdFi.Suite3.BulkLoadClient.Console --version 5.4.480 --tool-path {YourInstallFolder}

You can invoke the tool using the following command: EdFi.BulkLoadClient.Console
Tool 'edfi.suite3.bulkloadclient.console' (version '5.4.480') was successfully installed.

You can verify that the EdFi.BulkLoadClient.Console.exe is available by browsing to this location {YourInstallFolder}\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
- ProgramCharacteristicDescriptor.xml

note

The Bootstrap folder is used to load the necessary Descriptors and Education Organization used by the ODS / API. Since they require a special claimset (enabled in Step 4, below) they must be loaded separately from the other sample files.

Step 3. Create an Empty Sandbox

Open a PowerShell session.
Navigate to \Ed-Fi-ODS-Implementation\ directory
Execute .\Initialize-PowershellForDevelopment.ps1 and then Reset-EmptySandboxDatabase. The script will create EdFi_Ods_Sandbox_Empty Database.

Step 4. Create API Client for Empty Sandbox

Execute CreateApiClientforEmptySandbox.sql against the EdFi_Admin database. This will create claims needed to access EdFi_Ods_Sandbox_Empty ODS.

SQL Server - CreateApiClientforEmptySandbox.sql

DECLARE @VendorName nvarchar(150) = 'Empty Test Vendor'
DECLARE @NamespacePrefix nvarchar (255) = 'uri://ed-fi.org'
DECLARE @NamespacePrefixEdu nvarchar (255) = 'uri://gbisd.edu'
DECLARE @UserFullName varchar(150) = 'Empty Test User'
DECLARE @UserEmailAddress varchar(150) = 'EmptyTestUser@test.com'
DECLARE @ApplicationName varchar(150) = 'Default Sandbox Application Empty'

DECLARE @vendorId INT

-- Update if vendor already exists
UPDATE [dbo].[Vendors]
SET [VendorName] = @VendorName
WHERE [VendorName] = @VendorName

-- Create vendor if it does not exist
IF (NOT EXISTS (SELECT * FROM [dbo].[Vendors] WHERE [VendorName] = @VendorName))
BEGIN
    INSERT [dbo].[Vendors] ([VendorName])
    VALUES (@VendorName)
END

SELECT @vendorId = [VendorId] FROM [dbo].[Vendors] WHERE [VendorName] = @VendorName

DECLARE @userId INT

-- Update if user already exists
UPDATE [dbo].[Users]
SET [FullName] = @UserFullName
    ,[Email] = @UserEmailAddress
    ,[Vendor_VendorId] = @vendorId
WHERE [Email] = @UserEmailAddress

-- Create user if it does not exist
IF (NOT EXISTS (SELECT * FROM [dbo].[Users] WHERE [Email] = @UserEmailAddress))
BEGIN
    INSERT [dbo].[Users] ([FullName]
        ,[Email]
        ,[Vendor_VendorId])
    VALUES (@UserFullName
        ,@UserEmailAddress
        ,@vendorId)
END

SELECT @userId = [UserId] FROM [dbo].[Users] WHERE [Email] = @UserEmailAddress

DECLARE @applicationId INT

-- Create application if it does not exist
IF (NOT EXISTS (SELECT * FROM [dbo].[Applications] WHERE [ApplicationName] = @ApplicationName))
BEGIN
    INSERT [dbo].[Applications] ([ApplicationName]
        ,[OdsInstance]
        ,[OperationalContextUri]
        ,[ClaimSetName]
        ,[IsEnabled])
    VALUES (@ApplicationName
        ,'Ods_Sandbox_Empty'
        ,NULL
        ,'Bootstrap Descriptors and EdOrgs'
        ,1)
END

SELECT @applicationId = [ApplicationId] FROM [dbo].[Applications] WHERE [ApplicationName] = @ApplicationName

-- Update existing application data
IF (EXISTS (SELECT * FROM [dbo].[ApplicationEducationOrganizations] WHERE [Application_ApplicationId] = @applicationId))
BEGIN
    DELETE [dbo].[ApplicationEducationOrganizations]
    WHERE [Application_ApplicationId] = @applicationId
END

-- Create application profiles
IF (NOT EXISTS (SELECT * FROM [dbo].[ApplicationProfiles] WHERE [Application_ApplicationId] = @applicationId AND [ProfileName] = 'Test Profile'))
BEGIN
    INSERT [dbo].[ApplicationProfiles] ([Application_ApplicationId]
        ,[ProfileName])
    VALUES (@applicationId
        ,'Test Profile')
END

-- Create API client
DECLARE @Key nvarchar(50) = LOWER(CONVERT(nvarchar(50), NEWID()))
DECLARE @Secret nvarchar(100) = UPPER(CONVERT(nvarchar(50), NEWID()))
DECLARE @apiClientId INT

-- Update if one exists for the application
UPDATE [dbo].[ApiClients]
SET [Name] = 'Default Sandbox Client Empty'
    ,[ApplicationId] = @applicationId
    ,[UseSandbox] = 1
    ,[SandboxType] = 0
WHERE [ApplicationId] = @applicationId

-- Create if one does not exist for the application
IF (NOT EXISTS (SELECT * FROM [dbo].[ApiClients] WHERE [ApplicationId] = @applicationId))
BEGIN
    INSERT [dbo].[ApiClients] ([Key]
        ,[Secret]
        ,[Name]
        ,[ApplicationId]
        ,[UseSandbox]
        ,[SandboxType])
    VALUES (@Key
        ,@Secret
        ,'Default Sandbox Client Empty'
        ,@applicationId
        ,1
        ,0)
END

-- Get existing or created api client id
SELECT @apiClientId = [ApiClientId] FROM [dbo].[ApiClients] WHERE [ApplicationId] = @applicationId

-- Update api client secret if it already exists
UPDATE [dbo].[ClientAccessTokens]
SET [ApiKey] = @Key
    ,[Secret] = @Secret
    ,[Expiration] = DATEADD(DAY, 365, GETDATE())
WHERE [ApiClient_ApiClientId] = @apiClientId

IF (NOT EXISTS (SELECT * FROM [dbo].[ClientAccessTokens] WHERE [ApiClient_ApiClientId] = @apiClientId))
BEGIN
    INSERT [dbo].[ClientAccessTokens] ([ApiKey]
        ,[Secret]
        ,[Expiration]
        ,[SortOrder]
        ,[IsRefreshToken]
        ,[ApiClient_ApiClientId])
    VALUES (@Key
        ,@Secret
        ,DATEADD(DAY, 365, GETDATE())
        ,1
        ,0
        ,@apiClientId)
END

-- Create namespace if it doesn't exist
IF (NOT EXISTS (SELECT * FROM [dbo].[ClientAppNamespaces] WHERE [ApiClient_ApiClientId] = @apiClientId AND [NamespacePrefix] = @NamespacePrefix))
BEGIN
    INSERT [dbo].[ClientAppNamespaces] ([ApiClient_ApiClientId]
        ,[NamespacePrefix])
    VALUES (@apiClientId
        ,@NamespacePrefix)
END

-- Create namespace if it doesn't exist
IF (NOT EXISTS (SELECT * FROM [dbo].[ClientAppNamespaces] WHERE [ApiClient_ApiClientId] = @apiClientId AND [NamespacePrefix] = @NamespacePrefixEdu))
BEGIN
    INSERT [dbo].[ClientAppNamespaces] ([ApiClient_ApiClientId]
        ,[NamespacePrefix])
    VALUES (@apiClientId
        ,@NamespacePrefixEdu)
END

-- Output key and secret
PRINT 'Key: ' + @Key
PRINT 'Secret: ' + @Secret
GO

PostgreSQL - CreateApiClientforEmptySandbox.sql

DO $$
DECLARE 
  vendor_name varchar(150) := 'Empty Test Vendor';
  namespace_prefix varchar(255) = 'uri://ed-fi.org';
  namespace_prefix_edu varchar(255) = 'uri://gbisd.edu';
  user_full_name varchar(150) = 'Local Test User';
  user_email_address varchar(150) = 'EmptyTestUser@test.com';
  application_name varchar(150) = 'Default Sandbox Application Empty';
  
  vendor_id int;
  user_id int;
  application_id int;
  key varchar(50) = lower(cast(gen_random_uuid() as varchar(50)));
  secret varchar(100) = upper(cast(gen_random_uuid() as varchar(50)));
  api_client_id int;

BEGIN
    -- Update if vendor already exists
    UPDATE dbo.Vendors
    SET VendorName = vendor_name
    WHERE VendorName = vendor_name;

    -- Create vendor if it does not exist
    IF (NOT EXISTS (SELECT * FROM dbo.Vendors WHERE VendorName = vendor_name)) THEN
        INSERT INTO dbo.Vendors (VendorName)
        VALUES (vendor_name);
    END IF;
    
    SELECT VendorId INTO vendor_id FROM dbo.Vendors WHERE VendorName = vendor_name;
    
    -- Update if user already exists
    UPDATE dbo.Users
    SET FullName = user_full_name,
        Email = user_email_address,
        Vendor_VendorId = vendor_id
    WHERE Email = user_email_address;
    
    -- Create user if it does not exist
    IF (NOT EXISTS (SELECT * FROM dbo.Users WHERE Email = user_email_address)) THEN
        INSERT INTO dbo.Users (FullName, Email, Vendor_VendorId)
        VALUES (user_full_name, user_email_address, vendor_id);
    END IF;
    
    SELECT UserId INTO user_id FROM dbo.Users WHERE Email = user_email_address;
    
    -- Create application if it does not exist
    IF (NOT EXISTS (SELECT * FROM dbo.Applications WHERE ApplicationName = application_name)) THEN
        INSERT INTO dbo.Applications (ApplicationName, OdsInstance, OperationalContextUri, ClaimSetName, IsEnabled)
        VALUES (application_name, 'Ods_Sandbox_Empty', NULL, 'Bootstrap Descriptors and EdOrgs', true);
    END IF;
    
    SELECT ApplicationId INTO application_id FROM dbo.Applications WHERE ApplicationName = application_name;
    
    -- Update existing application data
    IF (EXISTS (SELECT * FROM dbo.ApplicationEducationOrganizations WHERE Application_ApplicationId = application_id)) THEN
        DELETE FROM dbo.ApplicationEducationOrganizations
        WHERE Application_ApplicationId = application_id;
    END IF;
    
    -- Create application profiles
    IF (NOT EXISTS (SELECT * FROM dbo.ApplicationProfiles WHERE Application_ApplicationId = application_id AND ProfileName = 'Test Profile')) THEN
        INSERT INTO dbo.ApplicationProfiles (Application_ApplicationId, ProfileName)
        VALUES (application_id, 'Test Profile');
    END IF;
    
    -- Update if one exists for the application
    UPDATE dbo.ApiClients
    SET Name = 'Default Sandbox Client Empty',
        ApplicationId = application_id,
        UseSandbox = true,
        SandboxType = 0
    WHERE ApplicationId = application_id;
    
    -- Create if one does not exist for the application
    IF (NOT EXISTS (SELECT * FROM dbo.ApiClients WHERE ApplicationId = application_id)) THEN
        INSERT INTO dbo.ApiClients (Key, Secret, Name, ApplicationId, UseSandbox, SandboxType)
        VALUES (key, secret, 'Default Sandbox Client Empty', application_id, true, 0);
    END IF;
    
    -- Get existing or created api client id
    SELECT ApiClientId INTO api_client_id FROM dbo.ApiClients WHERE ApplicationId = application_id;
    
    -- Update api client secret if it already exists
    UPDATE dbo.ClientAccessTokens
    SET ApiKey = key,
        Secret = secret,
        Expiration = NOW() + INTERVAL '365 days'
    WHERE ApiClient_ApiClientId = api_client_id;
    
    IF (NOT EXISTS (SELECT * FROM dbo.ClientAccessTokens WHERE ApiClient_ApiClientId = api_client_id)) THEN
        INSERT INTO dbo.ClientAccessTokens (ApiKey, Secret, Expiration, SortOrder, IsRefreshToken, ApiClient_ApiClientId)
        VALUES (key, secret, NOW() + INTERVAL '365 days', 1, false, api_client_id);
    END IF;
    
    -- Create namespace if it doesn't exist
    IF (NOT EXISTS (SELECT * FROM dbo.ClientAppNamespaces WHERE ApiClient_ApiClientId = api_client_id AND NamespacePrefix = namespace_prefix)) THEN
        INSERT INTO dbo.ClientAppNamespaces (ApiClient_ApiClientId, NamespacePrefix)
        VALUES (api_client_id, namespace_prefix);
    END IF;
    
    -- Create namespace if it doesn't exist
    IF (NOT EXISTS (SELECT * FROM dbo.ClientAppNamespaces WHERE ApiClient_ApiClientId = api_client_id AND NamespacePrefix = namespace_prefix_edu)) THEN
        INSERT INTO dbo.ClientAppNamespaces (ApiClient_ApiClientId, NamespacePrefix)
        VALUES (api_client_id, namespace_prefix_edu);
    END IF;
    
    -- Output key and secret
    RAISE NOTICE 'Key: %', key;
    RAISE NOTICE 'Secret: %', secret;
END $$;

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).
Open the LoadBootstrapData.ps1 file in notepad or Windows PowerShell ISE and update the $apiLoaderExe variable Value where EdFi.BulkLoadClient.Console is installed in Step 1.
Example $apiLoaderExe= "{YourInstallFolderFullPath}\EdFi.BulkLoadClient.Console.exe"
Save and Execute LoadBootstrapData.ps1. The script will run the Bulk Load Client loading data from the Bootstrap folder to the Empty Sandbox Database.

Step 6. Update Claim Set to Load Sample Data

Execute EnableSandboxClaimset.sql against the EdFi_Admin database. This will change the claim set for the empty sandbox database you created in Step 4 to the Ed-Fi Sandbox claimset.

SQL Server - EnableSandboxClaimset.sql

UPDATE [dbo].[Applications]
SET [ClaimSetName] = 'Ed-Fi Sandbox'
WHERE [ApplicationName] = 'Default Sandbox Application Empty'
GO

PostgreSQL - EnableSandboxClaimset.sql

UPDATE dbo.Applications 
SET ClaimSetName = 'Ed-Fi Sandbox' 
WHERE ApplicationName = 'Default Sandbox Application Empty';

Step 7. Run the Bootstrap Script to Load Sample Data

Restart the instance of the Ed-Fi ODS / API running locally again to refresh the claims.
Open a PowerShell session.
Navigate to Ed-Fi-SampleDataLoad directory (e.g., C:\Ed-Fi-SampleDataLoad).
Open the LoadSampleData.ps1 file in notepad or Windows PowerShell ISE and update the $apiLoaderExe variable Value where EdFi.BulkLoadClient.Console is installed in Step 1.
Example $apiLoaderExe= "{YourInstallFolderFullPath}\EdFi.BulkLoadClient.Console.exe"
Save and Execute LoadSampleData.ps1. The script will run the Bulk Load Client to load data from the Sample XML folder to the Empty Sandbox Database.

Downloads

The following link contains the scripts and directory setup used in this how-to article:

Ed-Fi-SampleDataLoad.zip

The following GitHub links contain the sample XML files and the as-shipped Ed-Fi Descriptor XML:

Step 1. Install the Ed-Fi Bulk Load Client​

Step 2. Download Scripts and Sample Data​

Step 3. Create an Empty Sandbox​

Step 4. Create API Client for Empty Sandbox​

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

Step 6. Update Claim Set to Load Sample Data​

Step 7. Run the Bootstrap Script to Load Sample Data​

Downloads​