Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-SPWorkManagementServiceApplication

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets settings for the Work Management Service application.

Set-SPWorkManagementServiceApplication [-Identity] <SPWorkManagementServiceCmdletPipeBind> [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-MinimumTimeBetweenEwsSyncSubscriptionSearches <TimeSpan>] [-MinimumTimeBetweenProviderRefreshes <TimeSpan>] [-MinimumTimeBetweenSearchQueries <TimeSpan>] [-Name <String>] [-NumberOfSubscriptionSyncsPerEwsSyncRun <UInt32>] [-NumberOfUsersEwsSyncWillProcessAtOnce <UInt32>] [-NumberOfUsersPerEwsSyncBatch <UInt32>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.WorkManagement.Cmdlet.SPWorkManagementServiceCmdletPipeBind

Specifies the service application to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPWorkManagementServiceApplication object

ApplicationPool

Optional

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies the name of an application pool to use; for example, SharePoint – 1213. If no value is specified, the default application pool is used.

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.

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

MinimumTimeBetweenEwsSyncSubscriptionSearches

Optional

System.TimeSpan

Specifies the minimum amount of time (in minutes) to find new tenants that want to synchronize Exchange Web Services tasks. Each tenant needs to be found once using this routine, subsequent users from the same tenant will be picked up on the next tenant synchronization.

MinimumTimeBetweenProviderRefreshes

Optional

System.TimeSpan

Specifies the minimum amount of time (in minutes) between refreshes for a provider for a given user. There cannot be a refresh of data if the value is not met and all refresh operations will contain a null value before a refresh. The default value is 5 minutes.

MinimumTimeBetweenSearchQueries

Optional

System.TimeSpan

Specifies the minimum amount of time (in hours) between calls to search for a given user. This parameter is used to discover new providers not yet known to have tasks for this user. The default value is 3 hours.

Name

Optional

System.String

Specifies the name of the Work Management Service application.

NumberOfSubscriptionSyncsPerEwsSyncRun

Optional

System.UInt32

Specifies the minimum amount of time (in minutes) between calls for a new tenant to synchronize Exchange Web Services tasks. Each tenant needs to be found once using this method, and subsequent users from the same tenant will be found on the next tenant synchronization. The default value is 30 minutes.

NumberOfUsersEwsSyncWillProcessAtOnce

Optional

System.UInt32

Specifies the maximum number of users a service instance machine will synchronize by using Exchange Web Services at one time across all tenants. This has direct influence on the computer workload. Each synchronization will last 45 seconds (constant). The default value is 10.

NumberOfUsersPerEwsSyncBatch

Optional

System.UInt32

Specifies the maximum number of users a service instance will try to synchronize on a given tenant by using the Exchange Web Services per Timer job interval. The default value is 100.

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

Use the Set-SPWorkManagementServiceApplication cmdlet to set settings (that is, minimum time between refreshes for aggregating tasks and load per machine for synchronization with Exchange) for the specified Work Management Service Application by using the Identity parameter.

Input Types

Return Types

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

$wmservice = Get-SPServiceApplication -Name "Work Management Service Application"
$refreshTime = New-Timespan -Minutes 10
Set-SPWorkManagementServiceApplication -Identity $wmservice -MinimumTimeBetweenProviderRefreshes $refreshTime

This example sets the minimum time between provider refreshes to 10 minutes on the service application named “Work Management Service Application”.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.