Using Oracle XML Publisher

Student Guide

Course Code NONE

Edition 1.0
Month Year SEP 2005
Part Number OOW2005
Copyright © Oracle Corporation, 2005. All rights reserved.

This documentation contains proprietary information of Oracle Corporation. It is provided under a license agreement containing
restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. If this
documentation is delivered to a U.S. Government Agency of the Department of Defense, then it is delivered with Restricted Rights
and the following legend is applicable:

Restricted Rights Legend

Use, duplication or disclosure by the Government is subject to restrictions for commercial computer software and shall be deemed
to be Restricted Rights software under Federal law, as set forth in subparagraph (c)(1)(ii) of DFARS 252.227-7013, Rights in
Technical Data and Computer Software (October 1988).

This material or any portion of it may not be copied in any form or by any means without the express prior written permission of the
Education Products group of Oracle Corporation. Any other copying is a violation of copyright law and may result in civil and/or
criminal penalties.

If this documentation is delivered to a U.S. Government Agency not within the Department of Defense, then it is delivered with
“Restricted Rights,” as defined in FAR 52.227-14, Rights in Data-General, including Alternate III (June 1987).

The information in this document is subject to change without notice. If you find any problems in the documentation, please report
them in writing to Worldwide Education Services, Oracle Corporation, 500 Oracle Parkway, Box SB-6, Redwood Shores, CA 94065.
Oracle Corporation does not warrant that this document is error-free.

Oracle and all references to Oracle Products are trademarks or registered trademarks of Oracle Corporation.

All other products or company names are used for identification purposes only, and may be trademarks of their respective owners.

Author: Bill Sawyer, Leslie Studdard, Tim Dexter

Technical Contributors and Reviewers: Klaus Fabian

This book was published using: oracletutor

 Table of Contents

Introduction .....................................................................................................................................................1-1
Using Oracle XML Publisher ........................................................................................................................1-2
Objectives ......................................................................................................................................................1-3
Example – Financial Reports.........................................................................................................................1-5
Example – Business Reports .........................................................................................................................1-6
Example – Invoices .......................................................................................................................................1-7
Example – Purchase Orders...........................................................................................................................1-8
Example – Sales Orders.................................................................................................................................1-9
Example – Contracts......................................................................................................................................1-10
Example – Government Forms ......................................................................................................................1-11
Example – Tax Forms....................................................................................................................................1-12
Example – Marketing Materials ....................................................................................................................1-13
Example - XML.............................................................................................................................................1-14
Example – EDI/EFT ......................................................................................................................................1-15
Why XML Publisher 5.5?..............................................................................................................................1-16
Document Management Requirements..........................................................................................................1-17
Oracle XML Publisher 5.5.............................................................................................................................1-18
Classic Reporting Tool Issues .......................................................................................................................1-19
XML Publisher Advantages ..........................................................................................................................1-24
Products Utilizing XML Publisher ................................................................................................................1-32
XML Publisher Technology ..........................................................................................................................1-33
Performance and Scalability ..........................................................................................................................1-35
Security..........................................................................................................................................................1-36
Language Support..........................................................................................................................................1-37
Translation.....................................................................................................................................................1-39
Summary........................................................................................................................................................1-40
Introduction to RTF Templates .....................................................................................................................2-1
Using Oracle XML Publisher ........................................................................................................................2-2
Objectives ......................................................................................................................................................2-3
What is Template Builder? ............................................................................................................................2-4
Install and Open Word...................................................................................................................................2-5
Starting the Walk-through .............................................................................................................................2-6
Basic Template ..............................................................................................................................................2-7
Load the Sample XML Data..........................................................................................................................2-8
Load Complete ..............................................................................................................................................2-10
Set the Address ..............................................................................................................................................2-11
Choose the Address Fields ............................................................................................................................2-12
Set the Other Simple Fields ...........................................................................................................................2-13
Preview Your Progress ..................................................................................................................................2-14
Insert a Table .................................................................................................................................................2-15
Setting Instruction Preferences ......................................................................................................................2-16
Creating the Table .........................................................................................................................................2-18
The End Result ..............................................................................................................................................2-24
Changing Field Properties .............................................................................................................................2-26
Preview Your Progress ..................................................................................................................................2-27
Create a Chart ................................................................................................................................................2-28
The Placeholder .............................................................................................................................................2-31
Preview Your Progress ..................................................................................................................................2-32
Student Lab....................................................................................................................................................2-33
Summary........................................................................................................................................................2-34
The Development Process ...............................................................................................................................3-1

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

i
 Using Oracle XML Publisher ........................................................................................................................3-2
