Pre-requisites

Est. Time

Notes

Getting Started - Installation Steps

2 hrsInstall and Build the Ed-Fi ODS on a developer machine
Install Fiddler for .NET410 minsInstall Fiddler to observe the requests and responses to and from the API

Useful Resources

ResourceDescription

Boot Camp Presentation

PDF of the slides presented during the ODS / API Track
EdFi.Ods.Labs.zipSource code for the hands on labs
Ed-Fi Sandbox: http://apidocs.ed-fi.org

Key: 5iqu6lX4JJAS, Secret: EytEoZqr2a0n3jMD5qsyUyiB

Issues that caused the build to break.docxSome helpful information for setting up the ODS / API when SQL Server is a named instance

Text Templating work around

 TextTemplating.zip

Unpack this file into C:\Program Files (x86)\MSBuild\Microsoft\VisualStudio\v12.0\TextTemplating . Once you've done that, right-click on one of those projects in Visual Studio and choose Reload Project. If that works, then close and reopen Visual Studio.

Day 1, October 13, 2015 (2:00 pm – 5:00 pm)

TimeSessionDescription

2:00 - 2:30 

(30 mins)

Boot Camp Kick OffOverview of what is to be covered, logistics, etc.
Components of the Ed-Fi ODS API
  • Review components of the Ed-Fi ODS / API (API, Swagger, Admin, Bulk and Commit workers, Databases)
  • Walkthrough of the Sandbox Admin portal
  • Walkthrough of the Swagger UI
  • Walkthrough of Fiddler as a useful tool

2:30 - 2:50

(20 mins)

 LAB 1: Using the Admin Portal and Swagger UI
  • Use the admin portal to create keys and secrets for populated and minimal templates
  • Use Swagger to: read types and descriptors, read schools, CRUD sections
  • View the traffic in Fiddler

2:50 - 3:05

(15 mins)

Ed-Fi ODS API SDK
  • Show the Swagger metadata
  • Demo generating the SDK
  • Add in for bulk and unique Id support

3:05 - 3:35

(30 mins)

LAB 2: Generating new SDK files
  • Generate the new SDK files
  • Copy and paste them into the lab along with the bulk and unique Id classes
  • Add configurations and create and modify a section
  • View the traffic in Fiddler

3:35 - 4:00

(25 mins)

Security Overview

Security Use Case: Students

  • Key security concepts
  • Managing access
  • Default claim set for the sandbox
  • Nuances of accessing student profile data

4:00 - 4:20

(20 mins)

LAB 3: Manage Student Data
  • Create, read, update, and delete a student
  • Notice the impact of a student school association
  • View and interpret error messages returned from the API

4:20 - 4:40

(20 mins)

Bulk Operations
  • Overview of how bulk operations work
  • Bulk operation infrastructure
  • Console bulk loader
  • Handling error messages

4:40 - 5:00

(20 mins)

LAB 5: Submit a Bulk Student XML File
  • Submit a bulk student XML file
  • Handle error messages

 

Day 2, October 13, 2015 (8:30 am – 1:00 pm)

 

TimeSessionDescription
8:30 - 9:00Breakfast 

9:00 - 9:45

(45 mins)

Extending the Data Model
  • Review elements that make up the core data model (UDM, XSD, ODS, Domain Metadata, (Profile metadata))
  • Extension Use Cases
    • Adding a new entity
    • Adding to an existing entity
    • Adding a new entity to an existing aggregate

9:45 - 10:25

(40 mins)

LAB 6: Extending the data model by adding a new entity

Transportation example

  • Modify XSD
  • Modify ODS
  • Modify domain metadata
  • Regenerate SDK
  • Rebuild API
  • View in Swagger
  • Add resource claim
  • Submit transactional
  • Submit bulk

10:25 - 10:45

(20 mins)

LAB 7: Extending an Existing EntityStudent example

10:45 - 11:00

(15 mins)

Security Use Case: Managing Descriptors and Assessment Data
  • Namespace security context
  • Example

11:00 - 11:20

(20 mins)

LAB 4: Manage Descriptors
  • Assign a namespace to the vendor
  • Restart the API to clear the cache
  • Attempt to create descriptors under the assigned namespace and an incorrect namespace
12:00 - 1:00Conclusion and Wrap Up - Combined with Dashboard Track