Configuring the Data Upgrade

The upgrade tool provides the easiest way to upgrade the core and installed modules. You can use text files or the tool’s command line interface to configure your upgrade. The upgrade tool can upgrade everything—the core and all the modules—together or separately.

Liferay DXP 7.2 bundles include the upgrade tool. If you installed Liferay DXP 7.2 manually, you can download the upgrade tool separately.

  • Liferay DXP 7.2: Go to the Downloads page and select the DXP 7.2 product and the Product/Service Packs file type. In the listing that appears, click Download for the Liferay DXP Upgrade Client.

  • Liferay Portal CE 7.2: Go to the Downloads page and select Download for Liferay Portal Tools for 7.2.

Before starting the data upgrade process, configure the upgrade tool for the core upgrade and specify whether the upgrade tool should upgrade non-core module data automatically.

Configuring the Core Upgrade

The core upgrade requires configuration. You can configure it at runtime via the command line interface or pre-configure it in these files in [Liferay Home]/tools/portal-tools-db-upgrade-client/:

  • Specifies the server’s location and libraries.
  • Configures the database connection.
  • Sets the rest of the portal properties that the upgrade requires. You might want to copy your current portal properties (except your database properties) into this file. Before copying your current properties, make sure you’ve updated the portal properties for Liferay DXP 7.2.

Each file’s properties are described next.


Specify the following information to configure Liferay DXP 7.2’s app server:

dir: the absolute path of the application server folder. (required)

extra.lib.dirs: a comma delimited list of extra directories containing any binaries or resources to add to the class path. Use all absolute paths OR all paths relative to dir. (required)

global.lib.dir: the application server’s global library directory. Use the absolute path or a path relative to dir. (required)

portal.dir: the directory where portal is installed in your app server. Use the absolute path or a path relative to dir. (required) ID of a supported application server. (required) Here are the IDs:

  • jboss
  • jonas
  • resin
  • tomcat
  • weblogic
  • websphere
  • wildfly

Relative paths must use Unix style format. The following properties, for example, are for Windows and use relative paths:


These properties, for example, are for Linux and use all absolute paths:



Specify the following information to configure the database you’re upgrading. Note that these properties correspond exactly to the JDBC portal properties you’d use in a file.

jdbc.default.driverClassName (required)

jdbc.default.url (required)

jdbc.default.username (required)

jdbc.default.password (required)


Specify the following information to configure the upgrade:

liferay.home: The Liferay home folder (required) The implementation for persisting documents to the document library store. This property is mandatory if you’re using a *FileSystemStore implementation. If you updated this property in your, copy it here. Otherwise, set the property one of these ways:

hibernate.jdbc.batch_size: The JDBC batch size used to improve performance; set to 250 by default (optional)

Example Upgrade Configuration

Here’s an example interaction with the upgrade tool’s command line interface:

Please enter your application server (tomcat):
Please enter your application server directory (../../tomcat-8.0.32):

Please enter your extra library directories (../../tomcat-8.0.32/bin):

Please enter your global library directory (../../tomcat-8.0.32/lib):

Please enter your portal directory (../../tomcat-8.0.32/webapps/ROOT):

[ db2 mariadb mysql oracle postgresql sqlserver sybase ]
Please enter your database (mysql):
Please enter your database host (localhost):


The command line interface creates the configuration files based on your input. You can put this information into configuration files to configure the tool manually.

Here are example upgrade configuration files that you can customize and copy into [Liferay Home]/tools/portal-tools-db-upgrade-client/:





Next, decide if the upgrade tool should upgrade non-core modules automatically.

Configuring Non-Core Module Data Upgrades

You can configure the upgrade tool to upgrade all installed modules automatically or to open a Gogo shell (after core upgrade completes) for you to execute module upgrades manually.

If the upgrade tool’s autoUpgrade property is set to true (the default setting), upgrade processes for all installed modules are run too.

If you set autoUpgrade="false" in a file called com.liferay.portal.upgrade.internal.configuration.ReleaseManagerConfiguration.config and copy the file into the [Liferay Home]/osgi/configs folder, the upgrade tool opens Gogo shell after the core upgrade. In the Gogo shell, you can administer module upgrades.

It’s time to run the upgrade tool.

« Tuning for the Data UpgradeUpgrading the Core Using the Upgrade Tool »
Was this article helpful?
0 out of 0 found this helpful