Objectives ......................................................................................................................................................3-3
User Interfaces...............................................................................................................................................3-4
Process Overview ..........................................................................................................................................3-5
Identifying a Report.......................................................................................................................................3-6
Run the Report...............................................................................................................................................3-7
View the Finished Report ..............................................................................................................................3-8
View the Report Log File ..............................................................................................................................3-9
View the Concurrent Program Definition......................................................................................................3-10
The Concurrent Program Definition ..............................................................................................................3-11
Copy the Concurrent Definition ....................................................................................................................3-12
View the New Definition...............................................................................................................................3-13
Modify the Definition to Produce XML ........................................................................................................3-14
Update the Concurrent Program ....................................................................................................................3-15
Check the Responsibility ...............................................................................................................................3-16
Query the Request Group ..............................................................................................................................3-17
Add the New Report ......................................................................................................................................3-18
Submit the New Request ...............................................................................................................................3-19
View the New Request ..................................................................................................................................3-20
View the Request Output...............................................................................................................................3-21
Create an RTF Template................................................................................................................................3-22
Load the XML Sample Data..........................................................................................................................3-23
Complete the Sample Data Load ...................................................................................................................3-24
Finish the Template .......................................................................................................................................3-25
Begin Data Definition Registration ...............................................................................................................3-26
Register the Data Definition ..........................................................................................................................3-27
Apply the Data Definition Registration .........................................................................................................3-28
Begin the Template Registration ...................................................................................................................3-29
Register the Template ....................................................................................................................................3-30
Complete the Template Registration .............................................................................................................3-31
Submit the XML Publisher Request ..............................................................................................................3-32
View the Results............................................................................................................................................3-33
Summary........................................................................................................................................................3-34
Overview of the Standards..............................................................................................................................4-1
Using Oracle XML Publisher ........................................................................................................................4-2
Objectives ......................................................................................................................................................4-3
Extensible Markup Language ........................................................................................................................4-4
XML Standards .............................................................................................................................................4-7
Example: A Simple XML Page .....................................................................................................................4-9
XML Document Structure .............................................................................................................................4-10
A Well-Formed XML Document ..................................................................................................................4-11
Comparing XML and HTML ........................................................................................................................4-13
What Is XSL? ................................................................................................................................................4-14
XSL Transformations ....................................................................................................................................4-16
What Is XML Path Language? ......................................................................................................................4-18
XSLT and XPath ...........................................................................................................................................4-20
Output Formats ..............................................................................................................................................4-22
Summary........................................................................................................................................................4-24
Installing Template Builder ............................................................................................................................5-1
Using Oracle XML Publisher ........................................................................................................................5-2
Objectives ......................................................................................................................................................5-3
Get the Template Builder ..............................................................................................................................5-4
Install Template Builder ................................................................................................................................5-5
Download and Unzip the Patch .....................................................................................................................5-6
Run the Installer.............................................................................................................................................5-7
Choose Setup Language ................................................................................................................................5-8

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

ii
 Welcome Screen ............................................................................................................................................5-9
Designate JRE Location ................................................................................................................................5-10
Template Builder for Word Tutorial Option..................................................................................................5-11
Designation Destination Location .................................................................................................................5-12
Ready to Install..............................................................................................................................................5-13
Installing ........................................................................................................................................................5-14
Installation Finished ......................................................................................................................................5-15
Summary........................................................................................................................................................5-16
Installing XML Publisher Server-side ...........................................................................................................6-1
Using Oracle XML Publisher ........................................................................................................................6-2
Objectives ......................................................................................................................................................6-3
Get the Latest MetaLink Note .......................................................................................................................6-4
Always Read and Follow the Instructions .....................................................................................................6-5
Pre-Installation Steps.....................................................................................................................................6-6
Download, Unzip, and Apply the Patch ........................................................................................................6-8
Post-Installation Steps ...................................................................................................................................6-9
Summary........................................................................................................................................................6-13

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

iii
Preface
Profile
Before You Begin This Course

Before you begin this course, you should have the following qualifications:

• Working experience with Oracle Applications 11i

Prerequisites

• There are no prerequisites for this course.

How This Course Is Organized

Using Oracle XML Publisher is an instructor-led course featuring lecture and hands-on
exercises. Online demonstrations and written practice sessions reinforce the concepts and skills
introduced. It is only being taught and offered at Oracle Open World 2005.

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

v
Related Publications
Oracle Publications
Title Part Number
Oracle XML Publisher User’s Guide B13817-03

Additional Publications

• System release bulletins

• Installation and user’s guides

