LTI Tool Admin Guide Canvas

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 Configuration... 6 Setup for Purchase Course Materials Link... 6 Setup for Research and Adopt Course Materials Link... 7 Authoring a URL Resource for Yuzu... 8 System-Level Setup of Access Digital Course Materials Link... 8 Optional System-Level Setup of Learn About Digital Options Link... 9 Testing the Links Research and Adopt Course Materials Purchase Course Materials Access Digital Course Materials Going Live Important Notes and Troubleshooting Link Doesn t Launch Error An Error Has Occurred Other Issues or Concerns Contact Us Appendix Connectivity Test Addendum Test Requirements Multi-Section and Cross-Listed Courses Term Descriptions

3 Introduction The purpose of this document is to provide details on how to integrate Barnes & Noble College links within the Canvas learning management system. This guide is intended for the Canvas administrator or instructional designer who will configure the LTI tools. This LMS integration streamlines the textbook adoption process for faculty, allowing them to select the course materials for their courses more easily. It also simplifies the purchase process for students, showing them the required and recommended materials for their course. Once setup is complete, a link will be available in all courses for students to Purchase Course Materials. 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 Canvas ID, so that they don t need to log in again when using these links in the future. Additionally a separate link for faculty only will allow faculty to access FacultyEnlight and pair their Canvas ID to their FacultyEnlight account, so that they won t need to log in to FacultyEnlight accessing the site from Canvas. 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. Canvas). If your institution. Enter your institution s name in this field (e.g. Rutgers University New Brunswick). 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. For security, CAPTCHA requires a user to type the letters and/or numbers contained within an image. 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 Canvas 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 into Canvas with your administrator username and password. Users will need to have app creation and configuration privileges. 2. Navigate to and select an available course. A course from your current term is preferable, as it will contain the most up-to-date parameters. If you test in staging, please employ 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. 3. Click Settings from the left-hand navigation. 4. Click the Apps tab. 5. Click the View App Configurations button. 6. Click the + App button to add the Connectivity Test. 7. The Add App dialog will appear in Canvas. Enter the following in the fields: Configuration Type: Select Paste XML from the drop-down menu. Name: BNC Connectivity Test Consumer Key: TEST Shared Secret: TEST XML Configuration: Download the XML here ( ). Copy it, and paste into this field. 8. Click Submit once the XML is pasted. 9. Return to the course Home page or refresh your browser to see the BNC Connectivity Test link in the left-hand navigation. 10. Click on BNC Connectivity Test. 11. You will be taken to the LTI Parameters page. a. If prompted, click Load BNC Connectivity Test to proceed. 12. On this page, click Send LTI Parameters to Barnes & Noble College. 13. Fill in the required information, then click Submit. a. A message will appear indicating the successful submission of your test. 14. Please repeat the test for courses of different formats, e.g. multi-section or cross-listed courses. 15. Once testing is complete, please a listing of term codes for the academic year (e.g = Fall 2017, etc.) to ltisupport@bncollege.com. If you have trouble submitting your connectivity test, send a screenshot to ltisupport@bncollege.com

6 System-Level External Tool Configuration In this section, the Canvas administrator will create two external tools that will enable the following LTI links globally, so that these links will automatically appear in all courses without requiring any action on the part of the faculty: Purchase Course Materials o This LTI link will direct students to their course materials on the official bookstore website. Research and Adopt Course Materials 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. Student users will not see this link. 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. In Canvas, click on the Admin tab. This tab is represented by a shield containing a star. 2. Select your institution s account from the list that appears. a. If your institution has multiple accounts, select the account or sub-account that is applicable to your specific college, university, or campus. 3. Click Settings from the left-hand navigation. 4. Click the Apps tab. 5. Click the View App Configurations button. 6. Click the + App button to add Purchase Course Materials. 7. The Add App dialog will appear. Enter the following in the fields: Configuration Type: Select Paste XML from the drop-down menu. Name: Purchase Course Materials Consumer Key: Enter the consumer key provided to you via . Shared Secret: Enter the shared secret provided to you via . XML Configuration: Download the XML here ( ). Copy it, and paste into this field. 8. Click Submit once the XML is pasted. 9. Purchase Course Materials will now appear among your External Apps under View App Configurations, and the Purchase Course Materials link will now be available in the left-hand navigation of your courses in Canvas. If you wish to rename this link, please edit the title in the XML code before completing Step 7. The title is found between the <lticm:property name="text"> </lticm:property> tags

