diff --git a/assets/Figures/canvas-lti1p3-anon.jpg b/assets/Figures/canvas-lti1p3-anon.jpg new file mode 100644 index 0000000..5306432 Binary files /dev/null and b/assets/Figures/canvas-lti1p3-anon.jpg differ diff --git a/assets/Figures/canvas-lti1p3-clientid.jpg b/assets/Figures/canvas-lti1p3-clientid.jpg new file mode 100644 index 0000000..47104e5 Binary files /dev/null and b/assets/Figures/canvas-lti1p3-clientid.jpg differ diff --git a/assets/Figures/canvas-lti1p3-instructor-clientid.jpg b/assets/Figures/canvas-lti1p3-instructor-clientid.jpg new file mode 100644 index 0000000..2f88388 Binary files /dev/null and b/assets/Figures/canvas-lti1p3-instructor-clientid.jpg differ diff --git a/assets/Figures/canvas-lti1p3-module-use.jpg b/assets/Figures/canvas-lti1p3-module-use.jpg new file mode 100644 index 0000000..f00c7d1 Binary files /dev/null and b/assets/Figures/canvas-lti1p3-module-use.jpg differ diff --git a/assets/Figures/canvas-lti1p3-settings.jpg b/assets/Figures/canvas-lti1p3-settings.jpg new file mode 100644 index 0000000..de3e47b Binary files /dev/null and b/assets/Figures/canvas-lti1p3-settings.jpg differ diff --git a/assets/Figures/moodle-lti1p3-activate.jpg b/assets/Figures/moodle-lti1p3-activate.jpg new file mode 100644 index 0000000..e87c6da Binary files /dev/null and b/assets/Figures/moodle-lti1p3-activate.jpg differ diff --git a/assets/Figures/moodle-lti1p3-instructor-show.jpg b/assets/Figures/moodle-lti1p3-instructor-show.jpg new file mode 100644 index 0000000..bd5984f Binary files /dev/null and b/assets/Figures/moodle-lti1p3-instructor-show.jpg differ diff --git a/assets/Figures/moodle-lti1p3-selectcontent-use.jpg b/assets/Figures/moodle-lti1p3-selectcontent-use.jpg new file mode 100644 index 0000000..5330765 Binary files /dev/null and b/assets/Figures/moodle-lti1p3-selectcontent-use.jpg differ diff --git a/pretext/Registration/lti.ptx b/pretext/Registration/lti.ptx index 0fd655a..2ce58e0 100644 --- a/pretext/Registration/lti.ptx +++ b/pretext/Registration/lti.ptx @@ -1,9 +1,18 @@
- Integrating with your LMS + Integrating with your LMS Using LTI 1.1 Introduction + +

+ Runestone provides two methods of LTI integration. LTI 1.1 and LTI 1.3. LTI 1.3 is the newer standard and is more secure and more flexible. However, it requires setup by an administrator of your Learning Management System (LMS). LTI 1.1 can be set up by an individual instructor without LMS admin support. +

+

+ We recommend that you use LTI 1.3 if possible If you are using LTI 1.3 you should follow the instructions in . If you are using LTI 1.1 then follow the instructions in this section. +

+

- Runestone provides a rudimentary LTI integration using LTI 1.1. So far we have made this work very successfully with Canvas, Moodle, and Brightspace D2L. Others may or may not work. I call this a community supported feature of Runestone because LTI is a huge pain to work with, and it is very difficult to get access to and test against whatever LMS your school has chosen.

+ Runestone provides a rudimentary LTI integration using LTI 1.1. So far we have made this work very successfully with Canvas, Moodle, and Brightspace D2L. Others may or may not work. I call this a community supported feature of Runestone because LTI is a huge pain to work with, and it is very difficult to get access to and test against whatever LMS your school has chosen. Community support is available on the #lti_community_support channel of the Runestone Discord Server. +

When you use LTI your students do NOT and should not register on Runestone Academy, the LTI interface registers your student with Runestone the first time they access it from your LMS. In addition, Instructors need to use one of the LTI links to your book in order for grades to transfer.

diff --git a/pretext/Registration/lti1p3.ptx b/pretext/Registration/lti1p3.ptx new file mode 100644 index 0000000..23c629e --- /dev/null +++ b/pretext/Registration/lti1p3.ptx @@ -0,0 +1,241 @@ +
+ Integrating with your LMS Using LTI 1.3 + + Introduction + +

