Skip Headers
Oracle® Communications Order and Service Management Developer's Guide
Release 7.2.2

E35419-02
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

9 Localizing OSM

This chapter provides information on localizing the Oracle Communications Order and Service Management (OSM) Web clients. Localization is the process of changing a user interface (UI) from the original language in which it was written to another language. This chapter also provides information for customizing regional settings across all OSM applications. This chapter is intended for service professionals developing a custom installation for their clients.

About Localization

Localization is the process of customizing the OSM system for use in a specific market and language. This process includes translating the user interface and documentation, as well as adapting time, date, number formats, and punctuation conventions. It may also include editing or creating new icon graphics.

Note:

Oracle recommends that you have an experienced localization professional perform the documentation translation and coding localization.

This chapter describes how to:

Note:

After you run any migration script such as upgrading an installation, you must reapply any customization done to the database.

Localizing OSM

Localizing OSM involves the following high-level steps.

Note:

These steps assume you have followed the directions specified in the OSM Installation Guide, which include:
  • Installing WebLogic Server

  • Making a backup of your WebLogic Server installation

  • Installing OSM to create the database schema by selecting Custom Installation and Database Schema. This generates the omsmodel_I10n.jar file needed for localization.

  • Making a backup of your OSM installation after performing these localization steps

  1. Uncompress the OSM_home/Database/dbinstall/install/omsmodel_I10n.jar file.

    Set the environment variable PATH to JDK_home/bin, then from a command prompt run the command:

    jar -xvf omsmodel_I10n.jar
    

    The uncompressed files are organized into the directories shown in Figure 9-1, "Uncompressed Files".

    Figure 9-1 Uncompressed Files

    Shows how uncompressed files are organized into the directories.
  2. Navigate to the directories listed below, and localize the text strings in the XML files indicated. You must localize this information first so that the database parameters are defined in the target language. For information on how to localize the content of the XML files, see the following sections in this chapter:

    OMS/main/model/calendar/_table/_data:

    • om_region.xml

    • om_schedule.xml

    OMS/main/model/cartridge/_table/_data:

    • om_cartridge.xml

    OMS/main/model/notification/_table/_data:

    • om_notification_def.xml

    OMS/main/model/ordertemplate/_table/_data:

    • om_attribute_type.xml

    • om_order_data_dictionary.xml

    • om_order_hier.xml

    • om_order_remarks_type.xml

    • om_order_type_category.xml

    • om_view_order_node_label.xml

    OMS/main/model/process/_table/_data:

    • om_behavior.xml

    • om_process.xml

    • om_process_point.xml

    • om_process_position.xml

    • om_process_status.xml

    • om_state.xml

    • om_state_category.xml

    • om_status_category.xml

    • om_task.xml

    • om_task_state.xml

    • om_task_status.xml

    OMS/main/model/rule/_table/_data:

    • om_rule_def.xml

    • om_rule_source.xml

    • om_rule_task.xml

    OMS/main/model/user/preference/_table/_data:

    • om_generic_mnemonic.xml

    OMS/main/model/user/privilege/_table/_data:

    • om_application_function.xml

    • om_responsibility.xml

    OMS/main/model/utility/_table/_data:

    • om_errors.xml

    • om_server_strings.xml

  3. Compress omsmodel_I10n.jar.

    After you have localized the XML files, open a command prompt console, navigate to the directory that contains the JAR file, and run the command:

    jar -cvf omsmodel_I10n.jar .
    
  4. Choose option a or option b:

    1. Drop the existing schemas from the database so you can reuse the schema names when you reinstall (Step 5). This is done by running the commands below. Stop the WebLogic server prior to running these commands, and start it again upon completion.

      • OMS user schema:

        drop user oms_schema_name cascade; commit;
        
      • Rule engine schema:

        drop user rule_engine_schema cascade; commit;
        
      • The context:

        drop context oms_schema_name; commit;
        
    2. When reinstalling (Step 5), create a new schema with a different name.

  5. Reinstall OSM, this time selecting all of the components you want to install permanently. When the Database Schema Localization Information window appears, select the Use localized Order and Service Management initial data check box and specify the path to your localized JAR file, as shown in Figure 9-2, "Installer Window".

    Figure 9-2 Installer Window

    Shows the Installer Window.

    The installer localizes the schema using your JAR file.

  6. Localize the OSM Web clients as required.

    After the database information has been localized and the product has been installed, you can customize the OSM Web clients to suit the needs of the target locale. For more information, see "Localizing the Task Web Client" and "Localizing the Order Management Web Client".

Localizing the XML Import/Export Application

