This guide describes how to add the Annoto App to your Instructure Canvas environment. This guide is intended for IT and administrators.

Prerequisites

• A Canvas Administrator account with access to manage .

• A URL to the provided by Annoto

  • Example: https://auth.eu.annoto.net/lti/register/{host_id}/canvas

Step 1: Create LTI Developer Key

1. Navigate to the Admin tab.

2. Navigate the Developer Keys

3. Click on "+ Developer Key" Button

4. Click "+ LTI Key"

Step 2: Configure the LTI Developer Key

1. Change the Method to "Enter URL"

2. Paste the "JSON URL" provided by Annoto

3. Paste the "Redirect URIs" provided by Annoto

4. Set Key Name to "Annoto LTI Advantage"

Step 3: Enable the LTI Developer Key

The newely created Key would be listed in your Account and have it's "State" set to off:

Click on the Toggle to enable the Key:

Step 4: Share the Client ID with Annoto

The Client ID of the LTI Developer Key is available in "Details" column:

Please copy the key and share it with Annoto team to finalize the deployment.

Support

If you need any additional information or have any questions, please contact us at

Annoto is an in-video collaboration solution that enables users to contribute, share and learn together, turning passive 1-way video viewing into an interactive group experience.

Annoto provides the full solution:

Video time-based discussion on one hand and Insights and Management Dashboard on the other, as you can see in the following video:

As opposed to simply watching a video passively, users can lean forward and become participants, share ideas and create meaningful content, causing all users to be actively involved and return to the video.

Powered by comprehensive analytics and insights, Annoto sheds light upon users and their interactions within the video content, giving a view on how and when users interact with the video content and with each other.

Want to learn more about Annoto? You're definitely in the right place!

Go ahead - Annoto's guides are waiting for you!

If you prefer not to have the Annoto course dashboard in the Course NavBar, you can choose this alternative option.

1. Click on adding "Existing Activities"

2. Then click on "External Learning Tools"

1. Click on the "Annoto Dashboard" LTI Link

1. Click on the activity setting and click "Hide from Users"

1. Click on the "Annoto Dashboard" activity

Access the Annoto Dashboard

Annoto Dashboard is accessible to the Faculty via the

Introduction to Branding Using Annoto's API

Annoto's robust API provides organizations with the flexibility to seamlessly integrate and customize the Annoto widget to align with their unique brand identity. This powerful feature enables you to tailor the look and feel of the video interaction environment, ensuring consistency with your organization's branding guidelines.

Key Benefits of Branding with Annoto's API

• Customizable Widget Layout: Adjust the widget's layout to match your brand's aesthetics, including colors, fonts, and design elements.

Adding the Annoto App to Account

1. Copy the "Annoto LTI Advantage" Developer Key's Client ID (same client ID that was shared with Annoto:)

2. Navigate to the account "Settings"

3. Navigate to the "Apps" Tab

4. On the External Apps page click the "+ App" button.

1. On the Add App page

   1. Select "By ClientID" in the "Configuration Type" drop down menu

   2. Paste the Client ID copied from the Developer Keys into the Client ID field

   3. Click "Submit"

Use Annoto within Schoology page content:

Create a graded assignment using Annoto Assignment within Schoology using External tool activity:

This document shows how to add and use Annoto as an external tool Canvas App Center.

Adding the Annoto App

Overview

This document shows how to add Annoto to your Blackboard Learn/Ultra environment via LTI 1.3

• Login to Blackboard as an admin.

• Go to “Administrator Tools” and select "LTI Tool Providers".

General

When using LTI in embedded mode with Moodle, the default iFrame height is very low.

The following describes how to increase the iFrame height

Install a Moodle plugin

Overview

This module extends Annoto Module with additional functionality for Hosted KAF (Such as LTI Outcomes).

1. Go to your KMS/KAF Management Console (<Your_Kaltura_site_Url>/admin) and navigate to the Annotokaf module.

Annoto's Email Notifications feature is designed to keep your users informed and engaged by delivering timely updates and alerts directly to their inboxes.

To make these communications even more impactful, we now offer the ability for you to brand these notifications by adding your logo. This customization ensures that every email your users receive is instantly recognizable and reinforces your brand’s identity.

With Annoto's Email Notifications, you can enhance user engagement and maintain consistent branding, providing a seamless and professional experience.