• Read-me files

• International Oracle User’s Group (IOUG) articles

• Oracle Magazine

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

vi
Typographic Conventions
Typographic Conventions in Text
Convention Element Example
Bold italic Glossary term (if The algorithm inserts the new key.
there is a glossary)
Caps and Buttons, Click the Executable button.
lowercase check boxes, Select the Can’t Delete Card check box.
triggers, Assign a When-Validate-Item trigger to the ORD block.
windows Open the Master Schedule window.
Courier new, Code output, Code output: debug.set (‘I”, 300);
case sensitive directory names, Directory: bin (DOS), $FMHOME (UNIX)
(default is filenames, Filename: Locate the init.ora file.
lowercase) passwords, Password: User tiger as your password.
pathnames, Pathname: Open c:\my_docs\projects
URLs, URL: Go to http://www.oracle.com
user input,
User input: Enter 300
usernames
Username: Log on as scott
Initial cap Graphics labels Customer address (but Oracle Payables)
(unless the term is a
proper noun)
Italic Emphasized words Do not save changes to the database.
and phrases, For further information, see Oracle7 Server SQL Language
titles of books and Reference Manual.
courses, Enter [email protected], where user_id is the
variables name of the user.
Quotation Interface elements Select “Include a reusable module component” and click Finish.
marks with long names
that have only This subject is covered in Unit II, Lesson 3, “Working with
initial caps; Objects.”
lesson and chapter
titles in cross-
references
Uppercase SQL column Use the SELECT command to view information stored in the
names, commands, LAST_NAME
functions, schemas, column of the EMP table.
table names
Arrow Menu paths Select File > Save.
Brackets Key names Press [Enter].
Commas Key sequences Press and release keys one at a time:
[Alternate], [F], [D]
Plus signs Key combinations Press and hold these keys simultaneously: [Ctrl]+[Alt]+[Del]

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

vii
Typographic Conventions in Code
Convention Element Example
Caps and Oracle Forms When-Validate-Item
lowercase triggers
Lowercase Column names, SELECT last_name
table names FROM s_emp;

Passwords DROP USER scott

IDENTIFIED BY tiger;
PL/SQL objects OG_ACTIVATE_LAYER
(OG_GET_LAYER (‘prod_pie_layer’))

Lowercase Syntax variables CREATE ROLE role

italic
Uppercase SQL commands and SELECT userid
functions FROM emp;

Typographic Conventions in Oracle Application Navigation Paths

This course uses simplified navigation paths, such as the following example, to direct you
through Oracle Applications.

(N) Invoice > Entry > Invoice Batches Summary (M) Query > Find (B) Approve

This simplified path translates to the following:

1. (N) From the Navigator window, select Invoice then Entry then Invoice Batches
Summary.

2. (M) From the menu, select Query then Find.

3. (B) Click the Approve button.

Notations:

(N) = Navigator

(M) = Menu

(T) = Tab

(B) = Button

(I) = Icon

(H) = Hyperlink

(ST) = Sub Tab

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

viii
Typographical Conventions in Oracle Application Help System Paths
This course uses a “navigation path” convention to represent actions you perform to find
pertinent information in the Oracle Applications Help System.

The following help navigation path, for example—

(Help) General Ledger > Journals > Enter Journals

—represents the following sequence of actions:

1. In the navigation frame of the help system window, expand the General Ledger entry.

2. Under the General Ledger entry, expand Journals.

3. Under Journals, select Enter Journals.

4. Review the Enter Journals topic that appears in the document frame of the help system
window.

Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

ix
 Copyright © Oracle, 2005. All rights reserved.

Using Oracle XML Publisher Table of Contents

x
 Introduction
Chapter 1

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 1
Using Oracle XML Publisher

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 2
Objectives

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 3
Objectives

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 4
Example – Financial Reports

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 5
Example – Business Reports

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 6
Example – Invoices

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 7
Example – Purchase Orders

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 8
Example – Sales Orders

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 9
Example – Contracts

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 10
Example – Government Forms

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 11
Example – Tax Forms

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 12
Example – Marketing Materials

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 13
Example - XML

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 14
Example – EDI/EFT

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 15
Why XML Publisher 5.5?

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 16
Document Management Requirements

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 17
Oracle XML Publisher 5.5

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 18
Classic Reporting Tool Issues

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 19
Classic Reporting Tool Issues

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 20
Classic Reporting Tool Issues

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 21
Classic Reporting Tool Issues

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 22
Classic Reporting Tool Issues

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 23
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 24
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 25
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 26
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 27
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 28
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 29
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 30
XML Publisher Advantages

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 31
Products Utilizing XML Publisher

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 32
XML Publisher Technology

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 33
XML Publisher Technology

