Environment
Reflection Desktop (including Pro, for X, for IBM, or for UNIX and OpenVMS) 16.0 or higher
Microsoft Windows 10
Microsoft Windows 7
Microsoft Windows Server 2012 R2
Microsoft Windows Server 2008 R2
Citrix XenApp 7.9
Citrix XenApp 6.5
Situation
This article explains how to install, configure, and publish Reflection Desktop 16 products to a Microsoft Windows Server running Citrix XenApp 6.x and 7.x
Resolution
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 Installation Customization Tool to Create a Custom Transform File
G. Installing Reflection Executables
H. Deploying Reflection Host and other Configuration Files
I. Publishing Reflection Applications
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.
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 which
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 Focus\Reflection folder
b. Supporting files (files like application.settings and *.access files)
Found under the C:\Users\<username>\Appdata\Roaming\Micro Focus\Reflection\Workspace folder
c. Subfolders (folders such as .ssh and .pki)
Found under the C.\Users\<username>\Micro Focus\Reflection 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).
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 Focus\Reflection.
8. In the left navigation pane, click "Add files"
9. In "Add files to" select [CommonDocumentsFolder].
Complete the line by typing [CommonDocumentsFolder]\Micro Focus\Reflection
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 Focus\Reflection.
8. In the navigation left pane, click "Add files"
9. In "Add files to" select [PersonalFolder].
Complete the line by typing [PersonalFolder]\Micro Focus\Reflection
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.
stored in a file called âapplication.settingsâ which is located in the
C:\Users\<username>\AppData\Roaming\Micro Focus\Reflection\Desktop\v16.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:\Users\Public\Documents\Micro Focus\Reflection
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 Focus\Reflection
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%\Documents\Attachmate\Reflection
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 Focus\Reflection
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:\ProgramData\Micro Focus\Reflection\Desktop\v16.1 folder
(also known as the [CommonAppDataFolder]\Micro Focus\Reflection\Desktop\v16.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 Focus\Reflection\Desktop\v16.1 folder
location will be newer than the existing file of the same name in the
C:\Users\<username>\AppData\Roaming\Micro Focus\Reflection\Desktop\v16.1 folder
and thus overwrite the existing users application.settings file with the new one, thereby
updating the user data location automatically.
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.
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 Focus\Reflectionâ
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 \\UNCServerName\RD16AdminInstall\companion.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.
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
manual â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 HKLM\software\Wow6432Node\WRQReflection 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 HKCU\Software\WRQReflection section. The following
installation instructions assume that neither the HKLM\software\Wow6432Node\WRQReflection
nor the HKCU\Software\WRQReflection 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 HKLM\software\Wow6432Node\WRQReflection registry key for
UserDir points to "C:\Users\<username>\Documents\Micro Focus\Reflectionâ.
End-users launch Reflection and access a common default configuration file
Sample command line:
Msiexec /I <msiname>.msi WRQ_USERDIR=âC:\Users\AllUsers\Micro Focus\Reflectionâ
After the Reflection software has completed its install, and before proceeding,
verify that the HKLM\software\Wow6432Node\WRQReflection registry key for
UserDir points to "C:\Users\AllUsers\Micro Focus\Reflectionâ.
End-users launch Reflection and have unique configuration files
Sample command line:
Msiexec /I <msiname>.msi WRQ_USERDIR=â%personalfolder%\Micro Focus\Reflectionâ
After the Reflection software has completed its install, and before proceeding,
verify that the HKLM\software\Wow6432Node\WRQReflection registry key for
UserDir points to â%personalfolder%\Micro Focus\Reflectionâ.
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)
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 files 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:\Users\AllUsers location. The Host session
files will go in the C:\Users\AllUsers\Micro Focus\Reflection
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 Focus\Reflection 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.
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 versions 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 Focus\Reflection, 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 Focus\Reflection\Attachmate.Emulation.Frame.EXEâ
For end-users to launch Reflection and access a common default configuration file
âC:\Program Files (x86)\Micro Focus\Reflection\Attachmate.Emulation.Frame.EXEâ /f âC:\Users\All Users\Micro Focus\Reflection\<sessionname>.RDOXâ
For end-users to launch Reflection and have unique configuration files
âC:\Program Files (x86)\Micro Focus\Reflection\Attachmate.Emulation.Frame.EXEâ /f â%personalfolder%\Micro Focus\Reflection\<sessionname>.RDOXâ
For additional details about starting Reflection Desktop from a command line, see:
https://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 versions 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,
which 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 Focus\Reflection, 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 Focus\Reflection\Attachmate.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:\Users\All Users\Micro Focus\Reflection\<sessionname>.RDOXâ
For end-users to launch Reflection and have unique configuration files
"/f â%personalfolder%\Micro Focus\Reflection\<sessionname>.RDOXâ
For additional details about starting Reflection Desktop from a command line, see:
https://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 Focus\Reflectionâ
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.
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 Installation Customization Tool to Create a Custom Transform File
G. Installing Reflection Executables
H. Deploying Reflection Host and other Configuration Files
I. Publishing Reflection Applications
A. Creating Reflection Installation Files
Before installing Reflection, first determine how the Reflection Host session and other configurationfiles 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.
B. Creating Companion Packages, Permissions Files, and Transforms
1. Create an Administrative Install of the latest version of Reflection Desktop 16 andadd 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 which
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 Focus\Reflection folder
b. Supporting files (files like application.settings and *.access files)
Found under the C:\Users\<username>\Appdata\Roaming\Micro Focus\Reflection\Workspace folder
c. Subfolders (folders such as .ssh and .pki)
Found under the C.\Users\<username>\Micro Focus\Reflection 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).
C. Create a Companion *.MSI File Using the Installation Customization Tool
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 Focus\Reflection.
8. In the left navigation pane, click "Add files"
9. In "Add files to" select [CommonDocumentsFolder].
Complete the line by typing [CommonDocumentsFolder]\Micro Focus\Reflection
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 Focus\Reflection.
8. In the navigation left pane, click "Add files"
9. In "Add files to" select [PersonalFolder].
Complete the line by typing [PersonalFolder]\Micro Focus\Reflection
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.
D. Define an application.settings File Using the Installation Customization Tool
Many Reflection Workspace settings (as opposed to the Host session file settings), arestored in a file called âapplication.settingsâ which is located in the
C:\Users\<username>\AppData\Roaming\Micro Focus\Reflection\Desktop\v16.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:\Users\Public\Documents\Micro Focus\Reflection
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 Focus\Reflection
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%\Documents\Attachmate\Reflection
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 Focus\Reflection
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:\ProgramData\Micro Focus\Reflection\Desktop\v16.1 folder
(also known as the [CommonAppDataFolder]\Micro Focus\Reflection\Desktop\v16.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 Focus\Reflection\Desktop\v16.1 folder
location will be newer than the existing file of the same name in the
C:\Users\<username>\AppData\Roaming\Micro Focus\Reflection\Desktop\v16.1 folder
and thus overwrite the existing users application.settings file with the new one, thereby
updating the user data location automatically.
E. Define Permissions Files
Use the Installation Customization Tool to define permissions files. Depending on the userconfiguration 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.
F. Use the Installation Customization Tool to Create a Custom Transform File
Use the Installation Customization Tool to prepare Reflection Desktop as a virtual applicationby 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 Focus\Reflectionâ
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 \\UNCServerName\RD16AdminInstall\companion.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.
G. Installing Reflection Executables
Before installing a new copy of the Reflection Desktop 16 software on the Citrix Server, it isbest 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
manual â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 HKLM\software\Wow6432Node\WRQReflection 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 HKCU\Software\WRQReflection section. The following
installation instructions assume that neither the HKLM\software\Wow6432Node\WRQReflection
nor the HKCU\Software\WRQReflection 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 HKLM\software\Wow6432Node\WRQReflection registry key for
UserDir points to "C:\Users\<username>\Documents\Micro Focus\Reflectionâ.
End-users launch Reflection and access a common default configuration file
Sample command line:
Msiexec /I <msiname>.msi WRQ_USERDIR=âC:\Users\AllUsers\Micro Focus\Reflectionâ
After the Reflection software has completed its install, and before proceeding,
verify that the HKLM\software\Wow6432Node\WRQReflection registry key for
UserDir points to "C:\Users\AllUsers\Micro Focus\Reflectionâ.
End-users launch Reflection and have unique configuration files
Sample command line:
Msiexec /I <msiname>.msi WRQ_USERDIR=â%personalfolder%\Micro Focus\Reflectionâ
After the Reflection software has completed its install, and before proceeding,
verify that the HKLM\software\Wow6432Node\WRQReflection registry key for
UserDir points to â%personalfolder%\Micro Focus\Reflectionâ.
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)
H. Deploying Reflection Host and other Configuration Files
End-users launch Reflection Desktop with no configuration fileNo 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 files 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:\Users\AllUsers location. The Host session
files will go in the C:\Users\AllUsers\Micro Focus\Reflection
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 Focus\Reflection 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.
I. Publishing Reflection Applications
Follow the steps below to publish the Reflection Desktop executable files tothe 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 versions 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 Focus\Reflection, 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 Focus\Reflection\Attachmate.Emulation.Frame.EXEâ
For end-users to launch Reflection and access a common default configuration file
âC:\Program Files (x86)\Micro Focus\Reflection\Attachmate.Emulation.Frame.EXEâ /f âC:\Users\All Users\Micro Focus\Reflection\<sessionname>.RDOXâ
For end-users to launch Reflection and have unique configuration files
âC:\Program Files (x86)\Micro Focus\Reflection\Attachmate.Emulation.Frame.EXEâ /f â%personalfolder%\Micro Focus\Reflection\<sessionname>.RDOXâ
For additional details about starting Reflection Desktop from a command line, see:
https://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 versions 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,
which 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 Focus\Reflection, 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 Focus\Reflection\Attachmate.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:\Users\All Users\Micro Focus\Reflection\<sessionname>.RDOXâ
For end-users to launch Reflection and have unique configuration files
"/f â%personalfolder%\Micro Focus\Reflection\<sessionname>.RDOXâ
For additional details about starting Reflection Desktop from a command line, see:
https://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 Focus\Reflectionâ
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.
Additional Information
Reflection Desktop 16 is supported only on Citrix versions currently supported by Citrix and in the environments listed below:
- Citrix Virtual Apps
- Citrix Virtual Desktops
- Citrix XenApp
- Citrix XenDesktop
This article assumes that Citrix is installed, configured, and other applications are working correctly in the network environment. For information about implementing a Citrix server and installing and publishing applications in a Citrix XenApp Server environment, please refer to the Citrix documentation at https://www.citrix.com. Having a Citrix âtest serverâ which can be used for experimentation during a deployment of the following instructions is the best route to go.
Updates for the Microsoft .NET framework on the Citrix Server and client PCs:
For Microsoft Windows Server the .NET interface comes already installed with the Windows Operating System and will be present on both the Server and Server PC. See the TID article titled "Installation of the Microsoft .NET Framework in Virtual Application Environments for Reflection Desktop" at https://support.microfocus.com/kb/doc.php?id=7022807 for details on recommendations for the Microsoft .NET installations and updates for virtual environments.
Troubleshooting Reflection Desktop Published Application Issues
If the Reflection Desktop Published Application does not start properly:- Verify that the <sessionname>.rdox loads when you start Reflection from the client (Citrix Receiver).
- Verify that the default location to save the session file within the Reflection session (by selecting the File Menu and then clicking on Save) is the %personalfolder%\Micro Focus\Reflection folder or the appropriate location specified during the installation and configuration.