/
UI Translations:  Managing Translations in the EVA Portal

UI Translations:  Managing Translations in the EVA Portal

 

 Introduction

This guide will help you understand how to manage translations on the EVA portal. You'll learn how to upload and download translation files, update translations, and handle errors. 

 

 

Downloading Translations

To download the current translations:

  1. Go to the "Translations" page under "Utils."

  1. Click the "Download translations" button.

  1. The system will generate a CSV file with the current literals and translations.

 

The CSV file contains the literals and literal ids along with the translations in different locales. Below, is the image sample of csv:

 

You can update the required labels in the locales and upload the file. This uploaded file will reflect updated labels in the application.

Uploading Translations

To upload a translation file:

  1. Navigate to the "Translations" section under "Utils."

  1. Click the "Upload translations" button.

  1. In the dialog window, select a CSV file and click "Open."

  1. The system will upload the file and update the literals accordingly.

 

**Note:** Only CSV files are accepted. Ensure your file follows the correct format: a header row with columns such as `literal`, `created_at`, `en`, `fr`, etc.

 

Managing Literals and Translations

Creating New Literals:

  • Literals are used to rephrase the name of the labels in the same language.

  • If a new literal (e.g., 'ABC') is in the uploaded CSV file and does not exist in the system, it will be created with the provided translations.

Updating Existing Translations

  • Translation is used to translate a label into different languages.

  • If an existing literal (e.g., 'ABC') is in the uploaded CSV file, the translations will be updated accordingly.

  • Empty cells in the CSV file will clear previous translations.

Deleting Literals

  • If a literal (e.g., 'ABC') is not in the uploaded CSV file and has no translations, it will be deleted from the system.

Note: To delete a literal with translations, first clear all translations for that literal in the file, then remove the literal.

Viewing Translation Upload History

On the "Translations" page, you can see details about the most recent uploads, including the date, time, and user who uploaded the file. Errors encountered during the upload will also be listed.

Validations of CSV files for uploading:

  1. When uploading a translation file, ensure:

  • The header row includes the correct columns (e.g., `literal`, `created_at`), otherwise a warning message is displayed as mentioned in the image below:

 

  1.  The system will display a list of errors when the csv contains, -  duplicate literal names and there are leading or trailing spaces in literals.

 

 

Displaying Translations and Literals

  • If a literal has a translation for the current locale, the translated text will display.

  • If there is no translation, the literal itself will display.

 

By following this guide, you will be able to efficiently manage translations on the EVA portal, ensuring that the system's literals are accurately translated and up-to-date.

 

Labelling

Introduction

This guide will help you understand how to customize labels in the EVA portal. You'll learn how to change, import, export, and manage labels for your tenant.

Accessing the Labelling Page

  1. Navigate to the "System settings" section in the menu.

  2. Click on "Labelling."

  3. The Labelling page will open, displaying all existing translations for your tenant's localization.

Editing Labels:

  1. On the Labelling page, find the label you want to edit.

  2. Click the "Edit" button next to the label.

  3. An editable text area will appear where you can enter the new label.

  4. Click "Save" to apply the changes and it will be updated in the application or "Cancel" to discard them.

To clear a label:

  1. Click the "Clear" button next to the label.

  2. The new label value will be removed, reverting to the original label.

Filtering Labels

You can filter the labels using the following options:

  • Original Label:

    • Contains (default)

    • Does not contain

  • New Label:

    • Contains (default)

    • Does not contain

    • Is empty

    • Is not empty

Importing Labels

To import a CSV file with new labels:

  1. On the Labelling page, click the "Import" button.

  2. In the File Upload Dialog Window, select a CSV file and click "Open."

  3. The system will upload the file and update the labels accordingly.

Note: Only CSV files are accepted. Ensure your file follows the correct format, including columns like Original label and New label.

Exporting Labels

To export the current labels:

  1. On the Labelling page, click the "Export" button.

  2. The system will generate a CSV file with the current translations and new labels.

Validations while importing the CSV:

When importing a file, ensure:

  • The header row includes the correct columns.

  • There are no duplicate literals IDs

If there are any errors in the CSV, the system will display warning messages. Example image shown below displays error in case of wrong header

Displaying Labels

  • If a literal has a label for the current tenant, the label will display.

  • If there is no label, the literal or its translation will display.

Important Notes

  • After uploading a file or changing a label, refresh the page to see the updates.

  • Labels are specific to each tenant. Different tenants can have different labels for the same literal.

By following this guide, you will be able to efficiently customise and manage labels on the EVA portal, ensuring that the terminology used matches your specific needs.