Summary

The Multi-Language Configuration feature allows for the customization of user interface (UI) elements in different languages using the API Translation functionality. This is particularly useful for supporting diverse user bases across multiple regions and improving user experience by presenting content in the user's preferred language.

By default, all label attributes and display text within the UI are presented in English. However, with this configuration enabled, you can define and apply translated values for various UI components, ensuring that the interface reflects the desired language settings based on user or site-specific requirements.

It is important to note that Annex Cloud does not provide translation services. Instead, it offers a structured way to store translated text values within the system. These stored translations can then be retrieved dynamically through API responses and used in the front-end display.

For example:

• A label such as “Points Balance” can be translated and stored in multiple languages like “Saldo de Puntos” (Spanish), “Punktestand” (German), or “Solde de Points” (French).
• Based on the member’s language preference, the appropriate version of the label can be fetched via the API and displayed in the UI.

This approach gives flexibility to businesses to manage localization at their own pace and with their own resources while leveraging the platform's ability to support multilingual experiences through API-based translations.

Navigation: Products > Additional Loyalty Settings > API Translation

In the Annex Cloud system, English is set as the default language. When the API Translation toggle is enabled, English automatically appears as the default entry in the language configuration table. This serves as the base language against which other translations can be added for supported UI labels and values.

To add an additional language to the UI

1. Click Add New Language.
2. From the drop-down list, select the desired language you want to configure.
3. Click Save to apply the changes.
   

Once a language is added, it appears in the language configuration table along with its associated details and options to manage or review its settings:

• Language: Displays the name of the selected language (in English).
• Language Code: An ISO 639-1 format standard code used to identify the language in API responses (e.g., en for English, fr for French).
• Status: A toggle switch to enable or disable the language. When toggled ON, the language is active and available for translations.
• Action:
• Edit: Allows you to modify the selected language for that row without the need to remove and re-add it.
  

• Delete: Permanently remove the language entry from the configuration table.

• Audit: The Audit option provides a detailed log of all modifications made to the language configuration. This includes:
• State changes to the Enabled API Translation: Tracks when the API Translation toggle is turned ON or OFF.
• Language removal logs: Records instances where a language was deleted from the configuration table.
• Language edit history: Captures edits made to the language in the respective row, including changes to the selected language or code.

Accessing Text Translation

Click Text Translation to open a window containing various options for managing translations. This section allows you to:

• Synchronize Text: Ensure that all existing translations are up to date across the system.
• Upload Translations: Import translated text for different languages in bulk using supported file formats.

These options help streamline the process of maintaining consistent and accurate multilingual content across your UI.

Options for Adding or Updating Translations in the Text Translation Tab

There are two primary methods for adding or updating translations:

Inline Updates

The Text Translation tab displays a data grid where:

• All field labels appear in English (the default language).
• For each additional language configured on the site, corresponding columns are shown with blank or editable fields.

To update translations using the inline method, click the edit icon for the desired row in the data grid. This opens the Edit Translation Language pop-up, where you can enter translated values for any of the additional languages configured on the site. Once you have entered the necessary translations, click Save to apply the changes. You can repeat this process for any field labels that require translation, making it easy to manage individual entries directly within the interface.

Select Module:

Choose loyalty from the module dropdown to begin synchronizing translated field labels related to member engagement and rewards.

Select Sub-Module:

Within the Loyalty module, you can select from the following sub-modules to synchronize:

• Actions
• Action Series
• Rewards (including External Rewards)
• Tiers
• Campaigns
• Segmentation
• Badges
• Badge Attributes
• Reward Attributes

Status:

You can filter the sub-modules using the status dropdown, which includes three options:

• All – Displays both active and inactive sub-modules.
• Active – Displays only sub-modules currently available for synchronization.
• Inactive – Displays sub-modules that are currently not in use or available for synchronization.

The successful completion of the scheduled job indicates that the selected sub-modules have been successfully added to the translation list. This ensures that their associated field labels are now included in the synchronization process and are available for translation within the system.

Upload a translation file

Instead of entering translation values manually, you can upload them in bulk using the following steps:

• Click Upload Translation.
• Click Download to get the CSV file.

A sample of the CSV file can be accessed from here: https://static.helpjuice.com/helpjuice_production/uploads/upload/image/17911/direct/1752648165497/Multi_Language_Translation_92469780_0_1750657296106.csv

• Open the CSV file and fill in the translated values for the required field labels in the configured languages.
• To upload the file with translated values click Select File and choose your completed CSV file using the standard file selection window.
• Click Upload.
• A confirmation message will appear, indicating that the upload was successful.
• The translated values will now be displayed in the data grid.

Publish Translations

Once all translations have been completed either through manual entry or by uploading a file you must click Publish to save the translated values to the database. Until this action is taken, the changes remain unsaved and are not reflected in the system. After clicking Publish, a confirmation page will appear prompting you to review and confirm the modifications. Once confirmed, the translations are successfully stored and made available for use across the platform. This step ensures that all updates are finalized and active in the live environment.

When you accept the confirmation message after publishing, a notification appears indicating the changes that were successfully saved. This provides a quick summary of the updates applied to the translated values.

After publishing the translations, a scheduled job is triggered, which processes the updates in the background. This job typically takes 15 minutes to complete, depending on the volume of data being translated.

An example of the API request header is shown below: 

• On the left-hand side, the request header includes the Language-Code, and on the right-hand side of the image, the translated value in French is highlighted in red for easy identification. Once translated, the text appears in the ADR (Applicable Display Region) and is displayed in the following section.

Auditing

The Audit button provides access to the Text Translation Log, which offers detailed tracking of all translation-related changes. The log includes the following information:

• Date: Indicates when the translation was completed.
• User Details: Shows the name and email address of the user who made the changes.
• Event Details: Specifies the fields where modifications were made.
• New: Displays the updated value that was entered after translation.
• Old: Displays the original value before the translation was applied.
• Source: Identifies the origin from which the translation was obtained (e.g., manual entry, file upload).

If a parameter is deleted from the translation page, the action is recorded in the audit trail. You can view this by clicking the Audit button located next to the Upload Translations option. The system maintains a Text Translation Removed Log, which specifically tracks such deletions, providing visibility into what was removed, by whom, and when the action occurred. This ensures accountability and supports effective change management.

The Publish Log displays the status of the scheduled job responsible for publishing the translations. It provides real-time visibility into whether the scheduled job has completed successfully, is still in progress, or has encountered any errors. Click the Publish Log button located to the left of the Publish button.

If any of the languages used for translations are no longer needed, they can be removed from the system. To do this, simply click the Delete button next to the language you wish to remove in the language configuration table. This action will permanently delete the selected language and its associated translations from the interface after you confirm that you want to delte the language in the pop up that appears.

This action will permanently remove the selected language and all its associated translations from the interface once you confirm the deletion in the pop-up that appears.

To view deleted languages, click the Audit button. The system maintains a Support Language Removed Log, which records all instances of language deletions. This log provides details such as the language removed, the user who performed the deletion, and the date and time of the action, ensuring full traceability of changes made to language configurations.