Users can design layout templates using familiar desktop applications such as
Adobe Acrobat and MS Word, there are now many XSL editors available on the
market for the user to take advantage of.

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 34
Performance and Scalability

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 35
Security

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 36
Language Support

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 37
Language Support

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 38
Translation

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 39
Summary

Copyright © Oracle, 2005. All rights reserved.

Introduction
Chapter 1 - Page 40
 Introduction to RTF
Templates
Chapter 2

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 1
Using Oracle XML Publisher

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 2
Objectives

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 3
What is Template Builder?

All of these steps, and many others, can be performed manually. Template
Builder simplifies the common tasks associated with creating an XML Publisher
RTF template.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 4
Install and Open Word

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 5
Starting the Walk-through

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 6
Basic Template

Nothing about this template is unique to XML Publisher. We could just have
easily started from a blank document. We just saved some typing.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 7
Load the Sample XML Data

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 8
Load the Sample XML Data

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 9
Load Complete

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 10
Set the Address

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 11
Choose the Address Fields

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 12
Set the Other Simple Fields

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 13
Preview Your Progress

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 14
Insert a Table

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 15
Setting Instruction Preferences

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 16
Setting Instruction Preferences

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 17
Creating the Table

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 18
Creating the Table

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 19
Creating the Table

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 20
Creating the Table

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 21
Creating the Table

You should now click again on the G Invoices element in the center view. The
Properties region on the right shows how the data fields will be formatted. You
should see the following information:
For each group you can set the following properties that describe how a group (such as
G Invoices) should be rendered by the template builder:
• Style: Select Table to create a table around the data fields.
• Grouping: Grouping is an advanced operation that allows you to re-group the data – for
example by transaction date instead of currency. You can select the element that the data
should be grouped by for this property. Please refer to the Oracle XML Publisher User’s
Guide for additional information on grouping.
• Show Grouping Value: This property will only be shown if you have selected a node
created by the Grouping functionality. You can choose for a group if the Data Field node
used as a grouping criterion is shown in the table or form.
• Sort By: You can select an element by which the data groups are sorted.
• Sort Order: If you have selected an element for Sort By you can select, if the data should
be sorted either ascending or descending.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 22
 • Sort Data Type: If you have selected an element for Sort By the data is by default sorted
as Text. That means that 12 will be shown after 111. If you need to sort numbers you
should select Number as the sort data type
• Break: This property allows you to insert a page break or a section break between every
data group. If nothing is select, then the data groups will be shown continuously with no
break. If you select New Page per Element, then a page break will be inserted between
each element. If you select New Section per Element, a section break will be created for
each data group. A section break allows changing the header/footer and resets the page
number. You will typically use this option, if you want to print multiple documents (for
example invoices or purchase orders) to a single PDF file.
• The order in which the data elements are shown reflects the order of the columns in the
table. If you want to reorder the columns you need to change the Insert Position box from
Child to Same Level. Then drag the elements into the correct order.
Click the OK button to create the table. The inserted table should look like this:

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 23
The End Result

The Template Builder creates two kinds of form fields:

• Form fields representing data elements
• Form fields with processing instructions for repeating table rows or document section

Form fields representing data elements are replaced with the data when the template is
processed. The for-each G_INVOICES and end G_INVOICES form fields indicate a repeating
section. The section of the document encapsulated by these two form fields is repeated, if the
associated data element G_INVOICE is found repetitively in the data. Please refer to the
Oracle XML Publisher User’s Guide for additional information on form fields.

You can now format these elements in Microsoft Word and add additional text. You can also
move fields around as long as you keep them in the surrounding for-each G_INVOICES and
end G_INVOICES processing instruction. If you remove one of these processing instructions
your template may not work anymore with XML Publisher.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 24
 You now can preview the template again to review your current template (see above). You
probably would like to change the alignment of the table columns or change the data type and
format for the amounts. For example, select the TRANS_AMOUNT field, right-click and
select Properties to see the Text Form Field Options dialog.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 25
Changing Field Properties

You may select the Number in the Type field, #,##0.00 for Number format and enter 1000 as
the Default Number to achieve a more desirable format for currencies in US Dollar. We
recommend not to use currency signs such as $ in the format string, since it may lead to
difficulties in supporting multiple languages with a single template.
Formatting options defined in this dialog box are understood by Oracle XML Publisher and
used to format your fields. Try to modify the template to get an idea which Word functions are
supported by XML Publisher 5.5.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 26
Preview Your Progress

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 27
Create a Chart

