search

pkp / plagiarism

Plagiarism checker plugin for OJS 3/OMP
GNU General Public License v3.0
7 stars 32 forks source link

readme

iThenticate Plagiarism Detector Plugin

For OJS/OMP/OPS 4.x

Overview

This plugin permits automatic or manual submission of uploaded manuscripts to the iThenticate service for plagiarism checking.

  1. You need an account on ithenticate.com (costs involved)
    • paid via Crossref Similarity Check
    • or, paid directly to iThenticate
  2. Configure the API credentials following this guide
  3. Install the plugin via the Plugin Gallery
  4. Configure the plugin (see below)
    • Enable the iThenticate service from config.inc.php by setting ithenticate to On.
    • Enable the plugin from Plugin Gallery by clicking on the checkbox.
    • Example Enabling Plugin
    • Configure the plugin with the API URL and API KEY you get from ithenticate.com at plugin's setting page or in the config file.
    • Example Settings configuration
  5. The author logs in and makes a submission
    • At Step 4 of the submission process, submitting user must confirm iThenticate's End User License Agreement to complete the submission.
    • The submission files will be sent to iThenticate in Step 4 of the submission process.
  6. The Editor logs in to OJS/OMP/OPS installation and opens the Submission workflow page.
    • In the submission files grid view, the Editor can see the similarity scores if the similarity process has completed.
    • The Editor can also launch iThenticate's similarity viewer.
  7. If auto upload to iThenticate is disabled, the Editor can send each submission file to iThenticate from the workflow stage.

Similarity Check Settings

There are several iThenticate similarity check settings that can be configured via the plugin.

  1. Similarity Check Options
    • addToIndex -- Submissions will be indexed in the accounts repository and will be available for comparison in Similarity Reports by other users within your organization
    • excludeQuotes -- Text in quotes of the submission will not count as similar content
    • excludeBibliography -- Text in a bibliography section of the submission will not count as similar content
    • excludeAbstract -- Text in the abstract section of the submission will not count as similar content
    • excludeMethods -- Text in the method section of the submission will not count as similar content
    • excludeCitations -- The citations of the submission will be excluded from similarity check
    • excludeSmallMatches -- Similarity matches that match less than the specified amount of words will not count as similar content. Minimum value is 8.
    • allowViewerUpdate -- Changes made in reports will be saved for the next time the report is viewed
    • Available Similarity Check Options
  2. Each of this settings can also be configured at global or Journal/Press/Server level from the config.inc.php file.

Configuration

You may set the credentials in config.inc.php, or you may set the credentials per journal/press/server in the plugin settings. If credentials are present in config.inc.php, they will override those entered in the plugin settings form.

The config.inc.php settings format is:

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; iThenticate Plugin Settings ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

[ithenticate]

; Enable/Disable iThenticate service to upload submission files for plagiarism checking.
; Unsetting this will turn off the plugin globally.
ithenticate = On

; Global iThenticate API URL
; api_url = "https://some-ithenticate-account.com"

; Global iThenticate API key
; api_key = "YOUR_API_KEY"

; If desired, credentials can also be set by context by specifying each Journal/Server/Press path.
; api_url[Journal_or_Server_or_Press_path] = "https://some-ithenticate-account.com"
; api_key[Journal_or_Server_or_Press_path] = "YOUR_API_KEY"

; To update webhook after changing the API URL or/both KEY defined in the config file,
; run the command `php plugins/generic/plagiarism/tools/registerWebhooks.php`.

; To globally disable auto upload of submission files to iThenticate service, uncomment following line.
; disableAutoSubmission = On
; It is possible to disable auto upload at specific Journal/Server/Press level rather than globally
; disableAutoSubmission[Journal_or_Server_or_Press_path] = On

; Other settings can be configured here; see README.md for all options.

NOTE : Changing the api credentails (api_url and/or api_key) in the config.inc.php file will not update the webhook settings automatically and will require action from the submission workflow section to complete plagiarism similarity score generation process. However it is possible to use the command line tool to update it from CLI via command php plugins/generic/plagiarism/tools/registerWebhooks.php to update webhook for forced credentails.

Restrictions

  1. The submitting user must confirm the iThenticate End User License Agreement to send files to iThenticate service for plagiarism checking.
  2. zip/tar/gzip files will not be uploaded to iThenticate.
  3. Uploading files larger than 100 MB will cause failure as per iThenticate limits.