Apereo uPortal Upgrade and Compatibility Notes

Apereo uPortal Upgrade and Compatibility Notes

uPortal can be directly upgraded from any previous version to any later version.  Please check the update notes found below for any intermediate versions to find steps you may need to perform after the upgrade. 

After Every Upgrade

Please run: ant db-update

This will ensure that if there were any hibernate changes that your database is updated accordingly.

To Release 4.0.13 from 4.0.12

No manual steps required

To Release 4.0.12 from 4.0.11

No manual steps required

To Release 4.0.11 from 4.0.10

No manual steps required

To Release 4.0.10 from 4.0.9

No manual steps required

To Release 4.0.9 from 4.0.8

No manual steps required

To Release 4.0.8 from 4.0.7

No manual steps required.  Note that JDK 7 is now supported but not required.

To Release 4.0.7 from 4.0.6

No manual steps required.

To Release 4.0.6 from 4.0.5

Please run: ant data-import -Dfile=/path/to/your/default.event-aggregation.xml

This adds in event aggregation.

To Release 4.0.5 from 4.0.4

No manual steps required.

To Release 4.0.4 from 4.0.3

1. CAUTION:  The default method of defining DLM fragment definitions has switched from the dlm.xml file to database persistence.  If you currently have fragments in dlm.xml, this update will require you to make a minor configuration change.  We apologize for the inconvenience and we want you to know we didn't make this change lightly.  A group of thorny issues related to layout migration (UP-3251, UP-3344, and UP-3332) were addressed in this release, and this change is a part of the overall solution.  There are two ways to deal with this change if it affects you:
   1. Option 1:  Stick with your dlm.xml.  You can undo the switch to database-persisted fragments very easily – just uncomment the 'dlmConfigurationLoader' bean that references the 'dlmConfigurationLoader' class in layoutContext.xml, and comment out the one that references the 'RDBMConfigurationLoader' class.  Make sure your dlm.xml file is present in the proper location:  uportal-war/src/main/resources/properties/.  WARNING:  If your DLM fragments are defined in this way when you migrate data from a previous version, you will experience issues migrating user customizations to fragment-based content.
   2. Option 2:  Convert to database-persisted fragments:  This option is also easy.  Take each <dlm:fragment> element in your dlm.xml file and surround it with a complete <fragment-definition> element (full example below).  Paste these elements each in their own file with a .fragment-definition.xml extension, then use >ant data-import to import your fragment definitions into the portal database.
2. For users upgrading from 4.0.2 or 4.0.3: Due to a column name reserved word conflict the UP_EVENT_AGGR_CONF_INTRVL_EXC and UP_EVENT_AGGR_CONF_INTRVL_INC tables need to be manually dropped and then re-created using ant db-hibernate-update 

COMPLETE <fragment-definition> ELEMENT EXAMPLE:

 <fragment-definition xmlns:dlm="http://org.jasig.portal.layout.dlm.config" script="classpath://org/jasig/portal/io/import-fragment-definition_v3-1.crn">

  <dlm:fragment name="Academics" ownerID="academics-lo" precedence="350">
    <dlm:audience evaluatorFactory="org.jasig.portal.layout.dlm.providers.GroupMembershipEvaluatorFactory">
      <paren mode="OR">
        <attribute mode="deepMemberOf" name="Students"/>
      </paren>
    </dlm:audience>
  </dlm:fragment>
</fragment-definition>

*NOTE:  The format for <dlm:fragment> elements is identical to dlm.xml

To Release 4.0.3 from 4.0.2

1. The UP_MUTEX table has changed, for step 2 to succeed please drop the UP_MUTEX table before running db-hibernate-update
2. There are a few new tables in 4.0.3. To add these tables run ant db-hibernate-update once you have the 4.0.3 source installed.

To Release 4.0.2 from 4.0.1

There are a few new tables in 4.0.2. To add these tables run ant db-hibernate-update once you have the 4.0.2 source installed.

To Release 4.0.1 from 4.0.0

1. The admin-lo layout in 4.0.0 incorrectly includes the fragment-admin portlet in the layout header, this can cause extraneous warnings in the portal log. To resolve this problem follow the steps below:
   1. Export the admin-lo layout: ant data-export -Dtype=fragment-layout -Dsysid=admin-lo -Ddir=export
   2. Edit the export/admin-lo.fragment-layout.xml file and remove the <channel fname="fragment-layout"/> element, there will be other attributes on the element.
   3. Import the admin-lo layout: ant data-import -Dfile=export/admin-lo.fragment-layout.xml
2. There are a few new tables in 4.0.1. To add these tables run ant db-hibernate-update once you have the 4.0.1 source installed.

ToRelease 4.0.0 from ...

Fresh install recommended.

Known Issues

Please refer to our open JIRA items: