This topic describes how to upgrade a single XperienCentral server in a production environment as well as in a clustered environment.
- See Upgrade Notes per Version for changes you might also need to make when upgrading to a specific version of XperienCentral.
- Whenever you upgrade an XperienCentral installation, instruct all users to delete their browser cache before they log in for the first time after the upgrade.
In This Topic
Upgrading XperienCentral on a Single Server
Upgrading the website to a new version of XperienCentral is a similar process to installing a new deploy. This topic describes the steps required to upgrade your website to a new version of XperienCentral.
Create a New Deploy and Optionally Request a New configuration.xml
First, a new deploy needs to be created. This is typically done by the software developer. See What to Deliver to the System Administrator for information on creating a deploy and what items to deliver to the system administrator. If necessary, you can request a new
configuration.xml file but in most cases this is not necessary. This step is only necessary if you want to add new functional components that you don't already use. If you do receive a
configuration.xml file from GX Software, deliver it to the system administrator. Contact GX Software to receive a new
Process the Deploy for a New configuration.xml
For most upgrades, you will not receive a new
configuration.xml file. If you do receive a new
configuration.xml file from GX Software, the system administrator must perform the following tasks:
- Make a backup copy of
- Copy the new
configuration.xmlover the old one in
Check Configuration Files
In most XperienCentral deployments, a number of the properties in the various configuration files are customized for each specific environment. During an upgrade, these files should not be overwritten. Instead, you should perform a diff to determine what the differences are between the files delivered by GX Software and those already present in your customized environment. In some releases, new properties are introduced which you must pick up in your configuration file(s). If no new properties have been introduced in a configuration file between releases, you can use the current version of the file in the upgraded version as is.
The files to check for every release are listed below. Other files in an XperienCentral can also be modified in a release and those changes are always specifically described in the Upgrade Notes.
startup_config.xml(if stored outside of the WAR file)
config.xml(if stored outside of the WAR file)
See also How to Create and Process a Deploy.
Process the Deploy
After receiving the files from the developer, the system administrator performs the following tasks to process the deploy and the
configuration.xml (if applicable):
- If necessary, make a backup copy of
- If necessary, replace the old copy of
configuration.xmlwith the new version.
- Perform the steps as described in.
Apart from the files mentioned in What to Deliver to the System Administrator, you sometimes also have to deliver a new
configuration.xml file depending on the circumstances surrounding your upgrade. Contact GX Software to receive a new
Upgrading XperienCentral in a Clustered Environment
Upgrading XperienCentral in a clustered production environment is very similar to upgrading a standalone version of XperienCentral except that there are multiple instances of XperienCentral that must be upgraded (read/write node(s) and one or more read-only nodes) and these must be upgraded in a specific order. To upgrade a clustered XperienCentral deployment, follow these steps:
- Stop XperienCentral on all read-only nodes.
- Stop XperienCentral on the read/write node(s).
Upgrade XperienCentral first on one of the read/write node(s) and after successfully starting XperienCentral on that single node, upgrade the remaining read/write and read-only nodes by following the steps in Upgrading XperienCentral on a Single Server.
- See Upgrade Notes per Version for further tasks (if any) that you need to perform for the newly installed version of XperienCentral.
Environments Using the File Distribution Service
- Start XperienCentral on a read/write noder with the setting
XperienCentral is completely started when the following messages appears in the Tomcat log:
[Date] [Time] nl.gx.webmanager.startup.impl.Startup start
INFO: XperienCentral started successfully in x ms
- When you have determined that the upgrade was successful, stop the read/write node.
- On the read/write node that you started and confirmed that the upgrade was successful in the steps above, change the setting
- Start XperienCentral on that read/write node.
After the read/write node is started, the file store will be initialized by the File Distribution Service (files from the
upload_mm directories). Depending on the number files and the size of the files, this process could take some time. During this process, the server is available for use but could run slower due to the impact from the file synchronization process. Editors should be able to continue working. The following message appears in the log when the File Distribution Service has completed its task:
INFO: Finished scanning the web roots for files for the File Distribution Service
- Start XperienCentral on the second read/write node if you are running a dual environment.
- In a dual read/write node environment, wait until the second read/write node has started successfully before starting XperienCentral on all read-only nodes. This could also take some time because the second read/write node needs to synchronize files from the central file store to the local disk. Until the file synchronization process is complete, the second read/write node will not be available for use.
- In a single read/write node environment, start XperienCentral on all read-only nodes.
Environments that Do Not Use the File Distribution Service
- Start XperienCentral on the read/write node. XperienCentral is completely started when the following messages appears in the Tomcat log:
26-jan-2010 13:05:35 nl.gx.webmanager.startup.impl.Startup start
INFO: XperienCentral started successfully in x ms
- Confirm that the upgrade was successful.
- Start XperienCentral one by one on all other read/write and read-only nodes.