Admin Guide: Configuration for Canvas

Step 1 - Developer Keys

Navigate to Admin / Developer Keys and select + Developer Key, + LTI Key buttons.

Under the Developer Key, enter the following into Key Settings: 

Key Name: HealthSmart

Owner Email: support@etr.org

Redirect URIs: https://www.etr.org/Slatwall/index.cfm/lti/oauth/launchv1p3

 

For the method of configuration, select Paste JSON.

 

Copy and paste the contents of the provided JSON below into the configuration box and give the key a name using the Key Name box.

{

"title": "HealthSmart",

"scopes": [

"https://purl.imsglobal.org/spec/lti-ags/scope/lineitem",

"https://purl.imsglobal.org/spec/lti-ags/scope/score",

"https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly",

"https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly",

"https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly"

],

"extensions": [

{

"platform": "canvas.instructure.com",

"settings": {

"platform": "canvas.instructure.com",

"placements": [

{

"placement": "course_navigation",

"message_type": "LtiResourceLinkRequest"

},

{

"placement": "assignment_selection",

"message_type": "LtiDeepLinkingRequest",

"selection_width": 1200,

"selection_height": 800

}

]

},

"privacy_level": "anonymous"

}

],

"public_jwk": {

"e": "AQAB",

"n": "s0jOxXnt8RJ8dS6GRYruhh08MnrWD1jUZPv7bQ1lsRSbowIZahtd86ThrPuYyzsHau7GPDY3zXWQeK0MGToU_9jL1ptQhiowqVqdNG4Eeg7XKUwZh-vxDbxQ9_ntpu0lskZFISdtiIQo1tuyoID3rfWx90GVBgICLfx4Exoy_wNOcdmTip0xWqxPnyU8UHsXmtdEbcIzZQ2ry8vf7nhXPK1sMbMTitjLz0MfmTMu5Ja7EAUsYoOTmMzoEHlOU2gFYbYatOT925Q4za-LXUBu7-SD17sZ-B52WPmZ2s1CEemPndAUxoGDaw0vvsSRCW4wPHB1agRnfr6MNwJzX955cw",

"alg": "RS256",

"kid": "7zg1GQTZ7Ku4RadnTedVx9LMJ05AYUlQvU4VFrd2liM",

"kty": "RSA",

"use": "sig"

},

"description": "Where Good Health Starts\nHealthSmart is ETR's comprehensive K–12 health education program for classroom and virtual instruction.",

"custom_fields": {

"name": "$Person.name.full",

"email": "$Person.email.primary",

"given_name": "$Person.name.given",

"family_name": "$Person.name.family"

},

"public_jwk_url": "",

"target_link_uri": "https://www.etr.org",

"oidc_initiation_url": "https://www.etr.org/Slatwall/index.cfm/lti/oauth/loginv1p3"

}

Example:

Please click Save.

Step 2 - Client ID & Secret

Please make a note of the Client ID and Client Secret.

Clicking “Show Key“ displays the client secret.

Copy the developer key from the details column (the Client ID), then add the app by clicking +App at either the Account, Sub-Account, or Course level (more details in Step 3 below). 

When installing the app, change the configuration type to By Client ID, add the Client ID, and click Submit.

Step 3 - App Install

Choose a location to install the HealthSmart tool as an external app. This can be done at either the Account, Sub-Account, or Course level. 

Account Level

To install an LTI 1.3 tool at the account level, follow these steps:

1. As an Admin, navigate to the Account: Log in to Canvas as an Administrator and click on the account name where you want to install the tool.
2. Go to Settings: Click on "Settings" in the account menu.
3. Choose Apps: Click on the "Apps" tab to view available apps.
4. Find the App: HealthSmart is a custom integration, so choose "View App Configurations" and then "+ App."
5. Configure the App: Enter the required configuration details, including the LTI 1.3 credentials (e.g., use the client ID to lookup the HealthSmart app we installed previously)
6. Install the App: Follow the on-screen instructions to complete the installation.
   More information can be found on the Canvas Learning Community here: https://community.canvaslms.com/t5/Admin-Guide/How-do-I-configure-an-external-app-for-an-account-using-a-client/ta-p/202 

Sub-Account Level

To install an LTI 1.3 tool at the sub-account level, follow these steps:

1. As an Admin, navigate to the Sub-Account: Log in to Canvas as an Administrator and navigate to an account, click "Sub-Accounts" from the navigation, then select the sub-account where you want to install the tool.
2. Go to Settings: Click on "Settings" in the sub-account menu.
3. Choose Apps: Click on the "Apps" tab to view available apps.
4. Find the App: HealthSmart is a custom integration, so choose "View App Configurations" and then "+ App."
5. Configure the App: Enter the required configuration details, including the LTI 1.3 credentials (e.g., use the client ID to lookup the HealthSmart app we installed previously)
6. Install the App: Follow the on-screen instructions to complete the installation.
   More information can be found on the Canvas Learning Community here: https://community.canvaslms.com/t5/Admin-Guide/How-do-I-configure-an-external-app-for-an-account-using-a-client/ta-p/202 

Course Level

1. As an Admin, navigate to the Account and/or Sub-Account: Log in to Canvas as an Administrator and navigate to the account and/or Sub-Account.
2. Go to Courses: Click on "Courses" in the account menu.
3. Select a Course: Find a course and click the cog icon to open the course settings.
4. Choose Apps: Click on the "Apps" tab to view available apps.
5. Find the App: HealthSmart is a custom integration, so choose "View App Configurations" and then "+ App."
6. Configure the App: Enter the required configuration details, including the LTI 1.3 credentials (e.g., use the client ID to lookup the HealthSmart app we installed previously)
7. Install the App: Follow the on-screen instructions to complete the installation.
8. Check Account Settings: To ensure the tool is only available at the course level, double check the tool is not installed at the account or sub-account level. More information can be found on the Canvas Learning Community here: https://community.canvaslms.com/t5/Admin-Guide/How-do-I-use-the-Canvas-App-Center-in-an-account/ta-p/262

Step 4 - Testing the Integration

Once installed, HealthSmart should now appear in the course navigation. The integration can be tested using a Teacher account.