Commit d26f3ff4 authored by Kristina Hoeppner's avatar Kristina Hoeppner

external/externalapps: Add assignment submission via LTI

New feature in Mahara 18.10: Be able to submit
portfolios for assessment into an LMS via LTI
(Bug #1789297).
parent 27e6fc33
Subproject commit c45760e1847dc0855c91b5017ab2d3417fd2ab66
Subproject commit 3d8cbb75eba35c278be2ec11bdf3a5c57ff0ef8b
......@@ -252,6 +252,40 @@ You add the details for your Mahara instance in the pop-up window.
#. **Config URL**: Paste the URL of your Mahara instance and add the following to the end of it: ``/module/lti/configxml.php``
#. Click the *Submit* button to finish the setup.
#. Click the *Cancel* button or the *Close* icon |close| to abort the setup.
#. You are taken to the "External Apps" page.
You will need to add a custom parameter in order to use the assignment submission functionality.
.. figure:: /images/administration/external/canvas_manual_configuration_enter.*
:alt: Make changes to the LTI setup
Make changes to the LTI setup
#. Next to the app that you just created, click the *Configure* button.
#. Select the *Edit* option.
Now you can enter the additional parameter without which the connection cannot be established properly.
.. figure:: /images/administration/external/canvas_manual_configuration_edit.*
:alt: Edit the LTI configuration in Canvas
Edit the LTI configuration in Canvas
#. **Name**: The name of your external application.
#. **Consumer Key**: Review or change the consumer key here that you have from your Mahara instance.
#. **Shared Secret**: That is the "Consumer secret" on Mahara. If it has changed, update it here.
#. **Launch URL**: The launch URL is the domain of your Mahara instance with ``/webservice/rest/server.php`` at the end of it.
.. note::
This URL is different from the one that you entered when setting up the connection. That is correct. When you set up the connection, you need to use ``/module/lti/configxml.php`` for Canvas to complete the setup properly.
#. **Domain**: Do not enter anything here.
#. **Privacy**: Leave this set to "Public".
#. **Custom Fields**: Add ``wsfunction=module_lti_launch`` here so that the assignment submission process works.
#. **Description**: You can leave the default text here.
#. Click the *Submit* button to finish the setup.
#. Click the *Cancel* button or the *Close* icon |close| to abort the setup.
#. You are taken to the "External Apps" page.
#. The app appears in your course navigation when you refresh the page.
#. Click the app to be authenticated in your Mahara instance.
......@@ -275,6 +309,8 @@ You can set up Mahara in two different ways for use in Moodle:
* General setup on the site level to make it easier for teachers as they won't require the technical details
* Manual setup on the course level
All screenshots were made with Moodle 3.5.
.. _moodle_preconfigure_mahara:
Preconfigure LTI for all courses to use
......@@ -294,7 +330,6 @@ Go to *Site administration → Plugins → Activity modules → Manage activitie
#. **Shared secret**: Paste the consumer secret from Mahara for the LTI connection that you set up earlier.
#. **Default launch container**: Choose "New window" or "Existing window". Do not choose to embed Mahara. That will not work as you are not allowed to embed Mahara into other websites. Furthermore, it will reduce the space that you have available to work in Mahara.
#. **Secure icon URL**: If you don't want to display the regular Moodle icon for external tools, you can provide a link to your favorite icon. It is recommended that you provide one that sits on your Mahara site and has the dimensions needed by Moodle for best results.
#. **Force SSL**: You can use LTI in Mahara only via SSL (unless you have a test instance). Tick this box to ensure that the connection is done via SSL only. That requires that Moodle also runs over SSL, which is recommended.
#. Click the *Save changes* button to accept the configuration or the *Cancel* button if you want to abort setting up the tool.
.. note::
......@@ -316,6 +351,7 @@ If Mahara was :ref:`already set up as external tool <moodle_preconfigure_mahara>
.. note::
Click the *Show more...* link if you want to make some additional changes.
#. |new in Mahara 18.10| **Privacy**: Tick the option "Accept grades from the tool" if you want to be able to use the activity for the submission of a portfolio.
#. Click the *Save and return to course* button to be taken back to your course page, click the *Save and display* button to launch into Mahara immediately, or click the *Cancel* button to abort adding Mahara to your course as activity.
Configure Mahara in a course activity manually
......@@ -342,13 +378,14 @@ If everyone should have access to the same Mahara site, setting up a preconfigur
#. **Consumer key**: Paste the consumer key from Mahara for the LTI connection that you set up earlier.
#. **Shared secret**: Paste the consumer secret from Mahara for the LTI connection that you set up earlier.
#. **Secure icon URL**: If you don't want to display the regular Moodle icon for external tools, you can provide a link to your favorite icon. It is recommended that you provide one that sits on your Mahara site and has the dimensions needed by Moodle for best results.
#. |new in Mahara 18.10| **Privacy**: Tick the option "Accept grades from the tool" if you want to be able to use the activity for the submission of a portfolio.
#. Click the *Save and return to course* button to be taken back to your course page, click the *Save and display* button to launch into Mahara immediately, or click the *Cancel* button to abort adding Mahara to your course as activity.
.. note::
You do not have to make changes to any of the other settings on the page.
.. index::
pair: LTI setup; Blackboard
pair: LTI setup; Blackboard
.. _lti-blackboard:
......@@ -460,3 +497,158 @@ Add the placement to a course
.. warning::
For security reasons, Mahara prevents being embedded as iframe in another website. However, it seems that there is no setting in Blackboard to allow Mahara to be opened in a new window or on top of the Blackboard site. If that is the case for you, you will need to **disable** a security feature on Mahara, which is not recommended. You can do so by adding ``$cfg->sameoriginframes = false;`` to your ``config.php``.
.. index::
single: New in Mahara 18.10; LTI for assignment submission
.. _lti-assignment:
|new in Mahara 18.10| LTI for assignment submission
-------------------------------------------------------------
You can use the LTI setup to create an activity in an LMS and allow for a portfolio in Mahara to be graded.
.. _lti_assignment_setup_canvas:
Set up an assignment in Canvas
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Prerequisite**: You have set up the connection to Mahara already via the :ref:`setup instructions <canvas>`.
In Canvas you can set up the LTI assignment submission as part of the assignment functionality.
.. figure:: /images/administration/external/canvas_assignment_add.*
:alt: Add an assignment to your Canvas course
Add an assignment to your Canvas course
#. In your course navigation, click the *Assignments* navigation item.
#. On the resulting page, click the *Assignment* button to set up a new assignment.
.. note::
You can add the assignment to a group of assignments as you wish.
.. figure:: /images/administration/external/canvas_assignment_setup.*
:alt: Assignment settings for your LTI activity
Assignment settings for your LTI activity
#. Once you created an assignment, you can change its paramenters, including the assignment name.
#. Provide a description or task for the assignment.
#. **Points**: Enter "100" here as LTI expects a scale from 0 to 100.
#. **Display Grade as**: Decide how you want to display the final grade for the assignment.
#. **Submission type**: Select "External Tool" from the drop-down menu.
#. Click the *Find* button to see all external tools that are available in your course and select the Mahara one. Click the *Save* button to confirm your selection.
#. **Load This Tool In A New Tab**: Tick this check box or Mahara would not load due to its security settings.
#. Click the *Save* button if you want to save an preview your assignment or click the *Save & Publish* button if you are ready to take the assignment live. Click the *Cancel* button to abort setting up the activity.
#. Click the activity name or button to finalize the :ref:`assessment settings <lti_assessment_settings>`. Learners are not able to use the activity until these settings have been saved.
.. _lti_assignment_setup_moodle:
Set up an assignment in Moodle
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Select to add the *External Tool* activity in Moodle.
#. During the :ref:`setup <moodle>` ensure that you tick the check box next to "Accept grades from the tool" under "Privacy". If you don't tick this check box, you can only authenticate to Mahara but not select a portfolio for submission.
#. Click the activity name to finalize the :ref:`assessment settings <lti_assessment_settings>`. Learners are not able to use the activity until these settings have been saved.
.. _lti_assessment_settings:
Confirm assessment settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Before any learners can use the activity, you need to confirm the activity settings as a teacher.
.. figure:: /images/administration/external/assessment_settings.*
:alt: Set the submission criteria
Set the submission criteria
#. **Email tutors on student submission**: Set this to "Yes" if course tutors / teachers / assessors shall be informed when a submission has been made.
#. **Keep portfolio locked after grading**: Set this to "Yes" if you don't want learners to make any changes to their portfolio once grading is done. The default setting is "No".
.. note::
This option will keep the portfolio locked from editing, and learners can't delete any of the submitted artefacts or make changes to them or delete the portfolio itself from their account. They can still make a copy or change artefacts that are not affected by the locking.
#. **Archive when graded**: If you want or need to keep a copy of the graded portfolio to comply with assessment regulations, you can set this option to "Yes". An archive is made automatically after you finished grading and placed on the Mahara server. Administrators can view the archives in the ":ref:`Archived submissions <archived_submissions>`", and a server administrator can download all archives from a folder within the content file structure of Mahara.
.. warning::
SmartEvidence collections cannot yet be archived properly as Leap2A.
#. Click the *Save and allow submissions* button to confirm the settings and allow your learners to submit their portfolios.
.. note::
You can change the assignment settings until the first learner submitted their portfolio. After that, they are locked in.
Currently, learners cannot re-submit portfolios to the same activity once you've completed grading. They can also not make any changes to the portfolio while it is being assessed.
Submit a portfolio as learner
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As a learner, you can submit any of your portfolios to an assignment in your learning management system (LMS).
.. note::
Any portfolio you submit is locked. Depending on the assignment settings, you may be able to edit the portfolio again after grading.
.. figure:: /images/administration/external/submit_portfolio.*
:alt: Submit a portfolio for assessment via your LMS
Submit a portfolio for assessment via your LMS
#. Click the link to the assignment in your LMS. Mahara opens either in a new tab or embedded as iframe depending on the assignment settings.
#. If you don't already have a portfolio that you can submit for this particular assignment, click the *create one* link. You are taken to *Pages and collections* where you can create a new portfolio. Once you are finished, click the assignment link in your LMS again to be taken to the correct submission screen.
#. If you do have a portfolio to submit, select it from the drop-down menu. You can select an entire collection or a page when it is not part of a collection.
#. Click the *Submit* button to confirm your choice.
.. note::
By clicking the *Submit* button, your portfolio is locked from editing.
#. You receive a confirmation on screen that lets you know when you submitted the portfolio.
Once your portfolio has been assessed and a grade given, you can see the result in Mahara after having clicked on the assignment link in the LMS.
.. figure:: /images/administration/external/assessed_portfolio.*
:alt: View grade in Mahara
View grade in Mahara
#. Review when you submitted your portfolio.
#. View the number of points you received on your portfolio.
#. View who assessed your portfolio.
#. Shows the time when the portfolio was assessed.
.. note::
Currently, you cannot re-submit a portfolio to the same assignment in the LMS.
Assess a portfolio as teacher
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once learners have submitted portfolios for assessment, as a teacher, you can click the link to the assignment in the LMS and be taken to Mahara, where you see all the submitted portfolios.
.. figure:: /images/administration/external/teacher_to_grade.*
:alt: View portfolios that require assessment
View portfolios that require assessment
#. **First name**: The first name of the portfolio author.
#. **Last name**: The last name of the portfolio author.
#. **Portfolio title**: Title of the submitted portfolio.
#. **Time submitted**: Time when the author submitted their portfolio.
#. Click the *Grade* link to be taken to the portfolio itself and give it a grade.
#. **Grade**: Grade given for this portfolio out of 100 points.
#. **Time graded**: Time when the grade was submitted.
#. **Graded by**: Teacher who graded the portfolio.
When you click the *Grade* link, you are taken to the portfolio and can review it. As usual, you can leave comments on the content where available and on a page itself. Once you are ready to give the grade, you can select it above the comments section.
.. figure:: /images/administration/external/teacher_grading.*
:alt: Grade a portfolio
Grade a portfolio
#. The course title from the LMS is listed.
#. The name of the assignment is displayed.
#. The time when the learner submitted the portfolio is shown.
#. **Grade**: Select a grade between 0 and 100 points from the drop-down menu.
#. Click the *Submit* button to lock the grade in. You cannot revoke your decision.
#. The grade is also entered into the gradebook in Moodle.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment