Skip to main content
Skip table of contents

Understanding the Resource Table

Contents

Overview

The contents of each resource are presented using a structure that mirrors the sequence of elements within the Ed-Fi JSON specification, and its specific implementation by the Georgia DOE. While there is also an Ed-Fi XML specification, the Georgia Ed-Fi implementation uses the JSON data-interchange format 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. Therefore, depending on the transaction, only a subset of elements within a resource may be transmitted, and the PowerSchool output file will not reflect the full content as depicted in the resource table.

Selection Criteria

Within the introduction to each resource, the Selection Criteria section summarizes the requirements and related business logic governing the publishing of resources. The specified conditions must be met in order for data within a resource 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.

Resource Output

The Resource Output section first summarizes the contents and key elements within the published data. Depending on the resource, a single record or multiple records may be published for a single student. An example of the single record model is the Student resource, in which a single record per district student is published. Multiple records apply to resources with a one-to-many relationship, such as the StudentSchoolAssociation resource where, for each student, a separate record is published for each school the student attends. Any dependencies that may govern the successful publishing of a resource are also listed.

Following the resource output summary, each resource output table lists the corresponding data elements and their specified properties, including the description, data type, PowerSchool source field, and an indication if the element is required or not. In cases where multiple values can apply to a single element, this one-to-many relationship is indicated as "1-many" if the element is required, or "0-many" if it is optional; one example is the reporting of student race codes, where multiple races such as "Asian" and "White" may apply.

Some Ed-Fi resources contain multi-element complexes comprised of a set of related fields, also referred to as an "array" in the Georgia DOE specifications. These can be recognized by the presence of a header shown in bold above the child data elements contained within the complex, and by the use of indenting and forward slashes to depict the parent-child relationship of the included elements. For example, when publishing student diploma information to the state, the diploma type, award date, and achievement category descriptor are all required elements within the studentAcademicRecordDiplomaArray.

Output Table Content and Conventions

The resource output tables in this documentation include the following information:

  • Data Element – The name of the data element or array (multi-element complex). In the case of arrays, each element that comprises the complex is listed.

Note: This document follows the Ed-Fi 2.0 XML specification, but uses the JSON property name when listing the data element name. 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".
  • Description – Additional information about the element, including state reporting rules.
  • Data Type – The JSON data type specified for the data element output, such as string, integer, date-time, etc.

Note: The source PowerSchool field type may differ, 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 – A value of "R" or "O" indicates whether the element is required or optional in the Georgia DOE implementation.

Descriptors and Types

Many data elements have output values that are governed by standardized Descriptors or Types, designated by the presence of "Descriptor" or "Type" at the end of the JSON data element name. Descriptors and Types are bound by code sets that represent the valid state codes required by the Georgia DOE when Ed-Fi data is transmitted to the state. Types are generally standardized Ed-Fi value sets that are not state-specific. Descriptors are state-specific codes, often based on one of the types. Where a descriptor exists that corresponds to a type, the descriptor is used. There are also some cases where types are defined or extended by the state.

These codes, along with their descriptions, are included in the data views within the Descriptors category in the Download Data section on the PowerSchool Ed-Fi Reporting Page. The values stored in PowerSchool are mapped in the Ed-Fi output to

Descriptor or Type state code values using these Ed-Fi output conventions:

  • Descriptors are output using the CodeValue.
  • Types are output using the Short Description.

In many cases, local values stored in PowerSchool are mapped internally to the required Ed-Fi output values within the PowerSchool Ed-Fi publishing routines, and no user intervention is required. In some cases, local values stored in PowerSchool must first be mapped by the district to the equivalent Descriptor or Type state values on the Ed-Fi Code Set Mappings page. Additional information about Ed-Fi Code Set Mappings can be found in the Georgia Ed-Fi Administrator Setup Quick Reference Guide. As each state's Ed-Fi implementation is unique, also refer to the Appendix for further information about the required configuration of PowerSchool state codes, which are referenced when elements using Ed-Fi Descriptors and Types are published.

Education Organization IDs

Every resource includes a reference to one or more Education Organization IDs. These identifiers are typically assigned by the state and downloaded into PowerSchool. When resources and elements are subsequently published to the state, the same identifiers are used. As needed, local values residing in PowerSchool are automatically converted to the required state format. As an example, depending on the state, the PowerSchool source value for SchoolId may require transformation to add zero padding or to combine the school number with an additional identifier. Any required conversions are automatically applied during the Ed-Fi publishing process. The following abbreviations are used when referring to Education Organization IDs:

  • State Education Agency - SEAId
  • Local Education Agency - LEAId
  • School – SchoolId


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close