Transform your Standard Reports Transform your Standard Reports GO the XML Way!GO the XML Way!

PresentersPresentersNeida E. Castaneda & Josephine L. AbelNeida E. Castaneda & Josephine L. Abel

City of West Palm BeachCity of West Palm Beach

City of West Palm BeachCity of West Palm Beach-- ProfileProfile• Established in 1894, we are a local government operating under a Strong

Mayor System

• 1,700 employees serve approximately 82,000 residents along the Atlantic Intracoastal Waterway

• Ranks #4 by Milken Index which measures cities with thriving economy

• 2005 Digital Cities Survey Winner

• The City successfully implemented/upgraded Oracle Financials/HR/Payroll - August 1999, 10.7 first time implementation- August 2002, 11.5.5 upgrade- October 2004, 11.5.9 upgrade

Visit us @ www.wpb.org

PresentersPresenters• Neida E. Castaneda - Senior Systems Analyst, OCP

- 8 years of Oracle experience- Lead HR/Payroll Technical and End user support- Oracle Apps implementation team member (10.7, 11.5.5 and 11.5.9)

• Josephine L. Abel - Database Administrator, OCP- 12 years of Oracle experience, 5 in Development, 7 in e-Business Suite- Oracle Apps implementation team member (10.7, 11.5.5 and 11.5.9)- Technical support for e-Business suite

AgendaAgenda• What is XML Publisher?

• XML Publisher – Benefits

• Report Transformation - Process Overview

• XML Publisher Template Builder

• Going the XML Way!

• Tips and Tricks

• Technical Requirements & Challenges

• XML Publisher Latest Releases

• Resources

• Q&A

What is XML Publisher?What is XML Publisher?• It is a template-based publishing solution bundled with e-Business suite

• XML is the acronym for eXtensible Markup Language

• Designed to structure, store and send information

• The collection of data continues to be handled by e-Business Suite, but users design and control report outputs using template files

XML Publisher XML Publisher -- BenefitsBenefits• Eliminate 3rd party software

• Reduce support cost

• Maximize technical resources

• Generate jazzy and feature rich reports

• Use graphs, charts, fonts, and colors

• Allow different report layouts using same data source

• Publish reports for online viewing

HR & PayrollHR & Payroll

Invoices & Dunning LettersInvoices & Dunning Letters

Financial ReportsFinancial Reports

Report TransformationReport TransformationProcess Overview

• Design Create layout form and markup elements

• IntegrateSetup “Data Definition” and “Template Definition”

• Runtime Submit report and XML Publisher concurrent request

Design Design -- LayoutLayout• Determine the report or form layout such as fonts, colors, graphs and charts• Create layouts using Acrobat Writer for PDF templates or MS Word for

RTF templates

Graphics

Fonts

Form Letter

Table

Colors

Design Design -- MarkupMarkupSet the concurrent program to generate XML outputRun report

Change output format to XML

Design Design -- MarkupMarkupXML datasource

Repeating Group

Fields

Design Design -- MarkupMarkup• Define markup elements to map XML datasource to the layout• Markup elements can be defined using Basic RTF or Form Field Method

Group

Placeholders

Page BreakEnd of Group

Integrate Integrate –– Data DefinitionData DefinitionRegister report as a Data Definition

Use XML Publisher Administrator responsibilityNavigation Path: Home → Data Definitions

Integrate Integrate –– Data DefinitionData DefinitionData Definition Code MUST MATCH the concurrent program Short Name

Data Definition Code = Short Name

Integrate Integrate –– Template DefinitionTemplate DefinitionRegister and upload template file

Use XML Publisher Administrator responsibilityNavigation Path: Home → Templates

Integrate Integrate –– Template DefinitionTemplate DefinitionAssociate template to Data Definition

• The first template uploaded is the default template• A single report can be associated to multiple templates

Data Definition

Upload Template File

RuntimeRuntime• Run the concurrent program

• Run the XML Publisher Concurrent RequestNot required if patch 3435480 is applied

Report Transformation Report Transformation -- Process OverviewProcess OverviewProcess OverviewProcess Overview

DesignDesign

IntegrateIntegrate

RuntimeRuntime

LayoutLayout

MarkupMarkup

Data DefinitionData Definition

Template DefinitionTemplate Definition

Run ReportRun Report

Run XML PublisherRun XML Publisher

XML Publisher Template BuilderXML Publisher Template BuilderWhat is Template Builder?• An add-on to MS Word• Simplify RTF templates development

To install Template Builder for MS Word apply45618354561835 Oracle XML Publisher Desktop Patch 5.5.0 client patch

Data Menu Load → XML DataAllows users to select a sample XML file containing fields that can be inserted into the template as a data source. The data source defines the XML format that will be merged with the RTF template

Insert Menu → FieldAllows users to select fields from the data source and insert them into the template

Insert Menu → Table/FormAllows users to insert tables or forms into the template

