Barnes & Noble College LTI Tool

Transcription

1 Barnes & Noble College LTI Tool Last updated September /22/2015

2 Contents Contents 1.0 Introduction Key and Secret Request Form Link and Instructions Testing Link Connectivity with BNC Link Authoring with a Course Purchase Course Materials Research and Adopt Course Materials System Level External Tool Configurations Setup Purchase Course Materials and Research and Adopt Course Materials Global Links Authoring a URL Resource for Yuzu Creating a URL Access Digital Course Material Creating a URL Learn About Digital Options Important Notes and Troubleshooting How can a user find their LMS User ID? How can a user identify a specific LMS course ID? I m getting an error when I try to launch out with the LTI link I am not able to successfully launch out of the LTI link I authored /22/2015

3 1.0 Introduction The purpose of this document is to provide details to an institution and the LMS administrator on how to integrate links within the Moodle Learning Management System. References/screenshots to options in this user guide may differ in location based on what version of Moodle the institution has installed. 2.0 Key and Secret Request Form Link and Instructions LMS Administrators will need to request a key and secret in order to successfully author links for courses in the LMS. Below are instructions on how to access and request a key and secret. Click or paste the link into your browser to access the Consumer Key and Secret Request form. The following fields are listed in the form and must be completed: Field Name LMS Type School First Name Last Name Phone Job Title CAPTCHA Description This drop down box displays a list of multiple LMS, Please choose which LMS your institution is using (example: Blackboard, Moodle, Canvas, etc.). This is a required field and must be filled in by a LMS Administrator. Enter your institution name in this field (example: Manhattan College). This is a free form text box with no character limits. This is a required field and must be filled in by a LMS Administrator. Please enter your school address. An auto-generated will be sent to this address when the key and secret is created. Enter your first name in this field. Enter your last name in this field. Enter your phone number in this field. We recommend you also enter your job title. This will help the BNC Administrator know whom they are working with for communication purposes. CAPTCHA requires that the user type the letters and/or numbers of an image. This step is required and must be successfully completed before the key and secret form can be submitted for processing /22/2015

4 Once the Key and Secret request has successfully been submitted, the system will direct you to a success page. Also, you will receive a confirmation from the Barnes & Noble College LMS support team with steps on how to test the connectivity and further instructions to setup the LTI integration. 2.0 Testing Link Connectivity with BNC Once you receive the confirmation with instructions explaining how to test the link, the testing process can begin. This test can be done prior to the key and secret being officially generated. Moodle requires a key and secret to be entered to perform the connectivity test. You can enter the text TEST in the both the Key and Secret field. The following procedure includes the steps to test connectivity. 1. Log into your Moodle LMS with your username and password. Users will need to have LTI link authoring privileges. 2. Navigate to any active available course. Make sure the course is an actual course or if using a test course, make sure it is formatted like an actual course. Launch requests should come from a course that has been properly set up using the established processes the school has implemented. 3. Select a valid course /22/2015

5 4. Ensure that Editing has been turned on. Click on the Turn editing on button. 5. Click in the Add an activity box. Select External Tool /22/2015

6 6. You will be taken to the Adding a new External Tool page. Ensure that you click the Show more option. 7. Enter the following fields on the Adding a new External Tool page: Activity Name: BNC Test Connectivity Launch URL: Secure Launch URL: Launch Container: Ensure that this displays New Window Consumer Key: Enter in TEST Consumer Secret: Enter in TEST - 6-9/22/2015

7 8. Once all the data has been entered, click on the Save and display button 9. A new screen for LTI Parameters will populate. 10. The LMS Administrator will need to click on the link, Send LTI Parameters to Barnes & Noble College. 11. The LMS Administrator will populate their address, school name and any message they want to BNC administrator to see. When ready to send to the BNC administrator, they must click on the Submit button /22/2015

8 Schools that have multi-section/cross-listed courses need to send multiple connectivity tests. One connectivity test should be sent for each type of course (individual, multisection, cross listed, multi-section/cross listed) /22/2015

9 This will send a request to Barnes & Noble College and help us ensure no connectivity issues exist between Barnes & Noble College and the school LMS server. The LMS Administrator will receive a success message letting them know it was submitted successfully /22/2015