Please send the following information to your Annoto CSM or :

• Your institute's logo

Overview

This document shows how to add only the Annoto Course Dashboard to your D2L environment and have it within the NavBar of the course

This document shows how to add and use Annoto Dashboard as an external tool Canvas App Center.

Adding the Annoto Dashboard App

Open Settings

In Course Navigation, click the Settings link.

Open Apps

Click the Apps tab.

Search for Annoto Dashboard:

Click on the Annoto Dashboard App

Note: there are two apps one for EU region and one for US region, contact support if you not sure which you should use

Click the +Add App button.

Add App Details

• Enter the name of the app in the Name field [1] : Annoto Dashboard

• Enter the consumer key in the Consumer Key field [2] and the shared secret in the Shared Secret field [3].

• This key and shared secret is provided by Annoto, If you do not have this information, please contact us

Add App

Testing the Annoto Dashboard Direct Integration to Canvas:

Go to this page .

Support

If you need any additional information or have any questions, please contact us at

Last but not least

In order to learn more about all the wonderful things you can do with Annoto, visit the page.

Overview

This document shows how to add Annoto to your Brightspace environment.

Add Annoto as a Tool Provider

The Tool Provider allows you to enter the Annoto key and secret one time for all the Annoto tools.

1. Click the Admin Tools icon and click "External Learning Tools".

2. Click on "Manage Tool Providers (Legacy)" tab and then click "New Tool Provider" .

3. Fill in the information as follows:

• Launch Point:

• Depending on your type of deployment (Ask your Annoto support representive):

  • EU:

Annoto's Personal Notes feature allows users to add private notes to video content, making it easier to reflect, bookmark important moments, and add additional information such as weblinks. This functionality transforms passive video watching into an active, engaging learning experience.

Exporting these personal notes is a simple process that ensures your insights and reflections are easily accessible for future reference.

Supported Export Types

Annoto supports exporting personal notes in various formats to suit different needs:

• Word: Ideal for sharing and printing, Word exports maintain the formatting of your notes for easy readability.

• CSV: Perfect for data analysis and integration with other tools, CSV files provide a structured, tabular format.

You can find more information about exporting notes in this link:

Templates

You have the option to brand the files that are exported from the system. To do this, you can create specific templates that align with your brand identity. These templates can then be sent either to your Annoto Customer Success Manager (CSM) or to

Export a video's notes branding template

Word Format:

Excel Format:

Example:

Export course notes branding template

Word Format:

Excel Format:

To provide the best customer and user experience, some of the data is transferred between Kaltura and Annoto platforms.

Processed Data

Kaltura shares data about the media details (media items and their context) and information about the users that consume the media.

Annoto collects all the UGC (User Generated Content) such as comments, votes, private notes, etc. and securely stored on AWS cloud (SAAS solution) or dedicated enterprise cloud (Enterprise solution).

Media Details Data

Kaltura shares the following media details to Annoto:

1. Media identifier

2. Media title

3. Media description

4. Media duration

Users Data

Kaltura shares the following user information to Annoto via SSO (Single Sign-On):

1. User identifier

2. User full name

3. User email

4. User role

Data Transfer Methods

All the data is securely transferred over https.

1. To add Annoto to a unit click on “Add Existing”

1. Click on the "Embed Annoto Media":

1. Add a video source

1. Copy paste embed code or url of your video.

1. Set a Title

1. Click on "Embed"

If you need any additional information or have any questions, please contact us at , or visit our online documentation website:

1. Click the Admin Tools icon and click "External Learning Tools".

2. Click on "LTI Advantage"

3. Click on "New Deployment"

1. The “Deploy Tool” page will display.

2. For the following steps please refer to this picture.

1. Name: Annoto LTI 1.3 Integration

2. Description: Dashboard and Embed with Content-item messaging

3. Add the appropriate org units for where in your institution you would like to use Annoto. We recommend choosing the main Org unit and all sub descendants, but you can also select otherwise.

This document shows how to add only the Annoto insights dashboard as an external tool using XML.

Notes:

• External apps can also be configured using XML in sub-accounts.

• Manually configuring an external app is an account permission. If you cannot configure an external app, this permission has not been enabled for your user role.

How-to Add Annoto to Kaltura Player