Preview MenuAllows users to preview the RTF template with sample XML data. The available output formats are PDF, HTML, RTF and EXCEL

Tools Menu → Field BrowserAllows multiple fields to be changed/updated efficiently

XML Publisher Template BuilderXML Publisher Template Builder

Going the XML Way!Going the XML Way!

How To How To -- DesignDesignAbout the report

HR Employee Details report (hreebarg.rdf) is a custom standard report, used by HR to generate service awards, eligibility lists and letters

Run HR Employee Details Report

Pre-XML

How To How To -- DesignDesignLayout

Use MS Word to design the layout Place logo, headers/footers, title, static text, etc

Logo

Header

How To How To -- DesignDesignMarkup

Set output format = XMLUse System Administrator responsibility

Navigation Path: Concurrent → Program → Define

Set output format to XML

How To How To -- DesignDesignRun HR Employee Details Report to generate XML output

Navigation Path: View Output → Tools → Copy File

How To How To -- DesignDesignOutput displays in a browser

Save XML output file as hr_emp_detail.xml

How To How To -- DesignDesignLoad the XML output (hr_emp_detail.xml)

Data → Load XML Data…

How To How To -- DesignDesignAfter data is loaded successfullyUse Insert → Table/Form to add table and fields

How To How To -- DesignDesignTo Preview template

Use Preview → PDF

How To How To -- DesignDesignUse Insert → Field to add more fields

How To How To -- DesignDesignTo Preview template

Use Preview → PDF

How To How To -- DesignDesignUse Tools → Field Browser

View/Modify XML commands in the form fields

How To How To -- DesignDesignPre and Post XML Output

Pre-XML

Post-XML

How To How To -- DesignDesignAdditional Template Features• IF-THEN-ELSE

• Display a message depending on a field value• Conditional formatting of fields

• CHOOSE• Display a graphic depending on a field value

• Group Count• Count total number of employees

• Graphs

How To How To -- DesignDesignDisplay a message depending on years of service

Use IFIF--THENTHEN--ELSEELSE

<?xdofx:if YR > 15 then ’15+' elsif YR >= 10 and YR < 15 then ’10-15' else ’1-9’end if?>

How To How To -- DesignDesign

Yrs of Service

Conditional Message

How To How To -- DesignDesignChange color attribute for years of service

<?if:YR>=15?><xsl:attribute xdofo:ctx="block“ name="color">red</xsl:attribute><?end if?><?if:YR>=10 and YR<15?><xsl:attribute xdofo:ctx="block" name="color">green</xsl:attribute><?end if?> <?if:YR< 10?><xsl:attribute xdofo:ctx="block" name="color">blue</xsl:attribute><?end if?>

How To How To -- DesignDesignDisplay when employee has 15+ years of service

<?choose:?><?when:YR >= 15?><?end when?><?end choose?>

Use CHOOSECHOOSE

How To How To -- DesignDesignDisplay the total count of employeesUse COUNTCOUNT

How To How To -- DesignDesignRepresent Number of Employees vs. Years of Service graphically

Chart Type

Group by Years of ServiceCount Number of Employees

Use Insert Insert → ChartChart

How To How To -- DesignDesignSample Template

How To How To -- DesignDesignThe possibilities are endless…

How To How To -- IntegrateIntegrateNavigation Path: XML Publisher Administrator responsibility

Home → Data Definition

NOTE:Data Definition Code MUST MATCHthe concurrent program Short Name

HowHow To To -- IntegrateIntegrateNavigation Path: XML Publisher Administrator responsibility

Home → Templates

Data Definition

Upload RTF templateSpecify Language

Template type = RTF

How To How To -- IntegrateIntegrateTemplate Duplicate Functionality

Enter Code & Name for new template definition

Query template definition

Click on Duplicate button

How To How To -- IntegrateIntegrateUpload the new template file

Click on Update button

Change template file

Upload hr_emp_detail_graph.rtf

How To How To -- RuntimeRuntimeRun HR Employee Details Report

How To How To -- RuntimeRuntimeDefault template can be changed using Concurrent Program definition page

Navigation Path: System Administration responsibilityConcurrent → Programs

Transformation Steps Transformation Steps -- SummarySummary

Tips & TricksTips & Tricks

Tips and TricksTips and TricksThe Form Field Help Text is limited to 138 characters. To overcome limitation, use the Help Key tab or add more form fields to the template.

Handling NULLs - Suppress or not to Suppress?

Suppress Nulls No additional coding requiredE.g. Letters and Labels

Do Not Suppress NullsInsert blank space E.g. Preprinted forms

Tips and TricksTips and Tricks

XML output does not extract parameter names and their values. As a workaround, create formula columns to return parameter values.

Formula Column (Report Builder)

Tips and TricksTips and Tricks

Tips and TricksTips and TricksHeaders and footers do not allow placeholders.

Use BASIC RTF method to insert fields in the headers and footers

