Outdated Method
This guide explains how to connect Canvas to GMetrix using Learning Tools Interoperability (LTI) 1.1. LTI 1.1 is an older connection standard. Do not use this method if your Canvas instance supports LTI Advantage (LTI 1.3). Use the Canvas LTI 1.3 setup guide instead.


Check which standard you're using
Your Canvas instance supports LTI 1.3 if you see "LTI Advantage" or are asked for any of the following:

• Client ID
• Registration URL
• OIDC URL

Even if your version of Canvas supports both versions of LTI, we recommend LTI Advantage (LTI 1.3). It's easier to manage and more secure.


Use LTI 1.1 to open GMetrix from Canvas when LTI 1.3 is unavailable. Instructors can add GMetrix Courses and Practice Exams to Canvas assignments. Supported Practice Exam scores can return to the Canvas Gradebook.


Contact GMetrix Support before continuing with a self-hosted, district-wide, multi-school, or other complex implementation.


Before You Begin

Keep Canvas and the GMetrix Administrator Portal open in separate browser tabs while you follow this guide.

  • Make sure you have access to the GMetrix Administrator Portal.
  • Make sure you have Canvas administrator permission to configure external apps for the intended account.
  • You need the GMetrix Consumer Key, Shared Secret, and Launch URL for each app you configure.
  • For a resource-specific app, you also need the generated accesscode and gmxresourcekey parameters.

Choose Where to Start

Canvas uses two app types
. The general app and resource-specific apps serve different purposes. You do not need to create the general app before creating a resource-specific app.

  • General GMetrix access: Complete Part 1 only when users need to open GMetrix without going directly to one resource.

  • Specific Course or Practice Exam: Complete Part 2 once for each resource that does not already have a named app.

  • Existing app: Skip to Part 3 when the required app is already available in Canvas.


TABLE OF CONTENTS


Part 1: Add General GMetrix Access

This part is optional. Complete it once for the intended Canvas account or course. Skip it when GMetrix is already installed or when you only need resource-specific apps.


In Canvas: Open the App Configuration

  1. Sign in to Canvas with permission to configure external apps.

  2. Open the intended account or course.

  3. From the navigation menu, select Settings.

  4. Select the Apps tab.

  5. Select View App Configurations.

  6. Confirm that a general GMetrix app is not already installed.

  7. Select Add App.

  8. Select Manual Entry from the Configuration Type list.

  9. Enter GMetrix in Name.


In GMetrix: Copy the Connection Values

  1. In the GMetrix Administrator Portal, select Integrations from the sidebar.

  2. Locate the LTI 1.1 section.

  3. Switching between GMetrix and Canvas, copy and paste the GMetrix LTI 1.1 credentials into their corresponding Canvas fields:

    • Consumer Key

    • Shared Secret

    • Launch URL


In Canvas: Install the General App

After pasting the credentials in their respective fields:

  1. Select Name Only from the Privacy list.

  2. Leave Custom Fields blank

  3. Select Submit.

  4. If Canvas asks you to confirm the installation, select Yes, Install Tool.

  5. Confirm that GMetrix appears in App Configurations.


Part 2: Add a GMetrix Resource

Complete this part once for each GMetrix Course or Practice Exam that does not already have a named app. A resource-specific app contains the parameters for one resource. It does not require the optional general app from Part 1.


In GMetrix

  1. In the GMetrix Administrator Portal, select Integrations from the sidebar.

  2. Locate the Link a Specific Resource section.

  3. Enter the Resource Key (gmxresourcekey) for the Course or Practice Exam.

    • Use the Look up button to find a specific resource key.

  4. Enter the Access Code for the intended Classroom or group.

    • Use the Look up button to find a specific Classroom or group's code.

  5. After the custom parameters appear, select Copy All Parameters.


In Canvas

  1. Open the intended Canvas account or course.

  2. From the navigation menu, select Settings.

  3. Select the Apps tab.

  4. Select View App Configurations.

  5. Confirm that an app for the intended resource is not already installed.

  6. Select Add App.

  7. Select Manual Entry from the Configuration Type list.

  8. Enter a name that identifies the resource, such as GMetrix: Excel Practice Exam.

  9. Copy the Consumer Key from GMetrix to Consumer Key.

  10. Copy the Shared Secret from GMetrix to Shared Secret.

  11. Copy the Launch URL from GMetrix to Launch URL.

  12. Select Name Only from the Privacy list.

  13. Paste the copied resource parameters from GMetrix into Custom Fields exactly as provided.

  14. Select Submit.

  15. If Canvas asks you to confirm the installation, select Yes, Install Tool.

  16. Confirm that the named resource app appears in App Configurations.


Repeat this process for each additional Course or Practice Exam you want to add to Canvas.


Why Canvas needs a separate app
Canvas stores the resource parameters in the manual app configuration. Without a verified GMetrix Content-Item workflow, one resource-specific app represents one GMetrix resource. Reuse that app in as many supported assignments or modules as needed.


Part 3: Assign a GMetrix Resource

Before assigning a resource, it must be added to Canvas as described in Part 2. Each resource must be added and assigned individually.


In Canvas

  1. Open the intended Canvas course.

  2. Create an assignment or open an existing assignment.

  3. Select Edit.

  4. Select External Tool from the Submission Type list.

  5. Select Find.

  6. Select the required GMetrix app from the list.

  7. Select Select to apply the app to the assignment.

  8. Enter the assignment point value.

  9. Select the required option from the Display Grade as list.

  10. Keep Load This Tool in a New Tab selected.

  11. Select Save & Publish.


Confirm the Resource

  1. Open the course.

  2. Select Student View.

  3. Open the GMetrix assignment.

  4. Select Load in a New Window if Canvas displays the option.

  5. Confirm that the intended GMetrix resource opens.


Repeat this process for each Course or Practice Exam you want to assign to a module.


After Setup

Publish Modules

After assigning resources to a Canvas module, the module must be published for students to access them.


Single sign-on (SSO)

The LTI connection signs learners in when they open GMetrix from Canvas.


Grade Passback

Supported Practice Exam scores can return to Canvas when the LMS item is configured for grading.


Resource management

Reuse the provider or app that is already configured. Add another resource-level link, activity, material, or app only when you need a different GMetrix resource.


Skills Management System (SMS)

Learners must install the desktop application for in-app tests. The macOS version is called SMSe. AutoCAD and Microsoft Office tests require SMS for Windows.