# Enabling and Configuring the Annoto Module in KAF/KMS

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

<table data-header-hidden><thead><tr><th width="133"></th><th>NOTE:</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTe7nNF87pl3ZFX%2F0.png?generation=1579100577192393&#x26;alt=media" alt=""></td><td>NOTE: You can use Annoto with Kaltura videos embedded outside of LMS (KAF) and MediaSpace (KMS), please contact <a href="mailto:support@annoto.net">support@annoto.net </a>for more information.</td></tr></tbody></table>

## 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
   * Secret
3. Go to your KMS/KAF Management Console (\<Your\_Kaltura\_site\_Url>/admin) and navigate to the Annoto module.

   * Enable the Annoto module&#x20;
   * Fill in the appropriate fields with the API Key and Secret
   * Click Save

   <figure><img src="https://lh7-us.googleusercontent.com/J423p_LIz-qi7umWFdj0tufT7Cg6qzeKH9xmC8P_hWunCC3fb9h6xRsT7RCK1N2udpeuO60Xt2gy_tD3OYKCd643V1pRlKEg1oVWjvCeSGStPzNRtanudsPgf7PPhER6stVSekm0wYIvNakLng0i8OU" alt=""><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="111"></th><th>NOTE:</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTe7nNF87pl3ZFX%2F0.png?generation=1579100577192393&#x26;alt=media" alt=""></td><td>NOTE: If this module is not in your MediaSpace/Kaltura KAF application, please contact your Kaltura representative to enquire about adding it..</td></tr></tbody></table>

### Grading Support

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

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

<figure><img src="https://lh7-us.googleusercontent.com/1-ab7rvEXu_w-sZAtZTVwTSB-KPC0vYRHSexPuhj96Ohfz5JvL0Uw4xFKNCG_MzvFYZCIyrHkSgdBq6nUGKOmUiICbhADM4Jl1CMBv40LsicMoAbbYJfrmqjvkiUcNNVYCkq12FB9gBcILzm3Tn_qyI" alt=""><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="111"></th><th>NOTE:</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTe7nNF87pl3ZFX%2F0.png?generation=1579100577192393&#x26;alt=media" alt=""></td><td>NOTE: If you see it empty, please enable/disable the Annoto Module.</td></tr></tbody></table>

### Video as Comment

