As part of the Workplace XT software
upgrade, you must back up and undeploy your existing installation.
You can then run the setup program to upgrade the software.
Attention: For sites with IBM® Production Imaging Edition Viewer Pro installations
: If you want to upgrade a
Workplace XT version
1.1.4 configuration to version 1.1.5 including the Viewer Pro software,
you must uninstall the software as documented in its
Installation Guide before running the
Workplace XT installer.
Important: In a highly
available clustered server environment, perform the steps on all nodes
in your cluster.
To upgrade the
Workplace XT software:
- Log in to the application server where Workplace XT is installed.
Option |
Description |
UNIX |
Log in as a user with write access to the /bin directory
and read, write, and execute access to the directory where you plan
to upgrade Workplace XT. |
Windows |
Log in as a member of the local Administrators group or a
user with equivalent permissions. |
The path to the installation directory is referred to with
the variable install_path in this documentation.
The default value of this variable depends on the version and host
operating system of the product installation:
- Version 1.1.3.x and earlier releases
- UNIX: /opt/FileNet/WebClient
- Windows: C:\Program
Files\FileNet\WebClient
- Version 1.1.4.0 and later releases
- UNIX: /opt/IBM/FileNet/WebClient
- Windows: C:\Program
Files\IBM\FileNet\WebClient
Tip: Although the UNIX-installing user must have write access
to the /bin directory, the Workplace XT installation program does
not write to that directory.
- From Process Task Manager, stop Component Manager (if running),
then exit the Process Task Manager application.
- (Windows only)
From the Windows Services
console, stop the Process WPXT Services Manager service.
- (Windows only)
Using the Windows Task Manager,
verify that no javaw.exe processes are running.
If the applications in the preceding steps stopped correctly,
no Workplace XT-related javaw.exe processes are
running. If needed, use Windows Task
Manager or some other process management tool to stop all javaw.exe processes
that are in the directory path install_path\_WCjvm\bin.
- Back up, undeploy, and remove the Workplace XT (web_client) Web application
from the J2EE application server.
Option |
Description |
WebSphere® Application
Server |
- Back up the deployed Workplace XT directory:
WAS_HOME/profiles/default/installedApps/node_name/WorkplaceXT.ear/application_name.war
- Stop the Workplace XT application
from the WebSphere administration
console.
- Uninstall the Workplace XT application
from Enterprise Applications.
- Save the changes and stop the WebSphere server.
- Delete the temporary Workplace XT directory
(default: WorkplaceXT) from:
WAS_HOME/profiles/default/temp/node_name/instance/
- Delete all folders from the wstemp directory
in the following location:
WAS_HOME/profiles/profile_name/wstemp
|
WebLogic Server |
- From the WebLogic Server administration
console, stop the Workplace XT Web
Application Module.
- Make a backup copy of the Workplace XT folder
or of the deployed Workplace XT directory:
- install_path/WorkplaceXT
- install_path/deploy/application_name.war
- install_path/deploy/web-client.ear
- Delete the Workplace XT Web
Application Module.
- Stop the WebLogic Server.
- Delete the temporary Workplace XT directory
(default: WorkplaceXT or web_client)
from:
WL_HOME/domain/servers/instance/
tmp/_WL_usr
|
JBoss Application Server |
- Stop the JBoss Application Server server.
- Back up the deployed Workplace XT application:
JBOSS_HOME/server/server_name/deploy/application_name.war or .ear
- Delete the Workplace XT application
from the deployed location.
- Clear out all files and folders within the following temp directories:
JBoss_home/server/server_name/tmp/deploy
JBoss_home/server/server_name/work/jboss.web/localhost
|
- (For systems with the IBM Content
Manager OnDemand (CMOD) site preference configured) Move the CMOD
key store and change the keyStorePath context parameter in the web.xml file.
- Copy the CMOD key store file, cmodKeyStore.
The default location is in the following path:
install_path/WorkplaceXT/WEB-INF
- Place the copy of the cmodKeyStore file
into the Config/WebClient directory, in the following
path:
install_home/FileNet/Config/WebClient
The
default path for the variable install_home depends
on the Workplace XT version
that you are upgrading and on your operating system:
- Version 1.1.3.x and earlier releases
- UNIX: /opt
- Windows: C:\Program
Files
- Version 1.1.4.0 and later releases
- UNIX: /opt/IBM
- Windows: C:\Program
Files\IBM
- Change the value for the keyStorePath parameter
in the web.xml file to match the new location
of the key store file:
<context-param>
<param-name>keyStorePath</param-name>
<param-value>install_home/FileNet/Config/WebClient/cmodKeyStore
</param-value>
</context-param>
- Optional: Copy existing configuration files.
If you have made custom changes to your configuration files
in the deployed location, do the following before you upgrade the
existing Workplace XT installation.
Copy
the following files:
- WcmApiConfig.properties
- web.xml
from the /WEB-INF folder in the backed-up Workplace XT directory created in the
previous step to the following directory:
install_path/WorkplaceXT/WEB-INF/
- For upgrades moving from JBoss 4.x.x to JBoss 5.x.x
only: If Workplace XT is
upgraded on a system that has been upgraded from JBoss 4.x.x to JBoss
5.x.x, you must edit the web.xml file and copy
a file to install_path/WorkplaceXT/WEB-INF/ before
deployment of Workplace XT using
JBoss 5.x.x.
- Type the following lines at the end of the corresponding
listener section of the web.xml file:
<listener>
<listener-class>com.sun.faces.config.ConfigureListener</listener-class>
</listener>
- Copy the file jboss-classloading.xml in
the path FileNet/WebClient/jboss5, and place
the copy in the directory install_path/WorkplaceXT/WEB-INF/.
- Optional: Install the IBM Production Imaging Edition Viewer
Pro license file. If you have purchased IBM Production
Imaging Edition, the Viewer Pro software can be installed when you
run the Workplace XT installation.
- To activate the Viewer Pro installation, you must run
the license installer before you upgrade Workplace XT. Start the IBM Production Imaging Edition Viewer Pro license
installation in one of the following ways, depending on whether you
want to upgrade interactively or silently:
Option |
Description |
To install IBM Production
Imaging Edition Viewer Pro license interactively: |
- Access the IBM Production
Imaging Edition Viewer Pro license installation software package.
- Launch the appropriate Setup program (PIEProLic-1.1.5.0-operating_system.bin or .exe)
and follow the prompts in the wizard screens.
|
To install IBM Production
Imaging Edition Viewer Pro license silently: |
- Access the IBM Production
Imaging Edition Viewer Pro license installation software package,
and copy the PIEsilent_input.txt file to a local
directory.
- Referring to the values from your worksheet, access the IBM Production Imaging Edition Viewer
Pro package and edit the silent input file to reflect the appropriate
responses for your installation.
Even if you accept all defaults
in the PIEsilent_input.txt file, you must edit
the file to accept the license agreement (-V licenseAccepted="true").
- From a command prompt, navigate to and run the installer:
- UNIX
- ./PIEProLic-1.1.5.0-operating_system.bin
-options "path_to_edited_input_file/XT_silent_upgrade.txt"
-silent
- Windows
- PIEProLic-1.1.5.0-Win.exe -options "path_to_edited_input_file\XT_silent_upgrade.txt"
-silent
|
View the PIEPro_install_log.txt file
located in install_path/IBM/FileNet/PIEProLicense.
Correct errors or failures noted in the log file before proceeding
with the Workplace XTupgrade.
Often problems are logged with the term "ERROR" at the beginning of
a line.
- Start the upgrade process in one of the following ways,
depending on whether you want to upgrade in interactively or silently:
Option |
Description |
To upgrade Workplace XT interactively: |
- Access the Workplace XT installation
software package.
- Launch the appropriate Setup program (WorkplaceXT-1.1.5.0-operating_system.bin or .exe)
and follow the prompts in the wizard screens. The installer detects
and copies settings from the previous Workplace XT installation.
|
To upgrade Workplace XT silently: |
- Access the Workplace XT installation
software package, and copy the XT_silent_upgrade.txt file
to a local directory.
- Follow the instructions in the silent input file to edit the values
to reflect the appropriate responses for your installation.
Even
if you accept all defaults in the XT_silent_upgrade.txt file,
you must edit the file to accept the license agreement (-V
licenseAccepted="true").
- From a command prompt, navigate to and run the installer:
- UNIX
- ./WorkplaceXT-1.1.5.0-operating_system.bin
-options "path_to_edited_input_file/XT_silent_upgrade.txt"
-silent
- Windows
- WorkplaceXT-1.1.5.0-Win.exe -options "path_to_edited_input_file\XT_silent_upgrade.txt"
-silent
|
- When the upgrade program is complete, view the web_client_install_log_1.1.5.0.txt file
located in: install_path/FileNet/WebClient.
Verify that no errors or failures were logged. Correct any
errors before you proceed.
- Optional: Update files to support user tokens
for Workplace XT.
If
user tokens are enabled on the system prior to the upgrade and if
you are using version 4.5.1, 5.0, or 5.1 of Content Engine, the authentication-websphere.jar and log4j-1.2.13.jar files
must be copied again. Refer to the appropriate section below for configuring
user tokens and the location from which these files are copied:
Option |
Description |
WebSphere |
- Copy the authentication-websphere.jar file
from here:
install_path/FileNet/WebClient/WorkplaceXT/authenticationFiles
to
here:
WAS_home/AppServer/lib/ext
- Copy the log4j-1.2.13.jar file from here:
install_path/FileNet/WebClient/WorkplaceXT/WEB-INF/lib
to
here:
WAS_home/AppServer/lib/ext
|
WebLogic |
- Copy the authentication-weblogic.jar file
from here:
install_path/FileNet/WebClient/WorkplaceXT/authenticationFiles
to
here:
WL_home/server/lib/mbeantypes
- Copy the log4j-1.2.13.jar file from here:
install_path/FileNet/WebClient/WorkplaceXT/WEB-INF/lib
to
here:
WL_home/server/lib/mbeantypes
|
JBoss |
Copy the authentication-utils.jar file
from here:
install_path/FileNet/WebClient/WorkplaceXT/authenticationFiles
to
here:
JBOSS_home/server/server_name/lib
|
- For upgrades moving from WebLogic version 10.x to
version 11g only: Configure the WebLogic session cookie settings.
- Go to the install_path/FileNet/WebClient/WorkplaceXT/WEB-INF directory.
- Back up the weblogic.xml file to weblogic.xml.bak.
- Copy the weblogic-11g.xml file
from the WebLogic_install_path/WebClient/weblogicFiles directory
to the WEB-INF directory in the Workplace XT installation path.
- Rename the weblogic-11g.xml file
to weblogic.xml. Copying and renaming
the weblogic-11g.xml file to the new location
is required before deploying Workplace XT using
WebLogic 11g.