The following sections describe how to install and publish Reflection applications in a Citrix XenApp Server environment.
A. Creating Reflection Installation Files
B. Creating Companion Packages, Permissions Files, and Transforms
C. Create a Companion *.MSI File Using the Installation Customization Tool (ICT)
D. Define an application.settings file Using the Installation Customization Tool
E. Define Permissions Files
F. Use the Attachmate Customization Tool to Create a Custom Transform File
G. Installing Reflection Executables
H. Deploying Reflection Host and other Configuration Files
I. Publishing Reflection Applications
Before installing Reflection, first determine how the Reflection Host session and other configuration files will be accessed by the users. There are a variety of ways to configure Reflection in a Citrix environment and the following three types will be covered:
1. End-users launch Reflection with no configuration file
a. No default configuration is used.
b. A blank Reflection Host session is launched.
c. The user is required to configure a new Host session each time they use the Citrix Server.
2. End-users launch Reflection and access a common default configuration file
a. No configuration changes can be saved.
b. A common default set of values is used for each new launch of a Host session.
3. End-users launch Reflection and have unique configuration files
a. Configuration changes will be saved for each user.
b. Individual customization will be captured at the end of each use on a per-user basis.
Individual user files in a Citrix environment are typically stored on a network server drive, either through the Windows redirected My Documents settings or Windows Roaming Profiles (there are other methods beyond the scope of this article). This file storage location of the Host session files is referenced in the Reflection software by an internal variable named %personalfolder%. This internal Reflection value is set “on-the-fly” by the Reflection Desktop software as it runs, which will detect how the users My Documents location is currently set under Windows.
Before installing Reflection Desktop 16 on a Citrix Server, document the requirements by determining which Reflection Desktop 16 components and features are to be installed, the location of installation files, and the location of any configured user data, such as Host session documents. Some Reflection application components may not be needed and it is recommended to install Reflection on a stand-alone PC to help identify and document the installation steps in advance.
If Reflection has any service packs or updates, ensure that the service pack installer file, *.MSP, is available for installation during the publishing process.
1. Create an Administrative Install of the latest version of Reflection Desktop 16 and add any Service Packs or Hotfixes that are needed. This Administrative Install Point can either be on the local drive or a network drive, but this install must be accessible from the Citrix Server.
2. Create Reflection Host sessions and related files with any special customization that is needed. This action can be done on another stand-alone PC where Reflection Desktop is installed. Configuration files on an individual Reflection workstation installation typically include:
a. The Host session files (files with extension of *.RD3X, RD5X, or *.RDOX)
Found under the C.Users<username>Micro FocusReflection folder
b. Supporting files (files like application.settings and *.access files)
Found under the C:Users<username>AppdataRoamingMicro FocusReflectionWorkspace folder
c. Subfolders (folders such as .ssh and .pki)
Found under the C.Users<username>Micro FocusReflection folder
Use the Reflection Installation Customization Tool (ICT) to create Companion install packages, to define permissions files, and to create transform files. Refer to the Installation and Deployment Guide for Reflection Desktop 16 as a resource, which is available from https://www.attachmate.com/documentation/reflection-desktop-v16-1-sp1/deployment-guide/data/bookinfo.htm
In the section below, the steps for using the Installation Customization Tool assume that you have set up a Reflection Administrative Installation. If not using a Reflection Administrative Install Point to automate parts of the installation and add user session documents, then proceed to section G. (Installing Reflection Executables).
Use the Installation Customization Tool to create a companion .msi file. Depending on the user configuration type chosen, a different Companion Install file will have to be created for each type.
End-users launch Reflection with no configuration file
or
End-users launch Reflection and access a common default configuration file
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Create a new Companion installer.”
4. Click OK.
5. In the left navigation pane, click “Specify install locations”.
6. Under Installation type, select the “Installs to all users of a machine” option.
7. In the Default installation folder drop-down list, select [CommonDocumentsFolder].
Complete the line by typing [CommonDocumentsFolder]Micro FocusReflection.
8. In the left navigation pane, click “Add files”
9. In “Add files to” select [CommonDocumentsFolder].
Complete the line by typing [CommonDocumentsFolder]Micro FocusReflection for the location of the User data files.
10. Click the “Add…” button to add files to include.
Such as pre-configured Reflection session documents (.RD3X, .RD5X, .RDOX settings files).
This step can be skipped if end-users launch Reflection with no configuration file.
11. Click File / Save As.
Save the companion.msi file in the same location as Setup.exe.
End-users launch Reflection and have unique configuration files
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Create a new Companion installer.”
4. Click OK.
5. In the left navigation pane, click “Specify install locations”.
6. Under Installation type, select the “Installs only for the user who installs it” option.
7. In the Default installation folder drop-down list, select [PersonalFolder].
Complete the line by typing [PersonalFolder]Micro FocusReflection.
8. In the navigation left pane, click “Add files”
9. In “Add files to” select [PersonalFolder].
Complete the line by typing [PersonalFolder]Micro FocusReflection for the location of the User data files.
10. Click the “Add…” button to add files to include.
Such as pre-configured Reflection session documents (.RD3X, .RD5X, .RDOX settings files).
11. Click File / Save As.
Save the companion.msi file in the same location as Setup.exe.
Many Reflection Workspace settings (as opposed to the Host session file settings), are stored in a file called “application.settings” which is located in the C:Users<username>AppDataRoamingMicro FocusReflectionDesktopv16.1 folder. This folder might be on a network drive if using Windows redirected My Documents or Windows Roaming profiles. Depending on the user configuration type chosen, the creation and distribution of a custom version of this file will have to be created for each type.
End-users launch Reflection with no configuration file
or
End-users launch Reflection and access a common default configuration file
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Open an existing Setup customization file or Companion installer”.
4. Click OK
5. Select the existing Companion install file
6. Press Open
7. From the left navigation pane, choose the “Modify user settings”.
8. In the right-hand dialog choose “Reflection Desktop – Workspace Settings”.
9. Press the “Define…” button.
This will open the Reflection Workspace settings dialog.
10. Choose “Configure Workspace Attributes”.
11. At the bottom of the Workspace dialog will be a setting for the “Default user data directory”
Change this to: C:UsersPublicDocumentsMicro FocusReflection
12. Click OK
13. A prompt will appear asking to add the new location to the Trusted Locations.
If using Trusted Locations answer Yes.
14. Click OK
Notice that “Reflection Desktop – Workspace Settings” is now defined to [CommonAppDataFolder]Micro FocusReflection
15. Click File / Save As.
Save the companion.msi file in the same location as Setup.exe.
End-users launch Reflection and have unique configuration files
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Open an existing Setup customization file or Companion installer”.
4. Click OK
5. Select the existing Companion install file
6. Press Open
7. From the left navigation pane, choose the “Modify user settings”.
8. In the right-hand dialog choose “Reflection Desktop – Workspace Settings”.
9. Press the “Define…” button.
This will open the Reflection Workspace settings dialog.
10. Choose “Configure Workspace Attributes”.
11. At the bottom of the Workspace dialog will be a setting for the “Default user data directory”
Change this to: C:Users%username%DocumentsAttachmateReflection
12. Click OK
13. A prompt will appear asking to add the new location to the Trusted Locations.
If using Trusted Locations answer Yes.
14. Click OK
Notice that “Reflection Desktop – Workspace Settings” is now defined to [CommonAppDataFolder]Micro FocusReflection
15. Click File / Save As.
Save the companion.msi file in the same location as Setup.exe.
When the Companion Install file (MSI) is run, the customized application.settings file created above will be placed in the C:ProgramDataMicro FocusReflectionDesktopv16.1 folder (also known as the [CommonAppDataFolder]Micro FocusReflectionDesktopv16.1 folder). As the users launch their existing Host sessions or the Reflection Workspace for the first time, the Reflection software will note that the date on the updated and customized application.settings file in the [CommonAppDataFolder]Micro FocusReflectionDesktopv16.1 folder location will be newer than the existing file of the same name in the C:Users<username>AppDataRoamingMicro FocusReflectionDesktopv16.1 folder and thus overwrite the existing users application.settings file with the new one, thus updating the user data location automatically.
Use the Installation Customization Tool to define permissions files. Depending on the user configuration type chosen, a different Companion Install file will have to be created for each type.
End-users launch Reflection with no configuration file
or
End-users launch Reflection and access a common default configuration file
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Open an existing Setup customization file or Companion installer.”
4. Click OK
5. Select the existing Companion install file
6. Press Open
7. In the left navigation pane, click “Specify install locations”.
8. Under Installation type, select the “Installs to all users of a machine” option.
9. From the left navigation pane, choose the “Modify user settings”.
10. In the right-hand dialog choose “Reflection Desktop – rd3x.access”.
Or choose one of the other .access options
11. Press the “Define…” button.
12. The Permissions Manager will open
13. The use of the Permissions Manager is beyond the scope of this article.
See the section in the Reflection Desktop Deployment Guide called
“Control Access to Settings and Controls with Reflection Administrative Tools” at
https://www.attachmate.com/documentation/reflection-desktop-v16-1-sp1/deployment-guide/data/bookinfo.htm
14. Save the changes to the *.access file in the Permissions Manager
15. Exit the Permissions Manager.
16. Click File / Save As.
Save the companion.msi file in the same location as Setup.exe.
End-users launch Reflection and have unique configuration files
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Open an existing Setup customization file or Companion installer.”
4. Click OK
5. Select the existing Companion install file
6. Press Open
7. In the left navigation pane, click “Specify install locations”.
8. Under Installation type, select the “Installs only for the user who installs it” option.
9. From the left navigation pane, choose the “Modify user settings”.
10. In the right-hand dialog choose “Reflection Desktop – rd3x.access”.
Or choose one of the other .access options
11. Press the “Define…” button.
12. The Permissions Manager will open
13. The use of the Permissions Manager is beyond the scope of this article.
See the section in the Reflection Desktop Deployment Guide called
“Control Access to Settings and Controls with Reflection Administrative Tools” at
https://www.attachmate.com/documentation/reflection-desktop-v16-1-sp1/deployment-guide/data/bookinfo.htm
14. Save the changes to the *.access file in the Permissions Manager
15. Exit the Permissions Manager.
16. Click File / Save As.
Save the companion.msi file in the same location as Setup.exe.
Use the Installation Customization Tool to prepare Reflection Desktop as a virtual application by creating a custom transform file (*.MST).
1. Navigate to the Reflection Administrative Installation.
2. Run Setup.exe /Admin to launch the Installation Customization Tool.
3. Select “Create a new Setup customization file for the following product”.
Micro Focus Reflection Desktop will be highlighted.
4. In the Welcome pane choose Setup.
5. Click “Install location and organization name”.
6. In the Default installation folder field, the default value of “[ProgramFilesFolder]Micro FocusReflection” should be used.
7. Click “Licensing and session metering”.
8. Complete the licensing agreement and accept the Session Metering setting defaults.
9. Click “User interface”.
10. Select the “Use this customization with interactive installs using setup.exe” option.
11. Verify that the user interface level is set at “Full – default”.
12. To add a chained companion.msi to the installation:
a. Click “Add installations and run programs”.
b. Add a companion.msi file (using the UNC path) to the installation command.
For example: msiexec.exe /i \UNCServerNameRD16AdminInstallcompanion.msi
Or install the companion.msi file by clicking it manually after Reflection Desktop is installed.
13. Click “Set feature installation states”.
14. Select the Reflection Desktop features to install.
Since the user interface level is set at Full, the selection of features is also available during installation on the Citrix Server.
15. Click File / Save As.
Save the custom.mst file in the same location as Setup.exe.
Before installing a new copy of the Reflection Desktop 16 software on the Citrix Server, it is best to make sure that all older or previous copies of the Reflection 2011 or Reflection 2014 (or even Reflection 14.x) software (which might have been used for testing) have been removed via “Programs and Features” in the Windows Control Panel.
If previous copies of Reflection have also been run, it might also be necessary to do some “clean-up” in the Windows Registry on the Citrix Server. When Reflection is installed, key values are written in the Windows Registry to determine how the software is installed. Values are written in the HKLMsoftwareWow6432NodeWRQReflection portion of the registry, specifically a value called UserDir that points to the location of the user configuration files. When Reflection is run by a user for the first time, the UserDir and other values get copied from the HKLM to the HKCUSoftwareWRQReflection section. The following installation instructions assume that neither the HKLMsoftwareWow6432NodeWRQReflection nor the HKCUSoftwareWRQReflection sections exist in the Windows registry.
1. At the Microsoft Windows Server console, log in as an Administrator or a user with full Administrative Rights.
2. Open a Windows “Command Prompt” then right-click and choose “Run as Administrator”
3. At the Command Prompt enter “change user /install” and press the ENTER key
(this will put the Citrix Server into install mode for applications)
4. Install Reflection Desktop using a MSIEXEC command line from the Admin install location:
If installing Reflection from a network location, use a UNC path to access the installation files, not a mapped drive letter:
UNC path syntax: \<servername><path>
Installing from a mapped drive may generate a Microsoft Windows installation error similar to the following: “Error 2755.
The installer has encountered an unexpected error installing this package. This may indicate a problem with this package.”
End-users launch Reflection with no configuration file
Sample command line:
Msiexec /I <msiname>.msi
After the Reflection software has completed its install, and before proceeding,
verify that the HKLMsoftwareWow6432NodeWRQReflection registry key for UserDir points
to “C:Users<username>DocumentsMicro FocusReflection”.
End-users launch Reflection and access a common default configuration file
Sample command line:
Msiexec /I <msiname>.msi WRQ_USERDIR=”C:UsersAllUsersMicro FocusReflection”
After the Reflection software has completed its install, and before proceeding,
verify that the HKLMsoftwareWow6432NodeWRQReflection registry key for UserDir points
to “C:UsersAllUsersMicro FocusReflection”.
End-users launch Reflection and have unique configuration files
Sample command line:
Msiexec /I <msiname>.msi WRQ_USERDIR=”%personalfolder%Micro FocusReflection”
After the Reflection software has completed its install, and before proceeding,
verify that the HKLMsoftwareWow6432NodeWRQReflection registry key for UserDir points
to ”%personalfolder%Micro FocusReflection”.
5. At the Command Prompt enter “change user /execute” and press the ENTER key
(this will put the Citrix Server into execute mode for applications)
End-users launch Reflection Desktop with no configuration file
No deployment of Reflection Host session files (*.RD3X, *.RD5X, or *.RDOX) and any other customization files to each users %personalfolder%
locations is necessary as the end-user will create these file each time they run a new Reflection Host session.
End-users launch Reflection and access a common default configuration file
Deploy or distribute the default Reflection Host session files (*.RD3X or *.RDOX) and any other customization files to the Citrix Server’s
C:UsersAllUsers location. The Host session files will go in the C:UsersAllUsersMicro FocusReflection folder with other files being put
in the location under this folder as normally found in an individual workstation installation. Set the attributes on these files to be Read-Only
to prevent the end-users from overwriting them. Use the companion install file created in section C. “Create a Companion *.MSI File Using
the Installation Customization Tool”.
It is recommended that the Installation Customization Tool be used to lock down features in the Reflection Host session and disable the ability
of individual end-users to save Host sessions they have modified. Refer to the Installation and Deployment Guide for Reflection Desktop 16 as
a resource, which is available from https://www.attachmate.com/documentation/reflection-desktop-v16-1-sp1/deployment-guide/data/bookinfo.htm
End-users launch Reflection and have unique configuration files
Deploy or distribute the Reflection Host session files (*.RD3X or *.RDOX) and any other customization files to each users %personalfolder% locations.
The Host session files will go in the users ..<MyDocuments>Micro FocusReflection folder with other files being put in the location under this folder as
normally found in an individual workstation installation. Use the companion install file created in section C. “Create a Companion *.MSI File Using the
Installation Customization Tool”.
The distribution of the Reflection Host and other configuration files is typically beyond the scope of this article and there are various mechanisms that can be used, including the previously mentioned Reflection Companion Installer file, Windows login scripts, Group Policy deployments, or other third-party software and file distribution tools.
Follow the steps below to publish the Reflection Desktop executable files to the Citrix XenApp Server 6.5 environment. Although these instructions refer to Citrix XenApp Server version 6.5, the same concepts and settings apply to all version of Citrix XenApp 6.x, but the steps may be slightly different. Please refer to your Citrix XenApp documentation for further details.
1. Click Windows Start > Administrative Tools > Citrix > Management Consoles > Citrix AppCenter
2. Log in to the Citrix AppCenter if necessary
3. Under Citrix Resources / XenApp open the Citrix Farm and navigate to Applications
4. Right-click on Applications
5. Select Publish Application to start the wizard.
6. In the Application Publishing Wizard dialog box, click Next
7. Enter a Display Name and Application Description
8. Click Next.
9. On the Type screen choose “Application”
Set Application type as “Accessed from a server”
Set Server application type as “Installed Application”
10. Click Next.
11. On the Location dialog, set the command line by browsing to the Reflection Desktop program files directory (C:Program Files (x86)Micro FocusReflection, by default),
and selecting the Attachmate.Emulation.Frame.EXE file. This is the point at which it is important to decide which command line option is needed for launching a Reflection host session:
For end-users to launch Reflection with no configuration file:
“C:Program Files (x86)Micro FocusReflectionAttachmate.Emulation.Frame.EXE”
For end-users to launch Reflection and access a common default configuration file
“C:Program Files (x86)Micro FocusReflectionAttachmate.Emulation.Frame.EXE” /f “C:UsersAll UsersMicro FocusReflection<sessionname>.RDOX”
For end-users to launch Reflection and have unique configuration files
“C:Program Files (x86)Micro FocusReflectionAttachmate.Emulation.Frame.EXE” /f “%personalfolder%Micro FocusReflection<sessionname>.RDOX”
For additional details about starting Reflection Desktop from a command line, see:
http://docs.attachmate.com/reflection/2014/r1/tshelp/en/user-html/index.htm?toc.htm?session_start_command_line_pr_cs.htm
12. Click Next to assign a Citrix Server where the Application will be published.
13. Click Next to either make the Application published as Anonymous or for Explicit Users.
14. Click Next to setup additional and advanced parameters for the Published Application based on your preferences.
15. When finished the Reflection Desktop software is ready to be published to and run from the Citrix client workstations.
Follow the steps below to publish the Reflection Desktop executable files to the Citrix XenApp Server 7.9 environment. Although these instructions refer to Citrix XenApp Server version 7.9, the same concepts and settings apply to all version of Citrix XenApp 7.x, but the steps may be slightly different. Please refer to your Citrix XenApp documentation for further details.
1. Click Windows Start > Citrix Studio
2. Go through the following configuration options: (if not already completed – Reference Citrix documentation for details)
a. Deliver applications and desktops to your users
b. Set up machines for desktops and applications or remote PC access – “Machine Catalog”
c. Set up Delivery Groups to assign desktops and applications to your users – “Delivery Groups”
3. During the creation of a Machine Catalog, select the machine where Reflection Desktop 16 is installed.
Typically this is the Citrix Server, but in XenApp 7.x it could be any PC, a desktop or a server, that could be hosting an application
4. During the creation of a Delivery Group, select from the Machine Catalog the machine where Reflection Desktop 16 is installed.
5. In the Create Delivery Group, at the Application step:
a. Press the “Add…” button
b. Select “Manually…”
c. Set the “Path to the executable file”
Set the command line by browsing to the Reflection Desktop program files directory
(C:Program Files (x86)Micro FocusReflection, by default if on the local Citrix Server),
and selecting the Attachmate.Emulation.Frame.EXE file.
The path will change to:
“%Program Files(x86)%Micro FocusReflectionAttachmate.Emulation.Frame.EXE”
d. Set the “Command line argument”
This is the point at which it is important to decide which command line
option is needed for launching a Reflection host session
For end-users to launch Reflection with no configuration file:
Leave the Command line argument blank or empty
For end-users to launch Reflection and access a common default configuration file
“/f “C:UsersAll UsersMicro FocusReflection<sessionname>.RDOX”
For end-users to launch Reflection and have unique configuration files
“/f “%personalfolder%Micro FocusReflection<sessionname>.RDOX”
For additional details about starting Reflection Desktop from a command line, see:
http://docs.attachmate.com/reflection/2014/r1/tshelp/en/user-html/index.htm?toc.htm?session_start_command_line_pr_cs.htm
e. Set the “Working directory” as
“%Program Files(x86)%Micro FocusReflection”
f. Set the Application name (for user)
“Reflection Desktop 16”
g. Set the Application name (for administrator)
“Reflection Desktop 16”
6. Click OK.
7. Click Next
8. On the Desktops dialog, if desired, add specific users or groups who can launch a desktop from this Delivery Group.
9. Click Next
10. Assign a Delivery Group name like “Reflection Desktop 16 Host Sessions”
11. Click Finish.
12. The Reflection Desktop software is ready to be run from the Citrix client workstations.
