Canvas (LTI 1.3) LMS Admin Install Guide

This guide is for LMS admins installing the CourseKata application so that it can be used for all courses on a Canvas learning management system using the LTI 1.3 protocol.

\uD83D\uDCD8 Prerequisites

To follow this guide, you will need

• an instructor account at CourseKata. If you do not have one, you can request one (free) at our website. Make sure to mention that you are an LMS admin, and use your institutional email address.

• permissions to install external LTI tools into your LMS.

• a class in your LMS to test the installation in.

 \uD83D\uDCD8 How CourseKata Works

CourseKata content is built and hosted on our servers and delivered via <iframe> over the LTI protocol to your Learning Management System (LMS). To make this work, you will need to install both the CourseKata application as an external LTI tool, as well as the content as modules in your course. This document will start by explaining how to install the tool—and then how to get the course content linked up with your class.

 🛠️ Registering the Tool

Registering your Platform on CourseKata

1. Start at our platform registration page.

2. If you see a platform listed for your institution, congrats! It looks like someone has already installed this on your platform and assigned you as the owner. You can check that the settings there are correct, and move on to 📘 Importing Content below. If not, click Register Platform at the top right.

3. Enter the information for your platform there, then click Register Platform to continue.

4. Choose the IMS LTI 1.3 pathway and then leave the page open at this step.

Registering CourseKata on your Platform

Congrats! The CourseKata tool should be installed in your LMS and you should see the ready icon. If this is not the case, please don’t hesitate to reach out to info@coursekata.org for help. Next, you will need to Deploy the tool and share it with the relevant Org Units.

1. Navigate to the Admin panel, then Developer Keys, then + Developer Key then + LTI Key

2. In the popup first change Configuration Type to By URL then use the following settings:

   1. Key Name: CourseKata

   2. Redirect URIs: https://coursekata.org/lti/authentication/new

   3. JSON URL: from the page on CourseKata that you opened in the last section, copy the JSON URL over

   4. Click Save and the CourseKata tool should now be in the list of Developer Keys

3. Find the CourseKata tool, and click the pencil icon to Edit. In the configuration area find Additional Settings and make sure Privacy Level is set to Public. Then Save again (or Cancel if you changed nothing)

4. Find the CourseKata tool and copy the Client ID from the Details. Copy the value directly above Show Key. Don't click Show Key to see and copy a longer ID. Paste this copied key into the Client ID field on the CourseKata page you opened in the last section.

5. Review the other values on the CourseKata page, and click Save.

🎉 Congrats! The CourseKata tool should be ready for deployment and you should see the ready icon. If this is not the case, please don’t hesitate to reach out at tech@coursekata.org for help.

Deploy your tool so that instructors can use it

1. Navigate to the Admin panel, then Settings, then Apps, and click + App

2. In the popup use the following settings:

   1. Configuration Type: By Client ID

   2. Client ID: use the Client ID you copied in the previous step

📘 Importing Content

🎉 CourseKata is now installed and ready for your instructors to use. From here, you can test that the installation is working properly by creating a test course. This is the same process that an instructor would follow to create their course.

1. From the menu on the top right of CourseKata, choose My Classes under Teaching.

2. Click the New Class button and choose New Class

3. Fill out the form with your institution’s information, and make sure to mark that This is a test class (real instructors will choose real class) but this helps us categorize cleanups. If you are unsure of which book, you can just choose our flagship College / Statistics and Data Science (ABC), though it doesn’t really matter which you choose. When you are done, click Create Class.

3. Copy and paste the URL to your Canvas course into the textbox click to the next step where you will download your cartridge for the course.

5. In your Canvas course, on the Home page, in the right panel click the button to Import Existing Content. (If you are in the Settings page, it will say Import Course Content but it is the same button.)

6. In the dropdown menu choose Common Cartridge 1.x Package, add the cartridge that you just downloaded in step 4, then choose the radio button for All Content

7. Click Import and wait for the process to finish. You will probably get a notification that looks like this, with many warnings you can ignore these

   

🎉 The content should now be properly imported! Head to your Modules section and choose one of the CourseKata modules like My Progress + Jupyter. When you access the module, you should see a sign in page where you can sign in and choose which class on CourseKata matches the one that you are in.

Troubleshooting

Email was not provided by the LMS. Please confirm that CourseKata’s Privacy level is set to Public.

If you see this error and have confirmed that the privacy level is indeed public, your Canvas instance may not be sending the email anyway. You can, however force it to do so:

1. Navigate to the Admin panel, then Developer Keys

2. Find the CourseKata tool, and click the pencil icon to Edit. In the configuration area find Additional Settings and make sure Privacy Level is set to Public

3. In the same Additional Settings section, add the following two items to the custom keys box:

custom_canvas_email_address=$Person.email.primary
custom_canvas_user_name=$Person.name.display