Citrix Receiver Diagnostics Tool - For Windows
Article ID: CTX141751
Updated On:
Description
Citrix Receiver Diagnostics Tool for Windows
Created Date: December 16, 2014
Updated Date: September 13, 2023
Please note:
You can download the required file from the Citrix downloads website by visiting the following link: https://www.citrix.com/downloads/citrix-tools
Description
The Receiver Diagnostics Tool for Windows enables Administrators to collect and upload key data from various components of Citrix Receiver installed on Windows end points.
The information can then be shared with Citrix Technical Support using secure uploads to diagnose and troubleshoot cases.
This tool encompasses the same functionality found in the existing CDF Control Utility to capture CDF Logs as well as additional data collection such as System and Registry Information, Always-On, Installation, System and Application Event Viewer, and DirectX Diagnostics Logs.
The following End point information can be collected:
|
Hardware |
Software |
|
Attached Monitors information Memory Information Network Adapters Processor Direct X Diagnostics information |
Receiver version OS information (version, service pack, architecture) IE version Default browser ActiveX Flash version NPAPI Flash version |
|
Registry | |
|
HKLM\Software\Citrix\AuthManager HKLM\Software\Citrix\CitrixCAB HKLM\Software\Citrix\Dazzle HKLM\Software\Citrix\ICA Client HKLM\Software\Citrix\Install HKLM\Software\Citrix\InstallDetect HKLM\Software\Citrix\PluginPackages HKLM\Software\Citrix\Receiver HKLM\Software\Citrix\ReceiverInside HKLM\Software\Citrix\XenDesktop HKLM\Software\Policies\Citrix HKLM\Software\Microsoft\Windows\CurrentVersion\Internet Settings\Zones HKLM\Software\Microsoft\Windows\CurrentVersion\Internet Settings\ZoneMap\Domains HKLM\System\CurrentControlSet\Control\NetworkProvider\Order HKCU\Software\Citrix\AuthManager HKCU\Software\Citrix\CitrixCAB HKCU\Software\Citrix\Dazzle HKCU\Software\Citrix\ICA Client HKCU\Software\Citrix\Install HKCU\Software\Citrix\InstallDetect HKCU\Software\Citrix\PluginPackages HKCU\Software\Citrix\Receiver HKCU\Software\Citrix\ReceiverInside HKCU\Software\Citrix\XenDesktop HKCU\Software\Policies\Citrix HKCU\Software\Microsoft\Windows\CurrentVersion\Explorer\VisualEffects HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings\Zones HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings\ZoneMap\Domains | |
|
Event Logs | |
|
Application Event Log System Event Log | |
|
Tracing | |
|
|
HDX Receiver shell, Auth Manager and Self-Service Plug-in Install Logs Always-On Logs |
Note: CDF tracing is only supported with administrative rights. The user requesting CDF tracing must provide administrative credentials when prompted.
New in Version 1.4.0.5
- Changed the default CDF trace file settings to Verbose Trace level and Log Size of 1000 MB to allow for generally larger trace volume produced by modern CWA versions.
- Removed the CIS upload feature temporarily while support for MFA is added for secure CIS data upload.
Prerequisites
- Microsoft .NET Framework, Version 3.5 or higher - (excluding Client Profile)
- Must provide administrator credentials or accept UAC prompt when requesting CDF tracing.
Supported Citrix Receiver Product Versions
Receiver for Windows versions 3.4, 4.x and later, CWA for Windows - All Versions
For more information on Supported versions of Citrix Receiver see Additional Lifecycle Information for Citrix Workspace App for Windows
Installing Receiver Diagnostics Tool
To install Receiver Diagnostics Tool, unzip the ReceiverDiag.zip package to an empty folder on the target end point.
Basic Steps to Collect Diagnostic Information
- Launch Receiver Diagnostics Tool.
- Start Receiver Tracing prior to duplicating the issue.
- Duplicate the issue.
- Stop Receiver Tracing.
- Click on "Collect" button to begin the process of packaging of the captured data. You can save the captured data locally by clicking the "SAVE" button.
Detailed Steps to Collect Diagnostic Information
How to Start Receiver Diagnostics Tool
Navigate to the folder where you extracted the download and launch ReceiverDiag.exe
Note: First time launch may generate a Windows SmartScreen prompt for additional permissions, click the Run anyway button to continue.
How to Set Receiver Diagnostics Tool Configuration Options
- From the side menu bar, click Settings
- Make any required changes and click Apply.
- To discard changes or reset settings to default values use Discard or Reset.
How to Capture a CDF Trace file
- From the side menu bar, click Diagnostics to open diagnostics page.
- Press Start Tracing and if prompted, enter administrator credentials or accept UAC prompt for “CdfCollector.exe”.
- Reproduce the issue to capture required trace information.
- When finished, press Stop Tracing to terminate tracing; if prompted, enter administrator credentials or accept UAC prompt for “CdfCollector.exe”.
How to Collect Environment Information
- Access diagnostics page by clicking Diagnostics on the side bar.
- Click Collect to generate the report package containing the environment information (system, registry etc.).
Note: Any CDF Trace files that have been created will also be included in the zip file.
NOTE: The generated files in the report directory will be deleted upon exiting Receiver Diagnostics Tool. This is a security measure to ensure the security of the system information gathered for Citrix support. Please save a copy of the report package file, using the “Save” button to provide the directory (different from report folder) where the report package will be copied. Please share the report package with Citrix Support
If you do not have Internet access on your endpoint, you can upload the saved report file manually by copying it to a location with Internet access and then logging onto https://cis.citrix.com
How to Check for Updates to Receiver Diagnostics Tool
- From the menu bar, select Settings
- Make sure that “Check for new software updates automatically” is enabled.
Once “check for updates” is enabled the Receiver Diagnostics Tool will perform a check for update every time upon startup. If a newer version is available, the link to the corresponding KB article page will be displayed in the upper right corner of the main window.
Uninstalling Receiver Diagnostics Tool
Contact Information
Additional Information
Please note:
You can download the required file from the Citrix downloads website by visiting the following link: https://www.citrix.com/downloads/citrix-tools