The data used for creating the open balance letter is not well suited to create a chart. Close the
previous Word document and open a new Word document. Then load the RetailSales.xml file
in the samples\sales Report folder by selecting Load XML Data from the Data menu.
This data contains retail sales data for different industries. We will create a chart that shows the
sales per industry. XML Publisher does not support native Microsoft Word Charts. You need
to create charts using the Template Builder.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 28
Create a Chart

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 29
Create a Chart

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 30
The Placeholder

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 31
Preview Your Progress

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 32
Student Lab

The data used for creating the open balance letter is not well suited to create a chart. Close the
previous Word document and open a new Word document. Then load the RetailSales.xml file
in the samples\sales Report folder by selecting Load XML Data from the Data menu.
This data contains retail sales data for different industries. We will create a chart that shows the
sales per industry. XML Publisher does not support native Microsoft Word Charts. You need
to create charts using the Template Builder.

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 33
Summary

Copyright © Oracle, 2005. All rights reserved.

Introduction to RTF Templates

Chapter 2 - Page 34
 The Development Process
Chapter 3

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 1
Using Oracle XML Publisher

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 2
Objectives

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 3
User Interfaces

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 4
Process Overview

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 5
Identifying a Report

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 6
Run the Report

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 7
View the Finished Report

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 8
View the Report Log File

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 9
View the Concurrent Program Definition

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 10
The Concurrent Program Definition

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 11
Copy the Concurrent Definition

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 12
View the New Definition

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 13
Modify the Definition to Produce XML

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 14
Update the Concurrent Program

This step must be done from the System Administration responsibility not the System
Administrator (i.e., forms-based) responsibility.

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 15
Check the Responsibility

Check the responsibility to see what REQUEST GROUP it is using. In this case, the System
Administrator responsibility is using the System Administrator Reports Request Group.

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 16
Query the Request Group

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 17
Add the New Report

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 18
Submit the New Request

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 19
View the New Request

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 20
View the Request Output

While you have the output in your browser window, SAVE a copy of the file to your machine.
For sake of simplicity, we will name the file, FNDSCURX.xml.
NOTE: The original file is quite large as it has numerous entries. We will want to significantly
reduce this file. So, using the Text Editor of your choice, open the FNDSCURX.xml file on
your machine. Notice that each User record is surrounded by the XML tag <BREAK> …
</BREAK>. So, do this, delete all the data from the file EXCEPT the complete entry for the
SYSADMIN user. Once you have done that, remember to also delete the user records after
SYSADMIN. Also, remember not to delete all the way to the end of the file, there are XML
tags that need to be preserved at the end of the file.
Specifically, the tags you need to preserve are:
</LIST_BREAK>
<AF_SRWINIT></AF_SRWINIT>
<AF_SRWINIT1></AF_SRWINIT1>
</OSAF_FIRST_QUERY>
</LIST_OSAF_FIRST_QUERY>
</FNDSCURS>

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 21
Create an RTF Template

Do the following steps:

1. Go to the XML Publisher directory where you keep your samples
• For example: C:\Program Files\Oracle\XML Publisher Desktop\samples\RTF
templates.
2) Create a directory in your RTF templates directory, call it User Listing.
3) Move the FNDSCURX.xml file that you edited to your new User Listing directory.
4) Move a copy of Balance Letter Start.rtf into your User Listing directory.
5) Rename Balance Letter Start.rtf to User Listing Start.rtf.
6) Open and edit User Listing Start.rtf until it appears as shown above.
7) Load the FNDSCURX.xml data.
8) Add the Username field into the template.
9) Create a table of the Responsibility information.

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 22
Load the XML Sample Data

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 23
Complete the Sample Data Load

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 24
Finish the Template

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 25
Begin Data Definition Registration

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 26
Register the Data Definition

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 27
Apply the Data Definition Registration

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 28
Begin the Template Registration

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 29
Register the Template

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 30
Complete the Template Registration

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 31
Submit the XML Publisher Request

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 32
View the Results

NOTE: Our report does not quite look the way that we expect. It is close, but not complete
there. The problem is that it has merged all the Users into 1 big responsibility listing.
Obviously not what we want. In the next module, we’ll look at how to fix this problem.

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 33
Summary

Copyright © Oracle, 2005. All rights reserved.

The Development Process

Chapter 3 - Page 34
 Overview of the Standards
Chapter 4

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 1
Using Oracle XML Publisher

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 2
Objectives

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 3
Extensible Markup Language

Extensible Markup Language