10 Upon receiving your success message, with your school terms codes. For example: SP15 = Spring 2015 Once the information is received, we will process your request and send you a Key and Secret via , which you can use to install our LTI integration. If you have trouble submitting your connectivity test, please send a screenshot to ltisupport@bncollege.com. 4.0 Link Authoring with a Course This section details the step-by-step process to link authoring within a specific course. The LMS administrator or a Faculty member will create two links within the course. Purchase Course Materials will facilitate students to seamlessly connect to their College bookstore website and purchase course materials assigned for the class /22/2015

11 Research and Adopt Course Materials will enable faculty to connect with the online adoption website FacultyEnlight where they can research and adopt course materials + submit their request directly to bookstore. Purchase Course Materials Step Screen 1. Sign in to Moodle with your username and password. Users need to have LTI link authoring privileges. 2. Navigate and click on the desired available course. 3. Under the Administration section, click the Turn editing on button. 4. Once editing has been enabled, click on + Add an Activity or resource /22/2015

12 Step Screen 5. An Add an activity or resource box will display. Click on the External Tool icon radio button and click Add /22/2015

13 6. You will now be on the Adding a new External Tool page. Click the +Show more... link. Enter the following fields: Activity Name: Research and Adopt Course Materials Launch URL: Secure Launch URL: Launch Container: Ensure New window is selected Consumer Key: Enter in the system generated Key that was sent to you in an from Barnes & Noble. Shared Secret: Enter in the system generated Secret that was sent to you in an from Barnes & Noble. 7. When all data has been entered, the user can either click on the Save and return to course button or Save and display button. Save and return to course - behavior will result in user being navigated back to the course view. Save and display - behavior will result in user being linked to launch URL /22/2015

14 - 14-9/22/2015

15 Research and Adopt Course Materials 1. Sign in to Moodle with your username and password. Users need to have LTI link authoring privileges. 2. Navigate and click on the desired available course. 3. Under the Administration section, click the Turn editing on button. 4. Once editing has been enabled, click on + Add an Activity or resource /22/2015

16 5. An Add an activity or resource box will display. Click on the External Tool icon radio button and click Add /22/2015

17 6. You will now be on the Adding a new External Tool page. Click the +Show more... link. 7. Enter the following fields: Activity Name: Research and Adopt Course Materials Launch URL: Secure Launch URL: Launch Container: Ensure New window is selected Consumer Key: Enter in the system generated Key that was sent to you in an from Barnes & Noble. Shared Secret: Enter in the system generated Secret that was sent to you in an from Barnes & Noble. 8. When all data has been entered, the user can either click on the Save and return to course button or Save and display button. Save and return to course - behavior will result in user being navigated back to the course view. Save and display - behavior will result in user being linked to launch URL /22/2015

18 5.0 System Level External Tool Configurations Please log into your Moodle LMS with your username and password. User will need to have LTI link authoring privileges. In this section, the LMS Administrator will create two external tools to facilitate link authoring at the global level. Setup Purchase Course Materials and Research and Adopt Course Materials Global Links 1. Select Site Administration /22/2015

19 2. Select Plugins. 3. Select Activity Modules /22/2015

20 4. Select LTI. 5. You will be taken into the LTI External Tool Types page. On the Active tab, click Add external tool configuration /22/2015

21 7. From here, you will need to author one global link for Purchase Course Materials and another global link for Research and Adopt Course Materials. You will need to author one link at a time. Once you author a link and click Save, go back in via the same steps and author the other link /22/2015

22 7. Enter the following information for Purchase Course Materials and Research and Adopt Course Materials. Purchase Course Materials: Tool Name: Purchase Course Materials Tool Base URL: Consumer Key: Enter in the system generated Key that was sent to you in an from Barnes & Noble. Shared Secret: Enter in the system generated Secret that was sent to you in an from Barnes & Noble. Custom Parameters: Click add custom parameter, fill in: system_level=true Default Launch Container: New Window Research and Adopt Course Materials: Tool Name: Research and Adopt Course Materials Tool Base URL: Consumer Key: Enter in the system generated Key that was sent to you in an from Barnes & Noble. Shared Secret: Enter in the system generated Secret that was sent to you in an from Barnes & Noble. Custom Parameters: Click add custom parameter, fill in: system_level=true Default Launch Container: New Window Once you author a link in a course, the global configuration gets picked up if the launch URL you author in the link matches the base URL value in the global configuration /22/2015

