Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
iconfalse

OperationsCommander supports a multilingual User Portal. In addition, multiple languages with different variations such as fr_ca (French Canadian) and fr_us (French American) are also supported.. Keep in mind that we can use this tool not only to create new languages but also to customize the wording on the user portal. 

This article will walk you through how you can use the language editor to support translations and add new languages.

Words that are added into the system by admins like Lot Names, Violation Numbers, Offences, etc.. will not be translatable or have a translation setup for them since these values are entered manually. To support multiple languages for these values we suggest creating lots and other names with both language variations. 

ex: Front Desk / Réception

Table of Contents

Twitterconnector
componentTypebuttonTweet
embedTypetweetButton
linkTweet
width460
lang
height500
tweetLimit20


Where are Translations Supported

Currently, translations are only supported on the user side, however they are managed and setup on the admin side by admins that have the correct permissions set up to work with languages. 

  1. Translations that are in red are translations on the adminside which are not yet supported. Since they are not supported you will see them come up in only English until the adminside is supported. 
  2. Translation that are in black are translations that are on the userside that can currently be changed. 

Navigating to Translations

To begin reviewing, editing or creating your translations/languages you will need to navigate to System Config → Translations. For the time being this functionality is in Beta so you will also see the Beta label next to the word Translations


This will take you to the Installed Languages page where you can begin managing your current languages.


Adding New Languages 

To begin adding your own languages simply click Add Language on the Installed Languages page which will bring up a new modal to add a label and locale. 


When you are finished click Save Changes and your new language will be instantly added to the list. Once the language has been added your users can begin using it on the user-side assuming you have the language enabled. 

The locales are used when we want to create sub-languages while the label is used to identify our translations throughout the site. 

Adding Sub Languages and How do They Work

Sub-languages are created by using a locale that currently exists with an underscore '_' followed by the sub-language that you want to set up. 



For example, you can support multiple variations of the English language for your users. In the image below I have created a sub-language for American English using the locale en_us. 


When you create a new sub-language, it will automatically use the translations that have been setup on the main language which is the locale on the left side of the underscore such as en_us. You will need to create the main language first before creating any sub-languages otherwise the sub-language will always default to english instead of the main language you may have intended to use. 

Installing Languages

Installing a language will create a new language template with the translations we have set up for it as well as the Name and Locale we have created for you. You can then click Edit Translations to adjust the preset translations to your liking. If there is not a language already in the system that can be installed you will need to add a new language and setup the translations yourself. Currently, we only support the ability to install French and English. 


Disabling or Enabling Translations 

We can choose to disable particular languages that we don't want to be selectable from the user side. To do this we can toggle the visibly of our languages under the Enabled column on the Installed Languages Page 



Once a language is toggled as Disabled it can no longer be selected by the users of your site as seen in the example image below. 


Searching Language Translations 

You can search for all translations that relate to a specific component in the system using the search bar at the top right of the Edit Translations page. For example, we can search for permits to find all permit related translations 



We can also go onto the user side and use the Token language which will show all of the Names found on the Edit Translations page under the Name column (See the image above) to find where that translation exists so it can be changed.  



The token language finds the tokens used so you can better search where the translations are being used on the userside. 

Edit Translations

To begin editing language translations you have to make your changes and then click away from the input field. Once you do this you will see that the translation gets highlighted in yellow indicating that a change has been made. The number of affected records will also display at the bottom of the translations page. 

When you are finished making your changes click Save Changes for the update to take effect. 

Delete Languages

To delete languages, you can click the delete button next to the language you want to remove. Keep in mind that if you remove the base English and French language it can be re-installed. However, if you delete a language that we do not provide you, then this data will be lost and you will need to contact support for assistance with recovering these translations. 


Keep in mind that deleting a language will not delete any of the sub-languages you may have created. For example, if I were to delete English, the English US language would still remain with all of its translations. 


Creating Templates and Messaging for New Languages

It's important to note that when you create a new language it will not rely on the default templates and system messaging that you have setup for your previous languages. For example, if I use the new French American language I created and go onto the userside where languages are supported then I will see a blank template as well as blank messages 


Adding Templates

