Access Keys:
Skip to content (Access Key - 0)

Portal

Portal 3.x Upgrade Guide

Table of Contents

Introduction

This guide explains how to upgrade an existing caGrid Portal 2.2 installation to version 3.x.

If you are running an earlier version (<3.0) of the portal, we recommend that you re-install the latest release using the instructions in the installation guide.

Obtaining the caGrid Portal 3.x Software

See this section of the installation guide for instructions on how to obtain the caGrid Portal 3.x software.

Obtain Required Software

You must install the following software:

  • Java 1.6.x
    • Make sure JAVA_HOME is set and Java SDK executable is on the PATH.
  • Ant 1.6.5
    • Make sure that ANT_HOME is set and Ant executable is on the PATH.

Update Properties

The caGrid Portal build script uses build-<target.env>.properties file for setting all its properties. By default the <target.env> is local, so if you don't provide a <target.env> when building the project (-Dtarget.env=) the build-local.properties file is used.

You can copy these property files from your existing portal installation or simply edit these properties for your environment.

<target.env> is the environment in which the portal is being installed. By default, the distribution of caGrid Portal is pre-configured for the following environments:

  • nci_qa-1.3
  • nci_stage-1.3
  • nci_prod-1.3
  • training-1.3 (default)

You can also get more details on individual properties here

Note
The build-local.properties has a list of properties that are REQUIRED to configure the installation to the local environment (database connections settings etc.). Users are expected to fill in the appropriate values in the build-local.properties file.
Note
Since this is an upgrade process, users can also re-use their existing build-<target.env>.properties file. In case you are re-using your existing properties file to configure the portal, it is important to note that some new properties have been introduced in this release.
Important
If you are using an existing JBoss, the property "liferay.jboss.home" is REQUIRED.

Build the Portal Project

Since this is a source release, you will first need to build the software with ANT. To do so, run the following command:

ant all

Upgrade caGrid Portal Software

Change MySQL default engine to InnoDB

In "MySQL Administrator" tool set the "Default storage" option to be InnoDB as shown.

Default storage must be InnoDB

Update all tables in lportal and portal2 to InnoDB

In "MySQL Administrator" tool select the "Catalogs" option on the left, select the "portal2" schemata and verify that all tables have the value "InnoDB" in the "Engine" column.

All tables must be InnoDB

If one or more tables have a different value right click on it and choose "Edit Table" from the context menu. In the dialog that will open select the "Table Options" tab. Select "InnoDB" as the "Table Engine".

Edit Table

Upgrade the Database

Run the following command to upgrade the database:

 ant update-schema
Note
The following log messages are normal. Wait till this process finishes on its own. 
updateDatabase] Changeset cagrid_portal-db-20-changelog.xml::20-1::kherm (generated)
::(MD5Sum: ef6eecdf75d51e257c7060d2c7a0f46)
[updateDatabase] Marking ChangeSet: cagrid_portal-db-20-changelog.xml::20-1::kherm (generated)::
(MD5Sum: ef6eecdf75d51e257c7060d2c7a0f46) ran due to precondition failure:
[updateDatabase] Not precondition failed

Upgrade the deployment

Do the following to upgrade caGrid Portal.

  • Shut down JBOSS.
  • Since this release of the caGrid Portal also updates the Liferay Portal software, you must delete your existing caGrid Portal and Liferay Portal installations from the JBOSS server. Typically you must delete the following directories (these paths may vary): 
       ${JBOSS_HOME}/server/default/deploy/cagrid-minimal.war
   ${JBOSS_HOME}/server/default/deploy/cagridportlets.war
   ${JBOSS_HOME}/server/default/deploy/liferay-portal.war
  • Delete all jar files from $JBOSS_HOME/server/default/lib/ext.
  • Clean the JBOSS cache, i.e delete $JBOSS_HOME/server/default/tmp and $JBOSS_HOME/server/default/work directories.
  • Run ant -Dtarget.env=nci_dev install-liferay.
  • Run ant -Dtarget.env=nci_dev deploy-all-portlets.
  • Run ant -Dtarget.env=nci_dev config-trust.
  • Start up JBOSS.
Note
(-Dtarget.env) is the environment in which caGrid Portal is being installed.
Note
Wait for JBOSS server to restart and fully deploy the caGrid Portal (typically 5 minutes) before opening the portal homepage in the browser (for example, http://localhost:8080).

Import the Site Structure

Set Up the Guest Community Layout

Before performing the below steps, its a good idea to clear out the Portal caches. To do this, open the Control Panel (Go to http://<host>:<port>/group/control_panel) and select Server Administration and click the following

  • Clear content cached by this VM"
  • Clear the database cache.
  • Reindex all search indexes.

Clean Portal cache

After cleaning the cache, see this section of the Installation Guide to import the site structure and set up the community layout.

Set Up Site Privileges

See this section of the Installation Guide to set up site privileges.

Once this is done, give the same privileges to the existing users of the portal. To do this, open the Control Panel and select Roles.

Roles Configuration.

You will see the Catalog User role created earlier. Click the Actions button and select Assign Members. The following window appears.

Assign Members.

Select the Assign Members->Users->Available tab. A list of all current portal users appears. Select all users (checkbox) and click Update Associations. This provides the Catalog User privilege to all current users of the portal.

Update Current Users.

Note
You may want to give the Catalog Admin privilege to those users that need administration privileges on the portal.

Refresh Lucene Index

Portal on start-up will re-load the SOLR/Lucene index. Post start up, its also recommended that you manually refresh the SOLR index by invoking the URL.

http://<hostname>:<port>/solr/dataimport?command=full-import

Re-deploying

If you are merely redeploying the portal, which refreshes a Portal 3.x deployment, do the following.

  1. Shut down JBOSS/Tomcat.
  2. Delete the existing cagridportlets.war from JBOSS.
  3. Delete the existing solr.war from JBOSS.
  4. Get the caGrid Portal source code.
  5. Update the properties.
  6. Run the following ant steps from the $SRC folder: 
    ant -Dtarget.env=<target.env> all
ant -Dtarget.env=<target.env> deploy-all-portlets
  7. Start up JBOSS/Tomcat.
  8. Refresh Lucene Index.
Last edited by
Murali Chadaram (381 days ago) , ...
Adaptavist Theme Builder Powered by Atlassian Confluence