If you localized OSM, you must also localize the XML Import/Export application. Localizing the XML Import/Export application involves the following high-level steps:

  1. Uncompress the OSM_home/SDK/XMLImportExport/classes/modelHandler.jar file.

    Set the environment variable PATH to JDK_home/bin, then from a command prompt run the command:

    jar -xvf modelHandler.jar
    
  2. Localize the sql/default_data.sql file.

    To localize the default_data.sql file, you must understand the relationship between the data that was localized in the XML files from the omsmodel_l10n.jar file, and the insert scripts defined in the default_data.sql file. The following example provides that understanding:

    Suppose om_state.xml of omsmodel_l10n.jar is localized. The localization corresponds to the INSERT statements of the table OM_STATE defined in default_data.sql in the om_state.xml file. For example, if the <state_description> of <state_mnemonic>received</state_mnemonic> is localized as <state_description>TEMP_received</state_description>, in default_data.sql the INSERT statement that is inserting received state in the OM_STATE table must be localized to:

    [INSERT INTO OM_STATE (STATE_ID, STATE_MNEMONIC, STATE_CATEGORY_ID, STATE_DESCRIPTION,STATE_ICON_ID, CARTRIDGE_ID) VALUES (1, 'received', 1, 'TEMP_received', 0, 0); ]

    Following this example, all fields that are localized in the XML files of omsmodel_l10n.jar must also be localized in default_data.sql.

  3. Compress modelHandler.jar.

    After you have localized the sql/default_data.sql file, open a command prompt, navigate to the directory that contains the JAR file, and run the command:

    jar -cvf modelHandler.jar .
    

Localizing the Encoding Element

To support localization, the <encoding> element in the config.xml file determines the appropriate language. For information on the config.xml file, see OSM System Administrator's Guide.

  • Configure the following line in the config.xml file with the appropriate ISO character code, shown in bold, below:

    <encoding>ISO-8859-2</encoding> 
    
  • Be sure that your Microsoft Windows operating system is localized for your language. See Microsoft documentation for instructions.

  • Some pattern restrictions for entity names in the XML model schema are provided with the XML Import/Export application. For non-English environments, you must customize the schema for entity name patterns.

Additional Considerations for Localizing OSM

The process of localization also involves the support for different locales, character set encoding, and localization of settings.

Support for Different Locales

Locales are linguistic regions that share spelling conventions. A locale consists of a language code, followed by an optional country code, followed by an optional variant code. For example, "en_US" specifies English in the United States, while "en_GB" specifies English in Great Britain.

Operating systems such as Windows, Linux, Oracle Solaris, and HP-UX support the locale model and provide facilities to properly read and format locale-specific information. Additionally, newer programming languages such as Java provide similar facilities to support localization.

However, HTML does not support localization or have solutions for date or time issues. The localization of HTML requires support from the OSM server and Javascript code sent to the browser.

Character Set Encoding

Characters in an HTML file are stored as numeric values with a range from 0 to 255. When a Web browser displays a character symbol, it uses the numeric value to find the correct symbol to display. The set of symbols displayed for each number is known as a character set. As 256 numbers is insufficient to describe all possible characters that may need to be displayed in all languages, you must specify what character set the browser is to use when it displays an HTML page.

By default, HTML uses the ISO-8859-1 character set, which can display all characters needed for Western European Languages. When you create HTML pages using other character sets (such as ISO-8859-2 for Eastern European Languages), you must use the corresponding encoding.

Localization of Settings

OSM supports localized Windows regional settings: All number, currency, date, and time formats displayed in the OSM Administrator application come from the Windows regional settings.

You can also localize regional settings through the OSM properties file. See "OSM Localization Resource Bundles" for more information on how to do this.

For more information on Windows regional settings, see the Microsoft Windows documentation.

About NLS Database Configuration

Oracle's National Language Support (NLS) architecture allows you to store, process, and retrieve data in native languages. It ensures that database utilities and error messages, sort order, date, time, monetary, numeric, and calendar conventions automatically adapt to the native language and locale.

Oracle Database Character Set

OSM stores its text data in CHAR and VARCHAR2 columns in an Oracle database. The database character set determines what languages can be represented in the database. So, you must install OSM in an Oracle database with a character set that meets your language requirements.

You can specify a character set when creating a database using the CHARACTER SET clause of the CREATE DATABASE statement. A complete list of character sets supported by Oracle is included in the Oracle documentation.

You can use the v$nls_parameters view to determine the existing database character set.

OSM does not use the NCHAR, NVARCHAR2, or NCLOB data types and so has no specific requirements for the alternate character set for the database.

To determine the existing character set:

  1. Connect to the Oracle server using SQL*Plus as a user who has access to the v$nls_parameters view.

  2. At the SQL*Plus prompt, enter the following:

    SQL> select value from v$nls_parameters where parameter = 'NLS_CHARACTERSET';
    

    Information similar to the following is returned:

    VALUE
    ----------------------------------------
    WE8ISO8859P1
    

    You can use the CHARACTER SET clause of the ALTER DATABASE statement to change the character set for an existing database.

    Note:

    You must have SYSDBA system privileges.

To change the character set:

  1. Initiate the database in restricted mode. For example, use the SQL*Plus STARTUP RESTRICT command.

  2. Connect to server Manager (svrmgrl in UNIX or svrmgr30 on Windows XP).

  3. At the prompt, enter:

    ALTER DATABASE db1 CHARACTER SET WE8ISO8859P1;
    

    Note:

    The source character set must be a strict subset of the target character set.

