About Oracle XML Publisher Release 5.5

Last revised: July 29, 2005

See Change Record

This document provides a complete, up-to-date description of Oracle XML Publisher Release 5.5 (4206181). You should read and understand all tasks described here before you begin your installation. The most current version of About Oracle XML Publisher Release 5.5 is OracleMetaLink Document 316447.1. Please ensure that you have the most current version before you begin.

How to Use this Document

This About Document contains the following information about Oracle XML Publisher Release 5.5.

1. New and Changed Features
2. New and Changed Components
3. New and Changed Setup Steps
4. Known Issues
5. Instructions for Applying Oracle XML Publisher Release 5.5 
6. Implementation and User Documentation
7. Software Updates
8. About Document Change Record

Target Audience:

• The Business User: Provides knowledge and guidance regarding application functionality.
• The Database Administrator: Installs and configures the Oracle database and maintains database access controls.
• The System Administrator: Responsible for administering systems.

Prerequisite Patch Application Instructions:

1. You must have already completed an installation of, or upgrade to, Oracle Applications Release 11i before advancing to Oracle XML Publisher Release 5.5. The patch application instructions in this document are appropriate for starting from any earlier version of Oracle XML Publisher Release 11i. 
2. If you do not already have a running Oracle Release 11i system, then you must first install the Oracle E-Business Suite. Please consult the related installation documentation, located on the Oracle Applications Online Documentation CD on OracleMetaLink.

Additional Product Information:

After you learn which features are new for your installation, you can find related information for those features by referring to the most recent version of the Oracle XML Publisher User's Guide and Online Help. You can also use the other sections of this document to learn about product enhancements made to Oracle XML Publisher Release 5.5.

1. New and Changed Features

New Features

RTF Template Enhancements:

The RTF template now supports the following features. See the Oracle XML Publisher User's Guide for information on how to use these features.

Brought Forward/Carried Forward page totals - used frequently in financial reporting, this feature allows you to calculate the page total for a given field, display it at the bottom of the page to be carried forward, and then displayed at the top of the subsequent page as the brought forward total.

Updateable Variables - Updateable variables differ from standard XSL variables <xsl:variable> in that they are updateable during the template application to the XML data. This allows you to create many new features in your templates that require updateable variables, such as a running total.

Parameters - you can now declare parameters in your template and pass values at runtime.

Batch Processing Enhancements - this release provides better support for batch processing based on RTF templates by now supporting the following features:

Restart page numbering for section breaks - for example, if generating invoices for multiple customers, you can now restart the page numbering for each new invoice.

Reset header and footer - similarly, if header and footer data is being supplied from the data (such as customer name), it can be reset for each new invoice.

Multicolumn Pages - Microsoft Word's native multicolumn page function is now supported.

Initial Page Number - allows you to define the number from which you want the first page of the report to begin.

Property Support - you can now set any of the XML Publisher properties in the template, you do not have to set them in the configuration file.

Check boxes - this feature allows you to include a check box in your template that you can define to display as checked or unchecked based on a value from the incoming data.

If-then-Else - you can now create conditional statements using the common programming construct If-then-Else.

Number and Date Formatting - you can now use the Oracle number and date format masks to control the display of numbers and dates. The Oracle masks ensure that at runtime the appropriate locale-specific formatting is used. The Microsoft native formatting masks are also supported.

Translation Support

The Template Manager now allows you to define a template as "translatable." When you define a template as translatable, XML Publisher extracts the translatable strings. You can then export the strings into an XLIFF (.xlf) file. This XLIFF file can then be sent to a translation provider, or using a text editor, you can enter the translation for each string. Upload the translated XLIFF file back to the Template Manager to make the translated templated available at runtime.

Configuration File Property Support in RTF Templates

XML Publisher properties that are available in the XML Publisher Configuration file can now be embedded into the RTF template. The properties set in the template are resolved at runtime by the XML Publisher engine. You can either hard code the values in the template or embed the values in the incoming XML data. Embedding the properties in the template avoids the use of the configuration file.

Configuration File Properties

