Use this Setup Guide to install and configure your Clinical Experience and Performance solution using test data. This guide will walk you through setting up a test environment that closely mimics a staging or production environment. At the end of this Setup Guide you'll have a test environment with your own test data loaded, but to cover all required elements (credentials, candidates, surveys, and evaluations) for the Clinical Experience and Performance solution additional steps will be required as indicated at the end of Step 3.
This test environment allows your tech team, administrators, and stakeholders to test configuration changes being considered for the production environment without an impact on end-users. It is important to note that this test environment is separate and distinct from the sample environment you accessed during the Quick Start.
This Setup Guide assumes that you have access to a the following data (in CSV format), which provides the data to power the dashboard:
Student Information System data
Candidates who have received credentials from the state or other licensing body
Data on Candidates who have received evaluations
Data on Candidates who have received survey feedback
The following steps to get this test environment up and running are very similar to the steps for setting up a production or staging environment.
Summary
More information
This Setup Guide builds on core skills and concepts in the Clinical Experience and Performance Quick Start. We recommend running that Quick Start before moving on to this more detailed Setup Guide.
Solution Overview
This section provides an overview of the components of your Clinical Experience and Performance solution to provide context for completing the remainder of the Setup Guide. The diagram below depicts the high-level architecture and component interactions. Names and acronyms in the diagram are explained below.
The core components involved in this solution are:
Student Information System (SIS) Data.
Program Data.
Survey and Evaluation Data.
Credentials Data.
The Ed-Fi ODS / API & Tools, which include Ed-Fi ODS / API, Ed-Fi Admin App, and Data Import Tool.
Power BI Desktop, the application chosen to model, create, and deliver the Clinical Experience and Performance Dashboards.
Power BI Online, which allows you to publish the dashboard and manage the different users and roles.
The rest of this guide will instruct you on how to:
Install the above components.
Configure Education Organizations and apps in the Ed-Fi Admin App.
Load data via the Data Import Tool (SIS, Programs, Credentials, Surveys, Evaluations) to the Ed-Fi ODS.
Use the Clinical Experience and Performance Starter Kit to engage and provide support to staff, deans, and program managers.
Important data security notes:
Adhere to your organization's data security guidelines regarding student data.
We recommend using test data for this walkthrough.
If you only have access to production data (i.e., live data about students), you'll want to ensure the platform is as secure as your production environment. Consult your organization's IT or security resources for specific guidance.
Step 1. Install the Ed-Fi Solution
In this step, you will install the components of the Ed-Fi solution needed for the Starter Kit. These components are:
ODS / API for Suite 3 v6.1
Analytics Middle Tier v3.1
Admin App for Suite 3 v3.0
Data Import v2.0
Basic Infrastructure and Prerequisites
The list of infrastructure items you need to be successful is provided below.
Database Server (Windows Server 2019) with the following components installed:
PowerShell 5.0.
.NET Core 6.0 SDK.
Microsoft SQL Server 2019 Standard (or higher)
Web Server (Windows Server 2019) with the following components installed:
.NET Core 6.0 Hosting Bundle. The .NET Core 3.1 Hosting Bundle is required for running the API on IIS.
Internet Information Services. IIS is the web server that will run the ODS / API.
For more details on setting up required components and software, refer to Getting Started - Binary Installation. It is always recommended to follow your institution's best practices for maintenance and backups.
Install Ed-Fi ODS/API
Install the ODS / API for Suite 3 v6.1 by following instructions in the Getting Started - Binary Installation guide
Install Analytics Middle Tier
Install Analytics Middle Tier by following the instructions in the AMT Deployment Guide to install the 'EPP' and 'RLS' collections
Install Admin App
Install Instructions for Admin App can be found in the Admin App v3.1 guide
Install Data Import
Install Instructions for Data Import can be found in the PowerShell Installation for Data Import using NuGet Packages guide. Data Import configuration is also described below.
Time to complete
Installing the Ed-Fi Solution usually takes a few hours to a day, assuming you have access to the hardware and software prerequisites, and are comfortable working with Windows Server, IIS, and SQL Server.
The time to configure and coordinate data flowing from a certified SIS system typically takes anywhere from a couple of hours to a week or two of calendar time, depending on the type of SIS.
Step 2. Configure your Education Organizations and Applications
In this step, you will load test data from your SIS, credential, and financial aid providers to the Ed-Fi ODS / API for it to be available on the Clinical Experience and Performance dashboard. This step requires you to have access to data in CSV format for Data Import to load into the Ed-Fi ODS / API. If you would like to see sample data import templates and CSV data it can be found on our GitHub here.
Add Your Education Organizations in the Admin App
Once you have successfully installed the Admin App following the instructions provided above, you can continue to configure Admin App to add your Education Organizations. This configuration will allow your data to be loaded properly as much of it requires education organizations. You can also find instructions for AdminApp configuration at Admin App - Next Steps.
The first time you open Admin App will ask you to register a new user in order to get access to the utility. The user you set up can be used for any future access to the tool. You will also have the opportunity to create additional users later.
In order to register a new user you will need to provide an email address and create a new password.
As soon as you log in for the first time with your new user, you will see the following page to complete the set up of Admin App. You will need to click the continue button to complete the Admin App's initial configuration.
After this initial one-time set up you will see a screen like the following on your subsequent visits to Admin App. You can start by clicking on the "Settings" button within Admin App to configure your Education Organizations.
Click on the "Education Organizations" tab. You might see a spinning icon on screen as the admin app calls the ODS / API to retrieve existing education organizations. When the page finishes loading the "Local Education Agencies" radio button will be preselected. Choose the "Post-Secondary Institutions" radio button instead.
Click the "Add Post-Secondary Institution" button. This will pop up a new window that will allow you to add a Post-Secondary Institution, which represents the university or institution that your EPP is a part of.
Note: The Post-Secondary Institution ID, Name of Institution, Address, City, State and Zip Code fields are required. Post-Secondary Institution ID is a numeric field.
After you fill out the information click 'Add'. You will be taken back to the Education Organizations tab and should see the Post-Secondary Institution you just added. Now click on the 'Add School' button on the lower right under your Post-Secondary Institution.
A popup that looks very similar to the one you used to create the Post-Secondary Institution will appear. Fill in this form with a School ID that is different from the Post-Secondary ID from that last step. At least one grade level from the dropdown list. As well as the Name of your EPP and Address information for your EPP. Click the 'Add' button when you're done.
You will be taken back to the Education Organizations tab. You should see two education organizations. If you do, click the 'Home' button at the top right side of the page.
Click on the "Global" button within Admin App to configure the vendor and Application that will provide API keys and access for Data Import to load your data.
Click on the "Add Vendor" button within the Vendors tab to add the vendor you will be using with Data Import.
The Namespace prefix should be a URL which includes your institution's web domain (e.g., uri://www.demo.edu')
After you fill out the information and click on "Save Changes", you should see the new entry at the bottom of the screen.
Now that the vendor is created, the application needs to be added. Click on the "Define Applications" button to enter the Application menu. Click on Add Application
The application form will describe how the vendor will be used. Here is an example of how to fill out the Education Organization and Claim Set information.
Note: For test environments using the Ed-Fi Sandbox claim set is appropriate, bur if this is a production environment we suggest using a claim set tailored specifically to this Starter Kit.
The next screen will provide you a key and secret to be used with importing data. These values will be required in your data import configuration. Make sure to save this information off somewhere for safekeeping.
Finally, the information of the added application is displayed.
You will then submit the API URL and security information to your vendor so they can start to load data with you ODS / API.
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 API access to data in the Ed-Fi ODS).
Store it according to your local IT Security policy. Often this will be in a password keeper app, on a secure file server, or a similar method.
Need help?
Having difficulty with your Clinical Experience and Performance Starter Kit? Reach out to an Ed-Fi Alliance representative for assistance.
Ed-Fi Slack channel #starter-kits
Open a ticket in Ed-Fi Tracker