Localization entries

The Localization entries menu item appears under the Localization menu node if the Role of session has the ‘Administration/Configuration/Localization/Display’ permission.

It opens a combined view for the 'Localization entry' (LocalizationEntry) entity type.

View name: de.lobster.scm.coresystem.localization.db::LocalizationEntry|listDetailsWindow
Menu node name: admin/localizationGroup/localization

Special features of the ‘Localization entries’ view
The view for Localization entries appears as a combined view with an input form for editing above a list area in which the entry to be edited must be selected.
At first glance, this corresponds to the classic structure of a generic view for any entity type. However, there are some special features to note for Localization entries:
The list area does not only display rows for Localization entries for which entities of the 'Localization entry' (LocalizationEntry) type have been created and saved in the database.
Instead, lines that are directly based on 'resources' provided by the system also appear as Localization entries. A 'localization entry' entity is only created if these localizations provided 'by default' are to be adapted.
The 'State' column (LocalizationStatus) in the list area can be used to differentiate between these two types of entries:
For LocalizationEntry entities that represent adapted or supplemented Localization entries, the status is: 'Database' (DATABASE).
For 'System localizations' that appear in the list but are not ‘known’ in the database, the state is: 'System' (SYSTEM).
The state 'Changed' (CHANGED) indicates added or edited list entries with unsaved changes.
►IMPORTANT◄ In contrast to conventional overviews, the view for Localization entries allows several entries to be edited before their volatile data is saved as a whole (see 'Special features in the ribbon' below).

Access to entities for Localization entries is regulated by the permissions for the 'Administration/configuration/localization' node (administration/designer/localization).

►IMPORTANT◄ Access rules for entities:

Although an 'owner' (ownerId) is formally identified for each entity of the 'Localization entry' (LocalizationEntry) type, there are effectively no owner restrictions for this entity type.
For read access to LocalizationEntry entities via Search API, the 'Read' or ‘Display’ permission must be available for the 'Administration/configuration/localization' node (administration/designer/localization).
The lookup of language management localizations using system functions (e.g. Value from localization, Access to localized resources (Calculation expression)) is not tied to permissions.

►NOTE◄ For Company specific localization and the 'overloads' defined therein for Localization entries, owner restrictions and therefore possibly also Company authorizations are explicitly relevant.

The following screenshot shows the combined view with the default ribbon, including the default input form with the details of the localization entry selected in the list area (at the bottom).

►NOTE◄ The filter for the Resource bundle ( resourceBundle ) column is set in the screenshot so that the list shows all localizations for the LocalizationStatus class. This class is a Static enumeration that defines the options for the State column of this list.

images/download/attachments/201683424/image-2025-6-10_9-17-23-version-1-modificationdate-1749539842810-api-v2.png

Special features in the ribbon

The ribbon buttons in the Details subcategory differ significantly from the default for generic overviews.

Sub category	Ribbon button	Description
Details		The Add ribbon button creates a new 'Localization entry' (`LocalizationEntry`) entity in the detail area. In this way, new entries can be added to the Localization. ►NOTE◄ If the input form contains data that has not yet been accepted (see Apply), a 'Discard changes?' prompt is displayed. ►IMPORTANT◄ If the entries for Resource bundle (`resourceBundle`) and Resource name (`name`) of an added entry match an existing one, this will be overwritten when saving without any notification.
		The Remove ribbon button appears active when a new 'Localization entry' (`LocalizationEntry`) entity is displayed in the detail area. When clicking on Remove, a prompt for 'Confirm deletion' appears. The entry is only removed from the list if it is confirmed. However, the entry is only actually deleted when a user clicks on Save to save all changes to the list. ►IMPORTANT◄ List entries with the State 'System' (`SYSTEM`) cannot be permanently deleted, even by using Remove and Save. They may temporarily disappear from the list, but reappear after using Save. When using Remove for an entry with the State 'Database' (`DATABASE`), which refers to a system entry whose localizations it overrides via a Resource bundle (`resourceBundle`) and Resource name (`name`), this entry also disappears temporarily from the list. When the changes are subsequently saved, the `LocalizationEntry` entity with the adapted localizations is actually deleted from the database. The entry then reappears with the State 'System' (`SYSTEM`) and the associated default localizations. ►NOTE◄ The Search ribbon button (in the List subcategory) does not retrieve the list contents again in the Localization entries overview as it does when the list is opened.
		The Cancel ribbon button is used to discard changes to a 'Localization entry' (`LocalizationEntry`) entity that is currently displayed in the detail area. Clicking Cancel effectively deselects a selected list entry. If there are changes that have not yet been confirmed by clicking Apply, a 'Discard changes?' prompt is displayed. ►NOTE◄ If changes have already been confirmed for the relevant list entry using Apply, these remain in place when Cancel is selected. However, they only become effective when the Save function is triggered for all changed entries.
		The Copy ribbon button creates a copy of the 'Localization entry' (`LocalizationEntry`) entity in the detail area and replaces it in the current selection. If the original contains changes that have not yet been confirmed via Apply, a 'Discard changes?' prompt is displayed. ►NOTE◄ As a rule, at least one of the key fields, Resource bundle (`resourceBundle`) or Resource name (`name`), should be changed after the copy has been created. Otherwise the copy will overwrite the original entry when using Apply or Save.
		The Apply ribbon button transfers any edited data state for a 'Localization entry' (`LocalizationEntry`) entity in the detail area to the volatile data status for the list as a whole. Accepted changes only take effect when Save is used.