NLS Environment

For the OSM Administrator application to support localization, the Oracle NLS parameters must be configured properly in Windows XP.

On UNIX, the Oracle NLS parameters are configured as environment variables. On Windows XP, the Oracle NLS parameters are configured as registry entries under HKEY_LOCAL_MACHINE/SOFTWARE/ORACLE.

NLS_LANG Parameter

Use the NLS_LANG parameter to set the language, territory, and character set used for the database.

The NLS_LANG parameter has three components: language, territory, and charset, in the form:

NLS_LANG = language_territory.charset

Each component controls the operation of a subset of the NLS features.

  • Language: Specifies conventions such as the language used for Oracle messages, as well as day and month names. Each supported language has a unique name, such as French, or German.

  • Territory: Specifies conventions such as the default calendar, collation, date, monetary, and numeric formats. Each supported territory has a unique name, such as America, France, or Canada.

  • Charset: Specifies the character set used by the client application. Each supported character set has a unique acronym, such as US7ASCII, WE8ISO8859P1, WE8DEC, WE8EBCDIC500, or JA16EUC.

ORA_NLS33 Environment Variable

Ensure the ORA_NLS33 environment is set to Oracle_home/nls/data.

You can also set other NLS environment variables. For a complete list of NLS environment variables, see the Oracle documentation.

About OSM Database Error Messages

You can localize OSM database error messages by editing the error message text in the om_errors.xml file.

This file is located in your OSM_home/ Database/dbinstall/install/OMS/main/model/utility/_table/_data directory.

To edit these error messages, open the file using an XML or text editor and replace the "error_message" text with the target language text. Table 9-1 lists all of the error messages in the om_errors.xml file.

Note:

After you have localized this file, make sure you provide an updated copy to Oracle Global Support to assist you in any issues that may arise.

Table 9-1 OSM Error Messages

Error Codes Error Message

-20001

Order satisfied no rule. Cannot start process.

-20002

Order status and order state have not been changed.

-20004

Starting position for the process is not defined. Call support.

-20005

There is no creation task. Call support.

-20006

Workflow thread does not exist. The order may have been moved by another user. Refresh your worklist and try again.

-20007

Order is locked. Try again later.

-20008

Current history detail record not found for the order. Call support.

-20009

Cannot remove node, which has children.

-20011

Order to be updated is currently locked by another user.

-20012

Order not found.

-20014

Rule to be evaluated is not found. Call support.

-20015

System data is protected.

-20016

Value cannot be null.

-20017

Rule cannot be evaluated.

-20020

Operation affected too many rows.

-20022

Access denied: not enough privileges.

-20023

You cannot accept this order thread.

-20025

There are too many instances for the order node.

-20026

There are too few instances for the order node.

-20027

Parent order node does not exist.

-20028

Rule engine has already been started.

-20029

Rule engine has not been started.

-20030

Invalid process definition.

-20031

Order node cannot be found. Call support.

-20038

Mandatory check failed.

-20040

Order view for task cannot be found.

-20041

Process position cannot be found. Call support.

-20044

Reporting status cannot be found. Call support.

-20049

Status is not valid for task.

-20050

View node cannot be found.

-20051

Notification cannot be found.

-20054

Notification history cannot be found.

-20055

Notification is not active.

-20056

Time interval is not valid.

-20043

Jump record does not exist.

-20059

Error processing notification.

-20060

Node information does not match any node in the database.

-20061

New parent node information is not valid.

-20062

Remark cannot be found.

-20063

The remark cannot be changed.

-20064

Attachment cannot be found.

-20065

No orders are stored in the system.

-20067

No orders satisfy the purge criteria.

-20068

The wrong task has been supplied for the order.

-20069

Invalid state transition.

-20070

Invalid order type.

-20071

Invalid order source.

-20072

Invalid process status.

-20073

Invalid state.

-20074

State is not valid for task.

-20075

Task not found.

-20076

Stop date/time must be greater than start date/time.

-20077

Shift violates schedule boundary.

-20078

Please change the shift boundaries not to overlap any existing shift.

-20079

Exception shift not found.

-20080

Parent region is not found.

-20081

Cannot remove region, which has child regions.

-20082

Cannot remove region, which is attached to workgroup.

-20083

Cannot move to the next task. Cannot calculate expected completion time. Schedule is too short. Ask OSM administrator to extend the calendar.

-20084

Cannot move to the next task. Cannot calculate expected completion time. Cannot find the schedule.

-20085

Invalid parameter when you call internal function.

-20086

DST start/stop date is not correctly specified in om_workgroup table.

-20087

Can not find workgroup during the building of DST date.

-20088

Invalid calendar DST start/stop day of the month in the workgroup settings

-20089

Incorrect value in DST week settings in the workgroup definition

-20090

