This developer guide describes the processes for a System Integrator to provide data to the Clinical Experience and Performance Starter Kit. In the Clinical Experience and Performance Setup Guide, we explain how to set up the Ed-Fi solution, including a high-level description of how to use Data Import to read and map a CSV. In this document, we dive a bit deeper into how to work with the Educator Preparation Provider to understand the data needs of the Starter Kit and how that data will map into the Ed-Fi Data Standard to produce a report valuable to the EPP.
...
Many Ed-Fi entities use enumeration values called descriptors. These descriptors are used to categorize data and help provide useful reporting. Descriptor values will need to be mapped from the source data into values in Ed-Fi. In most cases, new descriptor values can be added if the default ones provided by Ed-Fi are not sufficient. In cases where the EPP doesn't have data for a descriptor value, it can be statically set on import of the data. The mapping workbook linked above includes all descriptor values for any given entity in the starter kit. General guidance on the usage of descriptors can be found here.
Determine Mapping Logic
There may be cases where a direct field mapping from source data into Ed-Fi is not possible. A single field might require the concatenation of two fields, or maybe reading data from a second file.
...
Instructions for adding education organizations in Admin App can be found in the Starter Kit setup guide here. Clinical Experience and Performance Setup Guide
Set Up Data Import
Installation instructions for Data Import can be found here.
Once you've installed Data Import, initial setup info can be found here.
Post-installation setup instructions for Data Import are in the Clinical Experience and Performance Setup Guide.
...
Data Import requires a map for each piece of CSV data that will be loaded into the ODS. Basic information on creating maps and agents for the Clinical Experience and Performance Starter Kit can be found here.
More in-depth documentation on Import Maps and Agents can be found in the Data Import documentation.
Upload File to Agent
The final step before loading data with Data Import is to upload a file for the agent to process.
...
EducatorPreparationPrograms
An Educator Preparation Program entity represents a state-approved course of study, completion of which signifies a candidate will have met all requirements necessary to obtain a certification or licensure to teach within K–12 schools.
Most educator preparation providers will offer multiple programs, each aligned with a certification offered by the state. Program data needs to be loaded after Education Organizations (completed through Admin App, see Clinical Experience and Performance Setup Guide) but should be loaded before any other data. To load Programs you need the following data:
- The ID of the school created when Education Organization entities were loaded in the Admin App.
- The name of the program. This generally correlates to the degree being offered by the program such as 'All Level EC-12+Art' or 'High School 7 - 12+Science'.
- The program type. In many cases, this will be a traditional program, although Post-Baccalaureate is also quite common.
Programs are provided as a filter value on the left-hand side of the report, allowing the user to see values for either a single program or multiple programs using multi-select.
| Anchor | ||||
|---|---|---|---|---|
|
Candidates and Persons
...
- SchoolYear. A 4-digit year.
- Term. The term associated with the candidate and program. Generally this is the term the candidate entered the program.
- CohortYearType. A descriptor that represents the type of cohort. CohortYearType is usually determined by the EPP, with the most common being 'Entry' into the program.
Credentials
Credential represents the attainment of a certification or license that authorizes or enables teaching assignment services. This data is generally provided two ways:
- From the State of Issuance - EPP's can generally request from the state a list of their candidates who have been credentialed.
- From post-completion surveys - When an EPP cannot receive the data from the state, they will send out surveys and determine licensed candidates from the responses.
...
- PerformanceEvaluationTitle. A unique identifier for this performance evaluation. For the Clinical Experience and Performance Starter Kit, our sample PerformanceEvaluationTitle is 'Clinical Teacher - TWS' to represent the Teacher Work Sample.
- Term. The term where this evaluation applies. Common values include:
- 'Fall Semester', 'Spring Semester'
- 'First Term', 'Second Term', etc.
- 'Year Round'
- SchoolYear. the 4-digit school year where the evaluation applies.
- PerformanceEvaluationType. The type of evaluation. This can be a formal evaluation, informal observation, self-observation, etc.
- EvaluationPeriod. When the evaluation occurs - BOY, EOY, Fall, Spring.
- EducationOrganization. the organization that this evaluation belongs to. For the Starter Kit, this will almost always be the school created during setup.
Evaluation
Evaluation is the entity right under the PerformanceEvaluation entity and represents the actual evaluation definition.
...