About
The AICC Communication Protocol supports communication between a Learning Management System (LMS) and existing course content. Enabling the AICC module in Content Hubs and legacy Video Portal allows a customer to securely share Kaltura media content within their course. Each authenticated user has a seamless experience when consuming Kaltura-uploaded content.
Kaltura recently performed such integration for Siam Commercial Bank (SCB). Following is a brief overview of how integration was accomplished in this design use case:
SCB employs an LMS that uses the AICC protocol – Saba. Media is created and uploaded to a Content Hubs or legacy Video Portal channel, then embedded into Saba. An SCB user opens Saba and attempts to play said media. Saba sends a request to the Content Hubs or legacy Video Portal providing the Saba session ID and the Content Hubs or legacy Video Portal channel ID. The Content Hubs or legacy Video Portal sends a request to Saba for additional information about the user. Playback is granted to the authenticated user and Content Hubs or legacy Video Portal analytics are tracked in the player, which are then sent through the Content Hubs or legacy Video Portal backend to Saba.
This guide explains how to enable and configure the AICC module in the Configuration Management console.
This module is for both Content Hubs and legacy Video Portal users.
For technical support, contact Kaltura Customer Care. For all other inquiries, reach out to your Customer Success Manager.
Configure
- Access your Configuration Management console.
- In the list of configurable items on the left of your screen, locate and click on Aicc. (The item will be crossed out because it's disabled by default.)
- The AICC window displays.
The Module Info box displays the module name, description (what enabling this module allows users to do), and version number.
- Configure the following:
If this module is not in your application, please get in touch with your Kaltura representative to inquire about adding it.
enabled - Set to 'Yes' to enable the module.
allowedRoleToEmbed - Choose the minimum applicative role that is allowed to share AICC embed pages. This can be configured for specific users. The options are as follows:
- Owner Only
- Specific Users
- ViewerRole
- PrivateOnlyRole
- AdminRole
- UnmoderatedAdminRole
enableContextualAccess Restriction - This setting is applicable to a user who browses the site, accesses a certain channel, and accesses a media entry within that channel. Set to 'Yes' to make access to the AICC embed tab only possible within the context of a channel.
If set to 'No', access to the AICC embed tab will not be restricted and the tab will be present across the Content Hubs or legacy Video Portal. In other words, any user can access the AICC embed tab with any contextual role. In fact, the media does not even need to be published and can be privately owned.
If you set to 'Yes', additional configuration options display:
allowedChannelTypes - Enter the minimum contextual role in a channel allowed to share AICC embed pages. The options are as follows:
- Manager
- Moderator
- Contributor
- Member
createGroupUser - Automatically create a group user for the allowed channel types. AICC content consumers will be automatically added to this group user and inherit its role. This is set to 'Yes' by default.
groupUserMembership - Select the contextual role assigned to the automatically created group user. Changing this value will not affect the roles of existing group users. The options are as follows:
- Manager
- Moderator
- Contributor
- Member
embedTabName - Type a name for the embed tab that displays the AICC embed (see example below).
generateAiccWrapper - Set to 'Yes' to show link in the embed tab that allows generating AICC wrapper archive. If set to 'Yes', an additional configuration option displays:
aiccWrapperLinkText - Enter text of the AICC wrapper generation link.
requireKmsAuthenticationForEmbedPlayback - When enabled, a user must be authenticated to Content Hubs or legacy Video Portal to watch embedded media. If the user is not logged in, they will be redirected to login and will be redirected back to the embedded media page.
createUser - Set to 'Yes' to create a Content Hubs or legacy Video Portal user for each AICC user if it does not already exist. For example, in the design use case for SCB, when a user attempts to watch content that was embedded in Saba, the Content Hubs or legacy Video Portal requests to query Saba for additional information on that user's ID. If 'Yes' is selected, a Content Hubs or legacy Video Portal user will be created and listed in the User ID column of the User Management Window in the Configuration Management Section of the Content Hubs or legacy Video Portal based on the Saba's user ID information.
If 'No' is selected, the playback will only work if the user already exits and is entitled to watch the content or if the content itself is publicly accessible to all end users, including unauthenticated users.
If you select 'Yes', an additional configuration option displays:
defaultRole - Choose the user applicative role for newly created users. In other words, what is the default role that this new Content Hubs or legacy Video Portal user will be assigned? The options are as follows:
- ViewerRole
- PrivateOnlyRole
- AdminRole
- UnmoderatedAdminRole
overrideUserName - Set to 'Yes' to override the user's first and last name with the information available in the LMS. If the user exists in the Content Hubs or legacy Video Portal, this setting allows their name to be overridden – regardless of whether or not they are a Content Hubs or legacy Video Portal user or regular user. If set to 'No', the user's first and last name will not be overridden.
encryptEmbedLinks - Set to 'Yes' to encrypt the Content Hubs or legacy Video Portal URL in the AICC link in order to prevent its manipulation. This is a security configuration regarding whether or not to obfuscate the parameters in the URL.
When encrypted, the Content Hubs or legacy Video Portal will be able to decrypt those parameters, but any other entity seeking to manipulate them will not be able to create URLs in this structure. The Content Hubs or legacy Video Portal will not process the request when a request is being made with a manipulated URL.
For example, in the design use case for SCB, the Content Hubs or legacy Video Portal will process requests made only from the Saba domain. When the Content Hubs or legacy Video Portal edits the URL to that domain, it is encrypted. If another user attempts to add the Saba domain, exposed in the URL, the Content Hubs or legacy Video Portal will not process the request.
verifyDomain - Set to 'Yes' to limit the playback of the Content Hubs or legacy Video Portal URL only within the context of an LMS domain. This setting allows the administrator to add a whitelist. If 'No', the system will process requests from any domain.
completionRatePercent - Enter the percentage of a video's total duration that must be viewed in order for the Entry to be marked as 'Completed'.
playerSelection - Allow end users to choose which player will be used with the generated AICC links. When disabled, the default KMS player is used.
selectPlayers - Click +Add "selectPlayers". Type a player name to display to end users and a numerical player ID to apply to the generated AICC link.
7. Click Save.
You receive a notice that your configuration for AICC was saved and the cache was cleared.
User experience
Once enabled and configured, a new capability is added to the entry page that allows users to copy the AICC URL to share. This capability is displayed for Content Hub users as part of the three dots actions menu on the entry page, and for legacy Video Portal users as an additional tab under "Share", added to the entry page.
Content Hubs users:
Once enabled and configured, the AICC embed URL option appears in the three dots actions menu on the entry page for the end user.
After selecting the AICC Embed option in the three dots actions menu on the entry page, the Share screen displays where the user can copy and share the AICC embed URL.
Screen below shows "generateAiccWrapper" and "selectPlayers" items enabled and configured.
Legacy Video Portal users:
Once enabled and configured for legacy Video Portal users, the AICC Embed option appears as an additional tab under "Share" on the entry page where the user can copy and share the AICC embed URL.
Screen below shows "generateAiccWrapper" and "selectPlayers" items enabled and configured.
This document is maintained by Kaltura’s Professional Services team. Please send comments or corrections to your Customer Success Manager. Ask them to forward it to the Professional Services team. We are committed to improving our documentation and your feedback is appreciated.