LTI 1.3 Integration is in limited testing and is only available on a special development server not intended for production use. If you are interested in testing it against your LMS, please reach out to ascholerChemeketa on the Runestone Discord Server

+ + +

+ Runestone provides two methods of LTI integration. LTI 1.1 and LTI 1.3. LTI 1.3 is the newer standard and is more secure and more flexible. However, it requires setup by an administrator of your Learning Management System (LMS). LTI 1.1 can be set up by an individual instructor without LMS admin support. +

+

+ We recommend that you use LTI 1.3 if possible If you are using LTI 1.3 you should follow the instructions in this section. If you are using LTI 1.1 then follow the instructions in . +

+ +

+ Runestone's LTI 1.3 integration has been tested against Canvas and Moodle. Others LMS systems that support LTI 1.3 may or may not work. We welcome reports of successful use with other LMS systems and code pull requests to add any necessary support for other LMS systems. Community driven support is available on the #lti_community_support channel of the Runestone Discord Server. +

+ + + LTI1.3 Integration Basic Information +

+ LTI1.3 integration can include syncing user's names and emails from the LMS platform or be done anonymously. The Runestone Privacy Policy specifies how any synchronized data is used and protected. +

+

+ Integration must be setup one time by someone with administrator authority on your LMS. Once setup, Runestone can be added to a course by any instructor. (Depending on the LMS, instructors may need a piece of information from the LMS admin to do so.) +

+

+ When using LTI integration between Runestone and an LMS, students should NOT sign up for an account on Runestone. They should only access the Runestone book through the LMS, which will automatically create an account for them. Instructors will need to create an account with Runestone to set up their course and to link to the LMS. +

+ + + LTI1.3 Setup - LMS Administrator +

+ Runestone supports the LTI Dynamic Registration protocol. This means you will just need to enter one URL into your LMS and the two systems will negotiate the rest of the details. This registration URL is: https://runestone.academy/admin/lti1p3/register +

+ +

For Runestone to properly function, you will likely need to ensure specific settings in your LMS system. See the subsections below for details on particular platforms. Please note that user interfaces on LMS platforms change over time and the shown screenshots and described options may not perfectly match what you see. +

    +
    • +
    • +
+

+ + + LTI 1.3 Admin Setup - Canvas +

+ Global settings for LTI features are available in Site Admin > Settings > Feature Options. Runestone relies on being able to create Deep Linking Line Items. To ensure proper functioning, please ensure that the following settings are enabled: +

    +
  • Deep Linking for Module Index Menu
    • +
  • Deep Linking Line Items
    • +
+

+ + Canvas LTI 1.3 Feature Options settings + +

+ To register Runestone as an available app, go to Site Admin > Apps > Manage and select Install a New App. Select 1.3 as the LTI version, Dynamic Registration as the method, and use the the URL listed above. After pressing OK, you should get a confirmation message with a close button. Press that to continue to configure the App. +

+

+ All the settings on the Permissions screen should be left on. (If you wish to configure Runestone to not share Personally Identifying Information about users, you will get a chance to do so in the next step.) +

+ +

+ On the Data Sharing screen, leave the User Data Shared With This App setting as the default (All user data) to share user emails and names with Runestone. If you wish to disable doing so, you can change this to None. +

+ + Canvas LTI 1.3 Data Sharing Setting + +

+ From this point on, you should leave all settings as default - they just control what Runestone is titled within the LMS and what links are available to make use of it. +

+ +

+ For an instructor to add Runestone to their course, they will need to know the ClientID that was assigned to Runestone. This can be found at Site Admin > Apps > Manage. Click the three dots next to the Runestone app and select Copy Client ID. +

+ + Canvas LTI 1.3 Client ID + + + + LTI 1.3 Admin Setup - Moodle + +

+ To register Runestone as an available app, go to Site administration > Plugins > External tool > Manage tools. Use the URL listed above as the Tool URL and press Add LTI Advantage. After pressing OK, you should get a confirmation message with a close button. +

+

+ Next, activate the app by Clicking Activate on its card in the Tools list. +

+ + Moodle LTI 1.3 Activation + +

+ Finally, click on the gear icon on the Runestone card in the tools list to configure the app. Under Tool Settings sure to confirm these two settings: +

    +
  • Tool configuration usage is set to Show as preconfigured tool...
    • +
  • Default launch container is set to New Window (Runestone will display in embedded iframes but is much harder to read and navigate in that format.)
    • +
