Child pages
  • Upgrade (2.7)
Skip to end of metadata
Go to start of metadata

1.0 Database Conversions

Unable to render {include} The included page could not be found.

1.1 Other Database Conversions

Sakai 2.6 also includes data and schema conversions outside the standard scripts to address data integrity issues for assignments, content hosting and email archive. Below is a quick summary and overview of the process for each tool.

1.1.1 MailArchive conversion (2.5 -> 2.6)

SAK-13584 - Getting issue details... STATUS , SAK-16554 - Getting issue details... STATUS : Sakai 2.6 improvements to the Message API require that implementers upgrading from a pre-2.6 version of Sakai run both the 2.6.0 conversion scripts and a second script that can be found in the mailarchive module in order to update your existing mail archive data to take advantage of the 2.6 Email Archive performance improvements.

-- SAK-13584 Further Improve the Performance of the Email Archive and Message API. Note you have to run a bash conversion script on your old mail archive data for it to
-- appear in the new mail archive. The script is in the source as Please see the SAK for more information on this script or SAK-16554 for
-- updates to this script.
 	  	        SUBJECT                   ASC
 	  	        SUBJECT           VARCHAR (255) NULL,
	  	        BODY              LONGTEXT NULL

1.1.2 Assignments Tool conversion

(warning) This conversion was a part of the post-2.4 assignments branch so those migrating from a version already running this can disregard this step.

SAK-11821 - Getting issue details... STATUS : The assignment service previously permitted the creation of duplicate submission objects (i.e. two or more submissions for the same student and assignment). While the UI should prevent this from happening, at various stages in the evolution of the Assignments code, bugs, race conditions or other failures have led to duplicate objects being created. This conversion seeks to reconcile those duplicates and add database constraints to prevent this is the future.

In summary, the conversion script is necessary to

  1. Remove existing duplicate submission records, if any
  2. Prevent future submission duplicates by applying unique constraint on the ASSIGNMENT_SUBMISSION table
  3. Improve performance of the Assignment tool

The conversion script does the following to the existing ASSIGNMENT_SUBMISSION table in Sakai database:

  1. read in all tuples as AssignmentSubmission object, parse out data such as submitter_id, submit_time, submitted, and graded, and stores those attributes as separate columns in the ASSIGNMENT_SUBMISSION table;
  2. Runs though the table, combine and remove submission duplicates (tuples with same "context" and "submitter_id" combination);
  3. apply the unique constraint of "context" + "submitter_id" to ASSIGNMENT_SUBMISSION table.

There is a README file with detailed instructions on this process at

1.1.3 Content Hosting

Migrating from 2.4 to 2.5 requires adding several columns to the database tables used by the Content Hosting Service (the service used by the Resources tool, Dropbox, filepicker and WebDAV). The conversion scripts contain DDL statements to accomplish those changes. You need to run these conversions scripts (or perform the equivalent operations manually) and then convert your existing Resources via one of the methods outlined below, before you will gain the performance improvements Sakai 2.5 offers.

The new columns added to the database tables support a switch from XML serialization to "binary-entity" serialization, and enable Resources to perform faster and use less memory. One of the key areas this impacts is improving the performance of quota calculations.

There are two methods for converting existing Resources, with the first being the recommended option, as it enables all performance improvements when completed:

  1. Run the conversion utility, which can be run on a live system. (See readme for more details.)
    • (warning) Systems running oracle should read the email threads copied to the comments section below.
  2. Let the code convert each Resource as it is accessed.
    • (warning) This is only recommended for implementations with small datasets, such as pilot deployments; otherwise you should use the above conversion utility.
    • (warning) While some performance benefits from the binary-entity serialization can be realized immediately using this method, others, such as the quota calculation improvements will not be available until all Resources have been accessed and converted.

Based on the state of the data in the Content Hosting Service tables, it will start up in one of two modes:

  1. Binary only - If the code detects on start-up that all of the XML fields are null – as would be the case after running the conversion utility – it will run in binary mode. The means the system will only read and write using binary-entity serialization, and you will be able to fully realize all the performance enhancements that it offers.
  2. Dual mode - If the code detects there is still data in the XML fields – as would be the case if the conversion utility has not be run – it will run in dual mode. This means the system will be capable of reading both XML-serialized and binary-entity-serialized resources, but will write using only binary, and will convert any XML data it encounters into binary data. This gives you some of the performance benefits of binary-entity serialization without running the conversion utility, but you will never get the quota-calculation improvements unless all Resources end up converted.

2.0 changes

2.1 New preference.pages property

SAK-6545 - Getting issue details... STATUS : This property controls page order and visibility in the Preferences tool. The property takes comma-separated list of values identifying the pages (and toolbar actions) to display. Available pages are Notifications, Customize Tabs, Time Zone and Language. Below is an example of prefences.pages setting:

preference.pages=prefs_tab_title, prefs_noti_title, prefs_timezone_title, prefs_lang_title

The order of values in the comma-separated list determines page order and also the order of actions in the toolbar. If a value is missing, that page's action will not appear in the toolbar and the page will not be reachable via the UI. If the preference.pages property is not set, page order will be the (current) default.

If you remove

enable.privacy.status = true

you can achieve a similar effect by defining preferences.pages as follows:

preference.pages=prefs_tab_title, prefs_noti_title, prefs_timezone_title, prefs_lang_title, prefs_privacy_title

2.2 WebDAV properties changes

SAK-13403 - Getting issue details... STATUS : The properties associated with the WebDAV authentication cache have changed. In Sakai 2.5.0 and earlier the following properties were used:

These settings have been replaced as of Sakai 2.5.2 with:


2.3 Worksite Setup and Site Info properties changes

SAK-10762 - Getting issue details... STATUS : in Worksite Setup/Site Info the names of properties associated with the ability to add participants via email address have changed:

Old Name (Sakai 2.4 and earlier)

New Name (Sakai 2.5.0 and later)



















2.4 Portfolios (OSP) permission settings

OSP was turned off by default in Sakai 10 and removed entirely in Sakai 11.

SAK-13205 - Getting issue details... STATUS : if you are upgrading from a pre-2.5.0 version of Sakai, then you need to force conversion of the OSP permissions by setting osp.upgrade25=true in your file. (See also discussion.)

2.5 Portfolios (OSP) reports property changes

SAK-10451 - Getting issue details... STATUS : those upgrading from a pre-2.5.0 version of Sakai need to change osp.reports.useWarehouse to sakai.reports.useWarehouse.

3.0 Deprecated Discussion Tool

Commencing with Sakai 2.5, Sakai packaged distributions, tags or maintenance branches no longer include the Discussion tool. It has been retired and removed from the release, since there was no longer an active project team supporting the tool nor actively used by production institutions. feedback The Forums tool provides a viable alternative.

If you are upgrading and previously used the Discussion tool, you have two options:

  1. Continue using Discussion. A 2.5-compatible version of the Discussion tool is available in Contrib. You can build it and add it to your Sakai instance. No one has committed to supporting this version of the tool though, and you should not rely on it remaining available for future Sakai releases.
  2. Migrate Discussion content to Forums. A utility for converting Discussion tool content to Forums tool content is available in Contrib. See the README.TXT file for more information.
  • No labels