Sakai-TII Functional Specification v2.0 PDF

Sakai-Turnitin Integration
Functional Specification
Version 2.0
December 3, 2008
Table of Contents
1. Overview................................................................................................................................................................................................. 6
1.1. Purpose............................................................................................................................................................................................. 6
1.2. Existing Tool Impact Summary ....................................................................................................................................................... 6
1.2.1. Assignments.............................................................................................................................................................................. 6
1.2.2. Gradebook................................................................................................................................................................................. 7
1.3. Versions ........................................................................................................................................................................................... 8
1.4. Glossary ........................................................................................................................................................................................... 9
2. Architecture Overview.......................................................................................................................................................................... 10
2.1. Overview........................................................................................................................................................................................ 10
2.2. Design Considerations ................................................................................................................................................................... 11
2.2.1. Seamless Integration ............................................................................................................................................................... 11
2.2.2. Impact on Existing Sakai Modules ......................................................................................................................................... 11
2.2.3. Service-level Requirements .................................................................................................................................................... 11
2.2.3.1. Performance ..................................................................................................................................................................... 11
2.2.3.2. Scalability ........................................................................................................................................................................ 12
2.2.3.3. Security ............................................................................................................................................................................ 12
2.2.3.4. Extensibility ..................................................................................................................................................................... 12
2.2.3.5. Maintainability................................................................................................................................................................. 12
2.2.4. Other ....................................................................................................................................................................................... 13
2.2.4.1. Sakai Best Practices ......................................................................................................................................................... 13
2.2.4.2. Sakai Third-Party Software Components ........................................................................................................................ 13
2.3. Solution Components..................................................................................................................................................................... 13
2.3.1. Turnitin Administration Tool.................................................................................................................................................. 13
2.3.1.1. Overview.......................................................................................................................................................................... 13
2.3.1.2. GradeMark Web Service.................................................................................................................................................. 13
2.3.1.3. Deployment...................................................................................................................................................................... 13
2.3.2. Turnitin Service Component................................................................................................................................................... 14
2.3.3. Existing Sakai Tool Extensions .............................................................................................................................................. 15
3. Specifications by Scenario.................................................................................................................................................................... 16
3.1. Scenario and Screen Notes............................................................................................................................................................. 16
3.1.1. Integration ............................................................................................................................................................................... 16
3.1.2. Assignment Submission.......................................................................................................................................................... 16
3.1.3. Error Messages........................................................................................................................................................................ 16
Page 2 of 131
3.1.4. Export, Import, and Duplicate ................................................................................................................................................ 16
3.1.5. Disabling TII for Sakai ........................................................................................................................................................... 17
3.1.6. Disabling TII for an Assignment ............................................................................................................................................ 17
3.2. Administer Turnitin Globally for the Sakai Instance..................................................................................................................... 17
3.2.1. Requirements .......................................................................................................................................................................... 17
3.2.2. Scenario................................................................................................................................................................................... 19
3.2.3. Screens .................................................................................................................................................................................... 19
3.2.3.1. Register and Enable ......................................................................................................................................................... 19
3.2.3.2. Disable Turnitin ............................................................................................................................................................... 25
3.2.3.3. Edit Global Statement ...................................................................................................................................................... 27
3.2.3.4. Edit Plagiarism Pledge..................................................................................................................................................... 30
3.2.3.5. Disable GradeMark.......................................................................................................................................................... 33
3.2.3.6. View Registration Information ........................................................................................................................................ 36
3.2.4. Implementation Notes............................................................................................................................................................. 39
3.3. Administer Course Turnitin ........................................................................................................................................................... 40
3.3.1. Requirements .......................................................................................................................................................................... 40
3.3.2. Scenario................................................................................................................................................................................... 40
3.3.3. Screens .................................................................................................................................................................................... 41
3.3.3.1. Add Instructor Note ......................................................................................................................................................... 41
3.3.3.2. Edit Instructor Note.......................................................................................................................................................... 45
3.4. Add a Turnitin assignment............................................................................................................................................................. 49
3.4.1. Requirements .......................................................................................................................................................................... 49
3.4.2. Scenario................................................................................................................................................................................... 52
3.4.3. Screens .................................................................................................................................................................................... 52
3.4.3.1. Add Assignment............................................................................................................................................................... 53
3.4.3.2. Edit Assignment............................................................................................................................................................... 58
3.4.3.3. Delete Assignment ........................................................................................................................................................... 61
3.5. Submit a Turnitin assignment ........................................................................................................................................................ 63
3.5.1. Requirements .......................................................................................................................................................................... 63
3.5.1.1. Notes ................................................................................................................................................................................ 65
3.5.2. Scenario................................................................................................................................................................................... 65
3.5.3. Screens .................................................................................................................................................................................... 65
3.5.3.1. Submit Assignment.......................................................................................................................................................... 66
3.5.3.2. Submit Assignment for Student ....................................................................................................................................... 68
Page 3 of 131
3.6. View Turnitin Reports - Instructor ................................................................................................................................................ 73
3.6.1. Requirements .......................................................................................................................................................................... 73
3.6.2. Scenario................................................................................................................................................................................... 75
3.6.3. Screens .................................................................................................................................................................................... 75
3.6.3.1. View Originality Report - Assignment ............................................................................................................................ 76
3.6.3.2. View Originality Report Errors - Assignment ................................................................................................................. 79
3.6.3.3. View Originality Report - Gradebook ............................................................................................................................. 82
3.6.3.4. Sort by Originality Report - Gradebook .......................................................................................................................... 84
3.6.3.5. Launch Originality Report ............................................................................................................................................... 86
3.6.3.6. Launch GradeMark .......................................................................................................................................................... 88
3.7. View Turnitin Reports - Student.................................................................................................................................................... 93
3.7.1. Requirements .......................................................................................................................................................................... 93
3.7.2. Scenario................................................................................................................................................................................... 94
3.7.3. Screens .................................................................................................................................................................................... 94
3.7.3.1. Released Assignment ....................................................................................................................................................... 94
3.7.3.2. Returned Assignment....................................................................................................................................................... 96
3.7.3.3. Graded Assignment.......................................................................................................................................................... 97
3.8. Duplicate Turnitin Course............................................................................................................................................................ 100
3.8.1. Requirements ........................................................................................................................................................................ 100
3.8.2. Scenario................................................................................................................................................................................. 100
3.8.3. Screens .................................................................................................................................................................................. 100
3.8.4. Implementation Notes........................................................................................................................................................... 103
3.9. Reuse Existing Assignments........................................................................................................................................................ 104
3.9.1. Requirements ........................................................................................................................................................................ 104
3.9.2. Scenario................................................................................................................................................................................. 104
3.9.3. Screens .................................................................................................................................................................................. 105
3.9.4. Implementation Notes........................................................................................................................................................... 106
3.10. Grade Assignment...................................................................................................................................................................... 107
3.10.1. Requirements ...................................................................................................................................................................... 107
3.10.2. Scenario............................................................................................................................................................................... 108
3.10.3. Screens ................................................................................................................................................................................ 108
3.10.3.1. Submit Grade from GradeMark ................................................................................................................................... 109
3.10.4. Implementation Notes......................................................................................................................................................... 111
Page 4 of 131
4. Future Considerations ......................................................................................................................................................................... 113
4.1. Update to Assignments 2 ............................................................................................................................................................. 113
4.2. DropBox Tool Enhancements...................................................................................................................................................... 113
4.3. Filtering........................................................................................................................................................................................ 113
4.4. Additions to the Assignments Tool.............................................................................................................................................. 113
4.5. Additions to the proposed TII Admin Tool ................................................................................................................................. 114
4.6. Use of the GradeMark Product .................................................................................................................................................... 114
4.7. Alternative Course Configuration Options .................................................................................................................................. 114
4.8. Additional Locations for Viewing Disclaimers ........................................................................................................................... 115
4.9. Permissions .................................................................................................................................................................................. 115
5. Appendix............................................................................................................................................................................................. 116
Page 5 of 131
1. Overview
1.1. Purpose
The purpose of this document is to provide a functional specification for an integration between Sakai and the iParadigms Turnitin
application. This document details requirements for this integration, along with proposed workflows, screenshots, and technical
implementation recommendations. Requirements and recommendations were developed based on:
similar implementations with other Learning Management Systems

best practices in Sakai design
best practices in Sakai architecture
input from Sakai functional and technical users
In order to ensure a comprehensive and interesting integration for the Sakai community, version 1.0 of this document (as of 11/4/08)
was delivered to the Sakai community for review and input. All input provided by 11/18/08 was considered and either caused an
update to this specification, or was deferred as a consideration for future requirements.
1.2. Existing Tool Impact Summary
The existing Sakai tools "Assignments" and "Gradebook" have a proposed impact within this specification. Several other existing
tools were considered for inclusion in the integration. Please see section entitled "Other Considerations" for comments on tools
considered. Unless specifically called out within this specification, all other existing Sakai functionality is to remain unchanged.
The following sections provide an overview of the extent of the impact on the tools previously listed.
1.2.1. Assignments
As described in the Sakai help files: "The Assignments tool allows instructors to create, distribute, collect, and grade online
assignments for courses within Sakai. Assignments are private; student submissions are not visible to other users of the site."
The table below summarizes the impact to the existing Assignments tool.
Page 6 of 131
Primary functionality Impact? Description
Create/Add &
Create/Add, Edit, or Delete
Edit: Yes New publishing options
Assignments
Delete: No
Grade Assignment/Review
Yes Ability to view Originality Reports and GradeMark
Student Status
See How Assignments Look No Base Assignments functionality remains
Returning an assignment will be a trigger for allowing students to see
Return Assignments Yes
Originality Report or GradeMark, when applicable
Resubmission is a requirement listed in this document; however, nothing
Resubmit Assignments No
custom is required to allow resubmission of a TII assignment
Export Assignment Grades No Base Assignments functionality remains
Read Assignments Yes Ability to view Originality Reports and GradeMark
Duplicate Assignments Yes No UI changes; impact to the tool and service Java code
TII assignments are restricted to Inline Only or Attachments Only
Complete and Submit
Yes Assignment submission will send inline or attachment content to TII,
Assignments
GradeMark services, when applicable
Post Assignments No Base Assignments functionality remains
Add Honor Pledge No Base Assignments functionality remains
Student will have the ability to view Originality Reports and GradeMark,
Check Assignment Grade Yes
when applicable
1.2.2. Gradebook
As described in the Sakai help files: "The Gradebook is a tool for instructors to calculate and store grade information and
distribute it to students online.." The table below summarizes the impact to the existing Gradebook tool.
Primary functionality Impact? Description

