OA Extension Translation Toolset

The OA Extension Translation toolset deals with translatable information contained in OA Extension pages using XLIFF, a widely used XML format for transferring and manipulating translatable resources.

Note: The toolset actually uses oraXLIFF, an Oracle dialect of XLIFF defined and used by WPTG (Oracle's Worldwide Product Translation Group).

The Translation toolset consists of the following:

XLIFF Extractor

The XLIFF Extractor extracts the translatable information from a given OA Extension document, into an oraXLIFF file. The XLIFF Extractor can:

The XLIFF Extractor for the Oracle E-Business Suite behaves according to the following rules:

Oracle E-Business Suite-Specific Rules

General Rules

Attention: If the value of xml:lang is 'end-US', apply only Oracle E-Business Suite-specific rules 2 and 3 and general rule 2.

To use the XLIFF Extractor, ensure that your classpath, path and environment are set up similar to the environment required for applying an AD patch, and call Java oracle.jrad.tools.trans.extractor.XLIFFExtractor <full_path_of_file_or_directory_name> with the appropriate parameters.

If you have Oracle JDeveloper OA Extension, you may alternatively use the xliffextract.bat script for Windows or the xliffextract shell script for Linux that is packaged with the JDeveloper IDE, located in the jdevbin\jdev\bin directory of the JDeveloper install area. The batch file and shell script each set up the classpath, path and environment for you. Just typing xliffextract for Windows or ./xliffextract for Linux at the command prompt without any parameters will give help about its usage. Parameters enclosed in square brackets [ ] are optional.

Example
Java oracle.jrad.tools.trans.extractor.XLIFFExtractor 
  <fullPathOfFileName_or_directoryname> 
[-username <username>]
[-password <password>]
[-dbconnection <database_connection>]
[-xliff_extension <xliff_extension>]
[-root <MDS_root_dir>]
-mmd_dir <dir_of_MMD_files>
[-DBDRV <APPS_db_drivers>]
[-xliff_dir <XLIFF_output_dir>]
[-rootPackage <rootpkg>]
[-includeSubpackages]
[-product_name <product_name>]
[-category <category>]
[-source (db | file)]
[-languages <target_language(s)>]

Note: In addition to the parameter passing style shown above, you may also pass parameters using the style, parameter=<value>.

Replace the arguments as indicated in the explanation of the parameters below:

Using XLIFF Extractor with the -languages parameter

If both the XML file from the file system and the XML file from repository are different (XML file from file system contains extra translatable strings), you can use XLIFF Extractor with the -languages option. This merges the translated attributes from the repository so that the generated XLIFF file contains both translated and untranslated strings.

XLIFF Extractor does the following when the -languages option is specified:

Attribute "AAA" in XML in file system Translation for attribute "AAA" in repository XLIFF file
Not present Present Attribute string ignored.
Present Not present Contains untranslated "<target>AAA<target>"
Present Present, translation string is BBB Contains "<target>BBB<target>"

Using the Export tool with -translation option

If both the XML file from the file system and the XML file from the repository are the same, you can use Export -translations to export and extract the XLIFF file. The resulting XLIFF file contains only the translated strings. You can use this method to transfer the already translated contents from your repository to the file system, so you can then move the translations from one repository to another. Note that in the degenerate case where translations for all the translatable attributes of a XML file exist in a repository, the XLIFF files created by both "Export -translations" and "xliffExtract -languages" are similar.

Notes:

XLIFF Extractor Examples

To extract the base language content from the FND_MESSAGES_PAGE.xml file in the file system into a new document located in f:\temp\oracle\apps\fnd\pages\US\FND_MESSAGES_PAGE.xlf (for Windows) or /private/oaext/oracle/apps/fnd/pages/US/FND_MESSAGES_PAGE.xlf (for Linux):

To extract the base language content from the personalized FND_MESSAGES_PAGE.xml file in the file system into a new document located in f:\temp\oracle\apps\fnd\pages\US\FND_MESSAGES_PAGE.xlf (for Windows) or /private/oaext/oracle/apps/fnd/pages/US/FND_MESSAGES_PAGE.xlf (for Linux):

To extract translation content for XML from a repository:

When you extract translation content for XML with different target languages, XLIFF Extractor creates multiple copies of the XLIFF file, one for each language. Each copy is saved to the same directory structure, under a subdirectory of the same name as the target language. The following Windows example creates the files c:\temp\Fr-FR\page1.xlf with target-language="Fr-FR" and c:\temp\JA-JP\page1.xlf with target-language="JA-JP".

XLIFF Importer

The XLIFF Importer takes a translated XLIFF file and imports it into the MDS Repository. This effectively deploys the translated OA Extension document. The Importer tool performs the following validations on the XLIFF files it imports:

To use the XLIFF Importer, ensure your classpath, path and environment are set up similar to what is required for applying an AD patch and call Java oracle.jrad.tools.trans.imp.XLIFFImporter <full_path_of_file> with the appropriate parameters.

If you have Oracle JDeveloper OA Extension, you may alternatively use the Windows xliffimport.bat file or the xliffimport Linux shell script that is packaged with the JDeveloper IDE, located in the jdevbin\oaext\bin directory of the JDeveloper install area. The batch file and shell script each set up the classpath, path and environment for you. Just typing xliffimport without any parameters will give help about its usage.

Java oracle.jrad.tools.trans.imp.XLIFFImporter 
  <full_path_of_file>
-username <username>
-password <password>
-dbconnection <database>

The arguments should be replaced as described for the corresponding parameters below: