Custom Modules

Event Registration Overview

Event registration is the process by which an entry owner may add a registration page to the video thus making it only available for users that have filled in the registration form.  Entry collaborators may configure a registration form that fits their needs and configure the form per entry basis.

Online registration not only improves efficiencies and adds security, it also eliminates unnecessary paperwork. Registration maximizes participation and improves marketing capabilities while allowing participants to sign up when and where it is most convenient for them. 

Event Registration Roles

When creating an event, or editing media, there are several people involved that have different roles and objectives.  

• Admin - Kaltura Management Console and Kaltura MediaSpace admins are responsible for enabling the Registration module and creating the schemas for the Registration Forms.
• Entry Owner - The entry owner is responsible for enabling the Registration Form ( Add Registration) and selecting the registration form from one of the configured options. The entry owner may also choose to enable or disable the registration form for the entry, as well as  customize the Registration Page.  The Entry Owner is also responsible for sending a link to view the content/the event.
• Viewer -The viewer's role is to register by filling out the Registration Form's fields.

Event Registration Workflow

• Create a Registration Form in the Kaltura Management Console.
• Enable and Configure the Registration Module in the Kaltura MediaSpace Management Console.
• Create /Edit an Event - Add Registration and Select a Registration Form.
• Set up the Registration Page Display.
• Send a Link to Viewers
• Download the registration report

Kaltura Event Registration Documentation Guides

The information about Kaltura's Event Registration procedures, features and tips are written for specific roles. The following guides are available and written per user roles:

• Kaltura Event Registration Administrator's Guide 
• Kaltura Event Registration Entry Owner Guide
• Kaltura Event Registration Viewer's Guide

This guide is intended for KMC and KMS administrators.

The Media Page Registration feature allows admins to configure a registration form that safeguards the video content to be shown only to users that have registered, be it Live or VOD. This article describes how to configure a Registration Form.

The Registration Form is set up in the Kaltura Management Console as a Custom Data Schema. The schema contains the fields for the registrant to complete. 

In Kaltura MediaSpace, the Admin will select the Settings option and then the Custom Data tab. The schemas found in the Custom Data tab are essentially registration forms as long as they are configured on the user-entry option. Explanation for the user-entry will follow. Multiple registration forms can be made available per KMS instance. 

Configure the Registration Form(s) in the KMC

1. Login to the KMC.
2. Go to Settings and select the Custom Data tab.
   
3. Click Add Custom Schema to add a schema.
   
4. Enter the Custom Schema Title and a Description.
5. Select User Entry to ensure that that the custom data schema that is created will be available in the Registration module. You may create as many registration forms as you need. 
6. Add the custom fields. The supported field types are: Input Field, Drop List. Each field that is added has two additional configurations:
   1. Required - require the user to fill in that field and will not allow them to submit the form otherwise
   2. Hidden - hide the field from rendering in the registration form. You might want to use this option for a field you aren't sure that you want to use thus allowing you to show/hide the field on demand without the need of replacing the form
7. The default fields for the registration form that is included in the Registration module are:
   1. First Name 
   2. Last Name
   3. State 
   4. Country
      For more information on how to add or edit custom data see Custom Data.
      The following is an example of a Custom Data Registration Form Schema:

      

8. Click Save.

Activate the Kaltura Registration Feature in Kaltura MediaSpace (KMS) and Kaltura Application Framework (KAF)

Kaltura Registration is managed by KMS and KAF system administrators in the Admin area accessed from <Base_URL>/admin (e.g. https://videos.mediaspace.kaltura.com/admin)

• Configure the Kaltura Registration Module.
• Verify that you have Activated the Kaltura Registration Feature.

Configure the Kaltura Registration Module in KMS

1. Login to the application Configuration Management window.
2. Scroll down and select the Registration module in the Modules/Custom/core section.
   The Registration Administration page is displayed.
3. In the Enabled field, select Yes to enable the Registration module.
   
4. Select all the forms that you would like to make available within that KMS instance from the list of Registration Forms .
5. Select the Role(s) that are able to setup the Registration Form for an entry.
6. Enter the mediaPlayer ID, this is the player that will play media on the registration page
7. Click Save.
   

   Field	Description
   enabled	Enable, the Registration Module.
   registrationForms	Select an available registration form for the entry.
   registrationSetupRole	privateOnly Role      admin Role      unmoderatedAdmin Role      Co-Editor      Owner      Specific Users  Choose the minimal role required to setup registration for an entry.
   mediaPlayer	Select the Media Player.

Verify that you have Activated the Kaltura Registration Feature

1. Login to KMS.
2. Select Edit Entry.
   The Registration Tab is displayed in the Edit Entry screen.
   

This is a custom module that allows users to generate KMC-like embed codes. Also supports embed code generation for Interactive Video entries.

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). To learn more, see Introduction to Annoto.

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

