29
Kaltura Video Building Block for Blackboard Learn Setup Guide Version: 5 for Blackboard Learn 9.x

Kaltura Video Building Block for Blackboard Learn Video... · Contents Kaltura Video Building Block for Blackboard Learn Setup Guide 5 Preface This preface contains the following

  • Upload
    trandan

  • View
    221

  • Download
    0

Embed Size (px)

Citation preview

  • Kaltura Video Building Block for Blackboard Learn Setup Guide

    Version: 5 for Blackboard Learn 9.x

  • Kaltura Business Headquarters

    250 Park Avenue South, 10th Floor, New York, NY 10003

    Tel.: +1 800 871 5224

    Copyright 2015 Kaltura Inc. All Rights Reserved. Designated trademarks and brands are the property of their respective owners.

    Use of this document constitutes acceptance of the Kaltura Terms of Use and Privacy Policy.

  • Kaltura Video Building Block for Blackboard Learn Setup Guide 3

    Contents

    Contents ......................................................................................................................................................... 5

    About this Guide ....................................................................................................................................... 5

    Audience .................................................................................................................................................. 5

    Prerequisite Reading ................................................................................................................................ 5

    Document Conventions ............................................................................................................................ 5

    Section 1 Prerequisites .................................................................................................................................. 6

    Section 2 Understanding the Setup Process ................................................................................................. 8

    The Kaltura Application Framework (KAF) Admin Console ..................................................................... 8

    KAF Modules ............................................................................................................................................ 9

    Section 3 KAF Admin General Configuration ............................................................................................... 10

    General Settings ..................................................................................................................................... 10

    Mandatory Configuration .................................................................................................................. 11

    Section 4 KAF Admin Module Configuration ................................................................................................ 13

    Playback ................................................................................................................................................. 13

    Player ............................................................................................................................................... 13

    Audioentry ........................................................................................................................................ 14

    Imageentry ....................................................................................................................................... 14

    Videopresentations .......................................................................................................................... 14

    Content Authoring .................................................................................................................................. 15

    Media Upload ................................................................................................................................... 15

    Webcam Recording .......................................................................................................................... 15

    Video Presentations ......................................................................................................................... 16

    Screen Recording ............................................................................................................................ 16

    Captions ........................................................................................................................................... 16

    Thumbnails ....................................................................................................................................... 16

    Metadata .......................................................................................................................................... 17

    Customdata ...................................................................................................................................... 17

    Content Sharing and Publishing ............................................................................................................. 18

    Channelmoderation .......................................................................................................................... 18

    SharedRepositories .......................................................................................................................... 18

    Comments .............................................................................................................................................. 19

    Video Embeds ........................................................................................................................................ 20

    Embed .............................................................................................................................................. 20

    Browseandembed ............................................................................................................................ 21

    Section 5 Roles and Permissions ................................................................................................................. 22

    Introduction to Role Mapping ................................................................................................................. 22

    Assigning Roles in Blackboard Learn .............................................................................................. 22

  • Contents

    Kaltura Video Building Block for Blackboard Learn Setup Guide 4

    Mapping Blackboard Learn Roles to LIS roles................................................................................. 22

    KAF Grants Permissions According to the Mapping ........................................................................ 24

    Common Use Cases of Role Configuration ........................................................................................... 26

    Allowing Students to Upload Content .............................................................................................. 26

    Allowing Faculty Only to Upload and Create New Content ............................................................. 27

    Creating a Teachers Only Faculty Repository ................................................................................. 28

  • Contents

    Kaltura Video Building Block for Blackboard Learn Setup Guide 5

    Preface

    This preface contains the following topics:

    About this Guide

    Audience

    Prerequisite Reading

    Document Conventions

    About this Guide

    This guide describes how to setup the Kaltura Video Building Block for Blackboard Learn. Instructions are provided for setting up the building blocks behavior and how to control user roles and permissions using the Kaltura Application Framework (KAF) Admin Console.

    NOTE: Please refer to the official and latest product release notes for last-minute updates.

    Technical support may be obtained directly from: Kaltura Customer Care.

    Contact Us: Please send your documentation-related comments and feedback or report mistakes to [email protected]. We are committed to improving our documentation and your feedback is important to us.

    Audience

    This guide is intended for Blackboard and Kaltura administrators.

    Prerequisite Reading

    Kaltura Video Building Block 5 for Blackboard Learn 9.x User Manual

    Kaltura Video Building Block 5 for Blackboard 9.x Installation and Upgrade Guide

    Document Conventions

    Kaltura uses the following admonitions:

    Note

    NOTE: Identifies important information that contains helpful suggestions.

    Workflow

    Workflow: Provides workflow information.

    1. Step 1

    2. Step 2

    mailto:[email protected]:[email protected]://knowledge.kaltura.com/node/1254/attachment/field_mediahttp://knowledge.kaltura.com/node/1255/attachment/field_media

  • Prerequisites

    Kaltura Video Building Block for Blackboard Learn Setup Guide 6

    SECTION 1

    Prerequisites

    The following items are required to setup the Kaltura Video Building Block for Blackboard:

    Access to a Blackboard Learn environment with a system administrator permissions.

    A Kaltura account - Please contact your Kaltura representative for your Kaltura account details.

    Deployment of the Kaltura Video Building Block for Blackboard Learn on your Blackboard environment. For deployment instructions, see Kaltura Video Building Block 5 for Blackboard 9.x Installation and Upgrade Guide.

    KAF Admin Console please ask your Kaltura representative for credentials to access your KAF Admin Console instance.

    Before You Begin

    You will need to create a Blackboard root category in the KMC.

    To create the Blackboard root category in the KMC

    Log into the KMC.

    Select the Content tab and then select the Categories tab.

    Click Add Category.

    On the New Category window, select the position of the root category and save your new category.

    Click Next.

    http://knowledge.kaltura.com/node/1255/attachment/field_mediahttp://knowledge.kaltura.com/node/1255/attachment/field_media

  • Before You Begin

    Kaltura Video Building Block for Blackboard Learn Setup Guide 7

    In the metadata tab, enter metadata for your new category and click Save.

  • Understanding the Setup Process

    Kaltura Video Building Block for Blackboard Learn Setup Guide 8

    SECTION 2

    Understanding the Setup Process

    The Kaltura Video Building Block for Blackboard Learn offers an out-of-the-box solution that enables users to view, record, upload, publish, search, and share video directly from their Blackboard Learn environment. This translates into time and money saved for your organization, improved student engagement, creativity and learning results, as well as ease of use for students, faculty and teaching assistants.

    The Kaltura Application Framework (KAF) Admin Console

    The Kaltura Video Building Block for Blackboard Learn is implemented on top of the Kaltura Application Framework (KAF), a feature rich framework that allows flexible and streamlined integration of Kalturas video solution and products into 3rd party applications such as Blackboard Learn. KAF is hosted and served directly from the Kaltura cloud servers and once integrated into your Blackboard environment, presents different video components and workflows to users.

    At the backend, the Kaltura Application Framework provides a flexible and extensible administration panel, called KAF Admin Console. The KAF Admin Console offers full control over the user experience and when interacting with videos inside Blackboard. Nearly all configuration aspects of the Kaltura Video Building Block for Blackboard Learn are configured through the KAF Admin Console.

  • Understanding the Setup Process

    Kaltura Video Building Block for Blackboard Learn Setup Guide 9

    KAF Modules

    Your KAF instance is composed of multiple KAF modules, such as Application, Player, and Auth. Each module controls a different aspect of your Kaltura Video Building Block. A KAF module is composed of a set of configuration fields. All KAF modules are listed on the left menu in your KAF Admin Console instance.

    NOTE: Your KAF Admin Console may display modules and configuration fields that are not listed in this guide, some of which may be disabled. It is important that you do not modify the configuration of the disabled modules (and not enable them) without consulting with your Kaltura representative.

    The following KAF modules are required for configuring the Kaltura Video Building Block for Blackboard Learn and are described in this guide:

    Application

    Auth

    Categories

    Client

    Metadata

    Player

    Security

    SharedRepositories (used for Faculty Repository)

    Widgets

    Addcontent

    Captions

    Comments

    Customdata

    Embed

    Publish

    Screencapture

    Thumbnails

    Userreports

    Channelmoderation

    Audioentry

    Imageentry

    Videopresentation

    Blackboard

    Browseandembed

    Hosted

  • KAF Admin General Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 10

    SECTION 3

    KAF Admin General Configuration

    Related KAF modules: Application, Auth, Client, Security, SharedRepositories, Categories, Addcontent, Publish, Browseandembed, Blackboard, Hosted

    General Settings

    Your KAF account comes pre-configured with the following settings. Items marked with * should not be changed.

    Module Fields Description

    Application InstanceId, privacyContext, userRoleProfile Internal constant identifiers of your KAF instance.

    Auth sslSettings All site (set to None if SSL is not used)

    Client

    serviceUrl

    https://www.kaltura.com (set to http://www.kaltura.com if SSL is not used)

    VerifySLL Yes (set to No if SSL is not used)

    Security allowLoadInIframe Yes*

    SharedRepositories Enabled Yes ((set to No if you want to disable the Faculty Repository)

    Addcontent enabled Yes*

    Userreports enabled Yes*

    Publish enabled Yes*

    Browseandembed enabled Yes*

    Blackboard enabled Yes*

    Hosted

    enabled Yes

    enabledEntryDelete

    Set to No if you want to prevent users from editing entries after they have been published to a course Media Gallery or embedded using the Browse, Search and

    https://www.kaltura.com/

  • KAF Admin General Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 11

    Module Fields Description

    Embed module.

    allowEditPublished

    Set to No if you want to prevent users from deleting entries after they have been published to a course Media Gallery or embedded using the Browse, Search and Embed module.

    enableEntryDelete Set to No to completely prevent users from deleting entries.

    manPublish Yes*

    authMethod Lti

    In addition, you will need to specify the root category you created under the Categories module.

    Module Fields Description

    Categories rootCategory Select the category you created in the KMC.

    Mandatory Configuration

    After installing the Kaltura Video Building Block for Blackboard Learn you will need to specify the root category you created under the Categories module.

    Module Fields Description

    Categories RootCategory Select the category you created in the KMC.

    NOTE: The root category should not be changed after the plugin is configured. It is okay to change the name of the root category in the KMC. It will automatically update in the KAF Admin Console.

    Be certain that the sharedRepositoryCategoryId field is updated in the Hosted module. If it is not updated the following message is displayed:

    Click Click here to update to update the Shared Repository.

  • KAF Admin General Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 12

    NOTE: This step is only required one time after installation or migration of the Kaltura Video Building Block for Blackboard Learn.

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 13

    SECTION 4

    KAF Admin Module Configuration

    This section describes how to configure the KAF Modules.

    Playback

    NOTE: Related KAF modules: Audioentry, Imageentry, VideoPresentations

    Player

    Module Fields Description

    Player

    playerId

    Choose the player to use when playing back videos in My Media and in Media Gallery.

    Use a player id (uiConf id) from the list of players available in your KMC account (In KMC, go to Studio and select Players List.

    playerBarHeightPixels The height (in pixels) of the player ui which is not part of the actual video (for example - the bottom bar)

    playerVideoRatioPercent The ratio (in percent) of the video inside the player. Standard values: 16:9 = 56.25 , 4:3 = 75 , 16:10 = 62.5

    playerEditId The player ID (uiConf ID) of the player that is used to edit entries.

    autoPlayOnLoad Determines whether the video should start playing automatically when the player loads.

    playback

    Which Playback method should KAF use?

    RTMP is the default and recommended value to use for playback.

    HTTP uses progressive download and is cached in the browser.

    RTMP streams data and supports adaptive bitrates. RTMP is the default and recommended value.

    RTMPE - an encrypted (secure) protocol base on RTMP.

    Akamai HD Network allows adaptive bit-rate. The player can adjust the video quality on the fly

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 14

    Module Fields Description

    based on network and CPU conditions. Based on Akamai CDN technology.

    Generally, HTTP provides a better user experience for seeking forward or backward, while RTMP provides better video quality. How quickly the video begins playing depends on caching, so first time play always begins faster using RTMP and subsequent play may begin faster using HTTP.

    playerModerationId What is the player ID (uiConf ID) of the player shown in moderation pages?

    Audioentry

    Module Fields Description

    Audioentry

    audioPlayerId Player ID (uiConf ID) of the player that plays audio entries.

    audioPlayerHeight What is the Height of the player that plays audios?

    Imageentry

    Module Fields Description

    Imageentry

    imagePlayerId Player ID (uiConf ID) of the player that shows images.

    imageWatermarkUrl What is the URL of the image that should be used as watermark?

    Videopresentations

    Module Fields Description

    Videopresentations

    enabled Enable the Videopresentations module.

    sortMediaBy By default, how should media in the gallery be sorted?

    kpwId What is the widget ID (uiConf ID) of the Kaltura Video-Presentation Widget used inBlackboard Learn?

    kvpmDocUploadId

    What is the uiConf ID of the Kaltura Document Upload widget? The Kaltura Document Upload widget is used by the Kaltura Video-Presentation widget.

    kvpmCreationId What is the uiConf ID of the Kaltura Video-Presentation widget? The Video-Presentation widget enables users to synchronize video with

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 15

    Module Fields Description

    PowerPoint presentations.

    NOTE: To enable video presentation, please set enablePresentations to Yes in the Hosted module.

    Content Authoring

    Related KAF modules: Widgets, Screencapture, Captions, Thumbnails, Metadata, Customdata

    The KAF Admin Console provides great flexibility in configuring different authoring methods users can utilize for creating new content. To date, the following methods are available (with additional methods to be added in the future):

    Uploading media from the local machine

    Capturing a video from a webcam using the Kaltura Webcam Recorder (KRecord)

    Creating a Video Presentation

    Creating a new screencast using the Kaltura Screen Recorder (KSR)

    Please refer to the Kaltura Video Building Block 5 for Blackboard Learn 9.x User Manual for more details about each of these methods.

    Media Upload

    Please refer to Roles and Permissions.

    Webcam Recording

    Module Fields Description

    Widgets

    krecordId The uiConf ID of the kRecord widget. KAF uses kRecord to record and upload video from a webcam.

    rtmpUrl The URL of your RTMP Server. The URL is required for Webcam recording.

    http://knowledge.kaltura.com/node/1254/attachment/field_media

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 16

    Video Presentations

    See Video Presentations.

    Screen Recording

    Module Fields Description

    Screencapture

    Enabled Adds the Screen Recording option to the Add New menu.

    ksrId What is the widget ID (uiConf ID) of the Kaltura Screen Recorder Widget (KSR) used in Blackboard Learn?

    videoBitrate The video bitrate quality (in kbps) to use for the capture. For example 2000

    advancedOptionsEnabled Enable the option to select frames per second by the user

    Captions

    Enable the captions module to allow end users to upload captions to entries they own.

    Module Fields Description

    Captions

    captionsKsuId The uiConf ID of the Kaltura Simple Uploader (KSU) used for captions. KAF uses KSU to upload .SRT and .DFXP caption files.

    thumbnailRotator Enable thumbnail image rotation on mouseover in captions search results

    entriesPageSize How many entries are displayed as captions search results on each page? (The default is 10)

    captionsPageSize How many caption lines are displayed for each entry in search results? (The default is 5)

    NOTE: Regardless of the Captions settings, when captions are available for a video entry they are also available to the end user playing the video.

    Thumbnails

    Enable the thumbnails module to allow end users to update thumbnails of entries they own.

    Module Fields Description

    Thumbnails thumbnailsKsuId The uiConf ID of the Kaltura Simple Uploader (KSU)

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 17

    Module Fields Description

    used for thumbnails.

    extensionWhitelist Define the allowed thumbnail extensions. Default values: jpg, jpeg, bmp, gif, tif, tiff, png

    Metadata

    Use the Metadata and Customdata modules to define what types of metadata users are able to provide when uploading new content to their My Media or to a course Media Gallery.

    Module Fields Description

    Metadata

    descriptionRequired Require users to fill in the 'Description' field when uploading or editing media

    tagsRequired Require users to fill in the 'Tags' field when uploading or editing media.

    readMoreEnabled Enable/disable read more for entry description - shortening to 500 characters.

    metaDataInReadMore If enabled metadata is hidden until clicking on 'read more...' works for all descriptions - entry/channel/category.

    basicNameFieldHelperText Tooltip comment for the Name field when uploading or editing an entry.

    basicDescriptionFieldHelperText Tooltip comment for the Name field when uploading or editing an entry.

    basicTagsFieldHelperText Tooltip comment for the Tags field when uploading or editing an entry.

    showDescriptionInTooltipMeta Choose whether to display the field's description as a tooltip.

    Customdata

    Use the Customdata module to choose a custom metadata profile:

    Module Fields Description

    Customdata

    enable Enable the Customdata module.

    profileId The ID of the custom metadata. Copy the custom data schema ID from KMC > Settings > Custom Data. (http://www.kaltura.com/index.php/kmc/kmc4#account|metadata)

    dateFormat The format of the date for the date picker.

    requiredFields The custom data fields required before publishing media. Use custom data system names from KMC > Settings > Custom Data (http://www.kaltura.com/index.php/kmc/kmc4#account|metadata)

    privateFields The custom data fields that are not displayed in Blackboard Learn. Use the custom data system names from KMC > Settings > Custom Data.

    http://www.kaltura.com/index.php/kmc/kmc4%23account|metadatahttp://www.kaltura.com/index.php/kmc/kmc4%23account|metadata

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 18

    Module Fields Description

    (http://www.kaltura.com/index.php/kmc/kmc4#account|metadata).

    Note: Private custom data fields are not hidden when the media owner accesses media from My Media.

    Content Sharing and Publishing

    Related KAF modules: Channelmoderation

    Channelmoderation

    Module Fields Description

    Channelmoderation

    forceModeration Force moderation on every new channel creation.

    moderationDefaultValue Default value when moderation checkbox is enabled

    SharedRepositories

    Related KAF modules: SharedRepositories

    The SharedRepositories module controls the behavior of the Faculty Repository of the Kaltura Video Building Block.

    Faculty Repository metadata is used to facilitate searching and finding relevant media for the user. The Faculty Repository metadata is comprised of two types of metadata in Kaltura:

    Field of study filters represented as a categories branch in Kaltura

    Additional textual fields defined as a Custom Data Schema in Kaltura

    Both types of metadata can be edited and redefined in the Kaltura Management Console (KMC). Kaltura administrators are encouraged to configure the metadata that suits the needs of their institution when enabling the Faculty Repository.

    To define the Field of Study taxonomy, we recommend that you create categories in a tree structure as a child of the nestedFilters root category category, as defined in the Kaltura Management Console (KMC) User Manual. For instructions on how to define categories in the KMC, refer to How to create and manage content categories?

    To define the additional text fields, create a schema and add the name of the field with acceptable values. For instructions on how to define custom data schema refer to the What Fields Can Be Configured in Kaltura Custom Metadata Profiles.

    . Each field type in the schema is represented in the Faculty Repository in the following way:

    Text field - represented as a text field

    Text Select List field with possible single value - represented as a dropdown

    Text Select List field with unlimited maximum number of values - represented as a multi-select box

    http://www.kaltura.com/index.php/kmc/kmc4#account|metadatahttp://knowledge.kaltura.com/node/1178/attachment/field_mediahttp://knowledge.kaltura.com/node/1178/attachment/field_mediahttp://knowledge.kaltura.com/node/338http://knowledge.kaltura.com/node/343http://knowledge.kaltura.com/node/343http://www.kaltura.com/content/docs/NetHelp/default.htm#!Documents/addingaschema.htm

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 19

    Other types of fields are not supported in the Faculty Repository module and will not be represented.

    Module Fields Description

    SharedRepositories

    enabled Enabled Shared Repositories on the instance. This is required for the Faculty Repository.

    amountOfSharedRepositories This field is ignored by the Blackboard integration.

    termsOfUseLink Link to terms of use page. This appears when a user is contributing content to the Faculty Repository.

    nestedFilters

    Whether to require nested filters for the Fields of Study.

    Nested Filters are implemented as categories in the KMC. Configure them as nested categories under root>site category in your KMC.

    customDataProfileId

    Advanced metadata used for searching for content in the Faculty Repository. Choose custom metadata schema for media from one of the schemas defined in your KMS account under Settings > Custom Data.

    requiredFields Define which custom metadata fields are required before publishing media to the Faculty Repository

    dateFormat Define the format of date fields in custom metadata fields.

    Comments

    Related KAF modules: Comments

    The Comments module is used to enable users to add comments to videos and to have conversations around published entries. By default, all comments are public and are visible to all viewers of the entry. For example, if a video is shared in two courses, Course A and Course B, and a student in Course B adds a comment to the video, the comment will be visible to members of Course A. A course owner may choose to keep all comments for the course videos, private, however, public comments from other courses will be visible.

    Module Fields Description

    Comments

    enable Enable the Comments module.

    channelCommentsProfileId Custom Metadata profile Id for entries

    entryCommentsCountProfileId Custom Metadata profile Id for entry comments count

    commentAllowed Defines who can add comments. See Roles and Permissions.

    pageSize Number of comments to display.

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 20

    Module Fields Description

    sort Sort comments by newest or oldest first.

    sortReplies Sort replies by newest or oldest first.

    allowClose Allows content owners to disable/close comments for particular entries.

    showInGalleries Enable/disable showing of comments for entries in the gallery page

    showInChannels Enable/disable showing of comments for entries in the channels page

    showInChannelsOnly Show comments in for entries in the channels page

    showAddTimedCommentsCheckbox Show Add comment at mm:ss checkbox.

    showPrivateCommentsConfig Show configuration for setting private comments per gallery/channel.

    Video Embeds

    Related KAF modules: Embed, Browseandembed

    Embed

    The embed module is used to allow grabbing a player embed code of video to allow embedding them on external sites. A player embed code can be grabbed from a users personal My Media page or from a course Media Gallery.

    Module Fields Description

    Embed

    enable Yes (set to No to prevent users from grabbing embeds of videos)

    secureEmbed No*

    showMediaURL No*

    embedAllowed

    Determines who can grab an embed code:

    Owner Only Only the owner of the content can grab a player embed code.

    viewerRole/privateOnlyRole / adminRole select which roles can grab embeds of videos.

    Note: If Owner Only is checked, all other checkboxes should be unchecked.

    Note: anonymousRole & unmoderatedAdminRole are ignored by KAF

    embedSkins Define the list of player templates to the user can choose from when grabbing a player

  • KAF Admin Module Configuration

    Kaltura Video Building Block for Blackboard Learn Setup Guide 21

    Module Fields Description

    embed

    embedSizes, audioEmbedSizes Define the list of player sizes to the user can choose from when grabbing a player embed

    Browseandembed

    The Browseandembed KAF module is used to enable and configure the Browse, Search and Embed tool in Blackboard Learn. This tool is used in the following places:

    Kaltura Video Presentation

    Kaltura Video Resource

    Video submissions in a Kaltura Media Assignment

    Video embeds in TinyMCE elements across the site

    Module Fields Description

    Browseandembed

    enable Yes*

    returnUrlMethod POST*

    allowEmbedFromMultipleCourses

    When set to Yes, users will be able to embed videos from Media Galleries of all the courses they have access to. Set to No if you want to limit users to the Media Gallery of the current course only.

    filterTypeAttribute custom_filter_type*

    disableAddNewAttribute custom_disable_add_new*

    embedSkins, embedSizes, audioEmbedembed

    Deprecated

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 22

    SECTION 5

    Roles and Permissions

    Related KAF modules: Hosted

    See Common Use Cases of Roles Configuration for recommendations for common role configurations in the Kaltura Video Building Block for Blackboard Learn.

    Introduction to Role Mapping

    The Kaltura Video Building Block for Blackboard Learn implements role mapping from Blackboard Learn roles to Kaltura roles via LIS roles. Each role that is assigned to a user in Blackboard Learn is mapped to one of the roles defined in the LIS standard. When a user is assigned with a role in a Blackboard Learn course Student or Teacher for example the Kaltura Building Block translates this role to an LIS role which is then sent to KAF. On KAFs side, a dedicated module provides flexible mapping between LIS roles and Kaltura roles, allowing a granular control over the behaviour of the different components of the Kaltura Building Block.

    This process is described in the following workflow:

    Workflow:

    1. Users are assigned a Blackboard Institution, System, or course-level role.

    2. The Building Block maps the corresponding LIS role to Kaltura.

    3. KAF Grants Permissions according to mapping.

    Assigning Roles in Blackboard Learn

    To learn more about roles management in Blackboard Learn, please refer to this manual.

    Mapping Blackboard Learn Roles to LIS roles

    The Kaltura Building Block maps institution, system and course-level roles to LIS roles based on mapping tables that are available under the building block setting page. Login as a System Admin in Blackboard Learn then go to System Admin > Building Blocks > Installed Tools > Kaltura Integration > Settings > Kaltura Video Building Block Role Mapping.

    The following options appear:

    Institution-wide Role Mapping

    This table allows you to choose the role mapping for users outside of the context of a course. The default institution role mapping is provided. Each row represents a Blackboard Learn Institution role, and each column represents the possible LIS roles.

    http://www.imsglobal.org/lti/blti/bltiv1p0/ltiBLTIimgv1p0.htmlhttp://www.imsglobal.org/lti/blti/bltiv1p0/ltiBLTIimgv1p0.html#_Toc261271984http://library.blackboard.com/ref/df5b20ed-ce8d-4428-a595-a0091b23dda3/Content/_admin_app_users/admin_app_users_roles_about.htm

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 23

    When new custom Institution Roles are added in Blackboard Learn, they automatically appear in the table.

    Send administrator role?

    Check this option if you want to send the LIS role Administrator to the Blackboard Learn System Administrator.

    When checked, the Administrator role will be sent for Blackboard System administrators regardless of their Institution or Course-level roles. Use this option to enforce role mapping override for system administrators.

    NOTE: Other system roles are not mapped by the Kaltura Building Block by default.

    Send secondary roles?

    Check this option if you want the Kaltura Building Block to send secondary Institution roles.

    In case more than one LIS roles are sent to KAF, the highest level role will be used.

    System-wide Role Mapping

    The following table allows you to choose the role mapping for users outside of the context of a course in addition to the Institution-wide role mapping. When Institution roles are not available, system roles may be used to map roles outside of course context. Each row represents a Blackboard Learn System role, and each column represents the possible LIS roles. The default settings do not send system roles. System Roles should be used only in cases where Institution roles are not available.

    When new custom System Roles are added in Blackboard Learn, they automatically appear in the table.

    Send system roles?

    Check this option if you want the Kaltura Building Block to send the system roles mapping to KAF. In case more than one LIS roles are sent to KAF (Institution roles and System roles mapping), the highest level

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 24

    role will be used.

    Send secondary roles?

    Check this option if you want the Kaltura Building Block to send secondary System roles.

    In case more than one LIS roles are sent to KAF, the highest level role will be used.

    Course-Level Role Mapping This table allows you to choose the role mapping for users inside the context of courses. The default institution role mapping is listed.

    KAF Grants Permissions According to the Mapping

    On the KAF Admin Console side, each LIS role is mapped back to Kaltura roles. KAF grants different permissions according to the mapping provided in the Hosted module in the KAF Admin Console:

    As displayed, each LIS role is mapped in Kaltura to two roles an Applicative Role (kmsRole) and a Contextual Role (kmsContextualRole). These roles correspond to different cases/scenarios in the Kaltura Building Block for Blackboard Learn. Setting these roles changes the permissions a user has in the following scenarios:

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 25

    Applicative role (KMSRole) - Defines the user roles and permissions in Kaltura widgets that are out of course context (for example: My Media)

    o anonymousRole Not relevant to the Kaltura Building Block for Blackboard Learn and should not be used.

    o viewerRole The user will not have access to My Media, and will not be able to upload new content to either My Media, Media Gallery or using the Embed Kaltura Media text-editor button.

    o privateOnlyRole The user will have access to My Media and will have the ability to create new content.

    o adminRole, unmoderatedAdminRole Not relevant to the Kaltura Building Block for Blackboard Learn and should not be used.

    Contextual role (KMScontextualrole) - Defines the user roles and permission in Kaltura widgets when in a course context (for example: course Media Gallery)

    o Member: The user will be able to view content in Media Galleries of courses to which the user is enrolled, but will not be able to contribute (publish) to the galleries.

    o Contributor: The user has Member permissions with the ability to publish content to the Media Gallery.

    o Moderator: The user has Contributor permissions with the ability to moderate content added to the Media Gallery.

    o Manager: The user has Moderator permissions with the ability edit the Media Gallery settings, and view the course gallery analytics.

    From the Kaltura modules perspective, the permissions are as follows:

    My Media

    o Applicative role: If viewerRole, the user will not have access to My Media and will not be able to upload new content. If privateOnlyRole the user will be able to have its own My Media repository to where he can upload his own private content.

    o Contextual role: does not impact My Media.

    Media Gallery

    o Applicative role: If the user has a contextual role that allows publishing/adding content to the Media Gallery (see the following table), and the user has an Applicative role of privateOnlyRole, the user will be able to upload new content or contribute content from its own private My Media repository.

    o Contextual role: Determines the role of the user inside the Media Gallery (note users can access a course Media Gallery after they have access to the course page inBlackboard Learn, regardless of their Kaltura role.

    Role Permissions

    Member If the user has Member contextual role, the user will be treated as a viewer only in the Media Gallery, and will only be able to view content, and will not be able to contribute content to the Gallery (regardless of the users Applicative role).

    Contributor Users with Contributor role can view Media Gallery entries and upload and contribute entries from My Media (if applicative role is privateOnlyRole). Students are usually assigned Member or Contributor contextual roles.

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 26

    Role Permissions

    Moderator Moderator role allows the users to moderate content published to a Media Gallery (and to contribute new content). Teaching Assistants usually have Moderator contextual roles.

    Manager A Manager role provides full access to the Media Gallery, including the ability to moderate content, edit the Media Gallerys settings and metadata, and access the Media Gallery Analytics. Instructors usually have Manager contextual roles

    Browse, Search and Embed (rich-text editor button)

    o Applicative role: If viewerRole, the user will not have access to My Media and will not be able to create new content. If privateOnlyRole the user will be able to have their own My Media repository to where they can upload their private content.

    o Contextual role: does not impact Embed Kaltura Video.

    Common Use Cases of Role Configuration

    This section provides recommendations for common role configuration in the Kaltura Video Building Block for Blackboard Learn.

    The following use cases are described:

    Allowing Students to Upload Content

    Allowing Faculty Only to Upload and Create New Content

    Creating a Teachers Only Faculty Repository

    Allowing Students to Upload Content

    Description: Allow all Blackboard Learn users to author new content (upload, webcam recording, screencast recording, etc.) and publish to courses, Media Galleries, regardless of their contextual role.

    Blackboard-Learn Side Configuration

    Map students institutional (and/or system) and course-level roles to Learner. Make sure the My Media Module is available to all users: As a system administrator go to System

    Admin > Tabs and Modules > Modules > My Media > Module Properties and set the module availability under the Availability section:

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 27

    KAF Side Configuration

    In your KAF instance, configure the following mapping under the Hosted module:

    ItiRole kmsRole kmsContextualRole

    Learner privateOnlyRole CONTRIBUTOR

    Instructor privateOnlyRole MANAGER

    Allowing Faculty Only to Upload and Create New Content

    Description: Allow only faculty members to create and upload new media. Students should not have access to My Media and should not be able to contribute to any course Media Gallery.

    Blackboard Learn-Side Configuration

    To accomplish this configuration, the My Media link should be available only to faculty members. It is important to hide the My Media link - if students are able to access the My Media link, an Access Denied message will be displayed as they are prevented from accessing My Media by the KAF-side configuration (see below).

    To hide My Media from students

    Log into Blackboard Learn as a system administrator.

    Go to System Admin > Tabs and Modules > Modules > My Media > Module Properties.

    Under Available To, choose Specific Roles and select the desired roles. Make sure that Student is not included.

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 28

    KAF Side Configuration

    In your KAF instance, configure the following mapping under the Hosted module:

    ItiRole kmsRole kmsContextualRole

    Learner viewRole MEMBER

    Instructor privateOnlyRole MANAGER

    Creating a Teachers Only Faculty Repository

    Description: Creating a cross-site, shared repository accessible to faculty only. Only faculty members will have the capability to share common files among multiple courses.

    NOTE: For more information on the Faculty Repository, please refer to Kaltura Video Building Block 5 for Blackboard Learn 9.x User Manual.

    Blackboard Learn Side Configuration

    Add the Faculty Repository module to the Institution homepage and make it available to Faculty members only.

    To add the Faculty Repository Module to the Institution Home Page

    Log into Blackboard Learn as a system administrator.

    Under My Institution click the Add Module button.

    Under Other look for the Faculty Repository module and click Add.

    Click OK.

    To hide the Faculty Repository module from students

    Log into Blackboard as a system administrator.

    Go to System Admin > Tabs and Modules > Modules > Faculty Repository > Module Properties.

    Under Available To, choose Specific Roles and select the desired roles. Make sure that Student is not included.

    http://knowledge.kaltura.com/node/1254/attachment/field_mediahttp://knowledge.kaltura.com/node/1254/attachment/field_media

  • Roles and Permissions

    Kaltura Video Building Block for Blackboard Learn Setup Guide 29

    KAF-side Configuration

    In the Hosted module turn off the shared repository for the Learner LTI role if enabled.

    Kaltura Video Building Block for Blackboard Learn Setup Guide Version: 5 for Blackboard Learn 9.xContentsAbout this GuideAudiencePrerequisite ReadingDocument Conventions

    PrerequisitesBefore You BeginUnderstanding the Setup ProcessThe Kaltura Application Framework (KAF) Admin ConsoleKAF Modules

    KAF Admin General ConfigurationGeneral SettingsMandatory Configuration

    KAF Admin Module ConfigurationPlaybackPlayerAudioentryImageentryVideopresentations

    Content AuthoringMedia UploadWebcam RecordingVideo PresentationsScreen RecordingCaptionsThumbnailsMetadataCustomdata

    Content Sharing and PublishingChannelmoderationSharedRepositories

    CommentsVideo EmbedsEmbedBrowseandembed

    Roles and PermissionsIntroduction to Role MappingAssigning Roles in Blackboard LearnMapping Blackboard Learn Roles to LIS rolesInstitution-wide Role MappingSystem-wide Role Mapping

    KAF Grants Permissions According to the Mapping

    Common Use Cases of Role ConfigurationAllowing Students to Upload ContentBlackboard-Learn Side ConfigurationKAF Side Configuration

    Allowing Faculty Only to Upload and Create New ContentBlackboard Learn-Side ConfigurationKAF Side Configuration

    Creating a Teachers Only Faculty RepositoryBlackboard Learn Side ConfigurationKAF-side Configuration