Several properties have been added to the XML Publisher configuration file to support translation handling and bidirectional character handling:

The following properties control bidirectional character handling:

• digit-substitution
• bidi-chartype.[charcode(hex)]

  The following properties control translation unit selection and length:

• xliff-trans-expansion
• xliff-trans-max-length
• xliff-trans-min-length
• xliff-trans-null
• xliff-trans-symbol
• xliff-trans-keyword

2. New and Changed Components

This section lists the components that were added or changed for Oracle XML Publisher Release 5.5.  The components detailed in this section may have significant impact to existing customizations and/or extensions currently implemented on the system.  Take the necessary steps to review and understand the implications of these updates in these areas. For additional information refer to the Oracle Electronic Technical Reference Manuals (eTRM) located on OracleMetaLink.

• Changed User Interfaces
• Changed Public APIs
• New Programs
• New Profile Options
  

Changed User Interfaces

Changed HTML Pages

Create Template 

The Create Template page now contains a Translatable check box. Select this check box if you wish to export the translatable strings from your template into an XLIFF file.

View Template

The View Template page has been updated to accomodate the new translation features available in the Template Manager for RTF templates. If you define a template as translatable, the Template Files region of the page will display three subregions:

• Localized Templates - displays RTF template files uploaded for different language/territory combinations.
• Translatable Template - displays the base RTF template file from which XML Publisher generates an XLIFF file. This region also contains buttons to Export and Upload the XLIFF for this template.
• Available Translations - displays the available translated XLIFF files that have been uploaded for the base translatable template. Buttons allow you to enable or disable available translations.

Changed Public APIs

TemplateHelper class

With this release you can define a translatable template for each template code. The text in the template file can be retrieved in XLIFF format to be translated and then merged back into the file. To support this functionality, the following methods have been added to the TemplateHelper Class

• getXLIFF() - Downloads the translatable boilerplate text for a template in XLIFF format.
• uploadXLIFF() - Uploads the translations for a template in XLIFF format.

New Programs 

XML Publisher Template Re-Generator - run this program as a post-install step if you are upgrading from an earlier release of XML Publisher. This program regenerates your templates for compatibility with the latest version of the engine.

New Profile Option 

XDO: Calendar Type

You can now select the calendar type for your XML Publisher-generated reports using the XDO: Calendar Type profile option. Calendar types supported are:

• GREGORIAN
• ARABIC_HIJRAH
• ENGLISH_HIJRAH
• JAPANESE_IMPERIAL
• THAI_BUDDHA
• ROC_OFFICIAL (Taiwan)
  

3. New and Changed Setup Steps

This section does not apply to Oracle XML Publisher Release 5.5.

4. Known Issues

There are no known issues that will prevent you from successfully applying Oracle XML Publisher Release 5.5.

However, the following issues regarding XML generation by Oracle Reports are known and may impact your ability to successfully use XML Publisher. The fixes for these problems are provided below:

Oracle Reports 6i does not set the encoding attribute in generated XML output.

• Option1: Upgrade to Applications Release 11.5.10 CU2, which includes the fix.
• Option 2: Apply the following patches:
  • Part1: Fix for Bug 4105297 - Request the controlled release patch 4302733. The passwords can be accessed through the bug.
  • Part2: Fix for Bug 4105369 - Apply 11i.ADXE.1 FEB 2005 CUMULATIVE UPDATE (4175764)

Outdated Arabic message file in Oracle Reports

One of the Arabic message files in Oracle Reports (r60ar.msb) is outdated on Unix platforms, resulting in a failure while generating XML output. Oracle E-Business Suite customers running into this issue can fix the issue by removing $ORACLE_HOME/reports60/mesg/r60ar.msb. This issue was reported in bug 4173459.

References:

• Refer to the latest 11i Applications Recommended Patch List to see if you should apply any additional Oracle XML Publisher patches on top of Oracle XML Publisher Release 5.5. To access the 11i Application Recommended Patch List:
  1. Log on to OracleMetaLink.
  2. On the OracleMetaLink page, click Patches.
  3. Click the eBusiness Suite Recommended Patch List link.
  4. Specify your query criteria to retrieve application recommended patches for your instance.