XML is the abbreviation for Extensible Markup Language. XML documents look similar to
Hypertext Markup Language (HTML) documents, although they are very different.
HTML is a markup language, primarily used for formatting and displaying text and images in a
browser.
XML is a markup language for structuring data rather than formatting information.
You use XML to create a document that contains structured data that can be used or interpreted
by other applications. The format or structure is straightforward and can be used by any person
or program that can read text.
Unlike HTML, the tags in XML are extensible, and so you can create your own tags as you
need them. HTML has a set of predefined formatting tags that you can use, but you cannot
create your own.
XML is part of the World Wide Web Consortium (W3C) standards.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 4
Extensible Markup Language

Extensible Markup Language

XML describes data objects called XML documents that:
• Are composed of markup language for structuring the document data
• Support custom tags for data definition, transmission, validation, and interpretation
• Have become a standard way to describe data on the Web
• Are processed by XML processors
XML was developed by an XML working group headed by the World Wide Web Consortium
(W3C) with the following design goals:
• XML is usable over the Internet.
• It supports a wide variety of applications.
• It is compatible with Standard Generalized Markup Language (SGML).
• XML can be processed using easy-to-write programs.
• It has a minimum number of optional features.
• XML is human-legible and reasonably clear.
• XML enables quick design preparation.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 5
 • It enables formal and concise design.
• The XML documents are easy to create.
• The XML documents can be verbose.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 6
XML Standards

XML Standards
The following XML standards are covered in this course:
1. The XML language specification defines the rules that govern XML document
structure, and how XML processors must read them.
2. A document type definition (DTD) provides the definition and relationships of elements
contained in an XML document. A DTD validates an XML document.
3. XML Namespaces provide a mechanism to distinguish elements with the same name but
different definitions used in the same XML document.
4. The XML Path Language (XPath) provides syntax for searching an XML Document.
XPath expressions are used in an XSL stylesheet to match specific nodes.
5. An XML Schema provides a way to describe the XML document structure using data
type definitions and uses namespace support. XML Schema is the preferred way to
validate XML documents.
6. The Extensible Style Sheet Language (XSL) is implemented by XSL Transformations
(XSLT) to specify how to transform an XML document into another document. XSLT
uses an XML vocabulary for transforming or formatting XML documents.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 7
 The next two pages briefly discusses XML Programming Models or APIs, such as the
Document Object Model (DOM) and Simple API for XML (SAX), which are used by XML
processors for processing XML documents.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 8
Example: A Simple XML Page

Example: A Simple XML Page

The example of a simple XML document uses nested elements to describe the employee data.
Elements are identified by tag names, such as employee, employee_id, and last_name.
Tag names are distinguishable as markup, rather than data, because they are surrounded by
angle brackets (< and >).
Note: In XML, an element includes the start tag (<employees>), end tag
(</employees>), and all the markup and character data contained between the tags.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 9
XML Document Structure

XML Document Structure

An XML document contains the following parts:
• The prologue, which may contain the following information:
- XML declaration (optional in XML 1.0, mandatory in XML 1.1)
- Document type definition (DTD), which is required only to validate the document
structure
- Processing instructions and comments, which are optional
• The root element, which is also called the “document element”
• An epilogue, which contains processing instructions and comments
An XML document can also contain processing instructions, giving commands or information
to an application that is processing the XML data.
Processing instructions have the format <?target instructions?>, where the target is the
name of the application that is expected to do the processing, and the instructions consist of a
string of characters that embodies the information or commands for the application to process.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 10
A Well-Formed XML Document

A Well-Formed XML Document

All XML documents must be well-formed to guarantee that it is correctly structured and
adheres to the rules defined in the slide. The slide contains a list of the most common rules to
be addressed for well-formed documents; but it is not a complete list.
Note: The less than (<) and ampersand (&) characters are special in XML and cannot appear as
themselves within the character data part of an element, or the value of an attribute. In
character data and attribute values, an XML Parser recognizes:
• The less than (<) sign as a character that introduces the start tag of another element
• The ampersand (&) as an escape character before an entity name terminated by a
semicolon (;)
Therefore, to include special characters in the character data of an element, or attribute value,
you must use built-in XML entity names for the special characters. For example, use &lt; to
include the less than character, and &amp; for the ampersand character. The XML Parser
replaces the entity reference with its textual or binary representation, as discussed earlier in this
lesson.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 11
 Note: The XML 1.1 specification requires the XML declaration to appear at the beginning of
the document. However, the declaration is optional when using XML 1.0.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 12
Comparing XML and HTML

Comparing XML and HTML

