NBC Learn Tool. Administrator s Guide V3.0

Transcription

1 NBC Learn Tool Administrator s Guide V3.0

2 Trademarks NBC Universal and NBC News Learn are registered trademarks of the National Broadcasting Company. All other trademarks and registered trademarks are the property of their respective owners. Copyright Notice Copyright 2014 by NBC Universal. All rights reserved. Reproduction of all or any portion of this text, software, or exhibits without written consent is expressly prohibited. The documentation in this guide is subject to change by NBC Universal without prior notice. Users may copy this manual and the program(s) described in this manual only for the express purpose(s) for which the program and product(s) were designed and only for the direct use(s) of the original purchaser. Any and all copies of the materials must contain appropriate NBC Universal copyright statements and acknowledgments.

3 Table of Contents Contents 1 INTRODUCTION Product Overview Prerequisites Customer Support INSTALLATION Configuration LTI Settings Enable/Disable Components Enable/Disable Editor plugin Enable/Disable Resource plugin Enable/Disable Repository plugin Enable/Disable Browse Link Privacy Settings External Tool Types Settings Enable/Disable External Tool Type Enable/Disable External Tool Type... Error! Bookmark not defined. 3.5 Add Browse NBC Learn activity on the Front page.... Error! Bookmark not defined. 4 Authentication Verification... 23

4 1 INTRODUCTION This document details the installation and administration of the NBC Learn External Tool for the Moodle Learning Management System. Moodle Administrators should refer to this guide to facilitate the configuration and management of the NBC Learn External Tool/ plugins to ensure proper installation and functionality. 1.1 Product Overview NBC Learn, the education division of NBC News, offers unique collections of video resources, primary source documents, historical footage, images and mini- documentaries designed for use in the classroom. The NBC Learn External Tool enables subscriber institutions the ability to enhance classroom learning by embedding NBC Learn resources in their Moodle courses. The NBC Learn External Tool seamlessly integrates with your current Moodle installation and enables instructors to embed NBC content into existing courses for course delivery. For students, NBC Learn is a valuable research tool and unique study aid. 1.2 Prerequisites In order to get started in NBC Learn, you would need: A signed End User License Agreement (EULA) between your institution and NBC Learn. Your NBC Learn Consumer Key/Shared Secret from NBC Learn. NBC Learn External tool installer and admin guide. An operational test or production Moodle system version 2.3 and up. Technical Knowledge of Moodle environment settings and plugin installation. System administrator privileges on the Moodle server. Note: If you do not have NBC Learn installer you can download it from Customer Support Technical Support is available from the following: Via the web at Direct by Phone: (877) NBC (please have your consumer key / Subscription Token available.)

5 2 INSTALLATION The NBC Learn Tool can be installed manually or by using installation scripts that are part of the installation package. Note: A video version of this guide is also available at Note: The pictures taken in this guide, are for a Moodle server hosted on UNIX operating system, and user is connected to the server using a SSH tool. 1. Download the NBC Learn tool installer from or the link provided in the subscriber activation Unzip the installer, and you should see the list of folders as depicted in the picture below. 3. Move the unzipped folder to the Moodle server. 4. Make sure to login into the Moodle servers as administrator or the same user account, which you used to install Moodle.

6 5. If you Moodle server is hosted on the Windows operating system use install.bat and if it is is hosted on Unix operating system then use Install.sh script. 6. Prior to executing the installer script, make sure the logged in user have executable rights on the file. 7. Run the installer script, and you will be prompted to enter the Moodle installation path on the server. Note: Picture depicted below is from UNIX server. However, if you are on Windows server instead, you must execute install.bat from the command prompt.

7 8. Enter the Moodle installation path and press enter, on successful installation you will be prompted with a message Files are copied successfully. 9. Login to your Moodle site as an administrator and the site will list down all the NBC Learn plugins to be installed.

8 10. Click on Upgrade Moodle database now to install the plugins, and the site would prompt you with the success or failure message. 11. Click on the Continue button, and if the installation were successful you would be presented with the NBC Learn configuration screen. NOTE: An alternate way of installing NBC Learn tool is to copy, individual plugin folders from the installer to the appropriate directories inside Moodle.

9 3 Configuration NBC Learn tool provides a centralized administration screen, to configure, enable and disable all the plugins installed as part of the NBC Learn tool installation. There are three configurations sections on the page: 3.1 LTI Settings 1. Log into Moodle as an Administrator. 2. Click on Home>Site administration>plugins>local Plugins>NBC Learn Configuration and it will open the centralized configuration screen. 3. Enter the NBC Learn URL, Consumer Key, and Shared Secret. Note: Launch URL for NBC Learn is but if your Moodle instance is running as HTTP then you may use (although it is not necessary) 3.2 Enable/Disable Components By default, all plugins are enabled as part of the installation process. However, you could choose to enable/disable plugins based on your choice Enable/Disable Editor plugin

10 1. Log into Moodle as an Administrator. 2. Click on Home>Site administration>plugins>local Plugins>NBC Learn Configuration and it would open the centralized configuration screen. 3. To disable NBC Learn plugin from the text editors uncheck the checkbox for Enable Editor (TinyMCE/Atto) Plugin and click on Save Changes button. 4. To verify if the plugin was disabled, go to a course and click on Add an Activity and check the Editor toolbar and the NBC Learn icon should not be present.

11 5. To enable NBC Learn plugin in the text editors, please check the checkbox for Enable Editor (TinyMCE/Atto) Plugin and click on Save Changes button. 6. Verify the editor toolbar for NBC Learn icon, to check if the plugin is enabled successfully Enable/Disable Resource plugin 1. Log into Moodle as an Administrator. 2. Click on Home>Site administration>plugins>local Plugins>NBC Learn Configuration and it would open the centralized configuration screen. 3. To disable NBC Learn resource plugin, uncheck the checkbox for Enable Resource Plugin and click on Save Changes button.

12 NBC Learn Administrator s Guide

13 4. To verify if the plugin was disabled, go to a course and click on Add an Activity and NBC Learn icon should disappear from the resources section. 5. To enable NBC Learn resource plugin, please check the checkbox next to Enable Resources Plugin and then click on Save Changes button. 6. Verify the resources section for NBC Learn icon, to check if the plugin is enabled successfully.

14 3.2.3 Enable/Disable Repository plugin 1. Log into Moodle as an Administrator. 2. Click on Home>Site administration>plugins>local Plugins>NBC Learn Configuration and it would open the centralized configuration screen. 3. To disable NBC Learn repository plugin, uncheck the checkbox next to Enable Repository Plugin and click on Save Changes button.

15 4. To verify if the plugin was disabled, go to a course item and then and then navigate to the text editor. 5. Click on the Moodle Media icon from the Editor toolbar and then click on Browse Repositories button. 6. To verify if the plugin was disabled, go to the Repositories and NBC Learn icon should disappear from the repositories listing.

16 7. To enable NBC Learn repository plugin, please check the checkbox next to Enable Repository Plugin and then click on Save Changes button. 8. Verify the repository listing for NBC Learn icon, to check if the plugin is enabled successfully.

17 3.2.4 Enable/Disable Browse Link 1. Log into Moodle as an Administrator. 2. Click on Home>Site administration>plugins>local Plugins>NBC Learn Configuration and it would open the centralized configuration screen. 3. To disable NBC Learn browse link from the navigation bar, uncheck the checkbox next to the Enable Browse Link and then click on the Save Changes button.

18 7. To verify if the plugin was disabled, go to the home page and then and then look at the navigation bar, and the Browse NBC Learn link should disappear from the navigation. 8. To enable Browse NBC Learn link in the navigation block, please check the checkbox next to Enable Browse Link and then click on Save Changes button. 9. Verify the navigation block on the home page for Browse NBC Learn link, to check if the plugin is enabled successfully.

19 3.3 Privacy Settings In the Privacy section, select what user data you would allow to be released to NBC learn Tool. Note: We recommend the user s Name and to be checked for subscriber usage reporting purposes. At a minimum, you must allow Launcher s Name for salutation and personalized features of the tool. 3.4 External Tool Types Settings In this section, Administrator s can enable NBC Learn External Tool Types for the instructors to create External Tool Links within the courses Enable/Disable External Tool Type 1. Log into Moodle as an Administrator. 2. Click on Home>Site administration>plugins>local Plugins>NBC Learn Configuration and it would open the centralized configuration screen. 3. To disable NBC Learn external tool type, uncheck the checkbox next to the Create External Tool Type and then click on the Save Changes button.

20 4. To verify if the plugin was disabled, go to a course and click on Add an Activity. 5. From the activity popup, select External Tool as an activity and then click on the Add button.

21 6. On the External Tool creation page, click on the External Tool Type drop down, and you should not see NBC Learn as an option.

22 7. To enable NBC Learn tool type, please check the checkbox next to Create External Tool Type and then click on Save Changes button. 8. Verify the External Tools creation page for NBC Learn option in the External Tools Type dropdown, to check if the plugin is enabled successfully Custom Parameters When users are navigating to NBC Learn either from the External Tool link or the Browse NBC Learn navigation link, the Embed button on NBC Learn player provides the Embed Code or Embed Link to the users, below table summarize the differences between these two options. Mode Value Video Share URL/Embed code Usage inside Moodle Usage outside Moodle EMBEDCODE IFRAME Embed code can be used anywhere except the Forum Post, Glossary and Wiki items using WYSIWYG Editor inside Moodle. If Anywhere

23 you wish to embed videos into these items, use NBC Learn plugin for text editors. EMBEDLINK LINK with thumbnail Link can we used anywhere inside Moodle. Anywhere 4 Authentication Verification 1. Click on the Browse NBC Learn link from the Navigation block on the home page or the NBC icon from the text editor menu, and it will open NBC Learn website within Moodle. 2. Navigate to any collection on the left- hand side or search for the related and try to play a video. 3. If you see the video playing full length and embed code is visible, then it an indication that your subscription is configured correctly and successfully activated.