Barnes & Noble College LTI Tool Admin Guide Sakai

Transcription

1 Last Updated September /22/2015

2 Table of Contents Contents 1.0 Introduction Key and Secret Request Form Link and Instructions Testing Link Connectivity with BNC Site level External Tool Configuration Global level External Tool Configuration Authoring a URL Resource for Yuzu Creating a URL Access Digital Course Material Creating a URL Learn About Digital Options* (optional) Important Notes and Troubleshooting I m getting an error when I try to launch out with the LTI link How do I make edits to External LTI link names once they are already set up? How do I Set Role Logic at the Course Level so I can manage who sees what links? 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 about how to integrate links within the Sakai Learning Management System. References and screenshots to options in this user guide may differ in location based on the version of Sakai 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 all the required fields including CAPTCHA are successfully filled out, click the Submit button to process the key and secret request. 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 /22/2015

5 3.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. The following procedure includes the steps to test connectivity. Steps 1. Log into your Sakai LMS with your username and password. Users will need to have LTI link authoring privileges. 2. Click Worksite Setup in the left navigation. 3. Click on the course URL for which you want to set up a BNC Text Connectivity External Link. 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. To properly test the integration post-onboarding process, you will need to use a real course to ensure the cross-over to FacultyEnlight and the bookstore works properly. 4. Select a course /22/2015

6 5. Click on Site Info link located in the left side navigation. 6. Click the Edit Tools button. 7. Click on the External Tools check box (which is not selected). 8. Scroll down and click Continue /22/2015

7 9. In the Title field, replace the current title of External Tool with BNC Connectivity Test. 10. Click Continue. 11. Click Finish /22/2015

8 The screen will refresh and take you back to the Site Info page. 12. From the Site Info page, click on the BNC Connectivity Test option in the left hand navigation. You will now be on the IMS Learning Tool Interoperability page. 13. In the top right corner, click on the pencil and paper icon to author your BNC Connectivity link /22/2015

9 14. Enter the following information: Remote Tool URL: Remote Tool Key: Test Remote Tool Secret: Test Ensure Open in a New Window is selected. Click on the update options Button /22/2015

10 15. You will then be launched out to the LTI Parameters page. 16. Click on the link labeled Send LTI Parameters to Barnes & Noble College /22/2015

11 17. The LMS Administrator will populate their address, school name and any message they want to BNC administrator to see. 18. When ready to send to the BNC administrator, they should click on the Submit button. If you have trouble submitting your connectivity test, please send a screenshot to ltisupport@bncollege.com. 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.) 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. 19. Upon receiving your success message, ltisupport@bncollege.com with your school terms codes. For example: SP15 = Spring /22/2015

12 Once the information is received we will process your request and send you a Key and Secret, which you can use to install our LTI integration /22/2015

13 4.0 Site level External Tool Configuration Steps Log into your Sakai 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 course/ site level. Purchase Course Materials Research and Adopt Course Materials 1. Click Worksite Setup in the left navigation. 2. Click on the course URL you want to set up /22/2015

14 3. Click on Site Info link located on the left hand navigation. 4. Click the Edit Tools button /22/2015

15 5. Click on the External Tools check box. 6. Scroll down and click Continue /22/2015

16 7. Click on the More External Tools drop-down list to add one more tool /22/2015

17 8. Enter the following information to create two tool instances: Title: Purchase Course Materials Title: Research and Adopt Course Materials 9. Click the Continue button. 10. Click Finish to finalize changes /22/2015

18 The screen will refresh and take you back to the Site Info page. 11. Click the Purchase Course Materials link located in the left navigation. 12. You will now be on the IMS Learning Tool Interoperability page. 13. In the top right corner, click on the pencil and paper icon to author your Purchase Course Materials link /22/2015

19 14. Enter the following information: o Remote Tool URL: o Remote Tool Key: enter the Key received in the o Remote Tool Secret: enter the Secret received in the o Ensure the Open in a New Window checkbox is selected 15. Scroll down and click the Update Options button. The screen will refresh and take you back to the Site Info page. 16. Click on the Purchase Course Materials link in the left navigation. You will be redirected to the Bookstore Website /22/2015

20 You are now ready to author the link for Research and Adopt Course Materials. 17. Click on the Research and Adopt Course Materials link on the left hand navigation. You will now be on the IMS Learning Tool Interoperability page. 18. In the top right corner, click on the pencil and paper icon to author your Research and Adopt Course Materials link. 19. Enter in the following information: Remote Tool URL: Remote Tool Key: enter the Key received in the Remote Tool Secret: enter the Secret received in the /22/2015

21 Ensure the Open in a New Window is selected Scroll down and click the Update Options button The screen will refresh and take you back to the Site Info page. 20. Click on the Research and Adopt Course Materials option in the left navigation. You will be redirected to the FacultyEnlight website. You are finished setting up the links at the course/ site level for both Bookstore and FacultyEnlight /22/2015