To add a new template for your languages that you create you will need to go into Templates & Design followed by Toggle Templates for the templates that are currently being used. From there you will have the option to click the Create button to add the new template. If you just want your new language to use the same template from a language that is already in the system just go into Edit and copy the text over into your new language after clicking the Create button.

 

Adding System Messages

System messaging will work a bit differently than templates as you will need to go into each individual message and click the Edit button next to that message 


From there you should be able to select your new language



If you want multiple messages to display for all your languages you will need to create a new system message and type out the translations for that language template. 

Related Pages

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
cqllabel in ("ops-com","systemmessaging","templatesanddesign") and space = currentSpace()

Show If
special@authenticated


Warning
titleSupport Agent Notes
  • Make sure that the admins user role supports the ability to use languages in the system. 
  • If an admin creates a new language with a locale that already exists, it will override the previous language that uses that same locale. However, it does not delete it and for them to get the old language back they simply delete the new language that they just created. Once the new language gets deleted they will see the old language appear again so be careful they don't accidentally delete both entries since both entries could look similar. Additionally, you could look in the database to see how many additional entries they made to get back to the translation they wanted. 
  • Creating a new language using a locale that already exists in the system will throw an error. This is because you cannot re-use locales. 
  • All new languages are created in English until you edit all of the translations to what you want them to be unless you use the French language that we provide to our clients.  
  • sub-languages will take the translations from the main language. So for example, fr_en will use all of the french translations to start off, allowing you to go in and tweak the minor differences for your new sub-language. 
  • Languages found in RED are not supported yet because they are on the ADMIN SIDE while translations found in BLACK are found on the user side and are supported.

Test Cases

All TestRail test cases are added to the single JIRA task below, drill into this task to see the individual TestRail cases we have created for this

Jira
serverProjects
serverId2cd5be47-4b47-371a-a141-44aeb050c749
keyOC-4768



Info
iconfalse

OperationsCommander supports a multilingual User Portal. In addition, multiple languages with different variations such as fr_ca (French Canadian) and fr_us (French American) are also supported.. Keep in mind that we can use this tool not only to create new languages but also to customize the wording on the user portal. 

This article will walk you through how you can use the language editor to support translations and add new languages.

Words that are added into the system by admins like Lot Names, Violation Numbers, Offences, etc.. will not be translatable or have a translation setup for them since these values are entered manually. To support multiple languages for these values we suggest creating lots and other names with both language variations. 

ex: Front Desk / Réception

Table of Contents

Twitterconnector
componentTypebuttonTweet
embedTypetweetButton
linkTweet
width460
lang
height500
tweetLimit20


Where are Translations Supported

Currently, translations are only supported on the user side, however they are managed and setup on the admin side by admins that have the correct permissions set up to work with languages. 

  1. Translations that are in red are translations on the adminside which are not yet supported. Since they are not supported you will see them come up in only English until the adminside is supported. 
  2. Translation that are in black are translations that are on the userside that can currently be changed. 

Image Added

Navigating to Translations

To begin reviewing, editing or creating your translations/languages you will need to navigate to System Config → Translations. For the time being this functionality is in Beta so you will also see the Beta label next to the word Translations

Image Added


This will take you to the Installed Languages page where you can begin managing your current languages.


Image Added

Adding New Languages 

To begin adding your own languages simply click Add Language on the Installed Languages page which will bring up a new modal to add a label and locale. 


Image Added

When you are finished click Save Changes and your new language will be instantly added to the list. Once the language has been added your users can begin using it on the user-side assuming you have the language enabled. 

The locales are used when we want to create sub-languages while the label is used to identify our translations throughout the site. 

Adding Sub Languages and How do They Work

Sub-languages are created by using a locale that currently exists with an underscore '_' followed by the sub-language that you want to set up. 


Image Added


For example, you can support multiple variations of the English language for your users. In the image below I have created a sub-language for American English using the locale en_us. 


Image Added

When you create a new sub-language, it will automatically use the translations that have been setup on the main language which is the locale on the left side of the underscore such as en_us. You will need to create the main language first before creating any sub-languages otherwise the sub-language will always default to english instead of the main language you may have intended to use. 

