Bookshelf Home | Contents | Index | PDF     

Implementation Guide for Oracle Billing Insight > About Customizing Oracle Billing Insight >

Localizing the User Interface

The Oracle Billing Insight Self-Service and Assisted Service application interfaces are preconfigured to use English only. You can add additional languages by copying and translating the required English-language resource bundle (property) files and configuring the additional files described in this topic. Each language resource file is shared by the Self-Service, Assisted Service, and RESTFul Web Services applications.

You can set one language as the default for your implementation. Each user can choose a preferred language from the Self-Service interface, which automatically appears each time that user logs in.

Oracle Billing Insight comes preconfigured with a set of language files for U.S. English:

  • ApplicationResourcesMessages_en_US.properties
  • ApplicationResourcesNew_en_US.properties
  • NotificationResource_en_US.properties
  • NotificationResourceSms_en_US.properties
  • Period_en_US.properties
  • CurrencyText_en_US.properties
  • CommonFieldValidator_en_US.properties

To localize the user interface

  1. Verify that Oracle Billing Insight is installed and deployed.
  2. For each new language, add a record in the EDX_SYS_LANG database table. For example, the following SQL statement adds traditional Spanish and sets it as the default language:

    insert into edx_sys_lang(ID,code,name,is_default) values(1,'es_ES','Espanol',1);

    where:

    • ID is the ID you want to use as the primary key for this language.
    • code is the language code. The format can be language_country (such as en_US, zh_CN, or ja_JP) or language_country_variant, such as en_US_Traditional_WIN. The language argument is a valid ISO-639 Language Code in two lower-case letters. The country argument is a valid ISO-3166 Country Code in two upper-case letters.

      The variant argument is a vendor- or browser-specific code, for example: WIN for Windows, MAC for Macintosh, and POSIX for POSIX. The variant argument can have two parts, separated by an underscore. For example, the code for Traditional Spanish on Windows is es_ES_Traditional_WIN.

    • name is the name of the language that appears when a user selects a language in the interface.
    • is_default indicates whether this language is to be the default (0 is No, 1 is Yes).
  3. In the CurrencyText.properties file, for each application and in each language, add mappings between the currency code and text for any currencies you want to use.

    The currency text appears on reports and charts. The following values (for the American dollar, Chinese yuan, and euro) are included in the file by default:

    USD.CurrencyText=Dollars
    CNY.CurrencyText=CNY
    EUR.CurrencyText=Euro

  4. Create new resource bundle property files for each new language:
    1. Make copies of the following language resource property files, one for each language:
      • ApplicationResourcesMessages.properties. Message text, such as validation and error messages that appear in the user interface.
      • ApplicationResourcesNew.properties. Text of tabs, labels, and titles that appear on the user interface Web pages.
      • NotificationResource.properties. Contains text strings used to compose email notifications.
      • NotificationResourceSms.properties. Contains text strings used to compose SMS messages.
      • Period.properties. Contains monthly time periods that appear in lists in the user interface.
      • CurrencyText.properties. Contains the currency name to display in reports and charts for each language.
      • CommonFieldValidator.properties. Contains the validation rule for certain fields.
    2. Append the language code (typically in the format languageCode_Country) to the new file names. Use the codes that you defined in the database table in Step 2.

      For example, for Spanish, the copy of the application resource messages file must be called ApplicationResourcesNew_es_ES.properties. The files are located in the following directories:

      • UNIX. EDX_HOME/config/resourcebundle/com/edocs/application/resources
      • Windows. EDX_HOME\config\resourcebundle\com\edocs\application\resources

        Place all new and updated property files in the same directories as the English language files.

        NOTE:  If you want to customize to the pre-configured notification content, then make those changes in the property files before creating copies for localization.

  5. Translate the appropriate content in each new property file.
  6. In the ApplicationResourcesNew.properties file, for each language, update the file to customize the date, time, and number formats used in the user interface. Specifying custom values lets you override the default Java language formats. You can also add new patterns to the ApplicationResourcesNew.properties file.

    To apply a different date format in a report (such as using the short date format instead of the medium format), update the report XML file with the pattern you prefer. The report XML files are found in the EDX_HOME/config/rpt directory. Also update the report XML files where you want to apply any new patterns. Update the following code in the ApplicationResourcesNew.properties files:

    #################### Date,Time,Number ########################

    global.pattern.number.integer=#,##0
    global.pattern.number.decimal=#,##0.00
    global.pattern.number.percent=#0.00%
    global.pattern.number.amount=\u00A4#,##0.00
    global.pattern.number.amount2=\u00A4#,##0.00;\u00A4(#,##0.00)
    global.pattern.number.amount3=#,##0;(#,##0)
    global.pattern.number.amount4=#,##0.00;(#,##0.00)
    global.pattern.date.short=M/d/yy
    global.pattern.date.medium=MM/dd/yyyy
    global.pattern.date.long=MMM/dd/yyyy
    global.pattern.date.input=MM/dd/yyyy
    global.pattern.time.short=HH:mm
    global.pattern.time.long=HH:mm:ss
    global.pattern.date.time=MM/dd/yyyy HH:mm:ss

    NOTE:  The amount3 and amount4 patterns display numbers that are not currency amounts.

  7. Update the StatementDisplay.properties file to add the Unicode currency symbol for any currencies you want to use. The StatementDisplay.properties file is located in the following directory:
    • UNIX. EDX_HOME/config/resourcebundle/com/edocs/application/resources
    • Windows. EDX_HOME\config\resourcebundle\com\edocs\application\resources

      The currency symbols appear in the user interface and in email notification content. If your billing files contain only a single currency, then add an entry for that currency. The following values (for the American dollar, Chinese yuan, and euro), are included in the file by default:

    USD.CurrencySymbol=$
    CNY.CurrencySymbol=\u00a5
    EUR.CurrencySymbol=\u20ac

  8. Localize email and SMS notification templates by generating a template XML file for each language:
    1. Modify the template generator script. Update the value of EDX_HOME, using the full path names for your installation, in the generateNotificationTemplate.sh file, or the generateNotificationTemplate.cmd file on Windows. The files are in the following directories:
      • UNIX. EDX_HOME/bin/notification/
      • Windows. EDX_HOME\bin\notification\

        The template generator script generates an email notification template XML file based on the notification properties file for each language.

    2. Run the email and SMS template generator utility. You can run this tool in one of two ways:
    • Generate all new language email and SMS templates in batch. To generate a batch of XSL template files in the corresponding languages, create a text file that contains each language code on separate lines and place the file in the EDX_HOME/bin/notification directory (or the EDX_HOME\bin\notification directory on Windows):
      • UNIX. ./generateNotificationTemplate.sh -f filename -t templateType
      • Windows. generateNotificationTemplate.cmd -f filename -t templateType

        where:

      • filename is the name of the language code text file you created.
      • templateType is the template type, which is used to generate different notifications according to the notification category. Specify either SMS or email.

        For example, if you add the following content to a text file called languages.txt, and use the UNIX command ./ generateNotificationTemplate.sh -f languages -t email, then the command generates two email templates called template_ zh_CN.xsl and template_ ja_JP.xsl.

    • Generate a single template for one new language. Use the following commands to generate a single XSL template file for a new language:
      • UNIX. ./generateNotificationTemplate.sh -l code
      • Windows. generateNotificationTemplate.cmd -l code

        where:

      • code is the language code.
      • templateType is the template type, which is used to generate different notifications according to the notification category. Specify either SMS or email.

        For example, to generate a Chinese email template file (called template_zh_CN.xsl), use the following command:

      • UNIX. ./generateNotificationTemplate.sh -l zh_CN -t email
      • Windows. generateNotificationTemplate.cmd -l zh_CN -t email

        To generate a Chinese SMS template file (called template_zh_CN.xsl), use the following example command:

      • UNIX. ./generateNotificationTemplate.sh -l zh_CN -t sms
      • Windows. generateNotificationTemplate.cmd -l zh_CN -t sms

        For SMS templates, Oracle Billing Insight names the file with the prefix template_sms. For email templates, the file name prefix is the word template. The new template files generated are saved in the EDX_HOME/config/notification/templates directory.

  9. For each new language, make copies of the following template files used for generating PDF reports, appending the locale code (languageCode_Country) to the new file names. The template files are in the EDX_HOME/template/pdf directory (use back slashes (\) on Windows). Place the new files in the same directory.
    • PrintSummary.rtf
    • StatementSummary.rtf
    • telco_std_r1.rtf
    • telco_std_r6.rtf
    • telco_std_r13.rtf

      NOTE:  Oracle Billing Insight comes preconfigured with a set of template files for American English (appended with the American English locale code, _en_US).

  10. By default, Oracle Billing Insight automatically detects updates to the external resource files every five minutes. If you have turned this feature off in the global configuration file, then you must manually restart the server for the localization changes to take effect. For more information about automatic detection of changes to resource files, see Changing the Frequency of Automatic Resource File Updates.

CAUTION:  If you want to make any customizations to email notification text after localization, then make the changes to the notification property files for the language and regenerate the corresponding template file. Changes made directly to a template file will be lost if the template regeneration runs again for that language.

Changing the Frequency of Automatic Resource File Updates

Oracle Billing Insight automatically detects any changes made to external resource files, including localization and email content files. You can configure the frequency with which Oracle Billing Insight automatically detects these files. The default is every five minutes. You can optionally turn off the automatic detection feature, requiring you to restart the server if you make changes to resource bundles.

To configure the frequency of automatic detection of resource files

  1. In the globalConfig.xma file, found in the EDX_HOME\xma\config\modules directory (or the EDX_HOME/xma/config/modules directory on Windows), specify the value of the autoDetectExternalResourcePeriod property, in minutes:

    <property name="autoDetectExternalResourcePeriod"><value>5</value></property>

  2. To disable the auto-detect functionality and require that the server restart to reload resources updates, set the parameter value to zero.
  3. Restart the server.
    
Implementation Guide for Oracle Billing Insight Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.