Creating/adding, editing, or deleting a
No
Gradebook item
Viewing Gradebook item details Yes Ability to view Originality Reports and GradeMark
Page 7 of 131
Grades entered into GradeMark will update in the Sakai Gradebook. No
Entering or editing grades Yes
core grade entering/editing functionality will be impacted.
Commenting on grades No
Importing Gradebook items from a
No
spreadsheet
Importing grades for existing
No
Gradebook items
Sorting Gradebook tables No
Viewing and exporting student grades No
Viewing course grades No
Overriding an autocalculated course
No
grade
Releasing grades will be a trigger for allowing students to see Originality
Making grades available to students Yes
Report or GradeMark, when applicable
Calculating and exporting course
No
grades
Using categories and weighted grades No
Use of GradeMark enforces use of Gradebook integration, when creating
an assignment in the Assignments tool;
Changing the grade entry, type, and Not
Grades entered into Sakai Gradebook will be automatically transmitted to
scale directly
TII/GradeMark
1.3. Versions
This specification was developed for Sakai 2.5. All tool references assume use of the standard tools distributed with Sakai 2.5,
including the "Assignments 1" tool.
Page 8 of 131
1.4. Glossary
Term Definition
TII "Turnitin" abbreviation
Institution assignment Global plagiarism policy statement published by an institution
submission statement
Course assignment Course-level plagiarism policy statement published by an Instructor
submission message
Similar to Sakai's existing "Honor Pledge" - a plagiarism notice that must be acknowledged by a
Plagiarism pledge student submitting an assignment, before the assignment can be submitted.
Page 9 of 131
2. Architecture Overview
2.1. Overview
An integration between Sakai and Turnitin will be comprised of several solution components. In general, the solution components
follow typical Sakai application (tool) structure and conventions. The following diagram provides a high-level view of components
and interactions involved in the proposed Sakai-Turnitin integration:
• Turnitin Sakai Tool will be a web application that runs within Sakai and provides functionality to facilitate administration of
the institution specific Turnitin settings. The Turnitin Administration Tool will also expose a web service to allow Turnitin's
GradeMark system to post grades to Sakai.
• Turnitin Service Component will be comprised of several modules following typical Sakai packaging conventions. The
Turnitin Service Component will be responsible for providing both the interface to the Turnitin API and implementation of any
Turnitin specific business rules.
• Extensions to Existing Sakai Modules will include customizations to both the user interface and Java code to support
Turnitin-related functionality.
Page 10 of 131
2.2. Design Considerations
Before exploring the high-level design, the following section lists topics that merited additional consideration during the high-level
design process. Some topics, such as performance or security, are common to most software projects. Other topics, such as minimizing
impact on existing Sakai modules, are specific to an integration between Sakai and Turnitin. Both common and specific topics are
outlined below.
2.2.1. Seamless Integration
Among the most important considerations for a Sakai-Turnitin integration is providing a seamless experience when accessing
Turnitin from Sakai. In general, this involves blending Turnitin functionality into Sakai such that it conforms with the Sakai
user interface and adopts typical Sakai user interaction conventions. However, this notion can also be expanded to include how
developers and system administrators work with the Sakai-Turnitin integration. The Sakai-Turnitin integration can be made
system administrator and developer friendly by providing simple, yet robust, configuration and deployment mechanisms and
creating well-defined extension points for enhancing functionality.
2.2.2. Impact on Existing Sakai Modules
Although longer-term the solution components of the Sakai-Turnitin integration could become part of the core Sakai
framework, initially it makes sense to limit the impact on existing Sakai modules. Specifically, a concerted effort should be
made in the design and implementation of the Sakai-Turnitin solution components to, where possible, avoid changes to core
Sakai framework components including Java and user interface code. Taking this approach preserves a well-defined Sakai
upgrade path for institutions while still affording the opportunity to take advantage of Turnitin functionality.
2.2.3. Service-level Requirements
2.2.3.1. Performance
Performance can be measured in a number of ways. For the purposes of the proposed Sakai-Turnitin integration, the
primary performance concern is response time for a given transaction on a per user basis. Specifically, the goal is to
minimize the amount of time it takes to render Turnitin content within Sakai. While it is difficult to provide any
performance metrics at this point, baseline performance metrics will be established as the integration evolves.
Page 11 of 131
2.2.3.2. Scalability
In large part, scalability is dependent on the underlying systems (Sakai and Turnitin). When considering scalability in
the context of the solution components developed for the Sakai-Turnitin integration, it is important to design and
implement the solution components such that the scalability of the underlying systems is not adversely affected. To this
end, unit and integration tests will be developed for each solution component to help identify potential scalability
bottlenecks.
2.2.3.3. Security
During design and development of the Sakai-Turnitin integration, potential security vulnerabilities of the
implementation will be examined. Additionally, attempts will be made to address any potential security risks and any
perceived risk will be extensively documented.
2.2.3.4. Extensibility
Extensibility is an important consideration for the proposed Sakai-Turnitin integration. It is possible, even likely, that
components developed for the Sakai-Turnitin integration will need to be extended to support an individual institution.
Therefore, in order to facilitate extensibility, the Sakai-Turnitin integration will be designed to rely heavily on Java
interfaces (as opposed to concrete implementations) and avoid tight coupling of class implementations where possible.
2.2.3.5. Maintainability
As the core Sakai platform evolves, the components developed to support a Sakai-Turnitin integration will likely
evolve as well. In order to promote maintainability, the Sakai-Turnitin integration will be designed and implemented
with two key principles in mind: separation of concerns and modularity. Separation of concerns involves breaking
down components into fine-grained units to avoid functional overlap. By avoiding functional overlap, changes can be
made to individual components without impacting other system components. Modularity calls for grouping related
components together while maintaining loose-coupling to other modules or components. This allows for wholesale
swapping of component modules when necessary.
Page 12 of 131
2.2.4. Other
2.2.4.1. Sakai Best Practices
Solution components will be designed and developed to follow best practices and patterns set forth by the Sakai
community.
2.2.4.2. Sakai Third-Party Software Components
Where possible solution components will make use of third-party software that is widely adopted with the Sakai
community.
2.3. Solution Components
As described in detail below, the Sakai-Turnitin solution components will consist of the Turnitin Administration Tool, the Turnitin
Service Component and extensions to some existing Sakai tools.
2.3.1. Turnitin Administration Tool
2.3.1.1. Overview
The Turnitin Administration Tool will be a Java web application that runs within Sakai (i.e. a Sakai Tool). The Turnitin
Tool's core responsibility will be to facilitate administration of the institution specific Turnitin settings. For example,
the Turnitin Tool will provide functionality to enable Turnitin globally for a given Sakai instance.
2.3.1.2. GradeMark Web Service
In addition to its administrative function, the Turnitin Administration Tool will also expose a web service to allow
Turnitin's GradeMark System to report grades from Turnitin to Sakai.
2.3.1.3. Deployment
The Turnitin Administration Tool will be deploy in the same manner as other Sakai tools (e.g. in the Apache Tomcat
webapps directory). However, since the tool will manage global Sakai Turnitin settings, the Turnitin Administration
Tool should be added to the Sakai Administrative Workspace and not individual course or project worksites. Adding
Page 13 of 131
the Turnitin Administration Tool to the Sakai Administrative Workspace can accomplished by editing the tools
available on the !admin site.
2.3.2. Turnitin Service Component
The Turnitin Service Component will be comprised of several modules following typical Sakai packaging conventions. In
general, the Turnitin Service Component will be responsible for providing both the interface to the Turnitin API and
implementation of any Turnitin specific business rules. The diagram below details the modules that make up the Turnitin
Service Component:
• Domain Model will include Java interfaces and classes that represent entities used by the Sakai-Turnitin solution
components. For example, the domain model could include an interface and class pair that represents a Turnitin API
URL.
• Service API will be the interface for the Turnitin tool and other Sakai Tools to Turnitin data and business logic.
• Service Implementation will be the realization of the Service API. The Service implementation will consist of a Java
class or classes to process requests to the Turnitin API and manage Turnitin functionality within Sakai.
• Scheduler will be the mechanism used to queue and resubmit failed assignment submissions.
• Data Access Object (DAO) API will be the interface for the Turnitin Service Implementation to Turnitin data stored
within Sakai.
• DAO Implementation will be the realization of the DAO API. The DAO implementation will consist of a Java class or
classes to handle access to the Sakai database.
Page 14 of 131
Each Turnitin Service Component module will be packaged as Java Archive (JAR) files and deployed independently following
Sakai conventions.
2.3.3. Existing Sakai Tool Extensions
As part of the Sakai-Turnitin integration, number of existing Sakai tools will be enhanced to provide Turnitin functionality.
These tools include, but are not limited to, the Sakai Assignments (1) Tool and the Sakai Gradebook Tool. As mentioned in the
design considerations above, it is important to limit the impact, at least initially, on core Sakai tools. One way to limit the
impact on existing tools is to avoid, where possible, changing the core tool code directly. In the case of Java components, this
is straight-forward and can be achieved by simply creating Turnitin-specific implementations that extend the core
implementations. However, for other components, such as HTML pages, avoiding direct changes is more difficult as there is
no obvious extension point. One mechanism that has proven to be successful in solving this problem is the overlay feature of
the Maven 2 WAR Plugin.
As the above diagram shows, the Maven 2 WAR overlay feature works by merging the core tool web application archive
(WAR) file with the Turnitin-specific extension WAR file to produce a WAR file containing a Turnitin-customized version of
the core tool. At a high-level, the Maven 2 WAR overlay works by matching and then replacing files in the core tool WAR file
with files in the extension WAR file. This allows developers to create Turnitin-specific versions of certain core tool
components (e.g. an HTML file) without editing source code of the core tool.
Page 15 of 131
3. Specifications by Scenario
3.1. Scenario and Screen Notes
The screens detailed in this section do not exhaustively depict all possible conditions of the scenario, but demonstrate the workflow in
at least one representation of each Sakai context and include functional notes of the variances in the user interaction. The following
general functional notes apply to this section.
3.1.1. Integration
TII integration is available for course worksites only.
3.1.2. Assignment Submission
All submissions are stored on Sakai server in the same way they would be stored without the TII integration. Thus,
submissions by a student will succeed even if the submission to TII fails due to server error or file upload error. The student is
not notified of a TII error.
Sakai does not treat "group assignments" differently from individual assignments, in that group members will not
automatically get an Originality Report or grade based on a submission by one of the group members, even if it's technically
on behalf of the entire group.
3.1.3. Error Messages
Example error messages are visually represented for common errors in the scenario, but every error condition and subsequent
error message is not visually represented. A full description of error conditions and messages is available in the requirements
sections.
3.1.4. Export, Import, and Duplicate
Sakai has no user interface for selection of individual attributes for export, import, or duplicate that would affect the TII
integration. All TII attributes that are associated with the course or assignment will be exported, imported, or duplicated in the
normal Sakai process. These processes are therefore not depicted.
Page 16 of 131
3.1.5. Disabling TII for Sakai
Disabling TII for Sakai (via the Turnitin Administration tool) results in all TII services becoming disabled. However, existing
TII originality reports and GradeMark grades remain active in a read-only mode. No new reports are generated, GradeMark
may not be used (except for read-only access to already existing GradeMark material), and new assignments will not have the
option to use TII services. In all cases, disabled TII functionality reverts Sakai to its original functionality.
3.1.6. Disabling TII for an Assignment
Disabling TII for an Assignment (by unchecking the Use Turnitin checkbox in Assignment Edit) results in the removal of all
TII functional elements from resultant Assignment and Gradebook interfaces, regardless of whether or not there are existing
originality reports or GradeMark grades. Existing originality reports and GradeMark grades are not deleted, but are no longer
accessible from the interface. These conditions are called out in the functional notes, but are not explicitly depicted. In all
cases, disabled TII functionality reverts Sakai to its original functionality.
3.2. Administer Turnitin Globally for the Sakai Instance

3.2.1. Requirements
Req # Requirement Description
Provide the ability to enter and validate a Turnitin account ID and shared secret to
AG1.0 Register Turnitin for Sakai
unlock use of Turnitin for the Sakai instance
AG1.1 Enable use of Turnitin for Sakai Provide the ability to enable use of Turnitin for the Sakai instance
Disable use of Turnitin for
AG1.2 Provide the ability to disable use of Turnitin for the Sakai instance
Sakai
Enable use of institution
Provide the ability to enable use of an institution-wide statement that is displayed
AG1.3 assignment submission
when any student submits an assignment that uses Turnitin
statement
Disable use of institution
AG1.4 assignment submission Provide the ability to disable use of an institution-wide statement
statement
Input an institution assignment Provide the ability to enter the content of the institution assignment submission
AG1.5
submission statement statement
AG1.6 Enable use of the plagiarism Provide the ability to enable use of the plagiarism pledge
Page 17 of 131
pledge
Disable use of the plagiarism
AG1.7 Provide the ability to disable use of the plagiarism pledge
pledge
AG1.8 Input a plagiarism pledge Provide the ability to enter the content of the plagiarism pledge
Enable GradeMark at the global
AG1.9 Provide the ability to enable GradeMark for the Sakai instance
Sakai level
Disable GradeMark at the
AG1.10 Provide the ability to disable GradeMark for the Sakai instance
global Sakai level
Provide the ability to show a disclaimer that GradeMark must be turned on for the
AG1.11 GradeMark usage disclaimer
Institution's account in order for the functionality to work properly
Provide the ability to view previously entered account ID and shared secret
AG1.12 View registration information
registration information Sakai Admin
Provide the ability to edit previously entered account ID and shared secret
AG1.13 Edit registration information
registration information Sakai Admin
Provide the ability to return an error message if registration is not successful
Notify on unsuccessful
AG1.14 - Account id or shared secret are incorrect
registration
- Account is not active
AG1.15 Enable TII notification emails Provide the ability to enable TII emails from the Sakai admin interface
AG1.16 Disable TII notification emails Provide the ability to disable TII emails from the Sakai admin interface
Provide the ability to select an option to check work against an Institution-specific
Enable use of Institution-
AG1.17 repository (no validation required) - Should include wording that this is a service
specific repository
that must be purchased, similar to GradeMark
Disable use of Institution- Provide the ability to de-select an option to check work against an Institution-
AG1.18
specific repository specific repository (no validation required)
Read-only access to reports for Provide the ability for TII and GM reports to be viewable (per permissions outlined
AG1.19
invalid TII account elsewhere in this document) but read-only, if the TII account becomes invalid
Provide the ability for TII and GM reports to be viewable (per permissions outlined
Report viewability after
AG1.20 elsewhere in this document) but read-only, if TII is disabled for the institution after
disabling TII
having been previously enabled.
Error if Institution Repository is Provide the ability to return an error if Institution Repository selection is checked
AG1.21
not available but repository is not available
Page 18 of 131
3.2.2. Scenario
In order to use Turnitin, a Sakai administrator must input a registration key (given by Turnitin) to unlock use of Turnitin for the Sakai
instance. While registering Turnitin, the Sakai administrator enters a shared secret that will allow Turnitin to identify authorized
institution administrators. Once the registration key has been validated, Turnitin may be enabled for use by the Sakai installation. In
enabling Turnitin, the Sakai administrator may elect to use a global institution assignment statement and input the contents of the
statement. At the same time, the administrator may elect to enable use of a plagiarism pledge (similar to the honor pledge) and input
the contents of the pledge.
3.2.3. Screens
3.2.3.1. Register and Enable
Turnitin Administration tool (a new administrative tool created to administer Turnitin).
Page 19 of 131
Page 20 of 131
Page 21 of 131
Functional Notes
Note # Requirement Dependencies Functional Notes
Sakai: use Turnitin
Provide a link to begin the registration process. This screen
1 AG1.0 Administration tool, Sakai:
only appears if Turnitin has not been registered.
Turnitin not registered
Sakai: use Turnitin
2 AG1.0 Input for an Account ID. Account ID is provided by Turnitin.
Administration tool
Sakai: use Turnitin Input for a Shared Secret. Shared Secret is provided by
3 AG1.0
Administration tool Turnitin. A "what is this?" helper link is provided to aid
Page 22 of 131
understanding of the term Shared Secret.
Sakai: use Turnitin Provide a progress indicator while verifying the Account ID
4 AG1.0
Administration tool and Shared Secret.
Display an error message if Account ID and Shared Secret do
Sakai: use Turnitin
5 AG1.14 not validate. Allow re-entry of Account ID and Shared
Administration tool
Secret. Provide Turnitin contact link for validation problems.
6 AG1.12 Sakai: Turnitin registered Provide a link to edit registration information.
Show message that Turnitin is registered the disabled status.
7 AG1.1 Sakai: Turnitin registered
Provide a link to enable.
Checkbox to enable/disable use of an institution Assignment
8 AG1.3 Sakai: use Turnitin
Submission Statement.
9 AG1.5 Sakai: use Turnitin Textarea to input the Assignment Submission Statement.
10 AG1.6 Sakai: use Turnitin Checkbox to enable/disable use of a Plagiarism Pledge.
11 AG1.8 Sakai: use Turnitin Textarea to input the Plagiarism Pledge text.
12 AG1.15 Sakai: use Turnitin Checkbox to enable/disable email notifications.
Checkbox to enable/disable use of institution-specific
Sakai: use Turnitin, Turnitin
repository. Option to select is only displayed if the
13 AG1.17 Account: specific repository
institution-specific repository is included in the institution's
enabled
Turnitin account.
14 AG1.9 Checkbox to enable/disable use of GradeMark.
Account: GradeMark enabled
15 AG1.2 Sakai: use Turnitin Change status to Enabled and provide a link to disable.
Display Assignment Submission Statement in a non-editable
Sakai: use Turnitin, Sakai: use
AG1.3, textarea. If Assignment Submission Statement has not been
16 Assignment Submission
AG1.5 set, provide a link to use and input the Assignment
Statement
Provide a link to edit the text of the Assignment Submission
17 AG1.5 Assignment Submission
Statement.
Statement
AG1.6, Sakai: use Turnitin, Sakai: enable Display Plagiarism Pledge in a non-editable textarea. If
18
AG1.8 Plagiarism Pledge Plagiarism Pledge has not been set, provide a link to use and
Page 23 of 131
input the Plagiarism Pledge.
Sakai: use Turnitin, Sakai: enable
19 AG1.9 Provide a link to edit the text of the Plagiarism Pledge.
Plagiarism Pledge
AG1.15, Display state of email notifications and provide a link to
20 Sakai: use Turnitin
AG1.16 enable/disable use.
AG1.17, Display state of institution-specific repository and provide a
21 Account: specific repository
AG1.18 link to enable/disable use.
enabled
22 AG1.10 Show GradeMark as enabled and provide a link to disable.
Account: GradeMark enabled
Page 24 of 131
3.2.3.2. Disable Turnitin
Page 25 of 131
Functional Notes
1 AG1.2 Sakai: use Turnitin Provide a link to disable Turnitin.
2 AG1.1 Sakai: use Turnitin Change status to disabled and provide a link to enable.
Page 26 of 131
3.2.3.3. Edit Global Statement
Page 27 of 131
Page 28 of 131
Functional Notes
Provide a link to edit the text of the Assignment
1 AG1.5 Assignment Submission
Statement
Checkbox to enable/disable use of an institution
2 AG1.3 Sakai: use Turnitin Assignment Submission Statement. Checkbox is checked is
Assignment Submission Statement is currently enabled
Textarea to input the Assignment Submission Statement.
Textarea is pre-populated with existing text.
AG1.3, Display revised Assignment Submission Statement in a
4 Assignment Submission
AG1.5 non-editable textarea.
Statement
Page 29 of 131
3.2.3.4. Edit Plagiarism Pledge
Page 30 of 131
Page 31 of 131
Functional Notes
Sakai: use Turnitin, Sakai:
1 AG1.6 Provide a link to edit the text of the Plagiarism Pledge.
enable Plagiarism Pledge
Checkbox to enable/disable use of a Plagiarism Pledge.
Checkbox is checked is Plagiarism Pledge is currently enabled.
Textarea to input the Plagiarism Pledge text. Textarea is pre-
populated with existing text.
AG1.6, Sakai: use Turnitin, Sakai:
4 Display revised Plagiarism Pledge in a non-editable textarea.
AG1.8 enable Plagiarism Pledge
Page 32 of 131
3.2.3.5. Disable GradeMark
Page 33 of 131
Page 34 of 131
Functional Notes
Sakai: use Turnitin, Turnitin Account:
AG1.9, Show GradeMark as enabled and provide a link to
1 GradeMark enabled, Sakai: use
AG1.10 disable.
GradeMark
AG1.9, Sakai: use Turnitin, Turnitin Account: Show GradeMark as disabled and provide a link to
2
AG1.10 GradeMark enabled enable.
Page 35 of 131
3.2.3.6. View Registration Information
Page 36 of 131
Page 37 of 131
Functional Notes
Display current Account ID and Shared Secret. Provide a link
to view and edit registration information.
Provide input to edit Account ID. Input is pre-populated with
existing registration information.
Provide input to edit Shared Secret. Input is pre-populated
with existing registration information
4 AG1.13 Sakai: Turnitin registered Display revised registration information.
Page 38 of 131
3.2.4. Implementation Notes
All of global administrative functionality detailed in the preceding requirements is provided by the Turnitin Tool. As the
diagram below shows, the Turnitin Tool makes use of the Turnitin Service and related components to capture and persist
global Turnitin settings.
At a high level, the component interaction sequence is as follows:
1. The Turnitin Tool captures user input of Turnitin-specific data (e.g. shared secret)
2. The Turnitin Tool passes this data to the Turnitin Service for processing
3. The Turnitin Service communicates with Turnitin (via TII API) as necessary
4. The Turnitin Service uses the Turnitin Data Access Object (DA0) to persist the data to the database
At that point, the Turnitin Service can then be used by the Turnitin Tool (or other Sakai Tool or Service) to access global
Turnitin settings.
Page 39 of 131
Alternate Implementation
Instead of using the Turnitin Tool to capture, manage and persist global Turnitin settings, each setting could be defined as a
property in the sakai.properties file. For example, the shared secret could be defined as sakai.turnitin.sharedsecret=secret.
Sakai provides a robust properties infrastructure allowing properties to be set or overridden at multiple levels and easily
accessed using the ServerConfigurationService.
3.3. Administer Course Turnitin

3.3.1. Requirements
Display the institution assignment Provide the ability for the course instructor to read the institution assignment
AC1.0
submission message submission message
Enable use of a course assignment Provide the ability to enable use a course assignment submission message that
AC1.1
submission message students will see when submitting a Turnitin assignment to this course
Disable use of a course assignment
AC1.2 Provide the ability to disable use a course assignment submission message
submission message
Display the "course assignment
AC1.3 Provide the ability to view the "course assignment submission statement"
submission statement"
Edit "course assignment submission
AC1.4 Provide the ability to edit the "course assignment submission statement" content
statement"
AC1.5 Display the plagiarism pledge Provide the ability for the course instructor to read the plagiarism pledge
3.3.2. Scenario
An instructor is enabling Turnitin for use in the selected course. The instructor is able to read and review the Institution
assignment submission statement and select use of an instructor note for Turnitin assignment submission. If the instructor opts
to use an Instructor note, that content is input. Upon activation, the instructor may read and see a reasonable preview of what
the student will see in the Institution assignment submission statement, Instructor note, and Plagiarism pledge.
Page 40 of 131
3.3.3. Screens
3.3.3.1. Add Instructor Note
Assignments Tool - Turnitin view (new)
Page 41 of 131
Page 42 of 131
Functional Notes
1 IR1.12 Sakai: use Turnitin Indicate use of Turnitin for course assignments.
2 Sakai: use Turnitin Show the status of Turnitin at the Course level.
Display the content of the institution Assignment Submission
Sakai: use Turnitin, Sakai: Statement in a non-editable textarea. If the institution Assignment
3 AC1.3 use Assignment Submission Statement is not enabled, the textarea (and the
Submission Statement preceding note "Your institution has chosen to display...") is not
displayed.
Page 43 of 131
4 AC1.1 Sakai: use Turnitin Provides a link to set the Instructor Note.
Display the content of the Plagiarism Pledge in a non-editable
Sakai: use Turnitin, Sakai:
5 AC1.5 textarea. If the Plagiarism Pledge is disabled, the Plagiarism
Pledge section (title, note, and textarea) is not displayed.
Sakai: use Turnitin, Sakai: Show the use of GradeMark. If GradeMark is disabled, the
6
use GradeMark GradeMark section (title and note) is not displayed.
7 AC1.4 Sakai: use Turnitin Provides an input for the Instructor Note content.
Sakai: use Turnitin,
When an Instructor Note has been input, display the content of the
8 AC1.3 Course: use Instructor
Instructor Note in a non-editable textarea.
Note
When an Instructor Note has been input, provide a link to set the
9 AC1.4 Course: use Instructor
use of the Instructor Note and to edit the content.
Note
Page 44 of 131
3.3.3.2. Edit Instructor Note
Assignments Tool - Turnitin view (new)
Page 45 of 131
Page 46 of 131
Functional Notes
AC1.1, Sakai: use Turnitin, Course: use When an Instructor Note has been input, provide a link to
1
AC1.4 Instructor Note set the use of the Instructor Note and to edit the content.
Sakai: use Turnitin, Course: use Allow the Instructor Note to be enable/disabled by
2 AC1.1
Instructor Note checkbox.
Sakai: use Turnitin, Course: use
3 AC1.4 Instructor Note content may be edited by textarea.
Instructor Note
Sakai: use Turnitin, Course: use
4 AC1.4 Display revised Instructor Note.
Instructor Note
The component interaction sequence for administering Turnitin at the course worksite level is very similar to the global Sakai
Turnitin administration sequence. Like the global administration sequence, the course worksite level sequence uses the
Turnitin Service components to process and persist Turnitin settings, the difference being settings are associated with a
worksite instead of the entire Sakai instance. However, as the diagram below shows, the major difference between Turnitin
administration at the global and course worksite level is that the interaction begins in the Turnitin-specific Assignments Tool
extension.
Page 47 of 131
1. The Turnitin-specific Assignments Tool extension captures user input of Turnitin-specific data for this course worksite
2. The Turnitin Tool passes this data to the Turnitin Service for processing
3. The Turnitin Service uses the Turnitin Data Access Object (DA0) to persist the data to the database
Changes to the existing Assignments Tool support this functionality would include:
• Creating a new version of the assignments list Velocity template to support the Turnitin intra-tool navigation option
• Creating new versions of the Turnitin administrative templates, largely reusing the templates from the Turnitin Tool
• Extend the AssignmentAction class to support rendering of the Turnitin intra-tool navigation option
• Extend the AssignmentAction class or create a new class to manage the Turnitin administration workflow and interact
with the Turnitin Service
Page 48 of 131
3.4. Add a Turnitin assignment
3.4.1. Requirements
Enable use of Turnitin for an
AA1.0 Provide the ability to enable Turnitin for an individual assignment.
assignment
Provide the ability to disable the use of TII for an assignment.
In the case where TII has previously been enabled for this assignment and has
submissions/Originality Reports, the following should occur:
Disable use of Turnitin for an

AA1.1 All existing originality reports will remain, and will not be deleted
assignment
Links to existing originality reports will be removed
Users will not be able to generate new originality reports
Provide the ability to create a TII assignment with the following custom publishing
options:
• Provide the ability to enable use of QuickMark (requires QuickMark

product).
• Provide the ability to disable use of QuickMark.

AA1.2 Create Turnitin assignment
• Provide the ability to enable generation of originality reports for submitted
assignments.
• Provide the ability to disable generation of originality reports for submitted

assignments.
• Provide the ability to select the action that triggers the generation of an
originality report for a submitted assignment. Requires generation of
Page 49 of 131
originality reports to be enabled. Options are: "Immediately, first report is
final" (default), "Immediately, can overwrite reports until due date", "On due
date"
• Provide the ability to set the visibility of originality reports to the student that
submitted the assignment. Requires generation of originality reports to be
enabled. Options are: "No" (default), "Yes"
• Provide the ability to set the location of the repository to which assignment
submissions will be saved. Requires generation of originality reports to be
enabled. Options are: "Standard paper repository", "No repository",
"Institution repository" (if applicable)
• Provide the ability to set the repository location that will be checked against
for determining originality. Requires generation of originality reports to be
enabled. Options are: "student paper repository" (default checked), "current
and archived internet" (default checked), "periodicals, journals, &
publications" (default checked), "institution repository" (default checked if
option is shown)
• Provide the ability to select use of a plagiarism pledge to display and be
agreed to by the student submitting the assignment.
• Provide the ability to select use of course assignment submission message
(default)
• Provide the ability to enable use of GradeMark for an assignment (if enabled
at global level)
• Provide the ability to disable use of GradeMark for an assignment (if enabled
at global level)
Prohibit use of GradeMark for

