Set-SPTranslationServiceApplication

Sets property settings on a Machine Translation service application.

Syntax

Set-SPTranslationServiceApplication
   [-Identity] <TranslationServiceApplicationPipeBind>
   [-AddEnabledFileExtensions <String[]>]
   [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-ClearEnabledFileExtensions]
   [-Confirm]
   [-DatabaseCredential <PSCredential>]
   [-DatabaseName <String>]
   [-DatabaseServer <String>]
   [-DisableBinaryFileScan <Boolean>]
   [-EnableAllFileExtensions]
   [-FailoverDatabaseServer <String>]
   [-JobExpirationDays <Int32>]
   [-KeepAliveTimeout <Int32>]
   [-MachineTranslationAddress <String>]
   [-MachineTranslationCategory <String>]
   [-MachineTranslationClientId <String>]
   [-MaximumBinaryFileSize <Int32>]
   [-MaximumItemsPerDay <Int32>]
   [-MaximumItemsPerPartitionPerDay <Int32>]
   [-MaximumSyncTranslationRequests <Int32>]
   [-MaximumTextFileSize <Int32>]
   [-MaximumTranslationAttempts <Int32>]
   [-MaximumTranslationTime <Int32>]
   [-MaximumWordCharacterCount <Int32>]
   [-RecycleProcessThreshold <Int32>]
   [-RemoveEnabledFileExtensions <String[]>]
   [-TimerJobFrequency <Int32>]
   [-TotalActiveProcesses <Int32>]
   [-TranslationsPerInstance <Int32>]
   [-UseDefaultInternetSettings]
   [-WebProxyAddress <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

Use the Set-SPTranslationServiceApplication cmdlet to set properties on a Machine Translation service application in the farm.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

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

C:\PS>Set-SPTranslationServiceApplication TranslationService -JobExpirationDays 14 -TotalActiveProcesses 3

This example sets the job expiration to 14 days and the number of worker processes per server to 3 for the Machine Translation Service application named TranslationService.

Required Parameters

-Identity

Specifies the URL or GUID of the instance of the Machine Translation service to set.

The type must be a valid URL in the form, http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).

Type:TranslationServiceApplicationPipeBind
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016

Optional Parameters

-AddEnabledFileExtensions

Comma delimited list of file extensions that you want to add to the set of enabled file extensions for the Machine Translation Service application

To return a list of supported file extensions, type [Microsoft.Office.TranslationServices.TranslationService]::EnumerateFileExtensions().

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-ApplicationPool

Specifies the managed application pool that the instance of Translation Service will run in.

Type:SPIisWebServiceApplicationPoolPipeBind
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-ClearEnabledFileExtensions

Disables all file extensions for the Machine Translation Service application.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-DatabaseCredential

Specifies the SQL Server credentials used for this Translation Service instance. This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-DatabaseName

Specifies the database name which is to be used for this Translation Service instance.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-DatabaseServer

Specifies the database server which is to be used for this Translation Service instance.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-DisableBinaryFileScan

Determines whether Gatekeeper is run on binary files.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-EnableAllFileExtensions

Enables all file extensions for the Machine Translation Service application.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-FailoverDatabaseServer

Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-JobExpirationDays

Specifies the amount of days after which completed jobs can be automatically removed from the Machine Translation Service queue database.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-KeepAliveTimeout

Specifies the length of time (in seconds) that the worker can be inactive before it is automatically stopped.

The valid values are 60 to 600. The default value is 60.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MachineTranslationAddress

Specifies the service URL the service application will use to call the translation provider. For example, https://api.microsofttranslator.com/v2/soap.svc

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MachineTranslationCategory

Specifies the category which will be used by the service when calling the translation provider.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MachineTranslationClientId

Specifies the AppId which will be used by the service when calling the translation provider.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumBinaryFileSize

Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain binary data. The valid values are 100 to 524288. The default value is 51200.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumItemsPerDay

Specifies the maximum number of items which can be added to the job queue in a 24-hour period. A value of zero indicates no limit.

The valid values are 1000 to 1000000. A value of zero indicates no limit. The default value is zero.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumItemsPerPartitionPerDay

Specifies the maximum number of items which can be added to the job queue in a 24-hour period per partition. A value of zero indicates no limit.

The valid values are 1000 to 1000000. A value of zero indicates no limit. The default value is zero.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumSyncTranslationRequests

Specifies the maximum number of items which can be added to the sync queue. A valid of zero indicates no limit.

The valid values are 0 to 300. The default value is 10.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumTextFileSize

Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain mostly text data. The valid values are 100 to 15360. The default value is 5120.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumTranslationAttempts

Specifies the maximum number of attempts an unsuccessful job is tried before it is marked as Failed.

The valid values are 1 to 10. The default value is 2.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumTranslationTime

Specifies the maximum length of time (in minutes) that a translation can take.

The valid values are 60 to 3600. The default value is 600.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MaximumWordCharacterCount

Specifies the maximum character count for a Microsoft Word document which can be translated.

The valid Int values are 10000 to 10000000. The default value is 500000.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-RecycleProcessThreshold

Specifies the number of documents which are translated before a Translation Worker process is recycled.

The valid values are 1 to 1,000. The default value is 100.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-RemoveEnabledFileExtensions

Comma delimited list of file extensions that you want to remove from the set of enabled file extensions for the Machine Translation Service application.

To return a list of supported file extensions, type [Microsoft.Office.TranslationServices.TranslationService]::EnumerateFileExtensions().

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-TimerJobFrequency

Specifies the frequency (in minutes) with which the timer job for this service application runs. The valid values are 1 to 59. The default value is 15 minutes.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-TotalActiveProcesses

Specifies the number of Translation Workers which are simultaneously running on a single machine.

The valid values are 1 to 5. The default value is 1.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-TranslationsPerInstance

Specifies the number of translations dispatched to each service instance every time the timer job is run.

Valid values are 1 to 1,000. The default value is 200.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-UseDefaultInternetSettings

Determines whether the service application will use default Internet settings for the user service account to connect to the translation provider.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-WebProxyAddress

Specifies the web proxy address and port that the service application will use to connect to the translation provider.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016