7 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. In Canvas, click on the Admin tab. This tab is represented by a shield containing a star. 2. Select your institution s account from the list that appears. a. If your institution has multiple accounts, select the account or sub-account that is applicable to your specific college, university, or campus. 3. Click Settings from the left-hand navigation. 4. Click the Apps tab. 5. Click the View App Configurations button. 6. Click the + App button to add Research and Adopt Course Materials. 7. The Add App dialog will appear. Enter the following in the fields: Configuration Type: Select Paste XML from the drop-down menu. Name: Research and Adopt Course Materials Consumer Key: Enter the consumer key provided to you via . Shared Secret: Enter the shared secret provided to you via . XML Configuration: Download the XML here ( ). Copy it, and paste into this field. 8. Click Submit once the XML is pasted. 9. Research and Adopt Course Materials will now appear among your External Apps under View App Configurations, and the Research and Adopt Course Materials link will now be available in the left-hand navigation of your courses in Canvas. a. Note: Student users will not be able to view this link. If you wish to rename this link, please edit the title in the XML code before completing Step 7. The title is found between the <lticm:property name="text"> </lticm:property> tags

8 Authoring a URL Resource for Yuzu This section provides steps to author a URL resource for Yuzu. We do not currently provide an LTI integration for Yuzu. System-Level Setup of Access Digital Course Materials Link 1. Click on the Admin tab. This tab is represented by a shield containing a star. 2. Select your institution s account from the list that appears. a. If your institution has multiple accounts, select the account or sub-account that is applicable to your specific college, university, or campus. 3. Click Settings from the left-hand navigation. 4. Click the Apps tab. 5. Click the View App Configurations button. 6. Click the + App button to add Access Digital Course Materials. 7. The Add App dialog will appear. Enter the following in the fields: Configuration Type: Select By URL from the drop-down menu Name: Access Digital Course Materials Consumer Key: Please leave blank. Shared Secret: Please leave blank. Config URL: 8. Click Submit. 9. Access Digital Course Materials will now appear among your External Apps under View App Configurations, and the Access Digital Course Materials link will now be available in the left-hand navigation of your courses in Canvas

9 Optional System-Level Setup of Learn About Digital Options Link You may also opt to add a link to a page on FacultyEnlight that provides professors and instructors with an overview of our Yuzu offering. 1. Click on the Admin tab. This tab is represented by a shield containing a star. 2. Select your institution s account from the list that appears. a. If your institution has multiple accounts, select the account or sub-account that is applicable to your specific college, university, or campus. 3. Click Settings from the left-hand navigation. 4. Click the Apps tab. 5. Click the View App Configurations button. 6. Click the + App button to add Access Digital Course Materials. 7. The Add App dialog will appear. Enter the following in the fields: Configuration Type: Select By URL from the drop-down menu Name: Learn About Digital Options Consumer Key: Please leave blank. Shared Secret: Please leave blank. Config URL: w.facultyenlight.com%2f%23learn-about-yuzu&new_tab=1&course_navigation=1 8. Click Submit. 9. Learn About Digital Options will now appear among your External Apps under View App Configurations, and the Learn About Digital Options link will now be available in the left-hand navigation of your courses in Canvas

10 Testing the Links After placing the links, we recommend testing them before pushing them campus-wide. Research and Adopt Course Materials 1. Log into Canvas with faculty credentials. 2. Select a course from your Dashboard or Courses menu that has the LTI link enabled. 3. On the left-hand navigation bar, click the link for 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 Canvas 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

11 Purchase Course Materials 1. Log into Canvas with student credentials. 2. Select a course from your Dashboard or Courses menu that has the LTI link enabled. 3. On the left-hand navigation bar, click the link for 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 Canvas 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 Canvas. 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 Canvas with any credentials. 2. Select a course from your Dashboard or Courses menu that has the LTI link enabled. 3. On the left-hand navigation bar, click the link for Access Digital Course Materials. a. You will be prompted to open the URL in a new tab or window. Click Open in New Tab. 4. Yuzu will open in a new tab or window. a. At this point, the test is successful