Provide the system function to return error when use of GradeMark is selected and
AA1.3 assignments not selected for
"Add Assignment to Gradebook" is NOT the selected grading option
addition to the Sakai Gradebook
Prohibit use of GradeMark with
Provide the system function to return error when use of GradeMark is selected and
AA1.4 Grade Scale selections that do
"Points" is NOT the selected grade scale value
not work with Sakai Gradebook
AA1.5 Edit a TII assignment Provide the ability to edit a TII assignment (Assignments tool default)
Page 50 of 131
Provide the ability to delete a TII assignment (Assignments tool default) with the
following effects:
- Files in the submission will be deleted in Sakai
- Files in the submission will not be deleted in Turnitin
- Files in the submission that were indexed, will not be removed from the index in
AA1.6 Delete an assignment
Turnitin
- Originality reports for the files in the submission will be deleted in Turnitin; links
to originality reports in Sakai will be removed
- GradeMark files for the files in the submission will be deleted in Turnitin; links to
GradeMark files in Sakai will be removed
AA1.7 Allow inline submissions Provide the system function to submit "Inline Only" submissions to TII
AA1.8 Allow attachment submissions Provide the system function to submit "Attachments Only" submissions to TII
Prohibit combined inline and Provide the system function to return error when use of TII is selected and "Inline
AA1.9
attachments submissions and Attachments" is the selected student submission method value
Prohibit non-electronic Provide the system function to return error when use of TII is selected and "Non-
AA1.10
submissions electronic" is the selected student submission method value
Provide the ability to disable use of GradeMark for an assignment.
In the case where GM has previously been enabled for this assignment and has
submissions/GM reports; the following should occur:
All existing GradeMark files will remain, and will not be deleted
Links to existing GradeMark files will be removed and users will not be able
AA1.11 Disable use of GradeMark to access GradeMark functionality
All existing GM reports will remain, and will not be deleted
Links to existing GM reports will be removed
Users will not be able to generate new GM reports
Page 51 of 131
3.4.2. Scenario
An instructor creates a Turnitin assignment by selecting use of Turnitin in the Assignments Tool Add Assignment view. Once
selected, additional Turnitin assignment options become available. The instructor sets the general and Turnitin assignment
options, previews the assignment, and posts it.
3.4.3. Screens
Page 52 of 131
3.4.3.1. Add Assignment
Assignments Tool - Add Assignment view
Page 53 of 131
Page 54 of 131
Page 55 of 131
Functional Notes
Sakai: use Turnitin, Turnitin assignment options are revealed when the
AA1.0, AA1.1,
1 Assignment:Student Submissions: checkbox is checked and are hidden when it is
AA1.2
Attachments Only unchecked. Default is unchecked.
Determines target file location of submissions. Single
2 AA1.2 Assignment: use Turnitin
select. Default is Standard Paper Repository
Determines trigger for generation of originality report.
3 AA1.2 Assignment: use Turnitin Single select. Default is Immediately - first report is
final
Determines ability for students to see originality
reports. Default is unchecked, do not allow.
Determines what the submission will be checked
against for originality. Institution-specific repository
Assignment: use Turnitin, (Sakai:
5 AA1.2 option is only displayed when enabled at the Sakai level
use institution-specific repository)
(and requires it to be active on the institution's Turnitin
account). All options are checked by default.
Sets use of QuickMark and Rubric type. Default is
6 AA1.2 Assignment: use Turnitin unchecked, do not use. Rubric selection is single select
and defaults to Select Rubric.
Sets display of Instructor Turnitin Note. Option appears
Assignment: use Turnitin, Course: if the instructor has selected use at the course level. If
7 AA1.2
use Instructor Note instructor has selected use, it is checked by default. The
Note content is displayed in a non-editable textarea.
Sets use of the plagiarism pledge. Default is unchecked,
Assignment: use Turnitin, Sakai:
8 AA1.2 do not use. The Pledge content is displayed in a non-
editable textarea.
Sets use of GradeMark. Default is checked, allow use
9 AA1.2 use GradeMark, Assignment:Grade
of GradeMark.
Scale: Points
Displays Turnitin option settings in Assignment
Preview.
Page 56 of 131
Displays institution Turnitin Statement in the Student
Assignment: use Turnitin, Sakai: View of the Assignment Preview. Statement is pre-
11 AA1.2
use Turnitin Statement pended by the title "This assignment will be checked
for plagiarism".
Displays Instructor Turnitin Note in the Student View
Assignment: use Turnitin, Course: of the Assignment Preview. Note is pre-pended by the
12 AA1.2
use Instructor Note title "This assignment will be checked for plagiarism"
in the condition there is no Turnitin Statement.
Displays Plagiarism Pledge in the Student View of the
Assignment Preview. Pledge is pre-pended by the title
13 AA1.2 "This assignment will be checked for plagiarism" in the
condition there is no Turnitin Statement or Turnitin
Instructor Note.
Page 57 of 131
3.4.3.2. Edit Assignment
Assignments Tool - Edit Assignment view
Page 58 of 131
Page 59 of 131
Functional Notes
Course: Assignment Returns user to original creation screen where previously-selected
1 AA1.5
exists values are displayed; entire form is available for editing.
Course: Assignment Submits assignment to TII following the same logic as for initial
2 AA1.5
exists creation.
Page 60 of 131
3.4.3.3. Delete Assignment
Assignments Tool - Assignment List view
Functional Notes
Utilizes standard Assignments tool functionality to remove the
Course: Assignment
1 AA1.6 selected assignment.
exists
The diagram below shows the component interaction sequence for adding a Turnitin-enabled assignment. In general, the
interaction sequence will be similar to standard assignment creation in Sakai. However, some notable differences include using
Turnitin-specific extension of both the Assignment Tool and Assignment Service and the addition of an API call to Turnitin.
Note, the sequence for editing or deleting a Turnitin-enabled assignment is very similar to the add sequence.
Page 61 of 131
The component interaction sequence is a follows:
1. The Turnitin-specific Assignments Tool extension captures user input of assignment data including Turnitin-specific
options
2. The Assignments Tool extension follows the typical Sakai assignment creation process albeit using a version of the
Sakai Assignment Service extended to support Turnitin
3. The assignment is created successfully within Sakai
4. The Turnitin Service is used to make an API call to create the assignment in Turnitin
5. The Turnitin Service receives confirmation from Turnitin that the assignment was created and parses the Turnitin
assignment identifier from the response
6. The Turnitin Service uses the extended Assignment Service to associate the Turnitin assignment identifier with the
assignment in Sakai
The table below provides detail on the Turnitin API call to be executed as part of the add, edit or delete assignment process.
Function Name FID FCMD

Create Assignment 4 2
Edit Assignment 4 3
Delete Assignment 4 4
Page 62 of 131
This API call creates, modifies or deletes the assignment in Turnitin and returns an assignment identifier that should then be
associated with the assignment in Sakai. Note, in the delete case, the assignment will be removed in Sakai so there is no need
to process the assignment identifier returned by Turnitin.
Additional items required to support this functionality include:
• Creating new versions of the add assignment Velocity templates to support Turnitin options
• Extending the AssignmentAction class to support rendering and capturing of Turnitin options
• Extending the Assignment Entity to support persisting of Turnitin options
• Extending the Assignment Service to support processing of Turnitin-enabled assignments and expose additional
methods such as the ability to associate a Turnitin assignment identifier with a Sakai assignment
3.5. Submit a Turnitin assignment

3.5.1. Requirements
Provide the ability to submit a Turnitin assignment with the following
conditions:
• Provide the ability for the student to read the institution assignment
SA1.0 Submit a Turnitin assignment submission message (if selected for use)
• Provide the ability for the student to read the course assignment
submission message (if selected for use)
• Provide the ability for the student to read and agree to the plagiarism
pledge (if selected for use)
Provide the ability to resubmit a Turnitin assignment with the following

conditions:
SA1.1 Resubmit a Turnitin assignment

• Provide the ability for the student to read the institution assignment
• Provide the ability for the student to read the course assignment
Page 63 of 131
• Provide the ability for the student to read and agree to the plagiarism
pledge (if selected for use)
Provide the ability to allow multiple attachments within a submission to a TII

SA1.2 Accept multiple attachments
assignment
Provide the ability to capture TII error when file uploads fail. Sakai should still
save the submission even if the TII transaction fails
(1) File is of the type:.doc, .wpd, .ps, .pdf, .html, .rtf, .txt
(2) File size is < 10MB; Aside: may only be changed through special request to
Turnitin
(3) File contains more than 100 character of non-whitespace
(4) File length is < 1000000 characters; Aside: may only be changed through
special request to Turnitin
(5) File contains more than 20 words of text
If an originality report cannot be generated for the file, display the following info
text:
• (1): An originality report cannot be generated for this file type.
• (2): An originality report cannot be generated because the file size is too large.
• (3): An originality report cannot be generated because the file contains less than
SA1.3 Error messaging for upload errors 100 character of non-whitespace.
• (4): An originality report cannot be generated because the file exceeds the
maximum length.
• (5): An originality report cannot be generated because the file contains less than
20 words of text.
• Other: An originality report cannot be generated for this file.
If GradeMark cannot be used for the file, display the following info text:
• (1): GradeMark cannot be used for this file type.
• (2): GradeMark cannot be used because the file size is too large.
• (3): GradeMark cannot be used because the file contains less than 100 character
of non-whitespace.
• (4): GradeMark cannot be used because the file exceeds the maximum length.
• (5): GradeMark cannot be used because the file contains less than 20 words of
text.
• Other: GradeMark cannot be used for this file.
SA1.4 Submit on behalf of a student Provide the ability for an Instructor to submit an assignment on behalf of a
Page 64 of 131
particular student
Provide the ability to queue student submissions when TII service is unavailable
Queue student submissions if service System should retry in five (5) minute intervals
SA1.5
is unavailable
System should log failure and send failure notification/message to Sakai
at: 1 hour failure (12th interval)
3.5.1.1. Notes
Sakai does not treat "group assignments" differently from individual assignments, in that group members will not
automatically get an Originality Reports or grades based on a submission by one of the group members, even if it's
technically on behalf of the entire group.
3.5.2. Scenario
The student is submitting a Turnitin assignment. The student attaches a file as the assignment submission, reads the plagiarism
statement(s), reads and agrees to the plagiarism pledge, and submits the assignment.
3.5.3. Screens
Page 65 of 131
3.5.3.1. Submit Assignment
Assignments Tool - Student view
Page 66 of 131
Functional Notes
Assignment: use Displays institution Assignment Submission Statement. Statement is
1 SA1.0 Turnitin, Sakai: use pre-pended by the title "This assignment will be checked for
Turnitin Statement plagiarism".
Assignment: use Displays Instructor Note. Note is pre-pended by the title "This
2 SA1.0 Turnitin, Course: use assignment will be checked for plagiarism" in the condition there is
Instructor Note no Assignment Submission Statement.
Displays Plagiarism Pledge. Pledge is pre-pended by the title "This
Assignment: use
assignment will be checked for plagiarism" in the condition there is
3 SA1.0 Turnitin, Sakai: enable
no Assignment Submission Statement or Instructor Note. The Pledge
Plagiarism Pledge
checkbox must be checked in order to submit the assignment.
Page 67 of 131
3.5.3.2. Submit Assignment for Student
Assignments Tool - Submit for Student view
Page 68 of 131
Page 69 of 131
Page 70 of 131
Functional Notes
Sakai: use
1 SA1.4 Adds a new view to the Assignments tool.
Turnitin
Sakai: use Displays a warning to differentiate this process from the Student View, and
2 SA1.4
Turnitin the potential ramifications.
Sakai: use
3 SA1.4 Modified Assignment List is used to select the assignment.
Turnitin
Sakai: use
SA1.4 Modified Student List is used to select the student.
4 Turnitin
Sakai: use Submission process is identical to the student process including agreement
5 SA1.4
Turnitin to pledges.
Sakai: use
6 SA1.4 Confirmation is given on successful submission.
Turnitin
Page 71 of 131
The diagram below shows the component interaction sequence for submitting a paper to Turnitin.
1. The Turnitin-specific Assignments Tool extension captures upload of the paper(s)

2. The Assignments Tool extension follows the typical Sakai process to associate the uploaded paper(s) with an
assignment
3. The paper(s) is successfully associated with the assignment
4. The Turnitin Service is used to make an API call to submit the paper to Turnitin
5. The Turnitin Service receives confirmation from Turnitin that the paper was successfully submitted and parses the
Turnitin object identifier from the response
6. The Turnitin Service uses the extended Assignment Service to associate the Turnitin object identifier (i.e. a unique ID
for the paper) with the assignment in Sakai
The table below provides detail on the Turnitin API call to be executed.
Page 72 of 131
Submit Paper 5 2
This API call submits the paper to Turnitin and returns an object identifier that should then be associated with the assignment
in Sakai. Note the use of function command (fcmd) 2. Using fcmd 2 implies that Sakai will first process the paper and then
issue a POST to Turnitin including the appropriate API parameters.
Handling submission failure
Should the initial attempt to submit a paper to Turnitin fail for any reason attempts should be made to resend the paper until
successful or until the number of failed attempts reaches a given limit. This will be handled by the scheduler component of the
Turnitin Service. At a high-level, the scheduler component will consist of a queue and process (e.g. a Quartz job) that will
handle the storage and resend attempts of failed submissions. The resend process will occur at a specified interval until success
or the specified number of failed attempts occurs for a given submission.
• Creating new versions of the submit assignment Velocity templates to support Turnitin options
• Extending the AssignmentAction class to support rendering and capturing of Turnitin options
• Extending the Assignment Service to support processing of Turnitin-enabled assignments and expose additional
methods such as the ability to associate a Turnitin object identifier with a Sakai assignment
The technical notes above deal specifically with the case where the assignment submission is an attachment (i.e. a file
uploaded to Sakai). Support for inline assignment submission (i.e. text added directly via a UI component) can be handled
similarly to the attachment case with a one minor modification. As an inline submission is processed and stored as text, the
Submit Paper Turnitin API call must use ptype=1 (ptype denotes the type of file to Turnitin). Otherwise, the same, or very
similar, logic that is used for an attachment assignment submission can be used.
3.6. View Turnitin Reports - Instructor

