Overview
The Data Import tool allows users to define templates, which map data sources to an Ed-Fi ODS / API. The Ed-Fi Template Sharing Service provides users of the Data Import tool the ability to share templates with other organizations using import and export features built in to the tool.
Data Import templates have been submitted by other Ed-Fi community members based on actual implementations.
Important Usage Note
Shared templates provide a significant head start to mapping source data for import. However, Ed-Fi ODS / API instances can be customized, and source data formats often change from implementation to implementation (even within the same product version). So, these templates can save you time with Data Import setup but are NOT intended as a definitive or canonical mapping for source data.
When using Data Import templates you've imported from other organizations, always review carefully to ensure that the template components — that is, the maps, lookups, and bootstraps — match your scenario, source data, and Ed-Fi ODS / API configuration. You will often need to make modifications to imported templates to fit the needs of your specific implementation.
Sharing Setup
This form requests an API key and secret for the Template Sharing Service to enable this functionality within Data Import. Once submitted, the Ed-Fi Alliance will contact you with a key and secret for use within Data Import. This process may take a few days.
This is a service provided under the Data Import license agreement.
Please use this link to a Google form request a key and secret to the Template Sharing Service. We will follow up via e-mail with access information for this service.
Enabling Template Sharing
Once you have a key and secret for the template sharing service, that information can be used to enable this function within Data Import. Instructions follow.
Step 1. Click on Configuration
Step 2. Enter Ed-Fi Template Sharing Service information
The Ed-Fi Template Sharing Service allows for sharing of metadata (maps, lookups and bootstraps) between Ed-Fi adopters to solve similar challenges with legacy CSV data. Please see the Template Sharing page on more information on this service and to request a key and secret.
Configure the following fields:
- Sharing Key. Template Sharing Service key
- Sharing Secret. Template Sharing Service secret
The "Test Template Sharing Service Connection" button can be used to verify the connection.
Step 3. Click on Admin > Template Sharing to Verify Connection
Step 4. Service Verification
If you see "Grand Bend 2019 Sample..." you are connected to the template sharing service. You can use "View" to import the Grand Bend example (with a sample map, a lookup group, and four bootstraps), and "Share Template" to share existing templates.
Troubleshooting
If there are issues using the template sharing service, please create a ticket in Ed-Fi Tracker using the EDFI queue. Please use these templates with caution and ensure they are fully reviewed for your implementation before putting to use.
Accessing Shared Templates
Data Import uses the Ed-Fi Exchange to share templates. Use the Import/Export feature in Data Import to consume and publish new templates.
| Info | ||
|---|---|---|
| ||
You can review Data Import Templates that have been published by the Ed-Fi Community at Published Data Import Templates. |