Quaver can supply an LTI link that can be installed in your LMS and facilitate access directly to QuaverMusic.com. Below are the steps you should follow to set up an LTI link for Quaver.
Step 1: Identify key LTI parameters and referrer
All districts performing an LTI SSO integration with Quaver are required to send at least one LTI parameter that uniquely identifies the user, though you may send additional parameters to activate certain optional features. Please notify us if you plan to activate these optional features so we can configure them. You are allowed to send parameters in the request beyond those we support, but we will ignore them. The LTI parameters Quaver supports are as follows:
|Attribute Type||Required?||Max Chars||Purpose||Details|
|Unique Identifier||Yes||60||This attribute uniquely identifies the incoming user. |
If your district is also performing a roster integration, this value is used to look up the user in the roster users.csv file.
|You should specify the attribute name to Quaver.
Examples include: user_id, lis_sourcedId_id, etc.
If rostering, this value must match one of these users.csv columns: sourcedId, username, userId, or email.
|User Role||No||none||This attribute can be used to identify the incoming SSO user as a student in the Quaver system, giving them immediate access to student content (teacher accounts are verified through a different business process outside of SSO).||The attribute name must be exactly role or ext_role
The attribute value should be exactly 'Student' or 'Learner'
|Display Name||No||50||Quaver will display this value to identify the user’s account in QuaverMusic.com.||You should specify the attribute name to Quaver.
Examples include: lis_person_name_full, email, etc.
|User First and Last Name||No||60 (each)||Quaver will display this value to teachers if the student enrolls in a teacher's class.||The first and last name should be sent as individual attributes. You should specify the attribute names to Quaver.
Examples include: lis_person_name_given, lis_person_name_family, etc.
Quaver will configure our systems according to the parameters identified by the district. You will also need to identify the referrer link from which the SSO request will be coming. This will be in a link format, such as “launchpad.classlink.com”. This will allow our system to recognize incoming SSO requests from your district.
Step 2: Install key, secret, and host
Quaver will generate a key and secret for your district’s SSO integration and deliver these values to you via email, along with our host link. You will need to install these values in your configuration. You should use the host link as the SSO launch link.
Step 3: Provide test accounts
We ask that you provide Quaver with test teacher and student user accounts that can log in using the district’s SSO method. This allows us to perform initial testing without interrupting teachers and students as well as to aid the district in troubleshooting any future issues that may arise. If the Quaver SSO link is installed in your district’s Learning Management System (LMS), we ask that you provide us with test account credentials for the LMS so that we may access the SSO link as accurately as possible. If you are not able to provide us with test account information, then we will have to rely on you or your users to adequately test the integration.
Step 4: Testing
Once Quaver has confirmed that the configuration is working as expected, we will ask that the district test the integration in the live environment by having a Quaver music teacher log in using the SSO link. If the music teacher is able to log in using the SSO successfully, have a student log in using SSO as well. If both user types are able to log into Quaver successfully and get the expected behavior, we will consider the integration ready for district-wide release.
What defines a successful SSO login?
When a user logs into QuaverMusic.com via SSO for the first time, they should see our account provisioning page. This process will allow users to link their SSO accounts with existing Quaver accounts, or to have a new account provisioned automatically. This choice is particularly important for Quaver teachers who may have content licenses attached to their pre-existing Quaver accounts. Users will only have to provision their accounts the first time they log into Quaver using SSO. After that, logging into Quaver via SSO will simply take them directly to the program with the chosen account.
If a user attempts to log into QuaverMusic.com and gets a blank page or any other error, this indicates an issue with the SSO configuration. Please report any issues or concerns so we can address them.
What about our rosters?
If your district is performing a rostering integration with Quaver, they must log in with SSO to trigger the roster udpate process. Quaver teachers will not see their OneRoster data appear in the Quaver system the first time they log into Quaver via SSO. Because we process our rosters nightly, there is roughly a 24 hour delay between the time a teacher first logs into Quaver via SSO and the time he or she sees the roster data appear in Quaver.
Step 5: Release
Once we have confirmed that a teacher and a student have successfully logged into QuaverMusic.com via the SSO link, you can launch the SSO functionality district-wide whenever you wish. You should notify your Quaver users when the functionality becomes available, and you are responsible for training your users how to access Quaver from your district’s system. You can share our account provisioning instructions with your district’s users in order to smooth their transition into using SSO to access Quaver.
Step 6: Support
Quaver will continue to support the SSO integration with your district throughout our contract term. We are committed to providing responsive support for our SSO integrations, and will work with you to resolve any issues that may arise. If you need to alter your district’s SSO configuration at any time, please notify us prior to making any changes so that we can provide uninterrupted access for your Quaver users.