action.skip

Create or Modify a Transform

You can use the Installation Customization Tool to create a transform ( .mst) file.

To create a transform with the Installation Customization Tool

  1. From your administrative installation point, open the Installation Customization Tool from a desktop shortcut or by typing the following command line:

    path_to_setup\setup.exe /admin

  2. In the Select Customization dialog box, select Create a new Setup customization file for the following product or Open an existing Setup customization file.

  3. Select items from the list in the left panel to open configuration panels on the right, and then make your customizations.

  4. Save your transform as an .mst file.

    note

    Rocket Software recommends that you save transform files in the same folder as the Reflection base installation package .msi file.

Change the Installation Directory

You can change the Reflection installation directory.

To change the installation directory

  1. From your administrative installation point, open the Installation Customization Tool from a desktop shortcut or by typing the following command line:

    path_to_setup\setup.exe /admin

  2. From the Select Customization dialog box, do one of the following:

    • Select Create a new Setup customization file for the following product.

    • Select Open an existing Setup customization file or Companion installer and, in the Open dialog box, select an .mst file.

  3. On the left panel of the Installation Customization Tool, click Install location and organization name.

  4. In the Default installation folder box, specify where to install the product files.

    note

    List items that refer to folders (for example, [ProgramMenuFolder]) are pre-defined folder keywords. You can create customized directories by adding new folder names with typical directory syntax (such as, [ProgramFilesFolder]\My Folder). Alternatively, you can enter a fully qualified path (for example, C:\Program Files\My Folder), as long as that location is known to exist on the target machine.

Modify Setup Properties

In some cases you may want to customize your installation using Windows Installer (MSI) properties that support features not configurable on other Installation Customization Tool panels. For example, the installer property ARPHELPLINK, sets the URL used by the support link in the Programs and Features list.

note

If you want to create a custom (non-default) user data location that will be used by all installed Reflection products, specify the product-specific property WRQ_USERDIR. This property affects only those applications whose default user data directory is [PersonalFolder]\Micro Focus\Reflection\. Reflection applications that use this default data location include: Reflection Workspace, Reflection FTP Client, Reflection Kerberos Manager, Reflection Key Agent, and Reflection IBM Printer. Reflection X does not use this user data location.

To set the location where Reflection X artifact files are saved, specify the file path in the RXA_ARTIFACTS_DIR property.

To modify installation properties

  1. From your administrative installation point, open the Installation Customization Tool from a desktop shortcut or by typing the following command line:

    path_to_setup\setup.exe /admin

  2. From the Select Customization dialog box, do one of the following:

    • Select Create a new Setup customization file for the following product.

    • Select Open an existing Setup customization file or Companion installer and, in the Open dialog box, select an .mst file.

  3. From the Installation Customization Tool navigation pane, select Modify setup properties.

  4. Click Add to open the Add/Modify Property Value dialog box.

  5. In the Name box, use the drop-down list to select commonly-used public properties that are standard to the Windows Installer. Select an item in the list to see a brief description of the selected property. Some Rocket Software products support additional properties that do not appear in the drop-down list. You can configure these properties by manually entering the property name.

  6. From the File menu, select Save As and save the file to the same folder as the installer package file for Reflection ( setup.exe).

Add/Modify Registry Data

To modify registry data

  1. From your administrative installation point, open the Installation Customization Tool from a shortcut or by typing the following command line:

    path_to_setup\setup.exe /admin

  2. From the Select Customization dialog box, do one of the following:

    • Select Create a new Setup customization file for the following product.

    • Select Open an existing Setup customization file or Companion installer and, in the Open dialog box, select an .mst file.

  3. From the navigation pane, click Add registry data.

  4. To add a new registry value, click Add.

    -or-

    To modify a registry value in the table, select the value, and then click Modify.

  5. Specify registry keys and values to add or modify during the installation process. By modifying registry values, you can change the way the application operates. For example, for certain Rocket Software applications, you can add a value that specifies to never save settings on exit.

    In this field Enter or select
    Key The complete Registry path from the root, for example:

    HKEY_LOCAL_MACHINE\SOFTWARE\Reflection\Rwin\Reflection
    Name The registry value name, for example:

    SaveChanges

    If the Name box is blank, the data entered into the Value box are written to the Default registry key.
    Type The data type of the value. For example:

    DWORD

    Types include strings, integers (DWORD), or binary values.
    Value The value. For example:

    0x00000000 (0)

Select Features, Components, and Languages

You can select which features, components, and languages to install for your end users. In addition, you can make features available to users for a later installation or hide them from view.

To select features, components, and languages to install

  1. From your administrative installation point, open the Installation Customization Tool from a shortcut or by typing the following command line:

    path_to_setup\setup.exe /admin

  2. From the Select Customization dialog box, do one of the following:

    • Select Create a new Setup customization file for the following product.

    • Select Open an existing Setup customization file or Companion installer and select an .mst file.

  3. From the Installation Customization Tool navigation pane, select Set feature installation states, and for each feature, choose from the following states:

    Choose To do this
    Feature will be installed on local hard drive Add a feature to the installation.

    Note: Some features listed under a selected feature may not be included when you select to install the higher-level feature. The features that are included are the recommended defaults. If you select the higher level feature a second time, all sub-features will be included.
    Feature will be installed when required Advertise a feature.
    Feature will be unavailable Leave a feature uninstalled. End users will still be able to select and install the item from the Windows Program and Features or the Add or Remove Programs control panel.

More information

Add (Chain) Installations and Run Programs

Reflection makes it easy to "chain" installs. You can set up an install to run companion install packages automatically before or after the primary installation. You can also specify to run other scripts or programs. For example, the Reflection product Help is available as a separate program ( .msi) that you can add to the base product installation. See Install the Reflection Help.

