Integrating Kaltura into Canvas

To get Kaltura integrations to work with Canvas hosted by Instrucrure a couple of things needs to be set in a certain way, and done in a certain order.

First of all, the KAF settings should be changed te reflect the below values. After that, make sure that there are no Kaltura apps in you Canvas installation!. Then finally you can install the App using the below XML files.

These settings needs to be set to these specific values.

Browseandembed module

Option Value
enabled Yes
returnUrlMethod GET
BSEPlayerId A player id from your KMC's Studio-section
contentItemReturnUrlAttr content_item_return_url

Canvas module

Option Value
enabled Yes
appId APP ID THAT YOU GET FROM CANVAS
appKey APP KEY THAT CAME WITH THE appId

Hosted module

Option Value
enabled Yes
ltiUserIdAttribute custom_canvas_user_login_id
ltiOutcomeServiceURL launch_presentation_return_url
ltiReturnUrlType iframe
ltiContextIdAttribute custom_canvas_course_id

When you have made sure that the settings described above have the correct values, you can install the Kaltura App in Canvas by using these two XML files.

You need to replace {{KAF_URL}} with the KAF URL you have been given for instance kaf-canvas-100.kaltura.nordu.net, and replace {{KMC_PARTNERID}} with your actual PartnerId from the KMC.

In some cases you also need to change the $Canvas.course.id and $Canvas.user.loginId values, but this is usually not needed and depends on your Canvas setup and authentication provider.

Installation in Canvas

Login to Canvas as an Admin, and klik Admin>Settings>Apps. Then on the button “View App Configurations”, again! Make sure that all previous installed Kaltura apps have been removed.

Click the “+App” button and select the “Configuration Type” called “Paste XML”. Fill out the rest of the form:

Option Value
Name The name that you want the App to apear as in Apps settings
Consumer key Your partnerId form the KMC
Shared secret The admin secret from the KMC
XML Configuration The contents of the XML file below (one at a time)
MediaGalleryAndBSE.xml
<?xml version="1.0" encoding="UTF-8"?>
<cartridge_basiclti_link xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0"
	xmlns:blti="http://www.imsglobal.org/xsd/imsbasiclti_v1p0"
	xmlns:lticm="http://www.imsglobal.org/xsd/imslticm_v1p0"
	xmlns:lticp="http://www.imsglobal.org/xsd/imslticp_v1p0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd
	http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0.xsd
	http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd
	http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd">
	<blti:title>Media Gallery and Embed</blti:title>
	<blti:description>Media Gallery and Embed</blti:description>
	<blti:icon>https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png</blti:icon>
	<blti:launch_url>https://{{KAF_URL}}/canvas/index/launch/target/course-gallery</blti:launch_url>
	<blti:custom>
		<lticm:property name="custom_canvas_course_id">$Canvas.course.id</lticm:property>
		<lticm:property name="custom_canvas_user_login_id">$Canvas.user.loginId</lticm:property>
	</blti:custom>
	<blti:extensions platform="canvas.instructure.com">
		<lticm:property name="tool_id">KALTURA-NDN-{{KMC_PARTNERID}}-1</lticm:property>
		<lticm:property name="privacy_level">public</lticm:property>
		<lticm:property name="domain">{{KAF_URL}}</lticm:property>
		<lticm:options name="editor_button">
			<lticm:property name="message_type">ContentItemSelectionRequest</lticm:property>
			<lticm:property name="url">https://{{KAF_URL}}/browseandembed/index/browseandembed</lticm:property>
			<lticm:property name="icon_url">https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png</lticm:property>
			<lticm:property name="text">Embed Kaltura Media</lticm:property>
			<lticm:property name="selection_width">1100</lticm:property>
			<lticm:property name="selection_height">600</lticm:property>
			<lticm:property name="enabled">
				true
			</lticm:property>
		</lticm:options>
		<lticm:options name="course_navigation">
			<lticm:property name="url">https://{{KAF_URL}}/canvas/index/launch/target/course-gallery</lticm:property>
			<lticm:property name="icon_url">https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png</lticm:property>
			<lticm:property name="text">Media Gallery</lticm:property>
			<lticm:property name="enabled">true</lticm:property>
		</lticm:options>
	</blti:extensions>
	<cartridge_bundle identifierref="BLTI001_Bundle" />
	<cartridge_icon identifierref="BLTI001_Icon" />
</cartridge_basiclti_link>
MyMedia.xml
<?xml version="1.0" encoding="UTF-8"?>
<cartridge_basiclti_link xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0"
	xmlns:blti = "http://www.imsglobal.org/xsd/imsbasiclti_v1p0"
	xmlns:lticm ="http://www.imsglobal.org/xsd/imslticm_v1p0"
	xmlns:lticp ="http://www.imsglobal.org/xsd/imslticp_v1p0"
	xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation = "http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd
	http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0.xsd
	http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd
	http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd">
	<blti:title>My Media</blti:title>
	<blti:description>My Media</blti:description>
	<blti:icon>https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png</blti:icon>
	<blti:launch_url>https://{{KAF_URL}}/hosted/index/my-media</blti:launch_url>
	<blti:extensions platform="canvas.instructure.com">
		<lticm:property name="tool_id">KALTURA-NDN-{{KMC_PARTNERID}}-1</lticm:property>
		<lticm:property name="privacy_level">public</lticm:property>
		<lticm:property name="domain">{{KAF_URL}}</lticm:property>
		<lticm:options name="course_navigation">
			<lticm:property name="url">https://{{KAF_URL}}/canvas/index/launch/target/my-media</lticm:property>
			<lticm:property name="icon_url">https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png</lticm:property>
			<lticm:property name="text">My Media</lticm:property>
			<lticm:property name="enabled">true</lticm:property>
		</lticm:options>
	</blti:extensions>
	<cartridge_bundle identifierref="BLTI001_Bundle"/>
	<cartridge_icon identifierref="BLTI001_Icon"/>
</cartridge_basiclti_link>