Tennessee Ed-Fi Start-Up Checklist 2023-2024

Tool Search: Ed-Fi

This article describes the steps you should take in order to set up Ed-Fi.

Step 1. Update to the most recent version of Campus

In order to have the schema and logic in place, it is critical you update to the most recent version of Campus. Failure to do this will result in an inability to properly report data for the current 2023-2024 school year.

Step 2. Enable Ed-Fi functionality

Enable Ed-Fi functionality via the Enable Ed-Fi system preference (Classic View: System Administration > Preferences > System Preferences > Enable Ed-Fi; New Look: System Settings > System Preferences > System Preferences).

Yes = Ed-Fi functionality is enabled and Ed-Fi data will sync from Campus to the Ed-Fi system (if properly enabled via Ed-Fi Configuration tools).
Tools Only = You are able to fill out Ed-Fi fields (such as Ed-Fi ID) within Campus but this data will not sync to the Ed-Fi system until this field is set to Yes. This is especially useful when setting up Ed-Fi IDs for students within a school or district so that data properly syncs between Campus and Ed-Fi prior to enabling it.
No = Ed-Fi functionality is not enabled for the district and users cannot access Ed-Fi tools within Campus.

Image of System Preferences editor with Enable Ed-Fi option highlighted System Preferences

Step 3. Create A New Ed-Fi Configuration for 2023-2024

You will need to create a new Ed-Fi configuration for the 2023-2024 school year.

Connection Detail
To do this:

Navigate to the Ed-Fi Connection Configuration tool.
- Classic View: System Administration > Ed-Fi > Ed-Fi Configuration > Connection
- New Look: Reporting > Ed-Fi > Configuration > Connection
Select New.
Select the Connection Type, options are Core or State.
Enter a Connection Name.
Select a School Year.

Enter the following values:

Field	Value
Ed-Fi Connection Type	State
O-Auth URL	https://uat.tneeducation.net
API URL	https://integration-edfi-api.tneducation.net
Post-Amble	api/31
Timeout in Seconds	This field defaults to a value of 60 seconds and determines (in seconds) the amount of time allowed to pass before the connection between Campus and Ed-Fi is considered timed out and Ed-Fi events are not processed. These Ed-Fi events are then re-processed the next time a quartz job runs.
Client Key	The Client Key will be provided by the Tennessee Department of Education.
Client Secret	The Client Secret will be provided by the Tennessee Department of Education.

If desired, a certificate can be imported for the Ed-Fi configuration. For more information, please see the 'Import Certificates' section of the Ed-Fi Configuration article.
Click the Save button.

Step 4. Set Ed-Fi Tool Rights

Set the Ed-Fi Tool Rights.

Classic View: System Administration > User Security > Users/User Groups > Tool Rights
New Look: User Management > User Groups > Add User Group

Review the Ed-Fi Tool Rights article for more information.

Image showing Ed-Fi tool rights with all options selected Tool Rights

Step 5. Set Resource Preferences

Set all Resources to 'Off' and map the Ed-Fi Codes to Campus Codes via the Resource Preferences in:

Classic View: System Administration > Ed-Fi > Ed-Fi Configuration > Resource Preferences
New Look: Reporting > Ed-Fi > Configuration > Resource Preferences

Step 6. Assign Ed-Fi IDs

Assign Student Ed-Fi IDs via Census > People > Demographics > Person Identifiers. See the Enter Ed-Fi ID article for more information.

Image of Person Identifiers editor with Get Ed-Fi ID button highlighted Person Identifiers - Ed-Fi ID

Step 7. Toggle Resource Preferences to On

Toggle Resources to 'On' in Resource Preferences once all data setup is complete.

Classic View: System Administration > Ed-Fi > Ed-Fi Configuration > Resource Preferences
New Look: Reporting > Ed-Fi > Configuration > Resource Preferences

Step 8. Do an Ed-Fi Resync for the 2023-2024 Scope Year

Now that the 2023-2024 Ed-Fi configuration is in place and data has been properly reviewed, an ordered resync should be completed as the first resync of the year. This is completed using the Resync tool.

For detailed information about this process, please see the Resync (Ed-Fi) article.

Resyncing will generate a large volume of items in your event queue, so it may be helpful to plan your resync for an off-peak time period and resync in groups of calendars rather than all calendars.

Image showing Resync editor with options for configurations and schools to resync Ed-Fi ResyncTo do this:

Go the Resync tool.
- Classic View: System Administration > Ed-Fi > Ed-Fi Tools > Resync
- New Look: Reporting > Ed-Fi > Resync
Select the appropriate Configuration.
Select the resources to resync.
Once data sets have been marked and you are ready to resync, select the Start Resync button.

Step 9. Review the Event Queue

Navigate to the Event Queue. Wait until all records have processed in the Event Queue (when it reads “0 records total” as seen below). Once there are no events in the Event Queue, turn off all Resource Preferences.

Classic View: System Administration > Ed-Fi > Ed-Fi Tools > Event Queue
New Look: Reporting > Ed-Fi > Event Queue

Image of Ed-Fi Event Queue Event Queue

Step 10. Review the Error Log

Navigate to the Error Log. Review the Error Log and note any errors that exist. When you feel like you’ve addressed all of the underlying causes for the errors, click “Archive All Entries” on the Error Log tab (which will remove them from the list) and return to Step 8, retrying the resync of data.

Classic View: System Administration > Ed-Fi > Ed-Fi Tools > Error Log
New Look: Reporting > Ed-Fi > Error Log

Image showing Ed-Fi Error Log with Resource/Table tab displayed Ed-Fi Error Log