Page Comparison

Use this Setup Guide to install and configure your Chronic Absenteeism solution using test data. At the end of this Setup Guide you'll have a test environment which closely mimics a staging or production environment. 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.

It is important to note that this Setup Guide assumes that you have access to a certified Student Information System (SIS), which provides the data to power the dashboard.

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

Solution Overview

In this section you'll get a general understanding of the components of your Chronic Absenteeism solution to provide context for completing the remainder of the Setup Guide. The diagram below depicts the high level architecture and component interactions.

Once you complete this Setup Guide:

• Data from your Student Information System "SIS" will flow into your Operational Data Store (ODS) via the Ed-Fi ODS / API.
• Credentials and connections between your SIS and the ODS / API will be managed using the Ed-Fi ODS / API Admin App.
• The Chronic Absenteeism Power BI Starter Kit connects directly to the Ed-Fi ODS database and the Analytics Middle Tier to retrieve the data and use it to generate your Chronic Absenteeism Dashboard and Reports.

The core components involved in this solution are:

• A Student Information System (SIS).
• The Ed-Fi ODS / API & Tools, which include Ed-Fi ODS / API, Ed-Fi Admin App, and the Ed-Fi Swagger Documentation. 
• The Ed-Fi Analytics Middle Tier.
• Power BI Desktop, the application chosen to model, create, and deliver the Chronic Absenteeism 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:

• Installing these components.
• Connecting your SIS to the Ed-Fi ODS via the ODS / API.
• Connecting the Chronic Absenteeism Starter Kit application to your ODS.
• Using the Chronic Absenteeism Starter Kit to engage and support your staff, superintendent, principals, and teachers with your data.

Step 1. Install the Ed-Fi Solution

Step 2. Configure your SIS and Load Test Data

In this step, you will load test data from your SIS to the Ed-Fi ODS / API for it to be available on the Chronic Absenteeism Power BI Dashboard. This step requires you to have access to a certified Student Information System (SIS) capable of sending data to the Ed-Fi ODS / API. 

Add Your Student Information System in the Admin App

Once you have successfully installed the Admin App following the instructions provided above, you can continue to configure and add your "SIS" so that it can consume and write student data to the Ed-Fi ODS / API.

• 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 a password keeper app, or on a secure file server, or a similar method (check with your IT department). 
• Note that you may add other applications over time. For example, Assessment applications used in other Ed-Fi Starter Kits will each have their own API Client credentials ("keyKey" and "secretSecret").

Configure Your Student Information System

Each SIS provider has its own vendor-specific configuration tool and as well as steps to connect to the Ed-Fi ODS / 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 URL, key Key and secret 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 the Chronic Absenteeism Starter Kit: Registry of Ed-Fi Certified Products - Student Information Systems. 
  • Note: If your SIS is not listed as Ed-Fi certified, use the vendor request form provided to the right. Ed-Fi can help you convey your data requirements to your vendor.
• Verify that your district is using the version of your SIS that the vendor certified to 's SIS version is Ed-Fi 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.
• Submit a technical support ticket requesting to your SIS vendor requesting them to enable the Ed-Fi API client functionality for your district, and as well as to provide you with a product configuration guide. 
• Follow your SIS vendor's configuration guide to allow the product for instructions on how to connect to your ODS / API and prepare for loading load your data.

See the General Reference page for a list of publicly known vendor configuration guides.

Map Your District Codes to the Ed-Fi ODS / API Descriptors

• Once your SIS is configured to connect with the Ed-Fi ODS / API, the next step 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 district's SIS to those you will use in the Ed-Fi ODS / API. To do this: 
  • Refer to the SIS vendor configuration guide you used earlier in order 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, you will use these descriptors to understand how your data is displayed in the Chronic Absenteeism Dashboard.
• Review theRefer to the Best Practices for Descriptors presentation if you would like more background explanation of descriptors and why they're  presentation for more information on how descriptors may be relevant to your needsuse case. 

Let the Data Flow From Your SIS Into the Ed-Fi ODS / API

Quick recap:

• Using the Ed-Fi Admin App, you configured your SIS to be able to access the Ed-Fi ODS / API.
• Using the SIS configuration screen for Ed-Fi interoperability, you added the Ed-Fi ODS / API URL, and Key  Key and Secret so that it could connect to the API.
• Using the SIS configuration screen for codes and descriptors, you mapped your District's codes to the Ed-Fi Standard Descriptors.

Now you are ready to let the data flow into Ed-Fi. Contact your SIS vendor support team to launch the necessary processes to let the data flow into the Ed-Fi ODS / API. 

Note: It is always a good idea to collaborate with your SIS vendor support team so that both of you can monitor any issues preventing data flow from the SIS to the API. Some of the most  Most common issues are: Network connectivity issues, Data quality issues among othersinclude network connectivity and data quality.

If you run into any issues that require troubleshooting guidance, please do not hesitate to contact your Ed-Fi Alliance representative via one of the support channels provided in the /wiki/spaces/SK/pages/21992742.

Step 3. Install and Test the Chronic Absenteeism Dashboard

In this step, you'll install Power BI prerequisites, as well as download and run the Chronic Absenteeism Dashboards. 

Prerequisites

• At this point, you should have an operational Ed-Fi ODS / API with data flowing from your SIS.
• Additionally, you should have installed the AMT views on your ODS database.
• You will also need a machine that has access to the ODS database and has Power BI Desktop installed.

Install Power BI Desktop

The Chronic Absenteeism Dashboard was built with Microsoft's Power BI Desktop application.

To run the dashboard you will need a machine with:

• Access to the database server where you installed the Ed-Fi ODS database
• Power BI Desktop that can be downloaded at this link: https://powerbi.microsoft.com/en-us/downloads/

