QuaverEd supports Canvas LTI Single Sign-On (SSO) access to our resources. We support various methods for automated rostering that can be paired with Canvas LTI SSO.
Otherwise, teachers can use student self-enrollment with Canvas LTI SSO to manually manage their rosters in QuaverEd.
Canvas LTI 1.3 SSO Integration Setup
This section is directed toward IT administrators looking to set up CanvasLTI 1.3 SSO access to QuaverEd’s resources for their district.
Step 1: District requests integration
Your district IT team should contact QuaverEd’s integration team at integration@quavered.com to get started!
Step 2: District sets up LTI 1.3 App in Canvas
In your Canvas Admin account, configure the QuaverEd LTI 1.3 app following the instructions below:
- In Global Navigation, click the Admin link, then click the name of the account.
- In Account Navigation, click the Developer Keys link.
- Click the Add Developer Key button. Then click the Add LTI Key option.
- Enter the settings for the LTI key:
- Key Name: Quaver LTI 1.3
- Owner Email: The person setting up the app. Can use the district admin email.
- Redirect URIs: https://sso.quavermusic.com/LTI1p3LoginHandler/index.html
- Notes: (optional)
- Under the Method dropdown, select Enter URL, and you will be prompted for a JSON URL. Enter the following: https://sso.quavermusic.com/lti1p3Config
- This default JSON configuration that we offer automatically populates the fields needed, including the services that need to be enabled and custom parameters that need to be set for gradebook passback.
- Click the Save button to save your LTI key.
- View your LTI key. LTI keys are indicated by the External Tool icon [2].
- Each LTI key includes a client ID [3]. Copy or write down the client ID to enable the external tool from your Account Settings or to share it with users to enable the tool in a course.
- Once the LTI Key is created, it needs to be added as an External App. General instructions can be found here.
- In Account Navigation, click the Settings link (bottom of the left-side menu), and select Apps.
- Click the View App Configurations button.
- Click the Add App button.
- Select the Configuration Type drop-down menu and set the configuration type to By Client ID.
- Enter the client ID in the Client ID field. Then, click the Submit button.
- Click the Install button.
- View your app on the External Apps page.
- To manage your app, click the Settings icon.
- To manage app placements, select Placements.
- To view the Deployment ID for the app, select Deployment ID.
- Please note this value. It will be necessary to complete the LTI 1.3 integration with QuaverEd.
Step 3: District shares configuration information
Note that QuaverEd will use the Canvas user’s email address as their unique identifier and key value to roster data by default. If your users do not all have unique email addresses in Canvas, please notify the QuaverEd integrations team during the setup process.
Step 4: Testing
Once we receive your configuration information, we’ll complete the setup on our end. Then, we will move forward with testing the integration.
Your district will need to test the integration by having a QuaverEd teacher log in using the SSO link. If the teacher can log in successfully, we will consider the integration ready for district-wide release.
Please note that your SSO integration will be set up in a local testing state, so only a limited number of users can come through. Once we confirm everything seems to be working as expected, we’ll go ahead and release it for everyone to use.
Step 5: Release
When we have confirmed everything is working as expected, we will release your integration on our end. Teachers and students can begin accessing QuaverEd via Canvas.
Canvas LTI 1.1 SSO Integration Setup
This section is directed toward IT administrators looking to set up Canvas LTI 1.1 Single Sign-On (SSO) access to QuaverEd resources for their district.
QuaverEd can be set up as an External App in Canvas to allow Single Sign-On access to QuaverEd resources directly from Canvas via LTI 1.1 using the instructions below.
Step 1: District requests integration
Your district IT team should contact QuaverEd’s integration team at integration@quavered.com to get started!
Step 2: QuaverEd configures our system to support your district’s Canvas SSO integration
We’ll need to set things up on our side first. We’ll generate unique keys and secrets for your district, configure your LTI parameters, and more. Once we have everything ready, we’ll provide you with the key, secret, and launch link you need to set up QuaverEd as an External App in Canvas.
Step 3: Set up External App in Canvas
- You should be able to find this area via Admin > (Name of the Account) > Settings > Apps > View App Configurations > Add App. Please see Canvas’s instructions on this for details.
In your Canvas Admin account, add a new app to the External Apps.
- On the app configuration panel, use the following settings:
- Configuration Type: Manual Entry
- Name: QuaverEd
- Privacy: Public
- Consumer key, Shared secret, and Launch URL will be provided by our integrations team. They may be specific to your integration and should not be copied from another source.
- Domain, customfields, and description may be left blank unless otherwise specified by our integrations team.
Note that QuaverEd will use the Canvas user’s email address as their unique identifier and key value to roster data by default. If your users do not all have unique email addresses in Canvas, please notify the QuaverEd integrations team during the setup process.
Step 4: Testing
Once you have QuaverEd set up as an External App in your district’s Canvas instance, we’ll proceed with testing.
Your district will need to test the integration by having a QuaverEd teacher log in using the SSO link. If the teacher can log in successfully, we will consider the integration ready for district-wide release.
Please note that your SSO integration will be set up in a local testing state, so only a limited number of users can come through. Once we confirm everything seems to be working as expected, we’ll go ahead and release it for everyone to use.
Step 5: Release
When we have confirmed everything is working as expected, we will release your integration on our end. Teachers can then add the QuaverEd External Tool to any Canvas course to support SSO from Canvas.
Adding the QuaverEd app to a course
This section is directed toward teachers and students in districts with Canvas SSO integrations with QuaverEd. Please note that your district IT administrator must set up a Canvas SSO integration with QuaverEd, following the instructions above.
1. Sign in to your district Canvas account. This is often linked from your district’s website.
2. Check your sidebar! If your district has a Canvas LTI 1.3 SSO integration, the QuaverEd link may be located here.
3. If there isn’t a QuaverEd link in your sidebar, navigate to the course you would like to add QuaverEd to. Then click the “+” icon in one of the modules for that course. (Note: You may have to add a module if none exist)
4. Select External Tool from the dropdown menu.
5. Select QuaverEd’s app from the list. Also be sure that the Load in a new tab option is checked. Finally, click Add Item, and the QuaverEd app will be accessible to students in your course.
Note: If the QuaverEd app isn’t listed, your district IT will need to add the app for teacher use.
How to Access QuaverEd from Canvas
1. Sign into your district Canvas account. This is often linked from your district’s website.
2. Locate the QuaverEd link. It may be in your sidebar:
- If the link isn’t in your sidebar, check in your course module, then click the QuaverEd link:
If the link is not available, it may need to be added to the course by a teacher.
3. This page is essential! If this is your first time logging into QuaverEd from Canvas, you’ll likely see our Single Sign-On account provisioning page.
If we find an existing QuaverEd account associated with your email address, you will see the message to the right.
Select Yes, that’s my account to link to that QuaverEd account. Select No, that’s not me if you’d like to connect a different QuaverEd account.
4. If you have created a QuaverEd account before, click Link existing QuaverEd Account. This will allow you to link your Canvas account to your existing QuaverEd account.
If you do not have a QuaverEd account, click Create new QuaverEd Account.
5. Enter your QuaverEd Username and password and click LOGIN to link your Canvas account to your existing QuaverEd account.
If you have never created a QuaverEd account, click Go Back and select Create new QuaverEd Account in step 3.
6. Depending on the type of account you’re using, you will land at one of the following places:
Teacher Dashboard
If a teacher lands on their Teacher Dashboard, this will indicate that the teacher has successfully linked their QuaverEd teacher account with Canvas.
Student Dashboard
If a student lands on their Student Dashboard, this will indicate that the student has successfully linked their QuaverEd student account with Canvas.
How To Sync GradeBooks with Canvas Using LTI 1.3
This section is directed toward teachers in districts with LTI 1.3 Gradebook Passback configured with QuaverEd. Your district IT administrator must set up an LTI 1.3 SSO integration with QuaverEd and request Gradebook Passback be enabled, following the instructions above.
1. In your Canvas environment, navigate into the class that you would like to sync gradebooks with.
*Note: The class you wish to sync gradebooks with must also be an active rostered class present in your QuaverEd GradeBook (provided by your district’s nightly roster sync).
2. While in the class, launch the QuaverEd LTI 1.3 tool. This opens a pathway that lets QuaverEd automatically sync grades back into the LMS for that class.
3. Once this is done, grades will sync nightly from the QuaverEd class into the LMS. You can also trigger a manual sync of the GradeBook at any time by launching the LTI 1.3 tool from inside the LMS class again.
