1. Multi Language Support of Custom Fields
Description:
The Multi-Language Support for Custom Fields feature allows custom field values to be displayed in multiple languages. When enabled via the hasCmsValues: TRUE configuration in the YAML file, the system pulls translated values from the CMS and displays them according to the user's selected language. This ensures seamless localization of content without duplicating fields. Search, sort, and filter functions are also adapted to respect translations.
Explanation:
With the Multi-Language Support for Custom Fields feature, we enable the provision of values in a custom field in multiple languages. The field contents are displayed based on the user's selected language in the custom field.
Configuration
Enabling Multi-Language Support
To allow a custom field to retrieve multilingual values from the CMS, set the hasCmsValues parameter to TRUE in the corresponding YAML configuration. Otherwise, the logic remains unchanged, and the custom field uses the static value.
DriversVehicle:
Label: Drivers Vehicle
Description: Vehicle they use for delivery
hasCmsValues: TRUE
Type: STRING
Additionally, the value must be entered and maintained in the CMS in different languages.
Result
- If hasCmsValues: TRUE is set, the values from the CMS are used.
- If the values are entered and translated in the CMS, = Then the custom field is displayed based on the selected language.
- If a translation for a value is missing in the CMS, the static value from the entry is used instead.
Sorting, Filtering, and Search for Multi-Language Custom Fields
Sorting
Case 1: hasCmsValues = FALSE or not set
Sorting is performed as usual based on the stored values.
Case 2: hasCmsValues = TRUE
Sorting is performed based on the translated values in the currently selected language.
Note: If hasCmsValues = TRUE but a translation is missing in a specific language, the untranslated value is sorted below the translated values and displayed with the static value.
Searching
Case 1: hasCmsValues = FALSE or not set
The search is performed as usual based on the stored value.
Case 2: hasCmsValues = TRUE
The search is conducted in both the CMS translations and the original value.
Example: I can search for "Fahrrad" in german or the value "Bike"
Filtering
Case 1: hasCmsValues = FALSE or not set
Filtering is performed as usual based on the stored values.
Case 2: hasCmsValues = TRUE
Filtering is based on the translated values from the CMS.
Note: If a value needs to be filtered in multiple languages, all corresponding translations must be included in the filter.
Conclusion
With the Multi-Language Support for Custom Fields, we enable a flexible and dynamic provision of field content in multiple languages. The functionalities for searching, sorting, and filtering have been adapted accordingly to ensure consistent behavior for multilingual content.
Audience:
Portal developers and end users
Value:
Developers can configure custom fields once and provide localized values using the CMS.
End users automatically see custom field values in their preferred language, ensuring a consistent multilingual experience.
