Professional Documents
Culture Documents
AVEVA VPRM Internationalisation Support
AVEVA VPRM Internationalisation Support
Internationalisation
Support
VPRM Release 9.8
Issue 11
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from
viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss
of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data
created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in
contract, tort (including negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the
user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence
under which the AVEVA software was purchased, the clauses in the software licence shall take precedence.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied
with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this
document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or
transmitted without the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it
expressly requires that this copyright notice, and the above disclaimer, is prominently displayed at the beginning
of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this
publication may be incorporated into any third-party software, product, machine, or system without the prior
written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms
and conditions of the respective software licences, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the software is strictly prohibited.
Copyright 1994 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall
not be liable for any breach or infringement of a third party's intellectual property rights where such breach results
from a user's modification of the AVEVA software or associated documentation.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use
of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or
logo belongs to its respective owner.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK
VPRM Internationalisation Support Contents
Contents
INTRODUCTION ............................................................................................................................ 3
GLOSSARY ................................................................................................................................... 3
OVERVIEW OF INTERNATIONALISATION .................................................................................. 4
OVERVIEW OF MULTI-BYTE ENVIRONMENT ............................................................................. 5
Environment Restrictions .......................................................................................................... 5
Disclaimer ........................................................................................................................... 5
Restricted Entry Fields ........................................................................................................ 5
Cautionary Usage within VPRM .......................................................................................... 5
VPRM Configuration Restriction .......................................................................................... 6
Anticipated future developments ......................................................................................... 6
Multi-byte Data Entry................................................................................................................. 6
Reduced Multi-byte Character Limit .................................................................................... 6
Hint Text Notation ............................................................................................................... 6
Input Method Editors (IME).................................................................................................. 6
Text IO File Transfer ................................................................................................................. 7
INSTALLATION ............................................................................................................................. 8
TECHNOLOGY & TERMINOLOGY................................................................................................ 9
VPRM ....................................................................................................................................... 9
User Locale ......................................................................................................................... 9
Servlet Configuration ........................................................................................................... 9
VPRM format support for Microsoft Excel ......................................................................... 9
Text IO Interface ................................................................................................................. 9
Oracle ..................................................................................................................................... 10
NLS_LANG ....................................................................................................................... 10
NLS Dates ......................................................................................................................... 10
NLS Linguistic Sort ............................................................................................................ 10
Microsoft ................................................................................................................................. 10
Windows Regional Options ............................................................................................... 10
Microsoft Excel Interface................................................................................................. 10
PROCEDURES ............................................................................................................................ 12
Troubleshooting Multi-byte Data Entry .................................................................................... 12
Input Method Editor (IME) ................................................................................................. 12
Command Edit Menu (via IME).......................................................................................... 12
Toolbar Edit Functions ...................................................................................................... 13
Cut from 3rd Party Applications + Paste ............................................................................. 13
Cut and Paste via Keyboard between VPRM Entry Fields ................................................. 13
Imported Data (Excel & Text Files) .................................................................................... 14
Printing Multi-byte Data ........................................................................................................... 15
Configuring a PC for I18N ....................................................................................................... 16
Your Locale ....................................................................................................................... 16
Language Setting for System ............................................................................................ 16
Native Language Support........................................................................................................ 17
APPENDICES .............................................................................................................................. 18
Troubleshooting a VPRM Multi-lingual Environment................................................................ 18
Objective ........................................................................................................................... 18
Intended Audience ............................................................................................................ 18
Exceptions & Restrictions .................................................................................................. 18
Support Issues .................................................................................................................. 18
I18N Platform Configuration Guide .................................................................................... 19
Issue 10 Page i
VPRM Internationalisation Support Contents
Issue 10 Page ii
VPRM Internationalisation Support Introduction & Glossary
Introduction
This Guide is a central source of information for those users who wish to activate and utilise the
Internationalisation features that localise VPRM. The user must make constant reference to the
various sections contained here within and make themselves familiar with all the aspects and
implications of Internationalisation before embarking on installation, configuration and maintenance
of VPRM.
The intended audience is IT staff: who install, maintain, support VPRM, e.g. DBA, PC support,
network, server.
Contained in this guide is information relating to:
Installation Notes for Internationalisation
Definitions of the technology and terminology used in VPRM for Internationalisation
Procedures for the support of Internationalisation
Reference guides for trouble-shooting problems associated with Internationalisation support and
configuration.
Please refer to refer to the Release Notes accompanying the specific VPRM release for a list of
what languages and locales AVEVA have tested and support.
Glossary
TERM DESCRIPTION
I18N Internationalisation
NLS National Language Support
UTF-8 Universal Character Set Transformation Format, 8 bit
UCS2 Unicode Character Set, 2 byte
ASCII7 American Standard Code Information Interchange, 7 bit
Issue 10 3
VPRM Internationalisation Support Overview of Internationalisation
Overview of Internationalisation
Multiple environments may exist within a common VPRM system for support of different national
languages. Each of these national environments is called a locale, which considers the language, its
characters, fonts, and the customs used to input and format data. The VPRM Desktop Environment
is fully internationalised such that any application can run using any locale installed in the system.
Within VPRM, use of Servlet technology and Oracle NLS has been employed to achieve
Internationalisation. For each different NLS_LANG variant used to support different locales there
MUST exist a Servlet configured specifically to support that environment, please refer to Installation
Guide on how this is achieved.
Issue 10 4
VPRM Internationalisation Support Overview of Multi-byte Environment - Environment Restrictions
Environment Restrictions
The intention here is to help users of VPRM understand the restrictions imposed on them with
regards the usage of multi-byte UTF-8 data. The term multi-byte is applied to characters that
require more than one byte of data to represent a given symbol. This document details a list of
known multi-byte usage restrictions for VPRM both from a configuration and operational stance.
Disclaimer
There are some known multi-byte usage restrictions, which are validated at the point of entry and
hence will be rejected. Such multi-byte usage is designated as a high risk status and they will
prevent VPRM from functioning. Other VPRM multi-byte usage restrictions, noted in this
documentation, are only cautionary. They may cause unpredicted results or even minor data
corruption. These problems may be resolved by changes to code or system configuration. Finally,
there are a number of areas where the ability to handle multi-byte data is out of the domain of
VPRM. It is these areas where AVEVA can only advise the user of the possible consequences.
The term special character refers to the following list (which is not exclusive);
\ / | back slash, forward slash, vertical line
: * ? colon, asterisk, question mark, double-quote
<> less than, greater than
.% full-stop, single-quote, percent
Issue 10 5
VPRM Internationalisation Support Overview of Multi-byte Environment - Multi-byte Data Entry
Issue 10 6
VPRM Internationalisation Support Overview of Multi-byte Environment - Text IO File Transfer
the script. Microsoft is currently extending the language support for IMEs, which includes Japanese,
Chinese and Korean etc. Please refer to Microsoft for the current list of IMEs. VPRM supports
characters entered into data entry fields via an IME provided that the System Locale supports the
language.
Issue 10 7
VPRM Internationalisation Support Installation - Text IO File Transfer
Installation
Please refer to the Installation Guide and take extra note of the options to support multi-byte
characters, in the Internationalisation (I18N) configuration section. Please note that by selecting the
Multi-byte Character Support option activates Font Aliasing, which will affect the appearance of
the Reports.
Issue 10 8
VPRM Internationalisation Support Technology & Terminology - VPRM
VPRM
User Locale
Each VPRM User now has a preferred Locale setting configured as part of their User Profile. This
User Locale determines the NLS_LANG setting to be applied to the VPRM user session and also
determines the Servlet environment used during Module access.
Servlet Configuration
Servlet technology has been adopted on VPRM. Servlets are configured on the AS web server as a
means to support many different NLS Locales on the same hardware. Each configured user Locale
should be supported by a corresponding NLS configured Servlet environment. Please refer to the
Operating Environment Guide and Installation Guide for more details on the AS Servlet set up and
configuration.
Text IO Interface
Dates
The format of dates in the various VPRM Interfaces that utilises Text IO is in a fixed format as
described in the table below;
Issue 10 9
VPRM Internationalisation Support Technology & Terminology - Oracle
Where:
DD Day of Month (1-31)
MM Month of Year (1-12)
YYYY 4 digit Year (i.e. 2002)
Numeric Format
The numeric decimal point format expected for import and export of data via the Text IO Interface is
.. The Windows Regional Options does not affect the expected format.
Oracle
NLS_LANG
NLS_LANG is the environment variable used by Oracle to localise the users environment. It is made
up of 3 components that consequently change the behaviour of the Oracle product and the
operation of VPRM. The NLS_LANG has been extensively used in VPRM to localise the behaviour
of Dates and Linguistic Sorting (as detailed below). See the Troubleshooting a VPRM Multi-lingual
Environment for a more detailed definition of NLS_LANG in context with VPRM or refer to the
Oracle documentation.
NLS Dates
All the date formats that appear in VPRM Screens are sensitive to the Locale setting of the User.
The localised date format for supported Locales is specified in the Oracle NLS Guide. The date
format on VPRM Reports will be generated in the format of DD-MON-YYYY, where MON will be
localised to the Users language (i.e. Jan in English will be Ene in Spanish).
Microsoft
Issue 10 11
VPRM Internationalisation Support Procedures - Troubleshooting Multi-byte Data Entry
Procedures
This section contains a number of procedures that the reader will need to be aware of in order to
activate and utilise the Internationalisation features incorporated in VPRM. It also provides useful
information for data entry trouble-shooting. This will also be of particular interest to users who wish
to customise the VPRM system.
This section is a guideline for users concerned with the behaviour of entering multi-byte data into an
entry field within VPRM. This should be used as a reference listing of the data entry restriction using
the identified data entry methods including which the user should be aware.
Issue 10 12
VPRM Internationalisation Support Procedures - Troubleshooting Multi-byte Data Entry
Paste allows the user to cut or copy selected data from a field and repeatedly paste the data
into the same field or another. It is possible to enter more than the maximum number of
bytes into a field by entering multi-byte characters up to the maximum number of characters
allowed for the entry field. The Paste button is disabled if the number of characters in the
copy buffer is greater than the maximum number of characters allowed for that entry field.
Conclusion
The user must be aware that such truncation may take place when the data is copied to the data
entry field.
Issue 10 13
VPRM Internationalisation Support Procedures - Troubleshooting Multi-byte Data Entry
Issue 10 14
VPRM Internationalisation Support Procedures - Printing Multi-byte Data
Issue 10 15
VPRM Internationalisation Support Procedures - Configuring a PC for I18N
Your Locale
This setting determines the I18N support for applications that makes use of the System Locale. This
setting is more akin to the Territory setting for Oracle NLS. In the General tab under Regional
Options the user can select a Windows supported Locale e.g. Spanish (Spain) or Spanish
(Mexico). By default, the following Localisation settings are set to reflect the new Locale:-
Numeric Format
Currencies
Dates
Time
Sort (if an option exists)
These setting are available to applications running on the PC to allow them to reflect the Regional
settings. The user is only able to choose from the installed Locales that are supported by the
Language Setting for the System, see below.
Overriding the Locale Settings
The user may override the Locale Settings of a particular Locale simply by going to the appropriate
tab in Regional Options and setting the parameter manually.
Issue 10 16
VPRM Internationalisation Support Procedures - Native Language Support
Issue 10 17
VPRM Internationalisation Support Appendices - Troubleshooting a VPRM Multi-lingual Environment
Appendices
Objective
The objective here is to identify all of the components that make up and affect the I18N support for
VPRM from a user perspective. It is hoped that this information will assist the user to make
reasoned decisions about what must be done and what are the overriding factors when trouble-
shooting or configuring a VPRM environment for multilingual support.
Intended Audience
The user must have followed the recommended guidelines for platform support of VPRM. The user
who is performing the configuration of VPRM must be familiar with the set up procedure for
Regional Options within Microsoft Windows.
Support Issues
Microsoft Windows
Microsoft Windows uses UCS2 for its underlying architecture, which is a Unicode Character Set
consisting of 2 bytes. This has the effect that every character consists of 2 bytes, which means that
the ANSI character subset contains a leading NULL character. Microsoft Windows does NOT
directly support the UTF-8 character set. However, certain applications are capable of supporting
encoded character set documents, even UTF-8.
Oracle
Oracle Database does NOT support UCS2 character set for its database encoding. The preferred
Unicode compliant character set is UTF-8. UTF-8 is a variable multi-byte character set [Universal
Transformation Format 8 bit] that only utilises the required number of bytes necessary to store a
character. It uses the leading bits of the first byte to indicate how many bytes make up the character
code. The transformation converts the byte[s] to USC2. One of the key features is that the ASCII-7
character set maps directly to UTF-8.
Issue 10 18
VPRM Internationalisation Support Appendices - Troubleshooting a VPRM Multi-lingual Environment
Servlet Configuration [1][4] Servlet technology is used primarily to allow several Oracle
environments to exist on a common AS Server. This allows a user of a particular Locale to
connect via a Servlet of the same Locale.
AS Software
VPRM Application
Text IO [5] the Internet Explorer Encoding influences the character set encoding of the
saved text files. As part of the I18N changes the encoding of the Internet Explorer has been
forced to UTF-8. To ensure no data corruption occurs when dealing with text files, interfacing
with VPRM, it is important that applications used to modify the data have the ability to
support UTF-8.
VPRM User [3][4]
Client [3] the Language support of the client restricts the users ability to enter characters.
The default Locale of the client will not affect the regional behaviour of VPRM beyond this,
however the user must be aware that this setting may affect the behaviour of other
applications that interface with VPRM.
User Profile [4] each valid VPRM user has a preferred Locale that influences the behaviour
of VPRM itself. Once a user has successfully entered a VPRM Module, the behaviour of the
I18N sensitive data is affected, by the users Locale NLS setting.
Issue 10 19
VPRM Internationalisation Support Appendices - Troubleshooting a VPRM Multi-lingual Environment
Client [2]
PC Hardware [2] the I18N support of the hardware is determined by the I18N support
capabilities of the Windows Operating System and the keyboard layout.
Internet Browser deployed on the client is encoded as UTF-8 when connection to VPRM
is established. The encoding is specified in the configuration of VPRM in the middle tier and
is set as UTF-8 in the installation.
PC Hardware [1][2]
Microsoft Windows Operating System [1][2] provides the user with the ability to configure
their PC to support different Locales via the Regional Options.
Keyboard
Microsoft Windows Operating System [1][2][3]
The Mircosoft Windows platform used must support Unicode. For information about Unicode version
2.0, please visit the following Web site http://www.unicode.org/
Code Page [3] determines the keyboard character mappings with the operating system and
the Applications. Keyboard mappings differ to support different languages.
IME[3] - is simply an application that extends the keyboard capability via a phonetic dictionary
to allow support for languages that use ideographs.
Regional Options [1][3][4] determines the regional behaviour of applications that are
sensitive to these settings.
Font Support [2][3] is provided by Microsoft or a third party font provider. There must be,
installed on MS Windows a font type that supports the Language Setting of Regional
Options. Applications make use of these fonts to display the language script correctly within
the applications.
Servlet Configuration [1]
NLS_LANG [1][4] is set up to support the preferred Locale of a VPRM user. There should
exist a Servlet to support each different type of VPRM user Locale, which by default will be
set with a UTF-8 character set. A Servlet will also exist to support the character set content
of a MS Excel interface, which should correspond to the default Language Setting in
Regional Options.
NLS Override Parameters [4] by default a number of NLS features localises data, which
has not been made I18N aware in VPRM. Therefore, these NLS features will be overridden
within the Servlet.
NLS_LANG [1]
[Oracle Extract] 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 I18N Support features.
language Specifies conventions such as the language used for Oracle messages, day names, and
month names. Each supported language has a unique name--for example, American
English, French, or German. The language argument specifies default values for the
territory and character set arguments, so either (or both) territory or charset can be omitted.
If language is not specified, the value defaults to American English.
Territory Specifies conventions such as the default calendar, collation, date, monetary, and
numeric formats. Each supported territory has a unique name; for example, America,
France, or Canada.
Issue 10 20
VPRM Internationalisation Support Appendices - Troubleshooting a VPRM Multi-lingual Environment
Issue 10 21
VPRM Internationalisation Support Appendices - Troubleshooting a VPRM Multi-lingual Environment
Issue 10 22