Export (0) Print
Expand All

Set-SPTranslationServiceApplication

SharePoint 2013
 

Applies to: SharePoint Server 2013 Enterprise

Topic Last Modified: 2013-12-18

Sets property settings on a Machine Translation service application.

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

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

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.TranslationServices.Powershell.TranslationServiceApplicationPipeBind

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).

AddEnabledFileExtensions

Optional

System.String[]

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().

ApplicationPool

Optional

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

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

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.

ClearEnabledFileExtensions

Optional

System.Management.Automation.SwitchParameter

Disables all file extensions for the Machine Translation 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

DatabaseCredential

Optional

System.Management.Automation.PSCredential

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.

DatabaseName

Optional

System.String

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

DatabaseServer

Optional

System.String

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

DisableBinaryFileScan

Optional

System.Nullable

Determines whether Gatekeeper is run on binary files.

EnableAllFileExtensions

Optional

System.Management.Automation.SwitchParameter

Enables all file extensions for the Machine Translation Service application.

FailoverDatabaseServer

Optional

System.String

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

JobExpirationDays

Optional

System.Nullable

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

KeepAliveTimeout

Optional

System.Nullable

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.

MachineTranslationAddress

Optional

System.String

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

MachineTranslationCategory

Optional

System.String

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

MachineTranslationClientId

Optional

System.String

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

MaximumBinaryFileSize

Optional

System.Nullable

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.

MaximumItemsPerDay

Optional

System.Nullable

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 100 to 1000000. A value of zero indicates no limit. The default value is zero.

MaximumItemsPerPartitionPerDay

Optional

System.Nullable

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 100 to 1000000. A value of zero indicates no limit. The default value is zero.

MaximumSyncTranslationRequests

Optional

System.Nullable

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 25.

MaximumTextFileSize

Optional

System.Nullable

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.

MaximumTranslationAttempts

Optional

System.Nullable

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.

MaximumTranslationTime

Optional

System.Nullable

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.

MaximumWordCharacterCount

Optional

System.Nullable

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.

RecycleProcessThreshold

Optional

System.Nullable

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.

RemoveEnabledFileExtensions

Optional

System.String[]

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().

TimerJobFrequency

Optional

System.Nullable

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.

TotalActiveProcesses

Optional

System.Nullable

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.

TranslationsPerInstance

Optional

System.Nullable

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.

UseDefaultInternetSettings

Optional

System.Management.Automation.SwitchParameter

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

WebProxyAddress

Optional

System.String

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

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

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

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft