|
|
|
Upgrading to Reflection for the Web 9.x from Reflection for the Web version 5.x or 6.x
Technical Note 1854
Last Reviewed 20-Apr-2007
Applies To
Reflection for the Web version 5.x through 6.x
Summary
Technical Note 1854
Last Reviewed 20-Apr-2007
Applies To
Reflection for the Web version 5.x through 6.x
Summary
This note describes how to upgrade to Reflection for the Web 9.x from Reflection for the Web version 5.x or 6.x.
For information about upgrading from Reflection for the Web version 7.x, 8.x, or 9.x see Technical Note 1853.
Note: Reflection for the Web 2008 is available beginning in June 2008.
- For a list of new features in Reflection for the Web 2008 R1, see Technical Note 2345.
- For information about upgrading to Reflection for the Web 2008 from version 5.x or 6.x, see Technical Note 2350.
- For information about purchasing Reflection for the Web, please e-mail us at: SalesRecept@attachmate.com.
When you upgrade, it is strongly recommended that you follow the steps in the order they are presented:
Step I: Uninstall Reflection for the Web 5.x or 6.x Components
Step II: Restart the Windows Server(s) from Which You Uninstalled Reflection
Step III: Install Reflection for the Web 9.x Components
Step IV: Upgrade Outdated Files
Step V: Update Printing Sessions
Step II: Restart the Windows Server(s) from Which You Uninstalled Reflection
Step III: Install Reflection for the Web 9.x Components
Step IV: Upgrade Outdated Files
Step V: Update Printing Sessions
Note: The term "Reflection management server" refers to the Administrative WebStation plus the terminal emulation files.
If your configuration enables users to save preference files, see the Note about User Preference Files at the end of this technical note.
Note: If after upgrading, you receive error messages when trying to make a secure connection, see Technical Note 1956 titled, Error Message: "Invalid or missing authorization token."
Step I: Uninstall Reflection for the Web 5.x or 6.x Components
A. Note for all installation methods:
- Note the directory structure used to install Reflection for the Web 5.x or 6.x. If you used the UDC Mapping tool in the Administrative WebStation to assign custom characters to EBCDIC values and you want to retain those mappings, save a copy of the udc.xml file that is in the [Reflection management server installation]/ReflectionData/ directory.
- If you exported keyboard map files using the Export Keymap command in the Reflection session and these mappings do not exist in a configuration file, then upgrade these files before uninstalling version 5.x or 6.x. For details, see the topic, Upgrading External Keyboard Map Files, in the Administrative WebStation.
- The term "Reflection management server" refers to the Administrative WebStation plus the terminal emulation files.
B. Remove Reflection for the Web 5.x or 6.x files from your server.
To uninstall a previous version:
- If you used an automated installer, choose one of these procedures.
For Windows:
- Go to Start > Settings > Control Panel > Add or Remove Programs. Select Reflection for the Web and click Remove.
- Go to Start > Programs > Reflection for the Web > Reflection for the Web Uninstallation.
- Run uninstaller.exe from the [installation folder]\_uninst\ folder.
For HP, Linux, or Solaris:
- Run uninstaller.sh from the <installation folder>/utilities/ directory. An X11 window is required to run the graphical interface. Ensure that you have root access, and then enter this command:
./uninstaller.shIf there are other components (for example, security proxy or metering) installed on different servers, use the instructions above to uninstall them.
Performing one of these automated uninstall operations will preserve your Reflection management server and security proxy server configurations. You will be prompted to save modified files during the uninstallation process.
- On other platforms, shut down the Reflection servers, save these files and folders, and then uninstall:
1. Reflection management server—copy and save all of the following:
- The web.xml file in the <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/WEB-INF/ directory.
- Any files that you customized in the <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/ or [Reflection management server installation]/jakarta-tomcat-[version number]/webapps/rweb/jsp/ directory.
- Any unprotected, static sessions in the <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/session/ directory. These sessions may also be saved in other directories within the webapps directory.
- The <Reflection management server installation>/ReflectionData/ directory.
- The cacerts file in the <Reflection management server installation>/_jvm/lib/security/ directory.
2. Security proxy server—copy and save the following:
- The <security proxy installation>/conf/ directory and the <security proxy installation>/keystores/ directory. This saves your server.properties file and your certificates.
3. Metering server—copy and save the following:
- The web.xml file in the <metering server installation>/jakarta-tomcat-[version number]/rwebmeter/WEB-INF/ directory.
4. Servlet runner—copy and save the following:
- The Tomcat keystore in the <tomcat installation>/jakarta-tomcat-[version number]/conf/ directory.
5. Then delete the directories in which you installed the Reflection for the Web components.
Step II: Restart the Windows Server(s) from Which You Uninstalled Reflection
If you are running in a Windows environment, restart the server(s) from which you uninstalled Reflection for the Web components.
For all other environments, restarting the servers is not necessary; proceed to Step 3.
Step III: Install Reflection for the Web 9.x Components
Install the Reflection for the Web 9.x components now. When you upgrade from a previous version:
- Install Reflection for the Web 9.x in the same directory structure that Reflection for the Web 5.x or 6.x used (noted earlier).
- Select and follow an installation procedure described in the InstallGuide.html file, located at the root of your product CD.
Step IV: Upgrade Outdated Files
The steps to upgrade outdated files vary depending on how you originally installed Reflection for the Web.
If you installed using an automated installer:
This section includes information about retaining settings for the management server, servlet runner, security proxy server, and metering server if you originally installed Reflection for the Web using an automated installer.
Note the following:
- Follow the steps below in the "For all installation types:" section to retain customized settings and imported certificates, and to upgrade JCE policy files and UDC files.
- See the Static Session Migration procedure in the Administrative WebStation to upgrade sessions that were not saved using the Session Manager or that were manually edited.
Reflection management server and servlet runner
Reflection management server and servlet runner settings have been retained. If you did not customize files or add certificates to the management server trusted list, no further upgrade steps are necessary.
Security proxy server
To ensure that you can edit your existing secure sessions or create new secure sessions in the Session Manager, you must export the security proxy server settings to the Administrative WebStation.
- Run the Security Proxy Wizard.
- Go to the Proxies tab and select Export Settings. You are prompted to export your settings to the management server.
- Ensure that the management server name, port, and context are correct, and then click Export.
For detailed configuration information, see the tutorial, Setting Up the Security Proxy, in the Administrative WebStation.
Metering server
Upgrade of the metering server is complete. To transfer the settings for your previous installation into your new installation, open your previous web.xml file in a text editor. (This file was archived in the [metering server installation]/jakarta-tomcat-[version number]/rwebmeter/WEB-INF/ directory.) Use this information as a reference when you configure the version 9.x metering server using the metering configuration interface. For detailed configuration information, see the tutorial, Setting Up the Metering Component, in the Administrative WebStation.
If you installed using archive files:
Ensure that the following files are copied or edited correctly.
Reflection management server:
- Copy the old ReflectionData directory into your new Reflection management server directory structure.
- A new web.xml file has been created in the <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/WEB-INF/. Open that new file in a text editor.
- In the new web.xml file, enter values for rwebdata_location_placeholder and https_port_placeholder from the web.xml file that you saved in Step I. You can copy and paste from your saved file, or enter values directly.
- Save the new web.xml file.
Security proxy server:
Copy the /conf/ and /keystores/ directories that you saved in Step I into the new security proxy installation.
To ensure that you can edit your existing secure sessions or create new secure sessions in the Session Manager, you must export the security proxy server settings to the Administrative WebStation.
- Run the Security Proxy Wizard.
- Go to the Proxies tab and select Export Settings. You are prompted to export your settings to the management server.
- Ensure that the management server name, port, and context are correct, and then click Export.
For detailed configuration information, see the tutorial, Setting Up the Security Proxy, in the Administrative WebStation.
Metering server
Use the settings recorded in the web.xml file to configure the new metering server. Open the web.xml file in a text editor and use these settings for reference when you configure the version 9.x metering server. For detailed configuration information, see the tutorial, Setting Up the Metering Component, in the Administrative WebStation.
Servlet runner:
Copy the Tomcat keystore you saved into <installation path>/jakarta-tomcat-[version number]/conf/.
In a text editor, open <installation path>/jakarta-tomcat-[version number]/conf/server.xml. Make necessary modifications to the HTTP port and HTTPS port.
For all installation types:
The following procedures to upgrade outdated files apply to all Reflection for the Web installation types.
JCE policy files
If you installed the JCE unlimited strength policy files from the Sun web site to support 192-bit and 256-bit AES encryption in your previous version of Reflection, the downloaded files are uninstalled from the management server without notification during an automated uninstallation.
If you installed using an automated installation, the JRE version 5.0 was installed. To continue supporting 192-bit and 256-bit AES encryption, download and install the most recent version of the JCE unlimited strength policy files from the Sun web site. For more details, see the Security Proxy Wizard help (Security Proxy Wizard > Proxies > Add or Modify > Add or Modify > Help).
UDC mapping
If you saved your UDC Mapping settings by saving the udc.xml file in Step 1, copy the udc.xml file into the new ReflectionData directory in version 8.x.
JNLP sessions:
If you created JNLP sessions in version 5.x, you will need to modify those sessions so they will work in Reflection for the Web version 9.x. For more information about running and modifying JNLP sessions, see Technical Note 1729.
Servlet runner
If you installed tomcat.zip, upgrade your JDK to Java 2 (version 5.0 is recommended).
Trusted certificates
Automatic installation: If you added certificates to the management server trusted list, the imported certificates are stored in the cacerts file. This file was automatically saved during uninstallation of your previous version in the root of the Reflection management server installation, and renamed. The new name is created by appending an underscore and a three-digit number to the original file name, for example, cacerts_000. Copy this file into the new <Reflection management server installation>/_jvm/lib/security/ directory, and then rename the file to cacerts.
Customized files
To retain any unprotected static sessions, see Technical Note 1802.
To retain your settings, follow the steps for your version of Reflection for the Web.
Version 6.x: To retain your settings if you saved the LauncherHTML.jsp file from your version 6.x installation:
- In a text editor, open your original LauncherHTML.jsp, located in <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/WEB-INF/jsp/.
- Replace the first two lines of the old file with these two lines:
<%@ page import="com.wrq.java13plus.management.core.GmAsset" %><%@ page import="com.wrq.java13plus.management.gm.LauncherStartAction" %>- Save LauncherHTML.jsp in your new Reflection for the Web installation at <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/gm/.
Version 5.1: To retain your settings if you saved the ReflectionClient.html file from your version 5.1 installation:
- In a text editor, open your original ReflectionClient.html, located in <Reflection management server installation>/ReflectionData/.
- In a text editor, open the new LauncherHTML.jsp, which is located in <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/gm/.
- Copy your color, margin, and font settings from ReflectionClient.html into LauncherHTML.jsp.
- Save the JSP file.
Version 5.0: To retain your settings if you saved the LoginPage.jsp file from your version 5.0 installation:
- In a text editor, open your original LoginPage.jsp, located in <Reflection management server installation>/jakarta-tomcat-4.0.1/webapps/rweb/.
- In a text editor, open the new LauncherHTML.jsp, which is located in <Reflection management server installation>/jakarta-tomcat-[version number]/webapps/rweb/gm/.
- Copy your color, margin, and font settings from LoginPage.jsp into LauncherHTML.jsp.
- Save the JSP file.
Macros
To run version 6.x or 5.x macros in Reflection for the Web 9.x, you must manually import the older macros into version 9.x as follows:
- Locate the version 5.x or 6.x *.mac files on a user workstation. These files are located in <Java USER_HOME>\reflectionweb\macros directory.
For a Windows client using the Sun Java Plug-in, the default location is C:\Documents and Settings\<username>\reflectionweb\macros.
For a Windows client using the Microsoft virtual machine, the default location is C:\Windows\Java\reflectionweb\macros.
- Launch Reflection for the Web version 9.x. In the launched session, import the 5.x or 6.x *.mac files by clicking Macro > Playback > Import.
IIS Integration
If you installed Reflection using an automated installer, the installer prompted you to configure IIS during installation. You will need to stop and restart IIS and the Reflection Management server service for integration to take effect.
Note: If you are using Windows Server 2003 or if the server has multiple web sites, see Technical Note 2195 for more information about integrating Reflection for the Web with IIS.
BEA portal integration
If you integrated Reflection for the Web version 6.x with your BEA portal, modify the existing code in your portlet JSP. To display a session, use the following code (all on one line):
..... <%= new com.wrq.java13plus.management.portal.RWebBrokerWLP().getContent(request, "<RWeb URL>/RWebSession.do?link=<Session name>&portal=true&appletOnly=true") %> ..... |
To display the end user links list, use the following code (all on one line):
.....<%= new com.wrq.java13plus.management.portal.RWebBrokerWLP().getContent(request, "<RWeb URL>/LoginPage.do&appletOnly=true") %>..... |
Step V: Update Printing Sessions
When upgrading to Reflection for the Web 9.x, your printer sessions, print setup, and the test print feature may no longer function.
If you experience this problem, follow the steps below.
- Open the Reflection for the Web Administrative WebStation and click Session Manager.
- Click the printer session link and then click Save Settings.
- Repeat steps 1 and 2 for each printer session.
Note about User Preference Files
Each user's preference files are stored locally on the user's machine and are not upgradeable with the Reflection for the Web upgrade on the server. End users will need to create new preference files.
Advise the end users to rename the existing preference (.pref) files, launch a session, configure the settings as needed, and then save a new preference file. (In Reflection, click File > Save Preferences.)