Tips and TricksTips and TricksUse MS Word Table Property to repeat heading across pages

Missing header on Page 2

Tips and TricksTips and TricksUse MS Word Table Property to prevent rows from breaking across pages

Row breaking across pages

Tips and TricksTips and TricksTo utilize date format functionality, the date from the XML data source must be in canonical format: YYYY-MM-DDThh:mm:ss+HH:MM

Optional

dddd, MMMM dd, yyyy

Tips and TricksTips and TricksUse Diagnostic button to view XML output

Navigation Path:Standard Request Submission → Diagnostics Button → View XML

Technical Requirements Technical Requirements & &

ChallengesChallenges

PatchesPatchesClient side patch (Platform = Microsoft Windows(32-bit) Client)

• 4561835 Oracle XML Publisher Desktop Patch 5.5.0

Server side patches (Sun SPARC 32-bit)• 3412795 XML Publisher: Patch ADSPLICE patch for XDO • 3263588 Patch 11i.XDO.H• 3822219 XDO/Oracle XML Publisher OA ROLLUP patch 5.0.0 • 3435480 Publishing Concurrent Requests with XML • 3854951 FSG XML Publisher Functionality for R11i • 4073717 FND images pre-req for OA Framework• 4206181 XDO/Oracle XML Publisher OA ROLLUP patch 5.5.0 • 4515143 XML Publisher User’s Guide Online Help Release 5.5

SetupsSetups• Set properties in the xdo.cfg under $JRE_TOP/lib

The configuration file is primarily used for setting:• Temporary directory (Highly recommended for processing large files)• General and security properties for PDF files generated by XML Publisher• Font locations and substitutions

• Copy the font filesFrom $FND_TOP/resource to the /lib/fonts directory (under OA_JRE_TOP & JRE_TOP) on all Web and concurrent nodes. When using MICR font, remember to copy fonts on server

• Assign the XML Publisher Administrator responsibility to users

Challenges & SolutionsChallenges & Solutions• “JAVA lang out of memory errors”

To improve performance add the following lines to the xdo.cfg on your concurrent manager node:

<properties><!-- System level properties --><property name="system-temp-dir">/tmp</property><property name="xslt-scalable">true</property>

The directory pointed to by system-temp-dir should be large enough to hold your largest output files.

• Timeout WarningsThe concurrent manager has timed out waiting for the Output Post-processor to finish this request set profile Concurrent:OPP Response Timeout to allow more time to process large reports

• “Unable to find the published output for this request”Output Post Processor (OPP) patch has not been applied, or report is non-SRS requestrun the XML Publisher request to generate the output

XML Publisher XML Publisher Latest ReleasesLatest Releases

XML Publisher 5.6XML Publisher 5.6• Server side patches

4561451 XDO/ORACLE XML PUBLISHER OA ROLLUP PATCH 5.6.04743521 XDO 5.6.0 ADMIN PAGE UPDATE4734820 ONLINE HELP PATCH FOR XML PUBLISHER RELEASE 5.6

• New Features • Administration User Interface

Configuration properties can be set via the Administration interface, previously done in the xdo.cfg file. Behavior of XML Publisher can be configured at the site, data definition, and template level.

XML Publisher 5.6XML Publisher 5.6• Upload Font Files and Create Font Mappings

Upload fonts through the Administration interface to make them available at runtime

• RTF Template Enhancements• Graphics Support

• Drawing/Shape support • Background and Watermark support

• Conditional Formatting • Fixed-row enumeration

Specify a fixed number of rows for a table regardless of the amount of data coming into the template at runtime

• Currency formattingNumeric values can now be formatted according to their associated currency code

XML Publisher 5.6.1XML Publisher 5.6.1Server side patches

4905678 XDO/ORACLE XML PUBLISHER OA ROLLUP PATCH 5.6.1

RTF Template Enhancements

• Hyperlink support for shapesUsers can click the image in the document and link to an internal or external destination

• Bookmark SupportGenerate the bookmark links that display in the PDF navigation pane

• Truncate Table DataAbility to truncate data in a table cell that is too big for the cell

• Odd and even header and footer support Define different headers and footers for odd and even pages in report output

ResourcesResourcesTopic Doc#About Oracle XML Publisher Release 5.5 316447.1Using the Output Post Processor (OPP) in Oracle Applications Concurrent Processing

291792.1

Publishing Concurrent Requests with XML Publisher 295409.1XML Publisher and Concurrent Manager Integration 276691.1Check Printing Using XML Publisher 312353.1Concurrent Request Fails due to Timeout of the Post Processing Action

352518.1

Unable to view output in a single request run (CONC-PP FAILED NO OPP error)

308203.1

Presentations, Technical Information and Demos on XML Publisherhttp://www.oracle.com/technology/products/applications/publishing/index.html

Q&AQ&A

E-mail Addresses:• ncastaneda@wpb.org• jabel@wpb.org