Prerequisites 

Send the following information to the Annoto team:

1. 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 
   • Fill in the appropriate fields with the API Key and Secret
4. Click Save.

Grading Support

If you are using Annoto in an LMS via the Kaltura KAF 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 video as a comment feature.

1. Go to your KMS/KAF Management Console (<Your_Kaltura_site_Url>/admin) and navigate to the Annoto module.
2. Copy the text of the following integration configuration:

• appTokenId
• appToken
• appTokenHash
• uiConfigId

Annoto Module Settings Overview

General Settings

• enabled - Enable/Disable the Annoto module.
• apiKey - Provided by Annoto per Partner ID.
• ssoSecret – Provided by Annoto. Single Sign-On secret matching the API Key.

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 -         Specific Users      privateOnly Role      admin Role      unmoderatedAdmin Role 

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

• Specific Users
• privateOnlyRole
• adminRole
• unmoderatedAdminRole

If Specific Users or groups are selected, see the following video tutorial and 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 “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 Hen@annoto.net is currently the only one that can set the Annoto Preferences. All other users will not have the option of changing 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]

• deployment -       EU      US      Custom     Select Annoto Deployment Regio EU/ US / Custom. 

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. Note: when user embeds, the default size would be the custom and not the annoto-defined size.

• 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

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.

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

The following image demonstrates the Kaltura Player with Annoto Widget enabled.

The following image demonstrates Annoto Dashboard within MediaGallery/Channel:

Troubleshooting

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.
2. Enable - set Yes to enable the module. 
3. Click Save.
   

About

Use Powtoon to create animated presentations and animated explainer videos.
This guide will walk you through how to activate Powtoon on your Video Portal (aka MediaSpace/KMS) and KAF applications.

Setup

1. Log in to the application Configuration Management  <Base_URL>/admin (e.g. https://videos.mediaspace.kaltura.com/admin)
2. Scroll down and select the Powtoon module in the modulesCustom-5.x.x-control section.
3. In the Enabled field, select Yes to enable the Powtoon module.
4. Click Save.
   
   Upon enabling and saving the module, the account configuration fields as well as the Powtoon API credentials will be automatically populated on the page. The available fields include:
   
   enabled - Set to Yes to enable the module.
   importToPowtoonEnabled - [Auto enabled] Set to Yes to enable the Import To Powtoon feature.
   powtoonProfileId - [Auto populated] Custom Metadata profile ID for the Powtoon module.
   powtoonEndpoint - [Auto populated] Powtoon Endpoint URL (example: 'https://www.powtoon.com')
   For Enterprise customers, please use https://kec.powtoon.com/api
   For Education customers, please use https://www.powtoon.com/api
   powtoonAPIKey - [Auto populated DO NOT REPLACE] Powtoon API Key
   powtoonAPISecret - [Auto populated DO NOT REPLACE] Powtoon API Secret
   powtoonIframeHeight - [Auto set to 100%] Powtoon embed height override 
   powtoonItDepartmentEmail - [Optional] Enter the email address of the account manager that users will contact if they encounter license issues.
   powtoonWorkspaceEnabled - [Auto enabled] Enable Powtoon workspace.
   allowedRoles -        Specific Users      privateOnly Role      admin Role      unmoderatedAdmin Role  
   Assign roles to users in your organization with the minimum permissions they need to create a new Powtoon video: 
   • Specific Users: whitelisted users or groups created in the Kaltura user and group configuration
   • privateOnlyRole: this role can add media and upload content to My Media but cannot publish to galleries.
   • adminRole: this role can contribute content to all categories and upload content.
   • unmoderatedAdminRole: this role can upload content and bypass moderation (when moderation is enabled for an account).
     
     
     

To learn more, see Powtoon User Guide for Kaltura.

This module adds the KMC entry distribution capabilities to Kaltura's Video Portal. To learn more about distribution, visit our article Content distribution.

Configure

1. Go to your Configuration Management console, and navigate to the Distribution module. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/distribution.

The Distribution module page displays.

2. Configure the following:

enabled: Select 'Yes' to enable the module.

allowedDistributors: Choose the users who will be allowed to distribute, Specific Roles or Specific Users:

Specific Roles - Choose a role from allowedRoles below:

allowedRoles: Users with the selected roles will be allowed to distribute:

• privateOnly Role
• admin Role
• unmoderatedAdmin Role
• Co-Editor
• Owner

To learn more about roles, visit our article Administration Pages.

Specific Users - If you choose this option, you can add users as follows:

a. Click +Add "distributionUsers".

The distributionUsers window displays.

b. Click Select Users / Groups.

c. Select the ID or name of the user who should be allowed to distribute.

d. Click Submit.
The user appears in the grey field.

Repeat the process to add more users.

3. Click Save.

User experience

A Distribution tab displays on the Edit Media page in your Video Portal as shown below: