We have the following flows in Manage Localization Data

1. Search Localizations

2. Edit Localizations

3. Add and Bulk upload

Role required to manage localizations

"LOC_ADMIN"

Sample JSON:

{
   "name": "Localisation admin",
   "code": "LOC_ADMIN",
   "tenantId": "pb"
}

Adding Localizations

• From the search screen user can navigate to add localization screen by clicking the action button

• In this screen user can specify the locale(language) and module in which messages have to be upserted

• Once the language and module is selected a table is rendered in which user can add the keycode and the respective message. In one go, we can upsert upto 50 messages in this table.

• These messages will be upserted into the default locale as well.

• After adding the messages user can click on the "Save" action button. Upon success, a relevant toast message is shown and the table is cleared.

• In case of failure, an error toast message is shown listing the list of errors due to which the messages could not be upserted.

API for adding localizations

Same API is utilized for edit and bulk upload as well.

Refer the below curl:

curl --location 'http://localhost:3000/localization/messages/v1/_upsert' \
--header 'Accept: application/json, text/plain, */*' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Origin: http://localhost:3000' \
--header 'Referer: http://localhost:3000/workbench-ui/employee/workbench/localisation-add' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-origin' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36' \
--header 'sec-ch-ua: "Chromium";v="116", "Not)A;Brand";v="24", "Google Chrome";v="116"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "Windows"' \
--data '{"tenantId":"pb","messages":[{"code":"sdf","message":"dsf","locale":"default","module":"rainmaker-test","id":0}],"RequestInfo":{"apiId":"Rainmaker","authToken":"5bbfa93c-adc2-42b2-992e-a708a83cb2cf","userInfo":{"id":80234,"uuid":"aeb85b37-c996-4218-bdca-1b00cc268f2f","userName":"WBQA","name":"LOC","mobileNumber":"9999991942","emailId":null,"locale":null,"type":"EMPLOYEE","roles":[{"name":"MDMS ADMIN","code":"MDMS_ADMIN","tenantId":"pb"},{"name":"Super User","code":"SUPERUSER","tenantId":"pb"},{"name":"Localisation admin","code":"LOC_ADMIN","tenantId":"pb"},{"name":"Employee","code":"EMPLOYEE","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1694166894795|en_IN","plainAccessRequest":{}}}'

Tenant Module Localization

• State level users can upsert localizations to all modules

• City level users can only upsert to module specific to the tenantId (eg -> pg.citya)

• Some examples of city module localizations

       {
            "code": "PG_CITYA_ADMIN_B2",
            "message": "Ward Two",
            "module": "rainmaker-pg.citya",
            "locale": "en_IN"
        },
        
        {
            "code": "PG_CITYA_ADMIN_B3",
            "message": "Ward Three",
            "module": "rainmaker-pg.citya",
            "locale": "en_IN"
        }

Overview

This page provides the steps to search localisation data.

Steps

Navigate to the Manage Localisation screen from the home screen card. This opens the search localisation screen.

The following parameters are available for searching localizations

1. locale -> this field is mandatory. This dropdown is populated based on this mdms https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-UAT/data/pg/common-masters/StateInfo.json

2. module -> list of modules present in this mdms https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/pg/common-masters/StateInfo.json

3. keycode -> code of a specific message. It is a string-type parameter

Search Results

We have the following columns for localisation search results:

1. Module name

2. Key code

3. Default value -> message stored in default locale

4. Text -> message stored

5. Action -> Edit action to update message in that particular localisation

A note on the default value in the results

While adding localisations, by default all the messages will be updated in the locale mentioned by the user as well as in the "default" locale. The message updated in this locale is considered the default message. While updating the message default locale message remains unchanged.

Search API For Localisations

Localisation search API is an open API. Refer to the curl given below:

curl --location 'https://qa.digit.org/localization/messages/v1/_search?locale=en_IN&tenantId=pb' \
--header 'Content-Type: application/json' \
--data '{
     "RequestInfo": {
       "apiId" : "emp",
       "ver" : "1.0",
       "ts" : "10-03-2017 00:00:00",
       "action" : "create",
       "did" : "1",
       "key" : "abcdkey",
       "msgId" : "20170310130900",
       "requesterId" : "rajesh",
       "authToken" : "{{authToken}}",
       "userInfo" : {
         "id" : 1
       }
   }
}'

• Search for the desired language and module using the provided search functionality. The language and module are derived from MDMSv2.

• For example, if you are searching for the language ‘English’ and the module ‘rainmaker-common’, Once you perform the search, all relevant results will be displayed below.

Refer to the screenshot below:

If you are visiting the screen and it is not localized, the screen will appear as in the screenshot below.

• You can localize it with these simple steps:

• We have an option to upload Excel sheets (XLSX, XLS) and upsert bulk messages.

• From the "Add Localization" screen, there is an option to Bulk upload. See the image below.

• Upon clicking the bulk upload option, the user can select an Excel file from the file system.

• Copy all the locale code and give the corresponding message to display, module, and locale.

• Paste this data into an Excel spreadsheet and save it as an XLSX file.

• See the screenshot provided for reference for excel file.

Conditions for valid excel file

Excel file can contain multiple sheets, every sheet must have these four columns:

1. code

2. message

3. locale

4. module

• Upload this XLSX file to the project UI.

• After uploading, log out and log back in to see the UI localized.

Now see the UI, it will be as given below:

Editing localizations

• From the Search screen itself user can update localization messages

• Only message text can be edited, we are not allowed to change locale, module and code of the message.

• There is a fixed action column in the results table.

• Upon clicking the edit icon a modal is opened from where user can add the updated message

• User can click on the submit button, a respective toast is shown and the search results are refetched and rendered with the updated message.

• API used here is same as add localization.

• Select the edit icon in the action column, update the text as needed, and then click submit to save your changes.