Download and Configure the Chronic Absenteeism Dashboard

The latest version of the Chronic Absenteeism Power BI Dashboard file is located in a GitHub repository.

Use the machine that has Power BI and create the following folder structure: C:\Ed-Fi\QuickStarts\CHRAB\.

Save this file onto that location by clicking this link: https://github.com/Ed-Fi-Exchange-OSS/Chronic-Absenteeism-Dashboard/raw/main/ChronicAbsenteeismDashboard.pbix.

Once the download completes, navigate to the folder where you downloaded the file and double-click it. This should open Power BI and load the Chronic Absenteeism Dashboard as depicted below:

The data that is pre-populated is the sample "Grand Bend ISD" populated template.

To connect to your Ed-Fi ODS, use the top menu and navigate to Home and then Transform Data. Click the dropdown arrow and select "Data source settings".

When the modal opens click on the "Change Source..." button.

A second modal will popup with inputs to configure your SQL Server server connection. Use the IP address or the hostname of the server that contains the database. Then input the name of your Ed-Fi ODS database. Usually the name of your database will be Ed-Fi_ODS.

Depending on the kind of security that is configured in your organization's security configuration, you can may use integrated or SQL server security. 

Once you click OK‘OK’, it might show you a few screens with SQL statements that it will ask you to run. Say OK or Run on them.you will see SQL statements. Click ‘OK or ‘Run’

Additionally, it might show you the following screen:

This is where you can switch from Windows Integrated Security to MsSQL security if you desire.

Proceed to click on connect and accept the defaults.

You will see a screen that will load data from your ODS like the one below. Note that it might take a minute or two to finish loading. This depends on the amount of data and students you have in your Ed-Fi ODS.

Once it finishes loading, you will be presented with loads, the Chronic Absenteeism Dashboard and it will be displaying display your data. 

If you haven't already, visit the Chronic Absenteeism Dashboard Walkthrough to learn more about how to use the Chronic Absenteeism Dashboard.

Step 4. Publish the Chronic Absenteeism Dashboard and Plan Your Rollout

The goal of this step is to publish the Chronic Absenteeism Dashboards to the Power BI Online service in a release targeted to your internal test users, thereby allowing them to let them login, view, use, and test the data visualizations. At the end of this step, you will be in a position to plan your rollout and deployment to your end users. 

Basic Power BI Online Setup 

We will guide you through some of the basics around Power BI Online.

For this dashboard to work you will need:

• A subscription to Power BI Online
• A few users created in Office 365 
• A Workspace to be able to publish the dashboard

Creating Users in Power BI Online

If you already have users created in your Power BI account you can skip to the next section.

To create users follow these simple steps:

• Login to Power BI Online
• Click on the menu on the top left of the screen and select  as depicted below.

• This will open the 365 admin center. From here click on  button indicated on the image below.

• This will open a modal window that will allow you to add a user. Follow the instruction on that modal to create a user.
• It is important to note that the users user's email address in Power BI should be the same as the ones in you SIS and in the Ed-Fi ODS. This is how we match the user that is logged in with a role in the Ed-Fi ODS.
• You can repeat this process to add all the users that will be accessing the Chronic Absenteeism Dashboard on Power BI

Creating a Workspace to Hold the Dashboard

Back on the main screen of Power BI Online, click on the menu icon and then on the "Workspaces" subsection. This will expand , which expands a side modal where at .  At the bottom you have a , click on the "Create a workspace" button . Click that button and on the right to toggle a slide-out form will appearon the right. This slide out form allows you to create and name the workspace. Name it something meaningful. For sake of this demo we named it "Ed-Fi Demonstration Workspace".

At this point you are done with this step.

Publishing the Dashboard

Open Power BI Desktop and Sign in with the account that has access to publish to Power BI online.

Proceed to locate and click on the "Home → Publish" menu entry as depicted below.

This will open a modal popup window. Select the workspace you created in the section above and click on the "Select" button.

In a few seconds you will see the modal popup indicating that it is publishing. When complete you will see a "Success!" message.

To confirm, we recommend that you login to Power BI Online and ensure you can see the Dashboard.

To do this, open your favorite browser and navigate to https://powerbi.microsoft.com/ and login.

Click on your workspace and you should see the "ChronicAbsenteeismDashboard" in the list.

Enabling Security on the Report

The report comes configured with a "Dynamic Security Role". To enable it in Power BI Online, follow these steps:

Open your browser and navigate to Power BI Online. Then proceed to open the workspace where you published the "Chronic Absenteeism Dashboard" report. Ensure that the "All" submenu has been selected, and click on the context menu for the row showing the "Dataset". In the context menu select the security option.

In the Row-Level Security page, ensure you click the "Dynamic Role."  Then add either a role or an individual users that user who will be able to view the report.

Click on the "Save" button once you are done adding groups or users to the members section .

To test the security, hover over the "Dynamic Role" and click on the context menu then select "Test as role"

This will load the report and you should see the widgets show blank data as most likely the user you are using will will most likely not be part of the security.

On the top blue menu, click on "Now viewing as: Dynamic Role" and enter the email of a previously configured user. In this case, we are going to use David Wilson who is a District Superintendent for Grand Bend ISD. This is our sample data set. Upon selecting the user, the report will refresh and show only the data that that user can seeis specific to that user profile. 

Explore by impersonating other users.

Here is a screenshot impersonating "Alicia Cameron" who is a principal at "Grand Bend Highschool"

As you can see, this user's widget numbers are reduced as she can only see students associated at the Highschool level.

Once a real When an actual user logs in they will see , the data will be filtered out to only what they have access toospecifically to that user’s profile.

Inviting/Sharing the Workspace