How to translate terms or sentences using Translate()?

About this article

This article will explain what the Translate() function is and provide examples of how it can be utilized with the binding syntax in smart templates.  

• What is the Translate() function? 
• Translate() function examples

 

Prerequisites

Library and at least one Dynamics modules enabled Templafy Desktop and Office VSTO add-in installed on the PC Tenant admin/owner access or Space owner access Languages were added in the Admin Center and the Translation data source is populated

 

What is the Translate() function? 

Translate() is a function that allows the translation of specific terms or complete sentences by returning specific values from the Translations data source. When utilizing the Translate() function, the value present in the Name column of the Translations data source will be utilized to resolve the value from the desired language column.

 

Translate() logic

Syntax	{{Translate(NameValueToLookUp, ColumnName)}}

• NameValueToLookUp must be present in the Name column of the Translations data source and will be used to identify the row that should be utilized for the translation.
• ColumnName will be utilized to resolve the desired language column

If the user profile contains a Language dropdown called DocumentLanguage, a simplified syntax can be used that will automatically use the language column set in the user profile

Syntax	{{Translate(NameValueToLookUp)}}

 

The Translate function is case-sensitive. If the ColumnName or if  theDocumentLanguage cannot be found, or if no value exists for the language in the Translations data source, the value of the Name column will be used instead.

 

Translate() function examples

The below data sources and user profile field will be used in the examples: 

Please note that creating data sources requires owner or admin rights to the tenant.

 

Languages data source: 

 

Translations data source: 

 

The language columns are automatically created when adding languages to the tenant.

 

User profile using DocumentLanguage:

 

The word 'DocumentLanguage' is a reserved word within Templafy. If you use this in theNamefield, it can be used in many bindings, for example to set the proofing language.

 

Example 1

Using the Translate() function to translate "Subject" to Dutch.

Binding	{{Translate("Subject", "nl-NL")}}
Output	Onderwerp

 

If the nl-NL column couldn't be found, then the output would be "Subject" as it would default back to the value existing in the Name column of the Translations data source. As the Translate() function is case-sensitive, the name in the Translations data source needs to be "Subject" (not "subject").

 

Example 2

Using the Translate() function to translate "Subject" based on DocumentLanguage set in the user profile.

Binding	{{Translate("Subject", DocumentLanguage)}}
Input	DocumentLanguage = "nl-NL"	DocumentLanguage = "fr-FR"	DocumentLanguage = not set
Output	Onderwerp	Sujet	Subject

 

{{Translate("Subject")}} could have also been used to resolve the language set in the user profile with the DocumentLanguage field.

 

Example 3

Using the Translate() function to translate "Subject" based on DocumentLanguage selected by the user in the response form.

Binding	{{Translate("Subject", Form.DocumentLanguage.Language)}}
Input	DocumentLanguage = "nl-NL"	DocumentLanguage = "fr-FR"	DocumentLanguage = not set
Output	Onderwerp	Sujet	Subject

 

Example 4

Using the Translate() together with FormatDateTime() function to show a specific date format depending on theDocumentLanguage set in the user profile.

Binding	{{FormatDateTime(Form.Date, Translate("FormatLongDate", DocumentLanguage), DocumentLanguage)}}
Input	Date = 4 October 2021 DocumentLanguage = "nl-NL"	Date = 4 October 2021 DocumentLanguage = "fr-FR"	Date = 4 October 2021 DocumentLanguage = "en-US"
Output	maandag 4 oktober 2021	lundi 04 oct. 2021	Mon 4 October 2021

 

The binding {{FormatDateTime(Form.Date, Translate("FormatLongDate", UserProfile.DocumentLanguage.Language), UserProfile.DocumentLanguage.Language)}} can also be used. If the DocumentLanguage is not set then an unexpected value is shown (because the system tries to format the text 'FormatLongDate' as a date). The solution is to make the DocumentLanguage field required.

 

Related articles

Document language How to use the system-generated data source "Translations"? Configuration of form fields in the User Profile What is the binding syntax used in smart templates? What are functions, conditions, and operators? What are smart fields? What are template settings and properties? How to adjust the visibility of smart fields?