barnes & noble college lti tool admin guide moodlerooms joule€¦ · barnes & noble...

14
Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule - 1 - 9/23/2015 Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule Last Updated September 2015

Upload: others

Post on 08-Oct-2020

8 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 1 - 9/23/2015

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

Last Updated September 2015

Page 2: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 2 - 9/23/2015

Table of Contents

Contents

1.0 INTRODUCTION ............................................................................................................................................................ 3

2.0 KEY AND SECRET REQUEST FORM LINK AND INSTRUCTIONS ........................................................................................ 3

3.0 TESTING LINK CONNECTIVITY WITH BNC ...................................................................................................................... 4

4.0 LINK AUTHORING WITH A COURSE ............................................................................................................................... 8

5.0 PURCHASE COURSE MATERIALS ................................................................................................................................... 9

6.0 RESEARCH AND ADOPT COURSE MATERIALS................................................................................................................ 9

7.0 SYSTEM LEVEL EXTERNAL TOOL CONFIGURATIONS .................................................................................................... 10

SETUP “PURCHASE COURSE MATERIALS” AND “RESEARCH AND ADOPT COURSE MATERIALS” GLOBAL LINKS .......................................... 10

8.0 AUTHORING A URL RESOURCE FOR YUZU .................................................................................................................. 11

CREATING A URL – ACCESS DIGITAL COURSE MATERIAL................................................................................................................ 12 CREATING A URL – LEARN ABOUT DIGITAL OPTIONS* (OPTIONAL) ................................................................................................. 12

9.0 IMPORTANT NOTES AND TROUBLESHOOTING ........................................................................................................... 13

HOW CAN A USER FIND THEIR LMS USER ID? .............................................................................................................................. 13 HOW CAN A USER IDENTIFY A SPECIFIC LMS COURSE ID? ............................................................................................................... 13 I’M GETTING AN ERROR WHEN I TRY TO LAUNCH OUT WITH THE LTI LINK. .......................................................................................... 13 I AM NOT ABLE TO SUCCESSFULLY LAUNCH OUT OF THE LTI LINK I AUTHORED. .................................................................................... 14

Page 3: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 3 - 9/23/2015

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 Moodlerooms Joule Learning Management System.

References and screenshots to options in this user guide may differ on location based on what version of Moodlerooms Joule 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.

1. Click or paste the link into your browser https://blti.bncollege.com/registration/consumer to access the Consumer Key and Secret Request form.

2. The following fields are listed in the form and must be completed:

Field Name Description

LMS Type 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.

School 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.

Email Please enter your school email address. An auto-generated email will be sent to this email address when the key and secret is created.

First Name Enter your first name in this field.

Last Name Enter your last name in this field.

Phone Enter your phone number in this field.

Job Title We recommend you also enter your job title. This will help the BNC Administrator know whom they are working with for communication purposes.

CAPTCHA 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.

Page 4: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 4 - 9/23/2015

3. After all the required fields including CAPTCHA are successfully filled out, click Submit 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. You will receive a confirmation email from the Barnes & Noble College LMS support team with steps on how to test the connectivity and further instructions to setup the LTI integration.

3.0 Testing Link Connectivity with BNC

Once you receive the confirmation email 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. Joule 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.

Follow these steps to test connectivity.

Steps

1. Log into your Moodlerooms Joule LMS with your username and password. Users will need to have LTI link authoring privileges.

Page 5: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 5 - 9/23/2015

2. Navigate to any active available course.

Please make sure the course is an actual course or if using a test course, please 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.

3. Select a valid course.

4. Ensure that Editing has been turned on. Click Turn editing on.

5. Click the Add an activity box. Select External Tool.

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: https://blti.bncollege.com/lti/1.1/debug Secure Launch URL: https://blti.bncollege.com/lti/1.1/debug Launch Container: Ensure that this displays “New Window” Consumer Key: Enter TEST Consumer Secret: Enter TEST

8. Once all the data has been entered, click on the Save and display button A new screen for LTI Parameters will populate.

Page 6: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 6 - 9/23/2015

9. The LMS Administrator will need to click on the link Send LTI Parameters to Barnes & Noble College.

10. The LMS Administrator will populate their email address, school name and any message they want to BNC administrator to see.

11. When ready to send to the BNC administrator, the LMS Administrator should click Submit.

If you have trouble submitting your connectivity test, please send a screenshot to [email protected].

Page 7: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 7 - 9/23/2015

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, multi-section, 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.

12. Upon receiving your success message, please email [email protected] with your school terms codes.

a. For example: SP15 = Spring 2015

Page 8: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 8 - 9/23/2015

Once the information is received, we will process your request and send you a Key and Secret via email, which you can use to install our LTI integration.

4.0 Link Authoring with a Course

This section describes 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.

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.