12 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 Canvas. Upon going live, we provide the store manager with an template that may be used to communicate the availability of the bookstore links in Canvas. We can also provide how-to documentation for the faculty and student links to you and the store manager. Important Notes and Troubleshooting Link Doesn t Launch The LTI link may fail to launch from your Canvas LMS. Most often, the web browser is preventing the new window or tab from launching. If this occurs, please allow pop-ups to open from your Canvas site, and then attempt the link again. 403 Error When copying the key and/or secret from , you may have picked up a white space. If this happens, a user could receive a Forbidden 403 error message, or a notification that the key and secret must be provided. To resolve this, copy the information into Notepad or TextEdit to remove formatting, and then copy it into the dialog box, taking care to omit additional characters that may precede or follow the key and secret. An Error Has Occurred If you see the message, AN UNEXPECTED ERROR HAS OCCURRED. PLEASE CONTACT YOUR CAMPUS BOOKSTORE, please enable cookies in your browser. This message may also appear if you are attempting to access the link from within a private window. If the LTI link fails to launch, the pop-out window may be blocked. Please allow pop-ups from your Canvas site, and then attempt the link again. Other Issues or Concerns Contact Us For help with other concerns relating to the LMS integration in Canvas by Instructure, please contact us by Address ltisupport@bncollege.com

13 Appendix Connectivity Test Addendum Test Requirements In the above section entitled Testing Link Connectivity with Barnes & Noble College, we provided instructions to complete the connectivity test. Following are more details regarding the requirements and purpose for the connectivity test. When we receive the connectivity test, we use this data to set up the course mapping algorithms for your school. Usually, this information is contained in either the context_label or context_title field, but it could vary depending on your school s setup. One of the fields sent to us with the connectivity test must contain the term, department, course, and section information. When adding and performing the test, please ensure you do so within a course that contains this information. Example LTI Launch Parameters context_id de0855ae228f9f6d2fd1a93fddc7e4db23efad92 context_label BIOL608B-0101: Speciation-Fall 2017 staff context_title BIOL608B-0101: Speciation-Fall 2017 staff (PROD) custom_canvas_api_domain nook.instructure.com custom_canvas_course_id custom_canvas_enrollment_state active custom_canvas_user_id In this example, we see that the naming is: DepartmentCourse-Section: Coursename-Term Instructor

14 Multi-Section and Cross-Listed Courses If your school has multi-section and/or cross-listed courses, we will also require the naming protocol for those. You can either this information to or simply perform another connectivity test for each type of course. We need at least one example of each type, but more than one example, if they vary, will ensure a more accurate setup for your campus. Multi-Section Example LTI Launch Parameters context_id de0855ae228f9f6d2fd1a93fddc7e4db23efad92 context_label BIOL608B-0101,0202,0303: Speciation-Fall 2017 staff context_title BIOL 608B (Fall 2017) custom_canvas_api_domain nook.instructure.com custom_canvas_course_id In this example, we see that the naming is: DepartmentCourse,-Section,Section,Section: Coursename-Term Instructor Where the sections are separated by commas (you may have different delimiters) LTI Launch Parameters Cross-Listed Example context_id de0855ae228f9f6d2fd1a93fddc7e4db23efad92 context_label BIOL608B-0101/CHEM507B-0101: Speciation-F17 staff context_title BIOL608B-0101/CHEM507B-0101,0202: Speciation-Fall 2017 staff (PROD) custom_canvas_api_domain nook.instructure.com custom_canvas_course_id In this example, we see that the naming is: DepartmentCourse-Section/Course-Section: Coursename-Term Instructor Where the cross-listed courses are separated by a backslash / (you may have different delimiters)

15 Term Descriptions In order for proper mapping to occur, we need to match your school term codes to the bookstore s term codes. These term codes refer to the term descriptions used in your LMS. Please all current and future term descriptions, and the terms to which they refer, to ltisupport@bncollege.com. Examples BIOL608B-0101/CHEM507B-0101: Speciation-F17 staff F17 is the term code for Fall 2017 BIOL608B-0101/CHEM507B-0101: Speciation-Spring 2017 staff Spring 2017 is the term code for Spring 2017 BIOL608B-0101/CHEM507B-0101: Speciation-9117 staff 9117 is the term code for Summer BIOL608B-0101/CHEM507B-0101: Speciation-9217 staff 9217 is the term code for Summer