Skip to content
English
  • There are no suggestions because the search field is empty.

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.

In this article you can find step-by-step instructions.


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:

  • HealthSmart is a third-party LTI tool that's typically configured for users with a teacher or a student role in the LMS. Other roles such as an administrator or mentor may need to be configured in the integration settings.
  • The HealthSmart app is configured NOT to be accessible to students in their course navigation; students only access content assigned by the teacher.
 
    

Step 1 - Developer Keys

Navigate to Admin > Developer Keys 

Click the +Developer Key button and select +LTI Registration

 
During the setup call with ETR, the ETR team will provide you with a unique registration URL.
 
After entering the URL, select the Finish Registration button.
 
 
On the next screen, review the settings and select the Enable & Close button.

Step 2 - Client ID 

Back under Developer Keys, find the HealthSmart LTI integration and click the toggle switch to On (green).

Toggle Switch

Next, please share the Client ID with the ETR team during the setup call to enable the connection to the HealthSmart platform.

The Client ID is found here (highlighted in blue):

Step 3 - App Install

Copy the Client ID, then add the app by clicking +App at either the Account, Sub-Account, or Course level (more details below).

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

image

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 AppHealthSmart is a custom integration, so choose "View App Configurations" and then "+ App."
  5. Configure the App: Click on "Configuration Type" then choose "Client ID". Use the Client ID to the HealthSmart app 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-use-the-Edu-App-Center-in-an-account/ta-p/262

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 AppHealthSmart is a custom integration, so choose "View App Configurations" and then "+ App."
  5. Configure the App: Click on "Configuration Type" then choose "Client ID". Use the Client ID to the HealthSmart app 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-use-the-Edu-App-Center-in-an-account/ta-p/262 

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. Find the AppHealthSmart is a custom integration, so choose "View App Configurations" and then "+ App."
  5. Configure the App: Click on "Configuration Type" then choose "Client ID". Use the Client ID to the HealthSmart app installed previously. 
  6. Install the App: 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 - Enable Grading

To enable Canvas SpeedGrader for HealthSmart, an API integration is required in addition to the LTI integration.

Step 1:

Navigate to Admin / Developer Keys. Click the + Developer Key button and select + API Key.

Canvas Developer Keys

Under the Developer Key, enter the following into Key Settings:
 
Key Name: HealthSmart Student
Redirect URI (Legacy): https://www.healthsmartk12.org/apiv1/lti/oauth/oauth2Response/
Notes: This enables the primary HealthSmart application (LTI integration) to use SpeedGrader.

Click the Save button.

Step 2

Back under Developer Keys, find the HealthSmart Student API integration and click the toggle switch to on (green). Both integrations need to be enabled in order for the program to run correctly.

Toggle Switch

Please make a note of the Client ID and Client Secret (Key) to HealthSmart Student.

❗Important: the Client ID, Secret and the district's custom domain for Canvas will need to be shared during the tech setup call with ETR.

The Client ID is found here (highlighted in blue):

Client ID

Clicking “Show Key“ displays the client secret.

Key Highlighted

Optional Step 3 (if an existing customer switching over to SpeedGrader)

In Developer Keys, find the original HealthSmart Developer Key, and click to edit. Locate the Target Link URI and change this value from https://www.etr.org to https://www.healthsmartk12.org/

 

❗Important: Older versions of the HealthSmart integration with Canvas did not use SpeedGrader. If a district using an older integration needs to switch to SpeedGrader, please email ETR to make this change: support@etr.org.

Please note that after making the switch, any submitted scores on student assignments under the previous grading method will no longer be editable.

Step 5 - Testing the Integration

Once installed, HealthSmart should now appear in the course navigation. The integration can be tested using a Teacher account. 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 HealthSmart using the link in the navigation, they should be greeted with a welcome page:


Optional Step:

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

HealthSmart-Logo-200x200px

 

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.