We have a new Perusall integration method available (it is called LTI 1.3). Benefits include: group sync, roster sync, seamless grade pass back, and no need for the Key & Secret! Learn more about the difference between the integrations.
For this setup process, your IT Administrator is required to do the installation. If your IT administrator chooses to proceed, they can view our set up guide here Canvas Admin Setup.
Click the image below to watch tutorial video (1:10 runtime).
Step 1: Request Key & Secret
To connect Perusall to Canvas, contact support@perusall.com to obtain the institution’s Consumer Key & Shared Secret. Please email in from your official university email address using the subject line “Key and Secret Request.” For security verification purposes, please provide a link to an institutional web page that shows your name, email address, and title/affiliation.
Step 2: Install Perusall & Create your Perusall course
To connect Perusall to Canvas, there are two ways to add the tool.
-
- In a Canvas course, click Settings > Apps.
- Search “Perusall” in the Filter by name field, and click + App.
- Enter your institution’s Consumer Key and Shared Secret (request these from Perusall Support as needed) and then click Add App.
- Refresh the page and select the Navigation tab. Then scroll to the bottom, drag Perusall up to the list of viewable apps, and click Save.
- After refreshing the page, Perusall will appear on the side navigation of your course. Launch the button and you will be taken to your new course! Students can also click this link to launch into your Perusall course.
-
- In a Canvas course, click: Settings > Apps > View App Configurations > + App
- Choose By URL from the Configuration Type dropdown menu.
- Enter “Perusall” in the Name field, enter your institution’s Consumer Key and Shared Secret , and in the Config URL field enter: https://public.perusall.com/downloads/lti-config.xml
- Click Submit.
- Refresh the page and select the Navigation tab. Then scroll to the bottom, drag Perusall up to the list of viewable apps, and click Save.
- After refreshing the page, Perusall will appear on the side navigation of your course. Launch the button and you will be taken to your new course! Students can also click this link to launch into your Perusall course.
After you've set up your Perusall course, you can create assignment links in Canvas for your students to access your Perusall course content. When a student clicks on a Perusall link in your Canvas course, a Perusall account will be created and they will automatically be enrolled in your course.
Grade Sync to your Canvas Course
You can sync students' average or total assignment scores OR students’ individual assignment scores back to Canvas. Click on the toggles below to learn more.
-
A student’s average score is each individual assignment score summed and then divided by the total number of assignments, while the total score simply takes the sum of across all assignments.
Syncing the average or total score rather than individual assignment scores saves time because an instructor will only need to create one Perusall link in a Canvas assignment rather than an assignment link for each assignment. Students will access Perusall through this link.
- Launch into your Perusall course> Click Settings > Scoring > scroll to Grade sync to LMS > select Automatically sync students' average or total scores back to the LMS > save.
- Return to your Canvas course Assignments page, and Create an assignment link by clicking: Assignments > +Assignment
- Title your Perusall Link. (For example, “Perusall Assignments”.)
- The number in the Points field should be set to the highest possible score a student can earn.
- For average grade sync, this can be found under Settings > Scoring > General > Assignment score range.
- For total points sync, this is the total number of points of all Perusall assignments that students will be completing over the duration of your course.
- Choose External Tool from the Submission Type dropdown menu, select Perusall in the tool list (or enter https://app.perusall.com/lti/launch as the External Tool URL) and then enable Load this tool in a new tab.
- Click Save & Publish.
Students will click the Perusall link you created to access their Perusall assignments and Perusall will pass their average scores back to Canvas as you release assignment scores in Perusall.
-
To sync students’ individual assignment scores, you will create assignment links in Canvas for every assignment in Perusall.
- Launch into your Perusall course > Click Settings > Scoring > scroll to Grade sync to LMS > select Automatically sync individual assignments scores back to the LMS > then save.
- In Perusall, click: Course home > Assignments > select an assignment > Copy full title for LMS. The assignment name will be copied to the clipboard.
- In Canvas, click Assignments > +Assignment. Paste the assignment’s title into the Assignment name field.
- The number in the Points field should match the high end of the Assignment score range of your Perusall course (found under Settings > Scoring > General).
- Choose External Tool from the Submission Type dropdown menu, select Perusall in the tool list (or enter https://app.perusall.com/lti/launch as the External Tool URL) and then enable Load this tool in a new tab.
- Click Save & Publish.
- Test the assignment specific link you just created by clicking Open in a new window. You should launch directly into its corresponding assignment in Perusall.
Repeat this process for each Perusall assignment.
We suggest hiding the generic Perusall link (created in Step 2: Install Perusall & Create your Perusall course) from the students’ view in Canvas so students only use the assignment-specific links, thereby ensuring grade sync works correctly by disabling it in Settings > Navigation.
In order to successfully sync individual assignment scores, students must access each Perusall assignment by clicking its assignment-specific link in Canvas. If a student does not, then Perusall will not be able to send the student's scores back to Canvas.
See our general LMS troubleshooting page for other common issues.
Canvas Group Sync
Our LTI 1.1 integration allows you to sync your Canvas groups to Perusall. To sync your groups to Perusall, you must only have one 'Group Set' in your Canvas course.
- In Perusall click: Settings > Grouping > Specify groups > Apply groups from Canvas > Save changes.
- In Canvas, click Settings > Apps, locate Perusall, and click on the gear icon > Edit. The Custom Fields text box should have the following on a line by itself: group_ids=$Canvas.group.contextIds
If you already have students enrolled in the Perusall course, they will temporarily be placed in Group 1. Upon their next launch into Perusall, these students will be sorted into their corresponding Canvas groups. Perusall group numbers will not necessarily correspond with the Canvas group names, but students grouped together in Canvas will be grouped together in Perusall as well.
If all of your students have been assigned to groups in Canvas, Group 1 will be empty once all students join the course in Perusall. Any student not assigned to a group in Canvas will automatically filter into Group 1 in Perusall.
Perusall's LTI 1.1 integration is not compatible with multiple group sets in Canvas, however our LTI 1.3 integration is! Talk to your admin about upgrading: Canvas Admin Setup.
'View as student' in Canvas
Canvas' Student View button will not work with Perusall, since Canvas doesn't send an email address to Perusall as part of that launch. To see what students will see once they launch into Perusall, utilize the Student View link on the left navigation bar within your Perusall course. Otherwise, you can click on your Perusall assignment links to see the same launch behavior that students will see.
Related to