Set-SPWebAnalyticsServiceApplication
Published: May 12, 2010
Sets properties of a Web Analytics Service application.
Set-SPWebAnalyticsServiceApplication [-Identity] <WebAnalyticsServiceApplicationPipeBind> [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-EnableDataTrimming <SwitchParameter>] [-ListOfReportingDatabases <String>] [-ListOfStagingDatabases <String>] [-MaxAggregationDepth <String>] [-MinAggregationDepth <String>] [-ReportConsolidationStartTime <Int32>] [-ReportingDataRetentionPeriod <Int32>] [-SamplingRate <Int32>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
Identity |
Required |
Microsoft.Office.Server.WebAnalytics.Administration.Cmdlets.WebAnalyticsServiceApplicationPipeBind |
Specifies the Web Analytics Service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Web Analytics Service application (for example, WebAnalyticsApp1); or an instance of a valid WebAnalyticsServiceApplication object. |
||
|
ApplicationPool |
Optional |
Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind |
Specifies the name of the application pool in the form of a GUID. You can pass in the object name from the New-SPIisWebServiceApplicationPool cmdlet. |
||
|
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.
|
||
|
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 |
||
|
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. |
||
|
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. |
||
|
ReportConsolidationStartTime |
Optional |
System.Int32 |
Specifies the time expressed in hours that the report consolidation process is started. The default value is 3. A valid integer between 1 and 23. |
||
|
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. |
||
|
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 WebApplication. |
||
|
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. |
||
|
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 |
Detailed Description
The Set-WebAnalyticsServiceApplication cmdlet sets the properties of a Web Analytics Service application.
Input Types
Return Types
-------------------EXAMPLE 1---------------
Set-SPWebAnalyticsServiceApplication -Identity WebAnalyticsServiceApplication1 -ReportingDataRetentionPeriod 20 -SamplingRate 90
This example sets the reporting data retention and sampling rate for a Web Analytics Service application named WebAnalyticsServiceApplication1.
-------------------EXAMPLE 2---------------
Set-SPWebAnalyticsServiceApplication -Identity WebAnalyticsServiceApplication1 -ReportingDataRetentionPeriod 20 -SamplingRate 90 -ListOfReportingDatabases "<ReportingDatabases><ReportingDatabase ServerName='ap64bitbvt03-8' DatabaseName='R9'/></Reporting Databases>" -ListOfStagingDatabases "<StagingDatabases><StagingDatabase ServerName='ap64bitbvt03-8' DatabaseName='S9'/> <StagingDatabase ServerName='ap64bitbvt03-8' DatabaseName = 'S10'/></StagingDatabases>" -ApplicationPool "Sharepoint Web Services Default"
This example sets reporting data retention period, sampling rate, reporting database list, staging database list and application pool for a Web Analytics Service application named WebAnalyticsServiceApplication1.

Note: