Skip to content

Commit e53f939

Browse files
authored
LTI and DynReg Update (#406)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added an "Open Student Assignments Directly from LMS" page describing LMS-passed custom parameters and fallback behavior. * **Documentation** * Clarified and corrected LMS integration steps and wording across platforms (Blackboard, D2L, Schoology, DynReg). * Added Canvas assignment-mapping methods with videos and walkthroughs; removed legacy LTI 1.x/dynamic registration content. * Introduced Mentor role mapping in D2L; updated Getting Started videos and Added Additional Video Resources; fixed typos/formatting. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lola Valente <lvalente@codio.com>
1 parent 3f07d36 commit e53f939

12 files changed

Lines changed: 191 additions & 278 deletions

File tree

source/instructors/admin/integration/intro.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Integrating with your LMS system (Canvas etc.)
1414
lms-systems/system-specific-directions
1515
lms-students
1616
lti-enrol
17+
open-student-assignments-lms
1718
grading
1819
lti-app
1920
lti-keys-and-urls-information

source/instructors/admin/integration/lms-systems/blackboard.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Blackboard LTI 1.x
77
==================
88

9-
Please be sure to check out the :ref:`Codio LTI App <lti-app>` which allows for an easy way to integrate and to map Codio course assignments to your LMS system. The `following page <http://library.blackboard.com/ref/df5b20ed-ce8d-4428-a595-a0091b23dda3/Content/_admin_app_system/admin_app_basic_lti_tool_providers.htm>`_ explains how to set up external apps in Blackboard Learn.
9+
Please be sure to check out the :ref:`Codio LTI App <lti-app>` which allows for an easy way to integrate and to map Codio course assignments to your LMS. The `following page <https://library.blackboard.com/ref/df5b20ed-ce8d-4428-a595-a0091b23dda3/Content/_admin_app_system/admin_app_basic_lti_tool_providers.htm>`_ explains how to set up external apps in Blackboard Learn.
1010

1111
In Codio:
1212

@@ -26,8 +26,8 @@ Enable LTI for Your Course
2626
Bring up the LTI Integration Information
2727
----------------------------------------
2828

29-
6. Click your user name in the bottom left of your dashboard
30-
7. Choose your Organization
29+
6. Click your username in the top-right corner of your dashboard.
30+
7. Choose your Organization.
3131
8. Click the **LTI Integrations** tab to bring up the following settings.
3232

3333
.. image:: /img/lti/LTIintegrationinfo.png
@@ -81,7 +81,7 @@ In Codio
8181
24. On the main course screen, make sure the **Edit Assignments** tab is selected.
8282
25. Click the **Add Assignment** button and select **Project Based**.
8383
26. Select a project that has some autograded assessments. The **My First Project** that you created earlier in the Onboarding Guide has some auto-graded assessments. You can also assign another project but you will need to manually grade the assignment so there are some scores to pass back to the Blackboard gradebook.
84-
27. Once the assignment has been added to the course, you should click the icon with 3 blue dots and select **LTI Integration URL**.
84+
27. Once the assignment has been added to the course, you should click the three dots to the right of that assignment and select **LTI Integration URL**.
8585
28. You should copy the LTI integration url to the clipboard by clicking on the field (it will auto copy).
8686

8787
.. figure:: /img/lti/LMS-Unit-URL.png
@@ -99,12 +99,12 @@ We now return to Blackboard complete the mapping.
9999
33. In the **Web Link Information** section ...
100100
34. Enter a name for the content
101101
35. Paste in the **LTI Integration URL** that you just copied to the clipboard from Codio
102-
36. Check the box **Ths is a link to a tool provider**
102+
36. Check the box **This is a link to a tool provider**
103103
37. Select **Yes** for the field **Enable Evaluation** after which more fields will appear
104104
38. Set the points you want to award for this content (Codio will automatically scale the percentage value it uses to the points you specify here)
105105
39. Save the content settings.
106106

107107
Authentication and account creation
108108
-----------------------------------
109109

110-
To add students/teachers see :ref:`Users account creation <lms-users>`
110+
To add students/teachers, see :ref:`User account creation <lms-users>`.

source/instructors/admin/integration/lms-systems/d2l.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Enable LTI for Your Course
6161
Bring up the LTI Integration Information
6262
****************************************
6363

64-
1. Click your user name in the bottom left of your dashboard.
64+
1. Click your username in the top-right corner of the dashboard, then select **Organizations**.
6565
2. Choose your Organization.
6666
3. Click the **LTI Integrations** tab to bring up the following settings.
6767

@@ -144,3 +144,5 @@ Based on the LMS role, if teachers join Codio via the LMS, the following will ap
144144
+----------------------+-----------------------------------------------------------------------------------------------------+
145145
| Mentor | TEACHER (with :ref:`read only <add-teachers>` access to the course} |
146146
+----------------------+-----------------------------------------------------------------------------------------------------+
147+
148+

source/instructors/admin/integration/lms-systems/google-classroom.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,5 @@ Removing
6464
.. Note:: Removing the integration link will mean students will not be able to access any of their assignments any longer from Google Classroom
6565

6666
.. |Connect to Codio| image:: /img/google_classlist.png
67+
68+

source/instructors/admin/integration/lms-systems/schoology.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,6 @@ In Schoology
112112
23. Go back to Schoology and paste the **LTI Integration URL** into the URL field of the Add External Tool form from step 20.
113113
24. You can enable grading on external tool items which adds the material to your Gradebook so that you can assign a grade for each student who completes the assignment launched via the external tool.
114114

115-
.. Note:: LTI and external tool materials that have grading enabled in Schoology do not trigger submission notifications, grading reminders, or overdue notifications because Schoology does not automatically detect submissions from external tools.
115+
.. Note:: LTI and external tool materials that have grading enabled in Schoology do not trigger submission notifications, grading reminders, or overdue notifications because Schoology does not automatically detect submissions from external tools.
116+
117+

source/instructors/admin/integration/lti-app.rst

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -201,43 +201,6 @@ LTI 1.1
201201

202202

203203

204-
LTI 1.3
205-
"""""""
206-
207-
**Custom parameters claim object**
208-
specified in https://purl.imsglobal.org/spec/lti/claim/custom
209-
210-
**actual_user**
211-
212-
213-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
214-
| Parameter | Description | Example |
215-
+==================+===============================================================+==================================================+
216-
| id | id= lms user identification | "actual_user_id": "123" |
217-
| | | |
218-
| | This is equivalent of sub when the request is executed | |
219-
| | without changing the current user. | |
220-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
221-
| email | email= actual user email | |
222-
| | | |
223-
| | This will be used for registration if | "actual_user_email": "lms-admin@email.com" |
224-
| | custom_actual_user_id is not matched to an existed user. | |
225-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
226-
| role | role= actual user role | |
227-
| | | |
228-
| | This should not be Student-like role. | "actual_user_role": "Instructor" |
229-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
230-
| given_name | given_name= actual user given name | "actual_user_given_name": "Name" |
231-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
232-
| family_name | family_name= actual user family name | "actual_user_family_name": "Family" |
233-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
234-
| full_name | full_name= actual user full name | |
235-
| | | |
236-
| | This could be omitted if | "actual_user_full_name": "Name Family" |
237-
| | custom_actual_user_name_family and | |
238-
| | custom_actual_user_name_given passed. | |
239-
+------------------+---------------------------------------------------------------+--------------------------------------------------+
240-
241204
.. Note:: The parameters should be set by LMS dynamically based on current user, not statically. If you need assistance contact help@codio.com
242205

243206
.. important:: Canvas/Moodle/Blackboard do not support this feature.

source/instructors/admin/integration/lti1-3BS-D2L.rst

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ Access LTI Integration settings in Codio
2323
Copy fields from Codio to Brightspace/D2L
2424
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2525

26+
.. important::
27+
When copying links, please use the copy button adjacent to each link to ensure accuracy and prevent linking errors.
28+
29+
30+
31+
2632
.. figure:: /img/lti/codiolti13settings.png
2733
:alt: LTI 1.3 settings in Codio
2834
:width: 350px
@@ -122,28 +128,3 @@ First enable :ref:`LTI Constant URLs <lti-keys-and-urls-information>` for your c
122128

123129

124130

125-
LTI 1.3 Dynamic Registration
126-
-----------------------------
127-
128-
129-
Dynamic Registration simplifies the setup process by automatically sharing configuration information between Tools and LMS systems.
130-
131-
132-
Access LTI Integration Settings in Codio
133-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134-
135-
136-
.. image:: /img/lti/codiolti13settings.png
137-
:alt: LTI 1.3 settings in Codio
138-
:align: right
139-
:width: 350px
140-
:class: img-responsive
141-
142-
143-
1. Click your username in the top-right corner, then select **Organizations** from the menu.
144-
2. In the **Organizations** area, click the name of your organization.
145-
3. Select the **LTI Integrations** tab.
146-
4. Scroll down to the **LTI Integration 1.3** section.
147-
5. The **Dynamic Registration URL** is at the bottom of the list, you can copy it by clicking on the **Dynamic Registration URL** button.
148-
149-

source/instructors/admin/integration/lti1-3Blackboard.rst

Lines changed: 0 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -77,142 +77,3 @@ In Blackboard:
7777
- Paste the **LTI Integration URL** you copied in the last step into the **Configuration URL** field for your assignments.
7878

7979

80-
Blackboard LTI 1.x
81-
-------------------
82-
83-
Please be sure to check out the :ref:`Codio LTI App <lti-app>` which allows for an easy way to integrate and to map Codio course assignments to your LMS. The `following page <https://library.blackboard.com/ref/df5b20ed-ce8d-4428-a595-a0091b23dda3/Content/_admin_app_system/admin_app_basic_lti_tool_providers.htm>`_ explains how to set up external apps in Blackboard Learn.
84-
85-
In Codio:
86-
87-
Enable LTI for Your Course
88-
~~~~~~~~~~~~~~~~~~~~~~~~~~
89-
90-
1. Open the course you would like to connect or create a new course.
91-
2. Make sure you have at least one published assignment or add a new one. (see :ref:`Add and Remove Course Assignments <add-remove-assignment>`)
92-
3. Select the **LTI/LMS** tab.
93-
4. Select the **ENABLE LTI** option.
94-
95-
.. image:: /img/lti/enable-lti.png
96-
:alt: enable lti
97-
98-
5. Click **Save Changes**.
99-
100-
Bring up the LTI Integration Information
101-
----------------------------------------
102-
103-
6. Click your user name in the bottom left of your dashboard
104-
7. Choose your Organization
105-
8. Click the **LTI Integrations** tab to bring up the following settings.
106-
107-
.. image:: /img/lti/LTIintegrationinfo.png
108-
:alt: Org LTI info
109-
110-
111-
In Blackboard
112-
~~~~~~~~~~~~~
113-
114-
The Blackboard user who carries out these steps must be a Blackboard system administrator.
115-
116-
9. Create a new Course in Blackboard. We suggest you create a test course called **Codio Blackboard** before you do it with a production course.
117-
10. Look for the **System Admin** tab near the top right of the page and select it.
118-
11. Look for the **Building Blocks** section and select it.
119-
12. Click on **LTI tool providers**.
120-
13. Click on **Register Provider Domain** in the menu bar.
121-
14. In the **Provider Domain** field, enter ``apollo.codio.com``.
122-
15. In the **Default Configuration** section, set **Default Configuration** to be **Set globally**.
123-
16. In the **Organization Policies** section you should
124-
17. set **Send User Data** to **Send user data only over SSL**.
125-
18. in **User Fields to Send** you should set all 3 fields (Constituency in Course, Name, Email Address).
126-
127-
In Codio and Blackboard
128-
~~~~~~~~~~~~~~~~~~~~~~~
129-
130-
19. Now return to the **Default Configuration** section in Blackboard. We will now copy the following global integration fields from Codio to Blackboard.
131-
132-
- LTI Consumer -> Tool Provider Key
133-
- LTI Secret -> Tool Provider Secret
134-
135-
Codio course setup
136-
------------------
137-
138-
You need to perform the following actions one time only for a course. The Blackboard user who carries out these steps does not need to be a system administrator but must have suitable privileges to edit courses and assignments.
139-
140-
20. In Codio, go to your course and click on the **LTI/LMS** tab.
141-
21. Go to the **LTI/LMS Settings** area.
142-
22. At the top is a switch **Enable LTI** which you should check is enabled.
143-
23. Below this is an empty field **Course LMS URL**. Switch back to Blackboard and make sure you are on the main the Codio Blackboard course you created earlier. Copy the url in the address bar of your browser to the clipboard and paste it into the above mentioned field in Codio.
144-
145-
This URL ensures that Codio knows how to redirect students back to the correct Blackboard course should they attempt to access the course through their dashboard.
146-
147-
Mapping an assignment to Blackboard Content
148-
-------------------------------------------
149-
150-
The final mapping step needs to be taken for each individual assignment within Codio. It maps a piece of Blackboard content to a Codio assignment.
151-
152-
In Codio
153-
~~~~~~~~
154-
155-
24. On the main course screen, make sure the **Edit Assignments** tab is selected.
156-
25. Click the **Add Assignment** button and select **Project Based**.
157-
26. Select a project that has some autograded assessments. The **My First Project** that you created earlier in the Onboarding Guide has some auto-graded assessments. You can also assign another project but you will need to manually grade the assignment so there are some scores to pass back to the Blackboard gradebook.
158-
27. Once the assignment has been added to the course, you should click the 3 dots to the right of that assignment and select **LTI Integration URL**.
159-
28. You should copy the LTI integration url to the clipboard by clicking on the field (it will auto copy).
160-
161-
.. figure:: /img/lti/LMS-Unit-URL.png
162-
:alt: Unit URL
163-
164-
In Blackboard
165-
~~~~~~~~~~~~~
166-
167-
We now return to Blackboard complete the mapping.
168-
169-
29. Make sure you have selected the Blackboard course.
170-
30. Click **Content** in the left hand menu.
171-
31. Select or hover over **Build Content** in the menu bar
172-
32. Select **Web Link**.
173-
33. In the **Web Link Information** section ...
174-
34. Enter a name for the content
175-
35. Paste in the **LTI Integration URL** that you just copied to the clipboard from Codio
176-
36. Check the box **This is a link to a tool provider**
177-
37. Select **Yes** for the field **Enable Evaluation** after which more fields will appear
178-
38. Set the points you want to award for this content (Codio will automatically scale the percentage value it uses to the points you specify here)
179-
39. Save the content settings.
180-
181-
Authentication and account creation
182-
-----------------------------------
183-
184-
To add students/teachers see :ref:`Users account creation <lms-users>`
185-
186-
LTI 1.3 Dynamic Registration
187-
-----------------------------
188-
189-
190-
Dynamic Registration simplifies the setup process by automatically sharing configuration information between Tools and LMS systems.
191-
192-
193-
Access LTI Integration Settings in Codio
194-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195-
196-
197-
.. image:: /img/lti/codiolti13settings.png
198-
:alt: LTI 1.3 settings in Codio
199-
:align: right
200-
:width: 350px
201-
:class: img-responsive
202-
203-
204-
1. Click your username in the top-right corner, then select **Organizations** from the menu.
205-
2. In the **Organizations** area, click the name of your organization.
206-
3. Select the **LTI Integrations** tab.
207-
4. Scroll down to the **LTI Integration 1.3** section.
208-
5. The **Dynamic Registration URL** is at the bottom of the list, you can copy it by clicking on the **Dynamic Registration URL** button.
209-
210-
211-
212-
213-
214-
215-
216-
217-
218-

0 commit comments

Comments
 (0)