Enable New Product(s)

One of Singleton’s features is to provide translation for products, but before you can get real translation from Singleton, your translation bundles should be already existing in Singleton Service.

This page will show you the details of adding your product(s) definition and corresponding translation bundles to Singleton Service.

How to add new product(s) and corresponding translation bundles to Singleton Service?

Singleton provides 2 ways to do this:

Using Singleton API

1. Go to Singleton Service swagger-ui:

https://localhost:8090/i18n/api/doc/swagger-ui.html
or 
http://localhost:8091/i18n/api/doc/swagger-ui.html

2. Switch to v2 in Select a spec in the upper right corner;

3. Find and expand translation-sync-api, you will get an API as below:

PUT /i18n/api/v2/translation/products/{productName}/versions/{version} Update translation

4. Then click Try it out;

5. Input your productName/version/component/locale and the translation messages;

6. Verify everything is fine, click Execute, then the translation messages will be pushed into Singleton Service, please use other GET API(s) to fetch the translation.

Notes:

• productName/version should match the value in translationData;

• You can ignore the input for parameters: operationid/dataOrigin/machineTranslation/pseudo/requester, these parameters are VMware internally;

• For locale definition, please refer to CLDR availableLocales and defaultContent

Copy translation bundles to the location that Singleton Service reads

1. Check the translation location in singleton-0.1.0.jar\BOOT-INF\classes\application-bundle.properties

#translation config
#the follow item the Directory can't end of file separator
translation.bundle.file.basepath =.
translation.synch.git.flag = true

By default, it’s in the same location with the Singleton Service jar file, to find translation.bundle.file.basepath.

2. Create your translation bundle file(s) following the structure as below, and name your file(s) like “messages_xx.json” (for example: messages_en.json):

{
	"component": "componentName",
	"locale": "en",
	"messages": {
		"key1": "value1",
		"key2": "value2"
	}
}

3. Copy your translation bundle file(s) to .\l10n\bundles\{productName}\{version}\{componentName}, restart Singleton Service to refresh cache, then to fetch the translation.

4. Singleton supports multiple components definition, you can organize your resources by more than one components.