Localization task (Integration function)

Prev Next

The Localization Task function accesses the resource manager of Lobster Data Platform / Orchestration to determine a specific localization via the Localization and, if necessary, Company specific localization or – vice versa – the Resource Name for a given localization.

Irrespective of the search direction during a search, a Resource Bundle must be specified in parameter a.

With regard to the clarity of the assignment of localizations, the following must be taken into account:

  • Each combination of Resource Bundle and Resource Name defines by definition a system-wide unique reference point for translations in different languages.

  • Company specific localization can override the global localizations defined in the Localization for specific companies and languages.

  • Based on Company authorizations, Company specific localization can apply to more than one company.

  • For the same company, localizations for a bundle/resource combination can compete if several Company specific localization that overlap in content are applicable.

  • In a reverse search, it is possible that the same localization was selected for different Resource Names within the same Resource Bundle. If any ambiguity occurs, the first 'matching' Resource Name is returned as the result.

images/download/attachments/201674068/image2020-10-8_20-34-39-version-1-modificationdate-1747044309885-api-v2.png

Parameters

Parameter

Description

Example

Notes

a

Resource Bundle

de.lobster.scm.base.company.CompanyType

  • Values for the Resource Bundle of existing entries can be searched for in the Localization overview.

  • The Resource Bundle for Enumerations is always the internal name of the enumeration, whether it is provided by the system or is user defined.

    • The example value (left) refers to the dynamic enumeration for the Company type.

b

Resource Name

FWD

  • Each Resource Bundle can contain several Resource Name entries, which must be uniquely named within the Resource Bundle.

  • Resource Bundles for Enumerations use the internal names of the contained values as the Resource Name.

    • The example value (left) again refers to the Company type and identifies the entry, which is localized by default as the 'Freight forwarder'.

â–ºNOTEâ—„ For the 'reverse search' (see parameter f), it is necessary to define the localization here for which a matching Resource Name is to be searched.

c

Default Value (optional)

FORWARDER

  • The optional default text is only used as a return value if the search results in no value.

  • If an empty string is maintained as localization, the default text is not used.

  • While in the user interface the Resource Name usually appears automatically as the default value if no localization is defined, this rule may have to be formulated explicitly here.

d

locale (optional)

de

  • The Locale to be searched for can be optionally identified by its internal name.

  • If the information is missing, the Current locale (of the existing login) is used.

e

Owner ID (optional)

52

  • Optionally, you can specify the ID of a company in whose context you want to search for. Then any applicable Company specific localization are taken into account.

f

reverse mode (optional)

true

  • The value true for this optional parameter activates the 'reverse mode', in which a localization text can be specified in parameter b, for which a matching Resource Name is searched for in the Resource Bundle defined in parameter a.

Examples

Example: Search for a localization.

images/download/attachments/201674068/image2020-10-8_20-37-43-version-1-modificationdate-1747044309889-api-v2.png

  • Here the German localization for a Company type specified in the target field specifiedCompanyType is searched for.

  • If the specified company type is unknown or no German localization exists for this company type, the default value UNKNOWN is returned.

  • If Company specific localization are applicable for the context of the company identified by the source field ownerId , they will be considered if necessary.

    • The 'language' in the target field, for which the function is configured here, is therefore specific to the 'owner' of the entity in the input data.

Example: 'Reverse search' for a key value of a dynamic enumeration originating from a localization.

images/download/attachments/201674068/image2020-10-8_20-36-8-version-1-modificationdate-1747044309887-api-v2.png

  • Based on an English localization 'Principal', the corresponding Resource Name is determined among the localization entries for the Company type.

  • This is identical with the internal name of the value of the dynamic enumeration in question and in the concrete example is AAL (German: 'Auftraggeber').