Skip to end of metadata
  • Created by Former user, last modified by Former user on Jul 28, 2011
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

A reference implementation of the ContentReview Service exists that submits the content to Turnitin. The implementation makes use of a queue strategy. Submitted items are appended to a queue, and a separate process submits the content to Turnitin and retrieves the report scores.

The implementation can be found here: https://source.sakaiproject.org/contrib/turnitin/

This page refers to the stable 0.5 version of ContentReview tagged here: https://source.sakaiproject.org/contrib//turnitin/tags/content-review-impl-base-0.5/. This work began in ticket SAK-7240 - Getting issue details... STATUS .

What it does

The Turnitin implementation of the content-review service is exposed in the Assignments tool in the Add/Revise Assignment page, Assignment submissions list page, and student assignment submission view page. Where Turnitin is selected for the Assignment, student submissions are automatically sent to Turnitin, and result scores retrieved. A link is displayed for each submission for instructors to view the corresponding Turnitin report. See Screenshots of Turnitin in Sakai.

Bugs, Feature Requests and Support

Please file bugs or feature requests in the Turnitin category in JIRA: http://jira.sakaiproject.org/jira/browse/TII

The Turnitin integration for Sakai is currently supported by UCT. If you have questions about how to deploy or use it, contact ~dhorwitz or ~smarquard, or join the sakai-dev site on http://collab.sakaiproject.org and email the sakai-dev@collab.sakaiproject.org mailing list.

Building the Implementation

Sakai trunk:

Development notes

For testing or developing, the smallest possible build is cafe plus these modules: assignment, calendar, content-review (API and an implementation), gradebook and sections.

To create a development environment:

<module>assignment</module>
<module>calendar</module>
<module>content-review</module>
<module>gradebook</module>
<module>sections</module>

Configuration

3. Setting up the queue jobs

  • You may need to add the jobscheduler tool to your admin workspace
  • in the jobscheduler tool click on "new job"
  • Select "Process Content Review Queue" from the dropdown list
  • Give it a name in the text box (can be anything)
  • click post
  • select the triggers link next to the job you just created
  • Create a new trigger. We sugest you set the job to run at five minute intervals which can be done with the following definition 
    0 0/5 * * * ?
  • repeat these steps to create a job and trigger for the reports process "Process Content Review Reports"

Setting up the Turnitin API

You need to set up your Turnitin account to make use of the API.

  • Contact your Turnitin representative to set your shared secret key - you will need to specify what the key is set to. This is needed for the turnitin.secretKey cofiguration paramater
  • Login to Turnitin as your primary Administrator
  • Next to your institution's name make a note of your account Id (this should be a number). You will need this for the turnitin.aid configuration variable
  • click the green update button next to your institution name
  • at the bottom of the modify screen click "add/modify API Integration information"
  • You will need to specify an IP address or range of IP addresses that can connect. Set this to a value that includes your Sakai servers
  • The callback URL is not used so can be set to any value.
  • once you have saved your settings you need to create a new sub account - this will be used by Sakai and will prevent collisions with other users from your institution. Once you have set up the sub account, make a note of its numeric id. You will need this for the turnitin.said configuration variable.

A number of sakai.properties settings are necessary to configure the service. These are mostly specific to your institution's Turnitin account.

turnitin.aid

The account ID of your institutions primary TurnitIn account that you configured with the administrator login to set a shared key for.

turnitin.said

The sub account ID to which Sakai will submit content

This should not be used, as it is not necessary anymore, as each account can itself be configured in Turnitin to be used with any integration.

turnitin.secretKey

The TurnitIn API password for your Insititution. If you don't have one, check your Turnitin administrator login and subsequent configuration area for your account.

turnitin.apiURL (Optional)

Set this if you wish to override the default API URL. Institutions in the UK may have to set this to "https://submit.ac.uk/api.asp?"

turnitin.defaultInstructorEmail

The email of a default instructoir for the API to use

turnitin.defaultInstructorFName

A name for that instructor

turnitin.defaultInstructorLName

A last name for the instructor

turnitin.defaultInstructorPassword

A password for that instructor

turnitin.defaultClassPassword

The default join password set for classes the implementation sets up

turnitin.defaultInstructorId

the Sakai userId of the default instructor

turnitin.keystore_name (Deprecated)

The location of the Keystore containing the Turnitin certificates. As this is set as a system property it should be the same as any other keystores set in sakai.properties. We do not suggest you use this as it will overide the sytem keystore setting.

turnitin.keystore_password (Deprecated)

The keystore password. As this is set as a system property it should be the same as any other keystores set in sakai.properties. We do not suggest you use this as it will overide the sytem keystore setting.

turnitin.defaultAssignmentName

A default assignment name to use if none is specified

turnitin.defaultAssignId

The default Assignment Id

assignment.useContentReview

This is actually a property of the assignments module, but is generally needed if you plan on using the integration with Assignments, which is the primary consumer at the moment. Should be set to 'true' to enable the functionality in the end user Assignments tool.

References

  • No labels