This documentation relates to uPortal 4.0
If you are using a different version, please click on "Click for all versions" on the left side of the page and select the relevant version.

Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use $ant data-export to get data from your existing portal, then selectively include elements of that data in the new, 4.1 portal.

uPortal 4.1 introduced an optional feature Entity-based PAGS which has new database tables.  The default in uPortal 4.1 is XML-based PAGS.  Multi-tenancy requires Entity-based PAGS.  Refer to the Entity PAGS section below and the Person Attribute Group Store (PAGS) Overview documentation for more information.

uPortal 4.2-specific

Migrating from 3.x or 4.0.x to uPortal 4.2 generally requires an initdb as uPortal 4.2 does not support the universality theme anymore in favor of Respondr.  Though you could retain most data and make layout adjustments to get your portal to look reasonable in Respondr without wiping out other data, switching the theme to Respondr is generally sufficient reason to take the opportunity to reboot your portal look and discard old data.

There are no additional tables between 4.1 and 4.2.  

Topics for uPortal 4.1 Migration

...

Starting with uPortal 4.1, Person Attributes Group Store (PAGS) comes in 2 flavors:  original (configured in PAGSGroupStoreConfig.xml) and Entity (JPA-managed database entities).  Both approaches are functional and behave similarly.  Consider switching to Entity PAGS now;  in the future, Entity PAGS will allow uPortal to support management of PAGS groups through an administrative UI, without a re-build, re-deploy, and re-start of Tomcat.

Topics for uPortal 4.2 Migration

Below are some data migration notes of particular relevance to uPortal 4.2.  If upgrading from a version earlier than 4.1, also see Topics for uPortal 4.1 Migration above.

Entity PAGS

Entity-based PAGS becomes the default configuration in uPortal 4.2.0.  There is a new groovy-based script that can also be invoked from ant that converts an existing XML PAGS file to entity files and creates a SQL updae script that can be executed to upgrade a uPortal 4.1 database from XML PAGS to Entity PAGS.  See 

Jira
serverJASIG Issue Tracker
serverId76221f40-4501-3df1-8578-6c87908cbdf7
keyUP-4436
 for more information.

Code Block
# dir specifies the target directory to write out entity PAGS files to. Typically your institution-modified copy of quickstart_entities
ant -Dmaven.test.skip=true -Ddir=uportal-war/src/main/data/myInstitution_entities/pags-group pagsXmlToEntity
 
# As detailed in script output:
# - There are a few redundant entity PAGS files you can delete since they duplicate information in required_entities.
# - Also to upgrade an existing 4.1 database, you will need to import the entities, insure compositeGroupService.xml is configured to use Entity PAGS (default in 4.2.0) and run a generated SQL script against your existing 4.1 database.