5. Instructions for Applying Oracle XML Publisher Release 5.5

Read these instructions if you are advancing from an earlier Oracle XML Publisher version to this Oracle XML Publisher Release 5.5. These patch application steps are cumulative and apply to all versions since the base release of 11i.1.

Tasks included in these instructions require use of the AutoPatch, AD Administration, and other AD utilities. For information about how to use these utilities, refer to Oracle Applications Maintenance Utilities, Release 11i .

If you have languages other than American English licensed in your installation, you should apply the translated versions (if they exist) of each Oracle Applications patch referenced in these instructions immediately after applying the American English version, unless the instructions state otherwise.

There may be both technical and functional steps required to apply this patch. Functional steps may require assistance from someone familiar with application setup and use, and with business processes at your enterprise.

Before you apply this minipack...

For the System Administrator...

Ensure that the Business User receives a copy of this document to review the new features included in Oracle XML Publisher Release 5.5. Some optional features may require additional patches and technical setup.

For the Business User...

Review this document. This document contains the descriptions of new features that are being delivered by this minipack, implementation steps for these new features, and known issues with Oracle XML Publisher Release 5.5.

Pre-install Steps

The following pre-install steps must be completed prior to applying Oracle XML Publisher Release 5.5. If you already completed a step during a previous 11i patch application, then you do not need to complete the step again, unless otherwise specified.

Step 1 Apply the AD minipack. (Required)

Ensure that the you have installed the latest version of AD before proceeding with this patch. At this time the latest version is AD minipack I.2.

• 4038964 - AD Patch 11i.AD.I.1

Step 2 Apply additional prerequisites (Required)

The following patches are required prior to applying Oracle XML Publisher Release 5.5.

1. 2771817 - OA Self Service Framework V5.7H
2. 2949264 - Concurrent Processing Rollup Patch F
3. 3043856 - PHP Login Causes Double Decrement of FND_USER.PASSWORD_ACCESSES_LEFT
4. 3412795 - ADSPLICE Patch for XDO
5. 3641831 - DBI60:RUP4:WF_EVENT_OMB_QH is invalid after applying HR_PF.D
6. 3671463 - OA Framework Rollup Patch 5.7H - V6+
7. 3902820 - New Consolidated Fixes - Post AOLJ Patch 3313291
8. 3942438 - Workflow Directory Services, Version 4 (Role Hierarchy Support)
9. 3948369 - AOL Security Rollup Patch I.1
10. 4104924 - TXK (FND) AutoConfig Template Rollup Patch K (July 2005)
    
    

Step 3 Oracle Release 11i Use of Multiple Organizations in Oracle Applications (Recommended)

Oracle Applications strongly recommends that our customers convert to Multi-Org as soon as possible. We are making this recommendation in order to prepare for improvements to performance across the Oracle E-Business Suite as well as to prepare for supporting Multi-Org Access Control, an upcoming feature of the Oracle E-Business Suite.

For detailed information, see Release 11i Use of Multiple Organizations in Oracle Applications (OracleMetaLink Document 210193.1).

Functional Prerequisites

Product	Feature	Patch	Patch Description
Application Object Library	One-step reporting with the Concurrent Manager	3435480	Publishing Concurrent Requests with XML Publisher. (Note: This patch is included in the Oracle E-Business Suite 11.5.10 Cumulative Update 1.)

Applying this minipack...

Oracle XML Publisher Release 5.5 (4206181) contains a unified patch driver and may contain additional driver files to be applied with AutoPatch.  Please apply the driver file on all application tier server nodes. 

u4206181.drv

After you apply this minipack...

Post-install Steps

Once you have successfully applied Oracle XML Publisher Release 5.5, you must complete these additional steps. If you completed a task during a previous 11i patch application, then you do not need to complete the step again, unless otherwise specified.

Step 1 Review the Latest 11i Applications Recommended Patch List

