Overview
This checklist helps troubleshoot common issues when integrating Canvas with Planning & Self-Study. It covers key setup areas: ensuring foundational data files are correctly loaded in P&SS, checking Canvas LMS configurations and administrator permissions, understanding prerequisites for pulling data from Canvas, and managing data refreshes. Following these steps helps ensure accurate and timely data flow for reporting and planning.
1. Initial Setup: Foundational Data Files
Before connecting Canvas, it is essential to ensure core data files are loaded in Planning & Self-Study. Completing the companion course first can provide a deeper understanding.
Planning & Self-Study: Required Data Imports for System Administration
Planning & Self-Study: Optional Data Imports for System
For IT Administrators:
- Understand Required vs. Optional Fields: Note which data files/fields are necessary for the Canvas integration and which ones add more detail to reports.
- Student Learning & Licensure (SLL) Users: If SLL is in use and some data files are already loaded, section IDs may need updating to match Canvas.
-
Section ID Match:
- Confirm the Section ID in the P&SS Section file (System Administration) matches the SIS ID (under Course Details) in Canvas.
-
Student Email Match:
- Verify the email address listed for students in the P&SS People file and Enrollment file (System Administration) matches the email address used in Canvas.
-
Identify Terms:
- Identify all academic terms for which Canvas data needs to be brought into P&SS.
-
Term ID Match:
- Confirm the SIS ID (under Term Details) in Canvas matches the Term ID in the P&SS Terms file (System Administration).
2. Canvas LMS Considerations
For LMS Administrators / Planning & Self-Study System Administrators:
-
Canvas Admin Account Permissions:
- Review the necessary permissions for the Canvas-proper administrator account. Required Permissions for Canvas Role
-
Consortium Institutions:
- If the institution is part of a consortium, review the information in the Sub-account level help article.
3. Canvas LMS Configuration
For LMS Administrators:
Best practice: Load foundational data files in P&SS first, then activate the Canvas integration.
-
Integration Setup Steps:
- Review the How to Set Up Advanced Canvas Integration help article for configuring the Canvas integration.
-
Pay close attention to Step 7 in the article, as this step offers two options for selecting which terms to pull data from. If option 2 is chosen, then ensure that term end dates are set in Canvas for the specific term from which data is being pulled. If no term end dates are set, assessment results may not come through.
4. Using the Integration
For Planning & Self-Study System Administrators:
Canvas Source Material Prerequisites
-
Data in Canvas:
- Confirm the data to be pulled already exists in Canvas. Planning & Self-Study can only pull existing Canvas data.
- Verify that completed assessments for Rubrics or Activities exist in Canvas.
Measures
-
Alignment to Measures:
- Ensure the correct alignment has been added to the measure in P&SS. Adding an Alignment to a Measure
-
Met Criteria:
- Confirm that the "Met" criteria has been set for the rubric or activity in P&SS.
- Note: Rubrics with an overall grade will not be considered by P&SS for use as a Met threshold.
-
Correct Plan:
- Confirm the correct plan is selected in P&SS for the data being pulled. (For example, if Spring 2025 data is desired, ensure Canvas has Spring 2025 data and it is being pulled into the respective Plan in Planning & Self-Study).
Data Filtering
- Optional - You can filter your results by the following data points, but they would need to be expressed in the appropriate data files indicated below
| Filtering Value | CSV Import File | CSV Field | Description |
|---|---|---|---|
| Modality | Sections | Delivery_Method | The delivery method of the section, such as online or hybrid |
| Gender | Basic Person Attributes | Gender | The gender of the person, usually as reported to IPEDS |
| Race/Ethnicity | Basic Person Attributes | Race/Ethnicity | The combined race and ethnicity values of the person, usually common in combined Race/Ethnicity reporting |
| Generation | Basic Person Attributes | First_Generation | The flag indicates if the person is a first generation student |
| Pell Eligibility | Basic Person Attributes | Pell Eligibility | The flag indicates if the person is eligible to receive PELL grants |
| Attending Status | Student Term Attributes | Attending_ Status | This flag indicates if the person attends Full Time or Part-Time |
| Primary Major | Student Term Attributes | Primary Major | The primary major of the student during the given term |
5. Data Refreshes
By default, Canvas data updates and pulls into Planning & Self-Study every two weeks (2 weeks from the last data pull). However, a refresh may be needed sooner.
For Planning & Self-Study System Administrators:
A refresh from Watermark Support is needed if:
- It is within the two-week window and data is needed sooner.
- Data has been back-entered in Canvas after the initial refresh.
- To initiate a refresh, contact Watermark Support.
Note: The first data sync pulls all past data, current term data, and any future terms that have been mapped or synced (for option 1). For any manual refreshes after that, please submit a support ticket.
6. Ongoing Data Management
- Create a recurring schedule for uploading data to ensure the P&SS system stays up-to-date