Skip to main content
Version: 8.3

system.util.modifyTranslation

This function is used in Python Scripting.

Description​

This function allows you to add or modify a global translation.

Client Permission Restrictions​

Permission Type: Translation Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax​

system.util.modifyTranslation(term, translation, [locale])

Parameters​

TypeParameterDescription
StringtermThe key term to translate.
StringtranslationThe translated value to store.
StringlocaleIf specified, the locale identifying the language of the translation, such as "es" or "es-ES". Accepts both the BCP-47 language tag (recommended) and the legacy underscore formats. Make sure to use locale codes for either format, and not language names, such as "Spanish". Otherwise, the currently set language is used. [optional]

Returns​

Nothing

Scope​

Gateway, Vision Client, Perspective Session

Code Examples​

Example #1
# This code adds or updates a translation into French
# for the world Hello. Note the u in front "AllΓ΄!", which
# is needed for Python strings outside of the 7-bit ASCII
# range.
system.util.modifyTranslation("Hello", u"AllΓ΄!", "fr")