Integrating translation jobs with SDL TMS

This tutorial explains how to configure an integration with SDL TMS.

Set the deploymentName variable

First set the deploymentName variable.

$deploymentName="InfoShare"

Create mappings between SDL TMS languages and Content Manager languages

As SDL TMS and SDL Tridion Docs Content Manager use different identifiers for the languages, we need to create a mapping.

Use the New-ISHIntegrationTMSMapping cmdlet to create one mapping. Add multiple mappings into an array to describe all the necessary mappings.

For example:

# Create an array of mappings

$mappings=@(
    New-ISHIntegrationTMSMapping -ISHLanguage af -TMSLanguage AF
    New-ISHIntegrationTMSMapping -ISHLanguage sq -TMSLanguage SQ
    New-ISHIntegrationTMSMapping -ISHLanguage am -TMSLanguage AM
    New-ISHIntegrationTMSMapping -ISHLanguage ar -TMSLanguage AR-SA  
    New-ISHIntegrationTMSMapping -ISHLanguage hy -TMSLanguage HY
    New-ISHIntegrationTMSMapping -ISHLanguage as -TMSLanguage AS
    New-ISHIntegrationTMSMapping -ISHLanguage az -TMSLanguage AZ-XE  
    New-ISHIntegrationTMSMapping -ISHLanguage eu -TMSLanguage EU
    New-ISHIntegrationTMSMapping -ISHLanguage bn -TMSLanguage BN
    New-ISHIntegrationTMSMapping -ISHLanguage bs -TMSLanguage BS
    New-ISHIntegrationTMSMapping -ISHLanguage bg -TMSLanguage BG
    New-ISHIntegrationTMSMapping -ISHLanguage ca -TMSLanguage CA
    New-ISHIntegrationTMSMapping -ISHLanguage zh -TMSLanguage ZH-HK  
    New-ISHIntegrationTMSMapping -ISHLanguage hr -TMSLanguage HR
    New-ISHIntegrationTMSMapping -ISHLanguage cs -TMSLanguage CS
    New-ISHIntegrationTMSMapping -ISHLanguage da -TMSLanguage DA
    New-ISHIntegrationTMSMapping -ISHLanguage nl -TMSLanguage NL
    New-ISHIntegrationTMSMapping -ISHLanguage en -TMSLanguage EN-US  
    New-ISHIntegrationTMSMapping -ISHLanguage et -TMSLanguage ET
    New-ISHIntegrationTMSMapping -ISHLanguage fa -TMSLanguage FA
    New-ISHIntegrationTMSMapping -ISHLanguage fi -TMSLanguage FI
    New-ISHIntegrationTMSMapping -ISHLanguage fr -TMSLanguage FR
    New-ISHIntegrationTMSMapping -ISHLanguage gl -TMSLanguage GL
    New-ISHIntegrationTMSMapping -ISHLanguage de -TMSLanguage DE
    New-ISHIntegrationTMSMapping -ISHLanguage el -TMSLanguage EL
    New-ISHIntegrationTMSMapping -ISHLanguage gu -TMSLanguage GU
    New-ISHIntegrationTMSMapping -ISHLanguage ha -TMSLanguage HA
    New-ISHIntegrationTMSMapping -ISHLanguage he -TMSLanguage HE
    New-ISHIntegrationTMSMapping -ISHLanguage hi -TMSLanguage HI
    New-ISHIntegrationTMSMapping -ISHLanguage hu -TMSLanguage HU
    New-ISHIntegrationTMSMapping -ISHLanguage is -TMSLanguage IS
    New-ISHIntegrationTMSMapping -ISHLanguage ig -TMSLanguage IG
    New-ISHIntegrationTMSMapping -ISHLanguage id -TMSLanguage IN
    New-ISHIntegrationTMSMapping -ISHLanguage it -TMSLanguage IT
    New-ISHIntegrationTMSMapping -ISHLanguage ja -TMSLanguage JA
    New-ISHIntegrationTMSMapping -ISHLanguage kn -TMSLanguage KN
    New-ISHIntegrationTMSMapping -ISHLanguage ka -TMSLanguage KA
    New-ISHIntegrationTMSMapping -ISHLanguage kk -TMSLanguage KK
    New-ISHIntegrationTMSMapping -ISHLanguage km -TMSLanguage KM
    New-ISHIntegrationTMSMapping -ISHLanguage ky -TMSLanguage KY
    New-ISHIntegrationTMSMapping -ISHLanguage ko -TMSLanguage KO
    New-ISHIntegrationTMSMapping -ISHLanguage lv -TMSLanguage LV
    New-ISHIntegrationTMSMapping -ISHLanguage lt -TMSLanguage LT
    New-ISHIntegrationTMSMapping -ISHLanguage mk -TMSLanguage MK
    New-ISHIntegrationTMSMapping -ISHLanguage ms -TMSLanguage MS-MY  
    New-ISHIntegrationTMSMapping -ISHLanguage ml -TMSLanguage ML
    New-ISHIntegrationTMSMapping -ISHLanguage mr -TMSLanguage MR
    New-ISHIntegrationTMSMapping -ISHLanguage mn -TMSLanguage MN-XC  
    New-ISHIntegrationTMSMapping -ISHLanguage my -TMSLanguage MY
    New-ISHIntegrationTMSMapping -ISHLanguage no -TMSLanguage NO-NO  
    New-ISHIntegrationTMSMapping -ISHLanguage or -TMSLanguage OR
    New-ISHIntegrationTMSMapping -ISHLanguage ps -TMSLanguage PS
    New-ISHIntegrationTMSMapping -ISHLanguage pl -TMSLanguage PL
    New-ISHIntegrationTMSMapping -ISHLanguage pt -TMSLanguage PT
    New-ISHIntegrationTMSMapping -ISHLanguage pa -TMSLanguage PA
    New-ISHIntegrationTMSMapping -ISHLanguage ro -TMSLanguage RO
    New-ISHIntegrationTMSMapping -ISHLanguage ru -TMSLanguage RU
    New-ISHIntegrationTMSMapping -ISHLanguage sr -TMSLanguage SR
    New-ISHIntegrationTMSMapping -ISHLanguage st -TMSLanguage ST
    New-ISHIntegrationTMSMapping -ISHLanguage si -TMSLanguage SI
    New-ISHIntegrationTMSMapping -ISHLanguage sk -TMSLanguage SK
    New-ISHIntegrationTMSMapping -ISHLanguage sl -TMSLanguage SL
    New-ISHIntegrationTMSMapping -ISHLanguage es -TMSLanguage ES
    New-ISHIntegrationTMSMapping -ISHLanguage sw -TMSLanguage SW
    New-ISHIntegrationTMSMapping -ISHLanguage sv -TMSLanguage SV
    New-ISHIntegrationTMSMapping -ISHLanguage tl -TMSLanguage TL
    New-ISHIntegrationTMSMapping -ISHLanguage tg -TMSLanguage TG
    New-ISHIntegrationTMSMapping -ISHLanguage ta -TMSLanguage TA
    New-ISHIntegrationTMSMapping -ISHLanguage te -TMSLanguage TE
    New-ISHIntegrationTMSMapping -ISHLanguage th -TMSLanguage TH
    New-ISHIntegrationTMSMapping -ISHLanguage tr -TMSLanguage TR
    New-ISHIntegrationTMSMapping -ISHLanguage tk -TMSLanguage TK
    New-ISHIntegrationTMSMapping -ISHLanguage uk -TMSLanguage UK
    New-ISHIntegrationTMSMapping -ISHLanguage ur -TMSLanguage UR
    New-ISHIntegrationTMSMapping -ISHLanguage uz -TMSLanguage UZ-XL  
    New-ISHIntegrationTMSMapping -ISHLanguage vi -TMSLanguage VI
    New-ISHIntegrationTMSMapping -ISHLanguage xh -TMSLanguage XH
    New-ISHIntegrationTMSMapping -ISHLanguage yo -TMSLanguage YO
    New-ISHIntegrationTMSMapping -ISHLanguage zu -TMSLanguage ZU
)

