Direct V2 Integration Administrator User Manual

Transcription

1 Guides.turnitin.com Direct V2 Integration Administrator User Manual Downloading the Moodle Direct Code Package LMS Migration Information Installation, Uninstall and Configuration Custom User Roles Troubleshooting Enabling Course Migration Paper Repository Options Glossary 1

2 Direct V2 Integration Administrator User Manual Welcome to the Turnitin Moodle Direct V2 Integration Manual. The Turnitin plugin gives users of the Moodle Learning System the ability to use Turnitin products within the Moodle interface. Turnitin provides plagiarism prevention services, paperless digital grading, class management and peer review tools to educational institutions around the world. Note - The Turnitin plugin is currently compatible with Moodle versions 2.3 to Prerequisite- Turnitin requires all packages that Moodle recommends to install Downloading the Moodle Direct Code Package LMS Migration Information Installation, Uninstall and Configuration Custom User Roles Troubleshooting Enabling Course Migration Paper Repository Options Glossary Create a customizable PDF Book Download a pre-compiled PDF 2

3 Downloading the Moodle Direct Code Package The Turnitin administrator must first configure the Moodle integration before the code packages can be installed. The Turnitin account administrator should log into their Turnitin account at 1. Log in as the Turnitin account administrator on the Turnitin homepage 2. Click on the integrations button for the account. If purchased the 'Unconfigured' button will appear under the integrations column. If an integration has already been configured click on the 'Configured' button and skip to step 6. If the integration has not been configured click on the 'Unconfigured' button 3. Click on Moodle Direct to open up the configuration page. Unconfigured platforms will have an unlit status button. A yellow status button indicates a partially configured integration. A green status button indicates a fully configured integration 3

4 4. Fill out the three required fields: create a shared key containing 8 alphanumerical characters your institution s IP Address or default IP address: an error callback URL or the default url: 5. Click Save to finalize the Moodle Direct configuration. 6. Once the integration has been configured the code packages for Moodle Direct will be available for download 4

5 7. Click on the Download button to the right of the version of Moodle your institution supports. Save the file in an easy to find location on the computer Note: Moodle Direct Version 2 only works with Moodle versions 2.3 to

6 LMS Migration Information When migrating to a new LMS server, upgrading an LMS server, or making any changes to the system which would result in deleting or changing existing LMS IDs (also referred to as database primary keys or PKIDs), you should backup your existing LMS IDs for users, courses and assignments. This information is required by our support team to restore your previous data. Prior to upgrading your system, please contact Turnitin support. 6

7 Installation, Uninstall and Configuration The activity module is installed in the standard way, instructions on how to install an activity module in Moodle can be found here: You must first unzip the plugin that you downloaded before it can be installed. The unzipped file will contain a folder labeled turnitintooltwo and a read me file. You will need to copy the turnitintooltwo folder onto the Moodle server in the /mod directory. Copy the folder into the base of the moodle modules directory into the mod folder. You may have to restart your web server service at this point. You should then navigate to Site Administration > Notifications and follow the on screen instructions. Note: The Turnitin plugin was not developed with support for third party plugins, therefore it cannot be guaranteed to function fully in conjunction with other assessment plugins. Course Migration Block Note: the turnitintooltwo module must be installed before you can use the turnitin block. The block plugin enables non-administrator moodle users to migrate courses from Turnitin to Moodle. To install, all you need to do is copy the /blocks/turnitin directory from the zip file in to your Moodle installations /blocks directory. You should then go to Site Administration > Notifications and follow the on screen instructions. Once the block is installed, it will need to be added to one or more of your Moodle screens. To do this you should switch Moodle to editing mode, in Moodle 2.5 this is done by clicking the Turn editing on button. Once the Add a block box is showing on screen select Turnitin and the block will be added to the screen. The block can be dragged around and positioned wherever you require. 7

