Enable UI languages | Censhare Documentation

For censhare Client and censhare Web

Supported locales

User interface of censhare Client, censhare Admin Client and censhare Web is available in several languages. The standard distribution of censhare is delivered with the following languages:

English
German
French
Italian
Spanish | censhare Web only!

English and German are enabled by default. The other languages from this list are available without any restrictions and can be enabled as described in this article. Adding custom languages/locales that are not available in the standard distribution is not supported.

1 - Add locale

Available languages are controlled in the master data.

Log into the censhare Admin Client.
Go to Configuration > Modules > Administration > Locales and activate Add/Delete Locale.
Update the server configuration.
From the Server Actions menu, select Add/Delete Locale.
Under Action, select Add.
In the Locale name field, enter the ID of the desired language: one of fr, it
1. fr for French
2. it for Italian
3. es for Spanish
Under Locale for default values, select a locale to be used if censhare does not find a localized key in the Master data. We recommend that you always select en here.
To run the server action, click OK. censhare creates the database columns for the new language.

To remove a language, select the action Remove. Select the desired language from Locale name. Click OK.

What happens in the background: database update information

A db-schema.patch file is created in the following location: censhare-Custom/censhare-Server/app/config/. Depending on the executed actions, the following tags will be added into the db-schema.patch file:

for removing a locale - <p:remove>
for adding a locale - <p:add>

2 - Populate the master data language columns

The correct localized values for the new language columns are stored in the insert-data.xml file. To make locale visible in the UI, you need to populate corresponding columns in the master data table. For this, you can use a server action that does a database update.

Prerequisites and important considerations

Database updates are critical actions and should be carefully considered.

Only run this action on a server with the direct database connection, e.g., on the master server
Backup the database before running this action
Do not run other database operations at the same time

For safety reasons, the server action that runs database updates, is disabled by default, and needs to be enabled before you can use it for adding a new locale.

Steps

Go to the censhare Admin Client.
Select Configuration → Modules → Administration → Maintenance → SQL Database Update and enable it.
From the Server Actions menu:
1. Select SQL Database Update
2. Check-in the box that you acknowledge the risks; otherwise the action won‘t be executed.
3. Click OK to run the server action.
4. Select and run Reload data cache server action.
To verify the results, in the censhare Admin Client, open any localized master data table, for example, Asset types. Open any standard record, for example, type Group, and check that an additional Name row for the newly added language is displayed. Also ensure that the name is localized correctly. Example: Name [fr] Groupe

Troubleshooting

If you saw a success message for the database update action, but do not see the new locale, you can check the logs populated upon its execution.

You will see the name of the log file in the success message. It can be found:

in the work/logs/ directory on the Server
in Censhare Web, on the System asset, under “Server logs” tab

3 - Add new language to general Server configuration

Classic installations

In the censhare Admin Client, open Configuration → Server → General. If a custom configuration already exists, open it.
In the Locales section at the bottom of the dialog, click and add the language code of the language that you want to enable.
To save the configuration, click OK.
Update the server configuration. If necessary, synchronize the remote servers.

Cloud installations

For Cloud installations, you need to modify your server.xml directly in the custom Git repository:

https://gitlab-ext.censhare.com/censhare-cloud/<customer-name>/censhare-Custom/-/tree/main/censhare-Server/app/config

4 - Restart Censhare Server

Classic installations

Stop and start the server as describe in (2025.2) Server management , using the SSH and bash scripts.

Cloud installations

Restart the Server from the Cockpit, as described in Restart censhare Server .

5 - Build new webpack bundle

Each time you add new languages, a new webpack bundle must be created.

Classic installations

Prerequisite

Yarn must be installed on the instance where you want to build the bundles.

Steps

For more information on webpack handling, see Build frontend bundles macos local (partner login required).

Perform the following steps on a test or dev instance.

Open the following file in a text editor: censhare-Client5/web/censhare.json.
Enter the required languages into the file.
Open Terminal.
Change to the censhare-Client5/web directory.
From there, execute the command:
```
yarn cs5 release
```
This command builds the webpack bundles for all languages that are defined in censhare.json. The compiled files can be found in censhare-Client5/web/dist/censhare5.

If your installation uses a different place to store the webpack bundles, you have to copy or move compiled files there manually.

Copy the webpack bundles to the production system.

Cloud installations

(partner login required)

Please follow steps in this article: Build and deploy frontend bundles in Censhare Cloud . The locale needs to be added in each of the branding.json files.

6 - Synchronize module assets

Back in the Admin Client, execute two server actions (select the first option in both of them):

Synchronize module assets - optional
Synchronize module assets - required

Result

System languages that you added can be selected in the censhare Client in the File ► Locale menu, and in Censhare Web in the user preferences in the User interface language field.
Content languages that you added are available in any localized asset property and in Censhare Web in the user preferences in the Preview language field.