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

Set-SPWordConversionServiceApplication

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets properties of a Word Automation Services application.

Set-SPWordConversionServiceApplication [-Identity] <WordServiceApplicationPipeBind> [-ActiveProcesses <Nullable>] [-AddSupportedFormats <String[]>] [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-ClearSupportedFormats <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-ConversionsPerInstance <Nullable>] [-ConversionTimeout <Nullable>] [-DatabaseCredential <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] [-DisableBinaryFileScan <SwitchParameter>] [-DisableEmbeddedFonts <SwitchParameter>] [-KeepAliveTimeout <Nullable>] [-MaximumConversionAttempts <Nullable>] [-MaximumConversionTime <Nullable>] [-MaximumGroupSize <Nullable>] [-MaximumMemoryUsage <Nullable>] [-RecycleProcessThreshold <Nullable>] [-RemoveSupportedFormats <String[]>] [-TimerJobFrequency <Nullable>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind

Specifies the Word Automation Services application to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object.

ActiveProcesses

Optional

System.Nullable

Specifies the number of conversion processes on each machine on which the service application runs. This value is equivalent to the number of simultaneous conversions. The default value is 8.

The type must be a valid integer in the range from 1 to 1000.

AddSupportedFormats

Optional

System.String[]

Specifies a set of file formats to be enabled for use by the service application.

The value must be a comma-delimited list of one or more of the following: docx, doc, mht, rtf, xml.

ApplicationPool

Optional

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies the existing IIS managed application pool in which this instance of Word Automation Services runs.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object.

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.

ClearSupportedFormats

Optional

System.Management.Automation.SwitchParameter

Specifies that all file formats should be disabled for use by the service application.

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

ConversionsPerInstance

Optional

System.Nullable

Specifies the number of items sent to each conversion process (see the ActiveProcesses parameter description earlier in this table) every time the timer job is run. The default value is 12.

The type must be a valid integer.

ConversionTimeout

Optional

System.Nullable

Specifies the time, in minutes, after which a conversion that is marked InProgress is confirmed to be still running each time the timer job runs and, if necessary, the conversion is restarted. The default value is 5.

The type must be a valid integer in the range from 1 to 60.

DatabaseCredential

Optional

System.Management.Automation.PSCredential

Specifies the credentials to use for connecting to the database for the Word Automation Services application. Use this parameter only if SQL Authentication is used to access the service application database.

When the DatabaseCredential parameter is specified, the DatabaseName and DatabaseServer parameters are required.

DatabaseName

Optional

System.String

Specifies the name of the database to use for this instance of the Word Automation Services application.

The type must be a valid SQL database name; for example, MetadataDB1.

DatabaseServer

Optional

System.String

Specifies the name of the host server for the Word Automation Services database.

The type must be a valid SQL database server host name; for example, SQLServerHost1.

DisableBinaryFileScan

Optional

System.Management.Automation.SwitchParameter

Specifies whether additional checks are run when Word 97 to Word 2003 documents are processed. Turn this setting off only if all documents processed by the service are trusted.

DisableEmbeddedFonts

Optional

System.Management.Automation.SwitchParameter

Specifies whether embedded fonts are ignored when present in input documents.

KeepAliveTimeout

Optional

System.Nullable

Specifies the length of time, in seconds, that a conversion can be non-responsive before it is terminated. The default value is 30.

The type must be a valid integer in the range from 10 to 60.

MaximumConversionAttempts

Optional

System.Nullable

The maximum number of conversion attempts before a conversion is marked with status "Failed". The default value is 2.

The type must be a valid integer in the range from 1 to 10.

MaximumConversionTime

Optional

System.Nullable

Specifies the maximum length of time, in seconds, that a conversion can run before it is terminated. The default value is 300.

The type must be a valid integer in the range from 60 to MaxInt.

MaximumMemoryUsage

Optional

System.Nullable

Specifies the maximum percentage of system memory which can be used by the service application. The default value is 100.

The type must be a valid integer in the range from 10 to 100.

RecycleProcessThreshold

Optional

System.Nullable

Specifies the number of documents which are converted before a conversion process is recycled. For additional information about the conversion process, see the ActiveProcess parameter description earlier in this table.

The type must be a valid integer in the range from 1 to 1000.

RemoveSupportedFormats

Optional

System.String[]

Specifies a set of file formats to be disabled for use by the service application.

The value must be a comma delimited list of one or more of the following: docx, doc, mht, rtf, xml.

TimerJobFrequency

Optional

System.Nullable

Specifies the frequency, in minutes, with which the timer job for this service application runs. The default value is 15.

The type must be a valid integer in the range from 1 to 59.

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-SPWordConversionServiceApplication cmdlet sets global properties of a Word Automation Services application.

Input Types

Return Types

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

Get-SPServiceApplication –Name WordServices1 | Set-SPWordConversionServiceApplication -TimerJobFrequency 30

This example sets the timer job frequency of the WordServices1 application to 30 minutes.

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.