• Article

Deploying a Delivery Extension

Delivery extensions supply their configuration information in the form of an XML configuration file. The XML file conforms to the XML schema defined for delivery extensions. Delivery extensions provide infrastructure for setting and modifying the configuration file.

If a delivery extension is replaced or upgraded, all subscriptions that reference the delivery extension remain valid.

After you have written and compiled your Reporting Services delivery extension into a Microsoft .NET Framework library, you must copy the extension to the appropriate directory and add an entry to the appropriate Reporting Services configuration file so the report server can locate it.

Configuration-File Extension Element

Delivery extensions that you deploy to the report server need to be entered as Extension elements in the configuration file. The configuration file for the report server is RSReportServer.config.

The following table describes the attributes for the Extension element for delivery extensions.

Attribute

Description

Name

A unique name for the extension (for example, "Report Server E-Mail" for the e-mail delivery extension or "Report Server FileShare" for the file share delivery extension). The maximum length for the Name attribute is 255 characters. The name must be unique among all entries within the Extension element of a configuration file. If a duplicate name is present, the report server returns an error.

Type

A comma-separated list that includes the fully qualified namespace along with the name of the assembly.

Visible

A value of false indicates that the delivery extension should not be visible in user interfaces. If the attribute is not included, the default value is true.

For more information about the RSReportServer.config file, see Configuration Files (Reporting Services).

Deploying the Extension to the Report Server

The report server uses delivery extensions for processing and delivering notifications or reports. You should deploy your delivery extension assembly to the report server as a private assembly. You also need to make an entry in the report server configuration file, RSReportServer.config.

To deploy a deliver extension assembly to a report server

  1. Copy your assembly from your staging location to the bin directory of the report server on which you want to use the delivery extension. The default location of the report server bin directory is C:\Program Files\Microsoft SQL Server\MSRS10.<InstanceName>\Reporting Services\ReportServer\bin.

    Important

    If you are attempting to overwrite an existing delivery extension assembly, you must first stop the Report Server service before copying the updated assembly. Restart your service after the assembly is through copying.

  2. After the assembly file is copied, open the RSReportServer.config file. The RSReportServer.config file is located in the ReportServer directory. You need to make an entry in the configuration file for your delivery extension assembly file. You can open the configuration file with Microsoft Visual Studio or a simple text editor, such as Notepad.

  3. Locate the Delivery element in the RSReportServer.config file. An entry for your newly created delivery extension should be made in the following location:

    <Extensions>
   <Delivery>
      <Your extension configuration information goes here>
   </Delivery>
</Extensions>

  4. Add an entry for your delivery extension. Your entry should include an Extension element with values for Name and Type, and might look like the following:

    <Extension Name="My Delivery Extension Name" Type="CompanyName.ExtensionName.MyDeliveryExtensionClass, AssemblyName" />

    The value for Name is the unique name of the delivery extension. The value for Type is a comma-separated list that includes an entry for the fully qualified namespace of your class that implements the IDeliveryExtension interface, followed by the name of your assembly (not including the .dll file extension). By default, delivery extensions are visible. To hide an extension from user interfaces, such as Report Manager, add a Visible attribute to the Extension element, and set it to false.

  5. Finally, add a code group for your custom assembly that grants FullTrust permission for your delivery extension. You do this by adding the code group to the rssrvpolicy.config file located by default in C:\Program Files\Microsoft SQL Server\MSRS10.<InstanceName>\Reporting Services\ReportServer. Your code group might look like the following:

    <CodeGroup class="UnionCodeGroup"
   version="1"
   PermissionSetName="FullTrust"
   Name="MyExtensionCodeGroup"
   Description="Code group for my delivery extension">
      <IMembershipCondition class="UrlMembershipCondition"
         version="1"
         Url="C:\Program Files\Microsoft SQL Server\MSRS10.<InstanceName>\Reporting Services\ReportServer\bin\MyExtensionAssembly.dll"
       />
</CodeGroup>

    URL membership is only one of many membership conditions you might choose for your delivery extension. For more information about code access security in SSRS, see.Secure Development (Reporting Services) 

Deploying the Extension to Report Manager

If your delivery extension implements the ISubscriptionBaseUIUserControl interface, your delivery extension can be used with the Report Manager Subscription page. To make the subscription user interface available, you need to deploy your extension to Report Manager.

To deploy a deliver extension assembly to Report Manager

  1. Copy your assembly from your staging location to the bin directory of Report Manager. The default location of the Report Manager bin directory is C:\Program Files\Microsoft SQL Server\MSRS10.<InstanceName>\Reporting Services\ReportManager\bin.

  2. After the assembly file is copied, open the RSReportServer.config file. The RSReportServer.config file is located in the ReportServer directory. You need to make an entry in the configuration file for your delivery extension assembly file. You can open the configuration file with Visual Studio .NET or a simple text editor, such as Notepad.

  3. Locate the DeliveryUI element in the RSReportServer.config file. An entry for your newly created delivery extension should be made in the following location:

    <Extensions>
   <DeliveryUI>
      <Your extension configuration information goes here>
   </DeliveryUI>
</Extensions>

  4. Add an entry for your delivery extension. Your entry should include an Extension element with values for Name and Type and might look like the following:

    <Extension Name="My Delivery Extension Name" Type="CompanyName.ExtensionName.MyDeliveryUIExtensionClass, AssemblyName" />

    The value for Name is the unique name of the delivery extension. The value for Type is a comma-separated list that includes an entry for the fully qualified namespace of your class that implements the ISubscriptionBaseUIUserControl interface, followed by the name of your assembly (not including the .dll file extension).

    Important

    The value of the Name attribute must be identical for both the Report Server and Report Manager configuration file entries. If they are not identical, your server configuration is not valid.

    Finally, add a code group for your custom assembly that grants FullTrust permission for your delivery extension. You do this by adding the code group to the RSmgrpolicy.config file located by default in C:\Program Files\Microsoft SQL Server\MSRS10.<InstanceName>\Reporting Services\ReportManager. Your code group might look like the following:

    <CodeGroup class="UnionCodeGroup"
   version="1"
   PermissionSetName="FullTrust"
   Name="MyExtensionCodeGroup"
   Description="Code group for my delivery UI extension">
      <IMembershipCondition class="UrlMembershipCondition"
         version="1"
         Url="C:\Program Files\Microsoft SQL Server\MSRS10.<InstanceName>\Reporting Services\ReportManager\bin\MyExtensionAssembly.dll"
       />
</CodeGroup>

    URL membership is only one of many membership conditions you might choose for your delivery extension. For more information about code access security in SSRS, see Secure Development (Reporting Services) 

Verifying the Deployment

You can verify whether your delivery extension was deployed successfully to the report server by using the Web service ListExtensions method. You can also open Report Manager and verify that your extension is included in the list of available delivery extensions for a subscription. For more information about Report Manager and subscriptions, see Subscription and Delivery (Reporting Services).