LTI Tool Admin Guide Sakai

Transcription

1 LTI Tool - 1 -

2 Contents Introduction... 3 About the Bookstore Website... 3 About FacultyEnlight... 3 About Yuzu... 3 Getting Started - Requesting Credentials from Barnes & Noble College... 4 Testing Link Connectivity with Barnes & Noble College... 5 System-Level External Tool Setup... 7 Setup for Purchase Course Materials Link... 7 Optional Setup for Research and Adopt Course Materials Link... 8 Adding the Links to Your Template Adding the Bookstore LTI Links Adding Access Digital Course Materials Link Testing the Links Access Digital Course Materials Going Live Important Notes and Troubleshooting Error Messages Pop Ups Blocked Other Issues or Concerns Contact Us

3 Introduction This document illustrates how to integrate Barnes & Noble College links within the Sakai learning management system. It is intended for the Sakai administrator or instructional designer who will configure the LTI tools. This LMS integration simplifies the purchase process for students, showing them the required and recommended materials for their course. Once setup is complete, a link called Purchase Course Materials will be available in all courses for students. This will take students to the bookstore website, where they can view all available formats and pricing, and purchase the course materials specific to their course and section. Students will need to log in or create a bookstore website account only on their first time crossing over, and will then have their bookstore account paired with their Sakai ID, so that they don t need to log in again when using these links in the future. A separate link is also available that streamlines the textbook adoption process for faculty, allowing them to more easily select the course materials for their courses. Through this link, called Research and Adopt Course Materials, faculty are able to pair their Sakai ID to their FacultyEnlight account, so they won t need to log in to FacultyEnlight accessing the site from Sakai. The faculty s course information will be automatically populated in FacultyEnlight, saving them this step in the process when submitting their course material selections to the bookstore. About the Bookstore Website The official bookstore website is the online presence for your campus bookstore. Students can find all their required and recommended course materials for their courses, and are shown available formats with pricing, such as used, rental, and digital. Additional materials such as school supplies, apparel, and accessories are also available. A variety of payment options, including financial aid and campus debit, are accepted at checkout. About FacultyEnlight FacultyEnlight ( is a digital platform for faculty and staff that enables them to research and adopt course materials in one, convenient place. Faculty can compare estimated pricing and identify format availability before selecting the materials they want to use in their courses. Once they select their materials, the information is automatically submitted to the bookstore for processing and inventory preparation, and the materials become available on the bookstore website. About Yuzu Yuzu ( is a learning platform, powered by VitalSource, which delivers an enhanced digital reading experience with access to a broad digital catalog. Digital Learning Material includes etextbooks, which are digital versions of printed textbooks that students can access on their laptops, desktops, or mobile devices (Android and ios)

4 Getting Started - Requesting Credentials from Barnes & Noble College The LMS Administrator will need to request a key and secret in order to successfully author links for courses in the LMS. Following are instructions on how to access and request a consumer key and shared secret: Navigate to the following URL: Complete the form, taking note of the required fields: Field Name LMS Type School First Name Last Name Phone Job Title CAPTCHA Description Please select the LMS used at your institution (e.g. Sakai). Enter your institution s name in this field (e.g. University of Delaware). This is a free form text box with no character limits. Please enter your institutional address. An auto-generated will be sent to this address when the consumer key and shared secret are created. Enter your first name in this field. Enter your last name in this field. Enter your phone number in this field. We recommend that you also enter your job title. This will help Barnes & Noble College know this request is legitimate. To prevent spam submissions, CAPTCHA requires a user to check the box. This step must be completed before the credential request can be submitted for processing. If your institution employs multiple learning management systems, a separate key request will need to be submitted for each. Once all the required fields including CAPTCHA are successfully filled, click the Submit button to submit the key and secret request. After the credential request has been successfully submitted, the system will direct you to a success page. You will also receive a confirmation from the Barnes & Noble College LTI support team with steps to test the connectivity (also seen in the next step) and further instructions to set up the LTI integration. Your consumer key and shared secret will be generated and sent to your provided address, after you have provided Barnes & Noble College with all of the information requested in the following step

5 Testing Link Connectivity with Barnes & Noble College By testing the link connectivity, you are providing Barnes & Noble College with the parameters used within your Sakai instance. Knowing the Course ID or Course Registration Number format used by your campus will help us devise an algorithm to link students to the correct course materials and instructors to their correct courses. Following are the steps to test connectivity: 1. Log in to Sakai with your administrator username and password. Users will need to have LTI link authoring privileges. 2. Select Worksite Setup in the left-hand navigation. 3. Select an available course where you can install this external tool and run the test. A course from your current term is ideal, as it will contain the most up-to-date parameters. If you test in staging, please choose a course with a production naming scheme. See the Appendix for details. Please note: a test conducted from a sandbox will not provide the necessary course information. 4. Click the Site Info link in the left-hand navigation. 5. Click the Edit Tools button (Manage Tools in Sakai 11) located in the horizontal menu of the Site Info page. 6. On the resulting page titled Course Site Tools, select External Tool. 7. Scroll down, and click Continue. 8. On the Customize tool instances page, replace the title in the text box with BN Connectivity Test, and click Continue. 9. On the confirmation page, click Finish. 10. Your entry is submitted, and you will be returned to the Site Info page. 11. From there, click on the BN Connectivity Test link in the left-hand navigation menu. 12. The page will read, This tool has not yet been configured. Click on the pencil icon to the right of this message to configure to author the link

6 13. Enter the following in the fields: Remote Tool Url: Remote Tool Key: enter Test Remote Tool Secret: enter Test Set Button Text: leave blank Set Tool Title: leave blank Choose an icon for this tool: leave blank Open in a New Window: checked Maximize Window Width: unchecked iframe Height: leave blank Debug Launch: unchecked Send Names to the External Tool: unchecked Send Addresses to the External Tool: unchecked Allow the External Tool to retrieve the course roster: unchecked Allow the External Tool to store and retrieve its settings: unchecked Splash Screen: leave blank Custom Launch Parameters: leave blank 14. Click Update Options to save the tool settings. 15. You will be taken to the LTI Parameters page. 16. On this page, click Send LTI Parameters to Barnes & Noble College. 17. Fill in the required information, then click Submit. a. A message will appear indicating the successful submission of your test. 18. Please repeat the test for courses of different formats, e.g. multi-section or cross-listed courses. 19. Once testing is complete, please a listing of term codes for the academic year (e.g = Summer 2019, etc.) to ltisupport@bncollege.com. 20. We recommend that you remove the BNC Connectivity Test external tool from your courses once you have submitted the results to Barnes & Noble College. If you have trouble submitting your connectivity test, send a screenshot to ltisupport@bncollege.com

7 System-Level External Tool Setup This section provides steps for the Sakai administrator to create two external tools that will enable the following LTI links globally in Sakai: Purchase Course Materials o This LTI link will direct students to their course materials on the official bookstore website. Research and Adopt Course Materials (Optional) o This LTI link will direct faculty members to FacultyEnlight to place a textbook adoption for their course, or to research textbooks and digital materials. These steps are to be executed after the connectivity test is complete and the consumer key and shared secret have been issued by Barnes & Noble College. We suggest setting up these links in a staging environment for testing before implementing in your production environment. Setup for Purchase Course Materials Link 1. Log in to Sakai with your administrator username and password. 2. From My Workspace, click Worksite Setup and select the Administration Workspace worksite. 3. Click the External Tools link in the left-hand navigation. 4. In the External Tools menu, click the Tools Available in System button. 5. Click on the link for Add LTI 1.1 Tool located toward the top-right corner of the page

8 6. Enter the following in the fields: Site Id: leave blank Tool Title: Purchase Course Materials Allow tool title to be changed: Do not allow Button Text: Purchase Course Materials Allow button text to be changed: Do not allow Description leave blank Tool Status: Enabled Tool Visibility: Visible Launch URL: Allow launch URL to be changed: Do not allow Launch Key: Enter the consumer key provided to you via . Allow launch key to be changed: Do not allow Launch Secret: Enter the shared secret provided to you via . Allow launch secret to be changed: Do not allow Frame Height: leave blank Allow frame height to be changed: Do not allow Privacy Settings: leave all unchecked Services: leave all unchecked Launch in Popup: Always launch in Popup Debug Launch: Never launch in debug mode Custom Parameters: leave blank Allow additional custom parameters: unchecked Splash screen: leave blank 7. Click Save. 8. The Purchase Course Materials external tool will now be available for administrators or faculty to add within courses. Optional Setup for Research and Adopt Course Materials Link The steps to set up the Research and Adopt Course Materials link are very similar to the above steps for the Purchase Course Materials setup. 1. Log in to Sakai with your administrator username and password. 2. From My Workspace, click Worksite Setup and select the Administration Workspace worksite. 3. Click the External Tools link in the left-hand navigation. 4. In the External Tools menu, click the Tools Available in System (or Installed Tools) button. 5. Click on the link for Add LTI 1.1 Tool located toward the top-right corner of the page

9 6. Enter the following in the fields: Site Id: leave blank Tool Title: Purchase Course Materials Allow tool title to be changed: Do not allow Button Text: Purchase Course Materials Allow button text to be changed: Do not allow Description leave blank Tool Status: Enabled Tool Visibility: Visible Launch URL: Allow launch URL to be changed: Do not allow Launch Key: Enter the consumer key provided to you via . Allow launch key to be changed: Do not allow Launch Secret: Enter the shared secret provided to you via . Allow launch secret to be changed: Do not allow Frame Height: leave blank Allow frame height to be changed: Do not allow Privacy Settings: leave all unchecked Services: leave all unchecked Launch in Popup: Always launch in Popup Debug Launch: Never launch in debug mode Custom Parameters: leave blank Allow additional custom parameters: unchecked Splash screen: leave blank 7. Click Save. 8. The Research and Adopt Course Materials external tool will now be available for administrators or faculty to add within courses

10 Adding the Links to Your Template Once you have completed the System-Level External Setup, add the link to your course template for inclusion in Sakai courses at your institution. Adding the Bookstore LTI Links 1. Log in to Sakai with your administrator credentials. 2. Navigate to your course template. 3. Click on Site Info from the navigation bar. 4. Click on the Manage Tools tab. 5. Under the Course Site Tools list, find Plugin Tools and click on it to expand the selection. 6. Check the boxes for Purchase Course Materials and Research and Adopt Course Materials. You can also check the box for Research and Adopt Course Materials in this same process. However, this link is meant for instructors only. 7. Click Continue. 8. On the next page, for Purchase Course Materials, click the drop-down option under Choose a custom icon. 9. Search book to locate the book icon, and select it. 10. For Research and Adopt Course Materials, click the drop-down option under Choose a custom icon. 11. Search binoculars to locate the icon, and select it. 12. Click Continue. 13. In the confirmation menu, click Finish. 14. The bookstore links will be present in the template of your course menu. 15. To hide the Research and Adopt Course Materials link from students, find and select the Tool Order tab in your Site Info menu. 16. Click the gear icon next to Research and Adopt Course Materials. 17. Choose the option to Make Tools Invisible to Students. 18. Click Save

11 Adding Access Digital Course Materials Link This section provides steps to author a URL resource for Yuzu. We do not currently provide an LTI integration for Yuzu. 1. Navigate to your course template. 2. Click on Site Info from the navigation bar. 3. Click on the Manage Tools tab. 4. Under the General tools, check the box for Web Content. 5. Click Continue. 6. On the next page, enter the following information: Name: Access Digital Course Materials Source: 7. Click Continue. 8. Click Finish. 9. Click on the Access Digital Course Materials link in your course menu. 10. Click the pencil icon at the top-right corner of the frame. 11. On the Customize Web Content menu, check the box for Open in new window. 12. Click Update Options

12 Testing the Links After placing the links, we recommend testing them before pushing them campus-wide. When testing, be sure to use a course from a current or upcoming term. Using a course from a past term will not test successfully, as the term may no longer be available on the bookstore or FacultyEnlight websites. Research and Adopt Course Materials 1. Log into Sakai with faculty credentials. 2. Select a course that has the LTI link enabled from your Sites menu. 3. Click Research and Adopt Course Materials. a. You will be redirected to FacultyEnlight in a new tab or window. b. The pop-up may be blocked on the first attempt. Enable the pop-up from your browser. 4. On the first cross-over, you will be prompted to log into FacultyEnlight. a. If you have existing credentials, please enter them and click Sign In. b. Otherwise, please click Create Account, fill out the required information, and click Submit. 5. You will be signed in, and your Sakai account will be paired with FacultyEnlight. a. You will not have to log in again when using the Research and Adopt Course Materials link in the future, whether from the same course or a different one. 6. In FacultyEnlight, you are taken to a page with your course information (term, department, course, and section) already pre-selected for you based on course. Step 1 of the adoption process is completed. a. You may consider the test successful at this point. 7. To further verify the account pairing: a. Click Welcome (Your Name) at the top of the page, and b. Click on the Account Preferences tab. LMS Account information will appear in your preferences. 8. As an instructor, you may proceed with the adoption, or feel free to access any other feature of the site. If you continue the adoption, do not submit an adoption through the site while testing, as the adoption information is automatically sent to the bookstore for processing. Please clear your adoption from your Book Bag before exiting the site so it does not cause any issues for faculty. To do this, go to the Book Bag in the upper right-hand corner and select Remove on all materials

13 Purchase Course Materials 1. Log into Sakai with student credentials. 2. Select a course that has the LTI link enabled from your Sites menu. 3. In the section where the link is placed, click Purchase Course Materials. a. You will be redirected to your campus bookstore website in a new tab or window. b. The pop-up may be blocked on the first attempt. Enable the pop-up from your browser. 4. On the first cross-over, you will be prompted to log into your campus bookstore website. a. Please click Create Account, fill out the required information, and click Create Account. 5. You will be signed in, and your Sakai account will be paired with the bookstore website. a. You will not have to log in again when using the Purchase Course Materials link in the future, whether from the same course or a different one. 6. On the bookstore website, you are provided with the course materials for the course you selected in Sakai. Text materials will appear in all of the available formats (new, used, rental, and/or digital). a. Once you reach this point, the test is successful. 7. To further verify the account pairing: a. Hover over Hello, [Your Name] at the top of the page. b. Click My Account. c. Scroll down to LMS Account. If you are linked, you will have the option to unlink your account. Access Digital Course Materials 1. Log into Sakai with any credentials. 2. Select a course that has the link enabled from your Sites menu. 3. On the left-hand navigation bar, click the link for Access Digital Course Materials. 4. Yuzu will open in a new tab or window. a. At this point, the test is successful

14 Going Live When you have completed the setup of the Barnes & Noble College LTI links in your production environment, please let us know by reaching out to This way, we will know to follow up with the bookstore manager in order to help him or her inform faculty of the presence of these links in Sakai. Upon going live, we provide the store manager with an template that may be used to communicate the availability of the bookstore links in Sakai. We can also provide how-to documentation for the faculty and student links. Important Notes and Troubleshooting Error Messages An error message may appear when the tool link is accessed. The most common errors include: 400 Bad Request 403 Forbidden 404 Page Not Found 406 Cookie Error 500 Internal Server Error The message that appears will provide more detail as to the nature of the error, and actions to take to resolve it. Pop Ups Blocked If the LTI link fails to launch, the pop-out window may be blocked. Please allow pop-ups from your Sakai site, and then attempt the link again. Other Issues or Concerns Contact Us For help with other concerns relating to the LMS integration in Sakai, please contact us by Address