3.6.1. Requirements
Display "inactive" Originality Report Provide the ability to display a grayed-out indicator that assignment has been
IR1.0
indicator within the Assignments tool submitted but Originality Report is not yet available for an assignment
Page 73 of 131
View originality report within the Provide the ability to view the originality report by selecting active
IR1.1
Assignments tool Originality Report indicator
Provide the ability to display a grayed-out indicator that assignment has been
Display "inactive" GradeMark indicator
IR1.2 submitted but GradeMark is not yet available for an assignment (this is
within the Assignments tool
default until status changes)
Display "active" GradeMark indicator Provide the ability to display a colored indicator that GradeMark is available
IR1.3
within the Assignments tool for an assignment
Launch GradeMark from within the Provide the ability to launch GradeMark in a new browser window from an
IR1.4
Assignments tool active GradeMark indicator
Display "inactive" GradeMark indicator Provide the ability to display a grayed-out indicator that GradeMark is not
IR1.5
within the Gradebook tool yet available for an assignment (this is default until status changes)
Display "active" GradeMark indicator Provide the ability to display a colored indicator that GradeMark is available
IR1.6
within the Gradebook tool for an assignment
Launch GradeMark from within the Provide the ability to launch GradeMark in a new browser window from an
IR1.7
Gradebook tool active GradeMark indicator
Display GradeMark grade within the
IR1.8 Provide the ability to view the GradeMark Grade in the Sakai Gradebook
Gradebook tool
Display GradeMark grade within the
IR1.9 Provide the ability to view the GradeMark Grade in the Assignment tool
Assignments tool
IR1.10 Sort assignments by Originality Report
Provide the ability to sort assignments list by OR %
% in assignment list
Sort assignments by Originality Report
IR1.11 Provide the ability to sort gradebook list by OR %
% in gradebook
Provide the ability to view an indicator that says whether or not the
IR1.12 View indicator of TII assignment assignment is a TII assignment on the Assignment List.
Support more than one Instructor or TA Provide the ability to enable multiple Instructors and/or TAs to view reports
IR1.13
per course for the same course
Provide the ability to view an indicator denoting failure to generate an
IR1.14 View failure indicator Originality Report (failure due to server error or file upload error)
Page 74 of 131
Provide error message upon hovering over indicator
3.6.2. Scenario
In both the Assignments and Gradebook tools, an Originality Report icon and a GradeMark icon will appear for the appropriate
assignments. Until these items exist for use by the instructor, the icons will appear grayed out. When active, the icons will
appear in color and when clicked, will launch the respective application.
3.6.3. Screens
Page 75 of 131
3.6.3.1. View Originality Report - Assignment
Assignments Tool - Assignment Submission Detail view
Page 76 of 131
Functional Notes
Sakai: use Turnitin, Originality report is not displayed until a student has
1 IR1.0, IR1.1 Course:Assignment: Student made a submission. Originality report icon is inactive
Submission, Turnitin: Originality (gray) until the originality report has been returned.
Page 77 of 131
Report When an originality report has been returned, the icon
becomes active (full-color) with percentage and color
barometer.
Sakai: use Turnitin, Replace originality report icon with multiple file icon
2 SA1.2 Course:Assignment: Multiple file when multiple files are submitted to the assignment.
submission Clicking the icon goes to the assignment detail view.
Display an error icon when any of the submitted files
Sakai: use Turnitin, Turnitin Service: fails to generate an originality report. Clicking the icon
3 SA1.3
Originality report generation error goes to the Assignment detail view where the errors can
be viewed.
GradeMark,
GradeMark grade appears the same as non-GradeMark
4 IR1.9 Course:Assignment:Grade Scale:
grades.
Points, Course:Assignment:Student
Submission:Graded
GradeMark icon is inactive (gray) until a student has
IR1.2, IR1.3, made a submission that can be graded. When a student
5 GradeMark, Course:Assignment:
IR1.4 has made a submission that can be graded, the icon
Student Submission
becomes active (full-color).
Page 78 of 131
3.6.3.2. View Originality Report Errors - Assignment
Assignments Tool
Page 79 of 131
Functional Notes
Display an error icon when any of the submitted files
Sakai: use Turnitin, Turnitin Service:
1 SA1.3 fails to generate an originality report. Clicking the icon
Originality report generation error
goes to the Assignment detail view where the errors
Page 80 of 131
can be viewed.
Sakai: use Turnitin, Turnitin Service: Hover of mouse on the error icon next to the failing
2 SA1.3
Originality report generation error files displays the error messages.
Page 81 of 131
3.6.3.3. View Originality Report - Gradebook
Gradebook Tool - Assignment Submission Detail view
Functional Notes
Sakai: use Turnitin, Originality report is not displayed until a student has made a
1 IR1.0
Course:Assignment: Student submission. Originality report icon is inactive (gray) until the
Page 82 of 131
Submission, Turnitin: originality report has been returned. When an originality
Originality Report report has been returned, the icon becomes active (full-color)
with percentage and color barometer. When active, the icon
may be clicked to launch a view of the originality report (in a
new browser window).
GradeMark
Course:Assignment:Grade GradeMark grade appears the same as non-GradeMark
2 IR1.8
Scale: Points, grades.
Course:Assignment:Student
Submission:Graded
GradeMark icon is inactive (gray) until a student has made a
Sakai: use Turnitin, Sakai: use submission that can be graded. When a student has made a
IR1.5, IR1.6, GradeMark, submission that can be graded, the icon becomes active (full-
3
IR1.7 Course:Assignment: Student color). When active, the GradeMark icon may be clicked to
Submission launch the GradeMark application (in a new browser
window).
Sakai: use Turnitin, Turnitin Display an error icon when any of the submitted files fails to
4 SA1.3 Service: Originality report generate an originality report. Clicking the icon goes to the
generation error Assignment detail view where the errors can be viewed.
Course:Assignment: Student Originality report is not displayed until a student has made a
5 IR1.0
Submission, Turnitin: submission.
Originality Report
Page 83 of 131
3.6.3.4. Sort by Originality Report - Gradebook
Functional Notes
Course:Assignment: use Allows sorting of table data by clicking on the Report table
1 IR1.11
Turnitin header. Results are sorted initially from most original to least
Page 84 of 131
original, followed by submissions being processed
(alphabetically), followed by no submissions (alphabetically).
Clicking the table header again reverses the sort order.
Page 85 of 131
3.6.3.5. Launch Originality Report

Page 86 of 131
Functional Notes
Course:Assignment: Student When active, the icon may be clicked to launch a view of
1 IR1.0, IR1.0
Submission, Turnitin: Originality the originality report (in a new browser window).
Report
Page 87 of 131
3.6.3.6. Launch GradeMark

Page 88 of 131
Functional Notes
GradeMark icon is inactive (gray) until a student has made
a submission that can be graded. When a student has made
IR1.3, IR1.4,
a submission that can be graded, the icon becomes active
1 IR1.5, IR1.6, Sakai: use GradeMark
(full-color). When active, the GradeMark icon may be
IR1.8
clicked to launch the GradeMark application (in a new
browser window).
Sakai: use GradeMark,
2 IR1.7 Course:Assignment:Grade Scale: Submit grade via GradeMark.
Points
Page 89 of 131
View Originality Report
The diagram below details the component interaction sequence necessary to render the originality report.
1. A user requests the assignments list page

2. The Turnitin-specific Assignments Tool extension follows the typical process for rendering the assignments list.
However, the Assignments Tool also interacts with the Turnitin Service to retrieve the API URL to the originality
report, report data (report score and status), and GradeMark status for each assignment (Note the API calls should only
be performed if the assignment has an associated Turnitin object identifier associated meaning a paper has been
submitted and scored for the assignment)
3. A user clicks on the Turnitin icon
4. A new browser window is opened and the originality report is displayed in the new browser window (Return Report
API Call)
The tables below provides detail on the Turnitin API call to be executed to view the originality report.
Page 90 of 131
Return Report 6 2
This API call would be performed at page render time for each assignment to retrieve the report score. Not the use of function
command (fcmd) 2, denoting that XML containing the score will be returned.

Return Report 6 1
This API call is initiated by the user by clicking the Turnitin icon for a given assignment. The use of function command (fcmd)
1 denotes that the Originality Report will be rendered directly without any back-end processing needed from Sakai.
• Creating new versions of the appropriate assignment Velocity templates to support Turnitin related icons and data
• Extending the AssignmentAction class to support rendering of Turnitin icons and accessing of the Turnitin Service to
retrieve the API URL for the given assignment.
View GradeMark
The diagram below details the component interaction sequence necessary to render GradeMark for an instructor.
Page 91 of 131
1. User initiates request of the "grade view" of the assignments list page in the Turnitin-specific Assignments Tool
extension or the gradebook item summary page in the Turnitin-specific Gradebook Tool extension
2. For each assignment, the Turnitin-specific Assignments or Gradebook Tool determines if the GradeMark icon should
be enabled. This can be accomplished by using the extended Assignments Service to determine if the assignment has an
associated Turnitin object identifier (if object identifier is not null, the GradeMark icon is enabled)
3. For each assignment where the GradeMark icon is enabled the Turnitin Service is used to construct an API URL to
launch GradeMark
4. The user selects the GradeMark icon
5. An API call is issued requesting GradeMark to be rendered in a new browser window
6. GradeMark is rendered in a new browser window

Return GradeMark 13 1
Page 92 of 131
This API call is initiated by the user by clicking the GradeMark icon for a given assignment. The use of function command
(fcmd) 1 denotes that GradeMark will be rendered directly without any back-end processing needed from Sakai.
• Creating new versions of the appropriate assignment and gradebook templates to support GradeMark related icons and
data
• Extending the Action classes used to render the templates to support rendering of GradeMark icons and accessing of
the Turnitin Service to retrieve the API URL for the given assignment and interacting with the Turnitin-specific
Assignment Service extension to perform the object identifier check.
• Extending the Assignments Service to lookup assignments by Turnitin object identifier
3.7. View Turnitin Reports - Student

3.7.1. Requirements
Display "inactive" Originality Report Provide the ability to display a grayed-out indicator that Originality
SR1.0 indicator when report is not available, within Report is not yet available for an assignment, when the assignment has
the Assignments tool been returned to Student or when grades have been released
Provide the ability for a student view their Originality Report by
View originality report upon assignment
SR1.1 clicking an active Originality Report indicator when an individual
return to student, within the Assignments tool
assignment has been returned to the student
Provide the ability for all students to view their Originality Report by
View originality report upon grade release,
SR1.2 clicking an active Originality Report indicator when grades have been
within the Assignments tool
released for the assignment
Display "inactive" GradeMark indicator Provide the ability to display a grayed-out indicator that GradeMark is
SR1.3
within the Assignments tool not yet available for an assignment (this is default until status changes)
View GradeMark upon assignment return to Provide the ability for a student view active GradeMark indicator when
SR1.4
student, within the Assignments tool an individual assignment has been returned to the student
View GradeMark upon grade release, within Provide the ability for all students to view active GradeMark indicator
SR1.5
the Assignments tool when grades have been released for the assignment
Display "inactive" GradeMark indicator Provide the ability to display a grayed-out indicator that GradeMark is
SR1.6
within the Gradebook tool not yet available for an assignment (this is default until status changes)
Page 93 of 131
Display "active" GradeMark indicator within Provide the ability to display a colored indicator that GradeMark is
SR1.7
the Gradebook tool available for an assignment
Launch GradeMark from within the Provide the ability to launch GradeMark in a new browser window
SR1.8
Gradebook tool from an active GradeMark indicator
Display GradeMark grade within the Provide the ability to view the GradeMark Grade in the Sakai
SR1.9
Gradebook tool Gradebook
Display GradeMark grade within the Provide the ability to view the GradeMark Grade in the Assignments
SR1.10
Assignments tool tool
3.7.2. Scenario
When the instructor has released the assignment to the student, all eligible TII reports should also be released to the student.
The student can view the report at the same screen non-TII assignments are released and viewed.
Note that TII provides the option to produce an Originality Report at a specific time - however, we are using the default Sakai
functionality around returning or releasing assignments as the control mechanism for students viewing Originality Reports.
3.7.3. Screens
3.7.3.1. Released Assignment
Assignment Tool - Assignment Detail view
Page 94 of 131
Functional Notes
Sakai: use Turnitin, Sakai: use GradeMark,
Course:Assignment:Grade Scale: Points, GradeMark grade appears the same as non-
1 SR1.10
Course:Assignment:Student Submission: GradeMark grades.
Graded, Turnitin: GradeMark grade
Originality report is not displayed until a
student has made a submission. Originality
report icon is inactive (gray) until the
Sakai: use Turnitin, Course:Assignment: allow
originality report has been returned. When an
SR1.0, students to view originality reports,
2 originality report has been returned, the icon
SR1.1, SR1.2 Course:Assignment: Student Submission,
becomes active (full-color) with percentage
Turnitin: Originality Report
and color barometer. When active, the icon
may be clicked to launch a view of the
originality report (in a new browser window).
GradeMark icon is inactive (gray) until the
Sakai: use Turnitin, Sakai: use GradeMark, instructor has graded the assignment with
3 SR1.3, SR1.5 Course:Assignment: Student Submission, GradeMark. When an instructor has graded
Turnitin: GradeMark grade the assignment with GradeMark, the icon
becomes active (full-color).
Page 95 of 131
3.7.3.2. Returned Assignment
Assignment Tool - Assignment Detail view
Functional Notes
Sakai: use Turnitin, Originality report is not displayed until a student has made
Course:Assignment: allow a submission. Originality report icon is inactive (gray) until
students to view originality the originality report has been returned. When an
SR1.0, SR1.1,
1 reports, originality report has been returned, the icon becomes
SR1.2
Course:Assignment:Student active (full-color) with percentage and color barometer.
Submission: Returned, Turnitin: When active, the icon may be clicked to launch a view of
Originality Report the originality report (in a new browser window).
Sakai: use Turnitin, Sakai: use GradeMark icon is inactive (gray) until the instructor has
GradeMark, Course:Assignment: graded the assignment with GradeMark. When an
2 SR1.3, SR1.4
Student Submission, Turnitin: instructor has graded the assignment with GradeMark, the
GradeMark grading icon becomes active (full-color).
Page 96 of 131
3.7.3.3. Graded Assignment
Functional Notes
Originality report is not displayed until a student has made
a submission. Originality report icon is inactive (gray)
Course:Assignment: allow students
until the originality report has been returned. When an
SR1.0, to view originality reports,
1 originality report has been returned, the icon becomes
SR1.1, SR1.2 Course:Assignment: Student
active (full-color) with percentage and color barometer.
Submission, Turnitin: Originality
When active, the icon may be clicked to launch a view of
Report
the originality report (in a new browser window).
GradeMark GradeMark grade appears the same as non-GradeMark
2 SR1.9
Course:Assignment:Grade Scale: grades.
Points, Course:Assignment:Student
Page 97 of 131
Submission: Graded, Turnitin:
GradeMark grade
Sakai: use Turnitin, Sakai: use GradeMark icon is inactive (gray) until the instructor has
SR1.6, GradeMark, Course:Assignment: graded the assignment with GradeMark. When an
3
SR1.7, SR1.8 Student Submission, Turnitin: instructor has graded the assignment with GradeMark, the
GradeMark grade icon becomes active (full-color).
View Originality Report
In general, the technical considerations for providing the functionality for a student to view the originality report are the same
as those detailed in the instructor view originality report case. One significant difference, however, is that before enabling the
Originality Report icon an additional check of the assignment is necessary to ensure that the assignment has been graded or
returned to the student by the instructor.
View GradeMark
The diagram below details the component interaction sequence necessary to render GradeMark for a student.
Page 98 of 131
1. User initiates request of the "grade view" of the assignments list page in the Turnitin-specific Assignments Tool
extension or the grade report page in the Turnitin-specific Gradebook Tool extension
2. The Turnitin-specific Assignments or Gradebook Tool determines if the GradeMark icon should be enabled for the
given assignment. As in the instructor case, this can be accomplished by using the extended Assignments Service to
determine if the assignment has an associated Turnitin object identifier (if object identifier is not null, the GradeMark
icon is enabled). Additionally, in the student case, two more checks must be performed to determine if the GradeMark
icon is enabled. First, the assignment must have been returned to the student by the instructor. Second, the instructor
must have used GradeMark to either grade or comment on the assignment. The second condition can be checked by
issuing an API call to Turnitin
3. For an assignment where the GradeMark icon is enabled the Turnitin Service is used to construct an API URL to
launch GradeMark
4. The user selects the GradeMark icon
5. An API call is issued requesting GradeMark to be rendered in a new browser window
6. GradeMark is rendered in a new browser window
Page 99 of 131
Return GradeMark 13 1
This API call is initiated by the user by clicking the GradeMark icon for a given assignment. The use of function command
(fcmd) 1 denotes that GradeMark will be rendered directly without any back-end processing needed from Sakai.
Additionally, Turnitin must supply another API call that given a student and assignment will return whether the student should
have access to GradeMark.
• Creating new versions of the appropriate assignment and gradebook templates to support GradeMark related icons and
data
3.8. Duplicate Turnitin Course

