Kaltura Video App for Canvas Setup Guide
Contents
1. 4 SECTION 1 Prerequisites The following items are required to setup the Kaltura Video App for Canvas e Access to a Canvas environment with Account Admin permissions e A Kaltura account Please contact your Kaltura representative for your Kaltura account details e Deployment of the Kaltura Video App for Canvas on your Canvas environment For deployment instructions see Kaltura Video App for Canvas Deployment Guide e 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 Canvas root category in the KMC To create the Canvas 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 SNS New Category Select the parent category under which the new category will appear No Parent 5 Click Next Kaltura Video App for Canvas Setup Guide 5 Before You Begin 6 Inthe metadata tab enter metadata for your new category and click Save New Category Metadata Name Canvas Description Used as KAF root category Tags Reference ID Save Save amp Close Kaltura Video App for Canvas Setup Guide Understanding the Setup Process SECTION 2 Understanding the Setup Process The Kaltura Video App for Canvas offers2. The player ID uiConf ID of the player that is used to edit entries Determines whether the video should start playing autoPlayOnLoad automatically when the player loads Player ID uiConf ID of the player that plays audio Audioentry audioPlayerld entries Player ID uiConf ID of the player that shows Imageentry imagePlayerld images Captions amp NOTE Related KAF modules Audioentry Imageentry Captions Kaltura Video App for Canvas Setup Guide 9 Enable the captions module to allow end users to upload captions to entries they own Description The uiConf ID of the Kaltura Simple Uploader KSU used for captions MediaSpace uses KSU to upload SRT and DFXP caption files Module Fields Captions captionsKsuld 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 Authoring Methods d Related KAF modules Widgets Screencapture CS 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 e Uploading media from the local machine e Capturing a video from a webcam using the Kaltura Webcam Recorder KRecord e Creating a new screencast using the Kaltura Screen Recorder KSR Please refer to the Kaltura Video App for Canvas User Manual
3. ago Kms Git n Collabo k My Media Demo SS ER D Image001 ne eueweerewwes eme ey RATUT OUTTA oxo cnacccoccccccccoccccecceeecceecceecseee SEB RBBB BRB eee eee d Canvas KAF Admin Console 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 App for Canvas instance 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 al listed in this guide some of which may be disabled It is important that you do not modify the Xe configuration of the disabled modules and not enable them without consulting with your e Kaltura representative Kaltura Video App for Canvas Setup Guide 7 The following KAF modules are required for configuring the Kaltura Video App for Canvas and are described in this guide Application Client Auth security Player Metadata Categories Addcontent Captions Comments Customdata Publish Screencapture Channelmoderation Audioentry Imageentry Videopresnetation Canvas Browseandembed Hosted KAF Admin General Configuration Mandatory Settings Related KAF modules Application Auth Client Security Categories Addcontent Publish Browseandembed Canvas Hosted Your KAF account comes pr
4. Kaltura Video App for Canvas Setup Guide Version 1 0 MZ O AN Kaltura open source video Kaltura Business Headquarters 5 Union Square West Suite 602 New York NY 10003 USA Tel 1 800 871 5224 Copyright 2014 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 Contents TAC Eege 4 ee E 0 0 EE 4 PRS NCS ee 4 POON SI Roading EE 4 Document SONNY SF ONS EE 4 Section 1 Prerequisites ccccccccccccecssssseececeeeeeaaeeseeceeeeeseeeeseeeeeeesesaeeuseeceeeseeseeauseeeeeeesseuaaseeeeeeeesssaaaaesss 5 Section 2 Understanding the Setup Process cccccccccsssseeeeeeeeeeeaaeeseeeeeeeeeeesaeseceeeeeessuaaaaeeeeeeeessaaansees 7 The Kaltura Application Framework KAF Admin Console snaannnnnnaannnnnennnnnnnnnnnnnnsnnnnnnsnnnenesennenee 7 SE e e n 7 Mandatory MS tcc deter evade seme garde egal E pleads e e e ia a 8 KAF Admin Module Confouraton 9 Player LOOK and Feel 9 A OS LEIE errs cence A T E E A E E E A A A N 9 AUNO NTO MEO eriein iiini a E de ae a saw ge A eE EE EEE EEEE E EEEN EEE EE EE 10 Deeler dE E E A A E E E 10 Webcam Recording EE 10 Cea Pecorino aneen a E E E E dened a Ei 11 Ee E ire ME 11 Eo an EE E E PE E A A A A AE AE E EET E E A A E EE 12 FOES GING SUMS SIONS reenn nenn 12 Bee elt EE 13 Section 3 Common Use Cases of Role Config
5. OnlyRole MANAGER TeachingAssistant privateOnlyRole MODERATOR ContentDeveloper privateOnlyRole MANAGER Observer viewerRole MEMBER Kaltura Video App for Canvas Setup Guide 17
6. an out of the box solution that enables users to view record upload publish search and share video directly from their Canvas 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 App for Canvas is implemented on top of the Kaltura Application Framework KAF a feature rich framework that allows flexible and streamlined integration of Kaltura s video solution and products into 3 party applications such as Canvas KAF is hosted and served directly from the Kaltura cloud servers and once integrated into your Canvas 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 Canvas Nearly all configuration aspects of the Kaltura Video App for Canvas are configured through the KAF Admin Console Canva n u Zens Logout Heip canvas Configuration Management My Media s H Sort by Most Recent View All Statuses View All Media Q H Developer Tools Hosted H ente Ce erte mrret Kaltura Logo Mp4 Figg 2 z 3 5 4 w 10 2 Days
7. e assigned a Canvas role when added to courses via the Add People dialog 2 Canvas sends the corresponding LIS role to Kaltura 3 KAF Grants Permissions according to mapping Add People Users are assigned a Canvas role when added to courses via the Add People dialog Type or paste a list of email addresses below Example Student lt student example com Lastname Firstname lt firstlast example com justAnEmailAddress example com student Student Teacher TA Designer Observer Canvas Sends Corresponding LIS Role to Kaltura When the user accesses a Kaltura module such as My Media and Media Gallery Canvas sends the corresponding LIS role to Kaltura according to the following mapping Canvas role LIS role Student Learner Teacher Instructor Kaltura Video App for Canvas Setup Guide 13 Understanding the Setup ProcKAF Admin General Configuration Canvas role LIS role TA TeachingAssistant Designer ContentDeveloper Observer Observer KAF Grants Permissions According to the Mapping On the KAF Admin Console side each LIS role can be mapped back to Kaltura roles KAF grants different permissions according to the mapping provided in the Hosted module in the KAF Admin Console ItiRolesMapping Map each LTI role to a MediaSpace role a1 ItiRole Learner LISrole kmsRole privateOnlyRole VM lt ___ Ka
8. e configured with the following settings which should not be changed Module Fields Application Auth sslSettings Sin serviceUr VerifySLL Security Addcontent enabled Publish enabled Browseandembed enabled Kaltura Video App for Canvas Setup Guide Instanceld privacyContext userRoleProfile allowLoadInlframe Description Internal constant identifiers of your KAF instance Please note that privacyContext should be empty All site httos www kaltura com Yes Yes Yes Yes Yes Module Fields Description Canvas enabled Yes enabled Yes enableLike No enabledEntryDelete No Hosted enablePresentations No enableViews No 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 KAF Admin Module Configuration This section describes how to configure the KAF Modules x NOTE Related KAF modules Audioentry Imageentry Captions Player Look and Feel Module Fields Description Choose the player to use when playing back videos in My Media and in Media Gallery playerld 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 Player The ratio in percent of the video inside the player playerVideoRatioPercent Standard values 16 9 56 25 4 3 75 16 10 62 5 playerEditld
9. for more details about each of these methods Add New w D H Media Upload EH Webcam Recording Le Screen Recording Media Upload Please refer to Roles and Permissions Webcam Recording Module Fields Description The uiConf ID of the kRecord widget krecordld MediaSpace uses kRecord to record and Widgets upload video from a webcam The URL of your RTMP Server The URL is rtmpUrl Kaltura Video App for Canvas Setup Guide required for Webcam recording Screen Recording Adds the Screen Recording option to the Add What is the widget ID uiConf ID of the Kaltura ksrld Screen Recorder Widget KSR used in screencapture MediaSpace The video bitrate quality in kbps to use for the videoBitrate capture For example 2000 Enable the option to select frames per second by advancedOptionsEnabled Peu Metadata Related KAF modules Metadata Customdata 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 descrivtionReauired Require users to fill in the Description field when i S uploading or editing media taasReauired Require users to fill in the Tage field when Ge uploading or editing media Metadata readMoreEnabled Enable disable read more for entry description shortening to 500 characters If enabled metadata is hidden until clicking on read metaDatalnReadMore mo
10. l configurations are set in the Hosted KAF module in the KAF Admin Console Canvas Role Student Student TA Teaching Assistant Teacher Designer Use case Allow authoring new content upload webcam recording screencast recording and allow publishing to course Media Galleries Allow viewing content only Do not allow authoring new content or publishing to course Media Galleries It is recommended to hide the My Media navigation link on the course menu so that students will not receive an Access Denied screen when trying to access My Media Allow to author new content to contribute to course Media Galleries and to moderate course media galleries Allow authoring new content contributing to course Media Galleries and moderating course Media Galleries Allow authoring new content Kaltura ItiRole Learner Learner TeachingAssistant Instructor ContentDeveloper Kaltura Video App for Canvas Setup Guide kmsRole privateOnlyRole viewerRole privateOnlyRole privateOnlyRole privateOnlyRole kmsContextualRole CONTRIBUTOR MEMBER MODERATOR MANAGER MANAGER Common Use Cases of Role Configuration ItiRole kmsContextualRole contributing to course Media Galleries and moderating course Media Galleries Only allow viewing MEMBER Summary of Default Canvas gt LIS gt Kaltura Roles Mapping Student privateOnlyRole CONTRIBUTOR private
11. ll not be able to contribute publish to the galleries Kaltura Video App for Canvas Setup Guide 14 Understanding the Setup ProcKAF Admin General Configuration 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 module s perspective the permissions are as follows e 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 e Media Gallery o Applicative role If the user has a contextual role that allows publishing adding content to the Media Gallery see below 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 in Canvas regardless of their Kaltura role Role Permissions Member If the user has Me
12. ltura applicative role kmsContextualRole CONTRIBUTOR lt ___ Kaltura contextual role ItiRole Instructor kmsRole privateOnlyRole d kmsContextualRole MANAGER D 3 ItiRole TeachingAssistant kmsRole privateOnlyRole v As displayed each LIS role is mapped in Kaltura to two roles an applicative role kmsRole anda contextual role kmsContextualRole These roles correspond to different cases scenarios in Kaltura App for Canvas Setting these roles changes the capabilities a user has in the following scenarios e 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 Canvas integration 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 upload new content o adminRole unmoderatedAdminRole not relevant to the Canvas integration and should not be used e 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 wi
13. mber 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 user s 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 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 roles provides full access to the Media Gallery including the ability to moderate content edit the Media Gallery s settings and metadata and access the Media Gallery Analytics Instructors usually have Manager contextual roles e Embed Kaltura Video rich text editor button 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 their own My Media repository to where they can upload their private content o Contextual role does not impact Embed Kaltura Video Kaltura Video App for Canvas Setup Guide 15 SECTION 3 Common Use Cases of Role Configuration This section provides recommendations for common role configuration in the Kaltura Video App for Canvas Al
14. or the course videos private however public comments from other courses will be visible Module Fields Description enable Enable the Comments module Defines who can add comments See Roles and commentAllowed ee Permissions allowClose Allows content owners to disable close comments EEREER for particular entries When set to Yes adds the option Keep comments private to channel in the Media Gallery settings page to allow channel owners to set comments as private showPrivateCommentsConfig Roles and Permissions d Related KAF modules Hosted eh See Common Use Cases of Role Configuration for information and recommendations for common role configuration in the Kaltura Video App for Canvas Kaltura Video App for Canvas Setup Guide 12 KAF Admin General Configuration Role Mapping The Kaltura Video App for Canvas implements role mapping from Canvas roles to Kaltura roles via LIS roles Each role that is assigned to a user in Canvas is mapped to one of the roles defined in the LIS standard When a user is assigned with a role in a Canvas course for example Student or Teacher Canvas translates this role to an LIS role which is then sent to KAF On KAF s side a dedicated module provides flexible mapping between LIS roles and Kaltura roles allowing a very granular control over the behavior of the different Kaltura modules in Canvas This process is described in the following workflow Workflow Z 1 Users ar
15. re works for all descriptions entry channel category Use the Customdata module to choose a custom metadata profile Enable the Customdata module The ID of the custom metadata Copy the custom data schema profileld ID from KMC gt Settings gt Custom Data http www kaltura com index php kmc kmc4 account metadata dateFormat The format of the date for the date picker Customdata The custom data fields required before publishing media Use requiredFields custom data system names from KMC gt Settings gt Custom Data http www kaltura com index php kmc kmc4 account metadata The custom data fields that are not displayed in MediaSpace Use custom data system names from KMC gt Settings gt Custom Data http www kaltura com index php kmc kmc4 account metadata privateFields Kaltura Video App for Canvas Setup Guide 11 Module Fields Description Note Private custom data fields are not hidden when the media owner accesses media from My Media Comments e 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 f
16. uration ccccccccssseeseeeeeeeeeeaeeeseeeeeeeseaaaseeeeeeeeessasaaeees 16 Summary of Default Canvas gt LIS gt Kaltura Roles Mapping sso0000nnnnnnnnonnnnnnnnnnnennnnnnnnnnnne 17 Kaltura Video App for Canvas Setup Guide 3 Preface This preface contains the following topics e About this Guide e Audience e Document Conventions About this Guide This guide describes how to setup the Kaltura Video App for Canvas Instructions are provided for setting up the app s 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 E Technical support may be obtained directly from Kaltura Customer Care Contact Us Please send your documentation related comments and feedback or report mistakes to knowledge kaltura com We are committed to improving our documentation and your feedback is important to us Audience This guide is intended for Canvas and Kaltura administrators Prerequisite Reading e Kaltura Video App for Canvas User Manual e Kaltura Video App for Canvas Deployment Guide Document Conventions Kaltura uses the following admonitions e Note d NOTE Identifies important information that contains helpful suggestions e Workflow Pi Workflow Provides workflow information VY dei 1 Step 1 2 Step 2 Kaltura Video App for Canvas Setup Guide
Download Pdf Manuals
Related Search