Export (0) Print
Expand All

New-SPWebAnalyticsServiceApplication

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Adds a new Web Analytics Service application to the farm.

New-SPWebAnalyticsServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-EnableDataTrimming <SwitchParameter>] [-ListOfReportingDatabases <String>] [-ListOfStagingDatabases <String>] [-MaxAggregationDepth <String>] [-MinAggregationDepth <String>] [-Name <String>] [-ReportingDataRetentionPeriod <Int32>] [-SamplingRate <Int32>] [-WhatIf [<SwitchParameter>]]

The New-WebAnalyticsServiceApplication cmdlet creates a new Web Analytics Service application in the farm.

 

Parameter Required Type Description

ApplicationPool

Required

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies the existing IIS application pool to run the Web service in the service application.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL of a search application, in the form http://server_name; or an instance of a valid SPIisWebServiceApplicationPool object.

Name

Optional

System.String

Specifies the display name for the new Web Analytics Service application. The name that you use must be a unique name of a Web Analytics Service application in this farm. The name can be a maximum of 128 characters and cannot include the invalid characters comma (,), equal sign (=), or colon (:).

The type must be a valid name of a service application proxy; for example, WebAnalyticsSvc1.

ReportingDataRetentionPeriod

Optional

System.Int32

Specifies the period, in months, that data is retained in the Web Analytics Reporting database. The default value is 25.

An integer in the range from 1 to 25.

ListOfReportingDatabases

Optional

System.String

Specifies the server and database name for the Web Analytics Reporting database. The parameter value is an XML string that contains the server name and the database name.

The type must be a valid XML string.

ListOfStagingDatabases

Optional

System.String

Specifies the server and database name for the Web Analytics Staging database. The parameter value is an XML string that contains the server name and the database name.

The type must be a valid XML string.

MaxAggregationDepth

Optional

System.String

Specifies the maximum aggregation depth that the Report Consolidator component will use to aggregate data. The MaxAggregationDepth parameter should always be used in conjunction with the MinAggregationDepth parameter

The value specified for the MaxAggregationDepth parameter should always be higher than the MinAggregationDepth parameter value.

The range of possible values in ascending order are: All, WebApplication, SiteCollection, Site,

The default value is Web Application.

MinAggregationDepth

Optional

System.String

Specifies the minimum aggregation depth that the Report Consolidator component will use to aggregate data. The MinAggregationDepth parameter should always be used in conjunction with the MaxAggregationDepth parameter

The value specified for the MinAggregationDepth parameter should be lower than the MaxAggregationDepth parameter value.

The range of possible values in ascending order are: Web Application, SiteCollection, Site,

The default value is WebApplication.

SamplingRate

Optional

System.Int32

Specifies the sample rate of incoming data. This controls the throttling to reduce the amount of data to be processed. A backend process estimates the original traffic numbers. The default value is 100.

The type must be an integer in the range of 0 to 100.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

noteNote
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

EnableDataTrimming

Optional

System.Management.Automation.SwitchParameter

When enabled, the number of rows of data in the reporting database is trimmed to 20,000 rows per day per component (Site, Site collection, Web Application). Typically, the EnableDataTrimming parameter is enabled for improving performance of the Web Analytics Report Consolidator component.

The default value is false.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

---------------------EXAMPLE-------------------

New-SPWebAnalyticsServiceApplication -Name WebAnalyticsServiceApplication1 -ReportingDataRetention 20 -SamplingRate 100 -ApplicationPool WebAnalyticsServiceApplication1

This example creates a new Web Analytics Service application.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft