KAF\KMS Integration

Overview

This module adds Annoto in-video collaboration and insights solution to Media Space.

Account Administrators Guide

To configure the module, a MediaSpace administrator should login to the MediaSpace admin page (<MediaSpace site Url>/admin) and navigate to the Annoto module.

Note : If this module is not in your MediaSpace application, please contact your Kaltura representative to enquire about adding it.

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.

  • privateDiscussions - Enables discussions to be private in the scope of Course/Category/Channel. If disabled, discussions on same video entries will be public across Courses/Categories/Channels.

Activation Settings

  • activatedByDefault - If enabled, by default Annoto is active on all the Videos for all Courses/Categories/Channels.

  • activationEditAllowed - If enabled, Authorized Users will be able to activate/deactivate Annoto for specific Courses/Categories/Channels/Videos.

Annoto Activate/Deactivate Permissions

activationEditAllowedRoles - Allows to select which roles/users/groups can activate/deactivate Annoto in Courses/Categories/Channels/Videos.

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 activate/deactivate Annoto.

NOTE:

Regardless of the role settings below, only users that have access to Kaltura Entry/Channel/Category settings are Authorized to activate/deactivate Annoto.

ACTIVATE/DEACTIVATE Permissions Based on Users/Groups

To Authorize only specific users or groups to activate/deactivate Annoto, choose “Specific Users” in the activationEditAllowedRoles dropdown, as you can see in this video 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 [email protected] is currently the only one that can activate/deactivate Annoto. All other users will not have the option of Activate/Deactivate Annoto in Courses/Categories/Channels/Videos.

NOTE:

As a best practice, We suggest creating a Kaltura Users Group named for example “annoto_admins” and adding only this group to activationEditAllowedUsers list.

For more information on Groups visit : Kaltura Groups

Additional Activation settings

  • disableUserAnalytics - If checked, User detailed analytics will be disabled and not shown in the Annoto dashboard.

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

UX - User Experience Preferences

  • sidePanelLayout - If enabled, Annoto widget will be positioned on the side of the player instead of overlay.

  • sidePanelFullScreen- If enabled, Annoto widget sidePanelLayout will work in player full screen as well.

  • enableTabs- If enabled, Annoto widget will have tabs on the side for quickly toggling between discussion and private notes.

  • sidePaneClosedOnLoad - If enabled, Annoto widget will be closed when player first loads even if sidePanelLayout is enabled.

  • Position - Position of the discussion widget inside the player.

  • forceDarkTheme - If enabled, Annoto will always use the dark theme (not only on full screen).

  • disableTabs - If disabled, Annoto widget will not have tabs for quickly toggling between discussion and private notes. If enabled, the Annoto widget includes tabs on the side for quickly toggling between discussion and private notes.

Player Embed Sizes

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

  • playerEmbedSizes - Defines sizes that can be used for embedded players. Defines the player size in the following format: {width}x{height}.

  • Recommended sizes:

    • Large: 1200*628

    • Medium: 1024*576

    • Small: 900*506

Plugin Settings

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

  • deployment - Annoto Deployment Region.

  • playerPluginCDN - CDN host of the Annoto plugin assets (read-only).

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

Integration

Integration Configuration

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

End User Guide

Enable/Disable Annoto in Media Space

Annoto in-video collaboration and insights solution can be configured to be enabled on the following Scopes:

  • On the entire MediaSpace (please refer here for details).

  • On a specific channel

  • On a specific media

Enable Annoto In a Channel

    • Go to the Channel Actions menu

    • Under Details tab in the options section, Annoto can be enabled in the Channel

NOTE: This is available only if activationEditAllowed is set to Yes and the user is authorized to activate/deactivate Annoto (for more details, please refer here)

Disable Annoto On a specific Media

Once Annoto is enabled on the entire MediaSpace or in a specific channel, it can be disabled per media, as you can see in this video, or in the following instructions :

    • Go to the desired video where you want Annoto to be disabled

    • Click on Actions menu, and then Edit

    • Under Options Tab

    • Check the “Disable Annoto for this media.”

NOTE: This is available only if activationEditAllowed is set to Yes and the user is authorized to activate/deactivate Annoto (for more details, please refer here)

The following table summarizes the different configuration options :

activateBydefault

activationEditAllowed

Disable Annoto for this Media

Enable Annoto in Channel

Results

No

No

-

-

Annoto plugin will not be displayed

No

Yes

checked

*

Annoto plugin will not be displayed

No

Yes

unchecked

checked

Annoto plugin will be displayed in the category context

No

Yes

unchecked

unchecked

Annoto plugin will not be displayed in this category context and with no context

Yes

no

-

-

Annoto plugin will be displayed

Yes

Yes

checked

*

Annoto plugin will not be displayed

Yes

Yes

unchecked

checked

Annoto plugin will be displayed in category context and with no context

Yes

Yes

unchecked

unchecked

Annoto plugin will not be displayed in the category context. With no context, it will be displayed

(*) the value has no influence on the result. (-) not applicable/hidden.

NOTE: Using activateBydefault from the Annoto module admin panel, Annoto can be enabled on the entire MediaSpace.

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

Additional Kaltura Products Support

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

MediaSpace

Annoto supports Kaltura MediaSpace.

KAF Module (LMS Integration)

Annoto supports KAF Module integration; all the settings that are available for KMS are also supported for the KAF Integration.

Kaltura Webcasting

Annoto supports Kaltura webcasting and provides a unique capability of continuing the user discussions and personal notes, that were made during live video streams, on VOD, keeping each comment in sync with the video, While providing analytics and insights on the user's activities during the live session and afterward in the VOD.

Now Kaltura Webcasting users can collaborate and take notes during live streaming and then continue on the recorded content, and all the analytics will be available through the Annoto dashboard (Also integrated as part of Kaltura).

Kaltura Webcast has added support to “Live to VOD.” This is a unique capability enabling all users' interactions (comments, notes, votes, etc.) created during the Live session to be available on the recorded session as well.

Kaltura Lecture Capture

All Annoto features and capabilities are also available for Kaltura Lecture Capture live stream enabling all users to interact (comments, notes, votes, etc.) during the live broadcast, and gain insights on the live sessions.

KMC Player Plugin

Annoto can be added as a player plugin in KMC. This enable customer to embed Annoto in external sites (SharePoint, intranet etc.)

Limitations

The Annoto and Kaltura users, Single Sign-on integration, doesn’t work in content that was embedded outside of KMS.

Troubleshooting

Symptom

Resolution

After enabling the Module and entering the apiKey and the ssoSecret and enabling Annoto on the media, Annoto is still not showing

Need to verify that the client doesn't have an alias domain, instead of the traditional partner_id.mediaspace.com domain,

As the apiKey and ssoSecret that Annoto provides are generated based on the domain

Verify that the apiKey and ssoSecret are not switched by mistake

Appendix A : Kaltura and Annoto Data Transfer

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

  5. Media author

  6. Media thumbnail URL

  7. Context (channel/category/course) identifier

  8. Context title

  9. Context description

  10. Context thumbnail URL

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.

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 [email protected]

If you want to lean more about Kaltura, click here.

Last but not least

To learn how to add the Annoto Dashboard in your KAF\KMS, go to How to access Annoto Dashboard page.

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