Integrating the FeedbackFlow Assessment Platform into Canvas

This document provides instructions on integrating the FeedbackFlow Assessment Platform into your Canvas Learning Management System (LMS). If you have questions regarding any steps in this process, please contact your dedicated Client Success Manager. If your organization is running a 2018 or earlier version of Canvas, please update your Canvas to the latest version.

Generating a Canvas Developer Key

The instructions below will allow users to create a new Developer Key, which can be used to generate a Deployment ID for the integration.

1. Log in to Canvas as an admin.
2. Navigate to the Admin tab and click Developer Keys > + Developer Keys > + LTI Key.
   
3. From the Method drop-down menu, select Paste JSON.
4. Under Key Name, enter a name of your choosing, such as YuJa or FeedbackFlow.
5. Access your institution's JSON string by entering the following URL into a new browser tab:  https://<INST_URL> /P/LTI/Canvas/CanvasLTI3Config.json
   • Replace <INST_URL> with your zone URL. 
   • Example: https://lakewood.yuja.com/P/LTI/Canvas/CanvasLTI3Config.json
6. Copy the text in between the outer braces, and paste it under LTI 1.3 Configuration between the braces. The Redirect URls field will automatically be filled.
   
7. The following parameters are highly recommended. For more information on each parameter, please reach out to your dedicated Client Success Manager. Otherwise, please add the following parameters (including quotations) to the Custom Fields section in the JSON string.
   
   • "lti_login_id”:”$Canvas.user.loginId",
   • “canvas_course_id=$Canvas.course.id”
   • Note: The above parameters should be displayed as the following in the Custom Fields section of the JSON string:
     • "custom_fields": {
       "canvas_course_previous_context_ids": "$Canvas.course.previousContextIds",
       "lti_login_id": "$Canvas.user.loginId",
       "canvas_course_id": "$Canvas.course.id"
       }
8. Click Save to add the LTI Key.
   
   
9. Update State from Off to On and copy down the Developer Key for later use.

Adding FeedbackFlow to All Courses

With the LTI Developer Key set up, you can now go ahead and add FeedbackFlow to all courses in Canvas. If you wish to enable FeedbackFlow for specific courses, please go to Adding FeedbackFlow to a Specific Course.

1. Log into Canvas as an admin.
2. Navigate to the Admin tab and click Settings > Apps > View App Configurations.
   
3. Click on + App, then under Configuration Type, choose By Client ID.

4. Enter the Client ID obtained from step 9 in the Generating Canvas Developer Keys section, and then click Submit.

   
5. Next, click Install.
   
6. Once installed, click on the Gear icon and choose Deployment Id. Copy and store the ID in a secure location, it will be needed in a future step.
   

Adding FeedbackFlow to a Specific Course

With the LTI Developer Key set up, you can now go ahead and add FeedbackFlow to desired courses. The following steps should be repeated for each desired course. If you wish to enable FeedbackFlow for all courses, please go to Adding FeedbackFlow to All Courses.

1. Log into Canvas as an Admin.
2. Navigate to the desired course and choose Settings > Apps > View App Configurations.
   
3. Click on + App, then under Configuration Type, choose By Client ID.
4. Type in the Developer Key obtained in Generating Canvas Developer Keys step 7 then click Submit.
   
5. Next, click Install.
   
6. Click on the Gear icon and choose Deployment Id. Copy and store the ID in a secure location, it will be needed in a future step.
   

Integrating Canvas into FeedbackFlow

With FeedbackFlow set up in Canvas, the next step is to integrate Canvas into FeedbackFlow