note

This method of chaining installations applies only to installs performed with setup.exe. It does not apply to installs that use the MSI command-line method.

To chain installations and programs

  1. From your administrative installation point, open the Installation Customization Tool from a shortcut or by typing the following command line:

    path_to_setup\setup.exe /admin

  2. From the Select Customization dialog box, do one of the following:

    • Select Create a new Setup customization file for the following product.

    • Select Open an existing Setup customization file or Companion installer and select an .mst file.

  3. From the navigation pane, select User Interface and then select Use this customization with interactive installs using setup.exe.

  4. From the navigation pane, select Add installations and run programs.

  5. Click Add.

    The Add/Modify Program Entry dialog box opens.

  6. In the Target list, enter or select the folder where the program .exe file or the .msi file resides, and then enter the executable to run. For example:

    msiexec.exe

  7. Under Arguments, enter the command-line arguments to execute. For example:

    /i my_installation.msi

  8. To specify when to run the program, select one of the following:

    • Run this program after base product has been installed

    • Run this program before the base product has been installed

    note

    For most cases, select Run this program after the base product has been installed. If you select Run this program before the base product has been installed and the program fails, Reflection is not installed.

  9. Repeat these steps to add other programs or .msi files.

  10. To change the execution sequence, use the arrows next to Move in the lower-left area of the pane. To remove a program from the list, select it in the list and click Remove.

Install the Reflection Help

By default, the Reflection Help browser opens the Help from the Rocket Software website. To allow users to open the Help from the local hard drive you must install the product Help after installing Reflection and change the Reflection Workspace settings to use the installed help system.

To configure the Reflection Workspace to open Help locally

  1. Open the Reflection Workspace Settings dialog box.

    The steps depend on your user interface mode.

    User Interface Mode Steps
    Ribbon (../images/Office 2007) On the Reflection button (if using the Office 2007 Look and Feel), choose Reflection Workspace Settings.
    Ribbon (Office 2010) On the File menu, choose Reflection Workspace Settings.
    Reflection Browser On the Reflection menu, choose Settings and then Reflection Workspace Settings.
    Mobile UI Tap the Gear icon and then select Reflection Workspace Settings.

  2. Under Workspace Settings, select Configure Workspace Attributes.

  3. Under Help System, select Use installed help system.

    If Reflection can't find the Help files on the local drive, it will start your default browser and open the help files from Rocket Software website.

To install the Help locally

  • On a workstation where Reflection is already installed, from the installation image, open the HelpInstaller folder and double-click setup.exe.

    - or -

  • Chain the Help installer to the main installation, selecting Run this program after base product has been installed. For more information, see Add (Chain) Installations and Run Programs.

To set up Help on a Windows server

note

If you install Reflection on a Windows Server and Enhanced Security (IE ESC) is enabled, viewing the Help will result in security prompts each time you open a page. To resolve this problem, do the following:

  1. Turn off Internet Explorer Enhanced Security for users and administrators.

  2. Turn Off Internet Explorer Enhanced Security on Windows 2008 Server.

  3. Enable scripting for Internet Explorer.

Predefined System Folders

When you configure destination locations using the Installation Customization Tool, your options include Reflection properties that correspond to Windows system folder properties. During installation, the Windows installer expands these to show the appropriate location for your operating system.

The list of available folders for adding files to a companion installer depends on whether you are installing for all users (the default) or for individual users.

All-user installations

Reflection Property name Default Windows location Default path using Windows variables
[CommonAppDataFolder] C:\ProgramData %Programdata%
[CommonDocumentsFolder] C:\Users\Public\Documents %Public%\Documents
[CommonFilesFolder] C:\Program Files\Common Files %ProgramFiles%\Common Files
[ProgramFilesFolder] C:\Program Files %ProgramFiles%
[RootDrive] C:\ \
[WindowsFolder] C:\Windows %windir%

Individual user installations

Reflection Property name Default Windows location Path using Windows variables
[AppDataFolder] C:\Users\<user>\AppData\Roaming\ %appdata%
[LocalAppDataFolder] C:\Users\<user>\AppData\Local\ %localappdata%
[PersonalFolder] C:\Users\<user>\Documents\ %userprofile%\documents
[RootDrive] C:\ \
[%UserProfile] C:\Users\<user> %userprofile%

Configure Shortcuts

You can change the attributes associated with the pre-defined Reflection shortcuts. Also, you can configure shortcuts associated with files you've added to a custom install package.

note

This method of chaining installations applies only to installs performed with setup.exe. It does not apply to installs that use the MSI command-line method.

To configure shortcuts

  1. On a workstation on which you have installed Reflection, open the Installation Customization Tool from a desktop shortcut (if you set up a shortcut as shown on page 11) or from a command line as follows:

    path_to_setup\setup.exe /admin

  2. From the Select Customization dialog box, do one of the following:

    • Select Create a new Setup customization file for the following product.

    • Select Open an existing Setup customization file or Companion installer and select an .mst file.

  3. From the Installation Customization Tool navigation pane, choose Configure shortcuts.

  4. Select the shortcut that you want to configure, and then click Modify.

  5. In the Modify Shortcut dialog box, in the Location list, enter or select the folder where you want the shortcut to reside.

    note

    List items that refer to folders (for example, [ProgramMenuFolder]) are pre-defined folder keywords. You can create customized directories by adding new folder names with typical directory syntax (such as, [ProgramFilesFolder]\My Folder). Alternatively, you can enter a fully qualified path (for example, C:\Program Files\My Folder), as long as that location is known to exist on the target machine.

  6. Enter a descriptive name and tooltip for the shortcut.

  7. Enter the command-line arguments for the shortcut in the Arguments window.