Missing parameter "oms_timezone" in OM_PARAMETER table

-20091

The node is used as a coordinator node for this thread.

-20092

Parameter Stop Date must be greater than Current System Date

-20093

Parameter Completion Date Before should be less than Current System Date

-20094

Calendar can be generated only workgroup by workgroup not for all workgroups at once

-20095

Parent thread is not found.

-20096

Partition boundary is too low. Increase the value of NEXT RANGE PARTITION BOUNDARY parameter.

-20097

Specific view is not assigned to a workgroup

-20098

Specific task is not assigned to workgroup.

-20099

JMS message does not exists.

-20103

Event type is not recognized. Call support.

-20104

Increase value of job_queue_processes parameter in the init*.ora file.

-20105

Job type is not valid. Call support.

-20106

Minimum running jobs should be greater than 0

-20107

It can be only one notification job running at the same.

-20108

Task list is empty.

-20109

Specified pooler id is invalid.

-20110

Invalid type/source combination. Call support.

-20112

Cartridge already exists.

-20113

Cartridge can not be dropped. There are pending orders found.

-20114

Oracle runtime error.

-20121

Cannot modify cartridge - automation component is referring it.

-20122

Order type does not exist.

-20123

Order source does not exist.

-20124

Parent order not found for target node.

-20125

Cannot migrate the order header because it has activities in the source cartridge.

-20126

Character to number conversion error.

-20127

Unable to drop cartridge. There are pending orders referencing current cartridge.

-20128

Unable to drop cartridge. Drop oldest cartridge first.

-20129

Migration of schedule based tasks is not supported.

-20142

Operation is not allowed.

-20143

Summary extend date is invalid for existing summary interval.


About Application Server Strings

Application server strings are used in Java business application code in the OSM UI. These strings can be found in the om_server_strings.xml file in your OSM_home/Database/dbinstall/install/OMS/main/model/utility/_table/_data directory.

To edit these strings, open an XML or text editor and replace the "description" text with the target language text.

Note:

After you localize this file, make sure you provide an updated copy to Oracle Global Support, so that they can assist you with any future issues that may arise.

The strings shown in Table 9-2 are representative of the types of information displayed in the Worklist, Query, and Notifications views. For a full listing, see the om_server_strings.xml file.

Table 9-2 Server Strings

Class Key Description

order_history

NODEINST

Order Instance

order_history

FITEREDNODE

Filtered Node

fixed_header

]date_pos_started

"Started"

fixed_header

]expected_duration

"Expected Duration"

fixed_header

]expected_start_date

"Expected Start Date"

fixed_header

]order_creation_date

"Order Creation Date"

fixed_header

]ord_compl_date_expected

"Expected Order Completion Date"

fixed_header

]order_seq_id

"Order ID"

fixed_header

]order_source

"Source"

fixed_header

]order_state

"State"

fixed_header

]order_type

"Type"

fixed_header

]process_description

"Process"

fixed_header

]reference_number

"Ref. #"

fixed_header

]reporting_status

"Process Status"

fixed_header

]requested_delivery_date

"Requested Delivery Date"

fixed_header

]task_description

"Task"

fixed_header

]user

"User"

notification_ fixed_header

_NOTIFICATION_ DESC

"Notification Description"

notification_ fixed_header

_NOTIFICATION_ TYPE

"Notification Type"

notification_ fixed_header

_PRIORITY

"Priority"

notification_ fixed_header

_TIMESTAMP

"Notification Timestamp"

GUIMessage

ALT

"View Remark(s)"

fixed_header

]completion_date_expected_at_task

"Expected Task Completion Date"

fixed_header

]ord_completion_date

"Completed Date"

fixed_header

]num_remarks

"Number of Remarks"

fixed_header

]order_hist_seq_id

"Order History ID"


About OSM Process Definition Data

This section lists the process definition data used in OSM database tables. The data is contained in various files located in your OSM_home/Database/dbinstall/install/OMS/main/model directory.

To edit these tables, open the file using an XML or text editor and replace the "description" text with the target language text.

Note:

Do not localize the column names. Column names are not externally visible, and are necessary for the internal operation of OSM.

After you localize any of these files, make sure you provide an updated copy to Oracle Global Support, so they can assist you with any future issues that may arise.

om_application_function

Table 9-3 lists the application functions defined for OSM. The file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/user/privelege/_table/_data directory. Localize the values in the right column.

Table 9-3 om_application_function

app_function_mnemonic app_function_description

reference_number_modification

Reference Number Modification

priority_modification

Order Priority Modification

online_reports

Online Reports

worklist_viewer

Worklist Viewer

task_assignment

Task Assignment

exception_processing

Exception Processing

search_viewer

Search Viewer

create_versioned_orders

Create Versioned Orders


om_attribute_type

Table 9-4 lists the attribute types used by OSM. The file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/ordertemplate/_table/_data directory. Localize the values in the description column.

Table 9-4 om_attribute_type

attribute_type attribute_description

CN

Container

CT

Code Table

