This page is for Moodle System Admins of customers using Inspera Originality and want to configure the corresponding Moodle Plugin.

If you want to know more about the plugin's purpose, please check out this page.

Obtaining the Plugin

The IO Moodle Plugin is not yet available in the Moodle Plugin Directory, in order to obtain it please reach out to your Account Manager.

Once you have the zip file for the plugin you need to install it in your Moodle system.

When following these instructions please be aware that Inspera has no control about changes to Moodle and so your actual flow may slightly differ from the one described here.

Installing the Plugin

In order to install the plugin, they system admin needs to go to Site Administrator > Plugins and select Install Plugins under the Plugins section.

Then, upload the zip into the Zip package field and click Install plugin from the ZIP file.

TBD

Configuring the Plugin

After the plugin is installed, it needs to be configured.

In order to do that go to the list of Additional Plugins that are installed: Site Administrator > Plugins > Plugins Overview under the Plugins section > Additional Plugins. 

Identify the Inspera Originality Plugin and click on Settings.

You will find three tabs:

• Connection Settings: to configure the connection to IO
• Default Settings: to configure the default values for the different report settings
• Submissions Management: to manage all the documents submitted to IO

1. This is where the connection to IO will be configured. 

   

   In order to successfully connect to IO, please follow the following steps.

   1. Insert the Base API URL to connect to IO.

      To know your base api url, please reach out to your account manager or our support team.

   2. Insert the Client ID.

      To know your client ID, please reach out to your account manager or our support team.

   3. Insert the Institution ID.

      To know your institution ID, please reach out to your account manager or our support team.

   4. Enable the Originality check.

      This setting allows you to control whether the originality plugin is available to Teachers without having to uninstall it.

   5. Select the types of activities under which the plugin should be available.

   6. Save the changes.

      If there's an issue with steps 1-3 an error will occur when saving, please check the values and retry.

2. In this tab, the system admin can define:

   • The default value for each of the settings available for teachers
     • These are the values to be used to generate the IO report if the teacher does not change them
     • For a better understanding of each of these settings, please check out this page.
     • The setting "When should the file be submitted" has two possible values: "When file is first uploaded" and "When the student sends for marking". The second option is only available for tests in which the student needs to Click Submit under the submissions options. As such, even if "When the student sends for marking" is selected as the default, if the student does not have to Click Submit on the assignment, the selected and only available option will be "When file is first uploaded".
       • This setting is only available for assignments. In quizes the files are submitted when the attempt is finalized.
   • Hidden Settings: defines which settings should be completely hidden from the teachers
     • Use this when there are settings of which the teachers should not be aware, for instance to avoid confusion
     • The values defined as default will be used
   • Locked Settings: defines which settings can not be edited by the teachers when configuring an activity.
     • Use this when there are settings that you do not want your teachers to change but you still want them to have visibility over the value that is set
     • The values defined as default will be used
     • These will appear under the Show More option
   • Advanced Settings: defines which settings should be visible to the teachers but under the "show more" expandable section
     • Use this when you want to keep the teachers' view clean by only presenting the most important settings, the settings selected here will be for teachers in need of more advanced settings
     • Teachers will still be able to see these setting under the Show More option and they will be able to edit them

   

   The teacher will be able to edit settings that are visible and not locked.

   If a setting is selected in both Hidden and Advanced, Hidden will take precedence, i.e., the setting will not be shown to the teachers. 

   After the defaults are configured, click Save Changes to save your configured defaults. 

   

3. In this tab, the system admin can see a list of all the files that were submitted to Inspera Originality and failed or that should have been submitted but were not due to an error. Submissions older than 6 months will not be listed. By default, the most recent submission will appear at the top. 

   

   In section 1, the system admin can filter the submissions they wish to list.

   In section 2, all the submissions that match the filter will be listed. If no filter is applied, then all the submissions that ended in error will be listed.

   The column Originality status displays the status of the submission. It can be:

   • Error: an error occurred on Moodle side that prevented its submission to IO
   • External Error: there was an error while generating the report

   The column Description displays the cause for failure.

   The column Action lists the actions that can be taken for that submission. The available actions depend on the status of the submission:

   • Delete: deletes the IO submission from Moodle
     • It does not delete the student submission from Moodle or the report from IO, just the submission from this list
   • Resubmit: submits the file again to IO

   Actions over several files

   The system admin can select more than one submission and delete or resubmit all the submissions at once:

   1. Select the submissions
   2. Delete Selected Files -> this will delete all the selected submissions (in this case the ones with ID 117 and 116)
   3. Resubmit Selected Files -> this will resubmit all the selected submissions (in this case the ones with ID 117 and 116)
   4. This will select or unselect all the submissions

   

Generate all Reports at the activity level

When accessing an activity, there is a button at the top right corner that triggers the generation of all missing reports, i.e., it will send to IO all the submissions of that activity that do not have a report, either because it was not yet sent to IO or because an error occurred in the previous report generation attempt.

More details on this behaviour can be found in the teacher documentation.

The access to this button is controlled by the role of the user. To add it to a specific role, go to Site Administration -> Users -> Define roles -> edit the role you want (or create a new one) -> Scroll to the section belonging to Plagiarism Plugin: Inspera and enable the "Generate missing reports" capability.

Minimum Required Version

The minimum and recommended version to run the plugin is Moodle 4.5.