3.25 SiteUsage

Use this Knowledge Script to monitor usage information about each Web application on the SharePoint server.

This script collects usage information based on the following parameters:

  • URL

  • User

  • Operating System

  • Browser

  • Referrer URL

Web application usage information is displayed in report format. You can customize the format in which the report displays the information.

3.25.1 Resource Objects

SharePoint Server: Web Applications

3.25.2 Default Schedule

The default interval for this script is every hour.

3.25.3 Setting Parameter Values

Set the following parameters as needed:

Description

How to Set It

General Settings

Job failure event notification

Event severity when job fails

Set the event severity level, from 1 to 40, to indicate the importance of an event in which the job fails to monitor usage information about Web applications. The default is 5.

Monitor Site Usage

Comma-separated list of Web applications to exclude

Specify a list of Web applications to ignore when monitoring. Use commas to separate multiple Web applications.

File path of a file containing a list of site collection URLs to exclude from monitoring (one per line)

Specify the UNC or file path of a file that contains a list of sites to ignore when monitoring. In the file, list the sites to be excluded, one site per line.

The site collection URLs in your list must be in the same format as they appear in event messages. Include the http:// at the beginning of the URL, and do not include a trailing "/" at the end of the URL (which will cause the job to monitor the site collection you are trying to exclude).

Select report type:

Select the report type that you want to view. The report type dictates how data is filtered (included or excluded).

This script uses the following codes to identify report types. Select the code to view the report based on that code. The default is 0-URL.

  • 0-URL: URLs of pages that are visited, or of pages for lists that are updated.

  • 1-User: Names of users who visited the Web application.

  • 2-OS: The operating system used on the client computer. All Web application usage data refers specifically to visits from referrer URLs external to the application.

  • 3-Browser: The type of Web browser used to visit the SharePoint Web application. All usage data refers specifically to visits from referrer URLs external to the application.

  • 4-RefURL: External URLs through which users navigated to the SharePoint application.

Select report format:

Select the format in which you want to view the report. The default is 0‑Day‑wise.

0-Day-wise: Displays usage information for each day over the previous 31 days, not including the day the report is generated.

1-Summary: Summarizes usage information for the previous 31 days, not including the day the report is generated.

The maximum number of records to display

Specify the maximum number of records per site collection that you want to display in your report.

  • If you set the number of records to 0, the SiteUsage script displays all the records.

  • If you set the number of records to 5, for example, the SiteUsage script displays the 5 top records for each site collection in the report.

The default value is 50.

Data Collection

Collect site usage data on the SharePoint server?

Select Yes to collect usage data for Web applications on your SharePoint Server. The default is unselected.

Include detail report

Select this parameter to display the detail report with data points. The default is unselected.

Event Notification

Raise event when the site usage report is created?

Select Yes to raise an event in which a report for Web application usage is generated. The default is Yes.

Event severity when the site usage report is created

Set the event severity level, from 1 to 40, to indicate the importance of an event in which a report for Web application usage is generated. The default is 25.

Raise event when site usage report is unable to be created?

Select Yes to raise an event if no usage information exists for the Web applications on the SharePoint server, so no report can be generated. The default is Yes.

Event severity when site usage report is unable to be created

Set the event severity level, from 1 to 40, to indicate the importance of an event in which no usage information exists. The default is 11.