Child pages
  • Guide to installing content review services against trunk
Skip to end of metadata
Go to start of metadata

Description

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.

Steps


Turnitin

  • 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

    <ref bean="org.sakaiproject.contentreview.service.ContentReviewServiceTii"/>
  • (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:

      <property name="siteAdvisor"
                              ref="org.sakaiproject.contentreview.service.ContentReviewSiteAdvisor" />
    • 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:

    # TURNITIN CONFIG SETTINGS (v11)
    turnitin.apiURL=https://api.turnitin.com/api.asp?
    turnitin.secretKey=[yourAccountIdPassword]
    turnitin.said=[yourSubAccountID]
    turnitin.aid=[repeatYourSubAccountID]
    turnitin.useSourceParameter=true
    turnitin.option.institution_check=false
    assignment.useContentReview=true
  • 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:

    # CUSTOM LOGGER COUNT
    log.config.count=2
    # TURNITIN LOGGING
    log.config.1 = DEBUG.org.sakaiproject.contentreview.impl.turnitin
    log.config.2 = DEBUG.org.sakaiproject.turnitin.util.TurnitinAPIUtil.apicalltrace 
  • It is also recommended that you disable the option for "Institution Paper Repository" if your institution does not have one, to avoid errors.

    # sets the available repositories. 0=none; 1=standard; 2=institutional
    turnitin.repository.setting.count=2
    turnitin.repository.setting.1=0
    turnitin.repository.setting.2=1
  • Finally, if you wish to change the repository that is selected by default, you can do so with this property:

    # Sets the default repository. 0=none; 1=standard; 2=institutional
    turnitin.repository.setting.value=0

Vericite

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.xml to include the following line inside the "<list>" section

    <ref bean="org.sakaiproject.contentreview.service.ContentReviewServiceVeriCite"/>
  • Clone and build the VeriCite content review service implementation

    git clone https://github.com/LongsightGroup/contentreview-impl-vericite.git
    cd contentreview-impl-vericite
    mvn clean install sakai:deploy
  • Ensure you have the following sakai.properties

    assignment.useContentReview=true
    vericite.serviceUrl=https://vericite-api.longsight.com/vericite/report/
    vericite.consumer={username}
    vericite.consumerSecret={password}
    contentreview.defaultProvider=0

Federated with TurnItIn and VeriCite

  • Install both services using the steps above
  • In content-review, modify contentreview-federated/pack/src/webapp/WEB-INF/components.xml to include both services.

    <ref bean="org.sakaiproject.contentreview.service.ContentReviewServiceTii"/>
    <ref bean="org.sakaiproject.contentreview.service.ContentReviewServiceVeriCite"/>
  • 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

    contentreview.defaultProvider=1
  • 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'.