Guides.turnitin.com

Download / Installation

Configuring the Sakai integration within Turnitin

Scheduled Tasks (Quartz Tasks)

Creating an Assignment with Turnitin in Sakai

Multiple Instructors

Paper Repository Options

Glossary

1

Download / Installation

Turnitin

To download the Turnitin integration, use SVN to checkout the Turnitin integrationto your Sakai repository.

E.g. Create a folder called turnitin-129 in your Sakai repository, go into that folder and checkout: https://source.sakaiproject.org/contrib/turnitin/branches/TII-129/contentreview-impl/

While in that folder run the following command:

mvn clean install -Dmaven.test.skip=true sakai:deploy

Assignment 2

To download the Assignment 2 update, use SVN to check out the Assignment 2 module toyour Sakai repository.E.g. Create a folder called assignment2-773 in your Sakai repository, go into that folder and check out:

svn co https://source.sakaiproject.org/cont...ches/ASNN-773/

Configuration

To configure the Turnitin integration within Sakai you must edit your Sakai properties file, example:

2

vim /opt/tomcat/sakai/sakai.properties

The following properties must be added to the Sakai properties file (sakai.properties):

turnitin.apiURL=https://api.turnitin.com/api.asp? (or for UK users: https://submit.ac.uk/api.asp?)

turnitin.aid=12345 (Please enter the actual account ID for your institution)

Note: There is no need to set a value for SAID, simply ensure the Sakai integration is enabled inthe Turnitin Integrations Dashboard

turnitin.secretKey=testing1 (Please enter the Shared Key for your institution as entered in theTurnitin Integrations Dashboard)

turnitin.enable.assignment2=true (Only necessary if you’re using Assignment2)

turnitin.useSourceParameter=true assignment.useContentReview=true

The following property should be temporarily set in sakai.properties. After the application has started, itmay be set back to false.

auto.ddl=true

Optional properties that may be added to the Sakai properties file (sakai.properties):

turnitin.useGrademark=true

Note: Grades are checked once per user session per assignment. Any grades that have beenadded since the instructor last entered the assignment will be retrieved from Turnitin and writtento the associated gradebook. GradeMark will not work correctly if the assignment has beenassociated with the gradebook of another assignment. GradeMark will only run ifturnitin.useGrademark=true has been added to Sakai.properties.

turnitin.migrate=true

If you are using an older version of the Turnitin integration then it’s likely that all of your

3

communications to Turnitin are being made via a pseudo ‘default instructor’. Migration moves existingclasses from the Open API and will allow you to use actual instructors to create and control Turnitinassignments.

Note: If using linux run tail -fn 1000 /opt/tomcat/logs/catalina.out | grep –A20 -B10 ‘fid = 99’ onserver startup to check if the operation completed successfully. If successful removeturnitin.migrate=true from sakai.properties.

Proxy for turnitin (optional) - The proxy must not require authentication.

turnitin.proxyHost=

turnitin.proxyPort=

Send or don’t send notifications to students, this includes user creation/paper submission emails.

turnitin.sendnotifations=true

Logging settings

log.config.count = 2

log.config.1 = DEBUG.org.sakaiproject.contentreview.impl.turnitin

log.config.2 = DEBUG.org.sakaiproject.turnitin.util.TurnitinAPIUtil.apicalltrace

4

Configuring the Sakai integration within Turnitin

The Turnitin administrator must first configure the Sakai integration within Turnitin before the Turnitinintegration can be configured within Sakai. The account administrator should log into their Turnitinaccount at http://www.turnitin.com or http://turnitinuk.com for TurnitinUK users.

1. Log in as the Turnitin account administrator at the Turnitin homepage http://www.turnitin.comor http://turnitinuk.com for TurnitinUK users

2. Click on the integrations button for the account. If purchased the unconfigured button willappear under the integrations column. If the integration has already been configured click onthe configured button and skip to step 6. If the integration has not been configured click on theunconfigured button

5

3. Click on Sakai to open up the configuration page. Unconfigured platforms will have an unlitstatus button. Yellow status buttons indicates a partially configured integration. The green statusbutton indicates a fully configured integration

4. Fill out the three required fields:

create a shared key containing 8 alphanumerical characters

your institution’s IP Address or default IP address: 255.255.255.255

an error callback URL or the default url: https://www.turnitin.com/api_error.asp orhttps://submit.ac.uk/api_error.asp for TurnitinUK users

Tip: The shared key is used during the plug-in installation process within Sakai. We recommendmaking a note of the secret key once it has been entered for quick reference

5. Fill out the required technical contact fields

6