Installing Languages

Installing a language will create a new language template with the translations we have set up for it as well as the Name and Locale we have created for you. You can then click Edit Translations to adjust the preset translations to your liking. If there is not a language already in the system that can be installed you will need to add a new language and setup the translations yourself. Currently, we only support the ability to install French and English. 


Image Added

Disabling or Enabling Translations 

We can choose to disable particular languages that we don't want to be selectable from the user side. To do this we can toggle the visibly of our languages under the Enabled column on the Installed Languages Page 


Image Added


Once a language is toggled as Disabled it can no longer be selected by the users of your site as seen in the example image below. 


Image Added

Searching Language Translations 

You can search for all translations that relate to a specific component in the system using the search bar at the top right of the Edit Translations page. For example, we can search for permits to find all permit related translations 


Image Added


We can also go onto the user side and use the Token language which will show all of the Names found on the Edit Translations page under the Name column (See the image above) to find where that translation exists so it can be changed.  


Image Added


The token language finds the tokens used so you can better search where the translations are being used on the userside. 

Edit Translations

To begin editing language translations you have to make your changes and then click away from the input field. Once you do this you will see that the translation gets highlighted in yellow indicating that a change has been made. The number of affected records will also display at the bottom of the translations page. 

Image Added

When you are finished making your changes click Save Changes for the update to take effect. 

Delete Languages

To delete languages, you can click the delete button next to the language you want to remove. Keep in mind that if you remove the base English and French language it can be re-installed. However, if you delete a language that we do not provide you, then this data will be lost and you will need to contact support for assistance with recovering these translations. 


Image Added

Keep in mind that deleting a language will not delete any of the sub-languages you may have created. For example, if I were to delete English, the English US language would still remain with all of its translations. 


Creating Templates and Messaging for New Languages

It's important to note that when you create a new language it will not rely on the default templates and system messaging that you have setup for your previous languages. For example, if I use the new French American language I created and go onto the userside where languages are supported then I will see a blank template as well as blank messages 


Image Added

Adding Templates

To add a new template for your languages that you create you will need to go into Templates & Design followed by Toggle Templates for the templates that are currently being used. From there you will have the option to click the Create button to add the new template. If you just want your new language to use the same template from a language that is already in the system just go into Edit and copy the text over into your new language after clicking the Create button.

Image Added 

Adding System Messages

System messaging will work a bit differently than templates as you will need to go into each individual message and click the Edit button next to that message 

Image Added


From there you should be able to select your new language


Image Added


If you want multiple messages to display for all your languages you will need to create a new system message and type out the translations for that language template. 

Related Pages

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
cqllabel in ("ops-com","systemmessaging","templatesanddesign") and space = currentSpace()

Show If
special@authenticated


Warning
titleSupport Agent Notes
  • Make sure that the admins user role supports the ability to use languages in the system. 
  • If an admin creates a new language with a locale that already exists, it will override the previous language that uses that same locale. However, it does not delete it and for them to get the old language back they simply delete the new language that they just created. Once the new language gets deleted they will see the old language appear again so be careful they don't accidentally delete both entries since both entries could look similar. Additionally, you could look in the database to see how many additional entries they made to get back to the translation they wanted. 
  • Creating a new language using a locale that already exists in the system will throw an error. This is because you cannot re-use locales. 
  • All new languages are created in English until you edit all of the translations to what you want them to be unless you use the French language that we provide to our clients.  
  • sub-languages will take the translations from the main language. So for example, fr_en will use all of the french translations to start off, allowing you to go in and tweak the minor differences for your new sub-language. 
  • Languages found in RED are not supported yet because they are on the ADMIN SIDE while translations found in BLACK are found on the user side and are supported.
  • If you change the locale of a language such as French or English, then it will move the language into its own group and take all of the translation with it. This means that the pages and system messaging wont change even though it might seem like the language got deleted with all its translations. 

Test Cases

All TestRail test cases are added to the single JIRA task below, drill into this task to see the individual TestRail cases we have created for this

Jira
serverProjects
serverId2cd5be47-4b47-371a-a141-44aeb050c749
keyOC-4768