Project: Content Review
The Content Review project provides a set of API's for plagiarism prevention service plugins for Sakai. A back-end that uses the 3rd-party Turnitin service is currently available for production use although this will need to be replaced with a new IMS LTI-based integration by the end of 2016. It should also be possible to create implementations for other 3rd-party services which work in a similar way such as Ephorus, Longsight's VeriCite, Compilatio and Urkund.
Sakai (version 11.2 and above) supports this 3rd-party implementations:
Western University is working on porting the Turnitin (TII) LTI integration into a branch for Sakai master. They are currently running their version of the LTI integration with Sakai 11 locally; however, it requires heavy refactoring because of the recent changes to Assignments (refactored), BasicLTI, and Content Review. These additional changes and considerations will require more work and more time for the TII LTI project.
More details will be posted when available. No timeline right now, as the additional work is still being investigated and worked on (and there are still external changes being made to Assignments for the Assignments Refactor project during Sakai 12 QA separate from this TII project).
7-Jun-2017 Update from Sakai Project Meeting at Apereo Conference
Shawn Foster clarified that Western will build the IMS LTI integration into Sakai 12 - this will probably not be completed before the end of August.
There is a chance that the full integration won't be ready by the time that the Sakai 12 branch is cut, ie, in time for Sakai 12.0, in which case the plan is to ensure the new DB structures are in 12, if necessary, to make it easy to add LTI support in a point release.
Shawn clarified that due to issues with the TII LTI interface, when a multi-part submission is made it is not currently possible for grades to be sent back to Sakai. It is thought that in order to get this to work, TII will need to modify their interface and then work will need to be done in Sakai. This will be raised with TII in the future.
Western is currently running a version of the LTI integration with Sakai 10.3, and will be running a version of the LTI integration within Sakai 11, however, they have no plans to make a "10.x patch" or "11.x patch" available to the community. If any institutions want to run the LTI integration with 11 then funding / resources will have to be found. This caveat will be raised with TII in the future.
18-Apr-2017 Clarification about TurnItIn integrations from Brian Jones
Brian: You can use the legacy Turnitin API in Sakai 11.x ; Turnitin has extended the lifetime of this API until further notice.
The Turnitin LTI integration will be coming for Sakai 12. We are still fine tuning the LTI integration locally (at Western Uni, Ontario), and plan to contribute it back to the community after we're done our local upgrade to Sakai 11.3. At some point in the future (likely after the LTI integration has been completed in full), Turnitin may elect to revoke access to the legacy API.
Since January of 2017, Content review also supports Urkund, another option for the plagiarism prevention service.
13-Jan-2017 Update (Adam Marshall)
Oxford and Western Universities had a phone conference with the TurnItIn Integrations team on 10-Jan-2017 at which TurnItIn confirmed that they would not remove the current API until the Sakai LTI integration was 'complete' and institutions had moved to the new integration. It was decided that the completed integration would be written in such a way that it works with Sakai 11 and 12 but not with any earlier versions. It was mooted that the work to complete the Sakai 11 integration would start mid-way through 2017.
The work required to 'complete' the integration is in 3 parts
- Update the IMS LTI integration to fit with recent improvements to Sakai content-review API
- Update the integration in line with the recommendations made by TurnItIn, for example: TII-234 - implement iParadigms requested queuing logic Open TII-229 - Attempt immediate submission of a student's essay and only add the essay to the submissions queue if the attempt fails Open
- Complete any outstanding gaps in functionality, for example, TII-235 - Grademark should send marks back to Sakai when using multi-part submissions Open TII-232 - Display or log (or both) the contents of XML error message that are generated for non-submission actions Open TII-231 - "External Tools > Tools Links" allow TII LTI tools to be deleted Open TII-224 - Stealthed Turnitin LTI tool appears under Plugin Tools in Manage Tools Open and others
4/1/2017 Update (courtesy of Neal Caidin)
There has been a lot of discussion about changes to Sakai core code to keep up-to-date with changes to the Turnitin plagiarism detection tool for Sakai 11.
The plan for the new Turnitin integration, based on LTI, is targeted for Sakai 12 and probably will not be backported to Sakai 11. It is not recommended to use the new Turnitin LTI integration in production in its current state right now.
Sakai 11 will continue to use the legacy Turnitin API, which is still supported by Turnitin, until further notice. An LTI integration might be available for schools who want it for Sakai 11 in the future, pending available resources.
Turnitin is replacing their existing legacy APIs with LTI (IMS Learning Tools Interoperability). Originally, the community's understanding was that Turnitin would turn off the legacy APIs by the end of 2016 (this year), but that does not look to be the case anymore.
Institutions in the community have been working on implementing the new Turnitin LTI integration into Assignments to eventually replace the legacy Turnitin API. The initial work by the University of Oxford was targeted for the release of Sakai 11.0. More work was needed after the release of Sakai 11 to match the functionality of the legacy API and to handle the differences of the new LTI integration.
The University of Western Ontario (Western) has been working since early summer 2016 to adapt Oxford's LTI integration for their production Sakai 10 instance and to improve the integration in preparation for a later Sakai 11 minor release. Western is running a heavily-modified version of the LTI integration in their Sakai 10 production environment - successfully since the end of August.
Western was intending to contribute their Turnitin LTI integration improvements to Sakai 11 for 11.3. However, the Sakai Core team recently asked them to adapt it for Sakai 12 instead. Since the new LTI integration touches several areas of Sakai that have changed between Sakai 11 and (what will become) Sakai 12 (including Content Review, Assignments, and BasicLTI), the Sakai Core team believes it is best not to include the Turnitin LTI piece in the 11.3 maintenance release and instead focus on Sakai 12.
It is not recommended to use the Turnitin LTI integration in production in its current state. Therefore, the Sakai Core team recommends institutions on Sakai 11 continue to use the legacy Turnitin API until the new LTI integration is ready for Sakai 12.
Western will continue to work on the Sakai 11 LTI integration for their local upgrade to Sakai 11 for Spring 2017 and may be able to share this integration with other schools in the future, pending their available resources. Once they have the integration working solidly for their Sakai 11 instance and they have some development resources, they'll contribute their fixes back to Sakai master.
Please direct any questions to email@example.com email group (you must be subscribed - firstname.lastname@example.org).
Since November of 2016, Content review also supports Compilatio Service, another option for the plagiarism prevention service.
There is a special page about IMS LTI integration for Turnitin. We are currently working with Entornos de Formacion, Rutgers and UWO to try to get this new integration into Sakai 10.8 and Sakai 11.1. Many thanks to all those who are helping.
The new IMS LTI integration for Turnitin is now complete. The code is due to be released as part of Sakai 10.8 and Sakai 11.1. I have included an update from Earle Nietzel - I just want say a huge public “THANKS” to Earle and Longsight for offering to help in getting the new Turnitin code into sakai 11.1. We are extremely grateful for their help.
I would like to take a moment to update the community on the upcoming changes for content review.
Content Review in Sakai has always seemed like a step child, many pieces of content review existed in different locations even repositories.
It was decided the this is just a bad approach and we should include all the pieces required to use content review OTB, and someone should be able to just turn it on with a sakai property.
Currently in master the content-review module has been completely revamped, see https://jira.sakaiproject.org/browse/SAK-30207.
A ContentReviewFederatedService starts up an configures which implementations to activate, see http s://github.com/sakaiproject/sakai/tree/master/content-review. By default a NOOP service is configured OTB. All of the implementations are now conveniently located in the content-review module and not in a separate repo.
There is a new turnitin implementation that has just been completed (lead by Oxford) which will be replacing the current turnitin implementation which will expire. This new turnitin implementation is being adapted to the new content-review module and will be added to master shortly.
As a result this ongoing work it doesn’t make sense for it to have an effect on the upcoming 11.0 release for obvious reasons. However it does need to be included so that those wishing to use the new turnitin implementation can do so. Once the new turnitin implementation has been added to master and QA’d a new 11.x-CR branch will be created which will contain all the new content review changes for 11. Once 11.0 is released this branch will be merged back into 11.x and the following release 11.1 will contain all the new content review changes.
This represents the current and best way to bring the content review changes to 11.x without affecting an 11.0 release schedule. Caveat, while this represents the current plan to meet the communities needs it doesn’t mean that anything is written in stone, if some choices arise that will serve the community better they will most definitely be considered.
Sakai PMC/Core Team Member,
First of all, many apologies on the lack of progress reports about progress with the new Sakai-Turnitin integration, there's no real excuse other than that I haven't had time to compose reports as I've been totally snowed under with work.
The good news is that the coding is progressing well, we have almost completed the work and I hope that I will be asking for volunteers to test the code quite soon.
There are inevitable differences from the previous integration, some positive (resubmissions and multiple files per submission are allowed, marks from Markbook will be sent back to the Assignments tool) and some negative (we cannot provide a link directly to an Originality Report (one is instead taken to the Assignments Inbox) and a handful of other things, mainly 'edge cases').
The new code will not work at all with Assignments 2
7/10/2015 Work Started on Replacement Code
We are pleased to announce that the project to replace the integration code has finally started. The work is laid out on the separate U-TIC Project page.
14/09/2015 Business Requirements
This is on a separate Business Requirements page
3/06/15 Things to fix in new integration
This is on a separate Integration Issues page
15/04/2015 BoF at Apereo conference confirmed (Adam Marshall)
There will be a Turnitin BoF at the conference, I'm currently not sure about the scheduling.
I'm happy to lead but am also happy for others to give mini-presentations if needs be. It may be interesting to have 5-10 mins on the current LTI tool I know nothing about it at all. It could be useful background info?
In my bit I'll aim to outline what iParadigms are proposing regarding the new integration / API, what the implications are for the Sakai community and what the implementation schedule will look like. Then we can all have a chat and make some plans.
23/03/2015 Clarification of the different TurnItIn APIs (Adam Marshall)
TurnItIn offers 2 main APIs, I find the terminology confusing so I asked iParadigms and posted their response below. The latest Sakai 'content review' code uses the Legacy API, prior to that the Open API was used but I'm not sure of the version where the switch-over happened.
- Open API:
- oldest API used for integration
- was once publicly available to anyone
- integrations did not get assigned an integration ID - so we could not identify who was connecting to Turnitin through this method (which makes it harder to identify the badly behaving integrations)
- Legacy API:
- utilises same codebase as the Open API
- not as bad as Open API - each Legacy API integration has been assigned an integration ID for easier tracking and identification
20/3/2015 The future of Sakai - TurnItIn integration (Adam Marshall)
Matthew (Buckett) and I finally had the long-awaited conference call with Jessica Wells, Alex Bell and Gary Carr from iParadigms. The purpose of the call was to establish a route forward for the Sakai - TurnItIn integration and to answer a number of outstanding questions that we have compiled on behalf of the Sakai community.
The headline news is that iParadigms are putting a lot of effort into ensuring that future Sakai integration will look much the same as it currently does to the end-user. That is to say, it will be possible for the Sakai community to write brand new integration code for the Assignments tool (and others if necessary) that will replicate the current functionality.
iParadigms are NOT proposing to force Sakai to use the IMS LTI "external tool" route of integration. It is true that the new integration would pass some information around in an IMS LTI 1.1 standards compliant manner, but there are also a whole host of "custom extensions" to the LTI spec which allow tight integration with the Assignments tool. The IMS LTI spec can be used to pass marks back to the Gradebook tool.
The fact that the integration is based on IMS LTI is not that important, it may help to think of iParadigms offering a brand new API which we will need to code against.
The other headline is that the API that is currently used by Sakai will not be withdrawn until a suitable replacement exists. In other words, the current integration will not suddenly stop working: iParadigms are committed to ensuring that the switch-over to the new back-end is as smooth as possible.
We did raise a few questions that require clarification from iParadigms, these were in the area of error handling: what happens if TurnItIn tries to return some information to Sakai whilst the service is down for maintenance, or whilst the network is unavailable?
The documentation is available at: <https://guides.turnitin.com/03_Integrations/Learning_Tools_Interoperability_(LTI)/Turnitin_LTI_Custom_Setup_Guide_Future_Parameters>. Please post questions / comments about this to the email@example.com list - Jessica is a list member and will be able to respond accordingly.
iParadigms do not expect the proposed extensions to be available for use until May / June 2015 so code development could not start until then.
I hope that this positive outcome will dispel some of the worries that have been circulating of late. I for one am quite pleased with how things seem to be panning out.
28/11/2014 - Another New Method Of Integration (Adam Marshall)
iParadigms sent this communication n 12 Nov 2014. "To offer advanced functionality to our LTI integration customers, we have implemented custom LTI extensions to give customers more flexibility with the integration. We've actually since made more of these which are not yet documented. With the LTI extensions, the student can continue to submit into Sakai, and Sakai can programmatically pass the file over to us if appropriate. We have not implemented these in Sakai, but we see a need for them and so wanted to discuss with Sakai code contributors the possibility of working together to have these included in future iterations of Sakai."
It is not 100% clear what is happening to the TS2 code but it looks like it is being superseded.
Watch this space!
28/02/2014 - New TurnItIn API (Adam Marshall)
iParadigms intend to withdraw the current (2012) API. New "TS2" integration code, which is located at: https://github.com/ox-it/wl-content-review2, has been developed against a brand new API and, when complete, should be the library that all institutions use. Unfortunately this code is not yet finished (Feb 2014) and we would welcome any collaborative efforts from the community to take the matter forward.
In a change to previously reported policy, individual Sakai community members no longer need to sign the "ConnectItIn" agreement - I was told that the MoU between Sakai and iParadigms covers the use of the new API by Sakai: http://collab.sakaiproject.org/pipermail/announcements/attachments/20131107/cf61b064/attachment-0001.pdf
I would like to collect a list of institutions who use TurnItIn via Sakai with a view to setting up a consortium who can help Oxford develop and support the new integration. Oxford simply doesn't have the resources to do this alone. Please enter details lower down on this page.
Interested in TS2?
We need developers, code reviewers, testers, technical writers, and early adopters. Please signup here and indicate what role you would be able to play.
|Adam Marshall||Developer, Early Adopter, Tester|
Update May 8, 2012
An updated set of instructions for new users has been made available for the Turnitin Content Review Service. It is necessary to follow these guidelines going forward as the 'Open API' option is no longer available.
The guide can be found here
New Stuff! April 27, 2011
Version 1.0 of the Content Review Service is nearly complete. Instructions and release notes are in progress here
Tunitin Content Review 0.8
A branch of the Turnitin content review implementation has been released, which adds the following:
- Integration with GradeMark - This allows instructors to set a grade via the Turnitin Document Viewer and have that grade reflected in the Sakai gradebook
- Additional Assignment 2 options - adds support for ETS Erater
- Migration from the Open API
- Multiple Instructors - Allow instructors who haven’t created a Turnitin assignment on Sakai to access the Turnitin Document Viewer
Installation instructions can be found here
Turnitin Content Review 0.5
Version 0.5 of the Turnitin Content Review implementation is considered stable and in production use at several universities. Information on deploying and developing against it can be found here.
Turnitin CR 0.5 is currently stable. Outside of occasional bug fixes there is not any major feature development under way.
Sakai 2.6 Turnitin CR 0.5
|Roger Brown, Stephen Marquard|
Sakai 2.5 Turnitin CR 0.5
Northwest, South Africa
Sakai 2.9 Turnitin CR 0.8
LAMP (Appalachian College Association)
Sakai 2.7 Turnitin CR 0.5
Martin Ramsay (mailto: firstname.lastname@example.org)
Sakai 2.7 Turnitin CR 0.5
Sakai 2.7 Turnitin CR 0.5
Sakai 2.7 Turnitin CR 0.5
Sakai 2.6 Turnitin CR 0.5
Sakai 2.5 Turnitin CR sakai_2.5.x branch
Sakai 2.10 Turnitin CR 0.7
Sakai 10.x Turnitin CR 0.7
University of Florida
Sakai 2.9 Third-party plug-in/integration developed by the University of Cape Town
Asnn 1 + Ass 2
University of the Pacific
Sakai 2.6 Turnitin CR 0.5
|Western University||Sakai 2.9.1 Turnitin CR 0.7||Asnn 1||Production||Brian Jones, Paul Lukasewych|
|Rutgers University||Sakai 2.9.1 Turnitin CR 0.7||Asnn1 + Assn2||Production|
|Marist College||Sakai 188.8.131.52 Turnitin CR 0.7||Asnn 1||Production||Udaya Ghattamaneni, Joshua Baron, John Digilio|
American Public University System (APUS)
|in Sakai 2.9.3||Prod||Jeremy Kusnetz (email@example.com)|
|Miami University in Oxford, Ohio||Sakai 2.9||Ass 1 & Ass 2|
|Willamette University||Cheryl Cramer|
|NYU||Francesca Socolick, Gary W Shawver, (other contact details available on request)|
|Durham Technical Community College||Sakai 2.9.0||Assn 1||Production||Longsight (local contact Karen McPhaul)|
|Tufts||Sakai 2.8 (rSmart CLE 184.108.40.206), Turnitin CR ~0.8||Ass 1||Prod|
|University of Baltimore||James Campbell|
|Roger Williams University||Ashai Net International (local contact: Linda L Beith & Shawn Platt)|
|University of Dayton||Sakai 2.9||Prod||Paul Dagnall|
|Pacific Lutheran University||Prod||Sean Horner: firstname.lastname@example.org|
|Flying Kite||Steve Swinsburg|
|University of the Witwatersrand||Taurai Hungwe|
|Stockholm||2.8.1||Prod||Madeleine Wedin Shemweta|
MCI MANAGEMENT CENTER INNSBRUCK
|Lancaster University||Sakai 2.9.x||Assn 1||Prod||Adrian Fish|
|Brock University||Sakai 2.9.x||Assn 2||Prod||Matt Clare, Michael Brousseau|
|Boston Uni, School of Management|
|Texas State University||Sakai 2.8.2 (2.9.3 in Spring 2014)||Assn 1||Prod|
|Ithaca College||Sakai 2.9.3||Assn 1||Prod|
|Notre Dame||Laura Gekeler|
|UNIR - Universidad Internacional de La Rioja||Sakai 10.0||Assn 1||Prod||Rubén González, Miguel Pellicer|
|UCAM - Universidad Católica San Antonio de Murcia||Sakai 10.3||Assn 1||Prod||Miguel Ángel Guillén, Miguel Pellicer|
|IQ - Industry Qualifications||Sakai 10.0||Assn 1||DEV||Stephanie Loke, Miguel Pellicer|
Oxford has secured funding to work on further integration. We will be circulating plans as they emerge - this will probably not be until 2012.
JIRA project: http://jira.sakaiproject.org/browse/TII
Turnitin Integration Spec/Discussion: http://confluence.sakaiproject.org/display/SAKDEV/TurnItIn+Integration
Early Estimate/Design: https://source.sakaiproject.org/contrib/assignment2/trunk/docs/tii-estimate.html
There has been a lot of discussion about changes to Sakai core code to
keep up-to-date with changes to the Turnitin plagiarism detection tool
for Sakai 11.
The plan for the new Turnitin integration, based on LTI, is targeted for
Sakai 12 and probably will not be backported to Sakai 11. It is not
recommended to use the new Turnitin LTI integration in production in its
current state right now.
Sakai 11 will continue to use the legacy Turnitin API, which is still supported by Turnitin, until further notice. An LTI integration might be available for schools who want it for Sakai 11 in
the future, pending available resources.
Turnitin is replacing their existing legacy APIs with LTI (IMS Learning
Tools Interoperability). Originally, the community's understanding was
that Turnitin would turn off the legacy APIs by the end of 2016 (this
year), but that does not look to be the case anymore.
Institutions in the community have been working on implementing the new
Turnitin LTI integration into Assignments to eventually replace the
legacy Turnitin API. The initial work by the University of Oxford was
targeted for the release of Sakai 11.0. More work was needed after the
release of Sakai 11 to match the functionality of the legacy API and to
handle the differences of the new LTI integration.
The University of Western Ontario (Western) has been working since early
summer 2016 to adapt Oxford's LTI integration for their production Sakai
10 instance and to improve the integration in preparation for a later
Sakai 11 minor release. Western is running a heavily-modified version of
the LTI integration in their Sakai 10 production environment -
successfully since the end of August.
Western was intending to contribute their Turnitin LTI integration
improvements to Sakai 11 for 11.3. However, the Sakai Core team recently
asked them to adapt it for Sakai 12 instead. Since the new LTI
integration touches several areas of Sakai that have changed between
Sakai 11 and (what will become) Sakai 12 (including Content Review,
Assignments, and BasicLTI), the Sakai Core team believes it is best not
to include the Turnitin LTI piece in the 11.3 maintenance release and
instead focus on Sakai 12.
It is not recommended to use the Turnitin LTI integration in production
in its current state. Therefore, the Sakai Core team recommends
institutions on Sakai 11 continue to use the legacy Turnitin API until
the new LTI integration is ready for Sakai 12.
Western will continue to work on the Sakai 11 LTI integration for their
local upgrade to Sakai 11 for Spring 2017 and may be able to share this
integration with other schools in the future, pending their available
resources. Once they have the integration working solidly for their
Sakai 11 instance and they have some development resources, they'll
contribute their fixes back to Sakai master.
Please direct any questions to email@example.com email group
(you must be subscribed - firstname.lastname@example.org).
Thanks for your attention