6. Click Save to finalize the Sakai Direct

The Turnitin Account ID and the Shared Key are used within Sakai to verify and install the Turnitinintegration.

7

Scheduled Tasks (Quartz Tasks)

Quartz tasks must be set up within Sakai in order for the Turnitin integration to work.

1. Log into Sakai as an administrator and click on the Administrator Workspace

2. Click on the Job Scheduler link in the sidebar

3. Click on the Jobs link

8

4. Click on the New Job link to create the following three jobs by selecting them from the Typedrop down menu on the

Create Job page:

Process Content Review Queue

Process Content Review Reports

Process Turnitin Content Review

Roster Sync

Note: You may enter any name of your choice into the Job Name field when creating the new jobs

5. Once the three jobs have been created they will appear on the jobs page. Click on the Triggerslink for each job.

Click New Trigger and enter a name into the Trigger Name field (your choice) and for the CronExpression field the following values are recommended for the three jobs:

Process Content Review Queue: 0 0/5 * * * ?

Process Content Review Reports: 0 0/5 * * * ?

Process Turnitin Content Review Roster Sync: 0 0/1 * * * ?

9

10

Creating an Assignment with Turnitin in Sakai

Once the Turnitin integration has been properly configured assignments can be created with Turnitinactive. To create an assignment within Sakai, navigate to the desired site and click the Assignments (orAssignment2) link in the side menu.

1. Click on the Assignments link within the class drop down menu

2. Click the Add link

3. Enter the required assignment details (Title, Dates, Description) etc.

11

4. The Student Submissions field must be set to Attachments only as the integration does notcurrently accept text submissions

5. If desired, set the number of submissions you wish to allow the user to make, ranging from 1 tounlimited. (Please note that once work has been resubmitted the original is no longer accessible).

Note regarding Assignments ‘1’: When a resubmission is made, the original Originality reportlink for that entryremains in the submissions inbox until the resubmission has been fully processed. Clicking on thislink during that time willresult in an error. This behaviour does not occur in Assignments ‘2’, which properly shows thegreyed out link.

6. Click the Use Turnitin checkbox

12

7. There are three options for the Submit papers to the following repository: None, Standard PaperRepository, and Institution Paper Repository.

Note: Only select Institution Paper Repository if that option is enabled in your Turnitin Account

8. Select whether to generate originality reports Immediately or On Due Date for the Generateoriginality reports option

9. Check the Allow students to view report to allow students to view the Turnitin Originality Reportgenerated for student submissions

13

10. Select which repositories assignment submissions will be searched against from the Checkoriginality against option

11. Select whether to turn on e-rater grammar checking for the assignment. If e-rater is turned onadjust the following options accordingly:

ETS Handbook

e-rater Dictionary

e-rater Categories

14

Multiple Instructors

Allows instructors who have not created a Turnitin assignment on Sakai to access the Turnitin DocumentViewer. (Due to not having been enrolled on the Turnitin class). Once triggered all currently enrolledinstructors will be enrolled on the class in Turnitin. This can be triggered by going to Site info andclicking the ‘Update Participants’ button.

15

Paper Repository Options

The Turnitin administrator can select the paper repository options within their account to either allowinstructors to have access to paper repository assignment options or choose to have all student paperssubmitted to the standard repository. The Turnitin administrator has three options: enable instructorstandard repository options, enable instructor expanded repository options, or submit all papers to thestandard repository.

1. Login to Turnitin as the administrator and click on the edit icon

2. Select one of the three options from the paper repository options: enable instructor standardrepository options, enable instructor expanded repository options, or submit all papers tothe standard repository

3. Click on submit in the bottom left corner of the account modification window to save anychanges made

16

Note: If submit all papers to the standard repository is selected from the paper repository optionspull-down menu, all student papers submitted to the account will be stored in the standard paperrepository. If enable instructor standard repository options is chosen instructors will be able to setthe assignment option to either store student papers within the standard paper repository or to notstore 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 paperrepository, in the institution paper repository, no repository, or to allow students to choosebetween the standard paper repository and the institution paper repository.

17

Glossary

Definitions

account A Turnitin account allows instructors to useproducts purchased from Turnitin

account ID The numeric identification number for a specificaccount or sub-account

administrator

The controller of a specific Turnitin account. Thisuser type is able to install and configure, activateor deactivate products on an account, changeaccount settings, and add or remove instructorsfrom account access

assignment

Submissions to a class on Turnitin are made to anassignment. Each assignment can allow only asingle submission per student user who isenrolled in the class

Build mode The ability to design a course, used to createTurnitin assignments

class

