Upgrade Data Import

Please read the entire page before trying to import any data from previous versions of uPortal into 4.1 or 4.2

 

Data Overview

There are three groups of data included with uPortal 4.0 required (in uPortal/uportal-war/src/main/data/required_entities), default (in uPortal/uportal-war/src/main/data/default_entities), and quickstart (in uPortal/uportal-war/src/main/data/quickstart_entities). The required data must be imported before anything else, the portal will not function without this data. It is also highly recommended that all default data is imported as well, while uPortal will function without this data many features may not be available if this data is not correctly setup.

Pruning Imported Data

When upgrading to uPortal 4.1 or 4.2 not all data files from previous versions (particularly 3.x) should be imported unless you are VERY confident in what you are doing.

.channel-type

channel-type files from uPortal 3 and uPortal 2 are not supported, the .portlet-type.xml files included in uPortal 4 must be used, these are in the required and default data sets. If you have custom .channel-type files you will need to convert them by hand to .portlet-type.xml files.

TODO instructions on converting channel-type files to portlet-type.xml files

.entity-type

Only import custom entity types that you manually defined in your old uPortal instance. Entity types that were included in previous versions of uPortal should not be imported into uPortal 4.0

.channel

Since uPortal 3.2 the name element when publishing portlets must be unique within the portal, a non-unique name will result in a failure during the import process.

.structure and .theme

Do not import stucture and theme files from previous versions of uPortal, if you have custom .structure and .theme files they need to be converted by hand to .stylesheet-descriptor.xml files.

TODO instructions on converting structure and theme files to .stylesheet-descriptor.xml files.

.layout and .profile

In portal.properties set the properties org.jasig.portal.io.forceDefaultStructure and org.jasig.portal.io.forceDefaultTheme to true, this will update the profile information if all imported users so that they use the default structure and theme. If you're using a custom structure or theme change org.jasig.portal.io.defaultStructureName and org.jasig.portal.io.defaultThemeName properties to the appropriate names.

Import Steps

With the above knowledge the recommended steps for setting up a new uPortal 4.1 or 4.2 database are:

ant db db-import-required db-import-default
ant data-import -Ddir=/path/to/up3x-export/ 

Also see Topics for uPortal 4.1 and 4.2 Migration in Database Changes.