LTI Tool Admin Guide Moodle

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 Setup for Research and Adopt Course Materials Link... 8 Course-Level External Tool Configuration Adding Purchase Course Materials Link to a Course Adding Research and Adopt Course Materials Link to a Course Course-Level Setup of Access Digital Course Materials Link Optional Course-Level Setup of Learn About Digital Options Link Testing the Links 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 Moodle learning management system. This guide is intended for the Moodle 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 Moodle 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 Moodle ID to their FacultyEnlight account, so that they won t need to log in to FacultyEnlight accessing the site from Moodle. 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. Moodle). 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 Moodle 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 Moodle with your administrator username and password. Users will need to have LTI link authoring 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 the Turn editing on button at the top right-hand corner of your course page. 4. In your General section, click + Add an activity or resource. 5. Your list of activities and resources will appear. 6. Select External tool from the Activities list, then click Add. 7. In the new page titled Adding a new External tool, click Show more under the General section and enter the following in the fields: Activity name: BNC Connectivity Test Display description on course page: unchecked Display activity name when launched: unchecked Display activity description when launched: unchecked Preconfigured tool: Automatic, based on tool URL Tool URL: Secure tool URL: Launch container: New window Consumer key: Test Shared secret: Test Custom parameters: none Icon URL: none Secure icon URL: none 8. Once you ve entered the information, expand the privacy section, and unselect Accept grades from the tool. 9. Leave the rest of the settings as-is, and click Save and display. 10. You will be taken to the LTI Parameters page in a new window. a. If prompted, click Load BNC Connectivity Test to proceed

6 11. On this page, click Send LTI Parameters to Barnes & Noble College. 12. Fill in the required information, then click Submit. a. A message will appear indicating the successful submission of your test. 13. Please repeat the test for courses of different formats, e.g. multi-section or cross-listed courses. 14. Once testing is complete, please a listing of term codes for the academic year (e.g = Fall 2017, etc.) to ltisupport@bncollege.com. 15. 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 In this section, the Moodle administrator will create two external tools that will enable the following LTI links globally in Moodle, so that faculty can easily add them to their courses from their Activity/Resources menu. 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. The steps below are for Moodle 3.1 and newer. To set up an LTI tool in older versions of Moodle, navigate in your Administration block to Site administration > Activity modules > LTI. Then, click on Add external tool configuration and follow the steps below to complete this LTI configuration. Setup for Purchase Course Materials Link 1. Log in to Moodle with your administrator username and password. 2. Navigate to the Administration block and click on Site administration. 3. Expand Plugins. 4. Expand Activity modules. 5. Expand External tool. 6. Select Manage tools. 7. On the Manage tools page, there is an Add tool menu. Click configure a tool manually. 8. Click the + App button to add Purchase Course Materials

8 9. In the new page titled Adding a new External tool, click Show more under the General section and enter the following in the fields: Tool name: Purchase Course Materials Tool URL: Tool description: none Consumer key: Enter the consumer key provided to you via . Shared secret: Enter the shared secret provided to you via . Custom parameters: none required Tool configuration usage: Show as preconfigured tool when adding an external tool Default launch container: New window Content-Item Message: unchecked Icon URL: Secure icon URL: Once you ve entered the information, expand the Privacy section just below. Select the following in each field: Share launcher s name with tool: Never Share launcher s with tool: Always or Never (depending on institutional preference) Accept grades from the tool: Never 11. Click Save changes. 12. The Purchase Course Materials external tool will now be available for administrators or faculty to add within courses. a. In a course, the tool will appear in the + Add an activity or resource menu, under Activities. Editing must be turned on to add this activity. 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 Moodle with your administrator username and password. 2. Navigate to the Administration block and click on Site administration. 3. Expand Plugins. 4. Expand Activity modules. 5. Expand External tool. 6. Select Manage tools. 7. On the Manage tools page, there is an Add tool menu. Click configure a tool manually

9 8. Click the + App button to add Purchase Course Materials. 9. In the new page titled Adding a new External tool, click Show more under the General section and enter the following in the fields: Tool name: Research and Adopt Course Materials Tool URL: Tool description: none Consumer key: Enter the consumer key provided to you via . Shared secret: Enter the shared secret provided to you via . Custom parameters: none required Tool configuration usage: Show as preconfigured tool when adding an external tool Default launch container: New window Content-Item Message: unchecked Icon URL: Secure icon URL: Once you ve entered the information, expand the Privacy section just below. Select the following in each field: Share launcher s name with tool: Never Share launcher s with tool: Always or Never (depending on institutional preference) Accept grades from the tool: Never 11. Click Save changes. 12. The Research and Adopt Course Materials external tool will now be available for administrators or faculty to add within courses. a. In a course, the tool will appear in the + Add an activity or resource menu, under Activities. Editing must be turned on to add this activity