To allow students to submit files, an instructormust create a class for their students. A classrequires a name, a class ID, and a classenrollment password

digital receiptThe digital receipt is a confirmation of asuccessful paper submission to a Turnitinassignment. The digital receipt

export(stats) Downloading a copy of account statistics in aMicrosoft Excel® format to a user’s computer

GradeMark

A digital grading product offered by Turnitinwhich allows instructors to place comments andQuickMark editing marks on a submission forstudents to review. This product also includes

18

standardized rubric scorecards and the ability toshare QuickMark standard editing marks andrubric scorecards between instructors on anaccount via export or via administrators using thelibraries sharing feature of the GradeMark digitalgrading product

homepageThe default login page, which is different basedon the selected default user type of the userprofile being accessed

instructor

The term used for teachers, tutors, or otherstudent assisting users added or authorized tojoin as instructors on a specific Turnitin account.A single person may be joined to multiple Turnitinaccounts or sub-accounts using one user profileor separate user profiles. Users may fill morethan one user type role on Turnitin

internet archive

Turnitin’s web repository includes inactive or nolonger available web pages and copies of pagesthat have changed over time. This allows Turnitinto search against information that is no longeravailable or which has changed over time

log in

the act of an authorized user entering the e-mailaddress and personal password created for a userprofile to enter Turnitin as the user associatedwith the e-mail address entered

Originality Report

Optical character recognition software converts aimage of text information into an actual textdocument that can be read and altered by wordprocessing software. Papers or documentstransferred into a computer via a scanner requireoptical character recognition software conversionto be submitted to Turnitin. Turnitin only acceptsdocuments containing actual text data ratherthan an imaged document or submission. Somescanners offer OCR conversion automatically, butmost OCR conversion requires hand correction toresolve any inaccuracies which can cause majorchanges to the actual content of a document

Overall Similarity Index

The overall similarity index is a percentageindicating the similarity of the text submitted toinformation contained in the Turnitin repositoriesused for comparison on the assignment thesubmission was made in. This percentageindicates a percentage based on the length of thepaper compared to the length of the areasflagged as similar during the comparison

19

paperA paper refers to the document or file submittedby a user to an assignment in a class on theTurnitin website

paper ID

The paper ID number is a unique identifier thatcan be used to refer to a specific paper. Thepaper ID number can be viewed by accessing thepaper in the assignment inbox for instructors. Thepaper ID number is also available on the paperview page, Originality Report, and GradeMarkdigital assessment view of the submission

PeerMark

This product allows students to anonymously orwith attribution review submissions made byother students within the course. Students replyto free response and scale questions selected orcreated by the instructor. Instructors may alsocomment on the paper using three differentcommenting tools: inline text tool, highlightertool, and composition marks. A PeerMarkassignment must be based on a normal Turnitinassignment where the student papers are initiallysubmitted

post date

This product creates Originality Reports forsubmissions in assignments on Turnitin. TheOriginality Reports allow instructors and studentsto easily determine any problems in citation orreferencing and assists instructors in determiningthe originality of a submitted work

repository

A set of information of a specific type or types. Inthe specific context of the Originality Reportprovided by Turnitin, repository is used to refer tothe type of information the submission wasevaluated against for direct matching or highlevels of similarity. Available repositories includeinternet, archived internet, periodical/journal/publication information, and previous submissions

resubmit

The act of submitting a new paper in place of anexisting submitted paper. Resubmission can onlybe done if the instructor has set an assignment toallow students to overwrite until the due date andtime of the paper, or if the instructor hasmanually deleted the student’s existingsubmission in the assignment inbox. This optioncan only be enabled by the class instructor

shared keyA shared secret key is the eight digit,alphanumeric code that an institution’sTurnitin account administrator has created within

20

Turnitin. The shared secret key is used to verifythe integrity of requests sent from theInstitution’s Sakai account to theinstitution’s Turnitin account

student

A user type able to enroll in courses created byan instructor user. Student user profiles canonly submit to assignments created by aninstructor in a class they are joined to or havebeen authorized to join

submission

File or files uploaded by a student orinstructor user into an assignment withina Turnitin class. Only a single file per studentuser can be submitted to an assignment by astudent user

upload (file)the act of submitting or sending a file into aspecific assignment within a Turnitin for use withthe Turnitin products selected for the class

user profile

the user profile is a set of user preferences andinformation associated with a specific ID withinTurnitin. Each user profile requires a unique e-mail address. A specific e-mail address can onlybe used once within the Turnitin repository. Newattempts to create a profile associated with an e-mail address currently existing in Turnitin will notsucceed

21