
Extensions (RSReportServer.config file)
Extensions specifies configuration settings for the following extensible modules of a Reporting Services installation:
-
Delivery extensions
-
DeliveryUI extensions
-
Rendering extensions
-
Data processing extensions
-
Semantic query extensions (internal only)
-
Model generation extensions (internal only)
-
Security extensions
-
Authentication extensions
-
Event processing extensions (internal only)
-
Report definition customization extensions
Some of these extensions are strictly for internal use by the report server. Configuration settings for internal-use-only extensions are not documented. The following sections describe configuration settings for the default extensions. If you are using report server that has custom extensions, your configuration files might contain settings that are not described here. This section lists the extensions in the order in which they appear. Settings that occur repeatedly for multiple instances of the same kind of extension are described once.
Delivery
Specifies default (and possibly custom) delivery extensions used to deliver reports through subscriptions. The RSReportServer.config file includes application settings for four delivery extensions: report server e-mail, file share delivery, report server document library used for a report server that runs in SharePoint integrated mode, and the null delivery provider used to preload the report cache. For more information about delivery extensions, see Subscription and Delivery (Reporting Services).
All delivery extensions have Extension Name, MaxRetries, SecondsBeforeRetry, and Configuration. These shared settings are documented first. Descriptions of extension-specific settings follow in a second table.
|
Setting
|
Description
|
|---|
|
Extension Name
|
Specifies a friendly name and assembly of the delivery extension. Do not modify this value.
|
|
MaxRetries
|
Specifies the number of times a report server will retry a delivery if the first attempt does not succeed. The default value is 3.
|
|
SecondsBeforeRetry
|
Specifies the interval of time (in seconds) between each retry attempt. The default value is 900.
|
|
Configuration
|
Contains the configuration settings that are specific to each delivery extension.
|
File Share Delivery Configuration Settings
File Share delivery sends a report that has been exported to an application file format to a shared folder on the network. For more information, see File Share Delivery in Reporting Services.
|
Setting
|
Description
|
|---|
|
ExcludedRenderFormats, RenderingExtension
|
These settings are used to intentionally exclude export formats that do not work well with file share delivery. HTMLOWC, RGDI, and Null delivery extensions are excluded. These formats are typically used for interactive reporting, preview, or to preload the report cache. They do not produce application files that can be easily viewed from a desktop application.
|
Report Server E-mail Configuration Settings
Report Server Email uses an SMTP network device to send reports to e-mail addresses. This delivery extension must be configured before it can be used. For more information, see Configuring a Report Server for E-Mail Delivery and E-Mail Delivery in Reporting Services.
|
Setting
|
Description
|
|---|
|
SMTPServer
|
Specifies a string value indicating the address of a remote SMTP server or forwarder. This value is required for remote SMTP service. It can be an IP address, a UNC name of a computer on your corporate intranet, or a fully qualified domain name.
|
|
SMTPServerPort
|
Specifies an integer value indicating the port on which the SMTP service uses to send outgoing mail. Port 25 is typically used to send e-mail.
|
|
SMTPAccountName
|
Contains a string value that assigns Microsoft Outlook Express account name. You can set this value if your SMTP server is configured to use it in some way; otherwise you can leave it blank. Use From to specify an e-mail account used to send reports.
|
|
SMTPConnectionTimeout
|
Specifies an integer value indicating the number of seconds to wait for a valid socket connection with the SMTP service before timing out. The default is 30 seconds, but this value is ignored if SendUsing is set to 2.
|
|
SMTPServerPickupDirectory
|
Specifies a string value indicating the pickup directory for the local SMTP service. This value must be a fully qualified local folder path (for example, d:\rs-emails).
|
|
SMTPUseSSL
|
Specifies a Boolean value that can be set to use Secure Sockets Layer (SSL) when sending an SMTP message over the network. The default value is 0 (or false). This setting can be used when the SendUsing element is set to 2.
|
|
SendUsing
|
Specifies which method to use for sending messages. Valid values are:
1=Sends a message from the local SMTP service pickup directory.
2=Sends the message from the network SMTP service.
|
|
SMTPAuthenticate
|
Specifies an integer value that indicates the kind of authentication to use when sending messages to an SMTP service over a TCP/IP connection. Valid values are:
0=No authentication.
1= (not supported).
2= NTLM (NT LanMan) authentication. The security context of the Report Server Windows service is used to connect to the network SMTP server.
|
|
From
|
Specifies an e-mail address from which reports are sent in the format abc@host.xyz. The address appears on the From line of an outgoing e-mail message. This value is required if you are using a remote SMTP server. It should be a valid e-mail account that has permission to send mail.
|
|
EmbeddedRenderFormats, RenderingExtension
|
Specifies the rendering format used to encapsulate a report within the body of an e-mail message. Images within the report are subsequently embedded within the report. Valid values are MHTML and HTML4.0.
|
|
PrivilegedUserRenderFormats
|
Specifies rendering formats that a user can select from for a report subscription when subscribing is enabled through the "Manage all subscriptions" task. If this value is not set, all render formats that are not intentionally excluded are available to use.
|
|
ExcludedRenderFormats, RenderingExtension
|
Purposely excludes formats that do not work well with a given delivery extension. By default, HTMLOWC, RGDI, and Null delivery extensions are excluded for e-mail delivery and file share delivery. You cannot exclude multiple instances of the same rendering extension. Excluding multiple instances will result in an error when the report server reads the configuration file.
|
|
SendEmailToUserAlias
|
This value works with DefaultHostName.
When SendEmailToUserAlias is set to True, users who define individual subscriptions are automatically specified as recipients of the report. The To field is hidden. If this value is False, the To field is visible. Set this value to True if you want maximum control over report distribution. Valid values include the following:
True=The e-mail address of the user creating the subscription is used. This is the default value.
False=Any e-mail address can be specified.
|
|
DefaultHostName
|
This value works with SendEmailToUserAlias.
Specifies a string value indicating the host name to append to the user alias when the SendEmailToUserAlias is set to true. This value can be a Domain Name System (DNS) name or IP address.
|
|
PermittedHosts
|
Limits report distribution by explicitly specifying which hosts can receive e-mail delivery. Within PermittedHosts, each host is specified as a HostName element, where the value is either an IP address or a DNS name.
Only e-mail accounts defined for the host are valid recipients. If you specified DefaultHostName, be sure to include that host as HostName element of PermittedHosts. This value must be one or more DNS names or IP addresses. By default, this value is not set. If the value is not set, there are no restrictions on who can receive e-mailed reports.
|
Report Server Document Library
Report Server Document Library sends a report that has been exported to an application file format to a document library. This delivery extension can only be used by a report server that is configured to run in SharePoint integrated mode. For more information, see SharePoint Library Delivery in Reporting Services.
|
Setting
|
Description
|
|---|
|
ExcludedRenderFormats, RenderingExtension
|
These settings are used to intentionally exclude export formats that do not work well with document library delivery. HTMLOWC, RGDI, and Null delivery extensions are excluded. These formats are typically used for interactive reporting, preview, or to preload the report cache. They do not produce application files that can be easily viewed from a desktop application.
|
NULL
The NULL delivery provider is used to preload the cache with pre-generated reports for individual users. There are no configuration settings for this delivery extension. For more information, see Report Caching in Reporting Services.
DeliveryUI
Specifies delivery extensions that contain a user interface component that appears in the subscription definition pages used when defining individual subscriptions in Report Manager. If you create and deploy a custom delivery extension that has user-defined options and you want to use Report Manager, you must register the delivery extension in this section. By default, there are configuration settings for Report Server E-mail and Report Server File Share. Delivery extensions used only in data-driven subscriptions or in SharePoint application pages do not have settings in this section.
|
Setting
|
Description
|
|---|
|
DefaultDeliveryExtension
|
This setting determines which delivery extension appears first in the list of delivery types in the subscription definition page. Only one delivery extension can contain this setting. Valid values include True or False. When this value is set to True, that extension is default selection.
|
|
Configuration
|
Specifies configuration options for a delivery extension. You can set a default rendering format for each delivery extension. Valid values are the rendering extension names noted in the render section of the rsreportserver.config file.
|
|
DefaultRenderingExtension
|
Specifies whether a delivery extension is the default. Report Server E-Mail is the default delivery extension. Valid values include True or False. If more than one extension contains a value of True, the first extension is considered the default extension.
|
Render
Specifies default (and possibly custom) rendering extensions used in report presentation. Default rendering extensions include XML, NULL, CSV, PDF, RGDI, HTML4.0, MHTML, EXCEL, RPL, and IMAGE. For information about the attributes for the child <Extension> element under <Render>, see Deploying a Rendering Extension. Do not modify this section unless you are deploying a custom rendering extension. For more information, see Implementing a Rendering Extension.
Data
Specifies default (and possibly custom) data processing extensions used to process queries. Default data processing extensions include SQL, OLEDB, OLEDB-MD, ORACLE, ODBC, XML, SAPBW, ESSBASE, SSIS, and SAP. Do not modify this section unless you are adding custom data processing extensions. For more information, see Implementing a Data Processing Extension. For instructions about how to configure a report server to use "off the shelf" data processing extensions that are not specified in the RSReportServer.config file by default, see Configuring Data Processing Extensions in Reporting Services.
Semantic Query
Specifies semantic query processing extension used to process report models. The semantic query processing extensions included with Reporting Services provide support for SQL Server relational data, Oracle, and Analysis Services multidimensional data. Do not modify this section. Query processing is not extensible.
ModelGeneration
Specifies a model generation extension used to create report models from a shared data source that is already published on a report server. You can generate models for SQL Server relational data, Oracle, and Analysis Services multidimensional data sources. Do not modify this section. Model generation is not extensible.
Security
Specifies the authorization component used by Reporting Services. This component is used by the authentication extension registered in the Authentication element of the RSReportServer.config file. Do not modify this section unless you are implementing a custom authentication extension. For more information about adding custom security features, see Implementing a Security Extension. For more information about authorization, see Authorization in Reporting Services.
Authentication
EventProcessing
Specifies default event handlers. Do not modify this section. This section is not extensible.
ReportDefinitionCustomization