3.8.1. Requirements
Duplicate a Provide the ability to duplicate a course that is using Turnitin, where all course level flag settings
DC1.0
course are carried forward
3.8.2. Scenario
At the instructor's discretion, the duplicate course option is used. For a TII assignment, the duplicate function behaves as it
does now for a non-TII course, and all the TII attributes for the assignments in the originating course will carry forward to the
duplicated assignments in the duplicated course.
• When assignments are duplicated via the course duplicate feature, specific students or student attributes (grades) are
not duplicated. All of the assignment attributes are carried forward, including the dates. The instructor must change the
dates to make the new assignment meaningful.
3.8.3. Screens
Page 100 of 131

Site Info Tool
There are no workflow screens specific to TII when duplicating a course. Sakai duplicates a course on click of the duplicate
link from the Site Info tool and requires the user to input only a course title and term - there is no specific TII input needed.
The course and all its attributes (including TII in this integration) are duplicated to the new course, which may then be edited
in the normal means.
Screenshot of existing Sakai duplicate course:
Page 101 of 131

Page 102 of 131
The diagram below shows the component interaction sequence for duplicating a Sakai course worksite containing Turnitin-
enabled assignments.
1. User initiates duplicate course from the Site Info Tool

2. The SiteAction class (part of the Site Info Tool) processes duplicate course request as usual
3. The Turnitin-specific Assignment Service extension handles assignment duplication including handling of all Turnitin-
specific assignment settings for each assignment within the course via the transferCopyEntities method
4. For each assignment that is duplicated successfully
2. The Turnitin Service receives confirmation from Turnitin that the assignment was created and parses the
Turnitin assignment identifier from the response
3. The Turnitin Service uses the extended Assignment Service to associate the Turnitin assignment identifier with
the assignment in Sakai
Page 103 of 131


This API call creates the assignment in Turnitin and returns an assignment identifier that should then be associated with the
assignment in Sakai.
• Overriding the transferCopyEntities of BaseAssignmentService in the Turnitin-specific Assignment Service extension

to support Turnitin assignment settings.
3.9. Reuse Existing Assignments

3.9.1. Requirements
Provide the ability to duplicate a Turnitin assignment where all assignment level flag
DA1.0 Duplicate a TII assignment
settings are carried forward
Import Assignments from Provide the ability to use Import from Site feature to import Assignments from another
DA1.1
another site worksite; all TII attributes should come over in the import
3.9.2. Scenario
At the instructor's discretion, the duplicate course option is used. For a TII assignment, the duplicate function behaves as it
does now for a non-TII course, and all the TII attributes for the assignments in the originating course will carry forward to the
duplicated assignments in the duplicated course.
• When assignments are individually duplicated, specific student attributes (grades) are not duplicated. The title is
modified to have "-Copy" appended at the end to ensure uniqueness. All of the assignment attributes are carried
forward, including the dates. The instructor must change the title and dates to make the new assignment meaningful.
Page 104 of 131

3.9.3. Screens
Assignments Tool
There are no workflow screens specific to TII when duplicating an assignment. Sakai duplicates an assignment on click of the
duplicate link and does not require the user to input or change information. The assignment and all its attributes (including TII
in this integration) are duplicated to the new assignment, which may then be edited in the normal means.
Screenshot of existing Sakai duplicate assignment:
Page 105 of 131

The diagram below shows the component interaction sequence for duplicating a Turnitin-enabled assignment. In general, the
component interaction sequence will be very similar to the add Turnitin assignment sequence.
1. User initiates duplicate assignment from the Turnitin-specific Assignments Tool extension
2. The Assignments Tool extension follows the typical Sakai duplicate assignment processing
3. The Turnitin-specific Assignment Service extension handles assignment duplication including handling of all Turnitin-
specific assignment settings
4. The assignment is duplicated successfully within Sakai
6. The Turnitin Service receives confirmation from Turnitin that the assignment was created and parses the Turnitin
assignment identifier from the response
7. The Turnitin Service uses the extended Assignment Service to associate the Turnitin assignment identifier with the
assignment in Sakai
The table below provides detail on the Turnitin API call to be executed as part of the add assignment process.
Page 106 of 131

This API call creates the assignment in Turnitin and returns an assignment identifier that should then be associated with the
assignment in Sakai.
• Extending the Assignment Service to support handling of Turnitin-specific assignments settings on assignment
duplication
Import Existing Assignment
The requirement (DA 1.1) to handle importing an assignment from another worksite can be handled in the same manner as
detailed above for duplicating assignment with the exception that the process is initiated from the Sakai Site Info Tool.
3.10. Grade Assignment

3.10.1. Requirements
Receive/store initial grade from GradeMark and Provide the ability to receive and store a grade from GradeMark
GA1.0
input into Sakai when no grade previously existed
Provide the ability to receive/store an updated grade from
Receive/store updated grade from GradeMark and
GA1.1 GradeMark
input into Sakai
- Provide the ability to overwrite the existing grade
Provide the ability to send a Sakai gradebook grade to TII, will
GA1.2 Send grade entered into Sakai to TII
update the GradeMark screen
Provide the ability to enable multiple Instructors and/or TAs to
GA1.3 Support more than one Instructor or TA per course
grade assignments for the same course
Page 107 of 131

3.10.2. Scenario
GradeMark provides the ability for an instructor to enter and submit a grade. If an instructor chooses to grade via GradeMark,
the grade should be programmatically sent to and stored within Sakai. In addition, if the instructor chooses to update a grade
already submitted via GradeMark, the updated grade should also be sent, and should overwrite the existing grade.
3.10.3. Screens
Page 108 of 131

3.10.3.1. Submit Grade from GradeMark
System communication from GradeMark product to Sakai - no Sakai user interface.
Page 109 of 131

Functional Notes
Provide a link to launch the GradeMark
1 GA1.0 Sakai: use GradeMark application (Assignments and Gradebook
tools).
Sakai: use GradeMark,
2 GA1.0 Submit grade via GradeMark.
Course:Assignment:Grade Scale: Points
Page 110 of 131

The diagram below details the component interaction sequence for obtaining and persisting a grade from GradeMark to Sakai.
The high-level component interaction sequence is as follows:
1. User has launched GradeMark from the Assignments or Gradebook Tool

2. User has entered a grade in GradeMark
3. GradeMark recognizes the assignment as a Sakai assignment
4. GradeMark issues a call to the GradeMark web service exposed by the Turnitin Tool in Sakai
5. The Turnitin Tool processes the web service call
6. The Turnitin Tool retrieves the assignment submission via the Turnitin-specific Assignment Service extension using
the Turnitin object identifier
7. The Turnitin Tool passes the assignment submission and grade data to the Gradebook service to process and persist the
grade
Note, the functionality to call the GradeMark web service exposed by Sakai does not yet exist in GradeMark. This must be
developed by Turnitin.
Page 111 of 131

The GradeMark web service exposed by the Turnitin Tool must accept at a minimum the Turnitin object identifier, which can
be mapped to an assignment submission in Sakai, and the grade data.
Posting a grade from Sakai to GradeMark
The diagram below details the component interaction sequence for posting a grade from Sakai to GradeMark.
The high-level component interaction sequence is as follows:
1. User has entered a grade in the Turnitin extended Gradebook Tool

2. Turnitin extended Gradebook Tool recognizes the assignment as a Turnitin assignment
3. Turnitin extended Gradebook Tool issues a call to the Turnitin extended Gradebook Service
4. Turnitin extended Gradebook Service processes the grade in typical Sakai fashion
5. Turnitin extended Gradebook Tool issues a call to the Turnitin Service
6. Turnitin Service makes API call to Turnitin/Grademark to post grade
Page 112 of 131

4. Future Considerations
The requirements detailed in the sections above are considered Phase 1 integration requirements. During the development of this
functional specification, several areas were identified for possible inclusion in the integration and community feedback offered several
additional possible enhancements. All future considerations have been included in this section.
4.1. Update to Assignments 2
Discussion is currently underway regarding the value of a TII integration with Assignments 1, given that the Assignments 2 tool is
scheduled for release within the next year.
4.2. DropBox Tool Enhancements
The Sakai DropBox tool was examined for potential impacts. Since the current DropBox is not connected to the Assignments tool,
there was no logical out of the box integration proposed. However, DropBox could be enhanced to support submission of assignments,
thus allowing submission of a TII via DropBox. This would also enable the business scenario of accommodating student submissions
directly without requiring an association to an assignment.
4.3. Filtering
• The ability to filter the assignments list by Originality Report % value

• The ability to filter the gradebook by Originality Report % value
4.4. Additions to the Assignments Tool
The Assignments Tool is the primary focus of this proposed integration. Additional functionality that could be considered to be added
to the existing Assignment tool includes:
• The ability to enable/disable TII for a particular course

o Is there value in allowing the instructor to either set TII as default, or to denote never to display the option?
• The ability to edit the "institution assignment submission statement" content
o Would an institution want each instructor to be able to modify the global statement?
• The ability to edit the "plagiarism pledge" content
o Would an institution want each instructor to be able to modify the pledge?
Page 113 of 131

4.5. Additions to the proposed TII Admin Tool
The TII Admin Tool is a proposed tool that will control the administrative features of the Sakai-Turnitin integration. Additional
functionality that could be considered for the proposed new TII Admin tool includes:
• The ability to enable/disable the Instructor's use of the "course assignment submission statement"
• The ability to enable/disable the Instructor's ability to edit the "institution assignment submission statement".
• The ability to enable/disable the Instructor's ability to edit the "plagiarism pledge".
• The ability to enable/disable the Instructor's ability to edit the "course assignment submission statement".
4.6. Use of the GradeMark Product
Within this document, the use of the GradeMark is treated as a publishing choice within a Turnitin assignment. This assumes that an
instructor will only use GradeMark for TII assignments. Is this an accurate assumption? Would it be beneficial to allow an instructor
to use GradeMark on its own?
4.7. Alternative Course Configuration Options
The recommendation included in this document for configuration of Turnitin at the course level is to provide a "Turnitin" interface
within the Assignments tool. Two alternative to this could be (1) create a new and separate Turnitin tool that would live on its own; or
(2) create this functionality within the existing Site Info tool. Course configuration of Turnitin would then happen through either
option 1 or 2 instead of within the Assignments interface. Functionality that could be considered for a new or within the Site Info tool
includes:
• The ability to turn TII on for the particular course.

