HELIX MEDIA LIBRARY BLACKBOARD BUILDING BLOCK

Transcription

1 HELIX MEDIA LIBRARY BLACKBOARD BUILDING BLOCK Revision Date March 2013

2 The following guide explains how to install the Helix Media Library Blackboard Building Block which allows access to content in the Helix Media Library through the Helix Media Library API. Pre-requisite Step IMPORTANT: For the Plugin to work the IP address of your Blackboard server must be set in the API section of the Helix Media Library To configure this simply Log In to Helix Media Library as an Administrator and navigate to Settings > API and add you Blackboard Server s IP address to the API Menu

3 Installation Log into Blackboard as an administrator and click on System Admin Click on Building Blocks Click on Installed Tools

4 Click on Upload Building Blocks Under Install Building Block, click Browse Locate the building block on your machine e.g. HelixMediaLibraryBb war and click OK Click on Submit Back on the Installed Tools page, locate the Helix Media Library plugin and click on the down arrow next to it. Select Set Available A success message will appear at the top of the page letting you know that it has been made available

5 Select the down arrow next to the Helix Media Library plugin again and this time select Settings Click on Enter Connection Data Enter the following details in (the URL s below are examples) API URL: This is the address of the end point of the Helix Media Library API. It is the address of the back end administration web site for your Helix Media Library appended with /Api/hmlapi.svc/soap HTTP Server Host Name: This is the address of the front end of your Helix Media Library Video Streaming URL: rtmp://helix.domain.edu/flash This is the address of your Helix Server mountpoint used for Helix Media Library appended by rtmp:// Video Download URL: This is the address of your Helix Server mountpoint used for Helix Media Library appended by Audio Streaming URL: This is the address of your Helix Server mountpoint used for Helix Media Library appended by

6 Click Submit once the values have all been filled out Testing and End User Experience To test that the Building Block is working log in to Blackboard and navigate to a Course within Blackboard. Once within a Course click Content and then Build Content. Helix Media Library should appear as a Mashup option Click on the Helix Media Library Mashup option this will return a search box allowing you to search the Helix Media Library content repository

7 Searching for a media item will return results and you click to Preview or Select the item and add it to the Course. To test simply navigate back to the Course Page and Click on the Click to View hyperlink by the media item

8 Content Exclusion from Mashup It is possible for media in certain categories within the Helix Media Library to be excluded from the Mashup search for all but instructors on selected Courses (ID s). To configure this, the System Administrator needs to navigate to: System Admin > Installed Tools > and edit the Settings of the Helix Media Library Building Block. Then click to Click to Manage Course-Level Category Restrictions

9 The System Administrator must then upload a csv file containing mappings between Blackboard Course ID s and Helix Media Library category ID s. These mappings dictate the categories within the Helix Media Library that are only available to instructors on specific Course ID s. Instructors who are not on these specific Courses will be returned search results without media in these categories. Column 1 should have a Blackboard Course ID; Column 2 a Category ID. Note that this process skips the first row of.csv data and any row with an unrecognized Course ID or Category ID. An example to illustrate is below The Helix Media Library category ID s are most easily sourced by logging into Helix Media Library as an administrator and then hovering over the category names in the menu to see the ID at the base of the browser.

10 To test, upload a csv file containing one Course ID from Blackboard and one Category ID from Helix Media Library, this will appear in the page if successful. Then log in as a test instructor user who is not assigned to that Course ID and search for a media item in that category in the Helix Media Library Mashup. The item should NOT appear in the search if the mapping has been successful. NOTE: Please remember to click to clear the entry to delete the mapping after testing. Using the Building Bock When Running the Upload Site Over HTTPS When running the HML Upload site over HTTPS, there is some additional XML that needs to be placed in the web.config file for the upload site. On the Server locate the path to the web.config file by going to the install directory of the HML, then clicking on the Upload folder, e.g. C:\HelixMediaLibrary\Upload\web.config Find the following tags: <system.servicemodel></system.servicemodel>. Replace them and all the text between them with the following in RED: <system.servicemodel> <behaviors> <servicebehaviors> <behavior name="soaprestdemobehavior"> <servicemetadata httpgetenabled="false" httpsgetenabled="true" /> <servicedebug includeexceptiondetailinfaults="true" /> </behavior> </servicebehaviors> <endpointbehaviors> <behavior name="soapdemoendpointbehavior"> </behavior> <behavior name="restdemoendpointbehavior"> <webhttp /> </behavior> </endpointbehaviors> </behaviors> <bindings> <basichttpbinding> <binding name="hmlservicebinding" transfermode="buffered" messageencoding="text" maxreceivedmessagesize="655360" maxbuffersize="655360" closetimeout="00:01:00" opentimeout="00:01:00" receivetimeout="00:10:00" sendtimeout="00:01:00"> <security mode="transport"> </security> </binding> </basichttpbinding> </bindings> <servicehostingenvironment multiplesitebindingsenabled="true"> </servicehostingenvironment> <!--Set up the service--> <services> <service behaviorconfiguration="soaprestdemobehavior" name="hmlapi"> <endpoint address="soap" behaviorconfiguration="soapdemoendpointbehavior" binding="basichttpbinding" bindingconfiguration="hmlservicebinding" contract="vlscore2.interfaces.ihmlapi" /> </service> </services> </system.servicemodel>

11 If the upload website ever changes back from HTTPS to HTTP, then use the following code in RED to replace the <system.servicemodel> section and return the web.config file to its previous state. <system.servicemodel> <servicehostingenvironment multiplesitebindingsenabled= true > </servicehostingenvironment> <! Set up the service > <services> <service behaviorconfiguration= SOAPRESTDemoBehavior name= HmlApi > <endpoint address= rest behaviorconfiguration= SOAPRESTDemoEndpointBehavior binding= webhttpbinding contract= VLSCore2.Interfaces.IHmlApi /> <endpoint address= soap binding= basichttpbinding contract= VLSCore2.Interfaces.IHmlApi /> </service> </services> <! Define the behaviours > <behaviors> <servicebehaviors> <behavior name= SOAPRESTDemoBehavior > <servicemetadata httpgetenabled= true /> <servicedebug includeexceptiondetailinfaults= true /> </behavior> </servicebehaviors> <endpointbehaviors> <behavior name= SOAPRESTDemoEndpointBehavior > <webhttp /> </behavior> </endpointbehaviors> </behaviors> </system.servicemodel>