Installation Guide for Canvas Administrators 

This guide outlines the three essential steps that Canvas Administrators must follow to install and configure the Quality Matters (QM) Course Reviewer LTI tool within their Canvas instance.

1.Register the LTI Tool (Dynamic Registration)

The Quality Matters Course Reviewer LTI tool utilizes IMS Global's LTI 1.3 Dynamic Registration process for a streamlined initial setup.

Steps:

1. Navigate to your Canvas Administrator dashboard.
2. In the left-hand navigation menu, click Admin, then select the Canvas account where you want to register the tool. 
3. Click on the Developer Keys link.
4. Click the + Developer Key button, then choose + LTI Registration
5. Paste the Dynamic Registration URL provided to you.
6. Click Continue.
7. Canvas will present a confirmation screen showing the details of the LTI tool. The following values in the Register App confirmation screen must be set:

• Click Enable & Close.
• You should now see Quality Matters Course Reviewer (if that’s what you named the tool) in the list of developer keys. On the row linked to the LTI tool you just registered, under the Details column find and copy the LTI tool’s client id (which should be of the form 110330000000000385.) You will share the LTI client id with Noodle, and you will also use it to install the tool in a course in Canvas.

The Quality Matters Course Reviewer LTI tool is now registered within the selected Canvas account. This is not the same as installing an LTI tool in the course, but rather permits installation of the tool at the course level. The LTI tool’s client id (e.g.: 110330000000000385) copied from the last step above is what is used to find and install the tool within a course.

2.Create and Submit a Canvas Developer Key (API Key)

The LTI tool requires a specific Canvas Developer Key (API Key) to securely interact with the Canvas environment and retrieve necessary course-level data. This key must be generated and then securely sent to Noodle/QM for configuration.

Steps:

1. Navigate back to your Canvas Administrator dashboard.
2. Click Admin, then select your institution's name.
3. In the left-hand navigation menu, click Developer Keys.
4. Click the + Developer Key button, then select + API Key.
5. Configure the key with the following settings:

6. Click Save.
7. In the list of Developer Keys, locate the API key that you just created (search by the Key Name you assigned above which will show in the Name column.). Toggle the State to On. A modal dialog will show named Turn On Developer Key. Click Switch to On.
8. Locate the API key again in the list of Developer Keys. Note down the client id 
9. You will need to note down and provide Noodle with two data points from the API key you just created, both of which are in the Details column of the API key’s row in the Developer Keys listing page.
   • Client id (which should be of the form 110330000000000385.)
   • Secret key (which will be revealed by clicking the Show Key button.)
10. Securely share the LTI client id, and the API client id and secret key with Noodle, and confirm that these have been received and applied before proceeding to the next step (Launch and Authorize the LTI Tool).

• Create a secret link to share API secret key. You can use services like onetimesecret.com or 1Password to mask the secret, and password protect then share link.
   
  • Onetimesecret instructions:
    • Go to https://onetimesecret.com/
    • Enter API secret Key
    • Select Passphrase (Record this as you will need to insert in the Noodle ticket)
    • Create Link
    • Save URL for Ticket submission
       
  • 1Password Instructions:
    • Open and unlock 1Password.
    • Find the item you want to share and select it, then select Share.
    • Choose when the link expires and who to share it with. If you choose to share the item with only some people, select Add email. Enter an qualitymatters@support.noodle.com and press , or choose an email address from the list of suggestions.
    • Select Copy Link, then send the link to the person or people you want to share the item with, like in an email or text message
       

3.Submit Noodle Ticket

4.Launch and Authorize the LTI Tool

The final step requires a Canvas Administrator to launch the tool in any course to complete the authorization handshake and confirm API access. Please only commence with this step once Noodle has confirmed receipt of the data you shared in the previous step.

Steps:

1. Navigate to any existing Canvas course (a test course is recommended).
2. In the course navigation menu, click on Settings.
3. Click the Apps tab.
4. Click on View App Configurations, then + App
5. In the Add App modal dialogue that loads, find the Configuration Type drop down, and select By ClientID 
6. Paste the client ID you copied from Step 9 in the “Register the LTI Tool” section, and click the Submit button.
7. The Add App model should update to show text similar to: Tool "Noodle QM" found for client ID 110330000000000384. Would you like to install it? Click the Install button.
8. You should see a success message display that shows The app was added.
9. Navigate to a course where you would like to use the tool.
10. Locate the "Quality Matters Course Reviewer" app in the course navigation. Note: the name of the tool will be the title you provided in step 7 of the Register the LTI Tool section above.
11. Click on the tool name to launch it.
12. The LTI will open, and a modal dialog will show asking to authorize the API that was created in the previous step (Create and Submit a Canvas Developer Key (API Key)).
13.  Click the Authorize button.

The tool is now fully configured and authorized for use across your Canvas instance.