Issues with Localization of Messages for MDMS Data

[jagankumar-egov]

Description: There are several issues related to the localization of messages for the MDMS data in the application. The following points outline the key problems that need to be addressed:

Localization Awareness:

• The Workbench screen, or the screen where master data is added, does not know which fields should be localized while creating master data. There is a lack of clarity on which fields require localization.

Localization Consumption:

• Even if localizations are created, the application should consume the same localization messages that were added during the creation of master data. Currently, this is not functioning as expected.

Standardization Issues:

• There is no consistent rule or standard being followed in the app/module/UI regarding the addition of random prefixes to make a message (master data) unique within a module. For example, when a user creates a complaint type/subtype in the MDMS UI, the user fills in values for type and subtype. The MDMS UI assumes these as codes and creates the master data. The PGR UI fetches this newly added master data but adds a random/non-standard prefix (e.g., rainmaker-pgr), resulting in a non-user-readable key like servicedef.test instead of displaying the proper localized message as "test".

Proposed Standardization:

• Every app using master data should follow a standard prefix format. This should consist of the schema code, field name, and field value. The localization module prefix should be structured as follows: digit-master-{schemaCode}.

Steps to Reproduce:

1. Navigate to the Workbench screen.
2. Create a complaint type/subtype by filling in values for type and subtype(Look at Attachment 1).
3. Observe that the MDMS UI creates the master data and the PGR UI fetches it.
4. Note the random/non-standard prefix added to the master data key(Look at Attachment 2 it shows SERVICEDEFS.TEST).
5. Check if the proper localized message is displayed.

Attachment 1

Attachment 2

Expected Behavior:

• Clear guidelines for which fields require localization.
• Proper consumption of localization messages during master data creation and master data integration in any modules.
• Consistent and standardized prefixing for all messages using master data across the application, resulting in user-readable messages.

Additional Notes:
It is critical to establish these standards to ensure uniformity and clarity in the localization of messages throughout the application.

Reference

1. Attaching the Current MDMS Schema of PGR ServiceDef
   { "type": "object", "$schema": "http://json-schema.org/draft-07/schema#", "required": [ "serviceCode", "name", "keywords", "department", "slaHours", "menuPath", "active" ], "x-unique": [ "serviceCode" ], "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "keywords": { "type": "string" }, "menuPath": { "type": "string" }, "slaHours": { "type": "integer" }, "department": { "type": "string" }, "serviceCode": { "type": "string" } }, "additionalProperties": false }

2. Attaching the Current Localisation Object of PGR ServiceDef
   { code : "SERVICEDEFS.TEST", locale : "en_IN", message : "TEST", module : "rainmaker-pgr" }

[jagankumar-egov]

We previously discussed this issue during the "Localization <> Master Data" meeting held on Wednesday, September 25, from 12:00 PM to 1:00 PM. The attendees were @jagankumar-egov @eGovMan @Rishabh-egov @varunreddy-egov Krishna

@Rishabh-egov , please add the discussion points and proposed approaches from the meeting here.