CY

Currency

DT

Date

GR

Group

LK

Lookup

NM

Numeric

PH

Phone

RF

Reference

TX

Text

YN

Boolean


om_order_data_dictionary

The data dictionary contains one element, which is a dictionary element for the root node in the OSM master order template. This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/ordertemplate/_table/_data directory. Localize the text that appears in the business_name column.

Table 9-5 om_order_data_dictionary

Database Column Value

business_name

ROOT


om_order_remarks_type

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/ordertemplate/_table/_data directory. Localize the text that appears in the remarks_type_description column.

Table 9-6 om_order_remarks_type

Database Column Value

remarks_type_description

Default


om_order_type_category

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/ordertemplate/_table/_data directory. Localize the text that appears in the order_type_category_descr column.

Table 9-7 om_order_type_category

Database Column Value

order_type_category_descr

Unknown


om_process

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/process/_table/_data directory. Localize the text that appears in the process_id_description column.

Table 9-8 om_process

Database Column Value

process_id_description

Creation Process

N/A


om_process_status

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/process/_table/_data directory. Localize the text that appears in the process_status_description column.

Table 9-9 om_process_status

Database Column Value

process_status_description

Possible values are:

  • N/A

  • True

  • False

  • Submit

  • Delete

  • Next

  • Back

  • Cancel

  • Finish

  • Back


om_responsibility

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/user/privelege/_table/_data directory. Localize the text that appears in the responsibility_description column.

Table 9-10 om_responsibility

Database Column Value

responsibility_description

System


om_rule_def

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/rule/_table/_data directory. Localize the text that appears in the rule_description and rule_comment columns.

Null Rule is the rule that always evaluates to true.

Table 9-11 om_rule_def

Database Column Value

rule_description

Null Rule

rule_comment

Null Rule


om_state

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/process/_table/_data directory. Localize the text that appears in the state_description column.

Table 9-12 om_state

Database Column Value

state_description

Possible values are:

  • N/A

  • Received

  • Accepted

  • Assigned

  • Completed


om_state_category

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/process/_table/_data directory. Localize the text that appears in the state_category_description column.

Table 9-13 om_state_category

Database Column Value

state_category_description

Possible values are:

  • System

  • User defined


om_status_category

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/process/_table/_data directory. Localize the text that appears in the status_category_description column.

Table 9-14 om_status_category

Database Column Value

status_category_description

Possible values are:

  • System

  • User defined


om_task

file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/process/_table/_data directory. Localize the text that appears in the task_description column.

Table 9-15 om_task

Database Column Value

task_description

Possible values are:

  • Null Task

  • N/A

  • Recycle


om_view_order_node_label

This file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/ordertemplate/_table/_data directory. Localize the text that appears in the label column.

Table 9-16 om_view_order_node_label

Database Column Value

label

Default


About Generic Preferences

This section lists the generic user preferences in the OSM database tables. The file is located in your OSM_home/Database/dbinstall/install/OMS/main/model/user/preference/_table/_data directory.

To edit these tables, open the file using an XML or text editor and replace the description text with the target language text.

Note:

You must only localize the description values and not the column names. Column names are not externally visible, and are necessary for the internal operation of OSM.

After you localize this file, make sure you provide an updated copy to Oracle Global Support, so they can assist you with any future issues that may arise.

om_generic_mnemonic

Localize the text that appears in the description column.

Table 9-17 om_generic_mnemonic

CLASS Column Description

worklist_filter

Possible values are:

  • Accepted by current user

  • Assigned to current user

  • Received

  • Suspended

  • Completed

colour

Possible values are:

  • Black

  • White

  • Gray

  • Silver

  • Red

  • Green

  • Blue

  • Yellow

  • Purple

  • Olive

  • Navy

  • Aqua

  • Lime

  • Maroon

  • Teal

  • Fuschia

order_list

Possible values are:

  • Worklist

  • Search List

  • Notification List

user_attr

Possible values are:

  • Email address

  • User Local Timezone

  • Enable Worklist Filter

dynamic_filter

Possible values are:

  • Worklist filter field mnemonic

  • Worklist filter condition

  • Worklist filter lower value

  • Worklist filter upper value

  • Worklist filter display lower value

  • Worklist filter display upper value

login_screen

Possible values are:

  • System Default

  • Worklist

  • Home

  • Query

  • About


Localizing the Task Web Client

You can localize the following Task Web client items:

Note:

Before you can make any changes to the OSM UI, you must unpack the oms.ear file. See "Unpacking the oms.ear Application File" for more information.

The Task Web client is a Web-based application that provides information dynamically and a set of interactions that the end-user can perform on this information. The information appears as HTML pages, but server-side technologies produce the HTML output and provide user interaction.

For information on the Task Web client architecture, see OSM Task Web Client User's Guide.

The Task Web client uses the Java language, which has built-in support for localization of dates and times, as well as string sorting capabilities. The Task Web client uses the locale of the operating system upon which it runs in order to determine regional date and time settings.