Create templates

Use the New-ISHIntegrationTMSTemplate cmdlet to create one template. Add multiple templates into an array to describe all the necessary mappings.

For example:

# Create an array of templates

$templates=@(
    New-ISHIntegrationTMSTemplate -Name "Template1" -TemplateId "81143C38-0C96-4A8C-9BBB-87C1CF464FE3"
    New-ISHIntegrationTMSTemplate -Name "Template2" -TemplateId "70407FBC-86FA-4A9D-8E6D-35E1AE85DB73"
)

Create a request and group metadata

Use the New-ISHFieldMetadata cmdlet to create one metadata field representation. Add multiple fields into an array to describe all the necessary fields.

For example:

# Create an array of requested metadata

$requestMetadata=@(
    New-ISHFieldMetadata -Name FAUTHOR -Level lng -ValueType value
    New-ISHFieldMetadata -Name DOC-LANGUAGE -Level lng -ValueType value
)

# Create an array of group metadata

$groupMetadata=@(
    New-ISHFieldMetadata -Name FAUTHOR -Level lng -ValueType value
    New-ISHFieldMetadata -Name DOC-LANGUAGE -Level lng -ValueType value
)

Configure the integration with SDL TMS

To configure the integration with SDL TMS, use the Set-ISHIntegrationTMS cmdlet. The integration requires the following information:

The URI for TMS's service.
The APIkey and secret to access the TMS service, or use the -Credential parameter of PSCredential type to specify a username and a password (as supported from the 13.0.3 version of Content Manager for the new TMS 12.1 authentication).
The mapping configuration created above.
The template configuration created above.
The metadata configuration created above that is pushed to TMS.
The metadata configuration created above that groups items in TMS.

Note: The optional parameter -MaximumJobSize corresponds to the parameter "externalJobMaxTotalUncompressedSizeBytes" from the TMS configuration section.

# Uri and credentials for SDL TMS
$uri="http://tms.example.com/"

$apiKey="ApiKey"
$secretKey="SecretKey"

# Set the integration with required parameters
Set-ISHIntegrationTMS -ISHDeployment $deploymentName -Name TMS -Uri $uri -Mappings $mappings -Templates $templates -ApiKey $apiKey -SecretKey $secretKey

# Set the integration with extra parameters
Set-ISHIntegrationTMS -ISHDeployment $deploymentName -Name TMS -Uri $uri -Mappings $mappings -Templates $templates -RequestMetadata $requestMetadata -GroupMetadata $groupMetadata -ApiKey $apiKey -SecretKey $secretKey

Note: Content Manager requires that only one connector for SDL TMS is configured.

Remove the integration with SDL TMS

Use Remove-ISHIntegrationTMS -ISHDeployment $deploymentName.