• The ability to edit the "institution assignment submission statement" content
• The ability to edit the "course assignment submission statement" content
• The ability to edit the "plagiarism pledge" content
• The ability to set up defaults for the Institutional submission statement for each campus; the ability to support multiple
institutional statements and assign them based on originating campus would be preferable.
Page 114 of 131

4.8. Additional Locations for Viewing Disclaimers
Instructors may want the ability to view and/or include the institution or course assignment submission statement or the plagiarism
pledge from locations other than the Assignments tool. Possible additional locations include the Syllabus tool, the Gradebook and the
Announcements tool. Additional functionality that could be considered for these tools includes:
• The ability to read the "institution assignment submission statement"

• The ability to read the "course assignment submission statement"
• The ability to read the "plagiarism pledge"
4.9. Permissions
By default and when enabled, the TII integration is available for course worksites only. Extending the use of the integration to other
worksite types or adding more granular permissions have been discussed as possible future enhancements.
Another permissions scenario is where multiple institutions share a single Sakai instance but not all institutions have purchased
Turnitin. This situation can be handled in a number of ways without impacting the functional design detailed in this document. One
very simple solution would be to associate a boolean property with each Sakai course worksite that denotes whether Turnitin is
available. If the property is false no further processing of anything Turnitin related is performed (i.e. checks for Turnitin at the Sakai
and course level are ignored; no Turnitin-related items are displayed on the user interface). From an implementation perspective, this
could be accomplished by taking advantage of Sakai's robust property mechanism which allows for key and value property pairs to be
associated to various Sakai entities including worksites. Another potential solution would be to restrict access to the Turnitin Tool and
Turnitin extended Sakai Tools to non-Turnitin institutions. The key point is that this scenario could be handled and there are multiple
options to handle it. The optimal solution would have much to do with how the particular Sakai instance provisioned worksites.
Depending on how worksites were provisioned (i.e. manual or automatic) and the volume of worksite creation, solutions can be design
and incorporated into the Turnitin Sakai extensions on a case by case basis.
Page 115 of 131

5. Appendix
Requirements List
Num Name Description User/Role Tool Permission View Dependencies

Administer TII at Global Sakai Level
Institution is valid user
of TII service; all
Provide the ability to enter and following
Register validate a Turnitin account ID and requirements assume
Turnitin for shared secret to unlock use of TII Admin Tool TII Admin registration was
AG1.0 Sakai Turnitin for the Sakai instance Sakai Admin (new) Admin Privilege Tool successful
Enable TII at
the global Provide the ability to enable TII for TII Admin Tool TII Admin
AG1.1 Sakai level the Sakai instance Sakai Admin (new) Admin Privilege Tool
Disable TII at
the global Provide the ability to disable TII for TII Admin Tool TII Admin TII enabled for the
AG1.2 Sakai level the Sakai instance Sakai Admin (new) Admin Privilege Tool Sakai instance
Enable
"institution
assignment
submission
statement" at Provide the ability to enable the
the global "institution assignment submission TII Admin Tool TII Admin
AG1.3 Sakai level statement" Sakai Admin (new) Admin Privilege Tool
Disable
"institution
assignment
submission
statement" at Provide the ability to disable the Institution assignment
the global "institution assignment submission TII Admin Tool TII Admin submission statement
AG1.4 Sakai level statement" Sakai Admin (new) Admin Privilege Tool enabled
Enter/edit
content for the
"institution
assignment Provide the ability to enter or edit Institution assignment
submission the content of the "institution TII Admin Tool TII Admin submission statement
AG1.5 statement" assignment submission statement" Sakai Admin (new) Admin Privilege Tool enabled
Page 116 of 131

Enable
"plagiarism
pledge" at the
global Sakai Provide the ability to enable the TII Admin Tool TII Admin
AG1.6 level "plagiarism pledge" Sakai Admin (new) Admin Privilege Tool
Disable
"plagiarism
pledge" at the
global Sakai Provide the ability to disable the TII Admin Tool TII Admin Plagiarism pledge
AG1.7 level "plagiarism pledge" Sakai Admin (new) Admin Privilege Tool enabled
Enter/change
content for the
"plagiarism Provide the ability to enter content TII Admin Tool TII Admin Plagiarism pledge
AG1.8 pledge" into the "plagiarism pledge" Sakai Admin (new) Admin Privilege Tool enabled
Enable
GradeMark at
the global Provide the ability to enable TII Admin Tool TII Admin Successful registration
AG1.9 Sakai level GradeMark for the Sakai instance Sakai Admin (new) Admin Privilege Tool of TII
Disable
GradeMark at
the global Provide the ability to disable TII Admin Tool TII Admin GradeMark enabled
AG1.10 Sakai level GradeMark for the Sakai instance Sakai Admin (new) Admin Privilege Tool for the Sakai instance
Provide the ability to show a
disclaimer that GradeMark must be
GradeMark turned on for the Institution's
usage account in order for the functionality TII Admin Tool TII Admin
AG1.11 disclaimer to work properly Sakai Admin (new) Admin Privilege Tool
Provide the ability to view

View previously entered account ID and
registration shared secret registration TII Admin Tool TII Admin Previous registration
AG1.12 information information Sakai Admin (new) Admin Privilege Tool information entered
Edit Provide the ability to edit previously

registration entered account ID and shared secret TII Admin Tool TII Admin Previous registration
AG1.13 information registration information Sakai Admin (new) Admin Privilege Tool information entered
Page 117 of 131

Provide the ability to return an error
message if registration is not
successful
Notify on - Account id or shared secret are
unsuccessful incorrect TII Admin Tool TII Admin Previous registration
AG1.14 registration - Account is not active Sakai Admin (new) Admin Privilege Tool information entered
Enable TII Provide the ability to enable TII

notification emails from the Sakai admin TII Admin Tool TII Admin
AG1.15 emails interface Sakai Admin (new) Admin Privilege Tool
Disable TII Provide the ability to disable TII

notification emails from the Sakai admin TII Admin Tool TII Admin
AG1.16 emails interface Sakai Admin (new) Admin Privilege Tool
Provide the ability to select an
option to check work against an
Institution-specific repository (no
Enable use of validation required)
Institution- - Should include wording that this
specific is a service that must be purchased, TII Admin Tool TII Admin
AG1.17 repository similar to GradeMark Sakai Admin (new) Admin Privilege Tool
Disable use of Provide the ability to de-select an

Institution- option to check work against an
specific Institution-specific repository (no TII Admin Tool TII Admin
AG1.18 repository validation required) Sakai Admin (new) Admin Privilege Tool
Read-only Provide the ability for TII and GM
access to reports to be viewable (per Registration was
reports for permissions outlined elsewhere in Assignments previously valid and
invalid TII this document) but read-only, if the Took, reports were
AG1.19 account TII account becomes invalid System Gradebook previously generated
Provide the ability for TII and GM
reports to be viewable (per
Report permissions outlined elsewhere in TII was previously
viewability this document) but read-only, if TII Assignments enabled and reports
after disabling is disabled for the institution after Took, were previously
AG1.20 TII having been previously enabled. System Gradebook generated
Page 118 of 131

Use Institution
Error if Provide the ability to return an error Repository is selected,
Institution if Institution Repository selection is but repository is not
Repository is checked but repository is not TII Admin Tool TII Admin available or does not
AG1.21 not available available System (new) Create/Modify Tool exist
Administer TII at Course Level
Display the
"institution TII screen
assignment Provide the ability to view the within Institution assignment
submission "institution assignment submission Assignments Assignmen submission statement
AC1.0 statement" statement" Instructor Tool Read ts enabled
Enable use of
"course
assignment TII screen
submission Provide the ability to enable the within Course assignment
statement" at "course assignment submission Assignments Assignmen submission statement
AC1.1 the course level statement" at the course level Instructor Tool Create/Modify ts enabled
Disable use of
"course
assignment TII screen
submission Provide the ability to disable the within Course assignment
statement" at "course assignment submission Assignments Assignmen submission statement
AC1.2 the course level statement" at the course level Instructor Tool Create/Modify ts enabled at course level
Display the
"course TII screen
assignment Provide the ability to view the within Course assignment
submission "course assignment submission Assignments Assignmen submission statement
AC1.3 statement" statement" Instructor Tool Read ts enabled
Edit "course TII screen
assignment Provide the ability to edit the "course within Course assignment
submission assignment submission statement" Assignments Assignmen submission statement
AC1.4 statement" content Instructor Tool Create/Modify ts enabled at course level
TII screen
Display the within
"plagiarism Provide the ability to view the Assignments Assignmen Plagiarism pledge
AC1.5 pledge" "plagiarism pledge" Instructor Tool Read ts enabled
Add TII Assignment
Page 119 of 131

Enable use of
TII at the
assignment Provide the ability to enable the use Assignments Assignmen
AA1.0 level of TII for an assignment Instructor Tool Create/Modify t creation
Provide the ability to disable the use

of TII for an assignment.
In the case where TII has previously
been enabled for this assignment and
has submissions/Originality Reports,
the following should occur:
- All existing originality reports will
remain, and will not be deleted
Disable use of - Links to existing originality reports
TII at the will be removed
assignment - Users will not be able to generate Assignments Assignmen TII enabled at
AA1.1 level new originality reports Instructor Tool Create/Modify t creation assignment level
Page 120 of 131

Provide the ability to create a TII
assignment with the following
custom publishing options:
- Enable/disable use of
QuickMark
- Enable/disable generation of
originality reports
- Select action that generates
originality reports (Immediately,
first report is final (default),
Immediately, can overwrite reports
until due date, On due date)
- Select visibility of originality
reports to students (No (default),
Yes)
- Select location of submission
repository (Standard paper
repository, No repository)
- Select search options for
originality checking (student paper
repository (default checked), current
and archived internet (default
checked), periodicals, journals, &
publications (default checked),
institution repository if available)
- Select use of plagiarism pledge
- Select use of course assignment
submission message (default)
Create a TII - Enable/disable use of GradeMark Assignments Assignmen TII enabled at
AA1.2 assignment (if enabled at global level) Instructor Tool Create/Modify t creation assignment level
Prohibit use of
GradeMark for
assignments Provide the system function to return
not selected for error when use of GradeMark is
addition to the selected and "Add Assignment to
Sakai Gradebook" is NOT the selected Assignments Assignmen GradeMark enabled at
AA1.3 Gradebook grading option System Tool t creation assignment level
Page 121 of 131

Prohibit use of
GradeMark
with Grade
Scale
selections that Provide the system function to return
do not work error when use of GradeMark is
with Sakai selected and "Points" is NOT the Assignments Assignmen GradeMark enabled at
AA1.4 Gradebook selected grade scale value System Tool t creation assignment level
Assignmen
t
Provide the ability to edit a TII list/Assign
Edit a TII assignment (Assignments tool Assignments ment TII assignment has
AA1.5 assignment default) Instructor Tool Create/Modify creation been created
Provide the ability to delete a TII
assignment (Assignments tool
default) with the following effects:
- Files in the submission will be
deleted in Sakai
- Files in the submission will not be
deleted in Turnitin
- Files in the submission that were
indexed, will not be removed from
the index in Turnitin
- Originality reports for the files in
the submission will be deleted in
Turnitin; links to originality reports
in Sakai will be removed.
- GradeMark files for the files in the
submission will be deleted in
Delete an Turnitin; links to GradeMark files in Assignments Assignmen TII assignment has
AA1.6 assignment Sakai will be removed. Instructor Tool Delete t list been created
Provide the system function to
Allow inline submit "Inline Only" submissions to Assignments Assignmen TII enabled at
AA1.7 submissions TII System Tool Create/Modify t creation assignment level
Allow Provide the system function to
attachment submit "Attachments Only" Assignments Assignmen TII enabled at
AA1.8 submissions submissions to TII System Tool Create/Modify t creation assignment level
Prohibit Provide the system function to return
combined error when use of TII is selected and
inline and “Inline and Attachments” is the Assignments Assignmen TII enabled at
AA1.9 attachments selected student submission method System Tool Create/Modify t creation assignment level
Page 122 of 131

submissions value
Provide the system function to return

Prohibit non- error when use of TII is selected and
electronic “Non-electronic” is the selected Assignments Assignmen TII enabled at
AA1.10 submissions student submission method value System Tool Create/Modify t creation assignment level
Provide the ability to disable use of
GradeMark for an assignment.
In the case where GM has previously
been enabled for this assignment and
has submissions/GM reports; the
following should occur:
- All existing GradeMark files will
- Links to existing GradeMark files
will be removed and users will not
be able to access GradeMark
functionality.
- All existing GM reports will
- Links to existing GM reports will
be removed
Disable use of - Users will not be able to generate
AA1.11 GradeMark new GM reports
Submit TII Assignment
Provide the ability to submit a TII
assignment
- Provide the ability to view
"institution assignment submission
statement"
- Provide the ability to view/denote
acceptance of "course assignment
Submit a TII - Provide the ability to view/denote Assignments Assignmen Denote acceptance of
SA1.0 assignment acceptance of "plagiarism pledge" Student Tool Read/Submit t "plagiarism pledge"
Page 123 of 131