When a user connects to OSM using their web browser, the OSM server attempts to determine their preferred locale. If no customization can be found for their preferred locale, the default locale (English) appears.

All modern Web-browsers support an "Accept-Language" header which indicates your locale preferences. Multiple language preferences can be specified, however OSM uses the top one listed to locate localization resources.

Unpacking the oms.ear Application File

Before you can perform any customization of the OSM UI, you must unpack the oms.ear application file. This gives you access to configuration files and directories that otherwise are compressed within oms.ear.

To do this, run unpackOMS.bat, which is located in your OSM_home/SDK/Customization directory.

To run unpackOMS.bat:

  1. Copy the oms.ear file from the WebLogic server domain's applications directory (for example, WLS_home/wlserver_10.3/server/bin/applications) to your OSM_home/SDK/Customization directory.

  2. From the Customization directory, use a text editor to open the unpackOMS.bat file and configure the JAVA_HOME variable. Configure the variable to specify your JDK directory. For example: set JAVA_HOME=C:\WebLogic\jdk160_11.

  3. Save the change and close the file.

  4. Run unpackOMS.bat. This creates the following subdirectories in the Customization directory:

    • osm-ear

    • osm-ejb

    • osm-war

    • osmwebui

    • resources

    Localization files are located in the resources directory. For information on the localizable resources contained in this directory, see "OSM Localization Resource Bundles".

Packing the File When You Finish

For your changes to take effect, ensure you run packOMS.bat, and copy the new oms.ear file to the WebLogic server domain's applications directory.

To run packOMS.bat:

  1. From the Customization directory, use a text editor to open the packOMS.bat file and configure the JAVA_HOME variable. Configure the variable by specifying your JDK directory. For example: set JAVA_HOME=C:\WebLogic\jdk160_11.

  2. Save the change and close the file.

  3. From your OSM_home/SDK/Customization directory, run packOMS.bat. This creates a new oms.ear file that includes your changes.

  4. Copy the new oms.ear into the WebLogic server domain's applications directory, that is, the same location from which you obtained the file in Step 1 of "To run unpackOMS.bat:", above.

OSM Localization Resource Bundles

After OSM is unpacked (see"Unpacking the oms.ear Application File"), the localizable resources are contained in the directories:

  • OSM_home/SDK/Customization/resources/resources

  • OSM_home/SDK/Customization/resources/xliff

The resources directory contains the localizable resource files for the Task Web client. The files in this directory, and their configuration, are described in this section ("Localizing the Task Web Client"). The xliff directory contains the localizable resource files for the Order Management Web client. The files in this directory, and their configuration, are described in "Localizing the Order Management Web Client".

The resources directory contains the resources.properties file. This file contains all localizable strings and image references. Several other properties files are included in the resources directory as samples, such as:

  • resources_cs.properties (localized for the Czech Republic)

  • resources_zh.properties (localized for China)

  • resources_en.properties

To create a new localization, create a new resources.properties file with the name resources_locale.properties, where locale is a locale code. For example, resources_ja.properties for Japan. For each parameter in the resources.properties file, you can provide a replacement value in the new locale. If a replacement value is not provided, the default value is used.

Localizing Date, Time and Currency Formats

To differentiate between 2:00:00 pm EST and 2:00:00 pm CST, modify the resource.properties file by changing the format.datetime.input setting to include time zone.

To specify this, you must:

  1. Open the resources.properties file.

  2. Specify date time input and display format. For example:

    format.datetime.input=MM/dd/yy hh:mm:ss a

    format.datetime.display=MM/dd/yy hh:mm:ss a

Table 9-18 Localizing Data Formats

Data Formats Description

format.encoding

Character set encoding used in browser communication

format.currency

Mask used for currency display and validation

format.date.input

Mask used for date display and validation in input fields

format.date.display

Mask used for date display in tables

format.datetime.input

Mask used for datetime display and validation in input fields

format.datetime.display

Mask used for datetime display in tables

format.am

String for AM field in web calendar

format.pm

String for PM field in web calendar


You must edit the mask.date and mask.time properties together. You cannot edit one property and leave the other one empty.

The available values for the properties include the following.

Table 9-19 Properties Values

Symbol Meaning Presentation Example

y

year

Number

2005

M

month in year

Text & Number

July & 07

d

day in month

Number

10

h

hour in am/pm (1~12)

Number

12

H

hour in day (0~23)

Number

0

m

minute in hour

Number

30

s

second in minute

Number

55

E

day in week

Text

Tuesday

D

day in year

Number

189

w

week in year

Number

27

a

am/pm marker

Text

PM

'

escape for text

Delimiter

N/A

''

single quote

Literal

'


The available values for the mask.currency include the following.

Table 9-20 Mask Currency Values

Symbol Meaning Presentation

#

zeros show as absent

Number

0

zeros show as 0

Number

,

the locale-specific grouping separator

Text

-

the locale-specific negative prefix

Text

;

separates positive number format from optional negative number

Text

