Sakai Native Integration Instructions

VeriCite offers both a native integration and an LTI integration for Sakai. The native integration works within the LMS's Assignments tool and is enabled as part of your Sakai installation. The LTI integration may be configured separately without modifying the Sakai code base or properties. You may install either or both integrations in a single instance of your LMS. Most institutions make the LTI tool available to system administrators so that they can access the admin features and reports via the LTI interface.

Native Integration Installation

This is a developers' walkthrough for installing VeriCite's Content Review Service for Sakai 11.x, Sakai 10.x, and Sakai 2.9.x.

Sakai 11.x, Sakai 10.x, and Sakai 2.9.x

This guide will show you how to install and configure VeriCite in Sakai. We also include instructions on how to use the Federated Content Review Service to run multiple Content Review Services in Sakai.  For the manual install, this guide expects that you have Git installed as well as SVN, Maven, and your own Sakai instance.  You will use the following repositories:

https://github.com/vericite/contentreview-impl-vericite

https://github.com/vericite/contentreview-federated

If you have any questions with this guide or would like to request a pilot, please contact support@vericite.com

Source Code and Patches

*Delete the existing project in this tutorial from Tomcat (Assignment, Content Review, VeriCite Impl, Content Review Federated) and make sure they are all using the same version of the Content Review API while building

*If you have a previous install of Turnitin, please make sure you remove this from your Tomcat instance. The project name will be updated and an old instance will cause the content review service to not work properly.

Sakai 11.x

cd {sakai_src_home}/content-review
vi contentreview-federated/pack/src/webapp/WEB-INF/components.xml (make sure VeriCite is listed in the providers list)
git clone -b 2.0 https://github.com/vericite/contentreview-impl-vericite.git
cd contentreview-impl-vericite
mvn clean install sakai:deploy

Sakai 10.x

cd {sakai_src_home}
rm -rf content-review
svn co https://source.sakaiproject.org/svn/msub/longsight.com/content-review/contentreview-10.x_features-backport/ content-review
cd content-review
vi contentreview-federated/pack/src/webapp/WEB-INF/components.xml (make sure VeriCite is listed in the providers list)
mvn clean install sakai:deploy
git clone -b 2.0 https://github.com/vericite/contentreview-impl-vericite.git
cd contentreview-impl-vericite
git apply sakai10x.patch
mvn clean install sakai:deploy
cd ../../
rm -rf assignment
svn co https://source.sakaiproject.org/svn/msub/longsight.com/assignment/assignment-10.x_features-backport/ assignment
cd assignment
mvn clean install sakai:deploy

Sakai 2.9.x

cd {sakai_src_home}/content-review
git clone -b 1.0 https://github.com/vericite/contentreview-impl-vericite.git
patch -p0 < contentreview-impl-vericite/contentreview.patch
mvn clean install sakai:deploy
git clone -b 1.0 https://github.com/vericite/contentreview-federated.git
cd contentreview-federated
git apply sakai-29x.patch
vi pack/src/webapp/WEB-INF/components.xml (make sure VeriCite is listed in the providers list)
mvn clean install sakai:deploy
cd ../contentreview-impl-vericite
git apply sakai29x.patch
mvn clean install sakai:deploy
cd ../../assignment
patch -p0 < ../content-review/contentreview-impl-vericite/assignment-29x.patch
mvn clean install sakai:deploy

*If you want to install TII for Sakai 2.9, Sakai 10, and Sakai 11.0, apply the patch located in {sakai_src_home}/content-review/contentreview-impl-vericite/contentreview-impl_tii.patch You will also need to update the components.xml providers list for the federated content review service. The first content review service listed will be the default for all sites. You can override the default by setting a site property like: contentreview.provider=VeriCite If you need to change the default content review service, you can set the sakai property contentreview.defaultProvider=0 (zero based index of the providers list in content review federated).

Sakai 11.x, Sakai 10.x, and Sakai 2.9.x Properties

vericite.serviceUrl=(string) for Sakai 11.0 and Sakai 10.x use "https://api.vericite.com/lms/"; for Sakai 2.9.x use "https://app.vericite.com/vericite/report/" 
vericite.consumer=(string) we will provide this for you
vericite.consumerSecret=(string) we will provide this for you
contentreview.defaultProvider=(int) if you have multiple content review services, this allows you to set the default based on index in Federated's components.xml file
assignment.useContentReview=(boolean) Sets whether content review is used for the Assignments tool.
assignment2.useContentReview=(boolean) Sets whether content review is used for the Assignment2 tool.
contentreview.allowStudentView.default=(boolean) Sets the default for whether students can view their reports for new assignments.
contentreview.option.exclude_quoted=(boolean) Sets whether the instructor can see the option to modify the exclude quotes option. If false, then reports will not exclude quotes.
contentreview.option.exclude_quoted.default=(boolean) Sets the default for the exclude quotes option. If true, then quoted material is excluded in the report scoring algorithm.

Adding Projects to the Full Build

If you are running Turnitin, rename the checkout to something unique like "contentreview-impl-tii". This can be done in the .externals file or just rename the folder.

Add the projects to the main Sakai pom so that the projects will be built:

Index: pom.xml 
=================================================================== 
--- pom.xml	(revision 308876) 
+++ pom.xml	(working copy) 
@@ -63,6 +63,9 @@ 
config 
content 
content-review 
+ content-review/contentreview-federated 
+ content-review/contentreview-impl-vericite 
+ content-review/contentreview-impl-tii 
courier 
dav 
delegatedaccess 

Optional:  Add VeriCite LTI tool configuration:

Create or edit file: {CATALINA_HOME}/sakai/portlets/IMSBLTIPortlet.xml:

<?xml version="1.0"?>
<registration>
        <tool    
                id="sakai.vericite" title="VeriCite" description="VeriCite Plagiarism Service">       
                <configuration name="sakai:portlet-pre-render" value="true" />    
                <configuration name="functions.require" />        
                <configuration name="imsti.launch" value="https://api.vericite.com/web/v1/authenticate/lti" />    
                <configuration name="imsti.xml" />    
                <configuration name="imsti.secret" value="{secret}" />    
                <configuration name="imsti.key" value="{key}" />    
                <configuration name="imsti.pagetitle" value="VeriCite" />    
                <configuration name="imsti.tooltitle" value="VeriCite" />    
                <configuration name="imsti.frameheight" />    
                <configuration name="imsti.debug" />    
                <configuration name="imsti.releasename" value="on" />    
                <configuration name="imsti.releaseemail" value="on" />     
                <configuration name="final.launch" value="true"/>    
                <configuration name="final.xml" value="true"/>    
                <configuration name="final.secret" value="true"/>    
                <configuration name="final.key" value="true"/>
                <configuration name="final.pagetitle" value="false"/>
                <configuration name="final.tooltitle" value="false"/>
                <configuration name="final.newwindow" value="false"/>
                <configuration name="final.frameheight" value="false"/>
                <configuration name="final.debug" value="false"/>
                <configuration name="final.releasename" value="true"/>
                <configuration name="final.releaseemail" value="true"/>
         </tool>
</registration>