Refer to the latest 11i Applications Recommended Patch List to see if you should apply any additional Oracle XML Publisher patches on top of Oracle XML Publisher Release 5.5. To access the 11i Application Recommended Patch List:

1. Log on to OracleMetaLink.
2. On the OracleMetaLink page, click Patches.
3. Click the E-Business Suite Recommended Patch List link.
4. Specify your query criteria to retrieve application recommended patches for your instance.

Step 2 Run XML Publisher Template Re-Generator concurrent program. (Required for Upgrades Only) (System Administrator)

If you are upgrading from an earlier version of XML Publisher, you must run the XML Publisher Template Re-Generator concurrent program. Use Standard Request Submission to submit this request from the XML Publisher Administrator responsibility. The request will prompt you for the following parameter:

Regeneration Criteria

Select "Outdated" to regenerate only outdated templates.

Select "All" to regenerate all templates.

Step 3 Generate Message Files (Required) (Database Administrator)

Generate message files using the AD Administration utility (adadmin). Within adadmin, choose the Generate Applications Files menu option and choose the Generate message files task. For more information, refer to "Generating Applications Files" in Oracle Applications Maintenance Utilities, Release 11i.

Step 4 Copy Fonts (System Administrator)

This patch installs a set of variable width fonts. Please copy the files from $FND_TOP/resource to the /lib/fonts directory (under OA_JRE_TOP and JRE_TOP) on all Web and concurrent nodes . The font files are:

ALBANYWT.ttf - "single-byte" characters only

ALBANWTJ.ttf - Unicode font with Japanese Han Ideographs

ALBANWTK.ttf - Unicode font with Korean Han Ideographs

ALBANWTS.ttf - Unicode font with Simplified Chinese Han Ideographs

ALBANWTT.ttf - Unicode font with Traditional Chinese Han Ideographs

Please refer to the OracleMetaLink document 240862.1, Install Oracle Unicode Fonts for Dynamic Image Generation in Oracle Applications, for more details.

Step 5 Apply Online Help Patch (System Administrator)

Oracle strongly recommends the installation of documentation patch 4515143. This patch contains important implementation information for new features, end user documentation for new features, and updates to documentation for previously released features.  Applying this documentation patch does not affect any setup or transaction processing. The patch contains only revised text and illustrations that appear when a user reads online help, and does not contain any revised executable files or seed data changes.  This patch may be applied while users are on the system.

Step 6 Assign the XML Publisher Administration responsibility to users. (System Administrator)

Assign the XML Publisher Administration responsibility (key = XDO_ADMINISTRATION) to users who will require access to the Template Manager. For instructions on assigning a responsibility to a user, see the Oracle Applications System Administrator's Guide.

Step 7 Assign the XML Report Publisher concurrent program to a request group. (System Administrator)(Conditionally Required)

If you have not applied either Oracle E-Business Suite 11.5.10 Cumulative Update 1 or Application Object Library patch 3435480, which integrates XML Publisher with the Concurrent Manager, you must perform this step.

The XML Report Publisher concurrent program (XDOREPPB) produces the PDF output from the report template and the data source. Assign this request to a request group for users who will be running requests generated by XML Publisher.

From the System Administrator responsibility, navigate to the Request Groups window.
Menu path: Security > Responsibility > Request

Query the request group to which you want to add the program.

Add the "XML Report Publisher" program (shortname XDOREPPB), to the request group.

To see which request group is associated to a responsibility, query the responsibility in the Responsibilities window (menu path:
Security > Responsibility > Define). The Request Group region identifies the report group assigned to the responsibility.

For more information on Request Groups, see the Oracle Applications System Administrator's Guide.

Step 8 Enable PDF Printing in Oracle Applications. (System Administrator)

The "PDF Publisher" print style and PASTA_PDF printer driver provide the capability to print PDF files using a 3rd party utility. You can use this style and driver to print a generated PDF. "--Pasta Universal Printer" type has been associated with the style and driver for ease of use. Please refer to the Readme file of patch 2847981 - PASTA 3.0.2.1 for detailed configuration steps.