Follow the next steps in order to add Annoto capabilities to Kaltura player.

1. Login to KMC:

Overview

This document offers an overview of the settings for the Annoto Moodle local plugin.

Background

Annoto provides its in-video collaboration solution for Live video and VOD across the different Kaltura products.

Through our strategic partnership, Annoto and Kaltura empower organizations to activate in-video collaboration and insights effortlessly with just a single click.

Annoto is supported by the following Kaltura products:

Engaging audiences effectively is crucial for the success of any site or channel.

Annoto is a powerful tool that transforms passive content consumption into interactive and collaborative experiences. By integrating seamlessly with your platform, Annoto enables real-time discussions, peer-to-peer engagement, and valuable insights, directly within your videos and also within your site or digital content.

Whether it's for educational purposes, community building, or brand growth, Annoto empowers users to comment, share feedback, and interact, fostering a sense of connection and collaboration.

Its intuitive interface encourages meaningful participation, helping you enhance user retention, improve engagement metrics, and build a thriving, interactive community around your content.

Bring your audience together and unlock the full potential of your site or channel with Annoto.

Annoto is a pioneering solution in the realm of educational technology, designed to enhance online video delivery through interactive, social, and assessment layers. With a mission to support diverse educational use cases such as student assignments, skills development, collaborative learning, guided watching, and peer review, Annoto integrates seamlessly with platforms like Canvas, offering deep insights into user engagement and video content.

Recognizing the diverse needs of educational institutions and the importance of brand identity, Annoto has introduced a feature that allows education customers to incorporate their own branding into the Annoto interface. This customization capability empowers institutions to maintain a consistent brand presence across all their educational tools and platforms, fostering a cohesive and recognizable identity for students and educators alike.

By enabling custom branding, Annoto not only enhances the aesthetic appeal of the educational content but also reinforces the institution's values and ethos. This feature is designed to be user-friendly, allowing institutions to easily upload logos, choose color schemes, and customize various elements of the Annoto interface to align with their branding guidelines.

Incorporating custom branding into Annoto provides numerous benefits:

1. Brand Consistency:

1. Click the Admin Tools icon and click "External Learning Tools".

2. Click on "LTI Advantage"

1. Click on "Annoto LTI 1.3 integration "

Annoto dashboard is available as part of the Schoology navigation:

1. Click the Admin Tools icon and click "External Learning Tools".

2. Click on "Manage External Learning Tool Links" tab and then click "New Link" .

Overview

This document shows how to add Annoto in-video collaboration widget to your OpenEdx course videos

Adding Annoto In-Video Collaboration Widget

Note: Annoto module needs to be added to the course. If it does not exist, please refer to guide.

Once the Annoto Module was added to the Course, it should be added to the course unit, with the steps mentioned .

Annoto Widget Settings

• Display name: The name of the module

• Widget position: Select the position of Annoto widget in the video player.

• Overlay Video: Will Annoto show on the video (True) or outside of it (False)

• Tabs: Annoto widget will have tabs on the side for quickly toggling between discussion and private notes.

Hidden Enabled tabs

• Initial State: When the video starts – will Annoto be open or closed

• Discussion Scope: Will discussions on a video be per course (Private per course) or will anyone in the site be able to be a part of the conversation (Site Wide).

• Features: When adding the Annoto widget to the Course Unit you can set the widget features. There are four options in the dropdown menu:

1. Comments & Notes (Default).

2. Comments – Enable only the Shared comments feature.

3. Private Notes – Enable only the personal notebook feature.

4. Only Analytics – This will enable tracking the user activity and video consumption without showing the Annoto widget.

Example: if you don't want users to add comments and want to have only the widget's personal notes, you can just disable it and use Annoto as personal notes.

5. Save the changes you made.

6. In order for the changes to go live, don’t forget to publish the unit:

7. In order to see Annoto on the published page click on View Live Version

Support

If you need any additional information or have any questions, please contact us at

Last but not least

To learn how to add the Annoto Dashboard in your OpenEdX, go to page.

In order to learn more about the wonderful things you can do with Annoto, visit the page.

This document shows how to add and use Annoto as an external tool using XML.

Notes:

• External apps can also be configured using XML in sub-accounts.

• Manually configuring an external app is an account permission. If you cannot configure an external app, this permission has not been enabled for your user role.