The key difference between XML and HTML is that:
• XML is a markup language for describing data
• HTML is a markup language for formatting data
The slide covers other important differences between XML and HTML.
A Word About XHMTL
The World Wide Web Consortium (W3C) has worked on defining the Extensible HyperText
Markup Language (XHTML) as a successor to HTML.
XHTML is designed to conform with XML standards and well-formed document rules, and
provide a way to reproduce, subset, and extend HTML documents. An XHTML document is a
particular XML document instance intended for processing by a Web browser.
Note: Not all browsers support XHTML document, and different browsers often process
XHTML documents in different ways.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 13
What Is XSL?

What Is XSL?
XML documents have structure and, unlike HTML, do not provide formatting or display
instructions. Extensible Stylesheet Language (XSL) adds the capability of transforming an
XML document into another document containing XML with a different structure, or an
HTML document with formatting tags.
XSL has the following two parts:
• XSL Transformations (XSLT) is an XML application that processes rules contained in an
XSLT stylesheet. The rules in an XSLT stylesheet can be applied to any XML document.
• The XSL Formatting Objects (XSL-FO) is an XML application used for describing the
precise layout of text on a page. XSLT is used to generate XSL-FO elements that are
output to another XML document. Additional processing is needed to create the final
output form such as a portable document format (PDF) document.
This lesson focuses on XSLT.
The graphic in the slide depicts an XML document and an XSLT stylesheet document being
processed by an XSL processor. The XSL processor is an XML application that applies the
transformation rules to the XML document as specified in the XSL document and produces a
new document as the result.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 14
XSL-FO:
A XSL-FO document consists of document styles and document data like HTML. Unlike
HTML, XSL-FO can describe rich document styles such as page size, margins, page
header/footer, complicated document styles and others to compose high fidelity documents for
printing. It solves all the HTML printing problems.
In general, an XSL-FO document is generated by transforming XML data with an XSL
stylesheet that transforms the XML data to XSL-FO. XSL-FO processing engines are
becoming more popular and widely available.
For more information, use the following resources:
• W3C XSL-FO Specification: http://www.w3.org/TR/xsl/
• What is XSL-FO?: http://www.xml.com/pub/a/2002/03/20/xsl-fo.html
• Printing from XML: An Introduction to XSL-FO:
http://www.xml.com/pub/a/2002/10/09/xslfo.html

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 15
XSL Transformations

XSL Transformations
XSL Transformations (XSLT) is an XML application, or XSL Processor, that processes rules
specifying how to transform one XML document into another XML document. The rules are
contained in an XSLT document called an XSLT stylesheet, which itself is an XML document
and must be well-formed.
The slide shows that an XSLT stylesheet contains one or more template rules; each template
rule has two parts:
• A match pattern, specified as an XPath expression in an attribute of an
<xsl:template> element
• Template data, appearing between the start and end tags of the <xsl:template>
element, that contains the output information. The template data typically contains
XML/HTML elements mixed with the XSLT rules.
The XSL processor compares the elements in the input XML document with the template rule
pattern in the XSLT stylesheet, and writes the template data for matching rules to the output
tree, typically, another XML document. Essentially, the transformation process operates on the
tree data structure of a source (input) XML document and produces a tree of nodes as its
output.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 16
 Note: XSL-FO elements are output elements found inside the <xsl:template> rules.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 17
What Is XML Path Language?

What Is XPath?
XML Path Language (XPath) is primarily used for addressing parts (nodes) of an XML
document. XPath models an XML document as a tree of nodes, and expresses a navigation
path through the hierarchical structure of an XML document. XPath:
• Is named after the path notation it uses for navigating through the structure of an XML
document
• Uses a compact, non-XML syntax to form expressions that are used within URI and
XML attribute values
• Facilitates the manipulation of string, number, and Boolean values
• Operates on the abstract, logical structure of an XML document called the document data
model, rather than its surface syntax
In addition to its use for addressing parts of an XML document, XPath fully supports XML
Namespaces and provides a natural expression language subset for pattern matching, which is
extensively used in the W3C XSLT Recommendation, and XPointer.
Note: XSLT is XML Stylesheet Language Transformation, the language used to transform an
XML document into another XML document. XPointer is the XML Pointer Language, used as

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 18
 a fragment identifier for any URI reference that locates a resource with a MIME type of
text/xml or application/xml.

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 19
XSLT and XPath

XSLT and XPath