Step 9 Set up the XML Publisher Configuration file. (System Administrator)

You must set up a configuration file to specify a temporary diectory. A configuration file is not provided with XML Publisher. Follow the sample below to set it up in your system. You must name this file xdo.cfg and place it under <JRE_TOP>/jre/lib.

Note: <JRE_TOP> refers to AF_JRE_TOP for the concurrent node or OA_JRE_TOP for the Web node.

The configuration file is primarily used for:

• Setting a temporary directory
• Setting general properties for PDF files generated by XML Publisher
• Setting security properties for PDF files generated by XML Publisher
• Setting font locations and substitutions
  

For more information and a complete list of properties available, see "XML Publisher Configuration File" in the Oracle XML Publisher User's Guide.

A sample configuration file follows:

<?xml version = '1.0' encoding = 'UTF-8'?>
<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">

<!-- XML Publisher configuration file. -->
<!-- Please uncomment an element or property to enable options -->
<!-- Copy the file to <JRE_TOP>/jre/lib directory on all nodes -->
<!-- (web node and concurrent nodes) named as xdo.cfg -->

<!-- Properties -->
<properties>
<!-- Temporary directory -->
<!-- Specify temporary directory. $APPLTMP directory -->
<!-- is strongly recommended for this parameter. -->
<!-- On concurrent node, $APPLTMP will be used by -->
<!-- default. -->

<!-- #remove this line to uncomment
<property name="system-temp-dir">/disk1/oracle/app/ERPcomn/temp</property>
#remove this line to uncomment -->

</properties >

<fonts>

<!-- Font setting (for FO to PDF etc...) -->
<!-- <family> is case insensitive. -->
<!-- <style> must be "italic" or "normal" -->
<!-- <weight> must be "bold" or "normal" -->
<!-- Follow the structure of <trutype path="...." /> -->
<!-- to map a font to a TrueType font. -->

<!-- Example of mapping "MS Gothic" to -->
<!-- kochi-gothic-subst.ttf -->

<!-- #remove this line to uncomment
<font family="MS Gothic" style="normal" weight="normal" >
<truetype path="/usr/lib/X11R6/lib/X11/fonts/truetype/kochi-gothic-subst.ttf" />
</font>
#remove this line to uncomment -->

<!-- Example of mapping "MS Mincho" to -->
<!-- kochi-mincho-subst.ttf -->
<!-- #remove this line to uncomment
<font family="MS Mincho" style="normal" weight="normal" >
<truetype path="/usr/lib/X11R6/lib/X11/fonts/truetype/kochi-mincho-subst.ttf" />
</font>
#remove this line to uncomment -->

<!-- Default font is ALBANWTJ.ttf. You can change the -->
<!-- font by mapping "Default" font family to another -->
<!-- font.

<!-- #remove this line to uncomment
<font family="Default" style="normal" weight="normal" >
<truetype path="/usr/lib/X11R6/lib/X11/fonts/truetype/Gulimche.ttf" />
</font>
#remove this line to uncomment -->

</fonts>

</config>

6. Implementation and User Documentation

The corresponding documentation patch for Oracle XML Publisher Release 5.5 is patch number 4515143. This documentation patch should be applied as a post install step. (See Section  5. Instructions for Applying Oracle XML Publisher Release 5.5). The Oracle XML Publisher User's Guide is available as a PDF attachment to this document. The Java reference documents (javadocs) that accompany the API chapter are available in the following zip files:

XML Publisher Release 5.5 Core API Javadocs

XML Publisher Release 5.5 OA API Javadocs

Note that the Oracle Applications Online Documentation CD is available on OracleMetaLink.  It contains the most current Documentation Library plus all documents revised or released since the creation of the 11.5.10 Documentation Library CD. The Virtual Documentation CD is updated periodically.

7. Software Updates

RTF Processor Engine

Concurrent Manager Integration

8. About Document Change Record

Date	Description of Change
July 29, 2005	Published document.

Oracle Corporation

Copyright Notice
Copyright © 1994-2005, Oracle. All rights reserved.

Trademark Notice
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.