This document will walk you through the steps necessary to install content review service against Sakai trunk (11-SNAPSHOT at the time of writing). Sakai currently has two content review service integrations; one for TurnItIn, and one for VeriCite. There is also the new Federated Content Review Service which enables you to run one or the other, or both side by side.
Ensure you have content-review checked out from https://source.sakaiproject.org/svn/content-review/trunk
this is core, so content-review should already be included with the rest of your sakai trunk code base
- Check out the content-review turnitin implementation from https://source.sakaiproject.org/contrib/turnitin/trunk/contentreview-impl
In content-review, modify ./contentreview-federated/pack/src/webapp/WEB-INF/components.xml to include the following line inside the "<list>" section
(Optional) If you wish to control which sites can use Turnitin, you can modify pack/src/webapp/WEB-INF/components.xml in contentreview-impl.
Firstly, remove the comments around the following property of the org.sakaiproject.contentreview.service.ContentReviewServiceTii bean:
Next, choose a ContentReviewSiteAdvisor you'd like to use. You have 3 choices:
The DefaultSiteAdvisor. This one allows all sites in the system to use Turnitin
The SitePropertyAdvisor. This one allows sites to use Turnitin only if they have the site property 'useContentReviewService' set to true.
The SiteCourseTypeAdvisor. This one allows only course sites to use Turnitin.
Uncomment the bean definition for the ContentReviewSiteAdvisor that you wish to use.
Ensure you have the following sakai.properties:
It is recommended that you turn on logging for the content review service, at least during the testing phase, as there are some errors that can only be detected by examining the log. Add the following lines to your sakai.properties:
It is also recommended that you disable the option for "Institution Paper Repository" if your institution does not have one, to avoid errors.
Finally, if you wish to change the repository that is selected by default, you can do so with this property:
You may follow the instructions below, or refer to Longsight's installation guide: http://www.longsight.com/vericite/help/installation/sakai.html
In content-review, modify
contentreview-federated/pack/src/webapp/WEB-INF/components.xmlto include the following line inside the "<list>" section
Clone and build the VeriCite content review service implementation
Ensure you have the following sakai.properties
Federated with TurnItIn and VeriCite
- Install both services using the steps above
In content-review, modify
contentreview-federated/pack/src/webapp/WEB-INF/components.xmlto include both services.
Whichever service is listed first in contentreview-federated's components.xml will be the default. This can be overridden by setting contentreview.defaultProvider in sakai.properties to the 0 based index of the desired service. In the above example, to choose VeriCite as the default, you would set
- To select which service to use on a site by site basis, you can add a site property; the key is 'contentreview.provider'. To use TurnItIn, the value is 'Turnitin', to use VeriCite, the value is 'VeriCite'.