TABLE OF CONTENTS
- Setting up the Developer Key
- Entering the Key LTI Settings
- The Client ID
- "Add App" and Completing Configuration
Overview
This guide walks Canvas administrators through the LTI 1.3 tool configuration to integrate Vantage with Canvas so instructors are able to create deep links and grade syncs between Vantage and their LMS course.
Some configuration information is provided first to you by Sage:
- Your Sage Technical Implementation Specialist will provide these details using a privnote link (https://privnote.com/).
- Please note that this link can be opened once. When you close the page, the contents of the privnote will be destroyed.
- Once you open the privnote, we recommend storing a copy of this information for your records.
Setting up the Developer Key
The Developer Key must be set up at the Account level in Canvas. Once the Developer Key is configured, it can be deployed at the Account, Subaccount, or Course level depending on your school's needs or requirements.
1. Log into your Canvas LMS as an Administrator. Next, go to the Admin tab to begin. Select the account you wish to use for the integration.
2. In Account Navigation, choose Developer Keys.
3. Select the + Developer Key button, followed by + LTI Key.
Entering the Key LTI Settings
Enter the LTI settings into the fields provided.
- Key Name: Sage Vantage (* recommended)
- Owner Email: Enter the email address that needs to be tied to the tool setup.
- Redirect URI(s): The reply URL will be provided by Sage via email.
- Configuration Method: Select Enter URL from the dropdown menu.
- JSON URL: The JSON URL will be provided by Sage via email.
- Make a final review of the settings for accuracy. Next, select the Save button at the bottom right of the page to store your LTI key.
On the Developer Keys page, locate Sage Vantage in the list. In the State column, click to turn the tool On.
Once the tool is enabled, you will see the state's status change from OFF to ON.
The Client ID
A Client ID is assigned to the LTI key when it's created. It will appear in the Details column. Copy this ID as you will need it to enable the tool configuration.
"Add App" and Completing Configuration
After creating the LTI key, go to Admin in Account Navigation, and then to Settings.
ADD APP
Choose the Apps tab, then select the View App Configurations button.
1. Select the + App button.
2. On the Add App page, make the following changes:
- Configuration Type: By Client ID
- Client ID: Paste the Client ID you copied after creating the LTI key.
- Select the Submit button.
INSTALL AND COMPLETE SET-UP
To complete the tool set-up, select the Install button on the Add App confirmation.
1. Send this same Client ID and your Canvas URL (i.e. school.instructure.edu) to Sage to complete the tool set-up.
2. After you send the Client ID and Canvas URL to your Sage Technical Implementation Specialist, you will receive confirmation that the integration is complete on the Sage side. We recommend that you attempt to add a link to Vantage in a sandbox course to confirm the tool configuration is working.
a. Choose the module where you would like to add a Vantage link. Next, choose the "+" button to add new content to the module.
Note: If you are adding Vantage content through Pages instead of Modules, create or edit the Page where you wish to add content. Select the Apps icon in the toolbar and select the Sage Vantage tool. Adding links will mirror the process outlined below for Modules.
b. In the "Add" dropdown, select External Tool. You will see a list of available tools. Choose the one that says Sage Vantage.
c. You should see the following error message that you do not have a valid Vantage account:
"Message: Your learning management system email [[email protected]] does not match an existing account in Sage Vantage. Please contact [email protected] so that our support team can create or merge your accounts."
Seeing this error indicates you have authenticated into Vantage to the point where it is doing a user check. Since the user check is looking for an instructor account, this message indicates the configuration is correct.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article