Customizations
Configure variable substitutions for User ID and Course ID
By default Annoto uses $Canvas.course.id for course and $Canvas.user.id for user. In some cases it is required to use different values as unique identifiers for course and user.
The most common use case is if Kaltura KAF integration is used alongside Annoto LTI on the same Canvas LMS. For seamless experiance, Annoto LTI setup and Kaltura KAF setup should use the same subsitution variables for identifying courses and users.
If Kaltura KAF(LTI) course ID substitution variable does not match Annoto LTI, two duplicate courses would be created in Annoto platform with same name, one for Kaltura KAF actvities and another for Annoto LTI activities.
If Kaltura KAF(LTI) user ID subsitution variable does not match Annoto LTI, two duplicate users would be created in Annoto platform with same name.
This leads to confusion and may lead to variaous access and analytics issues.
Prerequisites
Admin access to Canvas account
LTI 1.3 deployment of Annoto (Not Legacy)
Step by Step guide
It is highly advisable to coordinate any changes to substitution variables with the Annoto team, prior to making any changes.
Changes to those settings will effectively modify the course/user identifiers, for live courses this will cause duplicates and data corruption.
If the goal of making this change is to match the Kaltura KAF, do not relly on the mentioned defaults below.
Check with your Kaltura contact to validate what actual settings are made to the hosted module of the Kaltura KAF, and that they match the KAF LTI developer key additional settings.
Why did Annoto choose $Canvas.user.id as the default instead of what Kaltura is using $Canvas.user.loginId .
As per Canvas documentation the $Canvas.user.id we are using by default is a unique user identifier, is bound to the user account and is the best option to uniquely identify users in the Canvas LMS.
On the other hand $Canvas.user.loginId which is used by Kaltura is "Username/Login ID for the primary pseudonym for the user for the account" which in some cases can be an email. The value of loginId can be changed by the user itselft, effectively changing they identification if used.
Annoto is a comprehansive interactivity and assessment platform, and unique and reliable user identification is required.
Annoto's best practice recomendation is to keep Annoto defaults, and change Kaltura KAF subsitution variables instead.
Determine the required Canvas substution parameters to be used as course ID and user ID (Canvas has support for various ids). To determine the values used by the Kaltura KAF, please refer to Kaltura video app for Canvas deployment guide.
Find the Annoto LTI developer key in Canvas Admin -> Developer Keys and click on Edit button.
Scroll down and expand the Additional Settings dropdown to access the Custom Fields:
Replace existing or add new fields as required (the defaults might be missing if the deployment was done long time ago):
nn_sub_course_id=$Canvas.course.id- in most cases no change is required for the defaults as it maps to the Canvas course ID as seen in the browser URL.nn_sub_user_id=$Canvas.user.id- Kaltura uses a different value by default, so to match Kaltura deployment this value can be changed to:nn_sub_user_id=$Canvas.user.loginId
Inform the Annoto team about this change. For valid setup, Annoto team would need to update substitution parameters in the Annoto Admin dashboard LTI integration to match the new value:
Hide the Annoto Dashboard Link by Default for all the Courses
Using LTI 1.3 in Canvas, administrators have the option to hide the Annoto Dashboard link from course navigation by default. This means that the link will not appear for instructors unless they choose to enable it themselves.
Prerequisites
Admin access to Canvas account
LTI 1.3 deployment of Annoto (Not Legacy)
Step by Step interactive guide
Last updated