This article outlines the steps to install the extension an extension that enhances the Director functionality to help XenDesktop Admins to generate reports on their XenDesktop environment with custom fields and filters using Director. 

Using this plugin extension we can generate any report on XenDesktop through Director and export it. 

Citrix is making this custom reporting tool available for experimental evaluation and it is ideal for trial in a non-production environment. The experimental versions of this tool including this one will not be supported by Citrix.

Note: Custom Report is now built into Director 7.12 and available to Platinum Edition customers.

Requirement

• Installation should be done on Director server
• Supported for XenDesktop 7.6 or above with Citrix Director 7.6 and Citrix Director 7.7.

Installation

• Installer for Citrix Director 7.6.0 : CustomReportInstaller-XD 7.6
• Installer for Citrix Director 7.6.300 :CustomReportInstaller-XD 7.6.300
• Installer for Citrix Director 7.7.0 : CustomReportInstaller-Xd 7.7

Unzip the files to any folder. Unblock the contents if required.

Open the unzipped folder and click on CustomReportinstaller.exe. The installer prompts the information message, check on I Agree and click install.

Once installation is completed, login to director and you can see new tab on trends page with the name Custom report.

Usage

An example of plugin usage. Lets generate a report for “get all the users  and the client name who have used outlook ”.
Once you login to Director and Navigate to trends page, click on custom report and you will see the following

These are the field that we need to look into,

Type

Select the type of report you want to generate. if you want application based report select Application. If you want to generate report based on Desktop session usage, select Desktop.

For our example, we will select the Type as Application.

Report Name

This field is used to name the report. The Exported report will be saved with the same file name.

For our example, we will change the report name to “OutLook Application”.

Conditions

These are the conditions or filters you want to apply on the report. This is a drop down with all available fields that can be used as filter.

For our example the condition should be like “PublishedName contains outlook”.

Output Columns

OData Query

This field is specially designed to help director admins generate the odata query. The field dynamically gets updated as an when there is modification on Conditions and Output Columns. This query can be copied and  used on other tools to generate the same report.

The final report UI looks like this:

Now Clicking on Export will export the required report In CSV format.

Refer to the image below of an Exported report.