Use this Setup Guide to install and configure your Family Engagement solution using test data. At the end of this Setup Guide you'll have a test environment which closely mimics a production environment. This test environment allows administrators and stakeholders to test configuration changes being considered for the production environment without an impact on end-users. This test environment is separate and distinct from the sample environment created during the Quick Start.
Summary
Table of Contents maxLevel 2 minLevel 2 include Step \d+.*
Panel | ||||
---|---|---|---|---|
| ||||
More information This Setup Guide builds on core skills and concepts in the Family Engagement Quick Start. We recommend running that Quick Start before moving on to this more detailed Setup Guide. |
Solution Overview
In this section you'll get a general understanding of the components of your Family Engagement solution to provide context for completing the remainder of the Setup Guide.
The below diagram depicts the general architecture of your Family Engagement solution.
Gliffy | ||||||
---|---|---|---|---|---|---|
|
Once you complete this Setup Guide:
- Data from your Student Information System will flow into your Operational Data Store (ODS) via the ODS / API.
- Connections between your SIS and the ODS / API will be managed using the ODS / API Admin App.
- The Family Engagement Portal web application will connect directly to the Ed-Fi ODS database to retrieve the data and use it to generate your Family Engagement detailed views.
The core components, including web apps, are described in the /wiki/spaces/SK/pages/22018859 section.
The rest of this guide will instruct you on installing these components, connecting your SIS to the ODS via the ODS API, connecting the Family Engagement Portal application to your ODS, conforming your SIS data to the Ed-Fi Data Standard, and using the Family Portal to engage and support your family members, students, and staff with your data.
Step 1. Install
In this step you will install all of the components of the Ed-Fi solution summarized in the Quick Start section to start creating your district's test environment for your own Family Engagement solution. The installation requires Windows Server 2016-2019. If you would like additional information on what's required to install your solution please see general system and starter kit specific requirements.
Install Microsoft SQL Server
- Starting with a base Windows Server 2019 image install Microsoft SQL Server Standard (or higher).
- Setup your organization's authentication with the database
Install the Ed-Fi Solution
Install the Ed-Fi Solution Suite 3 v5.1.0 using the /wiki/spaces/TSINSTALL/overview.
- Review the Tech Suite Installer /wiki/spaces/TSINSTALL/pages/20055180 and /wiki/spaces/TSINSTALL/pages/20055184 details to determine if you want to use the EXE installer or Powershell scripts.
- Install the Ed-Fi components using the /wiki/spaces/TSINSTALL/pages/20055784of the installer.
Once completed you will have the following Ed-Fi components installed:
- ODS / API for Suite 3 v5.1.0
- Admin App v2.1
Install Microsoft Visual Studio
Toady, the Family Engagement Portal solution requires the Microsoft Visual Studio to build and deploy the web application. The Family Engagement Portal web application maintains a live connection to the ODS/API, but can be deployed to a separate Windows IIS-based web application server from the database server, You will be able to adjust those connection settings as needed during the deployment of the portal application.
You can download the appropriate version of Visual Studio here: https://visualstudio.microsoft.com/downloads/
Download the Family Engagement Code
Use this link to download the code for the Family Engagement Portal: https://github.com/Ed-Fi-Exchange-OSS/ParentPortal/archive/main.zip
Once you have downloaded it we recommend you unzip it to the following location: C:\Ed-Fi\QuickStarts\FamilyEngagement\
Panel | ||||
---|---|---|---|---|
| ||||
Reminder If you do not have a Visual Studio license, you will automatically obtain a trial license for all of the features needed with the Community Edition. This trial license is valid for 30 days after you first launch and build the portal application. You will only need a licensed copy of Visual Studio when you are building and deploying the Family Portal web application and will not need to keep a license after the application is deployed in production, except of course if you must rebuild and re-deploy the application. |
Step 2. Load Test Data
In this step you will load test data from your SIS to the ODS API so it can be available to the Family Engagement Portal web application.
Understand Dependencies When Loading Data
Before you can load your production or test data, your Ed-Fi ODS/API requires that each data item, whether submitted via API from your SIS or directly loaded in bulk to the ODS database, must be structurally and relationally consistent and syntactically valid according to the Ed-Fi Data Standard v3.x
Put simply, some data items must be loaded correctly before others can be loaded - and - each data item must follow the rules of the standardized vocabulary to load correctly.
But don't panic! You won't have to load everything in your SIS to get started. Furthermore, acceptable defaults for some needed data are already loaded in your Ed-Fi ODS/API to ease your start. If your SIS is Ed-Fi-certified, it will already have tackled these load order dependencies and other requirements, and you won't have to worry about these details now. However, it is important to know the proper loading order for your data to minimize the frustration of tracking down potential errors during the loading process.
Below, is a dependency graph for loading data into the ODS/API highlighted with the specific data needs for Family Engagement. The vertical path represents dependencies that must be satisfied as you move downward, while items in the same horizontal position can be loaded independently or simultaneously. The purple labels to the side describe key Ed-Fi concepts that may be new to you. Again, don't worry, you will learn more about these concepts as you continue.
Note that to get to the "green light" of successfully loaded student performance data, you must load the set of needed "reference" data above it in this chart.
Next, we will configure your Ed-Fi ODS/API and SIS to communicate via the API.
Add your Student Information System in the Admin App
- Follow the Admin App - Getting Started instructions in the to complete its initial configuration steps.
- Follow the Admin App - Next Steps to configure your first Vendor and Application entry for your Student Information System.
- Once you create an Application in the Admin App, you will store and use the generated "Key" and "Secret" in the next section.
- Note: Treat the Key and Secret as secure information for your organization (because it will control student data exchange from your SIS).
- Store it according to your local IT Security policy. Often this will be in password keeper app, or on a secure file server, or similar method (check with your IT department).
- Note that other applications you may add over time, for example Assessment applications used in other starter kits, will each have their own "key" and "secret".
titleBGColor | #ffffff |
---|---|
borderStyle | none |
Deep dive
For additional information on the Ed-Fi Data standard and vendors who support it see the pages below.
Links:
Panel | ||||
---|---|---|---|---|
| ||||
More Information If your SIS vendor is not Ed-Fi certified use the Vendor Request Form and we can help you make the ask of your vendor to support data interoperability and certify their product. |
Configure your Student Information System
Each SIS provider has its own vendor-specific configuration tool and steps to connect to the Ed-Fi API, perform basic data mapping, provide descriptors, and to enable you to begin loading data into your ODS API. You will connect your SIS to your ODS API using the key and secret you generated in the Admin App.
- Verify that your SIS supports Ed-Fi data interoperability, and is certified to use the ODS API to allow you to use this Family Engagement starter kit: Registry of Ed-Fi Certified Products - Student Information Systems API v3 Certification
- Verify that your district is using the version of your SIS that the vendor certified.
- If you are not running the current certified version of your SIS (or newer), plan your update/upgrade to the certified version of your SIS.
- If your SIS is not listed as an Ed-Fi certified SIS, use the vendor request form to the right side of this page to get our help in making your ask and conveying your requirements of your vendor.
- Request Ed-Fi enablement and configuration from your SIS vendor's product support team.
- Log into your SIS vendor's customer support portal or knowledge base to find the most current help documentation to guide you in the SIS configuration steps.
- Follow your SIS vendor's configuration guide to configure the product to connect to your ODS API and prepare for loading your data.
See General Reference page for a list of publicly known vendor configuration guides.
Map SIS Codes to the ODS API
- Once your SIS is configured to connect with the Ed-Fi API, the next step to getting your data to the ODS API is to map "code sets", or Descriptors, as they are known in the Ed-Fi data standard, from the data elements and codes used in your SIS to those you will use in the Ed-Fi ODS API. To do this:
- Refer to your SIS vendor configuration guide you used above to locate and use the data mapping tools in your SIS application.
- Proceed with your SIS vendor's data mapping instructions, referring to their configuration guide and the dependency chart provided above to work through the data mapping and loading in the right sequence.
- In the next step (3) of this setup guide, you will use these descriptors to understand how your data is displayed in the Family Engagement portal application.
- Review the Best Practices for Descriptors presentation if you would like more background explanation of descriptors and why they're relevant to your needs.
Panel | ||||
---|---|---|---|---|
| ||||
Need help? Having difficulty configuring your SIS or mapping SIS codes? Reach out to an Ed-Fi Alliance representative for assistance.
|
Step 3. Configure
In this step you will configure the application and settings to enable the data visualization capabilities of the Family Engagement Portal starter kit in your own test environment with your district's data.
Build and Deploy the Family Engagement Portal web application from Visual Studio
Once you have installed Visual Studio, from the Windows Desktop of your installation environment:...