The Reporting Rollup Sample Tool package contains both a pre-built reporting rollup tool and sample source files which you can use to build unique reporting rollup tools.

For information about setting up and running the pre-built sample tool, see “Using the Reporting Rollup Sample Tool.” For information about the sample source files, see “WSUS Reporting Rollup Sample Tool Source Code.”

Using the Reporting Rollup Sample Tool

This sample tool was created using the WSUS application programming interface (API) in order to demonstrate centralized monitoring and reporting for WSUS.

This tool rolls up update and computer status from all of the WSUS servers in your WSUS implementation in a single report.

How the Reporting Rollup Sample Tool works

By setting up the tool on a server and then configuring the rollup server and WSUS downstream servers as described in this document, you will enable the following process:

  1. Each downstream WSUS server exports the status data and then uploads it to the rollup tool server.

  2. A monitoring tool running on the rollup tool server processes the incoming rollup data and then stores it in the rollup database.

  3. You access a web-based viewer (or Web site) which displays consolidated reports based on the data in the rollup database.

Requirements

This section contains server requirements and additional requirements.

Server requirements

Server requirements refer to the server on which you install the rollup tool (rollup tool server):

  • Microsoft Windows 2000 Server or Windows 2003 Server operating system

  • An instance of MSDE or SQL server 2000 with SP3. This instance must be separate from the instance in which the WSUS database (SUSDB) is running. Note the following important points:

    • This tool installs its own database which is separate from the WSUS database. Therefore, the server on which you install this tool does not have to be a WSUS server.

    • If the server on which you want to install the rollup tool is running MSDE as part of your WSUS installation, then you have to install another instance of MSDE specifically for the rollup tool database.

    • If the server on which you want to install the rollup tool is running WMSDE as part of your WSUS installation, you cannot use WMDSE for this tool. As specified in your WSUS licensing agreement, WMSDE is specifically for use with your installation of WSUS server. However, the rollup reporting tool will rollup data from downstream WSUS servers using MSDE, WMSDE or SQL Server 2000.

  • The following Windows components must be installed:

    • Internet Information Services (IIS)

    • ASP.NET

    1. In Control Panel, open Add or Remove Programs, and then click Add/Remove Windows Components.

    2. Click Application Server, click Details, and then click ASP.NET.

  • CabArc.exe must be in the %windir%\System32 folder on the rollup server. Note that this file must also be on each downstream server—this is noted again under “Additional Requirements.” This file is available on your installation CD, in the \Support\Tools\Support.cab folder.

Additional requirements

  • Multiple downstream WSUS servers for aggregating status.

  • The rollup server and downstream WSUS servers must be members of the same Active Directory domain.

  • CabArc.exe must be in the %windir%\System32 folder on each WSUS downstream server. This file is available on your installation CD, in the \Support\Tools\Support.cab folder.

Setting up the rollup tool

Setting up the tool consists of two parts:

  • Step 1: Run the MSI file on the central server (rollup tool server)

  • Step 2: Configure the rollup tool server and downstream servers

When the MSI runs on the central server, the following occurs:

  • A virtual directory under the Default Web Site in IIS (called WsusRollupViewer by default) is created. This virtual directory is used for the Reporting Rollup Tool UI. You have the option of specifying a name for this directory.

  • A shared folder for updated report rollup data (called WsusRollupData by default) which points to <install-dir>\RollupData is created. You have the option of specifying a name for this shared folder.

  • A rollup database (completely separate from the WSUS database) is created. The schema for this database is automatically populated based on your input parameters.

Important   During setup, you must install the rollup database on the same server on which you install the rollup tool. If you install the rollup database on a remote SQL 2000 server, then the web-based viewer (as described in Step #3 under “Tool Flow”) will not accessible from a remote computer.

By configuring the rollup server and WSUS downstream servers after running the MSI file, you complete the rollup tool installation and enable the process described in the “How the process works” section earlier in this document.

Step1: Run the MSI file on the central server (rollup tool server)

  • On a server, run WsusRollupSample.msi. You must be a member of the local administrators group on the rollup server to perform this task.

Step 2: Configure the rollup tool server and downstream servers

The commands provided in the following procedure are also automatically generated by the Reporting Rollup Tool Sample Setup and outputted to the <install-dir>\PostInstallSteps.txt file after you run setup, and will contain the folder names you specified during setup. You have the option of copying and pasting the commands directly from that file when creating the scheduled tasks described in the following procedure.

  1. On the server on which you installed the rollup tool (rollup tool server), create the following scheduled task (using Scheduled Tasks in Control Panel) to process incoming WSUS reporting rollup data:

"<install-dir>\WsusRollupImportMonitor.exe" "<install-dir>\\RollupData\\" "." "<rollup-database>"

This task must run under an account that has write access to the WsusRollupDatabase.

  1. On the rollup tool server, grant Write permissions for the shared rollup data folder (by default this is WsusRollupData pointing to <install-dir>\RollupData) to the members of “WSUS administrators” group of the downstream WSUS servers. This enables the downstream WSUS servers to upload data to the rollup tool server.

  1. On each downstream WSUS server, do the following:

  • Copy the files from <install-dir>\RollupClient on the rollup tool server to a folder you must create called <rollup-client-tools-dir>.

  • Copy the file <rollup-client-tools-dir>\DetailsDialogLauncher.aspx to the <%windir%>\Program Files\Update Services\Administration folder.

  • Create the following scheduled task (using Scheduled Tasks in Control Panel) to upload rollup data to the rollup server:

Cmd /c "<rollup-client-tools-dir>\ExportAndUploadRollupData.cmd" "<Local-Working-Directory>" <WSUS Console URL (for example http://<WSUSservername>/WSUSAdmin)> \\<rollup-tool-server>\<rollup-data-share>

This task must run under an account that is a member of the "WSUS Adminstrators" group, and that has Write access to the shared rollup data folder on the rollup tool server.

To run the Reporting Rollup tool

  • From an Internet browser, go to http://[localhost]/WsusRollupViewer.

Note
This Web site uses Windows Authentication by default. However, you can configure it to utilize SQL authentication.

WSUS Reporting Rollup Sample Tool Source Code

The source code is provided as a Microsoft Visual Studio 2003 solution.

Prerequisites

The following are required on your computer:

To setup the source code files

  1. Extract WsusRollupSampleSource.cab to a folder on your computer (<source-code-root>).

  2. In IIS Manager, create a virtual directory (VROOT) to point to <source-code-root>\WsusRollup\WsusRollupViewer.

To build the Reporting Rollup Sample tool

  1. Open <source-code-root>\WsusRollup\WsusRollup.sln in Visual Studio.

  2. Build the solution.

Projects

The following projects are provided as part of the sample solution:

  • WsusRollupExport –WSUS reporting data export tool

  • WsusRollupImport – WSUS reporting data import tool

  • WsusRollupImportMonitor – WSUS reporting data monitor tool

  • WsusRollupSetup – WSUS rollup setup based on WIX Votive toolset

  • WsusRollupViewer – WSUS rollup viewer UI based on ASP.NET

  • WsusSetupHelper – WSUS rollup setup helper

  • Solution Items – other files needed by the tool