The contents of each resource are presented using a structure that mirrors the hierarchy and sequence of elements within the Ed-Fi XML file output. Each resource includes a series of data elements, and most resources also include one or more complex types. Complex types group together a series of related elements, and can be recognized by the presence of a header shown in bold above the child data elements contained within the complex. Frequently, a complex type may be nested within another complex type, and in turn, there may be additional levels of nesting. Indenting and forward slashes are used to depict the parent-child relationships of data elements and complex types within the resource.
While the resource tables depict data elements and complexes according to the XML file output, XML is just one of two output options that may be used to transmit data to the state Ed-Fi ODS. When XML is used, the PowerSchool output file will generally reflect the structure as depicted in the resource table. In some states, XML may be used exclusively throughout the year, or may be used only at specific times, such as at the start of school or the start of a semester when the volume of data is significant. Many Ed-Fi implementations use JSON as the default method to transmit data. JSON employs a transactional processing model to transmit only the data elements that have been added or changed since the last update to the state. When JSON is used, only a subset of elements within an resource may be transmitted, and the PowerSchool output file will not have the same structure as depicted in the resource table and noted below.
Primary PowerSchool Source Data
For resources that are published rather than downloaded from the state, this section lists the primary PowerSchool source tables used to populate or derive the Ed-Fi output.
Within the introduction to each resource, the Selection Criteria section summarizes the requirements and related business logic governing the publishing of records. The specified conditions must be met in order for a record to be extracted for transmission. Refer to State Reporting Setup for additional information about the specific configurations and data entry required to support your state's implementation.
The Resource Output section summarizes the contents and key elements within the published records. Depending on the resource, a single record or multiple records may be extracted per student, per course, per teacher, etc. An example of the single record model is the Student resource, in which a single record is published per student enrolled in the district. Multiple records apply to elements with a one-to-many relationship, such as the StudentSectionAssociation resource where, for each student, a separate StudentSectionAssociation record is published for each class in which the student is enrolled.
Similarly, data elements and complex types may appear once or multiple times within an resource. Elements and complex types with a one-to-one relationship have a single value included in the output, such as the Gender of a student or staff member. In other cases, a one-to-many relationship may exist where multiple values may be extracted if the data is resident in the source PowerSchool tables and the selection criteria are met. Items with multiple possible values are designated as '(1-many)' or '(0-many)' at the end of the element or complex name; one example is Race where a student or staff member may be reported with multiple Race codes.
In addition, each item within each complex is designated as Mandatory, Required, Optional or Conditional. Refer to the Output Table Contents and Conventions section below for additional information on these designations.
Output Table Content and Conventions
The resource output tables include the following information:
- Data Element – The name of the data element or complex type.
Note: This document follows the Ed-Fi 2.0 XML specification. The JSON specification is similar, but with differences in structure and element names. In most cases, the JSON element name will be the same as the XML name, but with the following differences:
- The first letter of the JSON element name will be in lower case.
- If the element is a type, the JSON element name will end with 'Type'.
- If the element is a descriptor, the JSON element name will be the descriptor name, and will end with 'Descriptor'.
- Exceptions will be indicated under the element name, tagged with 'JSON'.
- Description – Additional information about the element, including state reporting rules.
- Data Type – The Ed-Fi field type specified for the data element output, such as character string, integer, date, etc.
Note: The source PowerSchool field type may be different and will be transformed as required in the output file.
- Stored in [Table]Field – The name of the source PowerSchool table and field where the data is stored, or from which the data output is derived.
Note: The Table name appears in brackets with the Field Name directly following. Example: [Table]FieldName.
Req'd – Indicates whether the resource or element is required per the following legend:
Constitutes the primary key for the record; exceptions must be corrected before the data can be published to the state ODS.
Missing required data may result in an error and/or prevent the data from being published to the state ODS; exceptions should be corrected as warranted.
Optional data element or complex; if the source data is populated within PowerSchool, it will be transmitted. Note: If an optional complex type is included for publishing, some elements within the complex may be mandatory or required.
Data is conditionally required and additional explanatory notes are provided. Conditional logic typically applies to one of the following scenarios:
- Elements applicable only to a subset of students, such as Graduation Plan, which is required for high school students, but not for elementary.
- Resources requiring at least one of two possible elements, such as Grade, where either the Letter Grade or the Numeric Grade must be provided.|