23 6.0 Authoring a URL Resource for Yuzu This section details the step-by-step process to author a URL resource for Yuzu within a specific course. The LMS administrator or a Faculty member will create two URLs within the course. Access Digital Course Material will help students organize, read and annotate their reading right in the palm of their hand. Learn About Digital Options will enable faculty to connect with Yuzu, which is an online ecosystem that enables the collaborative, free flow of information between learners and educators, making it easier than ever to teach, learn, discover and digest. Creating a URL Access Digital Course Material 1. Click into the course that you need to link author. Make sure your editing is turned on. 2. Click on the Add a resource box and select URL. The system will refresh and you will be taken to the Adding a new URL page. 1. In the Name field enter Access Digital Course Material. 2. In the Description field, enter the following text: Access Digital Course Material will help students organize, read and annotate their reading right in the palm of their hand. 3. In the External URL field, enter the following URL: /22/2015

24 4. Under the Appearance section, there is a Display drop down menu. Select in pop up /22/2015

25 5. When all data has been entered, the user can either click on the Save and return to course button or Save and display button. Save and return to course - user is navigated back to the course view. Save and display - user is linked to launch URL. 6. If you click Save and Display, the Access Digital Course Materials page displays and the description is visible. To launch the URL, the user must click the link labeled, Click link to open resource. They will then be taken to the Yuzu page /22/2015

26 Creating a URL Learn About Digital Options 1. Click into the course that you need to link author. Make sure your editing is turned on. 2. Click on the Add a resource box. Select URL. 3. The system will refresh and you will be taken to an Adding a new URL page. In the Name field enter in Learn About Digital Options. In the Description field, you will enter the following text: Learn About Digital Options will enable faculty to connect with Yuzu, which is an online ecosystem that enables the collaborative, free flow of information between learners and educators, making it easier than ever to teach, learn, discover and digest. 4. In the External URL field, you will enter in the following URL: /22/2015

27 5. Under the Appearance section, there will be a Display box. Ensure the In pop up is selected /22/2015

28 6. When all data has been entered, the user can either click on the Save and return to course button or Save and display button. 7. Save and return to course - behavior will result in user being navigated back to the course view. 8. Save and display - behavior will result in user being linked to launch URL. a. If you click on Save and Display, the user will be taken to the Learn About Digital Options page and users can read the description. To launch the URL, they will click on the link at the bottom where it says, Click link to open resource. They will then be taken to the Yuzu page /22/2015

29 7.0 Important Notes and Troubleshooting This section contains troubleshooting help for common issues. How can a user find their LMS User ID? When a user successfully authenticates in Moodle, they will see a status text that reads, "You are logged in as {username here} (Log out)". If a user clicks on their user name URL, they will be taken to their Public Profile. At the end of the browser URL, the user will see their LMS User ID. How can a user identify a specific LMS course ID? A user should click into a course. They will see a number at the end of the URL in their search browser. This is the particular LMS Course ID /22/2015

30 I m getting an error when I try to launch out with the LTI link. When doing a copy and paste of the launch URLs, key or secret from the s, sometimes white spaces get picked up in the copy and paste feature. If this happens, a user could receive a 403 error screen or a message that the key and secret must be provided. The best way to resolve this is to take the launch URL, key and secret and paste it into a text pad. This will eliminate any whitespaces. A user can then take the data from the text pad and copy back into LMS /22/2015

31 I am not able to successfully launch out of the LTI link I authored. There are several ways to troubleshoot this common issue: 1. Is the Activity that he set up an "External Activity"? It should be, so ensure that option is selected. 2. Ensure these URLS are listed in both the Launch URL and the Secure Launch URL for Purchase Course Materials and Research and Adopt Course Materials (ensure there are no whitespaces): Ensure the key and secret that was pasted in the Consumer Key field has no white spaces. Sometimes when a copy and paste is done, whitespaces are picked up. 4. Ensure the URL is launching to a new window /22/2015