Custom Reports in Management Studio
Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)
In SQL Server Management Studio, many Object Explorer nodes display a set of standard reports that are created by Microsoft. These reports summarize typically requested server information. Starting with SQL Server 2005 (9.x) Service Pack 2, administrators can run custom reports that were created in SQL Server Data Tools (SSDT) from Management Studio.
Custom reports are stored as report definition (.rdl) files and are created by using Report Definition Language (RDL). RDL contains data retrieval and layout information for a report in an XML format. RDL is an open schema. Developers can extend RDL with additional attributes and elements. Reports can execute any valid Transact-SQL statement within the report.
If Object Explorer is connected to a server, custom reports can execute in the context of the current Object Explorer selection if the reports reference report parameters of that node. This enables a report to use the current context, such as the current database; or a consistent context, such as specifying a designated database as part of the Transact-SQL statement that is contained in the custom report.
Running a Custom Report
You can run a custom report in Management Studio in the following ways:
Right-click a node in Object Explorer, point to Reports and left-click Custom Reports. In the Open File dialog box, locate a folder that contains .rdl files, and then open the appropriate report file.
Right-click a node in Object Explorer, point to Reports, point to Custom Reports, and then select a custom report from the most recently used file list.
When you work with custom reports, consider the following limitations:
To prevent the unintended execution of malicious code, Management Studio cannot be configured to automatically run a report, even if the file system is configured to associate .rdl files with Management Studio. Reports cannot be programmatically executed in Management Studio and cannot run from the command line through Management Studio.
You can run custom reports in a context that does not produce the expected values. For example, you can run a report about replication in the context of a database that is not involved in replication, or run a report as a user who does not have permission to access information that is required to generate an accurate report. The creator of the custom report is responsible for the validity of the report structure and its context.
You cannot add a custom report to the list of standard reports.
The code processed by the report might affect server performance.
Custom reports will not support subreports.
The command text for each query within the report must not be defined through an expression.
Any query parameter that is used in a command (query) can only reference a single report parameter and cannot use any expression operators.
Only Text and Stored Procedure command types are supported for report commands (queries).
The report framework does not provide any parameter escaping for the queries. Query authors must make sure that their queries are free from SQL injection attacks.
Managing Custom Reports
We recommend that users who have many custom reports organize them by using file system folders that have appropriate NTFS file system permissions.
Custom reports run by using the permissions of the current user. To prevent a malicious user from changing the queries run by the report, permissions on the file system folder that contains the report files should be set to restrict access.
Both the user and the account that is used by the SQL Server service require read access to the file system folder that contains the report files.
Any valid .NET Framework command can be embedded in a report, but the command will not be executed.
Any valid Transact-SQL statement can be embedded in and executed from a report. Running a report under a high-privileged user account makes it possible for any of these embedded instructions to execute without challenge.
Add a Custom Report to Management Studio
Unsuppress Run Custom Report Warnings
Use Custom Reports with Object Explorer Node Properties
Submit and view feedback for