Canvas Kialo LTI Setup Documentation

This article outlines how to set up Kialo Edu LTI integration for Canvas LMS. Kialo also supports LTI integration with Moodle and Blackboard.

Please note:

  • Self-hosted instances of Canvas may require reconfiguration to correctly support LTI. See the Troubleshooting section for more information.
  • An Admin for your Canvas instance is required to perform the initial set up of Kialo as an LTI app.
  • Only the Edu version of Kialo (kialo-edu.com) supports LTI integration.
  • Only LTI 1.3 is supported (versions such as LTI 1.0, 1.1, or 2.0 are not supported).
  • When accessing Kialo Edu via LTI:
    • students and teachers will be automatically signed into Kialo using their Moodle email address.
    • in discussions, students are automatically assigned the Writer role, while teachers are assigned the Admin role.

Admins: Setting up Kialo as an External App

Note: Ensure you’re an Admin on your Canvas instance. If you run into any issues, please refer to the Troubleshooting section and official Canvas documentation on configuring LTI keys and configuring external apps.

There are two parts to setting up Kialo LTI on Canvas: first adding the Kialo LTI key, then adding Kialo as an app.

Part One: Adding the Kialo LTI Key

  1. Navigate to Admin > {Name of your site} > Developer Keys.
  2. Click + Developer Key.
  3. Select + LTI Key.
  4. Enter the following information when required:
  5. In the Key Settings top section:
    • Key Name: Kialo Edu
    • Redirect URIs: https://www.kialo-edu.com/lti/launch
  6. In the Configure section:
    • Method: Manual Entry
    • Title: Kialo Edu
    • Description: a description is required, such as Kialo Edu
    • Target Link URI: https://www.kialo-edu.com
    • OpenID Connect Initiation Url: https://www.kialo-edu.com/lti/start
    • JWK Method: Public JWK URL
    • Public JWK URL: https://www.kialo-edu.com/lti/jwks.json
    • For LTI Advantage Services: Enable required LTI services
      • For Grading to function, check the following:
        • “Can create and view assignment data in the gradebook associated with the tool.”
        • “Can view assignment data in the gradebook associated with the tool.”
        • “Can view submission data for assignments associated with the tool.”
        • “Can create and update submission results for assignments associated with the tool.”
        • “Can view Progress records associated with the context the tool is installed in.”
      • To allow group mode (planned for future release), check the following:
        • “Can retrieve user data associated with the context the tool is installed in.”
        • “Can lookup Account information.”
    • For Additional Settings, set Privacy Level: Public (this is required so Kialo can read the name and email address of the user)
    • For Placements:
      • Remove the Account Navigation entry
      • Add an entry for Link Selection
        • Select Message Type: LtiDeepLinkingRequest
  7. Save the key. It should now be listed under Developer Keys.
  8. Toggle the State of the Kialo Edu key to On.
  9. Note the ID of the Kialo Edu key listed under Details (e.g. “10000000000001”). This is the Client ID required in the next step.

Part Two: Adding Kialo as an App

  1. Navigate to Admin > {Name of your site} > Settings > Apps.
  2. Click + App.
  3. For Configuration Type, select By Client ID.
  4. Enter the Client ID saved while adding the Kialo Developer Key.
  5. Click Submit.

Done! Kialo Edu should now appear in the External Apps list. You can recommend educators view the Adding Kialo Content to your Course section.

Teachers: Adding Kialo Content to your Course

Once Kialo has been added as an app to your Canvas instance (see above), it can be added to your courses. To do so:

  1. Navigate to a module in your course.
  2. Select External Tool from the top menu.
  3. Click Select Kialo Discussion. A popup appears.
  4. Select the discussion to display, then click Select Discussion. The popup closes and the URL field should be automatically filled.
  5. Enter a Page name for the discussion, such as Kialo Discussion.
  6. Click Add Item.
  7. When ready, Publish the course.

Done! The Kialo discussion has been added as an item to your course.

How accounts are managed

For Teachers

Teachers accessing Kialo via LTI need to be signed in on Kialo Edu (https://kialo-edu.com) in order to use the activity. If they are already signed in to Kialo, they can immediately use the LTI activity. Otherwise, they are prompted to log in (or create an account) the first time they click on Select content, or when opening an already configured Kialo activity.

For Students

Students who access Kialo via an LTI activity are usually automatically provided with a Kialo account with the same email address as provided by the LMS. The exact behavior depends on whether an account with the same email address already existed previously and some other factors.

Generally, if no Kialo account with the student’s email address has existed previously, a new account will be automatically created and the student is automatically signed into that account whenever they access Kialo via LTI. Subsequently, in most cases students won’t receive a login prompt.

If a Kialo account with the student’s email address has already existed before accessing Kialo via LTI, the student is prompted to log into that account by entering their password. Once they have entered their password, the account is linked to the LMS, so that the next time they access Kialo via LTI they are automatically signed in (even if they have been logged out of https://kialo-edu.com or if they access it via LTI on a different computer).

For security reasons, the student may be prompted to re-enter their password in certain circumstances, e.g. when they add or change an authentication method on their Kialo account.

Student Account Provisioning Details

When accounts are automatically created during the LTI process, their Kialo username is derived from the LMS account details. If still available, the Kialo account will have the same username as the account in the LMS. If the name is not available or invalid in Kialo, a valid account name will automatically be generated based on the student’s full name.

For provisioned student accounts, the Kialo terms and conditions are implicitly accepted, without the students having to explicitly check any checkboxes.

Troubleshooting

Prerequisites for Self-Hosted Canvas Instances

By default, self-hosted Canvas instances may not be correctly configured for LTI. If you run into issues, please review your configuration for the following changes. Note this requires file level access to the installation.

  • In canvas/config/security.yml, set lti_issuer to the base URL of your canvas instance. For example, “https://canvas.myuni.edu”.
  • On Bitnami AWS images, ensure that the file canvas/config/dynamic_settings.yml exists (there is a sample file in the same directory) and replace the key “development:” with “production:“. More information on this error can be found on Github and the Canvas Forum.

Unknown Learning Management System Error

If Kialo Edu is not able to automatically detect what type of LMS is attempting to connect via LTI, an error message is displayed:

We are unable to automatically detect your Learning Management System (LMS). We recommend that you use the Dynamic Registration service provided by the Learning Tools Interoperability (LTI) standard if it is available on your LMS. If that’s not possible, please Contact Support for assistance and provide them with your issuer details: “{issuer details}”.

If this occurs, Kialo Edu can assist in configuring the appropriate LTI endpoints for your LMS. Please contact Kialo Edu Support and include the type of LMS you are using, as well as the {issuer details} included in the error message.

Was this article helpful?

Back to top