8 If you have added a block and the logged-in user is enrolled on a class within your Turnitin account then a link will be displayed detailing how many classes a user has available to migrate. If the user has no courses available to migrate then the block will be hidden. Note: If you have added a block and the logged-in user is enrolled on a class within your Turnitin account then a link will be displayed detailing how many classes a user has available to migrate. If the user has no courses available to migrate then the block will be hidden. Plagiarism Plugin Note: the turnitintooltwo module must be installed before you can use the turnitin plagiarism plugin. The Plagiarism Plugin can be used within the following Moodle modules: Assignments, Forums and Workshops. To install, you need to copy the plagiarism/turnitin directory from the zip file in to your Moodle installations /plagiarism directory. Then go to Site Administration > Notifications and follow the on screen instructions. The plagiarism plugin needs to be enabled before this plugin can be used. You can do this by going to Site Administration > Advanced Features and ticking the Enable plagiarism plugins box before saving. The Plagiarism Plugin will inherit connection settings from the turnitintooltwo module, but you can set default values and whether the plugin is enabled within Moodle modules by going to Site Administration > Plugins > Plagiarism prevention > Turnitin plagiarism plugin. Required PHP settings In order for the module to work correctly you must enable support for curl in your php.ini file. To do this you need to locate the following line in your php.ini file: ;extension=php_curl.dll 8

9 Or ;extension=php_curl.so Remove the semi-colon at the start of the line to activate the php curl extension. Once you remove the semi-colon the web server service needs to be restarted. More information on curl and more detailed instructions for installing it can be found here: If you receive an error informing you 'unable to get local issuer certificate' or 'verify that the CA cert is OK' then you may need to install the CA certificate bundle from the curl repository on GitHub to allow Moodle to read the SSL certificates sent by Turnitin. Required Moodle setting Within config.php, the default setting for dbpersist needs to be: $CFG->dbpersist=false; Configuration Login to Moodle as the Moodle administrator then navigate to /admin to initiate the installation/upgrade process. Once the installation has completed, select Turnitin Assignment within the Plugins Activity modules menu. 9

10 1. Enter the Turnitin Account ID (Required) 2. Enter the Turnitin Secret Key that was set by the Turnitin Administrator (Required) 3. Enter the Turnitin API URL. For UK only Users enter and for all other users enter (Required) The Turnitin sandbox environment is available for testing the integration: 10

11 4. Choose whether to use GradeMark by using the drop down menu. If your account would like to use GradeMark select Yes 5. Select whether to use Anonymous Marking. Anonymous Marking is only available for TurnitinUK users. The default is No 6. Enter a disclaimer/agreement in the text box. Student s will have to check a box agreeing to this statement before submitting a paper (Required) 7. Do not select Yes for the Enable Diagnostic Mode option unless asked to do so by Turnitin support. The default is No 11

12 8. Click on the Save Changes button at the bottom of the screen to save all the entered information Uninstall the Moodle Plugin Uninstalling the Moodle plug in is done by going into the Moodle install directly and directly removing the code. Removing the Turnitin code will keep the tables within Moodle and if you then reinstall the plugin your assignment links will come back into view. However if remove the Turnitin Plugin via the Overview section Moodle will completely forget about the assignments. To recover the assignments once deleted from the Overview section you will have to use the migration tools to import them back in from Turnitin. 12

13 Custom User Roles If you are adding custom user roles within Moodle they should have appropiate capabilities attached to them. For example a Teacher should have different capabilities to Student. Creating a custom user role Creating custom user roles can only be done by the site administrator by navigating to Administration>Site Administration>Users>Permissions>Define Roles 1. To create a new role click 'Add a new role' beneath the Role Table. 13

14 2. On this page you can use a role or archetype as a template for the role you are creating or upload a preset. Doing nothing here will create a blank role for you to configure. Click Continue. 3. Set up the role as you would like it to be set up, adding a short name and full name to the role that will make sense for your workflow. The Context types for the role should be set to Course and Activity Module. 4. Fill in the rest of the settings where appropriate until you reach Activity: Turnitin Assignment 2 14

