|
<< Click to Display Table of Contents >> Navigation: Installation & updating the software > Installation on Citrix server |
This guide provides detailed instructions for installing the Key Studio™ application on a Citrix server. Follow the steps below to ensure a smooth installation and configuration process.
- Citrix Server environment (Citrix XenApp/XenDesktop)
- Administrative access to the Citrix server
- Internet access for downloading installation files
Download Key Studio™ Installer
- Log on to the Citrix server.
- Navigate to the Key Studio™ download page: [Key Studio™ Download](https://keystudio.assaabloyopeningsolutions.com).
- Download the latest version of the Key Studio™ installer.
Run the Installer
- Locate the downloaded installer file and run it.
- Follow the on-screen instructions to complete the installation.
Detecting Citrix Environment
- The installer will use Windows API to detect if it is being installed in a Citrix environment. It checks the `WTSClientProtocolType` using the `WTSQuerySessionInformation` function. If the value is `2`, it indicates an ICA session (Citrix).
- Additionally, the installer checks for the `FORCE_CITRIX` environment variable. If this variable exists, the installer assumes it is in a Citrix session.
Citrix Specific Configuration
- During installation, if Citrix is detected, the following actions will be performed:
- **No Shortcut Creation:** The installer will not create shortcuts to the application.
- **Configuration Settings:** An entry `CitrixEnabled` will be written in the application configuration settings.
- When the application starts, it will check for the `CitrixEnabled` flag. If set, it will store application data in the user's personal documents folder:
- `SpecialFolder.MyDocuments`\EMEA_MKS\prd
User Data Management
- Ensure that the Citrix environment is configured to restore user-specific locations when starting the environment. This includes locations like:
- `SpecialFolder.LocalApplicationData` (e.g., `C:\Users\<username>\AppData\Local\`)
- `SpecialFolder.CommonDocuments` (e.g., `C:\Users\Public\Documents`)
- `SpecialFolder.StartMenu` (e.g., `C:\Users\<username>\AppData\Roaming`)
- `SpecialFolder.MyDocuments` (e.g., `C:\Users\<username>\Documents`)
Finalizing Installation
- Complete the installation process by following any additional on-screen instructions.
- Verify that Key Studio™ is correctly installed and configured by launching the application and ensuring it starts without errors.
- **Testing:** Run the application in the Citrix environment to ensure all functionalities are working correctly.
- **User Access:** Configure user access and permissions as required using the Citrix management tools.
- **Support:** For any issues during installation, refer to the support documentation or contact Key Studio™ support.
By following these steps, you should be able to successfully install and configure Key Studio™ on a Citrix server. For further assistance, consult the provided resources or contact support.