Overview
Reporting Services in SQL Server Data Tools
Design Reports with Report Designer
Add a New or Existing Report to a Report Project
Deployment and Version Support in SQL Server Data Tools
URL Examples for Published Report Items on a Report Server in SharePoint Mode
(SSRS)
Set Deployment Properties
Dock the Report Data Pane in Report Designer
Report Designer F1 Help
Document Outline
Design View
Preview View
Grouping Pane
Project Property Pages Dialog Box
Reporting Services Login Dialog Box (SSRS)
Reporting Services in SQL Server Management Studio
Set Report Server Properties
Connect to a Report Server in Management Studio
Delete an Item
Report Server in Management Studio F1 Help
Cancel Report Server Jobs
Delete Catalog Items
Job Properties
New Shared Schedule
New System Role
New User Role
Schedule Properties (General Page)
Schedule Properties (Reports Page)
Server Properties (General Page)
Server Properties (Execution Page)
Server Properties (History Page)
Server Properties (Logging Page)
Server Properties (Security Page)
Server Properties (Advanced Page)
System Role Properties
User Role Properties
Report Builder authoring environment
Scripting and PowerShell with Reporting Services
Script with the rs.exe Utility and the Web Service
Format a Reporting Services Script File
Run a Reporting Services Script File
Script Deployment and Administrative Tasks
Sample Reporting Services rs.exe Script to Copy Content between Report Servers
Access the Reporting Services WMI Provider
Report Server Command Prompt Utilities
rskeymgmt Utility
rsconfig Utility
RS.exe Utility (SSRS)
Tutorial: How to Locate and Start Reporting Services Tools
Reporting Services Tools
3/24/2017 6 min to read Edit Online
SQL Server Reporting Services contains a set of graphical and scripting tools that support the development and
use of rich reports in a managed environment. The tool set includes development tools, configuration and
administration tools, and report viewing tools. This topic gives a brief overview of each tool in Reporting Services
and how it can be accessed.
To find a tool right away, see Tutorial: How to Locate and Start Reporting Services Tools (SSRS).
SQL Server Mobile Report Publisher With Mobile Report Publisher, you can Download the SQL Server Mobile
create mobile reports that dynamically Report Publisher
adjust the content to fit your screen or
browser window and scale well to any
screen size.
Power View An interactive data exploration and Reporting Services in SharePoint mode.
visual presentation experience designed Browser with Silverlight.
to let you create and interact with
reports based on Analysis Services
tabular models.
TOOL DESCRIPTION HOW TO ACCESS
Report Designer Use this tool to design reports. Includes SQL Server Data Tools (SSDT)
the following features:
Report Builder Use this tool to design reports. Includes Download the standalone version of
the following features: Report Builder
Aggregates of aggregates
Reporting Services Configuration Use this tool to configure a Reporting Start menu
Manager Services installation. Available tasks
include:
SQL Server Management Studio Use this tool to manage one or more Start menu
report server instances in a single
environment, including:
Managing jobs
SQL Server Configuration Manager Use this tool to: Start menu
Rsconfig Utility Use this tool to configure and manage Command prompt
a report server connection to the report
server database. You can also use it to
specify a user account to use for
unattended report processing.
Windows Management Instrumentation Use these classes to automate the Visual Basic script
(WMI) Classes configuration tasks in Reporting
Services Configuration Manager
without the need to use the graphical
user interface.
SharePoint Central Administration Use SharePoint Central Administration Browser to the SharePoint site URL for
to create, query, and manage the Central Administration
shared service applications for
Reporting Services.
PowerShell Cmdlets Use PowerShell cmdlets to create, SharePoint 2010 Management Shell
query, and manage the shared service
applications for Reporting Services.
Report Server Web service URL Use this tool to browse content in the Browser
report catalog in a generic item
navigation page.
RS Utility This tool is a script host that you can Command prompt
use to perform scripted operations. Use
this tool to run Visual Basic scripts that
copy data between report server
databases, publish reports, create items
in a report server database, and more.
For more information, see Report Server
Command Prompt Utilities (SSRS).
See Also
Reporting Services Report Server
Reporting Services Concepts (SSRS)
Reporting Services (SSRS)
Reporting Services in SQL Server Data Tools (SSDT)
3/24/2017 17 min to read Edit Online
SQL Server Data Tools (SSDT) is a Microsoft Visual Studio environment for creating business intelligence
solutions. SSDT features the Report Designer authoring environment, where you can open, modify, preview, save,
and deploy Reporting Services paginated report definitions, shared data sources, shared datasets, and report parts.
SQL Server Data Tools (SSDT) is not included with SQL Server 2016. Download SQL Server Data Tools.
This topic describes SQL Server Data Tools solutions, projects, project templates, and configurations used for
Reporting Services, and the views, menus, toolbars, and shortcuts that you can use in Report Designer.
To get started designing reports, see Design Reports with Report Designer (SSRS).
Configurations
To create multiple sets of project properties for deployment variations such as enterprise test and production
report servers, use the Configuration Manager. For more information, see Deployment and Version Support in
SQL Server Data Tools (SSRS).
Grouping Pane
Use the Grouping pane to define groups for a tablix data region. You can define row groups and detail groups for
tables and row and column groups for matrices. You cannot use the Grouping pane to define groups for Charts or
other data regions. For more information, see Understanding Groups (Report Builder and SSRS).
The Grouping pane has two modes:
Default. Use the Default mode to display all row and column groups in a hierarchical format that shows
the relationship of parent groups, child groups, adjacent groups, and detail groups. A child group appears
under and at the next indent level compared to its parent group. An adjacent group appears at the same
indent level as its peer or sibling groups.
Use default mode to add, edit, or delete groups. For groups based a single dataset field, drag the field to the
Row Groups or Column Groups pane. You can insert the group above or below an existing group. To add an
adjacent group, right-click the sibling group, and use the shortcut menu. To display which tablix cells belong
to a group, select the group in the Grouping pane.
Advanced. Use the Advanced mode to display static and dynamic row and column group members of the
selected tablix data region. You must use group members to set properties that control the visibility of the
rows and columns associated with a group or group member, or the rules that renderers use to try to keep
groups together on a page. Group members appear on the design surface as cells in the row group and
column group areas.
NOTE
To toggle between Default and Advanced modes, right-click the down arrow to the right of the Column Groups icon.
Source Control
SQL Server Data Tools can integrate with source plug-ins. Use the Projects and Solutions pages in the Options
dialog box to specify the plug-in and configure properties.
/build Build the solution file, but do not deploy it. For example, the following command builds the reports
specified by the solution file Reports.sln by using the Debug configuration settings that are specified in the
project properties:
/out Redirect the output generated by building a solution to the specified file. For example, the following
command redirects the output from the build in the previous example to a file named mybuildlog.txt.
Start debugging F5
Move focus from one report item to the next report item TAB
Increase or decrease the size of the selected report item CTRL+SHIFT+Arrow keys
In a text box, move cursor to the end of the display text CTRL+END
that is visible
In a text box, select text from the current cursor position SHIFT+HOME
to the beginning of the display text that is visible
In a text box, select text from the current cursor position SHIFT+END
to the end of the display text that is visible
In a text box, select text from the current cursor position CTRL+SHIFT+HOME
to the beginning of the expression
In a text box, select text from the current cursor position CTRL+SHIFT+END
to the end of the expression
Open the shortcut menu for the selected report item SHIFT+F10+Property Key on newer keyboards
See Also
Download SQL Server Data Tools Solution Explorer
Reporting Services Reports (SSRS)
Report Definition Language (SSRS)
Deployment and Version Support in SQL Server Data Tools (SSRS)
Design Reporting Services Paginated Reports with
Report Designer (SSRS)
3/24/2017 13 min to read Edit Online
Use Report Designer to create full-featured Reporting Services paginated reports and reporting solutions. Report
Designer provides a graphical interface in which you can define data sources, datasets and queries, report layout
positions for data regions and fields, and interactive features such as parameters and sets of reports that work
together.
Report Designer is a feature of SQL Server Data Tools (SSDT), a Microsoft Visual Studio environment for creating
business intelligence solutions. SQL Server Data Tools (SSDT) is not included with SQL Server 2016. Download
SQL Server Data Tools.
Shared Datasets
Use SQL Server Data Tools to define and deploy shared datasets for a reporting solution. Shared datasets can be
deployed independently from other items in a project by using the OverwriteDatasets and TargetDatasetFolder
properties. For more information, see Set Deployment Properties (Reporting Services).
In Report Designer, you work in both the Report Data pane and in Solution Explorer to define shared datasets used
in a report. For more information, see Report Data Pane. You cannot use SQL Server Data Tools to open published
datasets directly from a report server or SharePoint site. For that feature, use Report Builder authoring
environment (SSRS) in Shared Dataset mode.
SQL Server Data Tools is a client tool. You can use query designers to help create and test your query results
locally in Preview. After deployment, you can manage shared datasets independently from the shared data sources
and reports that they depend on. For more information, see Report Embedded Datasets and Shared Datasets
(Report Builder and SSRS), Query Design Tools (SSRS), and Manage Shared Datasets.
Paginated Reports
Paginated reports are files that are stored in a report project. Reports can be used as stand-alone reports,
subreports, or the targets for drillthrough actions from main reports. Reports can be deployed independently from
other items in a project by using TargetReportFolder and other properties. For more information, see Set
Deployment Properties (Reporting Services).
NOTE
If you are publishing to a report server in SharePoint mode, some report solution features cannot be tested in the Report
Designer project. References to reports, subreports, and drillthrough reports must use fully-qualified URLs that can be tested
only after you deploy the report project. For more information, see URL Examples for Published Report Items on a Report
Server in SharePoint Mode (SSRS).
NOTE
You must have Access 2002 or a later version installed on the same computer that Report Designer is installed on in
order to use the import feature. The data source for the Access reports must be available when the reports are
imported.
Work directly in RDL. When you write a report in Report Designer, the report is saved in XML format as a
Report Definition Language (RDL) file. You can edit this file in Report Designer, a text editor, or any tool in
which you can edit XML.
When you edit the report definition source in Report Designer, you are working in the current RDL schema
for the version of SQL Server from which you installed the development tools. When you build a project, the
schema version might change depending on your deployment properties. For more information, see
Deployment and Version Support in SQL Server Data Tools (SSRS).
Editing RDL directly can result in a report that cannot be published to the report server or cannot run. As
with any XML file, ensure that XML-specific characters used within elements are properly encoded. When
you publish the report, the report server uses the schema to validate the XML contained within the RDL file.
To include elements that are not part of the RDL schema, place them in the Custom Element. The Custom
element can be read by custom rendering extensions, but is ignored by the rendering extensions provided
with Reporting Services. For example, you can use the Custom element to store comments in the report.
For more information, see Report Definition Language (SSRS).
Report Parts
In Report Designer, after you create tables, charts, and other paginated report items in a project, you can publish
them as report parts to a report server or SharePoint site integrated with a report server so that you and others
can reuse them in other reports. For more information, see Report Parts in Report Designer (SSRS).
Report parts can be deployed independently from other items in a project by using TargetReportPartFolder and
other properties. For more information, see Set Deployment Properties (Reporting Services).
Resources
You can add files to your project that are related to your report but not processed by the report server. For
example, you can add images for pictures or ESRI shapefiles for spatial data. For more information, see Resources.
NOTE
When you preview a report, the data for the report is cached to a file on the local computer. When you preview the same
report again using the same query, parameters, and credentials, Report Designer retrieves the cached copy rather than
rerunning the query. The data file is saved as <reportname>.rdl.data in the same directory as the report definition file. The
file is not deleted when you close Report Designer.
NOTE
To use Debug mode, you must set a start item. In Solution Explorer, right-click the report project, click Properties,
and in StartItem, select the name of the report to display.
If you wish to preview a particular report that is not the start item for the project, select a configuration that
builds the report but does not deploy it (for example, the DebugLocal configuration), right-click the report,
and then click Run. You must choose a configuration that does not deploy the report; otherwise, the report
will be published to the report server instead of displayed locally in a preview window.
Print Preview.
When you first view a report on in Preview mode or in the preview window, the view of the report
resembles a report produced by the HTML rendering extension. The preview is not HTML, but the layout and
pagination of the report is similar to HTML output.
You can change the view to represent a printed report by switching to print preview mode. Click the Print
Preview button on the preview toolbar. The report will display as though it were on a physical page. This
view resembles the output produced by the Image and PDF rendering extensions. Print preview is not an
image or PDF file, but the layout and pagination of the report is similar the output in those formats. You can
choose the size of the report image, for example, set the width of the page.
Print preview helps you identify many of rendering problems you might encounter were you to print the
report. Common rendering problems include:
Extra blank pages because the report is too wide to fit on the paper size you specified for the report.
Extra blank pages because the report contains a matrix that dynamically expands to exceed the width
of the paper specified.
Page breaks between groups do not work the way you want.
Headers and footers do not display as expected.
Report layout needs modification to read better in a printed format.
NOTE
For debugging expressions and deployment errors, you must view the report definition in the build folder. Do not use View
Source. View Source displays the report definition source from the project folder.
For more information, see Deployment and Version Support in SQL Server Data Tools (SSRS).
Save a Report Locally
When you work on report or other project items in Report Designer, the files are saved to your local computer or a
share on another computer that you have access to.
If you are using source control software, you might be checking your reports into the source control server when
you save the report. For more information, see Source Control.
Deploy or Publish Paginated Reports
From SQL Server Data Tools, you can deploy reports or other project items to multiple versions of Reporting
Services report servers. Use project configurations to control the upgrade of report definitions to schema versions
compatible with target report servers. The properties controlled by project configurations include the target report
server, the folder where the build process temporarily stores report definitions for preview and deployment, and
error levels. For more information, see Configuration and Deployment Properties and Set Deployment Properties
(Reporting Services).
Export a Paginated Report to a Different File Format
Reports can be exported to a variety of formats and these formats affect how some report layout and interactivity
features function. For more information about design considerations for various output formats, see Export
Reports (Report Builder and SSRS).
When you attempt to preview or deploy a report that contains report items new in SQL Server 2016 Reporting
Services (SSRS), those report items can be removed from the report. By default, the ErrorLevel property of the
configuration is set to 2, which would cause the build of the report to fail when the map is removed. However, if
you change the value of the ErrorLevel property to 0 or 1, the map is dropped, a warning issued, and the build
process continues.
See Also
Download SQL Server Data Tools Reporting Services in SQL Server Data Tools (SSDT)
Query Design Tools (SSRS)
Deployment and Version Support in SQL Server Data Tools (SSRS)
Add a New or Existing Report to a Report Project
(SSRS)
3/24/2017 2 min to read Edit Online
In SQL Server Data Tools (SSDT), you can add a new Reporting Services paginated report by using the Report
Wizard or by adding a new blank report to your project. You can also add an existing report. After you add a
report, you can see the report name listed under the Reports folder in your project.
NOTE
To preview a report with existing data sources, you must have permissions to the data source from your report authoring
client. For more information, see Data Connections, Data Sources, and Connection Strings.
After you add a report, you can define data sources, datasets, and design a report layout. To get started, see Create
a Basic Table Report (SSRS Tutorial) or Tables (Report Builder and SSRS).
See Also
Reporting Services Tutorials (SSRS)
More questions? Try the Reporting Services forum
Deployment and Version Support in SQL Server
Data Tools (SSRS)
3/24/2017 3 min to read Edit Online
Supported Versions
NOTE
SQL Server Data Tools (SSDT), the 32-bit development environment for Report Server projects, is not designed to run on
Itanium-based computers and is not installed on Itanium-based servers. However, support for SQL Server Data Tools is
available for x64-based computers.
The following table describes the supported versions for authoring and publishing reports in SQL Server Data
Tools (SSDT).
NOTE
The schema has not changed since SQL Server 2008.
Report Server Project SQL Server 2016 2016 RDL schema SQL Server 2016
Reporting Services Reporting Services
or (SSRS) (SSRS)
Report Server Project SQL Server 2014 2014 RDL schema SQL Server 2014
Reporting Services
or
Report Server Project SQL Server 2012 2012 RDL schema SQL Server 2012
Reporting Services
or
Report Server Project SQL Server 2008 R2 2008 R2 RDL schema SQL Server 2008 R2
Reporting Services
or
Report Server Project SQL Server 2008 2008 RDL schema SQL Server 2008 Upgrades 2003 RDL
Reporting Services and 2005 RDL to the
or report server only 2008 RDL schema
locally.
Report Server Wizard
Project
For more information about opening reports in a previous version of the report definition schema, see Upgrade
Reports. For more information about specific report definition schemas, see Report Definition Language
Specification.
See Also
Publishing Data Sources and Reports
URL Examples for Items on a Report Server -
SharePoint Mode
4/14/2017 10 min to read Edit Online
To publish reports and related items to a SharePoint library, you can either publish the content using the Reporting
Services authoring tools such as Report Designer or you can upload the content by using SharePoint site actions.
SharePoint sites use different Web addresses than a Reporting Services report server in native mode. A SharePoint site
Web hierarchy includes the SharePoint Web application, a top-level site, optional subsites, and libraries. You must know
how to create a URL address that specifies the SharePoint server as well as the location in the SharePoint site hierarchy
where you want to publish a report or related items.
Items related to a report include shared data sources, subreports, drillthrough reports, and resources such as Web-
based image files. A report that has been published to a SharePoint library must specify these related items by their
location in the SharePoint library.
Use the examples in this topic to help create URLs to reports and related items in your reporting solutions.
Site Hierarchy
When you configure a report server to run in SharePoint integrated mode, the SharePoint Web hierarchy is used to
address items that are processed and managed on a report server.
The following elements of the Web hierarchy can be used to access and secure report server content. Other objects
such as lists and pages are not used to access report server content and therefore are not described in the following
table.
OBJECT DESCRIPTION
Item Report server items that you can reference in a URL include a
report definition for a report or subreport, a report model, a
shared data source, or an external image.
On a Microsoft Office SharePoint Server 2007 or SharePoint Server 2010 Web application, the site and subsite
frequently correspond to the tabs on the main site. To find the site name or subsite name, click Home, and then All Site
Content. Scroll to the bottom and look for Sites and Workspaces. The list of sites appears in this section.
URL for a SharePoint Library
When you deploy a report or related item to a SharePoint library, you must use a URL to the SharePoint library. The
URL to use for a library differs depending on the version of SharePoint you are using.
On Microsoft Windows SharePoint Services 3.0 or SharePoint Foundation 2010, the library appears after the server
name, for example, http://*servername/*Shared Documents .
On Office SharePoint Server 2007 or SharePoint Server 2010, the library appears after the site and subsite. For
example, http://*servername/site/*Documents .
To find the path information for a new SharePoint library or for an unfamiliar site, open a browser and locate the
SharePoint library where you want to publish your reports. If the library is empty, upload any file. Right-click the file
and select Properties to open the Properties window. The address of the file contains the URL values that you need for
a publish operation.
Fully qualified URLs for Items on a SharePoint Site
Items that are stored in a SharePoint library are always addressed through a fully qualified URL that starts with the Web
application ( http://*server* ) as the root node, and concludes with the name of the file that you are referencing.
File names in the URL must include a file name extension.
You cannot use relative URLs for dependent items in reports that you publish to a SharePoint site. For example, you
cannot use a relative URL to reference a shared data source, report model, or subreport. You must always specify the
fully qualified URL to a SharePoint library for each item. There is no way to predict where a dependent file might be
located as there is no predefined hierarchy to the sites that you can use to parse a URL format.
When you publish or upload a report that contains dependent items, you must set the references to the dependent
items after the report is published. References that worked correctly in Preview mode in Report Designer are not
guaranteed to work after the report is published. For more information, see Publishing from an Authoring Tool to a
SharePoint Library in this topic.
URLs for External Images
A report definition can include an image file that is stored as an external file. You can reference that file in the report
definition by setting a fully qualified URL to the image file. It can be stored on a SharePoint site or on a remote
computer.
IMPORTANT
If the external URL is for an image on a SharePoint site, the broken image icon will appear when you preview the report in Report
Builder. When you upload the report to the SharePoint site, and render the report in connected mode, the broken image icon will
appear if you have only View Items permissions.
Regardless of the report server mode, references to an external image file in a report must be a fully qualified URL. Also,
referencing an external image file typically requires that you configure the unattended report processing account.
Specifying Subreports and Drillthrough Reports
Subreports must reside in the same folder as the main report. You cannot specify a relative folder.
To specify drillthrough reports, include the URL in an expression. For example, to specify the report that is named
SalesDetails as a drillthrough report, in the Action for the text box or placeholder text, set ReportName to the following
expression:
="http://site/subsite/documentlibrary/SalesDetails.rdl"
Examples of URLs
When publishing items to a SharePoint library, you must specify fully qualified URLs to the target library. A fully
qualified SharePoint URL includes the SharePoint Web application, site, library, folder (optional), file, and file name
extension. The following examples provide several illustrations of the syntax you should use.
NOTE
In order to publish reports to a SharePoint site from SQL Server Data Tools (SSDT), you might need to add the SharePoint site to
your list of trusted locations in the Internet Explorer browser.
See Also
Publish a Report to a SharePoint Library
Publish a Shared Data Source to a SharePoint Library
Project Property Pages Dialog Box
Set Deployment Properties (Reporting Services)
3/24/2017 5 min to read Edit Online
In SQL Server Data Tools (SSDT), you must specify the report server and optionally the folders for reports and
shared data sources so that you can publish the items in a Report Server project to a report server. The properties
and values that SQL Server Data Tools (SSDT) needs to build, preview an deploy reports are stored in project
configurations of the Report Server project. You can create multiple named sets for these project properties, so
that you can conveniently switch between property sets. Each set of properties is a configuration. For example,
you can have a configuration for publishing reports to a test server and a different configuration for publishing
reports to a production server.
Use Configuration Manager to create and manage sets of project properties in project configurations.
Configuration Manager is a feature supported by Visual Studio, on which SQL Server Data Tools is based.
NOTE
Do not confuse this feature with the Reporting Services Configuration Manager, which is used to configure Reporting
Services after installation. For more information, see Configure and Administer a Report Server (SSRS Native Mode).
NOTE
In SQL Server Data Tools, the action of publishing reports from a Report Server project or solution is known as deploying
reports.
NOTE
You can use multiple configurations to switch quickly between different report servers or settings.
3. In the OutputPath textbox, type or paste the path in your local file system to store the report definition
used in build verification, deployment, and preview of reports. The path must be different than the path
that you use for the project and a relative path that is a child folder under the path of the project.
4. In the ErrorLevel text box, type the severity of the build issues that are reported as errors. Issues occurring
when building reports, data sources, or other project resources with severity levels less than or equal to
the value of ErrorLevel are reported as errors; otherwise, the issues are reported as warnings. Any error
will cause the build task to fail. The valid severity levels are 0 through 4 inclusive. The default value is 2.
ErrorLevel can be used to increase or decrease the sensitivity of the build. For example, when a report
with a map is built during deployment to a SQL Server 2008 report server an error displays by default and
building the report fails. If you lower ErrorLevel the map is removed from the report, a warning displays,
and building the report continues.
5. In the StartItem list, select a report to display in the preview window or in a browser window when the
report project is run.
6. In the OverwriteDataSources list, select True to overwrite the shared data source on the server each time
shared data sources are published, or select False to keep the data source on the server.
7. In the TargetServerVersion list, select SQL Server 2016 version of Reporting Services or select Detect
Version to automatically determine the version installed on the server identified by the TargetServer URL
property. The default value is SQL Server 2016 or later.
Use TargetServerVersion to customize the built reports, placed in the path specified in OutputPath, for
the version of the report server specified in TargetServer URL.
8. In the TargetDataSourceFolder text box, type the folder on the report server in which to place the
published shared data sources. The default value for TargetDataSourceFolder is Data Sources. If you
leave this value blank, the data sources will be published to the location specified in TargetReportFolder.
9. In the TargetReportFolder text box, type the folder on the report server in which to place the published
reports. The default value for TargetReportFolder is the name of the report project.
NOTE
For a report server running in native mode, you must have Publish permissions on the target folder to publish
reports to that folder. Publish permissions are provided through a role assignment that maps your user account to
a role that includes publish operations. For more information, see Create and Manage Role Assignments. For a
report server running in SharePoint integrated mode, you must have Member or Owner permission on the
SharePoint site. For more information, see SharePoint Site and List Permission Reference for Report Server Items.
10. In the TargetServerURL text box, type the URL of the target report server. Before you publish a report, you
must set this property to a valid report server URL. When publishing to a report server running in native
mode, use the URL of the virtual directory of the report server (for example, http://server/reportserver or
https://server/reportserver). This is the virtual directory of the report server, not Report Manager.
When publishing to a report server running in SharePoint integrated mode, use a URL to a SharePoint top-
level site or subsite. If you do not specify a site, the default top-level site is used (for example,
http://servername, http://servername/site or http://servername/site/subsite).
To set Configuration Manager properties
1. Right-click the report project, and then click Properties.
2. In the Property Pages dialog box for the project, click Configuration Manager.
3. In the Configuration Manager dialog box, select the configuration to edit. The currently active
configuration is displayed as Active(<configuration>).
4. In Project Contexts, for each project in the solution, select or clear Build or Deploy.
NOTE
If Build is selected, Report Designer builds the report project and checks for errors before previewing or publishing
to a report server. If Deploy is selected, Report Designer publishes the reports to the report server as defined in
deployment properties. If Deploy is not selected, Report Designer displays the report specified in the StartItem
property in a local preview window.
See Also
Publishing Data Sources and Reports
Previewing Reports
Report Designer F1 Help
URL Examples for Published Report Items on a Report Server in SharePoint Mode (SSRS)
Project Property Pages Dialog Box
Publishing Reports to a Report Server
Dock the Report Data Pane in Report Designer
(SSRS)
3/24/2017 1 min to read Edit Online
In Reporting Services Report Designer in SQL Server Data Tools (SSDT), the Report Data pane displays a
hierarchical view of data objects that you can use in a report, including data sources, datasets, fields, parameters,
and images. Data sources in this view can be embedded or references to shared data sources that are displayed in
Solution Explorer.
To display the Report Data pane
In Design view, on the View menu, select Report Data, or use CTRL+ALT+D.
To dock the Report Data pane
1. Grab the title bar of the Report Data pane and start to drag the pane. Docking arrows appear on the design
surface.
2. Drop the Report Data pane onto one of the arrows to dock the pane.
To change the Report Data pane from a docked window to a tabbed window
Right-click the title bar of the Report Data pane and then click Dock as Tabbed Document.
To change the Report Data pane from a tabbed window to a docked window
Right-click the Report Data tab and then click Dock.
To toggle between the last two display states, double-click the title bar of the Report Data pane.
See Also
Report Data Pane
Data Connections, Data Sources, and Connection Strings (Report Builder and SSRS)
Report Designer F1 Help
3/24/2017 1 min to read Edit Online
This section provides F1 Help for the SQL Server Reporting Services Report Designer wizards, views, and dialog
boxes in SQL Server Data Tools (SSDT). Alternatively, you can open the F1 Help while working with the dialog box
by pressing F1 or by clicking the Help button displayed in the dialog box.
See Also
Install SQL Server Data Tools - Business Intelligence for Visual Studio
Feature Refernce (Reporting Services)
Reporting Services Reports (SSRS)
Document Outline
3/24/2017 1 min to read Edit Online
Use the Document Outline window to view the hierarchy of report items in a report. Tablix data regions display all
the text boxes and other report items that are contained in Tablix cells. When you select a report item on the design
surface, the corresponding report item is selected in the Document Outline window. Use this view to locate report
items on the design surface. For example, when you preview a report with expression errors, the Output window
displays a message for each error. The message includes the name of the text box that contains the expression with
the error. You can click the name of the text box in the Document Outline window, see it selected on the design
surface, and view the expression that contained the error.
If the Document Outline window is not visible, on the View menu, click Other Windows, and then click Document
Outline. Or use CTRL+ALT+T.
Options
Expand All
Click to expand all nodes in the hierarchy.
Collapse All
Click to collapse all nodes in the hierarchy.
Design View
3/24/2017 2 min to read Edit Online
In Reporting Services Report Designer, use Design view to arrange report items in the report. Design view is
sometimes called the design surface or layout view.
Toolbox
The Toolbox lists data regions and other report items that are available for your report. To add report items from
the Toolbox, double-click the item or drag it to the design surface. You can then change the shape and size by using
the object handles.
Grouping Pane
Groups are used to organize your report data into a visual hierarchy and to calculate totals. Use the Grouping pane
to view the groups defined for a table, matrix, or list data region. By default, the Grouping pane displays all the
groups for the selected data region as a flattened list. The Grouping pane is disabled for Chart and Gauge data
regions.
To see the groups in relationship to one another, toggle the Grouping pane to Advanced mode. This mode displays
the hierarchy of group members, a visual display of cells in the data region that correspond to each group.
For more information, see Grouping Pane.
Properties Pane
Use the Properties pane to view properties for the currently selected report item on the design surface or the
currently selected group in the Grouping pane. Alternatively, you can right-click on a selected report item or group
and then click Properties to open the corresponding Properties dialog box for the report item or group.
See Also
Page Headers and Footers (Report Builder and SSRS)
Report Design Tips (Report Builder and SSRS)
Preview View
3/24/2017 1 min to read Edit Online
In Reporting Services Report Designer, use Preview view to display the rendered report. When a report is
previewed, Report Designer runs the report locally and displays it in the Preview view. In preview mode, the report
is processed in full. If the report has a complex query or has a large amount of data, preview might take several
minutes to complete the first time you view it. For subsequent changes that affect only the format of the report,
preview uses cached data.
Options
Use the toolbar to manage preview functions.
See Also
Previewing Reports
Report Designer F1 Help
Grouping Pane
3/24/2017 4 min to read Edit Online
When designing Reporting Services reports, the Grouping pane displays the row groups and column groups for
the currently selected Tablix data region. The Grouping pane is not available for the Chart or Gauge data regions.
The Grouping pane consists of a Row Groups pane and a Column Groups pane. The Grouping pane has two
modes: default and Advanced. Default mode displays a hierarchical view of the dynamic members for row and
column groups. Advanced mode displays both dynamic and static members for row and column groups. A group
is a named set of data from a report dataset that is displayed on a data region. Groups are organized into
hierarchies that include static and dynamic members. For more information, see Understanding Groups (Report
Builder and SSRS).
If you do not see the Grouping pane, on the Report menu, click Grouping.
Cells in the row and column group areas can be static or dynamic members of a group. Static members repeat
once per group and typically contain labels or totals. Dynamic members repeat once per group instance and
typically contain the unique values of the group expression. As you select Tablix cells in the row group area or
column group area, the corresponding group member is selected in the Row Groups or Column Groups pane.
Conversely, if you select groups in the Grouping pane, the corresponding cell associated with the group member is
selected on the design surface. For more information about Tablix row and column group areas, see Tablix Data
Region Areas (Report Builder and SSRS).
The Grouping pane supports the following modes:
Default. Use the default mode to add, edit, or delete groups. You can add parent, child, and detail groups by
dragging fields from the Report Data pane and inserting them in the group hierarchy. To add an adjacent
group, you must use the Add Group shortcut. For more information, see Add or Delete a Group in a Data
Region (Report Builder and SSRS).
Advanced. Use the Advanced mode to view all members of row and column groups, and to set properties
on static members. When you create groups or add totals, the properties that control how the Tablix data
region renders rows and columns on each report page are set automatically. To manually adjust these
properties, you must set them on the Tablix member. For more information, see Controlling the Tablix Data
Region Display on a Report Page (Report Builder and SSRS).
Default Mode
In default mode, the Row Groups pane and the Column Groups pane display a hierarchical view for all parent
groups, child groups, and adjacent groups. A child group appears indented under its parent group. An adjacent
group appears at the same indent level as its sibling groups. The following figure shows a Tablix data region with
nested row groups and nested and adjacent column groups.
The Grouping pane displays the corresponding row and column groups. In the following figure, the group based
on subcategory has been selected in the Row Groups pane, and the [Subcat] grouping cell is selected in the Tablix
data region:
In the Row Groups pane, the group based on subcategory is a child of the group based on category. In the Column
Groups pane, the country/region group is a child of the geography group. The year group and the country/region
groups are adjacent groups.
For more information, see Tablix Data Region Cells, Rows, and Columns (Report Builder) and SSRS.
Advanced Mode
In Advanced mode, you can view all static and dynamic members of a group. When you select a member, the
Properties window displays properties for the currently selected Tablix member.
To toggle Advanced mode, right-click the down arrow at the side of the Column Groups pane, and then click
Advanced Mode.
In most cases, properties that control the display of static and dynamic group rows and group columns are set
automatically when you create a group or add totals.
To edit the default values, you must select the group member in the Row or Column Groups pane, and change the
property values in the Properties window. If the properties pane is not visible, in the View menu, click Properties
or press F4. The following properties are available:
FixedData. Boolean. For outer row and column headers. Freeze the row group area when scrolling
vertically or the column group area when scrolling horizontally in a renderer such as HTML.
HideIfNoRows. Boolean. For static members only. If set, Hidden and ToggleItem are ignored. Hide this
member if the Tablix data region contains no rows of data.
KeepTogether.
KeepWithGroup. Boolean. For static row members only. Where possible, keep this row with the previous
or following sibling dynamic member, if it is not hidden.
RepeatOnNewPage. Boolean. For static row members only and where KeepWithGroup is not None. Where
possible, repeat this static row on every page that has at least one instance of the dynamic member
specified by KeepWithGroup.
Hidden. Boolean. Indicates whether the row or column should be initially hidden.
ToggleItem. String. The name of the text box to which to add the toggle image. The text box must be in the
same group scope or a containing scope.
For more information about how this behavior can be controlled on a Tablix data region, see Controlling the
Tablix Data Region Display on a Report Page (Report Builder and SSRS).
Not every static member has a header that corresponds to a cell on the design surface. In the Grouping
pane, the following convention indicates whether a static member has no header:
Static Indicates a static member with a header cell.
(Static) Indicates a static member with no header cell, known as a hidden static.
See Also
Tables, Matrices, and Lists (Report Builder and SSRS)
Expressions (Report Builder and SSRS)
Filter, Group, and Sort Data (Report Builder and SSRS)
Project Property Pages Dialog Box
3/24/2017 3 min to read Edit Online
Use the project property pages to configure deployment properties for a Report Server project. To open this dialog
box, from the Project menu, click <Report Project Name>Properties.
After you define configuration properties, you can select a configuration from the Solution Configurations drop-
down list on the toolbar.
Options
Configuration
Select the configuration to edit. Initially, the following configurations are available: Debug, DebugLocal, and
Release. The active configuration appears first, for example, Active(Debug).
To see properties for more than one configuration at the same time, select All Configurations or Multiple
Configurations.
To create additional configurations, click Configuration Manager on the toolbar.
Configuration Manager
Manage configurations for the entire solution or to add additional configurations. For more information, see the
Microsoft Visual Studio documentation.
OutputPath
Type or paste the path to store the report definition used in build verification, deployment, and preview of reports.
The path must be different than the path that you use for the project and a relative path that is a child folder under
the path of the project.
NOTE
You can use multiple configurations to switch among paths depending on the task you perform.
ErrorLevel
Type the severity of the build issues that are reported as errors. Issues with severity levels less than or equal to the
value of ErrorLevel are reported as errors; otherwise, the issues are reported as warnings. Any error will cause the
build task to fail. The valid severity levels are 0 through 4 inclusively. The default value is 2.
StartItem
Select the report that is displayed in the Web browser after the project is published to the report server or in the
preview window when the project is run locally. A start item is required for configurations that build but do not
deploy the project and for using the Debug command (F5). It is required for configurations that deploy the
project.
OverwriteDataSources
Select True to overwrite the data source on the server with the data source in the project when the reports are
published. Select False to leave the existing data source on the server.
TargetServerVersion
Select either the appropriate version of Reporting Services or select Detect Version to automatically determine
the version installed on the server identified by the TargetServer URL property. The default value is SQL Server
2016.
TargetDataSourceFolder
The name of the folder in which to store the published shared data sources. If you do not specify a folder, the data
source is published to the same folder as the report. If the folder does not exist on the report server, Report
Designer creates the folder when the reports are published.
When publishing to a report server running in native mode, specify the full path of the folder hierarchy starting at
the root. For example, Folder1/Folder2/Folder3.
When publishing to a report server running in SharePoint integrated mode, use a URL to the SharePoint library.
For example, http:\\<servername>\<site>\Documents\MyFolder .
TargetReportFolder
The name of the folder in which to store the published reports. By default, this is the name of the report project. If
the folder does not exist on the report server, Report Designer creates the folder when the reports are published.
When publishing to a report server running in native mode, specify the full path of the folder hierarchy starting at
the root. If a folder is located within another folder, include a path to the folder starting at the root, such as
Folder1/Folder2/Folder3.
When publishing to a report server running in SharePoint integrated mode, use a URL to SharePoint library. For
example, http:\\<servername>\\<site>\Documents\MyFolder .
TargetServerURL
The URL of the target report server. Before you publish a report, you must set this property to a valid report server
URL.
When publishing to a report server running in native mode, use the URL of the virtual directory of the report
server. For example, http:\\<server>\reportserver . This is the virtual directory of the report server, not Report
Manager. By default, the report server is installed in a virtual directory named "reportserver".
When publishing to a report server running in SharePoint integrated mode, use a URL to a SharePoint top-level
site or subsite. If you do not specify a site, the default top-level site is used. For example:
http:\\<servername> ,
http:\\<servername\<site>
http:\\<servername>\<site>\<subsite> .
See Also
Publish Reports
Publish a Report to a SharePoint Library
Set Deployment Properties (Reporting Services)
Report Designer F1 Help
Reporting Services Login Dialog Box (SSRS)
3/24/2017 1 min to read Edit Online
Use the Reporting Services Login dialog box to provide credentials to publish reports to the report server.
Note If this is the first time you have published a report to a report server since set you set the deployment
property TargetServerURL for a project, verify that the server name includes server and not reports. For
example, http://localhost/reportserver , and not http://localhost/reports . Specifying the reports directory
on the local server instead of the reportserver directory indirectly causes this dialog box to open. For more
information about setting TargetServerURL, see Set Deployment Properties (Reporting Services).
Options
Server
Displays the name of the report server. For example, http://localhost/reportserver . For report servers that use a
different port than default port 80, include the port number. For example, http://localhost:81/reportserver .
User name
Type the user name to log in to the Web service.
Password
Type the password to log in to the Web service.
See Also
Data Connections, Data Sources, and Connection Strings (Report Builder and SSRS)
Specify Credential and Connection Information for Report Data Sources
Report Designer F1 Help
Reporting Services in SQL Server Management
Studio (SSRS)
3/24/2017 1 min to read Edit Online
Report server administrators can use SQL Server Management Studio to:
Enable features, set server defaults, and manage running jobs.
View and create custom reports. In Object Explorer, many nodes display a set of standard reports that are
installed with Management Studio. You must have administrator permissions. The schema of a custom
report must match the schema of the installed reports. For more information, see Custom Reports in
Management Studio and Find the Report Definition Schema Version (SSRS).
Report authors can use Management Studio to:
Visualize spatial data from a query result set for a map report. After you run the query, use the Spatial
results tab in the result set pane. For more information, see View Spatial Data in Object Explorer.
This section contains step-by-step instructions for performing various reporting tasks using Management
Studio. Creating and managing shared schedules can also be performed using Report Manager.
In This Section
Connect to a Report Server in Management Studio
Set Report Server Properties (Management Studio)
Create, Delete, or Modify a Role (Management Studio)
Cancel Report Server Jobs (Management Studio)
See Also
Report Server in Management Studio F1 Help
Introducing SQL Server Management Studio
Set Report Server Properties (Management Studio)
3/24/2017 1 min to read Edit Online
You can set report server system properties in SQL Server Management Studio to enable features or set server
defaults.
To open the Advanced Server Properties page
1. Start Management Studio and connect to a report server instance.
2. Right-click the report server node, and select Properties. Click Advanced to open the properties page. See
Server Properties (Advanced Page) - Reporting Services for a description of each property.
See Also
Connect to a Report Server in Management Studio
Report Server System Properties
Connect to a Report Server in Management Studio
4/14/2017 5 min to read Edit Online
SQL Server Management Studio provides Object Explorer, which allows you to connect to any server in the SQL
Server family and graphically browse its contents. For Reporting Services, you can use Object Explorer to do the
following:
Enable report server features.
Set server defaults and configure role definitions.
Manage jobs that are running.
Manage job schedules.
You can connect to a native mode report server or a report server that runs in SharePoint integrated
mode. Connection syntax and the types of operations you can perform will vary depending on the server
mode of the report server and your permissions. If you have trouble connecting to a report server or
performing specific tasks, it might be that you have insufficient permissions or you specified the report
server name incorrectly. For more information about permissions and connection syntax, see the table at
the end of this topic.
Note that you cannot use Object Explorer to view or manage report server content. Content management
is performed through Report Manager if the report server runs in native mode or through a SharePoint
site if the report server runs in SharePoint integrated mode.
Object Explorer allows you to open connections to multiple server instances in the same workspace as
along as the servers are registered in the same server group. Before you can connect to a report server
instance in Management Studio, the server must be registered. If the report server is already registered,
you can skip this step. Instructions for registering report servers are provided at the end of this topic.
To connect to a native mode report server
1. If Object Explorer is not already open it, select it from the View menu.
2. Click Connect to view the list of server types, and then select Reporting Services.
3. In the Connect to Server dialog box, enter the name of the report server instance. Report server instance
names are based on SQL Server instance names. By default, the instance name of a local report server
instance is just the computer name. If you installed the report server as a named instance, use this syntax
to specify the server: <servername>[\].
4. Select the authentication type. If you are using Windows Authentication, you must connect using your
credentials. If you select Basic authentication or Forms authentication, type the account and password.
5. Click Connect. The report server appears in Object Explorer.
6. Right-click the server node to set system properties and server defaults. For more information, see Set
Report Server Properties (Management Studio).
To connect to a SharePoint integrated mode report server
1. If Object Explorer is not already open it, select it from the View menu.
2. Click Connect to view the list of server types, and then select Reporting Services.
3. In the Connect to Server dialog box, enter a URL to a SharePoint site. The following example illustrates
the syntax: http://<web server>/sites/<site> .
4. Select the authentication type. If you are using Windows Authentication, you must connect using your
credentials. If you select Basic authentication or Forms authentication, type the account and password.
5. Click Connect. The report server appears in Object Explorer.
6. Right-click the server node to set system properties and server defaults. For more information, see Set
Report Server Properties (Management Studio).
To register a report server
1. If you cannot connect to a report server, you either do not have permission to access it or it must be
registered. To register the server, click Registered Servers on the View menu,
2. Click the Reporting Services icon.
3. Right-click Reporting Services, point to New, and then click Server Registration. The New Server
Registration dialog box is displayed.
4. For Server name, enter a value. The value that you must specify will vary depending on the server mode:
For a native mode report server, type the name of the report server instance. Report server instance
names are based on SQL Server instance names. By default, the instance name of a local report
server instance is just the computer name. If you installed the report server as a named instance,
use this syntax to specify the server: <servername>[\].
For a report server that runs in SharePoint integrated mode, the server to connect to is the
SharePoint site with which the report server is connected. Connecting to the SharePoint site is
necessary so that you can view the permission levels that control access to report server content
and operations. You can specify any site in the site collection. The following example illustrates the
syntax: http://mysharepointsite .
5. For Authentication, select which authentication mode to use to access the Web server. You must choose
the authentication mode that the report server is already using.
If you are using default security, choose Windows Authentication.
If you installed and deployed a custom security extension, choose Forms Authentication.
If you configured the report server to use Basic authentication, choose Basic Authentication.
If the report server is configured for SharePoint integrated mode, choose Windows
Authentication.
6. Click Test to verify the connection.
7. When prompted, click OK, and then click Save.
Native mode report server, connected View and set server properties and Assigned to the System Administrator
as the default or named instance: defaults. role.
The connection to the report server is Create and manage shared schedules.
made through the Report Server WMI
provider. Create, modify, or delete role
definitions.
Native mode report server, connected View and set server properties and Assigned to the System Administrator
as the default or named instance, defaults. role.
through the endpoint to the Report
Server Web service: View and cancel jobs.
SharePoint integrated mode report View and set server properties and Full Control level of permission on the
server, connected through the defaults. SharePoint site to which you are
SharePoint site: connected.
View and cancel jobs.
http://<webserver>/<SharePointSite>
Create and manage shared schedules
defined for the site to which you are
connected.
SharePoint integrated mode report View and set server properties and Full Control level of permission on the
server, connected through the name of defaults. SharePoint site that is integrated with
the report server instance: the report server.
View and cancel jobs.
<server name><_instance> Notice that when you connect to the
report server rather than the
SharePoint site, the number of tasks
that you can perform is significantly
reduced. This is because the report
server can only return application data
that is stored or managed in the report
server database, and not in the
SharePoint configuration and content
databases.
See Also
Configure a Report Server Database Connection (SSRS Configuration Manager)
Reporting Services in SQL Server Management Studio (SSRS)
Delete an Item (Management Studio)
3/24/2017 1 min to read Edit Online
When connected to a report server instance in SQL Server Management Studio, you can delete role definitions and
shared schedules. You cannot delete reports, models, or other items on a report server. To delete report server
content, use Report Manager instead. Or, if the report server is configured for SharePoint integrated mode, use the
item management features in the SharePoint library that contains your content.
To delete an item in the report server folder namespace
1. In ObjectExplorer, expand a report server node. Navigate to the folder containing the item you want to
delete.
2. Expand the folder.
3. Right-click the item, and click Delete.
4. When prompted, Click OK.
See Also
Connect to a Report Server in Management Studio
Delete Catalog Items (Management Studio)
Reporting Services in SQL Server Management Studio (SSRS)
Report Server in Management Studio F1 Help
3/24/2017 1 min to read Edit Online
This section includes topics about the dialog boxes in SQL Server Management Studio that can be used to
manage report servers.
In This Section
Cancel Report Server Jobs
Delete Catalog Items
Job Properties Page
New Shared Schedule
New System Role
New User Role
Schedule Properties (General Page)
Schedule Properties (Reports Page)
Server Properties (General Page)
Server Properties (Execution Page)
Server Properties (History Page)
Server Properties (Logging Page)
Server Properties (Security Page)
Server Properties (Advanced Page)
System Role Properties
User Role Properties
See Also
Feature Reference (Reporting Services)
Use SQL Server Management Studio
Cancel Report Server Jobs (Management Studio)
3/24/2017 1 min to read Edit Online
Use the Cancel Report Server Jobs dialog box to view or cancel in-progress reports. This dialog box shows all
jobs that are currently running on the report server. Although you cannot pause or restart jobs that are currently
processing, you can cancel all jobs or individual jobs if they are taking too long to complete.
You can cancel user jobs and system jobs.
A user job is any job that is initiated by an individual user. This includes running a report on-demand,
manually creating a report history snapshot, or manually creating report execution snapshot. An in-progress
standard subscription is also a user job.
A system job is one that is initiated by the report server. System jobs include scheduled report processing.
To open this page, start SQL Server Management Studio, connect to a report server, right-click Jobs, and
then click Cancel All Jobs. You can also open Jobs, right-click a job that is running on the report server,
and select Cancel Job(s).
Before cancelling a job, you can view its properties to determine when the job started. For more
information, see Job Properties (Management Studio).
NOTE
This feature is not supported in SQL Server Express with Advanced Services. The page does not appear when you are running
SQL Server Express.
Options
Name
Shows the name of the report. Subscriptions are identified by their descriptions.
Type
Valid values are User and System.
Start Time
Shows when the job started.
User Name
For jobs that are initiated by a user, this column shows the name of the user.
Status
Shows the status of the job. Valid values are New and Running. Status is always New when the job begins. After
60 seconds, status changes to Running. You must refresh the page to pick up the change.
OK
Cancel a single job or multiple jobs. The jobs are cancelled immediately and cannot be resumed. If you mistakenly
cancel a job, you must request the report or subscription again to start a new job.
See Also
Report Server in Management Studio F1 Help
Connect to a Report Server in Management Studio
Manage a Running Process
Delete Catalog Items (Management Studio)
3/24/2017 1 min to read Edit Online
Options
Name
Specifies the name of the item you are deleting.
Type
Shows the type of item you are deleting.
Owner
Shows the name of the owner. In most cases, this is System.
Status
Shows progress information for a delete operation.
Error
Displays an error code if an error occurs while deleting an item.
See Also
Delete an Item (Management Studio)
Report Server in Management Studio F1 Help
Create, Modify, and Delete Schedules
Job Properties (Management Studio)
3/24/2017 1 min to read Edit Online
Use the Job Properties page to view information about an in-progress report or subscription before you cancel it.
To open this page, start SQL Server Management Studio, connect to a report server, and open the Jobs folder.
Right-click a job that is running, and then click Properties.
NOTE
This feature is not supported in SQL Server Express with Advanced Services. The page does not appear when you are running
SQL Server Express.
Tasks
Before you can view information about a job, refresh the page to retrieve information about jobs that are currently
running on the report server:
1. Open the report server folder.
2. Right-click Jobs, and then click Refresh.
3. If a job is listed, right-click the job, and then click Properties.
Options
Job ID
A GUID that is assigned to a job while it is processing. The value is randomly generated each time a report or
subscription runs.
Job Status
Valid values are New and Running. Status is always New when the job begins. After 60 seconds, status changes
to Running. You must refresh the page to pick up the change.
Job Type
Valid values are User and System. A user job is any job that is initiated by an individual user. This includes running
a report on-demand, manually generating a report history snapshot, or manually creating a report execution
snapshot. An in-progress standard subscription is also a user job. A system job is one that is initiated by the report
server. System jobs include report processing that is triggered by a schedule.
Job Action
For reports, this column shows which report execution processes are underway. This value is always Render.
Job Description
Reporting Services does not provide job descriptions by default.
Server Name
Shows the name of the report server that is processing the job. If you configured a scale-out deployment, this
value will show which server is processing the job.
Report Name
Shows the name of the report. Subscriptions are identified by their descriptions.
Report Path
Shows the path of the report in the report server folder hierarchy.
Start Time
Shows when the process started.
User Name
For processes initiated by a user, this column shows the name of the user. For system jobs, this is the name of the
report server.
See Also
Report Server in Management Studio F1 Help
Connect to a Report Server in Management Studio
Manage a Running Process
New Shared Schedule (Management Studio)
4/6/2017 2 min to read Edit Online
Use this page to create a shared schedule to run published reports and subscriptions. Shared schedules can be
used in place of report-specific or subscription-specific schedules. Centralized schedule information and the ability
to pause and resume scheduled operations are two key features that distinguish shared schedules from item-
specific schedules.
Not all frequency combinations can be supported in a single schedule. For example, if you want to run a report at
12:00 P.M. and 4:00 P.M. every Friday, you must create two daily schedules that specify a Friday run date, one with
a start time of 12:00 P.M. and another with a start time of 4:00 P.M.
Schedule processing is based on the local time of the report server that hosts and processes the schedule.
To open this page, start SQL Server Management Studio, connect to a report server, right-click Shared Schedule,
and select New Schedule. To save the schedule, SQL Server Agent service must be running.
NOTE
This feature is not available in every edition of SQL Server. For a list of features that are supported by the editions of SQL
Server, see Features Supported by the Editions of SQL Server 2012 (http://go.microsoft.com/fwlink/?linkid=232473).
Options
Name
Type a name for the shared schedule. This name appears in drop-down lists when users select a shared schedule
for reports and subscriptions. Be sure to provide a descriptive name that fits easily within a list and that easily
distinguishes one shared schedule from another. A name must contain at least one alphanumeric character. It can
also include spaces and some symbols. Do not use the following characters when specifying a name:
;?:@&=+,$/*<>
"/
Begin running this schedule on
Specify a start date for this schedule.
Stop this schedule on
Specify an expiration date for this schedule.
Type
Specifies whether the recurrence pattern is based primarily on hours, days, weeks, or months.
Hour (Recurrence Pattern)
Select options to run a scheduled operation in intervals of an hour (for example, to run a report every 6 hours). You
can specify the interval in hours and minutes.
Day (Recurrence Pattern)
Select options to run a scheduled operation in intervals of days (for example, to run a report every 2 days). You can
specify the interval in days and at the hour and minute you want the schedule to run.
Week (Recurrence Pattern)
Select options to run a scheduled operation in intervals of a week or when the pattern that you want to repeat is
based on weeks (for example, to run a report every other week). You can specify a weekly schedule to the day,
hour, and minute that you want the schedule to run.
Month (Recurrence Pattern)
Select options to run a scheduled operation in intervals of a month or when the pattern that you want to repeat is
based on months. You can specify a monthly schedule to the day, hour, and minute that you want the schedule to
run. You can omit specific months from the schedule.
Once
Select this option to create a schedule that runs only once, on a specific date and time.
See Also
Report Server in Management Studio F1 Help
Connect to a Report Server in Management Studio
Create, Modify, and Delete Schedules
Schedules
Report Server in Management Studio F1 Help
New System Role (Management Studio)
4/6/2017 1 min to read Edit Online
Use this page to create a system-level role definition. A system role definition specifies a set of system-level tasks
that apply to a report server as whole.
NOTE
Role definitions are used only on a report server that runs in native mode. If the report server is configured for SharePoint
integration, this page is not available.
Options
Name
Type the name of the role definition. A role definition name must be unique within the report server namespace. A
name must contain at least one alphanumeric character. It can also include spaces and some symbols. Do not use
the following characters when specifying a name:
;?:@&=+,$/*<>
"/
Description
Provide a description that explains how to use the role and enumerates what the role supports.
Task
Select the system-level tasks that can be performed through this role. You cannot create new tasks or modify the
existing tasks that are supported by Reporting Services. You cannot choose item-level tasks for a system role
definition.
Task Description
Shows a description of the task that enumerates the operations or permissions that the task supports.
See Also
Report Server in Management Studio F1 Help
Role Definitions
New User Role (Management Studio)
4/6/2017 1 min to read Edit Online
Use this page to create an item-level role definition. An item-level role definition is a named collection of tasks that
enumerate the tasks a user can perform in relation to folders, reports, models, resources, and shared data sources.
An example of an item-level role definition is the predefined Browser role that identifies the kinds of actions a
report end user might require for navigating folders and viewing reports.
Role definitions are intended to be few in number. Most organizations only require a few role definitions. However,
if the predefined role definitions are insufficient, you can vary them or create new ones.
NOTE
Role definitions are used only on a report server that runs in native mode. If the report server is configured for SharePoint
integration, this page is not available.
Options
Name
Type the name of the role definition. A role definition name must be unique within the report server namespace. A
name must contain at least one alphanumeric character. It can also include spaces and some symbols. Do not use
the following characters when specifying a name:
;?:@&=+,$/*<>
"/
Description
Type a description that explains how to use the role and enumerates what the role supports.
Task
Select the tasks that can be performed through this role. You cannot create new tasks or modify the existing tasks
that are supported by Reporting Services. Only item-level tasks can be used in an item-level role definition.
Task Description
Shows a description of the task that enumerates the operations or permissions that the task supports.
See Also
Report Server in Management Studio F1 Help
Role Definitions
Schedule Properties (General Page)
3/24/2017 2 min to read Edit Online
Use the Reporting Services page in SQL Server Management Studio to view or modify a shared schedule. Shared
schedules can be used in place of report-specific or subscription-specific schedules. Changes to the schedule are
applied after you save the schedule. Editing a schedule has no effect on jobs that are currently in progress. If you
edit a schedule while it is being used, all currently processing reports and subscriptions triggered from that
schedule will be allowed to finish.
Not all frequency combinations can be supported in a single schedule. For example, if you want to run a report at
12:00 P.M. and 4:00 P.M. every Friday, you must create two daily schedules that specify a Friday run date, one with
a start time of 12:00 P.M. and another with a start time of 4:00 P.M.
Schedule processing is based on the local time of the report server that hosts and processes the schedule.
To open this page: 1) Start SQL Server Management Studio. 2) Connect to a report server. 3) Expand the Shared
Schedules folder. 4) Right-click a shared schedule, and select Properties.
NOTE
This feature is not available in every edition of SQL Server and this page does not appear when you are running an edition
which does not have this feature. For a list of features that are supported by the editions of SQL Server, see Features
supported by the edition in SQL Server 2016.
Options
Name
Specifies the name for the shared schedule.
Begin running this schedule on
Specifies a start date for this schedule.
Stop this schedule on
Specifies an expiration date for this schedule.
Type
Specifies whether the recurrence pattern is based primarily on hours, days, weeks, months, or only runs once.
Hour (Recurrence Pattern)
Specifies options for running a scheduled operation in intervals of an hour (for example, to run a report every 6
hours). You can specify the interval in hours and minutes.
Day (Recurrence Pattern)
Specifies options for running a scheduled operation in intervals of days (for example, to run a report every 2 days).
You can specify the interval in days and at the hour and minute you want the schedule to run.
Week (Recurrence Pattern)
Specifies options for running a scheduled operation in intervals of a week or when the pattern that you want to
repeat is based on weeks (for example, to run a report every other week). You can specify a weekly schedule to the
day, hour, and minute that you want the schedule to run.
Month (Recurrence Pattern)
Specifies options for running a scheduled operation in intervals of a month or when the pattern that you want to
repeat is based on months. You can specify a monthly schedule to the day, hour, and minute that you want the
schedule to run. You can omit specific months from the schedule.
Once
Specifies a schedule that runs only once, on a specific date and time.
See Also
Report Server in Management Studio F1 Help
Connect to a Report Server in Management Studio
Create, Modify, and Delete Schedules
Schedules
Schedule Properties (Reports Page)
3/24/2017 1 min to read Edit Online
Use the Reporting Services schedule properties page in SQL Server Management Studio to view a list of all reports
that use the specific shared schedule. Schedules can be used to refresh report snapshots, generate report history,
trigger a subscription, or expire a cached copy of the report. To find out how the schedule is used, view the
property and subscription information of the report.
Although this page shows each report that uses the shared schedule, it does not indicate how many times the
shared schedule is used within that single report. For example, suppose 20 different subscribers to the Company
Sales report all use the same shared schedule to trigger subscription processing. In this case, the Company Sales
report will only appear once in this list, even though the report has 20 references to the shared schedule.
To open the schedule properties page:
1. Start SQL Server Management Studio.
2. Connect to a report server.
3. Open the Shared Schedules folder.
4. Right-click a shared schedule, select Properties.
5. click Reports.
You can also manage shared schedules from the Site Settings of the Reporting Services Web Portal.
NOTE
This feature is not available in every edition of SQL Server. For a list of features that are supported by the editions of SQL
Server, see Features Supported by the edition of SQL Server 2016.
Options
Folder
Specifies the path of the report.
Report
Specifies the name of the report that uses the schedule.
See Also
Create, Modify, and Delete Schedules
Schedules
Report Server in Management Studio F1 Help
Connect to a Report Server in Management Studio
Configure General Properties for a Report (Report Manager)
Report Server Properties (General Page)
3/24/2017 1 min to read Edit Online
Use this page to view or modify the title used in Report Manager, enable or disable My Reports, select a role
definition for My Reports security, and enable or disable the client print control.
To open this page: 1) Start SQL Server Management Studio 2) Connect to a report server instance. 3) Right-click
the report server name, and then select Properties.
The server mode determines which server properties you can set. If you are managing a report server that is
configured for SharePoint integrated mode, you cannot enable My Reports or set the title for the web portal.
Options
Name
Type a name that appears on top of the web portal. By default, this value is SQL Server Reporting Services. The
name that you specify appears only in Report Manager.
Version
This property is read-only. Specifies the version of SQL Server Reporting Services that you are using.
Edition
This property is read-only. Specifies the current report server instance. Report Manager is not available in every
edition of Microsoft SQL Server. For a list of features that are supported by the editions of SQL Server, see Features
Supported by the Editions of SQL Server 2016.
Authentication Mode
This property is read-only. It identifies the types of authentication requests accepted by the report server instance.
To change the authentication mode, you must edit the RSReportServer.config file. For more information, see
Authentication with the Report Server.
URL
This property is read-only. Specifies the URL to the Report Server Web service. This value is specified in the
Reporting Services Configuration tool. For more information, see Configure a URL (SSRS Configuration Manager).
Enable a My Reports folder for each user
Make My Reports available to users. This option is only available for native mode report servers.
Select the role to apply to each My Reports folder
Specify a role definition to use for My Reports security. The role definition identifies the set of tasks that are
supported in each My Reports folder.
See Also
Set Report Server Properties (Management Studio)
Connect to a Report Server in Management Studio
Enable and Disable My Reports
Report Server in Management Studio F1 Help
Secure My Reports
Server Properties (Execution Page)
3/24/2017 1 min to read Edit Online
Use this page to set a timeout value for report execution. This value applies to all reports that are processed by the
current report server instance. You can override this value for individual reports. The value you specify must
accommodate all report processing that occurs on the report server, plus query processing performed on the
database server when the report server retrieves data that is used in the report.
To open this page, start SQL Server Management Studio, connect to a report server instance, right-click the report
server name, and select Properties. Click Execution to open this page.
Options
Do not timeout report execution
Allow a report server unlimited time to complete report processing.
Limit report execution to the following number of seconds
Set a time constraint on report execution. The time period starts when the report is requested. If the time period
ends before the report is fully processed, the report server cancels the process and any in-process queries to
external data sources.
See Also
Set Report Server Properties (Management Studio)
Connect to a Report Server in Management Studio
Set Report Processing Properties
Setting Time-out Values for Report and Shared Dataset Processing (SSRS)
Report Server in Management Studio F1 Help
Server Properties (History Page)
3/24/2017 1 min to read Edit Online
Use this Reporting Services page in SQL Server Management Studio to set a default value for the number of copies
of report history to retain. The default value provides an initial setting that establishes report history limits for all
reports. You can vary these settings for individual reports.
Report history is a collection of report snapshots that include report data and layout that is current for the report at
the time the snapshot is created. You can use report history to keep a copy of a report as it was on a specific date or
time. You can create and manage report history for individual reports that run on a native mode report server or a
report server that is configured for SharePoint integrated mode.
Report history snapshots are stored in the report server database. If you keep an unlimited number of snapshots,
be sure to periodically check the database size to ensure it is not growing too fast or consuming too much disk
space.
To open this page: 1) Start SQL Server Management Studio. 2) Connect to a report server instance. 3) Right-click
the report server name, and select Properties. 4) Click History to open this page.
Options
Keep an unlimited number of snapshots in report history
Retain all report history snapshots. You must manually delete snapshots to reduce the size of report history.
Limit the copies of report history
Retain a set number of report history snapshots. When the limit is reached, older copies are removed from report
history to make room for newer copies.
If you limit report history later, when the existing report history exceeds the limit you specify, the report server
reduces the existing report history to the new limit. The oldest report snapshots are deleted first. If report history is
empty or below the limit, new report snapshots are added. When the limit is reached, the oldest snapshot is deleted
when a new report snapshot is added.
See Also
Set Report Server Properties (Management Studio)
Connect to a Report Server in Management Studio
Report Server in Management Studio F1 Help
Server Properties (Logging Page)
3/24/2017 1 min to read Edit Online
Use this Reporting Services page in SQL Server Management Studio to set limits on the report execution data that
is collected by a report server. Execution data is stored internally in the report server database. You can track report
activity for report server that runs in native mode or SharePoint integrated mode. If the report server is part of a
scale-out deployment, the report execution log maintains a record of all report activity for the entire deployment in
a single log file.
To open this page: 1) Start SQL Server Management Studio 2) Connect to a report server. 3) Right-click the report
server name and select Properties. 4) Click Logging to open this page.
Options
Enable report execution logging
Click to create and store information about report activity on the server. If this option is enabled, the report server
will track which reports are used, the frequency of report processing, the type of report operation that was
performed, the output format, and who ran the report. For more information about additional data points that are
captured in the log, see Report Server ExecutionLog and the ExecutionLog3 View.
Remove log entries older than this number of days
Specify the number of days after which log entries will be trimmed from the report execution log. The default value
is 60 days.
See Also
Set Report Server Properties (Management Studio)
Connect to a Report Server in Management Studio
Reporting Services Log Files and Sources
Report Server in Management Studio F1 Help
Report Server ExecutionLog and the ExecutionLog3 View
Server Properties (Security Page) - Reporting
Services
3/24/2017 1 min to read Edit Online
Use this Reporting Services page in SQL Server Management Studio to turn off features that can potentially
compromise a report server. Turning off these features will limit some functionality, but can improve the overall
security of the report server by mitigating specific threats.
To open this page: 1) Start SQL Server Management Studio. 2) Connect to a report server instance. 3) Right-click
the report server name, and select Properties. 4) Click Security to open this page.
Options
Enable Windows integrated security for report data sources
Specify whether a connection to a report data source can be made using the Windows security token of the user
who requested the report.
If you turn off this feature, the Windows Integrated Security feature in the report data source property pages will be
unavailable. If report data sources are configured for Windows integrated security and you subsequently turn off
this feature, the report server will immediately update all data source connection properties to prompt for
credentials.
Enable Ad Hoc Reporting
Specify whether users can perform ad hoc queries from a Report Builder report, where new reports are
automatically generated when a user clicks data of interest.
Setting this option determines whether the EnableLoadReportDefinition property on the report server is set to
True or False. If you clear this option, the property will be set to False and report server will not generate
clickthrough reports that are created during data exploration. All calls to the LoadReportDefinition method will
be blocked.
Turning off this option mitigates a threat whereby a malicious user launches a denial of service attack by
overloading the report server with LoadReportDefinition requests.
See Also
Set Report Server Properties (Management Studio)
Connect to a Report Server in Management Studio
Specify Credential and Connection Information for Report Data Sources
Report Server in Management Studio F1 Help
Server Properties (Advanced Page) - Reporting
Services
3/24/2017 4 min to read Edit Online
Use this page to set system properties on the report server. There are a number of ways to set system properties.
This tool provides a graphical user interface so that you can set properties without having to write code.
To open this page, start SQL Server Management Studio, connect to a report server instance, right-click the report
server name, and select Properties. Click Advanced to open this page.
Options
EnableMyReports
Indicates whether the My Reports feature is enabled. A value of true indicates that the feature is enabled.
MyReportsRole
The name of the role used when creating security policies on user's My Reports folders. The default value is My
Reports Role.
EnableClientPrinting
Determines whether the RSClientPrint ActiveX control is available for download from the report server. The valid
values are true and false. The default value is true. For more information about additional settings that are
required for this control, see Enable and Disable Client-Side Printing for Reporting Services.
EnableExecutionLogging
Indicates whether report execution logging is enabled. The default value is true. For more information about the
report server execution log, see Report Server ExecutionLog and the ExecutionLog3 View.
ExecutionLogDaysKept
The number of days to keep report execution information in the execution log. Valid values for this property
include -1 through 2,147,483,647. If the value is -1 entries are not deleted from the Execution Log table. The
default value is 60.
NOTE
Setting a value of 0 will delete all entries from the execution log. A value of -1 will keep the entries of the execution log and
will not be deleted.
SessionTimeout
The length of time, in seconds, that a session remains active. The default value is 600.
SharePointIntegratedMode
This is a read-only property that indicates the server mode. If this value is False, the report server runs in native
mode.
SiteName
The name of the report server site displayed in the page title of the web portal. The default value is SQL Server
Reporting Services. This property can be an empty string. The maximum length is 8,000 characters.
StoredParametersLifetime
Specifies the maximum number of days that a stored parameter can be stored. Valid values are -1, +1 through
2,147,483,647. The default value is 180 days.
StoredParametersThreshold
Specifies the maximum number of parameter values that that can be stored by the report server. Valid values are -
1, +1 through 2,147,483,647. The default value is 1500.
UseSessionCookies
Indicates whether the report server should use session cookies when communicating with client browsers. The
default value is true.
ExternalImagesTimeout
Determines the length of time within which an external image file must be retrieved before the connection is timed
out. The default is 600 seconds.
SnapshotCompression
Defines how snapshots are compressed. The default value is SQL. The valid values are as follows:
SQL = Snapshots are compressed when stored in the report server database. This is the current behavior.
None = Snapshots are not compressed.
All = Snapshots are compressed for all storage options, which include the report server database or the file
system.
SystemReportTimeout
The default report processing timeout value, in seconds, for all reports managed in the report server namespace.
This value can be overridden at the report level. If this property is set, the report server attempts to stop the
processing of a report when the specified time has expired. Valid values are -1 through 2,147,483,647. If the value
is -1, reports in the namespace do not time out during processing. The default value is 1800.
SystemSnapshotLimit
The maximum number of snapshots that are stored for a report. Valid values are -1 through 2,147,483,647. If the
value is -1, there is no snapshot limit.
EnableIntegratedSecurity
Determines whether Windows integrated security is supported for report data source connections. The default is
True. The valid values are as follows:
True = Windows integrated security is enabled.
False = Windows integrated security is not enabled. Report data sources that are configured to use Windows
integrated security will not run.
EnableLoadReportDefinition
Select this option to specify whether users can perform ad hoc report execution from a Report Builder report.
Setting this option determines the value of the EnableLoadReportDefinition property on the report server.
If you clear this option, the property will be set to False and report server will not generate clickthrough reports for
reports that use a report model as a data source. Any calls to the LoadReportDefinition method will be blocked.
Turning off this option mitigates a threat whereby a malicious user launches a denial of service attack by
overloading the report server with LoadReportDefinition requests.
EnableRemoteErrors
Includes external error information (for example, error information about report data sources) with the error
messages that are returned for users who request reports from remote computers. Valid values are true and false.
The default value is false. For more information, see Enable Remote Errors (Reporting Services).
EnableReportDesignClientDownload
Specifies whether Report Builder installation package can be downloaded from the report server. If you clear this
setting, the URL to Report Builder will not work. For more information, see Configure Report Builder Access.
EditSessionCacheLimit
Specifies the number of data cache entries that can be active in a report edit session. The default number is 5.
EditSessionTimeout
Specifies the number of seconds until a report edit session times out. The default value is 7200 seconds (2 hours).
EnableTestConnectionDetailedErrors
Indicates whether detailed error messages are sent to the client computer when users test data source connections
using the report server. The default value is true. If the option is set to false, only generic error messages are sent.
See Also
Set Report Server Properties (Management Studio)
Connect to a Report Server in Management Studio
Reporting Services Properties
Report Server in Management Studio F1 Help
Report Server System Properties
Script Deployment and Administrative Tasks
Enable and Disable My Reports
System Role Properties (Management Studio)
3/24/2017 1 min to read Edit Online
Use the System Roles page to view the system role definitions that are currently defined for the report server. A
system role definition contains a named collection of tasks that are performed relative to the entire site, instead of
an individual item. Role definitions are assigned to a user or groups to create a resulting role assignment. The tasks
in the role definition specify what the user or group can do.
Reporting Services has two predefined system role definitions: System Administrator and System User. You can
modify these role definitions by changing the task list, or you can create a new system role that supports a different
combination of tasks. Editing a role definition affects all role assignments that include the role definition.
NOTE
System role assignments are used only on a report server that runs in native mode. If the report server is configured for
SharePoint integration, this page is not available.
Options
Name
Specifies the name of the system role definition.
Description
Shows a description of the system role definition. In SQL Server Management Studio, this description is only visible
in this page. Users who view this item through Report Manager may see this description when browsing the folder
hierarchy.
Task
Lists all system-level tasks that can be selected for this role definition. You can add or remove items from the
predefined task list to define how users access a given item through this role. You cannot create new tasks, and you
cannot modify existing tasks.
Description
Provides information about each task. You cannot modify task descriptions.
See Also
Report Server in Management Studio F1 Help
System-Level Tasks
Tasks and Permissions
Predefined Roles
User Role Properties (Management Studio)
3/24/2017 1 min to read Edit Online
Use this page to view which tasks are included in an item-level role definition. You can also use this page to change
the task list or modify a role description.
An item-level role definition is a named collection of tasks that users perform relative to a specific item (that is, a
folder, report, resource, or shared data source). Role definitions are assigned to a user or group to create a role
assignment in Report Manager. The tasks in the role definition describe what the user or group can do.
Reporting Services includes a number of predefined item-level role definitions that you can work with. You can
modify the role definitions by changing the task list of each one. Editing a role definition affects all role
assignments that include the role definition.
NOTE
User role assignments are used only on a report server that runs in native mode. If the report server is configured for
SharePoint integration, this page displays read-only information about the roles and permission levels that are defined on
the SharePoint site.
Options
Name
Specifies the name of the role definition.
Description
Shows a description of the role definition. In SQL Server Management Studio, this description is only visible in this
page. In Report Manager, this description helps users decide whether to use the role in a role assignment.
Task
Lists all item-level tasks that can be selected for this role definition. You can add or remove items from the
predefined task list to define how users access a given item through this role. You cannot create new tasks, and you
cannot modify existing tasks. The task list of a role definition appears only in SQL Server Management Studio.
Task Description
Provides information about each task. You cannot modify task descriptions.
See Also
Item-Level Tasks
Role Definitions
Report Server in Management Studio F1 Help
Tasks and Permissions
Predefined Roles
Report Builder authoring environment (SSRS)
3/24/2017 1 min to read Edit Online
Report Builder Report Builder is a stand-alone authoring environment for creating Reporting Services paginated
reports outside of Visual Studio. When you design a report, you specify where to get the data, which data to get,
and how to display the data. When you run the report, the report processor takes all the information you have
specified, retrieves the data, and combines it with the report layout to generate the report. You can install it from
the Reporting Services web portal or from the Microsoft Download Center.
Install Report Builder from the Microsoft Download Center.
See Also
Install Report Builder
Configure Report Builder Access
Reporting Services Tools
Design Reports with Report Designer (SSRS)
Scripting and PowerShell with Reporting Services
3/24/2017 1 min to read Edit Online
Reporting Services supports a wide range of development and management scenarios through script, including the
rs.exe command line utility, PowerShell cmdlets for SharePoint mode report servers, and leveraging the Reporting
Services object model from PowerShell for both Native and SharePoint mode.
Administrators can write script in Microsoft Visual Basic to automate how they deploy and manage a report
server installation. Administrators can also generate and run Transact-SQL scripts that create, configure, and
update a report server database. Administrators can also use the record and playback script features in SQL
Server Management Studio to automate routine maintenance tasks.
Developers can create custom applications that include script. You can run script that makes calls to the
Report Server Web service. Almost any operation that you can write in managed code can also be written in
script.
Reporting Services supports Microsoft Visual Basic .NET script as the script language that can be processed
by the RS.exe utility, a script host that runs on the report server.
Reporting Services SharePoint mode includes Reporting Services cmdlets for report server administration.
PowerShell cmdlets for Reporting Services SharePoint Mode Includes the following examples:
Create a service application and proxy
Review and update a delivery extension
Get and set Properties of the Reporting Service Application Database, for example database timeout
List Data Extensions
PowerShell calling the core object model and for the most part valid for SharePoint and native mode, for example
the migration work, subscription work, and more related samples for subscriptions work in SQL15.
Use PowerShell to Change and List Reporting Services Subscription Owners and Run a Subscription.
Use PowerShell to Create an Azure VM With a Native Mode Report Server.
See the section Access the WMI classes using PowerShell in Access the Reporting Services WMI Provider.
Developers and report server administrators can perform operations on a report server through the use of the rs
utility (RS.exe). Using this utility, you can programmatically administer a report server using scripts written with
Microsoft Visual Basic.
Reporting Services scripts can be used to run any of the Report Server Web service operations. Scripting can be
used to copy security to multiple reports on a server, to add and delete items, to copy report server items from one
server to another and more. For more information about the scripting environment, see Run a Reporting Services
Script File. Script files take a certain format and are written in Visual Basic .NET. For more information, see Format a
Reporting Services Script File.
For script samples, see the following:
Sample Reporting Services rs.exe Script to Copy Content between Report Servers.
SQL Server Reporting Services Product Samples.
See Also
Script Deployment and Administrative Tasks
Report Server Web Service
Technical Reference (SSRS)
RS.exe Utility (SSRS)
Format a Reporting Services Script File
3/24/2017 1 min to read Edit Online
A Reporting Services script is a Microsoft Visual Basic .NET code file, written against a proxy that is built on Web
Service Description Language (WSDL), which defines the Reporting Services SOAP API. A script file is stored as a
Unicode or UTF-8 text file with the extension .rss.
The script file acts as a Visual Basic module and can contain user-defined procedures and module-level variables.
For the script file to run successfully, it must contain a Main procedure. The Main procedure is the first procedure
that is accessed when your script file runs. Main is where you can add your Web service operations and run your
user defined subprocedures. The following code creates a Main procedure:
The script environment automatically connects to the report server, creates the Web proxy class, and generates a
reference variable (rs) to the Web service proxy object. Individual statements that you create need only refer to the
rs module-level variable to perform any of the Web service operations that are available in the Web service library.
The following Visual Basic code calls the Web service ListChildren method from within a script file:
IMPORTANT
User credentials are managed by the script environment and passed through command prompt arguments through the use
of RS.exe. Although you can use the rs variable to set the authentication of the Web service, it is recommended that you use
the script environment. You do not need to authenticate the Web service in the script file itself. For more information about
authenticating the script environment, see RS.exe Utility (SSRS).
You do not declare namespaces within the script file. The scripting environment makes several useful Microsoft
.NET Framework namespaces available to you: System.Web.Services, System.Web.Services.Protocols,
System.Xml, and System.IO.
For script samples, see SQL Server Reporting Services Product Samples.
See Also
Report Server Web Service
Technical Reference (SSRS)
RS.exe Utility (SSRS)
Run a Reporting Services Script File
3/24/2017 1 min to read Edit Online
Reporting Services script files are run from the command prompt using the Reporting Services script environment
(RS.exe). RS.exe has many command prompt arguments available for you to use. For more information about the
command prompt options, see RS.exe Utility (SSRS). For more script samples, see SQL Server Reporting Services
Product Samples.
rs i Script.rss -s http://servername/reportserver
Run Script.rss in the script environment specifying a user name and password for authenticating the Web
service calls:
rs i Script.rss -s http://servername/reportserver -l 30
Run Script.rss in the script environment specifying a global script variable called report.
Run Script.rss in the script environment specifying that the Web service operations in the script file are run
as a batch.
rs i Script.rss -s http://servername/reportserver -b
See Also
Technical Reference (SSRS)
Script Deployment and Administrative Tasks
3/24/2017 9 min to read Edit Online
Reporting Services supports the use of scripts to automate routine installation, deployment, and administrative
tasks. Deploying a report server is a multi-step process. You must use several tools and processes to configure a
deployment; there is no single program or approach that can be used to automate all the tasks.
Not every step should be automated. In some cases, performing a step manually or through a graphical tool is the
simplest and most effective approach. For example, if you want to deploy a large number of reports and models, it
is better to copy the report server databases rather than write code that recreates report server environment.
Some steps require custom code. For example, configuring the URLs for the Web service and Report Manager can
be automated, but only if you write custom code that makes calls into the Report Server Windows Management
Instrumentation (WMI) provider. If you do not want to write code, you must use the Reporting Services
Configuration tool to perform the step.
To run script that configures a report server, you must be a local administrator on the computer that you are
configuring. For more information, see Configure a Report Server for Remote Administration.
This topic describes recommended approaches for automating specific steps. Several programs and programmatic
interfaces are mentioned; descriptions of each one are provided later in this topic.
TASK APPROACH
Install Reporting Services. You can run setup from the command line to perform an
unattended installation.
Configure the service account. The service account is initially configured through Setup. To
automate changes to the service account as a post-Setup
task, you must write custom code that makes calls into the
Report Server WMI provider. There are no command-prompt
utilities or script templates for configuring the service account
programmatically.
Configure the Report Server Web service and Report Manager You must write custom code that makes calls into the Report
URLs. Server WMI provider. There are no command line utilities or
script templates for configuring the URLs.
If you want to avoid writing code, you can configure the URLs
manually by running the Reporting Services Configuration
tool. For more information, see Configure a URL (SSRS
Configuration Manager).
Create the report server database. You must write custom code that makes calls into the Report
Server WMI provider. There are no command-prompt utilities
or script templates for creating the report server databases
and RSExecRole.
Configure the report server database connection. If you are changing the connection string, account or
password, or the authentication type, run the rsconfig utility
to configure the connection. For more information, see
Configure a Report Server Database Connection (SSRS
Configuration Manager) and rsconfig Utility (SSRS).
Configure a scale-out deployment. Choose from the following approaches to automate scale-out
deployment:
Configure Report Server E-mail. Write custom code that runs against the Reporting Services
WMI provider. The provider supports a subset of the e-mail
configuration settings.
Configure the unattended execution account. Choose from the following approaches to automate
unattended processing account configuration:
Deploy existing content on another report server, including The best way to re-create an existing report server
the folder hierarchy, role assignments, reports, subscriptions, environment is to copy the report server database to a new
schedules, data sources, and resources. report server instance.
NOTE
Scripts run under the Microsoft Windows credentials of the user running the script unless credentials are explicitly set.
For more information about how to format and run a script file, see Script with the rs.exe Utility and the Web
Service.
Using Scripts to Set Server Properties
You can write scripts that set system properties on the report server. The following Visual Basic .NET script shows
one way to set properties. This example disables the RSClientPrint ActiveX control, but you can replace
EnableClientPrinting and False with any valid property name and value. To view a complete list of server
properties, see Report Server System Properties.
To use the script, save it to a file that has an .rss extension, and then use the rs.exe command prompt utility to run
the file on the report server. The script is not compiled, so it is not necessary to have an installation of Visual Basic.
This example assumes that you have permissions on the local computer that hosts the report server. If you are not
logged on under an account that has permissions, you must specify account information through additional
command line arguments. For more information, see RS.exe Utility (SSRS).
TIP
For a detailed example, see Sample Reporting Services rs.exe Script to Copy Content between Report Servers.
See Also
GenerateDatabaseCreationScript Method (WMI MSReportServer_ConfigurationSetting)
GenerateDatabaseRightsScript Method (WMI MSReportServer_ConfigurationSetting)
GenerateDatabaseUpgradeScript Method (WMI MSReportServer_ConfigurationSetting)
Install SQL Server 2016 from the Command Prompt
Install Reporting Services Native Mode Report Server
Reporting Services Report Server (Native Mode)
Report Server Command Prompt Utilities (SSRS)
Browser Support for Reporting Services and Power View
Reporting Services Tools
Sample Reporting Services rs.exe Script to Copy Content between Report
Servers
3/24/2017 14 min to read Edit Online
This topic includes and describes a sample Reporting Services RSS script that copies content items and settings from one SQL Server Reporting Services
report server to another report server, using the RS.exe utility. RS.exe is installed with Reporting Services, both native and SharePoint mode. The script copies
Reporting Services items, for example reports and subscriptions, from server to another server. The script supports both SharePoint mode and Native mode
report servers.
||
|-|
| Applies to: Reporting Services SharePoint mode | Reporting Services Native mode|
In this Topic:
To Download the ssrs_migration.rss Script
Supported Scenarios
Items and resources the script migrates
Required Permissions
How to use the script
Parameter Description
More Examples
Native Mode Report Server to Native Mode Report Server
Native Mode to SharePoint Mode root site
Native mode to SharePoint Mode bi site collection
SharePoint Mode to SharePoint Mode bi site collection
Native Mode to Native Mode Windows Azure Virtual Machine
SharePoint Mode bi site collection to a Native Mode Server on Windows Azure Virtual Machine
Verification
Troubleshooting
Supported Scenarios
The script supports both SharePoint mode and Native mode report servers. The script supports the following report server versions:
SQL Server 2016
SQL Server 2014
SQL Server 2012
SQL Server 2008 R2
The script can be used to copy content between report servers of the same mode or different modes. For example, you can run the script to copy
content from a SQL Server 2008 R2 native mode report server to a SQL Server 2012 SP1 SharePoint mode report server. You can run the script from
any server where RS.exe is installed. For example, in the following deployment, you can:
Run RS.exe and the script ON Server A.
To copy content FROM Server B
TO Server C
Server A Native
Server B SharePoint
SERVER NAME REPORT SERVER MODE
Server C SharePoint
For more information on the RS.exe utility, see RS.exe Utility (SSRS).
Items and resources the script migrates
The script will not write over existing content items of the same name. If the script detects items with the same name on the destination server that are on the
source server, the individual items will result in a failure message and the script will continue. The following table lists the types of content and resources
the script can migrate to target report server modes.
History No No
Roles and system policies Yes Yes By default the script will not copy
custom permission schema between
servers. The default behavior is the items
will be coied to the destination server
with the inherit parent permissions flag
set to TRUE. If you want the script to
copy permissions for individual items,
use the SECURITY switch.
Shared data source Yes Yes The script will not overwrite existing
items on the target server. If an item on
the target server already exists with the
same name, you will see an error
message similar to the following:
cache refresh options Yes Yes Dependent settings are migrated as part
of a catalog item. The following is the
sample out of the script as it migrates a
report (.rdl) and related settings such as
cache refresh options:
Required Permissions
The permissions required to read or write items and resources is not the same for all of the methods used in the script. The following table summarizes the
methods used for each item or resource and links to related content. Navigate to the individual topic to see the required permissions. For example the
ListChildren method topic notes the required permissions of:
Native Mode Required Permissions: ReadProperties on Item
SharePoint Mode Required Permissions: ViewListItems
GetProperties SetItemDataSources
GetItemDataSources GetItemReferences
GetItemReferences CreateDataSource
GetDataSourceContents CreateLinkedItem
GetItemLink CreateFolder
GetRoleProperties
ITEM OR RESOURCE SOURCE TARGET
GetSubscriptionProperties CreateDataDrivenSubscription
GetDataDrivenSubscriptionProperties
GetCacheRefreshPlanProperties
For more information, see Compare Roles and Tasks in Reporting Services to SharePoint Groups and Permissions.
Usage notes:
The script runs in two steps.
The first step is an audit, to return a list of items that will be migrated and the second step is the migration process.
You can cancel the script after step one if you only want to see the possible migration list or you want to modify the parameters. Dependent
settings are not listed in step one. For example, the cache options of a report are not listed but the report itself is.
TIP
If you want to just audit a single server, use the same server for source and destination and cancel after step 1
A good use of the step 1 audit information is to review existing roles on both the source and target Native mode server. The following is an example of
the step one audit list. Notice the list includes a roles section because the switch-v security="True" was used:
Retrieve and report the list of items that will be migrated. You can cancel the script after step 1 if you do not want to start the actual
migration.
Retrieving roles:
Role: Browser
Retrieve and report the list of items that will be migrated. You can cancel the script after step 1 if you do not want to start the actual
migration.
Retrieving roles:
Role: Browser
Role: CustomRole
Role: Model Item Browser
Role: My Reports
Role: Publisher
Retrieving schedules:
Schedule: theMondaySchedule
Folder: /images
Resource: /images/R2-D2.png
Folder: /Reports
Report: /Reports/products
Report: /Reports/test
Report: /Reports/TitleOnly
The SOURCE_URL and TARGET_URL must be valid report server URLs that point to the source and target Reporting Services report server. In native
mode, a report server URL looks like the following:
http://servername/reportserver
The virtual folder structure presented to the user in SharePoint might be different than the underlying one. Open
http://servername/_vti_bin/reportserver or http://servername/sites/site_name/_vti_bin/reportserver in a browser to see the non-virtual folder
structure. This is helpful for setting source folder and target folder to something other than "/", for a server in SharePoint mode.
Passwords are not migrated, and must be re-entered, for example data sources with stored credentials.
Parameter Description
PARAMETER DESCRIPTION REQUIRED
-u Domain\password p password Credentials for source server. OPTIONAL, default credentials are used if missing
- v f="SOURCEFOLDER" Set to "/" for migrating everything, or to something like OPTIONAL, default is "/".
"/folder/subfolder" for partial migration. Everything
within this folder will be copied
-v tu="domain\username" -v tp="password" 'Credentials for target server. OPTIONAL, default credentials are used if missing.
Note: the user will be listed as the creator of shared
schedules and modified by account for report items, in
the target server.
PARAMETER DESCRIPTION REQUIRED
-v tf ="TARGETFOLDER" 'Set to "/" for migrating into the root level. Set to OPTIONAL, default is "/".
"/folder/subfolder" to copy into a that already exists.
Everything within "SOURCEFOLDER" will be copied into
"TARGETFOLDER.
-v security= "True/False" If set to False, destination catalog items will inherit OPTIONAL, default is False.
security setting according to the settings of the target
system. This is the recommended setting for migrations
between different report server types, for example
native mode to SharePoint mode. If set to True, the
script attempts to migrate security settings.
More Examples
Native Mode Report Server to Native Mode Report Server
The following example migrates content from the native mode Sourceserver to the native mode Targetserver.
TIP
For information on how to use Windows PowerShell to create Reporting Services report servers on Windows Azure virtual machines, see Use PowerShell to Create a
Windows Azure VM With a Native Mode Report Server.
SharePoint Mode bi site collection to a Native Mode Server on Windows Azure Virtual
Machine
The following example migrates content:
From a SharePoint mode report server SourceServer that contains a site collection of "sites/bi" and a shared documents library.
To a TargetServer Native mode report server running on a Windows Azure virtual machine. The TargetServer is not joined to the domain of the
SourceServer and the User2 is an administrator on the Windows Azure virtual machine TargetServer.
Verification
The section summarizes some of the steps to take on the destination server to verify content and policies were successfully migrated.
Schedules
To verify schedules on the target server:
Native Mode
1. Browse to Report Manager on the destination server.
2. Click Site Settings on the top menu.
3. Click Schedules in the left pane.
SharePoint Mode:
4. Browse to Site settings.
5. In the Reporting Services group, click Manage Shared Schedules.
Roles and Groups
Native Mode
1. Open SQL Server Management Studio and connect to your native mode report server.
2. In Object Explorer click Security.
3. Click Roles.
Troubleshooting
Use the trace flag t to receive more information. For example, if you run the script and see a message similar to the following
Could not connect to server: http://<servername>/ReportServer/ReportService2010.asmx
Run the script again with the t flag, to see a message similar to the following:
System.Exception: Could not connect to server: http://<servername>/ReportServer/ReportService2010.asmx ---> System.Net.WebException: The
request failed with HTTP status 401: Unauthorized. at System.Web.Services.Protocols.SoapHttpClientProtocol.ReadResponse(SoapClientMessage
message, WebResponse response, Stream responseStream, Boolean asyncCall) at
System.Web.Services.Protocols.SoapHttpClientProtocol.Invoke(String methodName, Object[] parameters) at
Microsoft.SqlServer.ReportingServices2010.ReportingService2010.IsSSLRequired() at
Microsoft.ReportingServices.ScriptHost.Management2010Endpoint.PingService(String url, String userName, String password, String domain, Int32
timeout) at Microsoft.ReportingServices.ScriptHost.ScriptHost.DetermineServerUrlSecurity() --- End of inner exception stack trace ---
See Also
RS.exe Utility (SSRS)
Compare Roles and Tasks in Reporting Services to SharePoint Groups and Permissions
Access the Reporting Services WMI Provider
3/24/2017 3 min to read Edit Online
The Reporting Services WMI provider exposes two WMI classes for administration of Native mode report server
instances through scripting:
IMPORTANT
Starting with the SQL Server 2012 release, the WMI provider is supported for only native mode report servers. SharePoint
mode report servers can be managed with SharePoint Central Administration pages and PowerShell scripts.
An instance of each of the above classes is created for each report server instance. You can use any Microsoft or
third party tools to access the WMI objects exposed by the report server, including WMI programming interfaces
exposed by the .NET Framework itself. This topic describes how to access and use the WMI class instances with the
PowerShell command Get-WmiObject.
This command syntax outputs all class property names and values. Note that all instances of the class
MSReportServer_ConfigurationSetting is returned, even though you are accessing the class in the namespace of
the default report server instance (RS_MSSQLSERVER). For example, if myrshost is installed with the default report
server instance and a named report server instance called SHAREPOINT, this command will return two WMI
objects and output the property names and values for both report server instances.
To return a specific class instance when multiple instances are returned, use the Filter parameter to filter the
results based on properties with unique values such as InstanceName. For example, to return only the WMI object
for the default report server instance, use the following command:
See Also
Reporting Services WMI Provider Library Reference (SSRS)
RsReportServer.config Configuration File
Report Server Command Prompt Utilities (SSRS)
3/24/2017 1 min to read Edit Online
SQL Server Reporting Services includes several command line utilities that you can use to administer a report
server. These utilities are installed automatically when you install a report server.
SUPPORTED DEPLOYMENT
NAME COMMAND FILE MODE DESCRIPTION
RSS utility rs.exe Native mode and SharePoint The rs utility is a script host
mode. The SQL Server 2008 that you can use to perform
R2 release introduced scripted operations. Use this
SharePoint mode support. tool to run Microsoft Visual
Basic scripts that copy data
between report server
databases, publish reports,
create items in a report
server database, and more.
To learn more about using
scripts to administer a
server, see Script
Deployment and
Administrative Tasks.
NOTE
If you prefer to use a tool that has a graphical user interface, you can use the Reporting Services Configuration manager
instead of rsconfig and rskeymgmt.
See Also
Reporting Services Configuration Manager (Native Mode)
Reporting Services Tools
Reporting Services Report Server (Native Mode)
rskeymgmt Utility (SSRS)
3/24/2017 7 min to read Edit Online
Extracts, restores, creates, and deletes the symmetric key used to protect sensitive report server data against
unauthorized access. This utility is also used to join report server instances in a scale-out deployment. A report
server scale-out deployment refers to multiple report server instances that share a single report server database.
Syntax
rskeymgmt {-?}
{eextract}
{aapply}
{-ddeleteall}
{srecreatekey}
{rremoveinstancekey}
{-jjoinfarm}
{-iinstance}
{-ffile}
{-pencryptionpassword}
{-mremotecomputer}
{-ninstancenameofremotecomputer}
{-uadministratoruseraccount}
{-vadministratorpassword}
{-ttrace}
Arguments
-?
Displays the syntax of rskeymgmt arguments.
-e
Extracts the symmetric key used to encrypt and decrypt data for the report server instance so that you can copy it
to a file.
This argument does not take a value. However, you must include additional arguments on the command line to
complete the extraction. The arguments that you must specify include -f and-p.
-a
Replaces an existing symmetric key with a copy that you provide in a password protected backup file. All instances
of the symmetric key are updated.
This argument does not take a value. However, you must include additional arguments on the command line to
select the file that contains the key to be applied. The arguments that you can specify include -f and-p.
-d
Deletes all symmetric key instances and all encrypted data in a report server database. This argument does not take
a value.
-s
Generates a new symmetric key and re-encrypts all encrypted content using the new key. All instances of the
symmetric key are regenerated.
-j
Configures a remote report server instance to share the report server database that is used by the local report
server instance.
-r installationID
Removes the symmetric key information for a specific report server instance, thereby removing the report server
from a scale-out deployment. The installationID is a GUID value that can be found in the RSReportserver.config file.
-f file
Specifies a fully qualified path to the file that stores a backup copy of the symmetric keys.
For rskeymgmt -e, the symmetric key is written to the file you specify.
For rskeymgmt -a, the symmetric key value stored in the file is applied to the report server instance.
-p password
(Required for -f) Specifies the password used to back up or apply a symmetric key. This value cannot be empty.
-i
Specifies a local report server instance. This argument is optional if you installed the report server on the default
SQL Server instance (the default value for -i is MSSQLSERVER). If you installed the report server as a named
instance, -i is required.
-m
Specifies the name of the remote computer that hosts the report server instance you are joining to the report
server scale-out deployment. Use the name of the computer that identifies it on your network.
-n
Specifies the name of the report server instance on a remote computer. This argument is optional if you installed
the report server on the default SQL Server instance (the default value for -n is MSSQLSERVER). If you installed the
report server as a named instance, -n is required.
-u useraccount
Specifies the administrator account on the remote computer that you are joining to the scale-out deployment. If an
account is not specified, the credentials of the current user are used.
-v password
(Required for -u) Specifies the password of an administrator account on the remote computer that you want to join
to the scale-out deployment.
-t trace
Outputs error messages to the trace log. This argument does not take a value. For more information, see Report
Server Service Trace Log.
Permissions
You must be a local administrator to run the tool, and you must run it locally on the computer that hosts the report
server. The rskeymgmt utility works with the local Report Server Windows instance (the utility cannot connect to
remote instances of the Report Server Windows service so it cannot be used to manage the encryption keys of a
remote report server instance).
NOTE
If you are using the -u and -v arguments, be sure to specify an account that has administrator permissions on the remote
computer.
Examples
The following examples illustrate ways of using rskeymgmt. The following examples show how to extract, restore,
and delete encryption keys, and how to configure a report server scale-out deployment.
Extracting Encryption Keys
This example shows how to create a backup copy of the encryption key and save it to a password-protected file on
a floppy disk. If the report server is installed as a named instance, add the -i argument.
rskeymgmt -d
NOTE
A report server scale-out deployment refers to a deployment model where multiple report server instances share the same
report server database. A report server database can be used by any report server instance that stores its symmetric keys in
the database. For example, if a report server database contains key information for three report server instances, all three
instances are considered to members of the same scale-out deployment.
rskeymgmt -r <installationID>
File Location
Rskeymgmt.exe is located at <drive>:\Program Files\Microsoft SQL Server\110\Tools\Binn or at
<drive>:\Program Files (x86)\Microsoft SQL Server\110\Tools\Binn. You can run the utility from any folder
on your file system.
Remarks
A report server encrypts stored credentials and connection information. A public key and a symmetric key are used
to encrypt data. A report server database must have valid keys in order for the report server to run. You can use
rskeymgmt to back up, delete, or restore the keys. If the keys cannot be restored, this tool provides a way to delete
encrypted content that can no longer be used.
The rskeymgmt utility is used to manage the key set that is defined during Setup or during initialization. It
connects to the local Report Server Windows service through a Remote Procedure Call (RPC) endpoint. The Report
Server Windows service must be running in order for this utility to work.
For more information about the encryption keys, see Configure and Manage Encryption Keys (SSRS Configuration
Manager) and Initialize a Report Server (SSRS Configuration Manager).
See Also
Scale-out Deployment - Reporting Services Native mode (Configuration Manager)
Reporting Services Report Server (Native Mode)
Report Server Command Prompt Utilities (SSRS)
Configure and Manage Encryption Keys (SSRS Configuration Manager)
rsconfig Utility (SSRS)
3/24/2017 5 min to read Edit Online
The rsconfig.exe utility encrypts and stores connection and account values in the RSReportServer.config file.
Encrypted values include report server database connection information and account values used for unattended
report processing.
Syntax
rsconfig {-?}
{cconnection}
{eunattendedaccount}
{mcomputername}
{iinstancename}
{sservername}
{ddatabasename}
{aauthmethod}
{-uusername}
{-ppassword}
{-ttrace}
Arguments
TERM OPTIONAL/REQUIRED DEFINITION
-m computername Required if you are configuring a Specifies the name of the computer that
remote report server instance. is hosting the report server. If this
argument is omitted, the default is
localhost.
-i instancename Required if you are using named If you used a named SQL Server
instances. instance to host the report server
database, this value specifies the named
instance.
-u [domain\]username Required with -e Optional with -c. Specifies a user account for the report
server database connection or for the
unattended account.
Permissions
You must be a local administrator on the computer that hosts the report server you are configuring.
File Location
Rsconfig.exe is located in \Program Files\Microsoft SQL Server\110\Tools\Binn. You can run the utility from
any folder on your file system.
Remarks
Rsconfig.exe is used for two purposes:
To modify the connection information that a report server uses to connect to a report server database.
To configure a special account that the report server uses to log on to a remote database server when other
credentials are not available.
You can run thersconfig utility on a local or remote instance of Reporting Services. You cannot use the
rsconfig utility to decrypt and view values that are already set.
Before you can run this utility, Windows Management Instrumentation (WMI) must be installed on the
computer that you are configuring.
Examples
The following examples illustrate ways of using rsconfig.
Specifying a Domain User Account
This example shows how to configure a report server to use a domain user account when connecting to a local
report server database.
See Also
Configure a Report Server Database Connection (SSRS Configuration Manager)
Configure the Unattended Execution Account (SSRS Configuration Manager)
Reporting Services Report Server (Native Mode)
Store Encrypted Report Server Data (SSRS Configuration Manager)
Reporting Services Configuration Files
Report Server Command Prompt Utilities (SSRS)
RsReportServer.config Configuration File
RS.exe Utility (SSRS)
3/24/2017 4 min to read Edit Online
The rs.exe utility processes script that you provide in an input file. Use this utility to automate report server
deployment and administration tasks.
NOTE
Beginning with SQL Server 2008 R2, the rs utility is supported against report servers that are configured for SharePoint
integrated mode as well as servers configured in native mode. Previous versions only supported native mode
configurations.
In this topic:
File Location
Arguments
Permissions
Examples
Syntax
rs {-?}
{-i input_file=}
{-s serverURL}
{-u username}
{-p password}
{-e endpoint}
{-l time_out}
{-b batchmode}
{-v globalvars=}
{-t trace}
File Location
RS.exe is located at \Program Files\Microsoft SQL Server\110\Tools\Binn. You can run the utility from any
folder on your file system.
Arguments
-?
(Optional) Displays the syntax of rs arguments.
-i input_file
(Required) Specifies the .rss file to execute. This value can be a relative or fully qualified path to the .rss file.
-s serverURL
(Required) Specifies the Web server name and report server virtual directory name to execute the file against. An
example of a report server URL is http://examplewebserver/reportserver . The prefix http:// or https:// at the
beginning of the server name is optional. If you omit the prefix, the report server script host tries to use https
first, and then uses http if https does not work.
-u [domain\]username
(Optional) Specifies a user account used to connect to the report server. If -u and -p are omitted, the current
Windows user account is used.
-p password
(Required if -u is specified) Specifies the password to use with the -u argument. This value is case-sensitive.
-e
(Optional) Specifies the SOAP endpoint against which the script should run. Valid values are the following:
Mgmt2010
Mgmt2006
Mgmt2005
Exec2005
If a value is not specified, the Mgmt2005 endpoint is used. For more information about the SOAP
endpoints, see Report Server Web Service Endpoints.
-l time_out
(Optional) Specifies the number of seconds that elapse before the connection to the server times out. The
default is 60 seconds. If you do not specify a time-out value, the default is used. A value of 0 specifies that
the connection never times out.
-b
(Optional) Specifies that the commands in the script file run in a batch. If any commands fail, the batch is
rolled back. Some commands cannot be batched, and those run as usual. Only exceptions that are thrown
and are not handled within the script result in a rollback. If the script handles an exception and returns
normally from Main, the batch is committed. If you omit this parameter, the commands run without
creating a batch. For more information, see Batching Methods.
-v globalvar
(Optional) Specifies global variables that are used in the script. If the script uses global variables, you must
specify this argument. The value that you specify must be valid for global variable defined in the .rss file.
You must specify one global variable for each v argument.
The -v argument is specified on the command line and is used to set the value for a global variable that is
defined in your script at run time. For example, if your script contains a variable named parentFolder, you
can specify a name for that folder on the command line:
rs.exe -i myScriptFile.rss -s http://myServer/reportserver -v parentFolder="Financial Reports"
Global variables are created with the names given and set to the values supplied. For example, -v a="1" -v
b="2" results in a variable named a with a value of"1" and a variable b with a value of "2".
Global variables are available to any function in the script. A backslash and quotation mark (\") is
interpreted as a double quotation mark. The quotation marks are required only if the string contains a
space. Variable names must be valid for Microsoft Visual Basic; they must start with alphabetical character
or underscore and contain alphabetical characters, digits, or underscores. Reserved words cannot be used
as variable names. For more information about using global variables, see Built-in Collections in
Expressions (Report Builder and SSRS).
-t
(Optional) Outputs error messages to the trace log. This argument does not take a value. For more
information, see Report Server Service Trace Log.
Permissions
To run the tool, you must have permission to connect to the report server instance you are running the script
against. You can run scripts to make changes to the local computer or a remote computer. To make changes to a
report server installed on a remote computer, specify the remote computer in the -s argument.
Examples
The following example illustrates how to specify the script file that contains Visual Basic .NET script and Web
service methods that you want to execute.
rs i c:\scriptfiles\script_copycontent.rss -s http://localhost/reportserver
For a detailed example, see Sample Reporting Services rs.exe Script to Copy Content between Report Servers.
For additional examples, see Run a Reporting Services Script File
Remarks
You can define scripts to set system properties, publish reports, and so forth. The scripts that you create can
include any methods of the Reporting Services API. For more information about the methods and properties
available to you, see Report Server Web Service.
The script must be written in Visual Basic .NET code, and stored in a Unicode or UTF-8 text file with an .rss file
name extension. You cannot debug scripts with the rs utility. To debug a script, run the code within Microsoft
Visual Studio.
TIP
For a detailed example, see Sample Reporting Services rs.exe Script to Copy Content between Report Servers.
See Also
Run a Reporting Services Script File
Script Deployment and Administrative Tasks
Script with the rs.exe Utility and the Web Service
Report Server Command Prompt Utilities (SSRS)
Tutorial: How to Locate and Start Reporting Services
Tools (SSRS)
4/14/2017 6 min to read Edit Online
This tutorial introduces the tools used to configure a report server, manage report server content and operations,
and create and publish paginated and mobile Reporting Services reports. If you are already familiar with the tools,
you can move on to other tutorials to learn skills for using Reporting Services. For other tutorials, see Reporting
Services Tutorials (SSRS).
Or
Click Start, then click Programs, then click Microsoft SQL Server 2016, then click Configuration Tools,
and then click Reporting Services Configuration Manager.
The Report Server Installation Instance Selection dialog box appears so that you can select the report
server instance you want to configure.
2. In Server Name, specify the name of the computer on which the report server instance is installed. The
name of the local computer is specified by default, but you can also type the name of a remote SQL Server
instance.
If you specify a remote computer, click Find to establish a connection. The report server must be configured
for remote administration in advance. For more information, see Configure a Report Server for Remote
Administration.
3. In Instance Name, choose the SQL Server Reporting Services instance that you want to configure. Only
SQL Server 2008, SQL Server 2008 R2, and SQL Server 2016 report server instances appear in the list. You
cannot configure earlier versions of Reporting Services.
4. Click Connect.
5. To verify that you launched the tool, compare your results to the following image:
Next Steps: Configure and Administer a Report Server (SSRS Native Mode) and Reporting Services
Configuration Manager (Native Mode).
Management Studio
Report server administrators can use Management Studio to manage a report server alongside other SQL Server
component servers. For more information, see Use SQL Server Management Studio.
To Start SQL Server Management Studio
1. From the Windows Start Screen type sql server and in the Apps search results, click SQL Server
Management Studio.
Or
Click Start, then click All Programs, then click Microsoft SQL Server 2016, and then click SQL Server
Management Studio. The Connect to Server dialog box appears.
2. If the Connect to Server dialog box does not appear, in Object Explorer, click Connect and then select
Reporting Services.
3. In the Server type list, select Reporting Services. If Reporting Services is not on the list, it is not installed.
4. In the Server name list, select a report server instance. Local instances appear in the list. You can also type
the name of a remote SQL Server instance.
5. Click Connect. You can expand the root node to set server properties, modify role definitions, or turn off
report server features.
SQL Server Data Tools with Report Designer and Report Wizard
You have a choice of two different tools for creating SQL Server paginated reports: Report Designer and Report
Builder.
Report Designer is available in SQL Server Data Tools (SSDT) - Visual Studio. The Report Designer design surface
includes tabbed windows, wizards, and menus used to access report authoring features. The report designer tool
becomes available when you choose a Report Server Project or a Report Server Wizard template in SQL Server
Data Tools (SSDT). To learn more, see Reporting Services in SQL Server Data Tools (SSDT).
Download SQL Server Data Tools.
To start Report Designer
1. Open SQL Server Data Tools.
2. On the File menu, point to New, and then click Project.
3. In the Project Types list, click Business Intelligence Projects.
4. In the Templates list, click Report Server Project. The following diagram shows how the project templates
appear in the dialog box:
5. Type a name and location for the project, or click Browse and select a location.
6. Click OK. SQL Server Data Tools (SSDT) opens with the Visual Studio start page. Solution Explorer provides
categories for creating reports and data sources. You can use these categories to create new reports and
data sources. Tabbed windows appear when you create a report definition. The tabbed windows are Data,
Layout, and Preview..
To get started on your first report, see Create a Basic Table Report (SSRS Tutorial). To learn more about
query designers you can use within Report Designer, see Query Design Tools (SSRS).
Report Builder
Report Builder in SQL Server 2016 is a stand-alone application you can use to create paginated reports outside
SQL Server. You can customize and update all existing reports, regardless of whether they were created in Report
Designer or in previous versions of Report Builder. You can install it from the SQL Server web portal or from the
Microsoft Download Center.
Download Report Builder from the Microsoft Download Center.
To start Report Builder
1. In the SQL Server web portal, on the New menu, select Paginated Report.
2. If Report Builder isn't installed on this computer yet, select Get Report Builder.
Or
Download Report Builder from the Microsoft Download Center.
3. Report Builder opens and you can create or open a paginated report.
2. If Mobile Report Publisher isn't installed on this computer yet, select Get Mobile Report Publisher.
Or
Download SQL Server Mobile Report Publisher from the Microsoft Download Center.
3. Mobile Report Publisher opens and you can create or open a mobile report.
See Also
Download SQL Server Mobile Report Publisher
Download Report Builder
Download SQL Server Data Tools
Install Reporting Services SharePoint Mode
Reporting Services Report Server
Query Design Tools (SSRS)
Reporting Services Tutorials (SSRS)