Adding Annoto App

Open Settings

In Course Navigation, click the Settings link.

Open Apps

Click the Apps tab.

View App Configurations

To configure an app, click the View App Configurations button.

Add New App

Click the Add App button.

Set Configuration Type

Select the Configuration Type drop-down menu and set the configuration type to Paste XML.

Add App Details

• Enter the name of the app in the Name field [1] : Annoto

• Enter the consumer key in the Consumer Key field [2] and the shared secret in the Shared Secret field [3].

• This key and shared secret is provided by Annoto, If you do not have this information, please contact us

Enter Configuration XML

In the XML Configuration field, paste the XML code.

The XML Code can be found in the following link:

EU Deployment:

US Deployment

Open it using a web browser (preferred Chrome) and just copy-and-paste it to the field.

Submit App

Click the Submit button.

Testing the Annoto Direct Integration to Canvas:

Support

If you need any additional information or have any questions, please contact us at

Last but not least

To learn how to access the Annoto Dashboard in your Canvas, go to page.

In order to learn more about all the wonderful things you can do with Annoto, visit the page.

Overview

This document details the steps required to install the Annoto Engagement Package for Moodle.

Prerequisites

• API Key (Client ID)

• SSO secret

• Registration Keys

  • Annoto Dashboard

  • Annoto Assignment

Installation Process

• Annoto Moodle Local plug-in used to:

  • Load Annoto's in-video engagement widget for automatic detection and adjustment based on the player type running on the page.

  • Enable Annoto Activity Completion.

• Annoto Assignment: Annoto's in-video engagement widget and allows for grading activities to sync with Moodle Gradebook.

Install Annoto Local Plugin

1. Install the latest Annoto Local Plugin from:

1. After the plugin is installed, Enter the API Key and SSO Secret.

1. Now click "Save" at the bottom of the settings page.

   Note If you want to learn more about the plugin settings:

Adding the Annoto Dashboard

1. Login as Administrator

2. Enter: Site administration -> Plugins -> Activity modules -> External Tools -> Manage Tools.

1. In the text box labeled "Tool URL..." enter the specific link based on your deployment:

• EU:

• US:

1. Click on "Add LTI Advantage"

1. Enter the API Key (Client ID) and Registration Key (Received for each tool)

2. Click "REGISTER"

Now the new Tool is added:

1. Click on the Edit icon

2. Change the "Tool configuration usage" type to "Show in activity chooser and as a preconfigured tool"

Adding Annoto Assignment

Repeat the steps 4-8 for Adding Annoto Assignment

• In the text box labeled "Tool URL..." enter the specific link based on your deployment:

  • EU:

  • US:

When seeing this message:

Click on "Register as a new external tool"

That's it!

Interactive Step by Step for Adding Annoto Local Plugin

Interactive Step by Step for Annoto Dashboard and Annoto Assignment Tools

Support

If you need any additional information or have any questions, please contact us at

Last but not least

In order to learn more about all the wonderful things you can do with Annoto, visit:

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.

Prerequisites

• Admin access to Canvas account

• LTI 1.3 deployment of Annoto (Not Legacy)

Step by Step guide

1. 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 .

2. Find the in Canvas Admin -> Developer Keys and click on Edit button.

3. Scroll down and expand the Additional Settings dropdown to access the Custom Fields:

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

Overview

This document shows how to add Annoto Insights Dashboard to your OpenEdx environment.

Annoto Insights And management Dashboard Setup

Annoto’s dashboard was designed in order to shed a light upon students’ behavior within Annoto in-video collaboration widget, providing you with data regarding their engagement within the video content.

Enable LTI Consumer In Studio

You can enable the LTI xblock in studio through the advanced settings:

1. From the main page of a specific course, click ​Settings->Advanced Settings in the top menu.

2. Check for the Advanced Module List policy key, and add "lti_consumer" in the policy value list.

[

...

" lti_consumer",

...

]

Adding ANNOTO INSIGHTS AND MANAGEMENT DASHBOARD

Once the lti_consumer module was added to the Course, it should be added to the course unit, using the following steps:

1. On the Course Outline page, open the unit in which you want to add Annoto:

2. Under Add New Component, click ​Advanced​, and then select ​LTI Consumer​.

3. Click Edit and then change LTI Consumer settings as you prefer:

