LTI 1.3 Test Tool

Return to 1.1 Configuration

Purpose

This tool lives on the same domain as a 1.1 test tool to facilitate testing of the 1.1 -> 1.3 migration process, which requires the tools to be on the same domain.

In addition, there hasn't historically been a in-house 1.3 test tool suitable for deployed environments. Though this doesn't yet have any other features besides a basic launch, this does fill that gap.

Currently, this tool only configures itself for two placements: course_navigation and assignment_selection. In the future this page will allow you to further configure the tool.

Installation (Deployed)

This tool currently only supports one registration per deployed environment - so it is installed as a SiteAdmin global DeveloperKey, and is available for you to install in any production/beta Canvas context you wish.

To install the tool in your root account, follow these steps:

  1. Copy this global DeveloperKey ID: 170000000000763
  2. Navigate to <account>.instructure.com/accounts/self/developer_keys, switch to the Inherited tab, click Show More, then Ctrl/Cmd-F for the global ID from step 1. Turn that key ON for your account.
  3. Navigate to the context in which you wish to install this tool (e.g. your sandbox root account). Go to Settings -> Apps -> View App Configurations -> + App, and choose By Client Id, and paste the ID from step 1.
  4. Reload the page. Congrats, the tool is installed! It will show up in a course sidebar and during assignment creation.

Installation (Locally)

This tool currently only supports one registration/client_id/Platform when developing locally, and is configured using environment variables.

To install the tool in your local Canvas, follow these steps:

  1. Visit the tool configuration page and copy the JSON there.
  2. Navigate to <local-canvas-install>/accounts/self/developer_keys, and click + LTI Key. Give it a name and select Paste JSON, then paste the JSON you copied in step 1.
  3. Save and close the new DeveloperKey, turn it ON, and copy its ID.
  4. In this repository, replace the CLIENT_ID entry in .env with this copied ID.
  5. Modify any other entries in .env to match your Canvas install domain.
  6. Restart the dev server after making any .env changes.
  7. Congrats, the tool is installed! It will show up in course sidebars and when creating assignments.