+ + Then, under Privacy, you can choose to share user data with Runestone or not. If you wish to disable sharing user data, you can change Share launcher's name with tool and Share launcher's email with tool Never. Make sure to leave Accept grades from the tool set to the default or to Always. +

+ + Canvas LTI 1.3 Data Sharing Setting + + + + + LTI1.3 Setup - Instructor + +

+ First make sure that you have a Runestone account. If you don't have one, you can create one at Runestone Academy. Create a Runestone course to link to your LMS course. You may also wish to set up assignments in Runestone at this point, although you can always link new ones later. Before you try to link your LMS to a course and/or assignments, you should make sure you are logged into Runestone and currently viewing the course you want to link to. +

+ +

+ Depending on how your LMS reports your identity to Runestone, when you access Runestone from the LMS by clicking a link to your RS course or book, you may or may not be logged into Runestone as the same user as the account you created. (If your LMS reports your email, and you set up your RS account with the same email, then you should be logged in as the same user.) If you end up with a different identity in Runestone, you will likely want to add that user as an instructor. You can do this by adding the user as a TA. See for more information. +

+ +

+ Each RS course can be linked to only one LMS course. This means that if you have multiple courses in your LMS for multiple sections or some other reason, you will need to create different RS courses for each LMS course. You can link multiple RS courses to the same LMS course (if you are using multiple books in one course.) If you need to unlink Runestone from an LMS, you can use the Remote LTI 1.3 Association button from the Admin > LTI Integration screen. Doing so will NOT remove any assignments or grades from the LMS, but it will prevent new grades from being sent to the LMS. You can then relink the course with the same LMS course or a new one. +

+ +

There are some settings available in each Runestone course that affect LTI integration: +

    +
  • Under Admin > Course Settings, Show Points in Gradebook will affect how scores are reported to the LMS. If you want assignments reported to the LMS as points (3 / 4) instead of percent (75%), make sure this is checked. Note that settings in your LMS grade book may allow you to weight scores or change their display in other ways that override the way Runestone reports them to the LMS.
    • +
  • Under Admin > LTI Integration, checking Ignore LTI1.3 Date Changes will prevent Runestone from updating due dates on assignments.
    • +
  • Under Admin > LTI Integration, checking Do not auto update LTI grades will prevent Runestone from trying to automatically send grade updates as a user completes activities. This may be desirable if your assignments contain lots of items that need to be hand graded and you do not want users to see misleading low grades for assignments that have not been fully scored yet.
    • +
+

+ +

Find the subsection below for details on how to add Runestone to your course: +

    +
    • +
    • +
+

+ + + LTI 1.3 Instructor Setup - Canvas +

+ You will need the Client ID of the Runestone installation on your LMS. Ask your LMS administrator for this piece of information. Refer them to for information on how to find this.

+

+ In your Canvas course, go to Settings > Apps and then click the + App button. For the Configuration Type, choose Client ID and then type the Client ID given to you by the LMS admin. +

+ Canvas LTI 1.3 Client ID Entry +

You should now see Runestone listed under the External apps

+ + + + LTI 1.3 Instructor Setup - Moodle +

If your LMS administrator has set up Runestone, you should see it displayed under More > LTI External Tools in your course settings. If you do not see it, ask your LMS admin to confirm that Runestone was set up to display as a preconfigured tool. You just need to toggle the Show in activity chooser to the on state.

+ Canvas LTI 1.3 Client ID Entry + + + + + LTI1.3 Instructional Use + + + Content Linking +

+ There are two kinds of links that can be generated from Runestone: +

    +
  • Book Page Links These are links to a particular page in the book. When a user uses one of these links, they will automatically be logged into Runestone. If you wish to provide a generic Log in to book link, you can use one of these that points at the book entry page (index.html). Or you can generate links to any page in the book.
    • + +
  • Assignment Links These are links to a particular assignment in the RS course. When you want a LMS assignment that is linked to a RS assignment, you must use this kind of link.
    • +
+ User activity is tracked and scores updated regardless of which form of link is used to access the Runestone content. The only difference other than where they link to is that Book Page Links do not create an entry in the LMS grade book. +

+ +

+ Begin by setting up assignments you wish to link to in Runestone. Do not make LMS assignmentsthey will be created for you when you link to the Runestone assignments. (See for coverage of making Runestone assignments.) For students to access a Runestone assignment (after clicking a link in the LMS), the RS assignment must be marked Visible to Students. This property is not linked to the LMS. If you want assignments to be rolled out gradually in the course, you will have to manage the process separately in your LMS and in RS by changing the visibility of assignments in both places. +

