LTI Canvas Admin guide - Electude

For general information about LTI, see our LTI 1.3 / Advantage Tool documentation. This document only applies to integration with the Canvas LMS.

1. Quick installation

This guide will explain how set up LTI integration with Canvas, with these features:

It will automatically enrol Canvas students and instructors in Electude groups with their name and email address.
The groups are automatically created in Electude. The name of each group will match the Course name in Canvas.
In Canvas instructors will be able to add links to Electude content in by Adding an item to a module in a course and choosing the External tool option.
Additionally in the Course navigation settings a direct link to Electude for instructors can be enabled, so they can view results of the associated group of students.
Grades will automatically be added to the course in Canvas if a student completes a module in Electude.

1.1. Log in to Electude and go to External access settings

Log in to your Electude administrator account.
Navigate to External access on the Settings tab.
In the Edit settings form, check Allow sites in frame.
Set Direct access to LTI 1.3.
In the Use defaults for drop down, select Canvas.
Select the LMS hosting option that applies to you:
- self-hosted
- by Instructure (production, beta or test)
If you select self-hosted you should change your.canvas.site in all URL fields to the real domain name of your canvas site. For Instructure hosted Canvas the correct URLs are already filled in.

External access settings for Canvas in Electude

Keep this page open as you continue, because you need to copy settings to and from Canvas.

1.2. Log in to Canvas and go to Developer keys

Log in to your Canvas administrator account in a new browser tab.
Navigate to the Developer keys of your account.
Click + Developer Key and choose + LTI Key.

Developer keys in Canvas

1.3. Create a Developer key in Canvas

In Canvas change the Method to Paste JSON.
Copy the Launch URL (target_link_uri) from Electude to the Redirect URIs in Canvas.
Copy the JSON LTI 1.3 configuration from Electude to LTI 1.3 Configuration in Canvas

Copy Launch URL and JSON configuration from Electude

In Canvas enter Electude LTI as the Key name. The screen should now look like this:

Paste values in Key settings in Canvas

Note: If you remove the line
```
        "visibility": "admins",
```
from the JSON configuration, the Electude direct access link will also be accessible for students.
In Canvas click Save and Customize. The screen below appears. Confirm by clicking Save.

Confirm Key in Canvas

Set the State of the key to ON in Canvas.

Set state of key to ON

Select and copy the number in the Details column. This is the Client ID.
Paste the number in the Client field in Electude's External access settings

1.4. Create an External App in Canvas

In Canvas go to the Apps section of the account Settings.

External Apps settings in Canvas

Click the + App button.
From the Configuration Type drop down list select By Client ID.
Paste the Client ID from step 3.

Add App in Canvas

Click Submit. The screen below appears.

Confirm Add App in Canvas

Click Install to confirm.
In the row of the new app in the table click on the cog icon and select Deployment ID from the drop down.
In the Deployment ID dialog select and copy the ID.

1.5. Save Electude External Access settings

Paste the ID from step 4 in the Deployments field in Electude. The screen should now look like this:
Click ok to save the settings.

See the Configuring LTI Advantage Tools documentation.

1.6. Configure Result Notifications

In Electude go to the Result notifications settings.

Result notifications settings in Electude

The setting 'Do not create line item automatically, only send grades for existing line items' allows you to determine for which modules student results are or are not passed on to your LMS. If you enable the setting, only grades of modules that have been added by teachers through the ’Select as LTI tool with line item’ will be sent to Canvas. If you disable the setting, all grades of modules with types that have been selected in the 'Module filter' will be sent to Canvas.
Check all types of modules for which the Electude LMS should pass grades to Canvas. Typically you should select all types, but you can e.g. limit this to tests only. If no grades should be passed at all, uncheck all options.
Save the settings by clicking ok.

This concludes the Electude integration with Canvas.

Note: The following sections should only be used if you have to deviate from the default.

2. Enhanced privacy

If you do not want to populate Electude accounts with name and email addresses, you can switch this off.

Important: note that the administrator and teachers in the Electude LMS will not be able to see which person is associated with a user account.

In step 1.4. Create an External App in Canvas:

Set Privacy Level to Private.

Privacy Level in Canvas

As an administrator in Electude in the Privacy settings, set Change account details to Users cannot change their account details.

Privacy settings in Electude

3. Custom data

In step 1.3. Create a Developer key in Canvas you can specify custom data to be sent in LTI requests. For more information about the supported custom data see Additional custom data of the LTI 1.3 / Advantage Tool document.

For example, if you have created a group Canvas in the Electude LMS and you want all new groups to be created as a sub group, you can specify parentgroup=Canvas in the Custom data field in the Customise Configuration screen.

Custom data in external tool configuration in Moodle

It is also possible to add custom data afterwards by editing the developer key and adding the custom data to the Custom Fields.

In the custom data you can use variable substitution as provided by Canvas.

3.1. Mapping courses to unique group names

If your Canvas environment has different courses with identical names and you want to map these to different group names in Electude, you can append the Canvas course ID by specifying this custom field:

group=${Context.title}-${Canvas.course.id}

4. Alternative placements

In the JSON configuration used in 1.4. Create an External App in Canvas there are three placements specified. One of these is a course navigation placement for instructors that can be enabled per course. Canvas allows additional placements and alternative configurations for this. To allow these placements you can edit the JSON before saving it in Canvas.

For more information see Canvas' Navigation Tools document.