Skip to content

Commit f812f07

Browse files
authored
1 parent 1b79403 commit f812f07

1 file changed

Lines changed: 147 additions & 13 deletions

File tree

  • source/instructors/admin/integration/lms-systems

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

Lines changed: 147 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,27 @@ Moodle
88

99
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. Moodle added support for LTI™ apps in version 2.2. The `following page <https://docs.moodle.org/32/en/External_tool_settings>`__ explains how to set up external apps in Moodle.
1010

11-
Setup and configuration
12-
-----------------------
11+
Setup and Configuration
12+
------------------------
13+
14+
.. raw:: html
15+
16+
<html lang="en">
17+
<head>
18+
<meta charset="UTF-8">
19+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
20+
<title>Important Notice</title>
21+
</head>
22+
<body style="font-family: Arial, sans-serif; padding: 20px;">
23+
<div style="margin: 0 0 10px 20px; padding: 10px; background: #ffffff; border: 5px solid #2baeff;">
24+
<div style="background: #e6f5ff; padding: 5px 8px; margin: -10px -10px 8px -10px; border-radius: 2px;">
25+
<span style="color: #2baeff; font-weight: bold;">!</span> <strong>Important</strong>
26+
</div>
27+
Codio needs the User Role, Email Address and Name of the Moodle user in order to work. It is important that you access the LTI security settings and ensure that these three fields are enabled. If they are not available, contact Moodle support who can help you enable this. If enabled after you have mapped Codio content to Moodle, you may need to re publish for the changes to be implemented.
28+
</div>
29+
</body>
30+
</html>
1331

14-
.. Important:: Codio needs the User Role, Email Address and Name of the Moodle user in order to work. It is important that you access the LTI security settings and ensure that these three fields are always enabled. If they are not available, contact Moodle support who can help you enable this. If enabled after you have mapped Codio content to Moodle, you may need to re publish for the changes to be implemented
1532

1633
**Video: Connect Moodle to Codio using the LTI Integration URL**
1734

@@ -22,19 +39,136 @@ Setup and configuration
2239
Common Cartridge
2340
----------------
2441

25-
If using the Common Cartridge file you should first set up an External Tool in Moodle with the :ref:`LTI Key's and URL's <lti-keys-and-urls-information>` for your organisation.
26-
When done then in the Moodle course you have created:
42+
If using the Common Cartridge file you should first set up an External Tool in Moodle with the :ref:`LTI Key's and URL's <lti-keys-and-urls-information>` for your organization.
43+
Then in the Moodle course you have created:
2744

28-
- go to the course settings and **Restore**,
29-
- select the **.ismcc** to upload it and proceed to restore,
30-
- and **Restore into this Course**.
45+
- Go to the course settings and **Restore**.
46+
- Select the **.ismcc** to upload it and proceed to restore.
47+
- **Restore into this Course**.
3148
- Proceed through the steps.
3249

33-
.. Note:: It is Restore that is required as Moodle currently does not support importing of **.imscc** files
3450