'

escape for text

Delimiter

other

all other symbols appear as entered

Text


You must change the on-window text of the HTML pages produced by the OSM UI, and, if necessary, indicate the character set encoding.

Localizing Text and Error Messages

If text and error messages (that is, messages in the resource file that begin with "text" or "error"), contain parameterized values, for example: {0}, {1}, {2}, and so on, ensure the localized message uses the same parameterized values.

Localizing Page Titles

Page titles in the resource file begin with "page."

Localizing Image References

Image references consist of two parameters:

  • image.name.alt: The HTML "alternate" text to display for the image

  • image.name.src: The location of the image file in oms.war (see below).

Inserting New Images

All images that display in the Task Web client are contained in the oms.ear file, in the oms.war file. You can insert new images anywhere inside oms.war as long as your reference the correct location in the locale's resource.properties file. Oracle recommends that you create a directory for each localization and name the directory images_locale, where locale is a code for the location.

Editing the First Day of the Week

By default, the Task Web client date and time calendar assumes Sunday is the first day of the week. To change the default first day of the week, edit the calendar.js file and follow the instructions provided.

Note:

When displaying lists, the OSM Administrator application always displays Sunday as the first day of the week.

Editing the Task Web Client Gantt Chart

You can customize the Gantt chart's width, height, and property panel width by modifying the following properties in the GanttChart.jsp file:

  • var chartMaximumWidth = 1024;

  • var chartMaximumHeight = 1000;

  • var propertyPanelWidth = 200;

Editing the Boolean Data Element Values

The Task Web client displays boolean data element values in drop-down lists in several views. You can change the Boolean data element values the Task Web client displays by editing the OSM_home/SDK/Customization/resources/resources /resources.properties file.

To change Task Web Client boolean data elements:

  1. From the OSM WebLogic server, transfer the domain_home/servers/AdminServer/upload/oms/app/oms.ear file to the OSM_home/SDK/Customization folder.

  2. Unpack the osm.ear file using the unpackOSM.bat or unpackOSM.sh scripts located in the OSM_home/SDK/Customization folder. For information about these scripts, see the OSM System Administrator's Guide.

  3. Open the OSM_home/SDK/Customization/resources/resources /resources.properties file using a text editor.

  4. Change the default values.

    For example:

    # Boolean display values
    text.boolean.yes=Yes
    text.boolean.no=No
    
  5. Pack the osm.ear file using the packOSM.bat or packOSM.sh scripts located in the OSM_home/SDK/Customization folder. For information about these scripts, see the OSM System Administrator's Guide.

  6. Transfer the OSM_home/SDK/Customization/osm.ear file back to the domain_home/servers/AdminServer/upload/oms/app/ folder.

  7. Stop and restart the OSM WebLogic server. For more information about starting and stopping the OSM WebLogic server, see the OSM System Administrator's Guide.

Editing the Number of Records Displayed in the Worklist

You can change the number of records displayed in the Worklist view from the default by editing the oms-config.xml file.

See the chapter on configuring OSM with oms-config.xml in OSM System Administrator's Guide for detailed instructions on accessing and modifying the oms-config.xml file.

To change the number of records displayed in the Worklist view:

  1. Open the oms-config.xml file for editing.

  2. Search for max_worklist_rows, and update the <oms-parameter-value> tag with the new value

  3. Save and close the oms-config.xml file.

  4. Activate the changes to the configuration on your WebLogic server. See the chapter on configuring OSM with oms-config.xml in OSM System Administrator's Guide for details.

Editing and Replacing Task Web Client Icons

You can edit or replace the icon graphics that appear in the OSM UI. To do this, replace the graphical content of the existing icon files with your own, customized graphics.

When creating or editing an icon graphic, ensure you maintain the file name. For example, if you replace the graphical content of the about.gif file, ensure you name the resulting file about.gif.

It is recommended that you only customize or replace existing icon graphics if the original graphic introduces ambiguities or errors when you localize the OSM UI.

All of the OSM icon files are located in your OSM_home/SDK/Customization/osm-war/images directory.

Localizing the Order Management Web Client

As with the Task Web client, all language-specific text exposed by the Order Management Web client is localizable. Also, as with the Task Web client, you must unpack the oms.ear application file to access the resource bundle files. However, the location, number, and format of the bundle files differs:

Visit the following Web site to learn about the XLIFF standard:

http://docs.oasis-open.org/xliff/xliff-core/xliff-core.html

Example 9-1 shows a simple XLIFF example.

Example 9-1 XLIFF

<?xml version="1.0" encoding="UTF-8" ?>
<xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
  <file source-language="en" original="i18n.view.i18nTestBundle" 
  datatype="xml">
    <body>
      <trans-unit id="MESSAGE">
        <source>Hello world!</source>
        <target/>
        <note>The message to display</note>
      </trans-unit>
    </body>
  </file>
</xliff>