LTI Annoto DASHBOARD Settings

Set the following fields as follows :

1. Display Name : Annoto Dashboard

2. LTI ID : annoto-auth

3. LTI URL:

4. Open in New Page : False

9. In order to see Annoto Dashboard on the published page click on View Live Version

Support

If you need any additional information or have any questions, please contact us at

Last but not least

To learn more about Annoto’s dashboard and the insights provided by it, visit our page and the .

1. Login to your Brightspace instance with an Admin user account.

2. In Brightspace, click the 'Admin Tools' (little gear on top right) button, and click on "Manage Extensibility".
3. In Manage Extensibility page select the “LTI Advantage” tab and click the “Register Tool” button.

1. The “Register a Tool” page will display. Click the “Standard” radio button to display the Tool Registration fields. For the following steps please refer to this picture.

1. Enabled should be checked. If it is not, click on the slide button to enable the tool.

2. Fill in the following fields:

   • Name - give a general name to the tool. E.g: “Annoto LTI 1.3 Integration”.

1. Send this strings to your Annoto contact support (as text).

2. Click "Done".

1. Adding the Annoto Course dashboard can be done either by the admin in the course template, or by the individual course admin

2. Hover over the navigation bar and click the three dots on the right (or pencil icon on the left).

3. Click Edit This NavBar

1. The Edit Navbar window is displayed.

2. Click Add Links.

1. Click Create Custom Link

6. In the Create Custom Link window, enter Annoto Course Dashboard as the Name.

7. Click Insert Quicklink.

1. Select External Learning Tools.

2. Select Annoto Dashboard.

1. The URL Quicklink is displayed:

1. Under Behavior choose "Same Window"

2. Under Availability make sure to choose course staff and exclude unauthorized roles (e.g. student)

3. Click Create and then Add

1. Click Save and Close

1. Annoto Course Dashboard should be now available in the NavBar

Support

If you need any additional information or have any questions, please contact us at

Last but not least

To learn more about Annoto’s dashboard and the insights provided by it, visit our page and the .

Overview

This document shows how to add Annoto Insights Dashboard to your OpenEdx environment.

Annoto Insights And management Dashboard Setup

Installation Overview and Requirements

Enabling Annoto Passback Grading in Kaltura transforms the video learning experience by fostering greater student assessment directly within the video content.

This feature streamlines the grading process by seamlessly integrating with Learning Management Systems, allowing for the efficient transfer of assessment data. It offers educators deep insights into student interactions, enhancing the ability to tailor feedback and improve teaching strategies.

By bridging Kaltura's rich video capabilities with Annoto's interactive tools, educational institutions can significantly enhance both teaching effectiveness and learning outcomes, creating a more dynamic and personalized educational environment.

Overview

This document shows how to add Annoto Dashboard to your D2L NavBar

Annoto can be setup in Brightspace with LTI 1.3 dynamically or manually. It is recommended to use dynamic registration.

Register the Tool

1. Click on the settings icon, then click on Manage Extensibility.

2. From the LTI Advantage tab, click Register Tool.

3. Choose Dynamic, enter the Annoto registration URL, check the checkbox to Configure Deployment and click Register:

1. Click on View Deployments link

1. Open the newly created deployment.

Note the deployment will have the same name as the registration.

1. Scroll to the "Security Settings" section and make sure all checkboxes except "Anonymous" are enabled

1. Add Org Units the too should be available to:

1. Click on Save and the Tool will be available for usage in the select Org units.

Annoto automatically adds 3 links which can be viewed by clicking on View Links:

Adding Annoto to the Navbar

1. Adding the Annoto Course dashboard can be done either by the admin in the course template, or by the individual course admin

2. Hover over the navigation bar and click the three dots on the right (or pencil icon on the left).

3. Click Edit This NavBar

1. The Edit Navbar window is displayed.

2. Click Add Links.

1. Click Create Custom Link

6. In the Create Custom Link window, enter Annoto Course Dashboard as the Name.

7. Click Insert Quicklink.

1. Select External Learning Tools.

2. Select Annoto Dashboard.

1. The URL Quicklink is displayed:

1. Under Behavior choose "Same Window"

2. Under Availability make sure to choose course staff and exclude unauthorized roles (e.g. student)

3. Click Create and then Add

1. Click Save and Close