Integration parameters are required for them to enable [video as a comment feature](https://docs.annoto.net/guides/comments/recording-video-as-a-comment).&#x20;

* 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
  * appToken
  * appTokenHash
  * uiConfigId

<figure><img src="https://lh7-us.googleusercontent.com/fwf9xlOdrXBYhrjqVpHCVAevL3eVnilQ75dyGfV0DNaIMvlPkxLFaPun-fcrGQ3cdcPWvtehrLOD3_CUsVn9XXzgQaEJDY96m-6c67TfM2yEFIt4uU_uVlRpThvG4gUtoiW4Unw1px6BgUbekI6TDmk" alt=""><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="111"></th><th>NOTE:</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTe7nNF87pl3ZFX%2F0.png?generation=1579100577192393&#x26;alt=media" alt=""></td><td>NOTE: If you see it empty, please enable/disable the Annoto Module.</td></tr></tbody></table>

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

<figure><img src="https://lh7-us.googleusercontent.com/BvK1piN0nwKFRqAaBMZGUGdfbLjApL_DoO8N3gvE-TM8r8ryWLU83laFZ5PcRsnwkcGixwUKs_8yVD1ax6VYcqpF7l2gS1NnOWUsNDunFNez0dxxv5kW_1k1QLteWBKGf3z4aD6KWQWv1_xtXWUlnXI" alt=""><figcaption></figcaption></figure>

### 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. )

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FiRZdssv4Fwh9aXzVnhyk%2Fimage.png?alt=media&#x26;token=605d1934-d440-42bc-8dd3-f2f899114eab" alt=""><figcaption></figcaption></figure>

#### Annoto Preferences Permissions Settings

**activationEditAllowedRoles** - Who can change the [Annoto Preferences](https://docs.annoto.net/guides/dashboard/preferences)? 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.

<table data-header-hidden><thead><tr><th width="111"></th><th>NOTE:</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTe7nNF87pl3ZFX%2F0.png?generation=1579100577192393&#x26;alt=media" alt=""></td><td><p>NOTE:</p><p>Regardless of the role settings below, only users that have access to Kaltura Channel/Category settings are Authorized to change the Annoto Preferences.</p></td></tr></tbody></table>

**Permissions Based on Users/Groups**

To Authorize only specific users or groups to change the Annoto Preferences, choose “Specific Users” in the activationEditAllowedRoles dropdown, [**as you can see in this video**](https://www.youtube.com/watch?v=AEN_XdYMlrE) 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

![](https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTg9cK3GrYwlpAN%2F2.png?generation=1579100577232557\&alt=media)

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

![](https://lh4.googleusercontent.com/j-SwufWeQc3KbDwJCRqFVKRnO18QpGSQyCV1MSzv17aC-vPCjdkl0-8QHWkRHOfPr07kEvflZrYnmO4z8YbBy1LFeb5yiBBK92URi0SS9AZFKPKW_ePgA0PJCeIREhURbfO5CrQ)

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

![](https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTiU5pC6NB6uYoi%2F4.png?generation=1579100577188893\&alt=media)

For example, in the below image we can see <Hen@annoto.net> 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.

![](https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTjeXndK_F5X26M%2F5.png?generation=1579100577257407\&alt=media)

<table data-header-hidden><thead><tr><th width="147"></th><th>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</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTkFPheL5qzsoRo%2F6.png?generation=1579100577162348&#x26;alt=media" alt=""></td><td><p>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.</p><p>For more information on Groups visit : <a href="https://knowledge.kaltura.com/group-support-kaltura-applications-and-kaltura-groups-faq">Kaltura Groups</a></p></td></tr></tbody></table>

#### 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.&#x20;

  <br>

  <table data-header-hidden><thead><tr><th width="147"></th><th>NOTE:</th></tr></thead><tbody><tr><td><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2Fsetup%2F-LydiPyqavs2mTygHFR3%2F-LydidTkFPheL5qzsoRo%2F6.png?generation=1579100577162348&#x26;alt=media" alt=""></td><td>NOTE: When user embeds, the default size would be the custom and not the annoto-defined size.</td></tr></tbody></table>
* **playerEmbedSizes** - Defines sizes that can be used for embedded players. Defines the player size in the following format: {width}x{height}.&#x20;
* Recommended sizes:
  * Large: 1200\*628
  * Medium: 1024\*576
  * Small: 900\*506

### 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&#x20;

\
The following image demonstrates the Kaltura Player with [Annoto Widget ](https://docs.annoto.net/guides/annoto-widget/introduction)enabled.

<br>

<figure><img src="https://lh7-us.googleusercontent.com/P_JahQq9jGf_oZkDKnGON83JtV3xaXcv60AJpIJMunkakXLSfA0pJxjRhaE7wKAlTOBYFS5aGq2oKQi0fToJvgVzSby0AvRWy_UP1NRr6FRnHsOUZ562iGrBwdyMzuGrgob2rBWhjn3jHJvfqE8rgUo" alt=""><figcaption></figcaption></figure>

The following image demonstrates [Annoto Dashboard](https://docs.annoto.net/guides/dashboard/introduction) within MediaGallery/Channel:

<figure><img src="https://lh7-us.googleusercontent.com/T7FXNIVYp_zoT14I67LJmc27SqSoxLI9p5l_FoKA1-5MtE_xtErJ81Cz7EakgDGk43RAVdfN-rj2CrWsxQzu8jwijBXlF4qaPZhuibThFtTRCGyV8JzTddbxRAO_hJ4rgdzvsMkE1ov2bJRj53M_pgQ" alt=""><figcaption></figcaption></figure>

<figure><img src="https://lh7-us.googleusercontent.com/AwT2lIIrnoX11-UmAkjkH0ntLKuJmuW0N8oY-cZqwpdDDF1Ay1pZ-ECbb9rRhde4ZHqzmB8cjsNw5UidMK_iAqXLGUlTH_8XQMTqjG-X3_APM2z8dcTkXEjUEvgzofz3uEVQbIMuO_thWuG2tIXHSZk" alt=""><figcaption></figcaption></figure>

<br>

## 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 | <p>Need to verify that the client doesn't have an alias domain, instead of the traditional partner\_id.mediaspace.com domain,</p><p>As the apiKey and ssoSecret that Annoto provides are generated based on the domain</p> |
|                                                                                                                                   | Verify that the apiKey and ssoSecret are not switched by mistake                                                                                                                                                           |

## Support&#x20;

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 [**support@annoto.net**](mailto:support@annoto.net)

If you want to lean more about Kaltura, [**click here**](https://corp.kaltura.com/).

## Last but not least

In order to learn more about the wonderful things you can do with Annoto, visit the [**Annoto Widget Guide**](https://app.gitbook.com/@annoto/s/guides/~/drafts/-Lz0pe_nMUA2IKiCjUaM/annoto-widget/user-guide) page.