Page 9: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 9 - 9/23/2015

5.0 Purchase Course Materials

Steps

1. Sign in to Joule 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 and Add an Activity or resource.

5. The Add an activity or resource box will display. Click on the External Tool icon radio button and click Add.

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: Purchase Course Materials Launch URL: https://blti.bncollege.com/lti/1.1/launch/bn_wcs Secure Launch URL: https://blti.bncollege.com/lti/1.1/launch/bn_wcs Launch Container: Ensure New window is selected Consumer Key: Enter the system generated Key that was sent to you in an email

from Barnes & Noble. Shared Secret: Enter the system generated Secret that was sent to you in an email

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.

6.0 Research and Adopt Course Materials

Steps

1. Sign in to Joule 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.

5. The Add an activity or resource box will display. Click on the External Tool icon radio button and click Add.

6. You will now be on the Adding a new External Tool page. Click the +Show more... link.

Page 10: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 10 - 9/23/2015

Steps

7. Enter the following fields: Activity Name: Research and Adopt Course Materials Launch URL: https://blti.bncollege.com/lti/1.1/launch/bn_fe Secure Launch URL: https://blti.bncollege.com/lti/1.1/launch/bn_fe Launch Container: Ensure New window is selected Consumer Key: Enter the system generated key that was sent to you in an email

from Barnes & Noble. Shared Secret: Enter the system generated secret that was sent to you in an email

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.

7.0 System Level External Tool Configurations

Log into your Moodlerooms Joule 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

Steps

1. Select Site Administration.

2. Select Plugins.

3. Select Activity Modules

4. Select LTI. You will be taken into the LTI External Tool Types page. 5. On the Active tab, select Add external tool configuration.

Page 11: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 11 - 9/23/2015

6. Define one global link for Purchase Course Materials and one global link for Research and Adopt Course Materials. You need to define one link at a time. Once you define a link and click Save, go back in via the same steps and define the other link.

You will 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: https://blti.bncollege.com/lti/1.1/launch/bn_wcs Consumer Key: Enter the system generated Key that was sent to you in an email

from Barnes & Noble. Shared Secret: Enter the system generated Secret that was sent to you in an

email 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: https://blti.bncollege.com/lti/1.1/launch/bn_fe Consumer Key: Enter the system generated Key that was sent to you in an email

from Barnes & Noble. Shared Secret: Enter the system generated Secret that was sent to you in an

email from Barnes & Noble. Custom Parameters: Click add custom parameter, fill in: system_level=true Default Launch Container: New Window

Once you define a link in a course, the global configuration gets picked up if the launch URL you define in the link matches the base URL value in the global configuration.

8.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

Page 12: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 12 - 9/23/2015

Creating a URL – Access Digital Course Material

Steps

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.

The system will refresh and you will be taken to the Adding a new URL page. 3. In the Name field enter “Access Digital Course Material”. 4. 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.” 5. In the External URL field, enter the following URL: http://yuzu.com/college

6. Under the Appearance section, make sure In pop up is selected in the Display Box.

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 – user will be navigated back to the course view. Save and display - user will be linked to launch URL.

8. If you click on Save and Display, you will be taken to the Access Digital Course Materials page and you can read the description. To launch the URL, click on the link at the bottom labeled, “Click http:yuzu.com/college link to open resource”. You will then be taken to the Yuzu page.

Creating a URL – Learn About Digital Options* (optional)

Steps

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. The system will refresh and you will be taken to an Adding a new URL page.

3. In the Name field enter “Learn About Digital Options”.

4. 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.”

5. In the External URL field, you will enter the following URL: https://www.facultyenlight.com/#learn-about-yuzu

6. Under the Appearance section, make sure In pop up is selected in the Display Box.

Page 13: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 13 - 9/23/2015

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 - user will be navigated back to the course view. Save and display - user will be linked to launch URL.

If you click on Save and Display, you will be taken to the Learn About Digital Options page and you can read the description.

8. To launch the URL, click on the link at the bottom labeled, “Click https://www.facultyenlight.com/#learn-about-yuzu link to open resource”. You will then be taken to the Yuzu page.

9.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 {username here} (Log out)". If a user clicks on successfully authenticates in Joule, they will see a status text that

reads, "You are logged in as 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.

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 emails, 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.

Page 14: Barnes & Noble College LTI Tool Admin Guide Moodlerooms Joule€¦ · Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule - 4 - 9/23/2015 3. After all the required fields

Barnes & Noble College LTI Tool Admin Guide – Moodlerooms Joule

- 14 - 9/23/2015

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 the External Tool option is selected.

2. Ensure the following 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):

https://blti.bncollege.com/lti/1.1/launch/bn_fe https://blti.bncollege.com/lti/1.1/launch/bn_wcs

3. 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.