35-
When completed, you can check all is correct by then selecting any of the assignments listed in Moodle. If all OK you will be taken to the **Teacher** view of the assignment in Codio
51+
.. raw:: html
52+
53+
<div style= " margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
54+
<strong>Note:</strong> Restore is required as Moodle currently does not support importing of <strong>.imscc </strong> files.
55+
</div>
56+
57+
58+
To confirm your setup, just click on any assignment available in Moodle. If all configurations are correct, you will be redirected straight to the Teacher view of that assignment in Codio.
59+
60+
Authentication and Account Creation
61+
------------------------------------
62+
63+
To add students/teachers see :ref:`Users account creation <lms-users>`
64+
65+
66+
67+
68+
69+
70+
LTI 1.3 Dynamic Registration
71+
-----------------------------
72+
73+
Dynamic Registration simplifies the setup process by automatically sharing configuration information between Tools and LMS systems. For LMS platforms that are compatible with this standard, you can enable it by following these steps. For more information on how to find the values in Codio please visit :ref:`Dynamic Registration <lti1-3DynReg>` .
74+
75+
76+
Adding the Tool in Moodle
77+
~~~~~~~~~~~~~~~~~~~~~~~~~
78+
79+
.. image:: /img/lti/moodlepastedynreg.png
80+
:alt: Where you paste your Dynamic Registration URL in Moodle
81+
:align: right
82+
:width: 500px
83+
:class: img-responsive
84+
85+
1. Navigate to the **Manage Tools** section of your Site Administration and select the Plugins tab.
86+
2. Paste the value you copied in the Tool URL field and click **Add LTI Advantage**.
87+
3. It will present you with the Codio Organizations you are associated with, likely just one choice, but if there is more than one, select the organization you want to associate this tool with and click continue. It should be the organization that contains the courses you want to connect to the LMS system.
88+
4. It will ask you to confirm that you want to register Codio as an external tool in the organization you selected. Click **Yes**. You will receive a confirmation from Codio that the action was completed.
89+
5. The tool will appear at the bottom of the screen, click the Activate button.
90+
91+
92+
93+
Activating the Tool You are Creating
94+
95+
.. image:: /img/lti/LTI13dynregactivate.png
96+
:alt: Where you activate the tool
97+
98+
Return to Codio and refresh the **Integrations** page, you will see the integration you created in the bottom section if everything has been set up properly.
99+
100+
Using the Tool in Moodle
101+
~~~~~~~~~~~~~~~~~~~~~~~~
102+
103+
.. image:: /img/lti/LTI13dynregshow.png
104+
:alt: Toggling on show in activity chooser for the Codio tool.
105+
:align: right
106+
:width: 500px
107+
:class: img-responsive
108+
109+
1. Navigate to your **My Courses** page and select the course you want to use.
110+
2. Turn on **Edit Mode**.
111+
3. From the **More** dropdown select **LTI External Tools**.
112+
4. You will see the Codio tool, toggle **Show in activity chooser** on.
113+
5. Go to your course and click on **Add an activity or resource**.
114+
6. Click on the **All** tab to show all the tools and select Codio.
115+
7. Click **Select Content** and that will bring up your list of Codio courses, select the course and assignment you want to connect.
116+
117+
118+
119+
LTI Version 1.3
120+
----------------
121+
122+
LTI version 1.3 improves upon version [LTI-1.1] by moving away from the use of OAuth 1.0a-style signing for authentication and towards a new security model, using OpenID Connect, signed JWTs, and OAuth2.0 workflows for authentication.
123+
124+
125+
For more information, see `Learning Tools Interoperability Core Specification <https://www.imsglobal.org/spec/lti/v1p3/>`__
126+
127+
The deep linking url is : ``https://apollo.codio.com/lti/resource_selection``
128+
129+
130+
131+
How to Configure lti1.3 Tool in Moodle Manually
132+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133+
134+
.. raw:: html
135+
136+
<script src="https://fast.wistia.com/embed/medias/24smkegju4.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_24smkegju4 seo=false videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/24smkegju4/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
137+
138+
139+
140+
141+
Connecting/Mapping Assignments in Moodle
142+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143+
144+
There are a number of ways you can connect/map assignments. Check out the following videos to see the option that best suits you.
145+
146+
How to Connect Assignment by lti Integration url
147+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148+
149+
.. raw:: html
150+
151+
<script src="https://fast.wistia.com/embed/medias/u6r8zfk9nc.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_u6r8zfk9nc seo=false videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/u6r8zfk9nc/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
152+
153+
How to Connect Assignment by Resource Selection Preview
154+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155+
156+
.. raw:: html
157+
158+
<script src="https://fast.wistia.com/embed/medias/e7jx2wdpyq.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_e7jx2wdpyq seo=false videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/e7jx2wdpyq/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
159+
160+
How to Connect Assignment by Endpoint url
161+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162+
163+
.. raw:: html
164+
165+
<script src="https://fast.wistia.com/embed/medias/g10ydg4cs2.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_g10ydg4cs2 seo=false videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/g10ydg4cs2/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
166+
167+
How to Connect Assignment with Custom Param
168+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169+
170+
.. raw:: html
36171

37-
Authentication and account creation
38-
-----------------------------------
172+
<script src="https://fast.wistia.com/embed/medias/493c2q31t5.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_493c2q31t5 seo=false videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/493c2q31t5/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div>
39173

40-
To add students/teachers see :ref:`Users account creation <lms-users>`
174+
If you require any assistance, please don't hesitate to :ref:`contact us <codio-support>`

0 commit comments

Comments
 (0)