Admin Guide: Configuration for Canvas

This article explains how to install and configure the HealthSmart LTI v.1.3 integration with the Canvas Learning Management System (LMS).

The following configuration guidelines are intended to be used by district IT. Please schedule a 15-minute call with us to confirm the integration setup and initiate the data sync. To schedule the setup call, please contact support@etr.org.


What You Need To Get Started

  • A school/district digital subscription to HealthSmart.
  • School/district IT has scheduled an integration setup call with ETR.

📑Notes:

  • The HealthSmart app is configured for users with either a teacher or a student role in the LMS. 
  • The HealthSmart app is typically configured NOT to be accessible to students; students only access content assigned by the teacher.
  • If a district administrator attempts to open the HealthSmart app, they may receive an error message. Double check that the administrator has teacher permissions in the LMS, then HealthSmart will work correctly. 

Step 1

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:

Example JSON

Please click Save.


Step 2

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

❗Important: both the Client ID and Client Secret will need to be shared during the tech setup call with ETR as well as teachers when installing the HealthSmart app.

The client id is found here (highlighted in blue):

Clicking “Show Key“ displays the client secret.

Copy the developer key (from the details column), also known as the client id, and then navigate to Settings, Apps, + App.

Now install the app by changing the configuration type to By Client ID, add the client id, and click Submit.image


Step 3

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. 

💡Tip: Carefully consider where the tool should be installed. Typically, all users (teachers and students) who are enrolled in an account, sub-account, or a course will be able to access the HealthSmart app.

Account Level

Canvas Admin: 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: Search for the app you want to install, or if it's a custom integration, you may need to choose "View App Configurations" and then "Add 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

Canvas Admin: 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: Search for the app you want to install, or if it's a custom integration, you may need to choose "View App Configurations" and then "Add 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

Canvas Admin: Course Level

To install an LTI 1.3 tool at the course level, follow these steps:
  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: Search for the app you want to install, or if it's a custom integration, you may need to choose "View App Configurations" and then "Add 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

💡Tip: Admin can remove the HealthSmart tool in Canvas at anytime by going to the location where it was installed (account, sub-account, or course) click on the "Apps" tab, then select the cog icon to open the tool's settings and click "Delete"


Step 4

HealthSmart should now appear in the course menu.

Depending on how the district installs the app, teachers may need to add HealthSmart to their course navigation, instructions can be found in the Teacher Guide: How to use HealthSmart with Canvas.

When a teacher launches using that link, they should be greeted with a welcome page:

Optional Step:

To create an Icon/Logo, please download the file:

HealthSmart-Logo-200x200px

Final Confirmation: Congratulations, you’re all set! Please schedule a 15-minute call with ETR where you will share the ClientID and run a test launch of HealthSmart. To schedule the setup call, please contact support@etr.org.


Additional Content Control Settings

HealthSmart allows school districts the autonomy for local decision-making to ensure all lessons align to state and local policies. A district administrator can be assigned content control settings to select the lessons they want educators to use while opting out of any lessons that don’t fit their scope and sequence.

To use content control settings, a district administrator can be assigned the Lesson Selector Tool which provides a toggle switch to turn on/off lesson access for all educators. See example below:

The Lesson Selector Tool is only enabled by ETR support. To request using the Lesson Selector Tool, please share the name and title of the district administrator during the HealthSmart setup call, or submit your request to support@etr.org

📑Note: The district administrator will need teacher permissions in the LMS in order to use the Lesson Selector Tool. Teacher permissions in the LMS are handled by district IT.