Summary
This document includes information on modifying existing Citrix EdgeSight reports and saving them as custom reports. This document describes how to edit a Report Definition Language (RDL) file to add or change columns in a report. Changes to other aspects of reports, such as graphical elements, are beyond the scope of this document.
Before You Begin
Before modifying a report, you should have an understanding of the Report Definition Language standard. For information on the structure of RDL files, see the Report Definition Language Specification. In addition, you should have experience developing and working with SQL queries.
Overview
The standard reports provided with Citrix EdgeSight Server can be used as the basis for new reports. By modifying an existing report definition (RDL) file instead of creating a new one, you can save time and effort while creating custom reports with a consistent presentation.
Before modifying a report, ensure that there are no existing reports that meet your business needs. This helps avoid the creation of duplicate reports. (Keep in mind that you can customize reports using filters and then bookmark the resulting report using the Add to Favorites feature.) You can use the All Reports page to quickly scan existing reports by name or type of data. The decision to modify a report should be based on a repeatable business need. If you need to view specific data on a regular basis, modifying a report can be the best way to achieve this. For one-time issues, it is preferable to display related reports to gather information.
The basic report modification procedure consists of the following steps:
• Define requirements for report modifications
• Download the report definition file from the report server
• Modify the report definition using the XML editor of your choice
• Upload the modified report definition file to the report server
• Verify that the new report is displayed correctly and shows the intended data
Defining Report Modification Requirements
As mentioned previously, report modifications should always be based on a repeatable business need. Once the need is identified, you can determine what data needs to be displayed to meet that need. To display the data fields available for use in a report, use the provided database schema information, or use the SQL Server Enterprise Manager to display EdgeSight database tables.
Downloading a Report
Use the Download link on the Properties pane to download the report in the form of an RDL file. When displaying a report list, click the information icon next to the report name to display the Properties pane. If you are already displaying the report, click the Properties link above the report.
When prompted, save the RDL file to a folder.
Modifying a Report
You can edit an RDL file using the XML editor of your choice. Do not use the Visual Studio Report Designer to modify reports. Editing existing Citrix EdgeSight reports using the Report Designer can, in some cases, render the RDL file unusable. To modify a report:
1. Open the RDL file in your XML editor.
2. Locate the <CommandText> tag in the <Query> section. This section contains the SQL query used to populate the report with data.
3. Edit the SQL query based on the previously defined requirements.
4. Locate the <Fields> section and edit the field names and <DataField> values as required to match the data fields specified in the query.
5. Locate the <Description> tag and edit the report name. The report name should be unique.
6. Save the RDL file with a new name.
Uploading a Report
Use the Upload a Report page (Company Settings > Server > Reporting > Upload a Report) to transfer the RDL file to the report server.
Note that you must have the Upload New Report permission to be able to upload a report to the server. This permission is granted by default to all Citrix EdgeSight Administrators. If you have not been granted this permission, contact your Citrix EdgeSight Administrator.
Always use a unique name when uploading a new report. This ensures that duplicate report names do not appear on the All Reports page. Also, it is best practice to define naming conventions for custom reports. Consistent report names can help users find the reports they need. It is also best practice to be consistent when specifying the Data Area and Report Type fields since users sort report lists by these values.
Use the Public or Private radio buttons to determine whether the report is shared within your company. Public reports are displayed to all users matching the role mapping. Private reports are only displayed to the user uploading the report.
The report attributes cannot be changed once the report is uploaded. To change any of these attributes, you must delete the report and then upload the report again.
If you make additional changes to the report, use the Update link on the Properties page to upload the RDL file.
Verifying the Modified Report
After uploading a report, navigate to the Custom Reports folder to which the report was uploaded. Display the report and verify that the changes are displayed and that the data appears to be correct. If problems appear, review the SQL query and data field portions of the RDL file for accuracy and completeness. Update the report to verify any problem fixes.