Provide the ability to resubmit a TII
assignment
- Provide the ability to view
"institution assignment submission
statement"
- Provide the ability to view/denote
acceptance of "course assignment
Resubmit a TII - Provide the ability to view/denote Assignments Assignmen Denote acceptance of
SA1.1 Assignment acceptance of "plagiarism pledge" Student Tool Read/Submit t "plagiarism pledge"
Provide the ability to restrict
submissions to TII assignments to Assignments
SA1.2 REMOVED only one (1) attachment System Tool Attachment
Accept Provide the ability to allow multiple
multiple attachments within a submission to a Assignments
SA1.2 attachments TII assignment System Tool Attachment
Page 124 of 131

Provide the ability to capture TII
error when file uploads fail. Sakai
should still save the submission even
if the TII transaction fails
(1) File is of the type:.doc, .wpd, .ps,
.pdf, .html, .rtf, .txt
(2) File size is < 10MB; Aside: may
only be changed through special
request to Turnitin
(3) File contains more than 100
character of non-whitespace
(4) File length is < 1000000
characters; Aside: may only be
changed through special request to
Turnitin
(5) File contains more than 20 words
of text
If an originality report cannot be
generated for the file, display the
following info text:
• (1): An originality report cannot be
generated for this file type.
generated because the file size is too
large.
generated because the file contains
less than 100 character of non-
whitespace.
generated because the file exceeds
the maximum length.
generated because the file contains
less than 20 words of text.
• Other: An originality report cannot
be generated for this file.
If GradeMark cannot be used for the
file, display the following info text:
Error • (1): GradeMark cannot be used for
messaging for this file type. Assignments Assignmen Assignment is
SA1.3 upload errors • (2): GradeMark cannot be used System Tool Read/Submit t submitted
Page 125 of 131

because the file size is too large.
• (3): GradeMark cannot be used
because the file contains less than
100 character of non-whitespace.
because the file exceeds the
maximum length.
because the file contains less than 20
words of text.
• Other: GradeMark cannot be used
for this file.
Submit on Provide the ability for an Instructor

behalf of a to submit an assignment on behalf of Assignments Assignmen
SA1.4 student a particular student Instructor Tool Submit t
Page 126 of 131

Provide the ability to queue student
submissions when TII service is
unavailable
- System should retry in five (5)
Queue student minute intervals
submissions if - System should log failure and send
service is failure notification/message to Sakai Assignments Assignmen Assignment is
SA1.5 unavailable at: 1 hour failure (12th interval) System Tool Submit t submitted
Reuse Existing Courses/Assignments
Provide the ability to duplicate a
course using TII, where all course Sakai
Duplicate a level flag settings are carried Admin/Instru
DC1.0 course forward ctor Site Info Admin Privilege Site Info
Provide the ability to duplicate a TII
assignment where all assignment
Duplicate a TII level flag settings are carried Assignments Assignmen
DA1.0 assignment forward Instructor Tool Create/Modify t List
Provide the ability to use Import
Import from Site feature to import
Assignments Assignments from another worksite;
from another all TII attributes should come over in Assignments Assignmen
DA1.1 site the import Instructor Tool Create/Modify t List
View Turnitin Reports - Instructor
Display
"inactive"
Originality Provide the ability to display a
Report grayed-out indicator that assignment "Grade"
indicator - has been submitted but Originality System - view within
Assignments Report is not yet available for an Instructor Assignments Assignmen
IR1.0 Tool assignment view Tool t List
View Assignment was
originality "Grade" submitted and report
report - Provide the ability to view the view within returned to Sakai
Assignments originality report by selecting active Assignments Assignmen Active indicator is
IR1.1 Tool Originality Report indicator Instructor Tool Read t List displayed
Page 127 of 131

Display
"inactive" Provide the ability to display a
GradeMark grayed-out indicator that assignment "Grade"
indicator - has been submitted but GradeMark System - view within Assignment option to
Assignments is not yet available for an assignment Instructor Assignments Assignmen use GradeMark was
IR1.2 Tool (this is default until status changes) view Tool t List checked
Display
"active"
GradeMark "Grade"
indicator - Provide the ability to display a System - view within
Assignments colored indicator that GradeMark is Instructor Assignments Assignmen Assignment is
IR1.3 Tool available for an assignment view Tool t List available to grade
Launch Provide the ability to launch "Grade"
GradeMark - GradeMark in a new browser view within
Assignments window from an active GradeMark Assignments Assignmen Active indicator is
IR1.4 Tool indicator Instructor Tool Read t List displayed
Display
"inactive" Provide the ability to display a
GradeMark grayed-out indicator that GradeMark System - Gradebook Assignment option to
indicator - is not yet available for an assignment Instructor Gradebook Item use GradeMark was
IR1.5 Gradebook (this is default until status changes) view Tool Summary checked
Display
"active"
GradeMark Provide the ability to display a System - Gradebook
indicator - colored indicator that GradeMark is Instructor Gradebook Item Assignment is
IR1.6 Gradebook available for an assignment view Tool Summary available to grade
Provide the ability to launch
Launch GradeMark in a new browser Gradebook
GradeMark - window from an active GradeMark Gradebook Item Active indicator is
IR1.7 Gradebook indicator Instructor Tool Read Summary displayed
Display GradeMark grade
GradeMark Provide the ability to view the Gradebook exists and has not been
grade - GradeMark Grade in the Sakai Gradebook Item overwritten by manual
IR1.8 Gradebook Gradebook Instructor Tool Read Summary grading within Sakai
Display
GradeMark "Grade" GradeMark grade
grade - Provide the ability to view the view within exists and has not been
Assignments GradeMark Grade in the Assignment Assignments Assignmen overwritten by manual
IR1.9 tool tool Instructor Tool Read t List grading within Sakai
Page 128 of 131

Sort
assignments by
Originality Gradebook
Report % in Provide the ability to sort Gradebook Item
IR1.10 assignment list assignments list by OR % Instructor Tool Read Summary
Sort
assignments by "Grade"
Originality view within
Report % in Provide the ability to sort gradebook Assignments Assignmen
IR1.11 gradebook list by OR % Instructor Tool Read t List
Provide the ability to view an
View indicator indicator that says whether or not the
of TII assignment is a TII assignment on Assignments Assignmen
IR1.12 assignment the Assignment List. Instructor Tool Read t List
Support more
than one Provide the ability to enable multiple
Instructor or Instructors and/or TAs to view Assignments Assignmen
IR1.13 TA per course reports for the same course System Tool Read t
Provide the ability to view an
indicator denoting failure to generate
an Originality Report (failure due to "Grade"
server error or file upload error) view within
View failure - Provide error message upon Assignmen
IR1.14 indicator hovering over indicator Instructor Assignments Read t List See SA1.5
View Turnitin Reports - Student
Student visibility of
originality report = yes
(TII)
Assignment has been
Display Provide the ability to display a "returned" to student
"inactive" grayed-out indicator that Originality or
Originality Report is not yet available for a Grades have been
Report submitted assignment, when the released for
indicator when assignment has been returned to Assignmen assignment
report is not Student or when grades have been System - Assignments t detailed Status from TII = not
SR1.0 available released Student view Tool view ready
Page 129 of 131

View originality report = yes
originality Provide the ability to view own (TII)
report upon Originality Report by clicking an Assignment has been
assignment active Originality Report indicator Assignmen "returned" to student
return to when an individual assignment has Assignments t detailed Status from TII =
SR1.1 student been returned to the student Student Tool Read view ready
originality report = yes
(TII)
Student has submitted
the assignment
Provide the ability to view own Grades have been
View Originality Report by clicking an released for
originality active Originality Report indicator Assignmen assignment
report upon when grades have been released for Assignments t detailed Status from TII =
SR1.2 grade release the assignment Student Tool Read view ready
Display Provide the ability to display a "Grade"
"inactive" grayed-out indicator that GradeMark view within Assignment option to
GradeMark is not yet available for a submitted System - Assignments Assignmen use GradeMark was
SR1.3 indicator assignment Student view Tool t List checked
View
GradeMark
upon Provide the ability to view active "Grade" Assignment has been
assignment GradeMark indicator when an view within "returned" to student
return to individual assignment has been Assignments Assignmen "Ready" status
SR1.4 student returned to the student Student Tool Read t List returned from API
Grades have been
View Provide the ability for all students to "Grade" released for
GradeMark view active GradeMark indicator view within assignment
upon grade when grades have been released for Assignments Assignmen "Ready" status
SR1.5 release the assignment Student Tool Read t List returned from API
Display Provide the ability to display a
"inactive" grayed-out indicator that GradeMark Assignment option to
GradeMark is not yet available for an assignment System - Gradebook Grade use GradeMark was
SR1.6 indicator (this is default until status changes) Student view Tool Report checked
Display Assignment has been
"active" Provide the ability to display a "returned" to student
GradeMark colored indicator that GradeMark is System - Gradebook Grade "Ready" status
SR1.7 indicator available for an assignment Student view Tool Report returned from API
Page 130 of 131

Grades have been
Provide the ability to launch released for
GradeMark in a new browser assignment
Launch window from an active GradeMark Gradebook Grade "Ready" status
SR1.8 GradeMark indicator Student Tool Read Report returned from API
Display
GradeMark Provide the ability to view the
grade - GradeMark Grade in the Sakai Gradebook Grade Grades have been
SR1.9 Gradebook Gradebook Student Tool Read Report released to Students
Display
GradeMark
grade - Provide the ability to view the Assignmen
Assignments GradeMark Grade in the Assignments t detailed Grades have been
SR1.10 tool Assignments tool Student Tool Read view released to Students
Grade Assignment
Receive/store
initial grade
from Provide the ability to receive and
GradeMark and store a grade from GradeMark when TII sends grade to
GA1.0 input into Sakai no grade previously existed System Sakai
Receive/store
updated grade Provide the ability to receive/store
from an updated grade from GradeMark
GradeMark and - Provide the ability to overwrite the TII sends grade to
GA1.1 input into Sakai existing grade System Sakai
Sakai sends grade to
TII when a grade is
Send grade Provide the ability to send a Sakai entered for an
entered into gradebook grade to TII, will update assignment that has
GA1.2 Sakai to TII the GradeMark screen System TII turned on.
Support more
than one Provide the ability to enable multiple
Instructor or Instructors and/or TAs to grade
GA1.3 TA per course assignments for the same course System
Page 131 of 131

Sakai-TII Functional Specification v2.0 PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Sakai-TII Functional Specification v2.0 PDF

Uploaded by

Copyright:

Available Formats

Sakai-Turnitin Integration

 similar implementations with other Learning Management Systems

1.2. Existing Tool Impact Summary

Primary functionality Impact? Description

2.2.1. Seamless Integration

2.2.2. Impact on Existing Sakai Modules

2.2.3. Service-level Requirements

2.2.4.1. Sakai Best Practices

2.2.4.2. Sakai Third-Party Software Components

2.3. Solution Components

2.3.1. Turnitin Administration Tool

2.3.1.2. GradeMark Web Service

2.3.2. Turnitin Service Component

2.3.3. Existing Sakai Tool Extensions

TII integration is available for course worksites only.

3.1.2. Assignment Submission

3.1.3. Error Messages

3.1.4. Export, Import, and Duplicate

3.1.6. Disabling TII for an Assignment

3.2. Administer Turnitin Globally for the Sakai Instance

3.2.3.1. Register and Enable

Turnitin Administration tool (a new administrative tool created to administer Turnitin).

Turnitin Administration tool (a new administrative tool created to administer Turnitin).

Turnitin Administration tool (a new administrative tool created to administer Turnitin).

Turnitin Administration tool (a new administrative tool created to administer Turnitin).

Turnitin Administration tool (a new administrative tool created to administer Turnitin).

Turnitin Administration tool (a new administrative tool created to administer Turnitin).

At a high level, the component interaction sequence is as follows:

3.3. Administer Course Turnitin

3.3.3.1. Add Instructor Note

Assignments Tool - Turnitin view (new)

Assignments Tool - Turnitin view (new)

3.3.4. Implementation Notes

Disable use of Turnitin for an

 Users will not be able to generate new originality reports

• Provide the ability to enable use of QuickMark (requires QuickMark

• Provide the ability to disable use of QuickMark.

• Provide the ability to disable generation of originality reports for submitted

Prohibit use of GradeMark for

 All existing GM reports will remain, and will not be deleted

 Links to existing GM reports will be removed

 Users will not be able to generate new GM reports

Assignments Tool - Add Assignment view

Assignments Tool - Edit Assignment view

Assignments Tool - Assignment List view

3.4.4. Implementation Notes

Function Name FID FCMD

Additional items required to support this functionality include:

3.5. Submit a Turnitin assignment

Provide the ability to resubmit a Turnitin assignment with the following

SA1.1 Resubmit a Turnitin assignment

Provide the ability to allow multiple attachments within a submission to a TII

Assignments Tool - Student view

Assignments Tool - Submit for Student view

The component interaction sequence is a follows:

1. The Turnitin-specific Assignments Tool extension captures upload of the paper(s)

Handling submission failure

Additional items required to support this functionality include:

3.6. View Turnitin Reports - Instructor

Assignments Tool - Assignment Submission Detail view

Gradebook Tool - Assignment Submission Detail view

Gradebook Tool - Assignment Submission Detail view

Assignments Tool - Assignment Submission Detail view

similar implementations with other Learning Management Systems

Users will not be able to generate new originality reports

All existing GM reports will remain, and will not be deleted

Links to existing GM reports will be removed

Users will not be able to generate new GM reports