Skip to content

Commit 46a3283

Browse files
authored
moodle update (#458)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reworked Moodle integration guide with reorganized, streamlined setup and onboarding steps for clarity * Emphasized LTI 1.3 Dynamic Registration and simplified activation/usage flows in Moodle * Removed legacy/out-of-scope subsections and replaced with concise, focused guidance * Updated and added visuals (screenshots, captions, alignment/size) and clarified deep-linking/configuration steps * Added Brightspace to the list of supported LMS references and updated navigation pointers in integration docs <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 1659145 commit 46a3283

8 files changed

Lines changed: 45 additions & 111 deletions

File tree

source/img/LTI13dynregactivate.png

145 KB
Loading

source/img/LTI13dynregshow.png

71.9 KB
Loading
174 KB
Loading

source/img/editmodemoodle.png

7.54 KB
Loading

source/img/moodlepastedynreg.png

112 KB
Loading

source/instructors/admin/integration/intro.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,13 @@ Integrating with your LMS system (Canvas etc.)
2020
lti-keys-and-urls-information
2121
lti-course-copy
2222
commoncartridge
23+
moodle
2324
lti1-3
2425
lti1-3Blackboard
2526
lti1-3BS-D2L
2627
lti1-3Canvas
2728
lti1-3DynReg
29+
2830

2931
Learning Tools Interoperability (LTI) is a standard for passing user, organization, and course information between learning management systems (tool consumers) and learning tools and tool providers, such as Codio.
3032

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

Lines changed: 41 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,10 @@
66
Moodle
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. 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.
10-
11-
Setup and Configuration
12-
------------------------
13-
149

1510
.. important::
1611
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.
1712

18-
**Video: Connect Moodle to Codio using the LTI Integration URL**
19-
20-
.. raw:: html
21-
22-
<script src="https://fast.wistia.com/embed/medias/awib5ehvj0.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_awib5ehvj0 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/awib5ehvj0/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>
23-
24-
Common Cartridge
25-
----------------
26-
27-
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.
28-
Then in the Moodle course you have created:
29-
30-
- Go to the course settings and **Restore**.
31-
- Select the **.ismcc** to upload it and proceed to restore.
32-
- **Restore into this Course**.
33-
- Proceed through the steps.
34-
35-
36-
.. note::
37-
Restore is required as Moodle currently does not support importing of **.imscc** files.
38-
39-
40-
41-
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.
42-
43-
Authentication and Account Creation
44-
------------------------------------
45-
46-
To add students/teachers see :ref:`Users account creation <lms-users>`
47-
48-
49-
50-
5113

5214

5315
LTI 1.3 Dynamic Registration
@@ -59,99 +21,71 @@ Dynamic Registration simplifies the setup process by automatically sharing confi
5921
Adding the Tool in Moodle
6022
~~~~~~~~~~~~~~~~~~~~~~~~~
6123

62-
.. image:: /img/lti/moodlepastedynreg.png
24+
.. image:: /img/moodlepastedynreg.png
6325
:alt: Where you paste your Dynamic Registration URL in Moodle
64-
:align: right
6526
:width: 500px
66-
:class: img-responsive
67-
68-
1. Navigate to the **Manage Tools** section of your Site Administration and select the Plugins tab.
69-
2. Paste the value you copied in the Tool URL field and click **Add LTI Advantage**.
70-
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.
71-
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.
72-
5. The tool will appear at the bottom of the screen, click the Activate button.
27+
28+
1. Log in to your Codio account and follow the steps on this page to retrieve your :ref:`Dynamic Registration <lti1-3DynReg>` URL.
29+
2. In a new tab go to Moodle.
30+
3. Navigate to the **Manage Tools** section of your Site Administration and select the Plugins tab.
31+
4. Paste the Dynamic Registration URL and click **Add LTI Advantage**.
32+
5. 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.
33+
6. 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.
34+
7. The tool will appear at the bottom of the screen, click the Activate button.
7335

7436

37+
.. image:: /img/LTI13dynregactivate.png
38+
:alt: Where you activate the tool
39+
:width: 500px
7540

76-
Activating the Tool You are Creating
77-
78-
.. image:: /img/lti/LTI13dynregactivate.png
79-
:alt: Where you activate the tool
80-
81-
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.
41+
Return to Codio and refresh the **Integrations** page. You will see the integration you created in the bottom section of **LTI 1.3 Configurations** if everything has been set up properly.
8242

8343
Using the Tool in Moodle
8444
~~~~~~~~~~~~~~~~~~~~~~~~
8545

86-
.. image:: /img/lti/LTI13dynregshow.png
87-
:alt: Toggling on show in activity chooser for the Codio tool.
88-
:align: right
89-
:width: 500px
90-
:class: img-responsive
91-
9246
1. Navigate to your **My Courses** page and select the course you want to use.
93-
2. Turn on **Edit Mode**.
47+
2. Click the **More** tab.
9448
3. From the **More** dropdown select **LTI External Tools**.
9549
4. You will see the Codio tool, toggle **Show in activity chooser** on.
96-
5. Go to your course and click on **Add an activity or resource**.
97-
6. Click on the **All** tab to show all the tools and select Codio.
98-
7. Click **Select Content** and that will bring up your list of Codio courses, select the course and assignment you want to connect.
99-
100-
101-
102-
LTI Version 1.3
103-
----------------
104-
105-
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.
106-
107-
108-
For more information, see `Learning Tools Interoperability Core Specification <https://www.imsglobal.org/spec/lti/v1p3/>`__
109-
110-
The deep linking url is : ``https://apollo.codio.com/lti/resource_selection``
111-
112-
11350

114-
How to Configure lti1.3 Tool in Moodle Manually
115-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116-
117-
.. raw:: html
118-
119-
<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>
120-
121-
122-
123-
124-
Connecting/Mapping Assignments in Moodle
125-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51+
.. image:: /img/LTI13dynregshow.png
52+
:alt: Toggling on show in activity chooser for the Codio tool.
53+
:width: 600px
54+
:class: img-responsive
12655

127-
There are a number of ways you can connect/map assignments. Check out the following videos to see the option that best suits you.
56+
5. Go to your course and toggle **Edit Mode** on in the top-right corner of the screen.
12857

129-
How to Connect Assignment by lti Integration url
130-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58+
.. image:: /img/editmodemoodle.png
59+
:alt: Toggling on edit mode.
60+
:width: 200px
13161

132-
.. raw:: html
62+
6. Navigate to the module where you want to add an activity, then click the plus icon.
63+
7. Click **Add an activity or resource**.
64+
8. Click on the **All** tab to show all the tools and select Codio.
65+
9. Click **Add**.
66+
10. Click **Select Content** to open your Codio courses, then choose the course and assignment you want to connect.
13367

134-
<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>
13568

136-
How to Connect Assignment by Resource Selection Preview
137-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69+
Common Cartridge
70+
----------------
13871

139-
.. raw:: html
72+
If you are using a Common Cartridge file, you’ll first need to configure an External Tool in Moodle using your organization’s :ref:`LTI Keys and URLs <lti-keys-and-urls-information>`.
14073

141-
<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>
74+
Once the External Tool is set up, you can proceed with importing your :ref:`Common Cartridge <common-cartridge>` file by following the instructions provided on that same page.
14275

143-
How to Connect Assignment by Endpoint url
144-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76+
Then in the Moodle course you have created:
14577

146-
.. raw:: html
78+
1. Go to your course and click the **More** tab.
79+
2. From the **More** dropdown select **Course reuse**.
80+
3. Click **Restore**.
81+
4. Select the **.imscc** to upload it and proceed to restore.
82+
5. Click **Restore**.
83+
6. Proceed through the steps.
14784

148-
<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>
14985

150-
How to Connect Assignment with Custom Param
151-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86+
.. note::
87+
Restore is required as Moodle currently does not support importing of **.imscc** files.
15288

153-
.. raw:: html
89+
To confirm your setup, 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.
15490

155-
<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>
15691

157-
If you require any assistance, please don't hesitate to :ref:`contact us <codio-support>`

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ LTI 1.3 Dynamic Registration
88

99

1010
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. Please refer to the appropriate LMS page for detailed platform-specific steps.
11-
1211
- :ref:`Moodle <moodle>`
1312
- :ref:`Canvas <lti1-3Canvas>`
1413
- :ref:`Blackboard <lti1-3Blackboard>`
@@ -20,10 +19,9 @@ Access LTI Integration Settings in Codio
2019
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2120

2221

23-
.. image:: /img/lti/codiolti13settings.png
22+
.. image:: /img/codiolti13settingsDyReg.png
2423
:alt: LTI 1.3 settings in Codio
25-
:align: right
26-
:width: 350px
24+
:width: 450px
2725
:class: img-responsive
2826

2927

0 commit comments

Comments
 (0)