An XML Stylesheet Language (XSL) document is an XML document with elements that
define transformation rules. The slide shows sample XSL document elements, such as:
• The <xsl:template> element with a match attribute containing an XPath
expression defining the set of nodes to which the template rule applies.
• The <xsl:value-of> element with the select attribute containing an XPath
expression. The <xsl:value-of> element outputs the text value of the specified
node, relative to the context node matching its template XPath expression.
The <xsl:template> element informs the XSLT Processor how to locate specific element
nodes in the input document, and provides the rules to create the output data as the contents
specified between the start and end tags of the <xsl:template> element. In the example,
you search for department_name elements, and use the current node (.) to output the
value of the department_name.
Note: The XSLT Specification states that XSLT processors must provide a default template
rule causing text nodes to be output, if no matching template rules exist. Suppress the output of
unprocessed text nodes by including, at the end of the XSLT stylesheet, a template rule
matching all text nodes that does not output data. For example, as shown in the slide, use:
Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 20
 <xsl:template match="*/text()"/>
Note: The example in the slide provides a context for where XPath expressions can be used.
XSLT is covered in detail in the lesson titled “Transforming XML by Using XSL
Transformation.”

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 21
Output Formats

RTF is a standard maintained by Microsoft. You can learn more about it at:
http://msdn.microsoft.com/library/?url=/library/en-us/dnrtfspec/html/rtfspec.asp

PDF was created by Adobe. You can learn more about it at:
http://www.adobe.com/products/acrobat/adobepdf.html

The PDF Specification is available at:

http://partners.adobe.com/public/developer/pdf/index_reference.html

PDF standards, in multiple output format (e.g. print-based PDFs vs. electronic
PDFs), are currently being submitted and accepted as standards to the ISO. You
can find more about their published standards at:
http://www.iso.org/

For information on XML, XSL, XSL-FO, and XPath, those standards are
maintained by the World Wide Web Consortium (W3C). You can find them at:
Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 22
http://www.w3c.org/

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 23
Summary

Copyright © Oracle, 2005. All rights reserved.

Overview of the Standards

Chapter 4 - Page 24
 Installing Template Builder
Chapter 5

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 1
Using Oracle XML Publisher

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 2
Objectives

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 3
Get the Template Builder

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 4
Install Template Builder

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 5
Download and Unzip the Patch

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 6
Run the Installer

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 7
Choose Setup Language

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 8
Welcome Screen

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 9
Designate JRE Location

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 10
Template Builder for Word Tutorial Option

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 11
Designation Destination Location

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 12
Ready to Install

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 13
Installing

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 14
Installation Finished

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 15
Summary

Copyright © Oracle, 2005. All rights reserved.

Installing Template Builder

Chapter 5 - Page 16
 Installing XML Publisher
Server-side
Chapter 6

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 1
Using Oracle XML Publisher

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 2
Objectives

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 3
Get the Latest MetaLink Note

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 4
Always Read and Follow the Instructions

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 5
Pre-Installation Steps

As of the writing of this course, the following patches would need to be applied
prior to applying the XML Publisher 5.5 patch:
2771817 - OA Self Service Framework V5.7H
2949264 - Concurrent Processing Rollup Patch F
3043856 - PHP Login Causes Double Decrement of
FND_USER.PASSWORD_ACCESSES_LEFT
3412795 - ADSPLICE Patch for XDO
3641831 - DBI60:RUP4:WF_EVENT_OMB_QH is invalid after applying HR_PF.D
3671463 - OA Framework Rollup Patch 5.7H - V6+
3902820 - New Consolidated Fixes - Post AOLJ Patch 3313291
3942438 - Workflow Directory Services, Version 4 (Role Hierarchy Support)
3948369 - AOL Security Rollup Patch I.1
4104924 - TXK (FND) AutoConfig Template Rollup Patch K (July 2005)

Additionally, follow any Functional Prerequisites for the patch.

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 6
 Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 7
Download, Unzip, and Apply the Patch

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 8
Post-Installation Steps

XML Publisher Re-Generator Concurrent Program:

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.

Generate Message Files:

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.

Copy Fonts:

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 9
 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.

Apply Online Help Patch:

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.

Assign XML Publisher Administrator Responsibility:

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.

Assign XML Report Publisher Concurrent Program to a Request Group:

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.

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 10
Enable PDF Printing in Oracle Applications:
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.

Set-up the XML Publisher Configuration File:

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

Note: It is strongly recommended that you set up this configuration file to create a temporary
directory for processing large files. If you do not, you will encounter "Out of Memory" errors
when processing large files. Create a temporary directory by defining the system-temp-dir
property (shown below). 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 >

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 11
 <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>

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 12
Summary

Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 13
 Copyright © Oracle, 2005. All rights reserved.

Installing XML Publisher Server-side

Chapter 6 - Page 14