You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/instructors/admin/integration/lti-keys-and-urls-information.rst
+91-46Lines changed: 91 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,67 +14,51 @@ Enabling this setting enables constant URL for course assignments, course detect
14
14
15
15
Constant URL's allows the transfer of learning content without modifying LTI links and they are also required if you wish to copy Codio courses and LMS Courses. See :ref:`LTI Course Copy <lti-course-copy>` for more on this.
.. Note:: the screenshots below are for implementation in Canvas but other LMS systems should be similar. Refer to their documentation for more assistance
24
-
25
-
1. Create an External app in your LMS using the **configuration type: By URL**.
26
-
27
-
.. figure:: /img/lti/canvas_url.png
28
-
:alt:LTI URL config
29
-
30
-
2. Enter in the **Consumer Key** and **Shared Secret** from your Codio organization.
31
-
32
-
.. figure:: /img/lti/lti-org-fields.png
33
-
:alt:LTI Fields
34
-
35
-
3. Copy the **XML URL** into the Config URL field.
36
-
4. Submit.
37
-
5. Return to your Codio course and enable the **Enable LTI constant URL's** button, and save your changes.
38
-
6. Copy the **LTI constant URL's enabled** link.
39
-
40
-
.. Note:: If your LMS supports it, ``lis_course_offering_sourcedid`` is also supported as a unique course identifier so you can replace``codio_class_target_id`` if required. For cases when ``lis_course_offering_sourcedid`` is needed for course copy but not available due to privacy settings in Canvas, a custom parameter ``custom_codio_course_offering_sourcedid=$CourseOffering.sourcedId`` can be tried.
41
-
42
-
.. figure:: /img/lti/constant_url.png
43
-
:alt:Enable Constant URL
44
-
45
-
7. Return to your LMS external app and 'edit'.
46
-
8. Paste the **LTI constant URL's enabled** link into the Custom Field.
47
-
9. Submit.
48
19
49
20
LTI Keys
50
21
--------
51
22
52
-
**LTI Keys** are used to integrate your LMS to Codio. These keys are required by your LMS administrator one time only so that Codio can be added as an LTI provider. Once Codio has been added as an LTI provider, you will not need them again and the remaining actions can be completed by LMS users who have Teacher/Instructor permissions. LTI keys are accessible to :ref:`Codio Organization Owners <org-owners>` only.
23
+
**LTI Keys** are used to integrate your LMS to Codio. Your LMS administrator will use these keys once to integrate Codio as an LTI provider in your system. Once Codio has been added as an LTI provider, you will not need them again and the remaining actions can be completed by LMS users who have Teacher/Instructor permissions. LTI keys are accessible to :ref:`Codio Organization Owners <org-owners>` only.
53
24
54
25
To find these keys:
55
26
56
-
1. Go to your organization account settings by clicking on your user name in the bottom left of your dashboard and then selecting your organization within
57
-
**Organizations**.
58
-
2. Select the **LTI Integrations** tab.
59
-
3. Scroll down to the **LTI Integration 1.0** section. You should see the following fields.
The **Course LMS URL** is used to map an LMS course to a Codio course. It ensures that Codio knows how to redirect students back to the correct course should they attempt to access the course through the Codio dashboard.
42
+
The **Course LMS URL** is used to map a LMS course to a Codio course. This ensures that students are automatically redirected to the correct course when they access it through the Codio dashboard.
68
43
69
-
The LMS user who carries out these steps does not need to be a system administrator but must have suitable privileges to edit courses and assignments.
44
+
**Note: The LMS user who carries out these steps does not need to be a system administrator but must have suitable privileges to edit courses and assignments.**
70
45
71
-
1. In Codio, go to the **LTI/LMS** section.
72
-
2. At the top is a switch **Enable LTI** which you should enable.
73
-
3. Below this is an empty field **Course LMS URL**. Switch back to your LMS and make sure you are on the Home page of the course. Copy the url in the address bar of your browser to the clipboard and paste it into the above mentioned field in Codio.
@@ -90,6 +74,67 @@ The **Assignment URL** is needed to map each individual assignment within your C
90
74
.. figure:: /img/lti/LMS-Unit-URL.png
91
75
:alt:Assigment URL
92
76
93
-
.. Note:: The LTI integration URLs for the assignments in a course can be exported. Select the course, go to the **LTI/LMS** tab, and press the **Assignment URLS** button and a CSV will download that provides the information for the course in one place.
94
77
95
-
3. Complete the mapping in your LMS.
78
+
.. Note:: The LTI integration URLs for the assignments in a course can be exported, see instructions below.
79
+
80
+
81
+
82
+
83
+
84
+
85
+
Export LTI Settings
86
+
===================
87
+
88
+
The LTI integration URLs for the assignments in a course can be exported.
89
+
90
+
- Select the course, go to the **LTI/LMS** area and then press the **Assignment URLs** button.
91
+
92
+
.. image:: /img/class_lti_export.png
93
+
:alt:Export LTI settings
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
LTI Enroll to Course Only
103
+
=========================
104
+
105
+
LTI Enrollment provides single sign-on access to an entire course without linking each assignment. **It does not allow for automatic grade passback**.
106
+
107
+
To use this feature, first generate a link from your Codio course and then add it to your LMS course as an **External Tool** in an assignment or module. When students click the link, they are enrolled in the Codio course and redirected to the Codio dashboard. On there dashboards they will see all the assignments for the course.
108
+
Students do not need to begin each assignment using the LMS system.
109
+
110
+
To generate an **LTI Enroll Link**, follow the steps below:
111
+
112
+
.. image:: /img/lti/LTIenrolllink.png
113
+
:alt:Export LTI settings
114
+
:align:right
115
+
:width:510px
116
+
117
+
1. Navigate to the **Courses** page and select the course you wish to connect.
118
+
2. Click **LTI/LMS** tab and turn ON the **Enable LTI** setting from LTI/LMS Setting area.
119
+
3. Enable the **Enroll to course only** setting to generate the link.
120
+
4. Copy the link and paste it as an **External Tool** in your LMS system.
121
+
122
+
123
+
|
124
+
125
+
.. Note:: With the **Enroll to course only** setting, grades are not passed back to the LMS. Refer to :ref:`Webhook <webhooks>` for more information about passing grades back.
126
+
127
+
128
+
Common Cartridge
129
+
=================
130
+
131
+
Allows you to export the `Common Cartridge 1.3 <http://www.imsglobal.org/cc/ccv1p3/imscc_Overview-v1p3.html>`_ data for the course to then use within your LMS system to import details of the assignments in your Codio courses.
132
+
133
+
1. Navigate to the **Courses** page and select the course to open it.
134
+
2. Click the **LTI/LMS** tab and then in the **LTI/LMS Connections** area, click to **Common Cartridge** the common cartridge information.
135
+
136
+
.. image:: /img/common-cartridge.png
137
+
:alt:Common Cartridge Export
138
+
139
+
.. Important:: If working with Canvas, each assignment within your LMS still needs to be configured. Refer to the :ref:`system specific instructions <system-specific-directions>` for your LMS system.
0 commit comments