Settings File Format in Reflection for IBM 14.x

  • 7021692
  • 20-May-2004
  • 01-Apr-2018

Environment

Reflection for IBM version 14.x

Situation

Starting with version 12.0, Reflection for IBM uses a new format for your saved settings files. This technical note describes the new binary file format and discusses implications of this change.

Resolution

Version Information

For information about using update settings files in Reflection 12.0 through 14.x, see KB 7021642.

Introduction

Starting with version 12.0, Reflection for IBM settings files (*.rsf) are saved in binary file format rather than as simple text files. The new binary file format means that macros can be included in your settings files, making it easier to distribute macros to other users.

Partial settings files, which include Key/Mouse (*.map), Toolbar (*.btp), Colors (*.clr), Hotspot/Hotlist (*.hsp), and Menus (*.mnu) continue to use text format. Settings update files (*.rsu) also continue to use text format.

Prior Version Settings Files are Updated Automatically

When you open a settings file created with Reflection 11.0 or earlier, Reflection 12.0 through 14.x automatically updates its settings to the newer binary format. However, the updated format isn't retained until you save the settings file.

Note the following:

  • Your saved settings file is changed to the new binary format the first time you use Reflection's File > Save command. If you close Reflection without using the Save command, the file will retain its original (text-based) format.
  • Prior to version 12.0, macros were saved in separate files that had the same base name as your settings file and used an *.rvx extension. Macros are now incorporated directly into your settings files. The first time you save a prior version settings file using Reflection 12.0 through 14.x, Reflection moves all macro information to the saved settings file (*.rsf) and deletes the *.rvx file.

Sharing Settings Files with Earlier Versions of Reflection

Earlier versions of Reflection cannot open the binary settings file that were created using version 12.0 through 14.x. If you create and save a settings file using version 12.0 through 14.x and then try to open that file using an earlier version of Reflection, you will see the following error message:

<file name> is not a valid Reflection settings file

Reflection users running version 12.0 through 14.x can share settings with users running older versions of Reflection by saving partial settings files or creating settings update files. These files can be opened in earlier versions of Reflection.

To share macros created using version 12.0 through 14.x, you can open the Visual Basic editor and export your Visual Basic project files. Use the Visual Basic Editor again in the earlier Reflection application to import the project files.

"Not a valid file" Errors seen when Launching Reflection from a Web Page

If you use a web page to launch your Reflection sessions and see an error message saying that the settings file is not a valid Reflection settings file, contact your system administrator. Administrators who have installed and configured Reflection for the Web can use the Reflection for the Web Administrative WebStation to distribute Reflection sessions to end users. If the administrator is using version 12.0 through 14.x on the workstation that creates the Reflection for IBM settings files uploaded to the web server, end users running Reflection 11.x or earlier will not be able to launch those sessions.

Administrators who use the Administrative WebStation to distribute Reflection sessions should use one of the following strategies to ensure that all end users can run Reflection sessions.

  • Upgrade all users to the latest version of Reflection.
  • Run version 11.x (or earlier) on the administrator's workstation. This will ensure that all settings files uploaded to the web server use the earlier file format.

Tips for Viewing Settings

Because the new settings files are saved in binary format, you can no longer view and edit these files directly. You can still use either of the following methods to view information about your settings.

  • To see a quick list of non-default settings, open the View Settings dialog box and set Display settings to Changed. (Note: Some Reflection configuration information is not included in the View Settings dialog box list.)
  • To see a comprehensive list of all current configuration information, click File > Save As, and then in the Save as type drop-down list, select XML Settings (*.xml). Open the resulting file in your web browser. If your session is configured to use the default value for Transform Settings to HTML, the XML file you created will display an HTML document summarizing all of your current settings.

Additional Information

Legacy KB ID

This document was originally published as Attachmate Technical Note 1820.