10 Resource Bundle Customization
This chapter describes the customization of the resource strings in Retail Home. Resources strings can be edited via the Resource Bundle task.
Editing Resource Strings
This section describes the process for editing resource strings.
Roles
In order to edit the resource strings via the Resource Bundle task of Retail Home, the user must be assigned one of the following roles:
-
RETAIL_HOME_ADMIN (or RETAIL_HOME_ADMIN_PREPROD)
-
PLATFORM_SERVICES_ADMINISTRATOR
Editing Process
You can edit the resource strings through the Resource Bundle task of Retail Home.
From the Retail Home Settings menu, a Retail Home admin user can access the Resource Text Strings link under the Resource Bundles submenu. Use the Resource Text Strings screen to customize the resources present in the resource bundles of an application. To search the resources in an application, use the Application, Bundle, Language, Resource, Text and Contains Custom Text fields, as shown in Figure 10-1.
The results table in the Resource Text Strings screen, shown in Figure 10-2, displays the Resource, Base Text, Current Text, Updated Date, and Updated By columns for the resources matching the entered search criteria. If a custom value is present for a resource, it will be displayed in the Current Text column, along with the date and the user who customized that entry. If no custom value is present for a resource, the Current Text column will display the base text and the Updated Date and Updated By columns will be empty. The user can edit or remove custom text for a resource using this screen.
The Resource Text String page contains the following search options to search the translation strings.
Bundles
For any application, three sets of bundles can be customized:
-
Translations - These bundles contribute to most of the strings present in the application.
-
Oracle.rgbu.ard. resources.rpas.resources.RpasBundle - This bundle contains strings that are mainly seen in the Admin Task Dashboard and Log Levels.
-
Oracle.rgbu.ard. resources.rpas.resources.RpasMessages - This bundle has strings that are mainly seen after Dynamic Position Maintenance Imports and errors in the Wizard.
Languages
Table 10-1 lists the languages that are supported.
Table 10-1 Supported Languages
Language | Retail Home Language Code |
---|---|
Arabic |
Ar |
Deutsch (German) |
De |
Greek |
El |
English - United States |
En |
English - Great Britain |
en-GB |
Spanish |
Es |
French |
Fr |
Croatian |
Hr |
Hungarian |
Hu |
Italian |
It |
Japanese |
Ja |
Korean |
Ko |
Dutch |
NI |
Polish |
PI |
Brazilian Portuguese |
pt_BR |
Russian |
Ru |
Swedish |
Sv |
Turkish |
Tr |
Chinese - China (Simplified Chinese) |
zh_CN |
Chinese - Taiwan (Traditional Chinese) |
zh_TW |
Resource
The unique keys used to identify the resource strings.The most frequently used resource keyword are listed in Table 10-2.
Text
The exact text seen in the labels and snack bar messages in the RPASCE application. The user can search and customize any text that is visible in the UI. For example, the text from any dialog box, snack bar notification, or menu can be selected and copied using the browser copy functionality. The same text can be used for a keyword search to find the string in Retail Home.
In Figure 10-3, the text "Attribute Display Order" has been selected using Copy - Ctrl + C.
Figure 10-4 shows the same search in Retail Home.
Figure 10-4 Example Text Search in Retail Home
Description of "Figure 10-4 Example Text Search in Retail Home"
Add or Edit
The user can add or edit the custom text for a resource using the Edit menu or the Pencil icon. If no custom text is present for a resource, new custom text will be added. If custom text is already present for a resource, it will be modified. The Updated Date and Updated By columns will be changed to reflect the addition or modification. The Edit option opens a pop-up that displays the resource, its base text, and the editable custom text, as shown in Figure 10-5. Only one record can be edited at a time in a pop-up.
Remove Customization
The user can remove the custom text for a selected resource using the Delete menu or the Cross icon. The user can select a single record and remove the custom value for the record. The base text is not impacted by the delete operation. After the delete operation is complete, a snack bar notification is displayed. The user can either undo the delete action or dismiss the notification.
Settings for the RPASCE UI
The Time-to-live (ttl) for application resource bundles on the Additional Settings tab of System Configuration is used to determine the refresh time until the rpasBundle and rpasMessages custom strings are reflected in the UI. The default value is 600,000 ms.(that is, 10 minutes). With this default value, any changes to rpasBundle or rpasMessages bundles will take 10 minutes to be reflected in the application. This value can be reduced to a lesser value; however, reducing this value can result in slower performance.
This property is applicable only to rpasMessages and rpasBundle. Any changes to the translation bundle are implemented immediately. The user does not have to wait to see the custom Translation Bundle strings in the application.
Settings for Retail Home
The resource bundle customization feature must be enabled for the specific application using the Application Administration and Application Navigator Setup Task. The resource bundle customization check box must be checked to enable this feature, as shown in Figure 10-6.
Resource Keywords
Table 10-2 list the resource keywords that are most frequently used to search for a group of strings corresponding to a particular feature. These resource keywords belong to the translation bundle.
Table 10-2 Resource Keywords
Resource Keyword | Corresponding Feature |
---|---|
global |
Buttons used globally: OK, Cancel, Save, Remove, Delete, Next, Previous, Last, First, and so on. |
snackbar |
The messages displayed in the snackbar notifications. |
session |
The labels and messages for session expiration and timeout. |
Editview |
Labels and messages in the Edit View window. |
EditDim |
Labels and messages in the Edit Dimension window. |
charts |
Labels and messages for the charts. |
segment |
Labels and messages for the segments. |
wizardDialog |
Labels and messages for the Wizard dialog box. |
contextMenu |
Labels for context menu options. |
preferencestab |
Tab names, labels, hints, and messages in the System Configuration. |
userPreferences |
Labels and messages corresponding to user preferences. |
workbook |
Menus and labels corresponding to the workbooks. |
pivotTable |
Menus such as Undo and Redo and messages for features such as Copy/Paste, Lock/Unlock, and so on. |
alerts |
Labels and messages for the alerts feature. |
Dashboard |
Labels and messages for the Dashboard. |
adminTaskStatus |
Labels and messages used in Online Admin Tasks. |
positionFiltering |
Labels and messages used for Position Filtering. |
find |
Labels in the Find tab. |
export |
Labels and Messages of export dialog |
format |
Labels and messages used in the format dialog box. |