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.


Skip to end of metadata
Go to start of metadata
All Versions
Page not found
Table of Contents
Page not found


DB2 is a commercial database from IBM. The DB2 database software is availble from IBM at:

Step 1: Obtain the Driver

Since the DB2 JDBC driver is not available in the central Maven repository, it must be placed into the local repository of each machine on which you wish to build uPortal.

As an alternative to this, you could set up a maven repository for use by multiple machines.

A JDBC DB2 driver is included in the DB2 software in the java subdirectory after DB2 installation has been performed. To install the JAR into your local maven repository, use the following command:

mvn install:install-file -DartifactId=db2-jdbc -Dversion=<version> -Dpackaging=jar -DgeneratePom=true

The groupId, artifactId and version specified in this command are up to you, but they should match the JAR vendor, name and version to avoid confusion down the road.

Step 2: Add the Dependency

From the uPortal source directory, open uPortal-4.x.x/pom.xml, there is a section about 92 lines down that reads:

<!-- The JDBC Driver used by uPortal -->

Modify this to use the DB2 driver, using the group, artifact and version information from the mvn install:install-file command above.

<!-- The JDBC Driver used by uPortal -->

Step 3: Configure the Database Filter     

     1. In the filters folder, locate the default file under uPortal-4.x.x/filters/ and configure the Database Connection Settings

# HSQL Configuration

# Database Connection Settings

Step 4: Test the Configuration

Running the dbtest ant target will tell you if you have configured the database connection properly.

ant dbtest


Step 5: Build and Deploy 

Following a successful test, you can execute the command below to build the database tables and copy files to your servlet container. 

Note: Executing the command "ant clean initportal" will drop and recreate the database tables and all existing data will be lost. This will result in a clean uPortal database structure. If you want to keep the contents of your existing database, use "ant clean deploy-war"

ant clean initportal

Step 6: Restart Tomcat



Issues and Known Bugs

Some people have encountered problems with database drivers with certain web application environments if the classes zip file is used as-is with the .zip file extension. Simply renaming the file to a .jar file seems to fix the problem. Alternatively, unzipping the classes file into a directory structure, then using the jar command to repackage the classes into a jar file works as well.

Having problems with these instructions?

Please send us feedback at

  • No labels