UserGuide.md

Before Continuing with this User Guide, please make sure you have deployed the application.

• Deployment Guide

Once you have deployed the solution, the following user guide will help you navigate the functions available.

Index	Description
Uploading Data	How to upload data
Updating Data	How to modify the data schema
Home	Walkthrough of the Home page
Staging Website	Navigation to the Staging website
Individual Summary	Walkthrough of the Individual Summary page
Snapshot	Walkthrough of the Snapshot page

Uploading Data

Please refer to the Uploading Data Guide.

Updating Data

Please refer to the Modifying Data Guide.

Home

This page displays a table of TLEF funded proposals with information including:

• Funding Year - the funding year of the proposal

• Project Type - there are five types of TLEF projects: Large TLEF, Small TLEF, Flexible Learning projects, Interdisciplinary Team-Teaching Grant projects, and Universal Design for Learning projects

• Principal Investigator - the lead in charge of the particular proposal

• Faculty - the faculty targeted by the project

• Title - title of the funded proposal

• Project Year - current duration of the project

• Amount - amount of funding received

• Status - active or completed

• Report - project report, if it exists

• Poster - project poster, if it exists

  

At the top of the page, users are able to search proposals by their title or principal investigator. The projects are also filterable by funding year, project type, faculty/college/unit, and focus area. Applied filters are displayed below the filter and search area.

The Generate Program Summary button will take users to the Snapshot page.

Staging

The staging website provides a controlled environment for reviewing changes to the data before they are made public.

Navigate to Staging

To navigate to staging, add staging to the end of the URL. For example: https://main.d1kbeedktpnze5.amplifyapp.com/ to https://main.d1kbeedktpnze5.amplifyapp.com/staging

This will direct you to the login page, where authorized users can sign in with their credentials.

Generate Admin User

If you have already logged in, you can continue to the website. Otherwise, the following section will walkthrough creating an Admin user and logging in to the Admin page.

1. Navigate to AWS Console by searching for cognito

2. Navigate to User Pools in the sidebar and select the tlef-user-pool user pool

3. Next, we will create a user. Under Users, click on Create user.

4. Under User information:
   Select Don't send email invitation
   Input the user's email address under the Email address field
   Select Generate a password
   Click Create user
   

5. Now you will be able to login with the newly created admin user. Check your email for the temporary password to sign in. Upon sign in, you will be asked to change your password.

Navigating the staging website

Within the staging website, data that is currently in the /staging bucket in AWS S3 will be displayed. There are two additional features: confirming the new data changes (which will publish data to the main page), and logging out from the staging view.

Individual Summary

The individual summary page displays detailed data on each TLEF funded proposal. It can be accessed by clicking on the title of the proposal you're interested in within the data table on the home page.

The page provides an overview of the selected project. It includes details such as the project's status, the faculty/college/unit involved, and its duration. The summary outlines the project's objectives and overarching information. Project reports can be viewed by clicking "Link to Report", opening up the report as a PDF in a new window.

For each year of the project, there are details about the primary investigator(s), project types, funded amounts, focus areas, team members involved, and potentially the reach or impact of the projects.

If the project has posters, they are displayed under the project details for each year. If there are multiple years with posters, you can view each one by clicking on the forward and back buttons.

Similar projects and project outcomes are displayed at the bottom.

Snapshot

The Snapshot page generates a program summary and gives statistics and visualizations of the data.

Users can filter by a single funding year or a range of funding years, project type, faculty/college/unit, and focus area (refer to home for further details on the data schema). Filters applied to the data are preserved when navigating between the Snapshot and Home pages.

Information displayed includes:

• Success Rate - amount of projects that received funding during selected TLEF rounds

  

• Number of Grants and Projects - the number of grants and projects funded during selected TLEF rounds

  

• Funding Awarded - bar chart view of funding amounts for selected projects

  

  Users can hover over the bars or click on them in mobile to view specific data per faculty/college/unit.

  

• Student Reach - bar chart view of student reach for selected projects

  

  Users can hover over the bars or click on them in mobile to view specific data per faculty/college/unit.

  

• Faculty and Student Engagement - additional information about student and faculty engagement

  

*Please note that if there are no existing projects that apply to the filters the user has chosen, a message will be displayed instead.