This file specifies a single localizable token ("MESSAGE") as well as the text with which to replace the token ("Hello world!") for the specified language ("en", which is English). The note element provides a description of the context in which the token is used. As with the resources_languageCode.properties file, an XLIFF file may contain parameters. However, unlike the numeric parameters in resources_languageCode.properties, the parameters in the Order Management Web client XLIFF files are named. For example, <source>Change Reference for Order {ORDER_ID}</source>. Building on Example 9-1, the XLIFF file might look like Example 9-2.

Example 9-2 XLIFF with <source>

<?xml version="1.0" encoding="UTF-8" ?>
<xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
  <file source-language="en" original="i18n.view.i18nTestBundle"  datatype="xml">
    <body>
      <trans-unit id="MESSAGE">
        <source>{SALUTATION} {RECIPIENT}!</source>
        <target/>
        <note>The message to display</note>
      </trans-unit>
    </body>
  </file>
</xliff>

As with the resources_languageCode.properties file, each XLIFF file is localized by creating a new file with the language code and (optionally) country code appended. Building on Example 9-2, "XLIFF with <source>", if the contents are found in a default bundle file named applicationBundle.xlf, a version localized to the French language would be named applicationBundle_fr.xlf, as shown in Example 9-3.

Example 9-3 XLIFF Language set to French

<?xml version="1.0" encoding="UTF-8" ?>
<xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
  <file source-language="fr" original="i18n.view.i18nTestBundle_fr" datatype="xml">
    <body>
      <trans-unit id="MESSAGE">
        <source>Bonjour le monde!</source>
        <target/>
        <note>The message to display</note>
      </trans-unit>
    </body>
  </file>
</xliff>

For more information about the faces.config.xml file, see Oracle Fusion Middleware Web User Interface Developer's Guide for Oracle Application Development Framework.

Example 9-4 shows an example faces.config.xml with the language set to French and English.

Example 9-4 faces.config.xml Language set to French and English

<?xml version="1.0" encoding="windows-1252"?>
<faces-config version="1.2" xmlns="http://java.sun.com/xml/ns/javaee">
  <application>
    <default-render-kit-id>oracle.adf.rich</default-render-kit-id>
    <locale-config>
      <default-locale>en</default-locale>
      <supported-locale>en</supported-locale>
      <supported-locale>fr</supported-locale>
    </locale-config>
  </application>
</faces-config>

You can specify the default and supported locales using <default-locale>locale</default-locale> and <supported-locale>locale</supported-locale> respectively where locale is the locale you want to register with.

As with the Task Web client, after the file is localized (in this case, multiple files are localized), the application must be reassembled using the packOMS.bat utility.

Changing the Order Management Web Client Logo Image and Text

To change the Order Management Web Client logo image and text, do the following:

  1. From the OSM WebLogic server, transfer the domain_home/servers/AdminServer/upload/oms/app/oms.ear file to the OSM_home/SDK/Customization folder.

  2. Unpack the osm.ear file using the unpackOSM.bat or unpackOSM.sh scripts located in the OSM_home/SDK/Customization folder. For information about these scripts, see the OSM System Administrator's Guide.

  3. Go to the OSM_home/SDK/Customization/osmwebui/images folder.

  4. Change any images with the Oracle logo. Do not change the image names or file types.

    For example:

    • splash.jpg: This image is used in the Order Management Web Client login and about screens and contains the Oracle logo at the top left corner.

    • splash.bmp: This is the Order Management Web Client background and contains the Oracle logo at the top left corner.

  5. Open OSM_home/SDK/Customization//resources/xliff/oracle/communications/ordermanagement/ui/order3columnBundle.xlf using a text editor.

  6. Change the text associated with the customized Oracle logo images.

    For example:

    <?xml version="1.0" encoding="windows-1252" ?>
    <xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
      <file source-language="en" original="oracle.communications.ordermanagement.ui.order3columnBundle"
            datatype="xml">
        <body>
          <trans-unit id="OSM_APP_NAME">
            <source>custom_name</source>
            <target/>
          </trans-unit>
          <trans-unit id="HOME_PAGE_TITLE">
            <source>custom_name2</source>
            <target/>
          </trans-unit>
          <trans-unit id="DENIED_SEARCH_MSG">
            <source>You are not authorized to perform search</source>
            <target/>
          </trans-unit>
          <trans-unit id="ERROR_MSG_SUBJECT">
            <source>Error</source>
            <target/>
          </trans-unit>
        </body>
      </file>
    </xliff>
    

    where custom_name is the text associated splash.jpg and custom_name2 is the text associated with splash.bmp.

  7. Pack the osm.ear file using the packOSM.bat or packOSM.sh scripts located in the OSM_home/SDK/Customization folder. For information about these scripts, see the OSM System Administrator's Guide.

  8. Transfer the OSM_home/SDK/Customization/osm.ear file back to the domain_home/servers/AdminServer/upload/oms/app/ folder.

  9. Stop and restart the OSM WebLogic server. For more information about starting and stopping the OSM WebLogic server, see the OSM System Administrator's Guide.