1. Annoto Course Dashboard should be now available in the NavBar

Support

If you need any additional information or have any questions, please contact us at

Last but not least

To learn more about Annoto’s dashboard and the insights provided by it, visit our page and the .

Overview

This document shows how to add Annoto as an LTI activity to your OpenEdx environment.

Enable LTI Consumer In Studio

You can enable the LTI xblock in studio through the advanced settings:

1. From the main page of a specific course, click ​Settings->Advanced Settings in the top menu.

2. Check for the Advanced Module List policy key, and add "lti_consumer" in the policy value list.

[

...

" lti_consumer",

...

]

Adding ANNOTO LTI Activity

Once the lti_consumer module was added to the Course, it should be added to the course unit, using the following steps:

1. On the Course Outline page, open the unit in which you want to add Annoto:

2. Under Add New Component, click ​Advanced​, and then select ​LTI Consumer​.

3. Click Edit and then change LTI Consumer settings as you prefer:

Annoto LTI Activity Settings

Set the following fields as follows :

• Display Name : Annoto LTI Activity (Or any name you like)

• LTI Version: LTI 1.3

• Tool Launch URL:

• Registered Redirect URIs: leave empty

• Tool Initiate Login URL:

• Tool Public Key Mode: Keyset URL

• Tool Keyset URL:

• Enable LTI NRPS: True

• Deep linking: True

• Deep Linking Launch URL:

• LTI Assignment and Grades Service: Allow tools to manage and submit grade (programmatic)

• Scored: True

• Accept grades past deadline: True (Default)

• Send extra parameters:

After clicking Save, you will see the following information:

Please send it as plain text to you Support contact at Annoto.

Click on Deep Linking Launch - Configure tool

2. Add a video source

• Copy paste embed code or url of your video.

• Add the title to the video, this will be used to identify the video in the Annoto dashboard

• Set the Aspect Ratio for the video

• Embed Size - Set video size

Click on Embed

In order for the changes to go live, don’t forget to publish the unit:

Click on view live version:

Now you will the Anntoo widget overlaying the video:

Support

If you need any additional information or have any questions, please contact us at

Last but not least

To learn more about Annoto’s capabilities, visit our .

Overview

This document shows how to add Annoto to your D2L environment via LTI 1.3

Annoto can be setup in Brightspace with LTI 1.3 dynamically or manually. It is recommended to use dynamic registration.

Register the Tool

1. Click on the settings icon, then click on Manage Extensibility.

2. From the LTI Advantage tab, click Register Tool.

3. Choose Dynamic, enter the Annoto registration URL, check the checkbox to Configure Deployment and click Register:

1. Click on View Deployments link

1. Open the newly created deployment.

Note the deployment will have the same name as the registration.

1. Scroll to the "Security Settings" section and make sure all checkboxes except "Anonymous" are enabled

1. Under Configuration Settings, enable Auto Create Grade Items and optionally enable Grades created by LTI will be included in Final Grade:

1. Add Org Units the too should be available to:

1. Click on Save and the Tool will be available for usage in the select Org units.

Annoto automatically adds 3 links which can be viewed by clicking on View Links:

Annoto has now been registered in Brightspace and is ready for use!

Overview

This document shows how to add Annoto as an LTI activity to your OpenEdx environment.

Enable LTI Consumer In Studio

Overview

This document shows how to add Annoto to your Blackboard environment.

Creating a Tool Provider

Overview

This document shows how to add Annoto to your Schoology environment.

Overview

This document shows how to add Annoto xBlock to your OpenEdx enviroment.

In-Video Collaboration Widget Setup

Annoto's Comments feature facilitates dynamic interaction by allowing users to add time-stamped comments directly on video content. This turns passive video consumption into an engaging, collaborative experience. Comments can be used for discussions, questions, feedback, and sharing additional resources, enhancing the overall learning environment.

Exporting these comments is a valuable feature that enables moderators to archive discussions, review interactions, and analyze feedback comprehensively.

Supported Export Types

Annoto supports exporting comments in several formats:

• Word: Ideal for maintaining the format and structure of the comments, making it easy to share and review.

Overview

This module adds Annoto’s in-video collaboration assessment and insights solutions to Kaltura Video Portal (aka KMS) and LMS integrations (Kaltura Application Framework aka KAF).

