Bookshelf Home | Contents | Index | PDF     

Implementation Guide for Oracle Self-Service E-Billing > Customizing Oracle Self-Service E-Billing >

Localizing the User Interface

The Oracle Self-Service E-Billing user interface is 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. The localization process involves configuring and translating files for each of the Oracle Self-Service E-Billing applications: Billing and Payment, Command Center, and Customer Service Representative applications.

You can set one language as the default for your implementation. Each user can choose a different language from the interface, and that language becomes his or her preferred language and automatically appears each time that user logs in.

To localize the user interface

  1. Oracle Self-Service E-Billing must be installed and deployed. Shut down the Billing and Payment, Command Center, and Customer Service Representative application servers.
  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. Create new resource bundle property files for each new language for all three Oracle Self-Service E-Billing applications: Billing and Payment, Command Center, and Customer Self-Service applications.
    1. Extract the app-resources-1.0-SNAPSHOT.jar file from the EAR files shown in the following table (use back slashes (\) on Windows):
      Application Server
      Oracle Self-Service E-Billing Application
      Location of the Application Resource Bundle File

      Oracle WebLogic

      Billing and Payment

      EDX_HOME/J2EEApps/ebilling/
      weblogic/ebilling-weblogic-10-6.0.4.ear/xma/app-resources-1.0-SNAPSHOT.jar

       

      Command Center

      EDX_HOME/J2EEApps/commandcenter/weblogic/command-center-weblogic-10-6.0.4.ear/xma/app-resources-1.0-SNAPSHOT.jar

       

      Customer Service Representative

      EDX_HOME/J2EEApps/csr/
      weblogic/csr-app-6.0.4.ear/xma/app-resources-1.0-SNAPSHOT.jar

      IBM WebSphere

      Billing and Payment

      EDX_HOME/J2EEApps/ebilling/
      websphere/ebilling-websphere-6-6.0.4.ear/xma/app-resources-1.0-SNAPSHOT.jar

       

      Command Center

      EDX_HOME/J2EEApps/commandcenter/websphere/command-center-websphere-6-6.0.4.ear/xma/app-resources-1.0-SNAPSHOT.jar

       

      Customer Service Representative

      EDX_HOME/J2EEApps/csr/
      websphere/csr-app-6.0.4.ear/xma/app-resources-1.0-SNAPSHOT.jar
    2. Make copies of the following language resource property files, one for each language and each Oracle Self-Service E-Billing application (3), appending the locale code (languageCode_Country) to the new file names. For example, for Spanish, the copy of the application resource messages file must be called ApplicationResourcesNew_es_ES.properties. For each application, the files are located under the corresponding JAR file path in the com/edocs/application/resources directory (or the com\edocs\application\resources directory on Windows). (Place all new and updated property files in the same directories as the English language files.)

      NOTE:  If you want to make any customizations to the pre-configured email content, make those changes in the following files before creating copies for localization.

      • 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.
      • 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.

        Oracle Self-Service E-Billing comes preconfigured with a set of language files for U.S. English:

      • ApplicationResourcesMessages_en_US.properties
      • ApplicationResourcesNew_en_US.properties
      • CurrencyText_en_US.properties
      • NotificationResource_en_US.properties
      • Period_en_US.properties
  4. Translate the appropriate content in each new property file.

    NOTE:  The content of the resource bundle files are identical for all applications.

  5. 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

  6. In the ApplicationResourcesNew.properties file, for each application and 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. For each application, update the StatementDisplay.properties file to add the Unicode currency symbol for any currencies you want to use. The currency symbols appear in the user interface and in email notification content. The StatementDisplay.properties file is found under the application JAR file path in the com/edocs/application/resources directory (or the com\edocs\application\resources directory on Windows). 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. If any of the new languages use special characters, update the Payment Module validation file, validation-payment.xml. Adding the characters to this file lets a user enter the special characters in payment account names, credit card names, and so on in the Payment Module. The validation-payment.xml file is located in the /WEB-INF directory under the ebilling-web-1.0-SNAPSHOT.war path. Extract the ebilling-web-1.0-SNAPSHOT.war file from the EAR files shown in the following table (use back slashes (\) on Windows):
    Application Server
    Oracle Self-Service E-Billing Application
    Location of the Payment Validation File validation-payment.xml

    Oracle WebLogic

    Billing and Payment

    EDX_HOME/J2EEApps/ebilling/
    weblogic/ebilling-weblogic-10-6.0.4.ear/ebilling-web-1.0-SNAPSHOT.war/WEB-INF

    IBM WebSphere

    Billing and Payment

    EDX_HOME/J2EEApps/ebilling/
    websphere/ebilling-websphere-6-6.0.4.ear/ebilling-web-1.0-SNAPSHOT.war/WEB-INF
  9. Repackage the JAR and EAR files at the application server console and deploy the EAR files. For instructions on how to deploy an application EAR file, see Installation Guide for Oracle Self-Service E-Billing.
  10. Generate an email template XML file for each language:
    1. Modify the template generator script for your implementation. The template generator script generates an email notification template XML file based on the notification properties file for each language. Change to the EDX_HOME/bin/notification/ directory (or the EDX_HOME\bin\notification\ directory on Windows). In the generateEmailTemplate.sh file found in this directory (or the generateEmailTemplate.cmd file on Windows), update the value of EDX_HOME and using the full path names for your installation. If you have saved the Billing and Payment application ear file in a new location, update the path to the ear file in the EBearfile variable (the default is EBearfile="$EDX_HOME/J2EEApps/ebilling/weblogic/ebilling-weblogic-10-6.0.4.ear").
    2. Run the email template generator utility. You can run this tool in one of two ways:
    • Generate all new language email 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). Run the following command, where filename is the name of the language code text file you created:
      • Unix: ./generateEmailTemplate.sh -f filename
      • Windows: generateEmailTemplate.cmd -f filename

        For example, the following text file content generates two files called template_ zh_CN.xsl and template_ ja_JP.xsl:

        zh_CN

        ja_JP

    • Generate a single template for one new language. You can generate a single XSL template file for a new language, run the utility as follows, where code is the language code:
      • UNIX: ./generateEmailTemplate.sh -l code
      • Windows: generateEmailTemplate.cmd -l code

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

      • UNIX: ./generateEmailTemplate.sh -l zh_CN
      • Windows: generateEmailTemplate.cmd -l zh_CN

        The new template files generated will be saved in the EDX_HOME/config/notification/templates directory.

  11. 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 files can be found 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 Self-Service E-Billing comes preconfigured with a set of template files for American English (appended with the American English locale code, _en_US).

  12. Restart the application servers.

    CAUTION:  If you want to make any customizations to email notification text after localization, 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.

    
Implementation Guide for Oracle Self-Service E-Billing Copyright © 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices.