How to Generate Citrix Reports

Within Goliath Performance Monitor,  there are a number of reports that can be run to assess your environment. These reports have the ability to be scheduled on and run on an automated basis, and or run on demand. Please reference the article Out-of-the-Box Citrix Reports for a full list of report options. Below, are instructions on how to run the reports specified in the article.

Configure Scheduled Reports

1. Connect to your Goliath console
2. Navigate to the Report>Schedule page of the technology
3. On the schedule tab, use the "Report Type" drop-down  to choose "Citrix XenApp Reports" or "Citrix XenDesktop Reports" as applicable to your environment
   
   1. Please note, the technology refers to "Citrix XenApp" as published applications and desktops session via a serverOS and "Citrix XenDesktop" as virtual desktop sessions via a workstationOS
   2. 
4. Once the report type is selected, click on the "Choose XenApp/XenDesktop Report & Options" button to next select the specific report that you'd like to schedule.
   1. 
5. Upon pressing the button, a new pane will appear. First, use the "Report" drop down field to select the specific report that you'd like to schedule. 
   1. 
   2. 
6. Once you have a report selected, next you can customize the report settings. Once all customizations are made click the "OK" button to continue. Please note - these options are not applicable for the Environment Summary Report
   1. By default, the report is configured to report on ALL XenApp/XenDesktop machines in Goliath. To override this setting, click the button labeled "Select" for "Select Services/Devices". This will then bring up a selection try window to choose the specific machines to add to the report.
      1. 
   2. You can also choose which field the report is sorted on and how it is sorted (asc/desc).
      1. 
   3. By default, if the report is reporting based on user sessions it will show all user sessions. You can use the radio buttons for "include" and "exclude" to define specific users to be reported on or to not include. To do so, define a comma delimited list of user account names (which can include a leading or trailing wildcard symbol for partial name matches).
      1. 
   4. Lastly, choose the optional report columns to be displayed. By default, there will be "base columns" that will always be included in the report. In addition to these column, some of the reports will have additional data points that can be added or removed.
      1. 
7. Once all of the options have been set click "ok" to save the configuration. You will then be taken back to the Schedule Reports screen
8. At the top of the page, you can optionally modify the report name field
   1. 
9. At the bottom of the page, schedule the report frequency:
   1. Run Report Every - click in the white space to configure how frequently the report will run and generate. Once finished, click on the arrow icon to save the field
   2. Start At Date/Time - click in the first white space to choose the date of the initial report. Click in the second white space to choose the time when the report will run. Once finished, click on the arrow icon to save the field.
   3. For Previous Period - click on the white space to configure how much historical data the report will include. (In most cases this will be the same as the "run report every" field. Once finished, click on the arrow icon to save the field.
   4. 
   5. 
10. Optionally, click the "email report" check box to enable the report to be sent via email.
11. If the report will be emailed, then use the radio buttons to the left to choose who the report will be sent
    1. Link Only - An email with a hyperlink to view the report
    2. Attach Report As - An email with the report attached as a PDF, CSV and or HTML file(s)
12. If the report will be emailed, lastly click the "specify email details" button to define the email address(es) where the report will be sent and the subject of the email
    
    1. 
13. By default, all generated reports are saved as an HTML file in the "reports" folder of the Goliath install directory. If you would like to also save the report as a PDF and or a CSV check the appropriate boxes in the "Export Report" field. 
14. By default, all generated reports are named "RPT*" with a random number value. To override this setting, optionally define a report name. To make the report name unique use the macros &D or &T to add the date and or time to the report name.
15. By default, all generated reports are saved as an HTML file in the "reports" folder of the Goliath install directory. To override this setting on a per report basis, enter a new path in the "optional report folder" field.
16. By default, all generated reports will have the URL of "https://{goliathserveraddress}/reports/{reportname}".T o override this setting on a per report basis, enter a new URL in the "optional URL to report" field.
17. When finished, click the "Schedule Report" button
    1. If you dont not see "Schedule Report" button, this means that one of the required fields was not completed. Make sure that the 3 fields defined in step 9 are configured an all of the arrows are clicked in. 
18. To modify an existing scheduled report, see the "queued" tab at the top of the screen.

Run Reports On Demand

1. Click the ‘Report’ tab and then select the ‘View’ submenu 
2. At the bottom of the page, click on the 'New" button
3. A pop up will appear, choose Citrix XenApp (pub apps and desktops) or XenDesktop (VDI) as appropriate and click OK
4. A new pane will appear. First, use the "Report" drop down field to select the specific report that you'd like to schedule. 
   1. 
   2. 
5. Once you have a report selected, next you can customize the report settings. Once all customizations are made click the "OK" button to continue. Please note - these options are not applicable for the Environment Summary Report
   1. By default, the report is configured to report on ALL XenApp/XenDesktop machines in Goliath. To override this setting, click the button labeled "Select" for "Select Services/Devices". This will then bring up a selection try window to choose the specific machines to add to the report.
      1. 
   2. You can also choose which field the report is sorted on and how it is sorted (asc/desc).
      1. 
   3. By default, if the report is reporting based on user sessions it will show all user sessions. You can use the radio buttons for "include" and "exclude" to define specific users to be reported on or to not include. To do so, define a comma delimited list of user account names (which can include a leading or trailing wildcard symbol for partial name matches).
      1. 
   4. Lastly, choose the optional report columns to be displayed. By default, there will be "base columns" that will always be included in the report. In addition to these column, some of the reports will have additional data points that can be added or removed.
      1. 
6. Once all of the options have been set click "ok" to save the configuration. You will then be taken back to the Schedule Reports screen
7. ‘Specify Timeframe for Alert Notifications’ page will appear, choose how many days/hours that you’d like to report 
8. Click ‘Ok’ to approve the report parameters and run the report
   1. Please note that the report generation process is tied to this page. If you navigate away from the page or click any other buttons on the page it will break the report process.
9. When the report is completed, select the report and then click the ‘Status’ tab to view the results.