15 Teacher Settings for a teacher, or anyone who you want to be able to grade student work, should be set as shown in the table below. Add Turnitin Tool Activity Grade Turnitin Tool Assignments Read Turnitin Tool Assignments Submit Turnitin Tool Assignments View Turnitin Tool Assignments Allow Allow Allow Don't Set Allow Once you have finished configuring settings for this role click 'Create this Role' at the bottom of the page. Student Settings for a student should be set as shown in the table below. Add Turnitin Tool Activity Grade Turnitin Tool Assignments Read Turnitin Tool Assignments Submit Turnitin Tool Assignments View Turnitin Tool Assignments Don't Set Don't Set Allow Allow Allow 15

16 Once you have finished configuring settings for this role click 'Create this Role' at the bottom of the page. 16

17 Troubleshooting Connectivity Test To check the communication with Turnitin click on the Test Turnitin Connection link. If you click on the Test Turnitin Connection link, Moodle will try to access Turnitin. If Moodle successfully connects to Turnitin, A green check mark will be displayed next to the Test Turnitin Connection link. If you receive an error message please check the configuration data that was entered and fix any errors. The Show Data Dump and Save Data Dump links are useful for troubleshooting and may be referred to by Turnitin support. The Data dump tracks all Moodle communication with Turnitin. For example, the name and dates of each Turnitin assignment that was created within a course. 17

18 The Unlink Users link can be used to reset links between Turnitin accounts and Moodle accounts. Connectivity Issues If you encounter connectivity issues while using the Turnitin Moodle Direct integration (error: Turnitin API Base URL incorrect or unavailable, or error: Double check your API URL setting) this could be related to a CA certificate being unavailable to curl. Enabling diagnostics mode in the Turnitin plugin and viewing the Turnitin comms logs will identify if this is the case. The Moodle Direct plugin uses the server operating system's implementation of curl. If curl has an out of date (or no) CA certificates, the interaction with Turnitin will fail due to curl performing peer SSL certificate verification and not being able to verify the Turnitin SSL certificate. Until curl some CA certificates were provided, but after no CA certificates have been provided at all. Because of this, the Moodle server administrator would need to ensure that an up to date CA certificate bundle is used. For Debian and RedHat based distributions: CA certificates are distributed in the ca-certificates package. Gentoo servers provide them via the appmisc/ca-certificates ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and curl libraries (libcurl) are up-to-date on your server. 18

