Tool Search: Configuration
The Ed-Fi Configuration tool allows you to setup and manage the data connection between Campus and the Ed-Fi system, and determine resource preferences.
Ed-Fi Configuration rights provide access to Resource Preferences.
Read - View the Resource Preferences.
Write - Modify existing Resource Preferences.
Add - Create new Resource Preferences.
Delete - N/A
Connection Detail rights provide access to the Connection Detail values.
Read - View the Ed-Fi Connection Detail editor.
Write - Modify Ed-Fi Connection Detail values.
Add - Create new Ed-Fi Connection Detail records.
Delete - Delete Ed-Fi Connections.
For more information about Tool Rights and how they function, see the Tool Rights article.
Connection Details
See the Ed-Fi Configuration Tool for more information.
Ed-Fi Configuration values are created by the Ed-Fi ODS and are entered by the district. When information does not make a successful connection, work with Campus Support to troubleshoot your issues.
Ed-Fi Connection Details for Vermont
The following describes each Ed-Fi Configuration field.
| Field | Description |
|---|---|
| Connection Type | Indicates the type of Ed-Fi connection, either State or Core. |
| Connection Name | The unique name given to the connection. |
| School Year | The school year scoped for the configuration values entered. Start Date and End Date values should be entered for the school year in the School Years editor. Otherwise, a default Start Date of 7/1/XXXX is used and a default End Date of 6/30/XXXX is used to determine what year to send data (where XXXX = the Start Year and End Year values entered on the School editor). |
| O-Auth URL | The base URL of the endpoint to retrieve an OAuth Token. Please see the O-Auth URL and ID Post Amble Information section below for details on entering information in this field. |
| API URL | The base URL of the API. |
| ID Post-Amble | The URL for Ed-Fi resources and Ed-Fi Identities is generally different, so this parameter is to store the URL segment for identities (this is appended on to the API URL). Please see the O-Auth URL and ID Post Amble Information section below for details on entering information in this field. |
| Timeout in Seconds | This field 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 reprocessed the next time a quartz job runs. This field is defaulted to a value of 60 seconds but can be modified. |
| Client Key | The client key. There could be multiple APIs attached to one given URL. They are demarcated based on a key. |
| Client Secret | The secret that goes along with the above key. This is used to generate the OAuth token. |
| Test Connection | Selecting this button initiates a check to see whether the values entered in the configuration fields are valid and proper connection has been made between Campus and Ed-Fi. When a connection is made, a message saying "Connection is Valid" displays. |
O-Auth URL and ID Post Amble Information
| Field | Value | Example |
|---|---|---|
| O-Auth URL | The server URL concatenated with /edfi.ods.webapi. | When the Base URL is https://edfiods-dev002.infinitecampus.com/edfi.ods.webapi/data/v3, then the O-Auth URL is the part of the Base URL before /data. Add https:// to the beginning when it is not present. So in this example, the O-Auth URL is: https://edfiods-dev002.infinitecampus.com/edfi.ods.webapi.
|
| ID Post Amble | The ID Post Amble is /data through the end of the Base URL. Note: The end year of the school year is optional as part of the ID Post-Amble in Ed-Fi 3.1. | When the Base URL is: https://edfiods-dev002.infinitecampus.com/edfi.ods.webapi/data/v3, then the ID Post Amble is /data through the end of the Base URL. So in this example, the ID Post Amble is: /data/v3. |
Enter Ed-Fi Configuration values
- Click the Connection button. The Connection Detail editor displays.
- Enter the Connection Name.
- Select the School Year.
- Enter the O-Auth URL.
- Enter the API URL.
- Enter the Post-Amble.
- Enter the Timeout in Seconds (or leave the default value of 60).
- Enter the Client Key.
- Enter the Client Secret.
- Select the Save icon.
- Click the Test Connection button to ensure configuration values were correct and a connection to Ed-Fi was made. When a proper connection is made, a message saying "Connection is Valid" displays.