For KAF and LMS integrations, the Annotokaf module is required to be enabled as well. If this module

is not available, please get in touch with your Kaltura representative to enquire about adding it.

Prerequisites

1. Send the following information to the Annoto team:

   • Send the KAF/KMS domain and any alias domains if you have one

2. To activate the module, the Annoto team will send back the following information:

   • API Key

Grading Support

If you are using Annoto in an LMS via the Kaltura KAF to the following to enable grading support

• Send the field called "endpoint" under the Webhook section in the Annoto Module.

• Make sure AnnotoKAF Module is existing and enabled.

• Annoto Team will send you the jwksUrl and integrationKey values.

Video as Comment

Integration parameters are required for them to enable .

• Go to your KMS/KAF Management Console (<Your_Kaltura_site_Url>/admin) and navigate to the Annoto module.

• Enable the Annoto module for the integration parameters to auto-populate.

• Copy the text of the following integration configuration:

  • appTokenId

Annoto Module Settings Overview

General Settings

• enabled - Enable/Disable the Annoto module.

• apiKey - Which was received from Annoto, this is provided per Partner ID.

• ssoSecret – Single Sign-On secret matching the API Key provided by Annoto.

Webhook (Only KAF)

Configure webhook integration so that advanced features can be enabled, such as enabling Annoto's reporting grading to the LMS.

• jwksUrl - JWKS URL for validating the webhook messages, provided by Annoto.

• integrationKey - Integration Key provided by Annoto.

• Endpoint - Target URL to where Annoto should send the webhook messages. (The following field are auto-populated with the disable/enablement of the module. )

Annoto Preferences Permissions Settings

activationEditAllowedRoles - Who can change the ? if a role is selected, any role above it will also be able to change the Annoto Preferences.

The dropdown has the following options:

• Specific Users

• privateOnlyRole

• adminRole

• unmoderatedAdminRole

If a role is selected, any role above it will also be able to change the Annoto Preferences.

Permissions Based on Users/Groups

To Authorize only specific users or groups to change the Annoto Preferences, choose “Specific Users” in the activationEditAllowedRoles dropdown, or follow the following steps:

• Once “Specific Users” is chosen, a submenu will be available for adding authorized users and/or groups.

• Click on “activationEditAllowedUsers” to add Users/Groups

• Click on the “Select Users/Groups” to add Users/Groups to the list

• Enter the user or group (once you start typing you will see suggestions related to what you entered)

For example, in the below image we can see is currently the only one that can activate/deactivate Annoto. All other users will not have the option to change the Annoto Preferences in Courses/Categories/Channels.

Additional Activation settings

• guestUsersAllowed - If checked, not-logged-in Users will be able to see Annoto Widget. [KMS only]

• loginPath - URL path for user login page. If provided, Users will have login prompts in the widget to add a comment/vote/etc.

Player Embed Sizes

• playerEmbedSizesOverride - Enables overriding the BSE player sizes (for the optimal Annoto user experience).

• keepCustomBSEPlayerSizes - If enabled, override only the default sizes but keep any custom BSE player sizes.

Integration

The following fields are auto-populated with the enablement of the module.

• appTokenId - ID of the App Token.

• appToken - Value of the App token.

• appTokenHash - Hash type used to generate the App token.

• uiConfigId - Player UI config ID to be used by Annoto.

Plugin Settings

The following fields are auto-populated with the enablement of the module. Do not change!

• enablePlayerPlugin - Enables the built-in Player Plugin. If disabled, the Annoto plugin would not be injected into the Kaltura player by the module. Allows using Kaltura player with custom (non-production) Annoto plugin.

• playerPluginUrl - URL of the V2 player Annoto plugin. Must start with '//'.

• v7PlayerPluginUrl - URL of the V7 player Annoto plugin. Must start with '//'.

• analyticsCDN - CDN host of the Annoto analytics assets (read-only).

Once Annoto is enabled, when we will view the media, this is what we will see

The following image demonstrates the Kaltura Player with enabled.

The following image demonstrates within MediaGallery/Channel:

Troubleshooting

Support

If you need any additional information or have any questions or want to know how you can add Annoto to your videos, please contact us at

If you want to lean more about Kaltura, .

Last but not least

In order to learn more about the wonderful things you can do with Annoto, visit the page.