19 You will also need to place a file with the Bundle of CA Root Certificates (downloadable fromhttp://curl.haxx.se/ca/cacert.pem) on your webserver and make a curl.cainfo reference to this file in your php.ini. For Windows based servers: Please see point 4 within the link below which describes where to put/how to name the CA certificate bundle. 19

20 Enabling Course Migration The Moodle Direct version 2 Turnitin integration provides the ability for an instructor or an administrator to migrate courses and assignments from their Turnitin account. This ability allows instructors to migrate courses created in previously installed Moodle plugins (i.e. Moodle Basic or Moodle Direct version 1) to be reused or continued in the Moodle version 2 instance. A Moodle administrator can access the functionality by clicking on the Turnitin Course Migration tab in the Turnitin Assignment plugin settings. To make this functionality available to instructors, an administrator must add the Turnitin block to the interface. This will then show on screen how many classes a user is enrolled as an instructor on for the connected Turnitin account. They can click on this link to be taken to the Course Migration section. If a user is not enrolled as an instructor on any classes on the connected Turnitin account then the Turnitin block will be hidden. When a user goes to the Course Migration section they will be met with a table showing them the classes on the connected Turnitin account available for them to migrate to Moodle. 20

21 For more information on course and assignment migration please view the Moodle direct version 2 instructor manual: Moodle_DirectV2_Integration_Instructor_Manual.pdf 21

22 Paper Repository Options The Turnitin administrator can select the paper repository options within their account to either allow instructors to have access to paper repository assignment options or choose to have all student papers submitted to the standard repository. The Turnitin administrator has three options: enable instructor standard repository options, enable instructor expanded repository options, or submit all papers to the standard repository. 1. Login to Turnitin as the administrator and click on the edit icon to the right of the account name 2. Select one of the three options from the paper repository options: enable instructor standard repository options, enable instructor expanded repository options, or submit all papers to the standard repository 3. Click on submit in the bottom left corner of the account modification window to save any changes made 22

23 Note: If submit all papers to the standard repository is selected from the paper repository options pull-down menu, all student papers submitted to the account will be stored in the standard paper repository. If enable instructor standard repository options is chosen instructors will be able to set the assignment option to either store student papers within the standard paper repository or to not store the papers in any repository. If enable instructor expanded repository options is chosen, instructors will be able to set an assignment options to store student papers in the standard paper repository, in the institution paper repository, no repository, or to allow students to choose between the standard paper repository and the institution paper repository. 23

24 Glossary Definitions account account ID administrator consortium account GradeMark homepage instructor A Turnitin account allows instructors to use products purchased from Turnitin The numeric identification number for a specific account or sub-account The controller of a specific Turnitin account. This user type is able to install and configure, activate or deactivate products on an account, change account settings, and add or remove instructors from account access An account type which is the parent for multiple institutional accounts. Consortium accounts do not allow instructors to directly join. Instructors must be added to an institutional or departmental account A digital grading product offered by Turnitin which allows instructors to place comments and QuickMark editing marks on a submission for students to review. This product also includes standardized rubric scorecards and the ability to share QuickMark SM standard editing marks and rubric scorecards between instructors on an account via export or via administrators using the libraries sharing feature of the GradeMark digital grading product the default login page, which is different based on the selected default user type of the user profile being accessed the term used for teachers, tutors, or other student assisting users added or authorized to join as instructors on a specific Turnitin account. 24

25 A single person may be joined to multiple Turnitin accounts or sub-accounts using one user profile or separate user profiles. Users may fill more than one user type role on Turnitin internet archive libraries log in Originality Report PeerMark Plagiarism Prevention Turnitin s web repository includes inactive or no longer available web pages and copies of pages that have changed over time. This allows Turnitin to search against information that is no longer available or which has changed over time. The libraries menu displays the rubrics created by Turnitin or the instructor. For more information about rubrics please view the GradeMark training video or the rubric section of the GradeMark manual available at The act of an authorized user entering the address and personal password created for a user profile to enter Turnitin as the user associated with the address entered he Originality Report is a flexible document that allows students and instructors to review matches between a submitted work and the repositories scanned by Turnitin. Citations, quotations, and bibliographic material are all scanned against Turnitin s repositories to determine an overall similarity percentage as well as specific matches to similar text This product allows students to anonymously or with attribution review submissions made by other students within the course. Students reply to free response and scale questions selected or created by the instructor. Instructors may also comment on the paper using three different commenting tools: inline text tool, highlighter tool, and composition marks. A PeerMark assignment must be based on a normal Turnitin assignment where the student papers are initially submitted This product creates Originality Reports for submissions in assignments on Turnitin. The Originality Reports allow instructors and students to easily determine any problems in citation or referencing and assists instructors in determining the originality of a submitted work 25

26 product proxy server repository shared key student sub-account user profile A specific service, feature, or group of features offered by Turnitin as part of the purchase of a Turnitin license by an educational customer A proxy server is a server that stands between an institution s network and the internet. The proxy server passes requests from the institution s network to places on the internet and returns the responses from the internet to the institution s network A set of information of a specific type or types. In the specific context of the Originality Report provided by Turnitin, repository is used to refer to the type of information the submission was evaluated against for direct matching or high levels of similarity. Available repositories include internet, archived internet, periodical/journal/ publication information, and previous submissions A shared key is the eight digit, alphanumeric code that an institution s Turnitin account administrator creates. See page 3 for instructions on how to create the shared key. The shared key is used to verify the integrity of requests sent from the Institution s Moodle account to the institution s Turnitin account A user type able to enroll in courses created by an instructor user. Student user profiles can only submit to assignments created by an instructor in a class they are joined to or have been authorized to join An account created beneath a parent account. The Turnitin account tree allows for multiple subaccounts created under each parent account. Only individual accounts may not create sub accounts. The number of institutional accounts created beneath a consortium account is determined by license purchases The user profile is a set of user preferences and information associated with a specific ID within Turnitin. Each user profile requires a unique address. A specific address can only be used once within the Turnitin repository. New attempts to create a profile associated with an address currently existing in Turnitin will not succeed 26