Upgrading SDL LiveContent Reach with a third-party web application server
This procedure describes how to upgrade SDL LiveContent Reach when it has been integrated with a third-party web application server, such as Apache Tomcat.
About this task
For a list of files that are new, updated, or obsoleted in this release, see the SDL LiveContent Reach Release Notes. Updated files that you are likely to have customized are delivered so that they do not overwrite your customization.
Procedure
- Do one of the following:
- For Windows, log on to the server as a user with administrative privileges.
- For Linux, log on as the root user.
- Stop the web application server.
- Download the SDL LiveContent Reach installation executable through your customer FTP account, provided by SDL customer support.
- To start the installation, run the installation executable.
- For Windows, navigate to the folder where you downloaded the installation package, and then right-click on the installation executable and choose Run as administrator.
- For Linux, navigate to the folder where you downloaded the installation package, and then enter ./install.bin. The installation package may have a different filename, which includes its version number.
- Click Next in the Introduction panel.
- In the License Agreement panel, read the license terms, click I accept the terms of the License Agreement, then click Next.
- In the SDL LiveContent Reach Upgrade window, click OK.
- Review the settings in the Pre-Installation Summary panel, then click Install.
- In the Installation Successful panel, note the URL and login info, then click Next when the installation is complete.
- In the Install Complete panel, click Done.
A log file of the installation process is written to LiveContent_home/logs.
- Optionally, configure Apache Tomcat to support UTF-8 input for user names and searches.
In the
TOMCAT_HOME/conf/server.xmlfile, add these attributes to all<Connector>elements within the configuration:useBodyEncodingForURI="true"URIEncoding="UTF-8"
For example:<Connector port="8443" protocol="HTTPS/1.1" connectionTimeout="20000" redirectPort="8443" useBodyEncodingForURI="true" URIEncoding="UTF-8"/> - Restart the web application server. For example, if you are using Apache Tomcat, restart the Apache Tomcat service.
- At a command prompt (Run as Administrator), in the LiveContent_home/WEB-INF/ directory, do one of the following:
For a Windows secure upgrade installation, type
setup.bat -jh path_to_java -Dlc.port=port# -Dlc.protocol={https} -Dlc.host=fully.qualified.domain.name fix_audits upgradeExample:
setup.bat -jh JAVA_HOME -Dlc.port=8443 -Dlc.protocol=https -Dlc.host=wkqasv0804.global.sdl.corp fix_audits upgradewhere
JAVA_HOMEis set as follows:C:\Users\Administrator>set JAVA_HOME=C:\Program Files\Java\jdk7For a Windows non-secure upgrade installation, type
setup.bat -jh path_to_java -Dlc.port=port# -Dlc.host=fully.qualified.domain.name fix_audits upgradeExample:
setup.bat -Dlc.port=8080 -Dlc.protocol=http -Dlc.host=wkqasv0804.global.sdl.corp fix_audits upgradewhere
JAVA_HOMEis set as follows:C:\Users\Administrator>set JAVA_HOME=C:\Program Files\Java\jdk7For a Linux secure upgrade installation, type
setup.sh -jh path_to_java -Dlc.port=port# -Dlc.protocol={https} -Dlc.host=fully.qualified.domain.name fix_audits upgradeExample:
setup.sh -Dlc.port=8443 -Dlc.protocol=https -Dlc.host=wkqasv0804.global.sdl.corp fix_audits upgradewhere
JAVA_HOMEis set as follows:set JAVA_HOME=/usr/Java/jdk7For a Linux non-secure upgrade installation, type
setup.sh -jh path_to_java -Dlc.port=port# -Dlc.host=fully.qualified.domain.name fix_audits upgradeExample:
setup.sh -Dlc.port=8080 -Dlc.protocol=http -Dlc.host=wkqasv0804.global.sdl.corp fix_audits upgradewhere
JAVA_HOMEis set as follows:set JAVA_HOME=/usr/Java/jdk7
-jh path_to_java Path to where the JDK is installed. See the SDL LiveContent Reach Platform Requirements for supported Java versions. If your path to Java includes spaces, then you must quote the entire path. Note: If your JAVA_HOME environment variable is set to point to the version of Java that you have used for the SDL LiveContent Reach installation, you do not need to include the-jhoption in the command.-Dlc.port# Port number of the SDL LiveContent Reach web application. The port number can be 2 to 5 digits. Typically, Tomcat uses port 8443 for the HTTPS protocol.
-Dlc.protocol Hypertext Transfer Protocol Secure (HTTP). Because this is the default protocol, you do not need to include the
Hypertext Transfer Protocol Secure (HTTPS), a secure communications protocol. You must include the-Dlc.protocolswitch.-Dlc.protocolswitch.-Dlc.context Used to specify a web app context other than the default, which is LiveContent. Include -Dlc.context=/context
If you are unable to run setup.bat (as evidenced by an error in ApacheTomcat_home\logs\urlrewrite.log about an invalid char at index 27), ensure that C:\Windows is included in the
java.library.pathenvironment variable.Running this script completes the installation by determining the web application context, initializing the database, and uploading program files and skins to the database.Note: If you experience a web\UI.XQL literal text string when logging in, you should restart the Apache Tomcat service. - Refer to the third-party web application server documentation for settings to optimize the initial heap size and maximum heap size for Java, based on available RAM. Ensure that the memory settings are valid based on those specified for the database and modify the database memory settings as appropriate. For details, see Changing Database Memory Settings.
For example, in Apache Tomcat you can configure these memory settings using the tomcatversion#w.exe application (for example, tomcat7w.exe).
On the Java tab, you can set these fields:Table 1. On Windows: Initial memory pool 2048 Maximum memory pool 6144 Thread stack size null Note: These settings assume that the Tomcat server has at least 8 GB of system memory.On Linux:xpplinux5sqa-root 114 > more setenv.sh export JAVA_HOME="/usr/java" export JAVA_OPTS="-Xms2048m -Xmx6144m" xpplinux5sqa-root 115 > pwd /usr/app/apache-tomcat-7.0.23/bin - For Apache Tomcat only, if you wish to be able to control SDL LiveContent Reach from the Tomcat Application Manager interface, you must copy the LiveContent_home/WEB-INF/lib/rlmnum.jar file to ApacheTomcat_home/lib and then stop and restart the Apache Tomcat service.
Note: Typically, num is a date string (for example, rlm923.jar).Tip: If you would like to manage only SDL LiveContent Reach from the Tomcat Web Application Manager, then delete all but the LiveContent directory from the InstallDir\Program Files\Apache Software Foundation\Tomcat 7.0\webapps directory.
- Diff the newly upgraded conf.xml.tmpl with your local conf.xml file. Locate any differences in the newly-delivered conf.xml from the old one and to then migrate configuration changes. Consult the SDL LiveContent Reach Release Notes for any fixes added to the new conf.xml.The upgrade may have installed important new changes that need to be merged into your working copy.
Note: The conf.xml file is located in the WEB-INF directory of the web application.
To merge these files, do the following:
- In the LiveContent_home directory, save the conf.xml file as conf.xml.orig
- Copy the conf.xml.tmpl file to conf.xml
- Merge your changes in conf.xml.orig into the new conf.xml file.
- Reindex the SDL LiveContent Reach database.
Upgrading SDL LiveContent Reach might require new indexes in the SDL LiveContent Reach database to optimize performance for the new release. Therefore, you must reindex the database before redeploying SDL LiveContent Reach for general use.Tip: Alternatively, you can use the
loaddb reindexcommand.- Browse to SDL LiveContent Reach at https://host:port/LiveContent, and log in as a user that belongs to a group with the Manage app permission.
- If you are in a SDL LiveContent Reach tool, click Home in the breadcrumb trail.
The Review and Collaboration landing page appears.
- In the Administration Tools pane, click Manage Application.
The Manage Application page appears.
- In the left pane, click Search Categories.
- Click Reindex.
- Merge skin language files.
To avoid UNDEFINED popping up unpredictably in the skin user interface, the skin developer should merge the differences between base skin's language files in the new SDL LiveContent Reach version and in their skins, which are still based on the older SDL LiveContent Reach version.
What to do next
Once you have completed this procedure, you are ready to perform the post-installation processes.