10 Course-Level External Tool Configuration Once you have completed the System-Level External Setup, the links must be enabled at the course level in Moodle for each course. We encourage this to be completed by the Moodle Administrator; however, we can provide instructions to be shared with faculty on how they can add these tools to their courses. The below steps are for Moodle 3.1 and newer. To add the link in Moodle 3.0 and older, click + Add an activity or resource, select External tool, and click Add. Then, enter the information as provided in the above System-Level External Tool Setup steps in the previous section. Adding Purchase Course Materials Link to a Course 1. Log in to Moodle with your administrator or teacher credentials. 2. Navigate to and select your desired course. 3. Click the Turn editing on button at the top right-hand corner of your course page. 4. In the section where you wish to place the link, click + Add an activity or resource. 5. Select Purchase Course Materials from the list of activities and resources, then click Add. 6. On the Adding a new External tool page, enter the following: Activity name: Purchase Course Materials 7. Click Save and return to course. Adding Research and Adopt Course Materials Link to a Course 1. Log in to Moodle with your administrator or teacher credentials. 2. Navigate to and select your desired course. 3. Click the Turn editing on button at the top right-hand corner of your course page. 4. In the section where you wish to place the link, click + Add an activity or resource. 5. Select Research and Adopt Course Materials from the list of activities and resources, then click Add

11 6. On the Adding a new External tool page, enter the following: Activity name: Research and Adopt Course Materials 7. Click Save and return to course. The Research and Adopt Course Materials link is meant for instructors only. To prevent student access, complete the following steps. 8. Click the Edit option next to Research and Adopt Course Materials, and select Edit settings. 9. Scroll down to the Administration block. Under External tool administration, click Permissions. 10. Under Activity: External tool, find Launch external tool activities. 11. Under the Roles with Permission column, click the X to the right of Student to prevent student access to this link. The change will save automatically. 12. Return to your course. Course-Level Setup of 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. Log in to Moodle with your administrator or teacher credentials. 2. Navigate to and select your desired course. 3. Click the Turn editing on button at the top right-hand corner of your course page. 4. In the section where you wish to place the link, click + Add an activity or resource. 5. On the list of activities and resources, scroll down to the end of the Resources and select URL. 6. Click Add. 7. On the Adding a new URL page, enter the following under General: Name: Access Digital Course Materials External URL: 8. Expand the remaining options to tailor the appearance, settings, and competencies settings to your institutional preference. 9. Click Save and return to course. 10. The Access Digital Course Materials link will now be available in your course in Moodle

12 Optional Course-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. Log in to Moodle with your administrator or teacher credentials. 2. Navigate to and select your desired course. 3. Click the Turn editing on button at the top right-hand corner of your course page. 4. In the section where you wish to place the link, click + Add an activity or resource. 5. On the list of activities and resources, scroll down to the end of the Resources and select URL. 6. Click Add. 7. On the Adding a new URL page, enter the following under General: Name: Learn About Digital Options External URL: 8. Expand the remaining options to tailor the appearance, settings, and competencies settings to your institutional preference. 9. Click Save and return to course. 10. The Learn About Digital Options link will now be available in your course in Moodle. The Learn About Digital Options link is meant for instructors. To prevent student access, complete the following steps. 11. Click the Edit option next to Learn About Digital Options, and select Edit settings. 12. Scroll down to the Administration block. Under URL module administration, click Permissions. 13. Under Activity: URL, find View URL. 14. Under the Roles with Permission column, click the + button. 15. Select Teacher to enable instructor access. The change will save automatically. 16. Click the X to the right of Authenticated user to prevent student access. The change will save automatically. 17. Return to your course

13 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 Moodle with faculty credentials. 2. Select a course that has the LTI link enabled from your My courses menu. 3. In the section where the link is placed, 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 Moodle 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

14 Purchase Course Materials 1. Log into Moodle with student credentials. 2. Select a course that has the LTI link enabled from your My courses 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 Moodle 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 Moodle. 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 Moodle with any credentials. 2. Select a course that has the link enabled from your My courses menu. 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

15 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 Moodle. Upon going live, we provide the store manager with an template that may be used to communicate the availability of the bookstore links in Moodle. 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 Moodle 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 Moodle 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. Other Issues or Concerns Contact Us For help with other concerns relating to the LMS integration in Moodle, please contact us by Address ltisupport@bncollege.com

16 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_moodle_api_domain nook.moodle.com custom_moodle_course_id custom_moodle_enrollment_state active custom_moodle_user_id In this example, we see that the naming is: DepartmentCourse-Section: Coursename-Term Instructor

17 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_moodle_api_domain nook.moodle.com custom_moodle_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_moodle_api_domain nook.moodle.com custom_moodle_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)

18 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