22 5.0 Global level External Tool Configuration Please log into your Sakai 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. Purchase Course Materials Research and Adopt Course Materials Steps 1. Click the Administration Workspace button in the top navigation. 2. Click External Tools located in the left navigation /22/2015

23 2. Click the Tools Available in System button. 3. Click on the link Add LTI 1.1 Tool located on the top right side of the screen. 4. Enter the following information Tool Title: Purchase Course Materials Button Text: Purchase Course Materials Launch URL: Launch Key: enter the Key received in the Launch Secret: enter the Secret received in the 5. Click the Save button after you have entered all the required information /22/2015

24 - 24-9/22/2015

25 In the next step you will create an external tool for Research and Adopt Course Materials. 6. Click the Administration Workspace button located on the top navigation. 7. Click on External Tools in the left navigation. 8. Click the Tools Available in System button. 9. Click on the link Add LTI 1.1 Tool located on the top right side of the screen /22/2015

26 10. Enter the following information: Tool Title: Research and Adopt Course Materials Button Text: Research and Adopt Course Materials Launch URL: Launch Key: enter the Key received in the Launch Secret: enter the Secret received in the Under Custom Launch Parameters: enter system_level=true 11. Click the Save button once you have entered all the required information /22/2015

27 - 27-9/22/2015

28 12. After you click Save, the system will bring you to a new screen where a list of all the added external tools is displayed. 13. In order to launch the tool you must create the tool configuration within a course site. 14. Click on Worksite Setup in the left navigation. Select the course URL where you want to set up the links. 15. Click on the Site Info link located on the left navigation. 16. Click on the External Tools button located on the top navigation /22/2015

29 17. Next click on Add Available Tool to Site. 18. A drop-down list of all the available tools will be displayed /22/2015

30 19. Click the Purchase Course Materials link and check the Add Site Link box. 20. Click the Save button. 21. The course site will refresh and Purchase Course Materials link will be added to the left navigation. 22. Repeat steps from 17 to 19 in order to add a link for Research and Adopt Course Materials to the left navigation. Once finished, the course navigation will display the links for both Bookstore and FacultyEnlight website. 23. You now can start using the links to research and adopt course materials at FacultyEnlight or purchases course materials via the bookstore website /22/2015

31 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. *Optional Creating a URL Access Digital Course Material 1. Click into a course. 2. In the left navigation, click Site Info. 3. Click Edit Tools. Steps /22/2015

32 4. Scroll to the bottom and select Web Content from the list of tools /22/2015

33 5. Click Continue. You will be taken to the Customize Tool Instance page. Enter in Access Digital Course Materials and enter in the following URL: 6. Click the Continue button. 7. Click Finish /22/2015

34 You will now see Access Digital Course Materials added to the Left Navigation list. Users can now click on the link in the left hand navigation and launch the URL. Once you have added it there you can go into edit mode by clicking on the pencil on the right hand corner. You can change the frame height and specify if it should be opened in new window /22/2015

35 Creating a URL Learn About Digital Options* (optional) 1. Click into a course. 2. In the left navigation, click Site Info. 3. Click on Edit Tools. Steps 4. Scroll to the bottom and select Web Content from the list of tools. 5. Click Continue. You will be taken to the Customize Tool Instance page. Enter in Learn About /22/2015

36 Steps Digital Options and enter in the following URL: 6. Click the Continue button. 7. Click Finish. 8. You will now see Learn About Digital Options added to the Left Navigation list /22/2015

37 Steps Users can now click on the link in the left navigation and launch the URL. Once you have added it there you can go into edit mode by clicking on the pencil on the right corner. You can change the frame height and specify if it should be opened in a new window. 7.0 Important Notes and Troubleshooting This section contains troubleshooting help for common issues. 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 it back into LMS /22/2015

38 How do I make edits to External LTI link names once they are already set up? While in a course on the IMS Learning Tool Interoperability page: Step 1. Click on the Administration Workspace drop-down box. 2. Click on Sites in the left navigation. 3. Click into the site ID for your course. 4. Scroll down and click on Add/Edit pages. 5. Click on the External Tool Page ID that needs to be edited. 6. In the Title field, edit your name. 7. Click on the Save button. 8. Do this for all External Tool Names that need to be edited. How do I Set Role Logic at the Course Level so I can manage who sees what links? Step 1. Click on the Site Info link in the left navigation menu of the course. 2. Click the Page Order button from the Site Info view. 3. Click the Light bulb icon to turn off the left navigation link(s) that should be hidden from student view. 4. Click Save. The Instructor Only links will be grayed out /22/2015

39 I am not able to successfully launch out of the LTI link I authored. The following table describes several ways to troubleshoot this common issue. Step 1. Ensure that the following URLS are listed in the 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. 3. Ensure the URL launches a new window /22/2015