Set-SPWordViewingServiceApplication
Applies to: Word Online
Topic Last Modified: 2010-02-11
Sets a global property for a Word Viewing Service application.
Syntax
Set-SPWordViewingServiceApplication [-Identity] <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DisableBinaryScan <SwitchParameter>] [-DisableEmbeddedFonts <SwitchParameter>] [-EnableBinaryFormatSupport <SwitchParameter>] [-EnableOpenXmlFormatSupport <SwitchParameter>] [-KeepAliveTimeoutInSeconds <Int32>] [-LocalCacheStoreDirectory <String>] [-LocalCacheTimeoutInSeconds <Int32>] [-MaxActiveProcessCount <Int32>] [-MaxRenderingLifetimeInSeconds <Int32>] [-RecycleActiveProcessCount <Int32>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-SPWordViewingServiceApplication cmdlet changes global run-time properties for a Word Viewing Service application.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind |
Specifies the unique identity of a service application. |
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. Note 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 |
DisableBinaryScan |
Optional |
System.Management.Automation.SwitchParameter |
Disables binary document scanning for corruption or other malicious content. The valid values are True or False. The default value is False. |
DisableEmbeddedFonts |
Optional |
System.Management.Automation.SwitchParameter |
Disables support for rendering embedded fonts in Microsoft Word documents. The valid values are True or False. The default value is False. |
EnableBinaryFormatSupport |
Optional |
System.Management.Automation.SwitchParameter |
Enables support for binary file formats in the Word Viewing Service application. The value values are True or False. The default value is True. |
EnableOpenXmlFormatSupport |
Optional |
System.Management.Automation.SwitchParameter |
Enables support for XML-based file formats in the Word Viewing Service application. The value values are True or False. The default value is True. |
KeepAliveTimeoutInSeconds |
Optional |
System.Int32 |
Specifies the amount of time, in seconds, that a worker process is allowed to be nonresponsive before it is terminated. Changes to this setting require an IISReset command to take effect. The type must be an integer in the range of 5 to 3600. |
LocalCacheStoreDirectory |
Optional |
System.String |
Specifies the location of the temporary cache for use by the Word Viewing Service application. Changes to this setting require an IISReset command to take effect. The default value is %temp%\waccache.. |
LocalCacheTimeoutInSeconds |
Optional |
System.Int32 |
Specifies the amount of time, in seconds, that an output file remains on the application server. Changes to this setting require an IISReset command to take effect. The default value is 300. |
MaxActiveProcessCount |
Optional |
System.Int32 |
Specifies the number of active processes available to render Word documents. The default value is 3. Changes to this parameter require an IISReset command to take effect. |
MaxRenderingLifetimeInSeconds |
Optional |
System.Int32 |
Specifies the total amount of time, in seconds, that a worker process is allowed to process a particular rendition. Changes to this setting require an IISReset to take effect. |
RecycleActiveProcessCount |
Optional |
System.Int32 |
Specifies the number of files that a single process is allowed to render before the Word Viewing Service Application recycles the process. Changes to this setting require an IISReset command to take effect. The default value is 5. |
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 |
Input Types
Return Types
Example
---------------EXAMPLE 1-----------
Get-SPIisWebServiceApplicationPool -Identity "SharePoint Web Services System" | New-SPWordViewingServiceApplication -Name "My Service Application" | Set-SPWordViewingServiceApplication -MaxActiveProcessCount 10 -LocalCacheStoreDirectory "C:\temp"
This example creates a new Word Viewing Service Application, setting the maximum number of processes available for render to 10, and the local cache directory to C:\temp.