List		Unlike in generic overviews, clicking on the Search ribbon button for Localization entries has no effect on the list content, as this should be protected as a possibly volatile processing status. ►NOTE◄ If the `Ctrl` key is held down when clicking on Search, the definition for a Tuple search is copied to the Lobster Data Platform / Orchestration clipboard as usual. However, due to the deviations from the structure of a generic overview, this cannot be executed in the Search builder.
Changes		The Save ribbon button transfers all changes to list entries to the database that have been confirmed by clicking Apply since the overview was opened or, if applicable, since the last Save in the overview. This also applies to the deletion of entities for entries after Remove (if applicable). If there are unsaved changes when the view is closed, a 'Discard changes?' prompt is displayed.

Contents of the default input form

The default input form for Localization entries provides Text field elements for the following properties:

The Resource bundle (resourceBundle) and Resource name (name) fields define a composite key that uniquely identifies the 'Localization entry'. References within the system refer to these two characteristics, e.g. per Value from localization resolver or for Access to localized resources (Calculation expression).

In addition, the detail area displays a Text field for each supported Locale, in which a localization text for the respective Locale can optionally be entered.

The trash can symbol on the right above the input area allows a user to Remove the localization value from the list field (values), which defines stored localizations per Locale (locale) as a list of 'Localization entry value' (LocalizationEntryValue) entities. This option is important, as a distinction must be made between the empty string ('') and 'No value' ($null) when entering localization texts. As can be seen in the screenshot for the Locale German (de), the Text field displays a placeholder text – '(Not translated)' – as long as 'No value' ($null) is present.

In this specific case, when retrieving the localization for the Locale 'German' (de), the localization for English (en) is used (see Locale for details).

images/download/attachments/201683424/image-2025-6-10_9-20-9-version-1-modificationdate-1749540008652-api-v2.png

Effective localization per language:

German: 'System'
English: 'System'
French: 'Système'

►NOTE◄ If a uniform localization is to apply to all languages, this does not have to be explicitly assigned to each supported Locale, but only for the English (en) Locale.

Columns in the list area

The Data grid in the list area displays additional information in columns together with the fields of the 'Localization entry' (LocalizationEntry) entity.

Column	Data field name	Data type	Description
Resource bundle	`ressourceBundle`	`String`	Text key for a system-defined or fictitious Resource bundle.
Resource name	`name`	`String`	Text key that must be unique in the specified Resource bundle.
Current	n/a (calculated)	`String`	Effective text for the localization entry for the Current locale identified by Resource bundle and Resource name. ►NOTE◄ For entries with the State 'Changed' (`CHANGED`), this column indicates the text that may be overwritten when Save is made. ►IMPORTANT◄ This column takes into account applicable Company specific localization for Resource bundle and Resource name.
<supported Locale> by default: German English French	`values.value`	`String`	The `values` list field contains an entry of the 'Localization entry value' (`LocalizationEntryValue`) type for each explicit Locale, which specifies the Locale via the `locale` field and contains the assigned localization text in the `value` field. The list offers a column for each supported Locale, in which either a stored localization text appears or, instead of 'No value' (`$null`), the character string displayed in the corresponding empty input field as placeholder text (see note below). ►NOTE◄ For entries with the State 'Changed' (`CHANGED`), these columns show the state confirmed by Apply, if applicable. ►NOTE◄ The placeholder text '(Not translated)' is defined by a localization entry for the Current locale, which can be found in the Resource bundle for the 'Localization entry' (`de.lobster.scm.coresystem.localization.db.LocalizationEntry`) entity under the Resource name `NOT_TRANSLATED`. Company specific localization may also have to be taken into account here.
Translations	`values.length`	`Interger`	Number of 'translations' (→ 'Localization value' entities) in the `values` field.
Is <supported Locale> localized?	n/a (calculated)	`Boolean`	The list provides a column for each supported Locale in which the value `$true` appears if the `values` list field contains a 'Localization value' for the Locale in question. ►NOTE◄ For entries with the State 'Changed' (`CHANGED`), these columns show the status confirmed by Apply, if applicable.