+ +

+ To add content to your course, look for the Runestone option in whatever allows you to add content items to a module/course etc... in your LMS (see subsections below for LMS specific notes). +

+ +

+ When you open the Runestone Content Linking panel, you will see two sections. First you will see a section to generate New Book Page Links. Click Add book link as many times as you like to generate dropdowns that can be used to select book pages. Use the dropdown to select the page(s) you want to make links to. Each will be generated as a separate content item in your LMS. +

+ +

+ Below that is the Assignment Links area. Here a table is displayed with each Runestone assignment. For each one, the current LMS assignment (if any) that it is linked to is displayed. If the RS assignment is linked to an assignment in the current LMS course, that will be displayed and you will not be able to perform any action. To delete the assignment, do some from your LMS. For unlinked assignment, you will be given three options: + +

    +
  • No action: do not link this assignment.
    • +
  • Create new LMS Activity: creates a new LMS assignment linked to this RS assignment.
    • +
  • Link to existing assignment: this should only be used after copying a course to relink orphaned items. See for details.
    • +
+

+ +

+ Finally, the Submit Form button will update Runestone to link the RS course to this LMS course (so it knows where to send grades) and will send a message to your LMS to generate the desired content links. Your LMS may or may not give you a chance to confirm the changes after this point. +

+ +

+ If you ever need to, it is safe to delete an assignment in the LMS. No RS data will be deleted. If desired, you can then readd the assignment in the LMS and re-push any available grades. +

+ + + + LTI1.3 Grade Reporting +

Grades are normally sent to Runestone at the following times: +

    +
  • A learner interacts with any graded element of the course that is part of an active assignment with released grades. (Grade updates should happen whether the user is viewing the problem in context or in the assignment view).
    • +
  • The instructor goes to the Grading tab of the admin interface, selects an assignment and presses the Push Grades to LTI button. This will send score updates for that assignment for all users in the course regardless of whether or not scores are released in Runestone.
    • +
  • The instructor goes to the Grading tab of the admin interface, selects an assignment and a particular Student, then enters a manual override grade and presses Push Grade to LMS. This will send the grade for that one user, regardless of whether or not scores are released in Runestone.
    • +
+ This means that if you want users to see score updates as they complete work, you should release the assignment scores in Runestone as soon as assignments are created. +

+ + + + Copying an LTI1.3 Course +

+ To reuse course content that you linked in one course for a new course, you will generally want to do the following: +

    +
  1. + Use your LMS to copy the assignments from your old course to your new course. They will not be linked to Runestone. If you want to synchronize the due dates automatically, use your LMS to set up due dates. +
    2. +
  2. + In Runestone, make a new course. Copy all of the assignments from your old course to your new course. If you want to make sure the due dates are synced, do not check the Ignore LTI1.3 Date Changes box in the Admin > LTI Integration settings for your new course before finishing the linking process. +
    3. +
  3. + In your LMS, use the add content feature and select the Runestone tool. Assuming your assignments in the two platforms have matching names, the default actions suggested for each RS assignment will be to link to the existing LMS assignment with the same name. If there is a mismatch, change the LMS assignment name to match the RS assignment name before linking. When you submit the form, the assignments will be linked and the due dates from the LMS will be synced to Runestone. +
    4. +
+

+ + + LTI 1.3 Canvas Notes +

The best way to create new content items (especially multiple at one time) is in the Modules area. Use the three dot menu and select Runestone.

+ Adding Runestone items from the Canvas Module area + + + LTI 1.3 Moodle Notes +

To add content items, use one of the Add an activity or resource links in your course. Select Runestone from the available tools. You will be taken to a form adding one activity, but you can still add as many Runestone links as you like. Click the Select content button. When you finish selecting content, if you selected just one new RS item, you will return to the form to finish editing that activity and save it in your LMS. If you selected multiple items, you will return to a page that lists the items being added. If your actions do not add any new content (you are remapping copied assignments), you will be returned to a blank form but Runestone will have updated your selected items.

+ Adding Runestone items from the Moodle Select content area + + +
diff --git a/pretext/Registration/toctree.ptx b/pretext/Registration/toctree.ptx index 1911d17..9b849c9 100644 --- a/pretext/Registration/toctree.ptx +++ b/pretext/Registration/toctree.ptx @@ -4,6 +4,7 @@ +