01/12/2010 14:18:52
The most up-to-date version of this file is available online at the Microsoft Download Center on the
For help with SQL Server technical issues not related to documentation, see
Contents
1.0 Background
The Microsoft® SQL Server® 2008 Reporting Services add-in for SharePoint Products and Technologies is a Web download that provides features to integrate a report server with a deployment of Microsoft SharePoint Foundation 2010® or Microsoft SharePoint Server 2010 ®. The Reporting Services Add-in provides the following functionality:
-
A Report Viewer Web Part, which provides report-viewing capability, export to multiple rendering formats, page navigation, search, print, and zoom.
-
Web pages so that you can create subscriptions and schedules, set model item security, and manage reports, models, and data sources.
-
Support for standard SharePoint Foundation 2010 and SharePoint Server 2010 features including document management, collaboration, security, and deployment with report server content types.
-
You can use SharePoint alerts, version control (check in and check out), and Filter Web Parts with reports. You can add the Report Viewer Web Part to any page or dashboard on a SharePoint site and customize its appearance.
-
You can use SharePoint permission levels and roles to control access to report server content. You can also use SharePoint forms authentication to support access over Internet connections.
-
A delivery extension that you can use in subscriptions to deliver reports to SharePoint libraries.
-
Publish reports and models from Report Designer and Model Designer to a SharePoint library.
-
Open reports and models in Report Builder from a SharePoint library, and save reports to SharePoint libraries across the site.
-
A Simple Object Access Protocol (SOAP) endpoint to manage report server content in SharePoint integrated mode.
2.0 Features in This Release
The Reporting Services Add-in works together with an SQL Server 2008 R2 Reporting Services report server that you configure for SharePoint integration. The following list introduces new features in this release:
-
Flexible installation of the add-in, which is now supported either before or after installing a SharePoint product or technology. Installing before a SharePoint Product or Technology provides an easier deployment of the add-in because the SharePoint farm deploys the files when servers are added to the farm.
-
Easier configuration of SharePoint servers for integration with a report server. There are less steps to complete than the previous version of the add-in. For more information, see How to: Configure Report Server Integration in SharePoint Central Administration
-
Ability to use data from a SharePoint list as a data source for reports. The add-in provides new Microsoft SharePoint list and query experience to easily add SharePoint list information into your report. For more information, see Getting Data from a SharePoint List Data Source Type (Report Builder 3.0)
-
Reports from Microsoft Access 2010® and the new Reporting Services SharePoint list data extension can run locally from the SharePoint document library, without a connection to a SQL Server reporting services report server. For more information, see Rendering Local Mode Reports in the Report Viewer (Reporting Services in SharePoint Integrated Mode)
-
Categories that can be configured to be a part of the SharePoint diagnostic logging. The categories log information ranging from user interface usage to the SOAP client proxy. For more information, see Events for a Report Server in SharePoint Integrated Mode and How to: Turn on Reporting Services events for the SharePoint trace log
-
The Reporting Services related user interface within SharePoint now supports 37 languages, Right to Left character sets with Hebrew and Arabic, and complex text layout with Thai. This support includes the report viewer web part as well as web pages.
-
Report Builder click-once functionality loads Report Builder directly from a report server and use server-side system properties.
-
Subscriptions and drill-through links work directly with the linked resources in the document library instead of going through report server.
-
An HTTP redirector which listens for requests from clients such as Report Builder to the SharePoint Web front-end and re-directs the requests to the report server.
3.0 Requirements
To install the Reporting Services Add-in, the computer must meet the following software requirements in addition to the software and hardware requirements of the SharePoint 2010 product or technology you integrate with:
-
Microsoft Windows Installer 3.0 or newer.
-
SharePoint Foundation 2010 or SharePoint Server 2010. The Reporting Services Add-in is not supported on earlier versions of Windows SharePoint Services or Microsoft Office SharePoint Server2007.
-
The add-in is 64-bit only, which is a requirement of SharePoint 2010 products and technologies.
-
To configure integrated operations with this version of the Reporting Services Add-in, the report server must be SQL Server 2008 R2. The report server must be configured for SharePoint integrated mode as described in SQL Server Books Online.
-
Supported SQL Server editions include Standard, Evaluation, Developer, and Enterprise. Server integration is not supported on the Workgroup edition of Reporting Services or SQL Server Express with Advanced Services.
3.1 Domain user account requirements for SharePoint administration and services
A deployment of a SharePoint product or technology uses a variety of accounts to run services and access front-end and back-end servers. If you specify domain accounts for your deployment, you should follow best practice recommendations and specify accounts that are used exclusively by the SharePoint Web application. Do not configure a service account to run under the domain user account of an actual person who will access the SharePoint site.
A domain account is required if:
-
The SharePoint site and the report server are on different computers.
-
The SharePoint site is hosted in an application pool that runs as a built-in account, such as NetworkService.
-
The report server endpoint on the SharePoint Web application is configured to use Trusted Account mode.
If you do not use a domain user account, you will receive the following error when a user views a report or accesses Reporting Services features from the SharePoint site:
"An unexpected error occurred while connecting to the report server. Verify that the report server is available and configured for SharePoint integrated mode. The permissions granted to user '<acccountname>' are insufficient for performing this operation."
You avoid this error by following the recommendations in the SharePoint product and technology documentation and running the application pool service as a domain account. For more information about service account requirements and recommendations, see
Note: |
---|
SharePoint 2010 products and technologies require domain accounts for service configuration like reporting services SharePoint integration. |
4.0 Upgrade
If you have an existing installation of the Reporting Services Add-in, you can upgrade to the current version. Setup will detect the existing version and prompt you to confirm the update. If you confirm, the older version of the add-in will be removed and then the new version will be installed.
Note that the Reporting Services Add-in is not instance-aware. You can only have one instance of the add-in on a computer. You cannot run early versions side-by-side the current version.
5.0 Installation and configuration overview
The exact steps that you take to install and configure the Reporting Services Add-in may vary depending on your requirements. The following are the basic steps.
-
Install the add-in using the rsSharepoint.msi file. In a SharePoint farm deployment, the add-in must be installed on each Web front-end server. For more information, see How to: Install or Uninstall the Reporting Services Add-in
-
In SharePoint Central Administration, configure Reporting Services integration, which includes specifying the URL of the report server to integrate with the SharePoint farm. For more information, see How to: Configure Report Server Integration in SharePoint Central Administration
-
In SharePoint Central Administration, verify the report server integration and Central Administration features are activated under site collection features. For more information, see How to: Activate the Report Server Feature in SharePoint Central Administration
-
In SharePoint Central Administration, activate the Report Server File sync feature. This feature helps keep items that are manually copies to document libraries, synchronized with the report server catalog. For more information, see How to: Activate the Report Server File Sync Feature in SharePoint Central Administration
-
For each document library, add the three reporting services content types: Report Builder Model, Report Data Source, Report Builder Report. This will make the reporting services options available in the new document list. For more information, see How to: Add Report Server Content Types to a Library (Reporting Services in SharePoint Integrated Mode)
6.0 Installation of the add-in
To install the Reporting Services Add-in, you must be an administrator on the computer.
You must be a Site Collection administrator to activate the Reporting Services integration feature.
In this release the add-in can be installed before installing SharePoint or after SharePoint installation. The add-in follows SharePoint pre-deployment standards and installs files in locations used by the SharePoint installation.
Note: |
---|
The advantage of installing the add-in prior to the SharePoint product or technology is that as new servers are added to the farm, the Reporting Services Add-in will be configured and activated by the SharePoint farm. |
6.1 Installing the add-in before a SharePoint Product or technology
The add-in must be installed on all servers that will run as SharePoint Web front-ends that you want integrated with the Reporting Services. If the SharePoint product or technology has not been installed yet, you can run the add-in installation wizard on all servers.
-
Download the Setup program (rsSharepoint.msi) for the Reporting Services Add-in.
-
As an administrator, run rsSharepoint.msi to run the Installation Wizard. The wizard displays a Welcome page, the Software license terms, and a registration information page. Setup creates SharePoint 2010 folders under %program files%\common files\Microsoft Shared\ and copies files to the folders. You must run the .msi as administrator by first opening an elevated command prompt window, and then running the rsSharepoint.msi from the command line.
-
Configure the report server integration settings and feature activation in SharePoint Central Administration.
6.2 Installing the add-in after a SharePoint product or technology has been installed
When installing the add-in on servers after a SharePoint product or technology has been installed, you can run the full add-in installation on only one of the SharePoint servers. For the other SharePoint servers in the farm, you must run the files only installation of the add-in from the command line. The files-only installation installs the files but skips the custom actions section of the installation process.
After you have installed the add-in on all the servers, start SharePoint Central Administration to configure report server integration.
6.3 Files-only installation
To install the files but skip the custom action steps, run the .msi from the command line with the SKIPCA option:
-
Open a command prompt with administrator permissions.
-
Run msiexec -i rsSharePoint.msi SKIPCA=1.
6.4 Two step full add-in installation
If you get errors during installation, you can run Setup as a two-step process from the command line. First run Setup to install the files and skip the custom actions, and then run a custom actions executable. To install the Reporting Services Add-in for files-only mode, do the following:
-
Open a command prompt with administrator permissions.
-
Run msiexec -i rsSharePoint.msi SKIPCA=1.
-
Find the rsCustomAction.exe file on the file system. This file is copied to your computer by the Setup program. The file will be located in the %Temp% directory.
To get the path information for this file, click Start, click Run, and then type %temp%. The file should be located in \Documents and Settings\<your name>\LOCALS~1\Temp.
Open a command prompt window. To do this, click Start, click Run, and type cmd. On newer operating systems, you might need to elevate your permissions and run this run this with administrator permission.
-
Navigate to the folder that contains the rsCustomAction executable.
-
Enter the following command. This configuration step will take several minutes to finish. The W3SVC service will be restarted during this process.
rsCustomAction.exe /i
6.4 Configure report server integration
-
In SharePoint 2010 Central Administration, click the General Application Settings tab.
-
In the Reporting Services application section, click Reporting Services Integration.
-
In Report Server Web Service URL: Specify the report server URL (for example, http://example-server-name/reportserver). Do not use "localhost". For best results, open a browser window and verify that the URL you intend to use is valid. A valid URL will open to the root node of the report server folder hierarchy. If you get an error, the report server URL is not valid and must not be used. For more information about URL syntax, see “Configuring Report Server Virtual Directories” in SQL Server Books Online.
-
In Authentication Mode, select either Windows Authentication or Trusted Account to specify whether the proxy server endpoint sends a header with a security token for an impersonated connection on the report server.
-
In Credentials, specify the User Name and Password to connect to the report server to retrieve the service account. Enter credentials for an account that is a member of the local Administrators group on the report server computer.
-
In Activating the Reporting Services Feature choose to have the Reporting Services feature activated in all existing site collections or select the list of site collections in which to activate the feature.
-
Click OK.
-
In Report Server Web Service URL: Specify the report server URL (for example, http://example-server-name/reportserver). Do not use "localhost". For best results, open a browser window and verify that the URL you intend to use is valid. A valid URL will open to the root node of the report server folder hierarchy. If you get an error, the report server URL is not valid and must not be used. For more information about URL syntax, see “Configuring Report Server Virtual Directories” in SQL Server Books Online.
-
In the Reporting Services section, click Set server defaults to optionally set values to limit report history, enable logging, set a report processing time-out, and enable report builder download
For more information, see How to: Configure Report Server Integration in SharePoint Central Administration and How to: Activate the Report Server Feature in SharePoint Central Administration
6.5 Set Permissions and Add Reporting Services Content Types
To complete the integration process, you must verify permissions for all users who need to access and manage report server content on the SharePoint Web application. To grant application access to those users, you must assign user and group accounts to SharePoint groups or permission levels. Reporting Services features integrate with the SharePoint security model and permissions, and access to Reporting Services content Types is the same as access to other items in the same document library. For example if a user has permissions to view other items in the document library, they will be able to view a report in that library.
You might also want to add Reporting Services content types so that users who have permission to use Report Builder can start it from the New menu within a document library. For more information, see How to: Add Report Server Content Types to a Library (Reporting Services in SharePoint Integrated Mode)
6.6 Verify the Installation and configuration
-
Verify integration by starting Reporting Services Configuration Manager to view server status. The Current Report Server section should display SharePoint Integrated for Report Server mode.
-
In the Reporting Services Configuration Manager, click the Web Service URL, and then click the Report Server Web Service URL to open a browser window to the report server page. If the page does not open without error messages then the report server is not configured correctly.
-
In SharePoint Central Administration, click General Application Settings, and then in the Reporting Services section, click Set server defaults. If integration is correctly configured, this page will open and not show an error that indicates a failed connection to the report server.
-
Navigate to a library in the SharePoint site and upload a report definition (.rdl) file and a report model (.smdl) file. Make sure that the data source properties for the report are correct. The data source must have a valid connection string to an external data source. The credential type must be valid for your network topology. Specifically, if Kerberos authentication is not enabled for your domain, you cannot use the Windows integrated security credential type if the report server is on a different computer. Instead, you should specify stored credentials. After you verify that the data source properties are correct, you can click the report name to open the report. The report will open in the Report Viewer Web Part automatically.
6.7 Uninstalling the Reporting Services Add-in
You can uninstall the Reporting Services Add-In from Windows control panel in Programs and Features. You can also uninstall the Reporting Services Add-in by running Setup (the .msi file) in uninstall mode.
Note: |
---|
Removing the add-in from a server that is active in the farm removes the add-in from all servers in the farm. If you only want to remove the add-in from one server, first remove that server from SharePoint farm and then uninstall the add-in. |
Uninstalling the add-in removes server integration features that are used to process reports and models on the report server. Setup does not delete files that you created or uploaded to a library, nor does it delete schedules, subscriptions or report history. Consider deleting these items before uninstalling the add-in. You should also delete the SharePoint database logins that were created for the Reporting Services service account.
-
Remove any reports and other report server items that you no longer use. They will not run after the add-in is removed.
-
In Control Panel, in Programs or Programs and Features, select SQL 2008 R2 Reporting Services SharePoint Add-In.
-
Click Uninstall.
For more information, see How to: Install or Uninstall the Reporting Services Add-in
7.0 Known Issues
There are currently no known issues.
8.0 Documentation notes
There are currently no documentation issues.