Bi Publisher Quick Start Guide 2010

Susan Behn

Bi Publisher Quick Start GuidePresentation Templates

Copyright 2010 Solution Beacon, LLC All Rights Reserved Any other commercial product names

herein are trademark, registered trademarks or service marks of their respective owners.

2

Agenda

• Overview• Hands On – Build AP Invoice Register Report• Questions



3

Overview

XML Data

BI Publisher Processing

Engine

Report Template

FormattedOutput

XML EDI

XSL

• Separates source of data from presentation of data

• Data Template Produces XML Data

• Report Template formats data



4

XML Data

• Any Valid Source– Oracle Reports– SQL, SQLX, PL/SQL– Scripting (Perl, PHP,etc)– Email, FTP– Discoverer– XML data template

• Multiple Uses– One XML File, Multiple

Template– One template, multiple

XML Files– Conditional Subsets



5

Report Templates

• Create with common desktop tools– MS Word (RTF, EDI, XSL)– Adobe Acrobat (PDF)– MS Excel

• Template Markup Tags– Text Tags– Text Form Fields (RTF

Only)

Text Tags

Text Form Fields



6

Template Builder

• MS Word Plug–in– Version 5.6.3 for 11i/R12 Patch

Num: 5887917– Version 10.1.3.4.1

• For R12 only if you have 64bit machine

• Not backward compatable

• Wizards, Drag–and–Drop• Report Preview• Simplifies Template

Creation

Office 2000, 2003

Office 2007



7

Processing Engine

• Merges XML Data with Report Template– PDF, RTF, EDI Processors

Engine• Three Versions

– Desktop• Version 5.6.3

– Enterprise Edition• Version 10.1.3.4

– Oracle Applications• Version 5.6.3 processing engine

embedded in E-Business

PDFProcessor

RTFProcessor

EFTProcessor

How the processing engine works



8

Formatted Output

• Advanced Formatting• Precision Control• User Interactivity

– Parameters– Sorting– Links, Drilling

• Conditions, Exceptions• Formulas• Charts and Graphs



9

Report Delivery

Web Services

Templates

XML

EDI

EFT

Email

Printer

Fax

WebDAV

WWW

Output Delivery

Oracle DB, MS SQL Server

Oracle 11i, PeopleSoft,SAP, Siebel

Oracle Reports,

PL/SQL, Java,

Perl, etc

BI Publisher

Data Source

XSL

Layout

PDF

RTF

HTML

Excel

How to BuildAP Invoice Register





11

Report w/o BI Publisher



12

Sample Report with BI Publisher



13

Invoice Register in Release 12.1.2(XML Template Already Exists)



14

Sample of XML Data

• Existing File• Make Your Own• SQL Query• PL/SQL• Scripting• XML Data Template• E–Business Suite Report

– Our Example uses the output from E–Business Suite Report 'AP Invoice Register'



15

Create XML Data Source(Invoice Register in 11i is not in XML)

• Concurrent | Program | Define– System

Administrator or Application Developer

• Query program

Choose the Copy to button



16

Create XML Data Source

• Enter slightly different ProgramProgramProgramProgram, Short NameShort NameShort NameShort Name

• Click Include Include Include Include ParametersParametersParametersParameters and Include Include Include Include Incompatible Incompatible Incompatible Incompatible ProgramsProgramsProgramsPrograms

• Click OKOKOKOK



17


• Change Output Output Output Output FormatFormatFormatFormat to XML

• Save work noting new Short NameShort NameShort NameShort Name



18


• Register Report to Request Group– Security |

Responsibility | Request

– Query Group assigned to responsibility where report will be run



19

Run Report

• Run Report• When finished

– Select View View View View OutputOutputOutputOutput

– Save results to InvoiceReg.xml

• Name of file can be any desired name



20

Open File

• Review generated data– Oracle may (or not)

furnish report name– Look at each grouping

(starts with dash)– Look at end of report

for fields that can also be used

• Parameters• Constants



21

R12 – Getting XML output when there is already a template

• Run the report in the concurrent manager– Format =

null• Report will

complete with warning but output contains XML data

Click on the options buttonSet the

format to null



22

R12 – Download Existing Template

• XML Publisher Administrator Responsibility– Home � Templates

Search for Invoice Register

Download file to local directory



23

Setup Template Options

• MS Word, Add–Ins, Oracle BI Publisher

• Addin Tab |Tools | Options

• UI tab• Select Original Original Original Original

XML Element XML Element XML Element XML Element NameNameNameName

• Save file in type .rtf



24

Setup Template Options

• Build Build Build Build Tab• 'Abbreviated'

chosen for ForForForFor––––each form fieldeach form fieldeach form fieldeach form field

• Click SelectSelectSelectSelect– Choose default

Table Header Table Header Table Header Table Header ColorColorColorColor



25

Load Sample XML Data

• Data | Load XML Data

• Select file saved from running Invoice Register to Invoice Register to Invoice Register to Invoice Register to XMLXMLXMLXML, Click OpenOpenOpenOpen, receive Data Data Data Data loaded successfully loaded successfully loaded successfully loaded successfully message

• No file is displayed in document window



26

Set Page Layout

• Using standard Word functionality– Set Orientation to Landscape– Set Margins– Set Font and Size– Set Style



27

• Use std Word header functionality– XML data may include Report title– Add date, page numbers, (optional) logo, etc…

Create Report Page Header



28

Create Data Header Section

• From Add–Ins, Oracle BI Publisher– Insert | Table

Wizard– Click FormFormFormForm



29


• Select field to group by– The selected field

becomes the outer grouping

• Click NextNextNextNext



30


• Select fields to appear in header– Either pick

formatted amount or will have to use Word formatting




31


• Select Sort Order– Since grouping by

Vendor, sort by vendor first

– Order of other fields up to designer




32


• Enter field labels– Default label is

field name• Click FinishFinishFinishFinish



33

• Format resulting table– Font size, type– Width 1st column– Table borders, shading– Alignment

• Hint: Split amount cells so right–align still close to header




34

What is that F and E

End For Each

For Each

• Select Properties PageProperties PageProperties PageProperties Page• Click Add Help Text…Add Help Text…Add Help Text…Add Help Text…



35

• Add a couple of blank lines between table and EEEE• Place cursor in line just above EEEE

Create Data Detail Section



36


• From Add–Ins, Oracle BI Publisher– Insert | Table /

Form



37

• Scroll down until <G_INVOICE> appears• Drag to Template zone, click 'Drop Single Node' when

pop–up box appears




38

• Making sure Insert Position Insert Position Insert Position Insert Position = ChildChildChildChild, drag <C_EXP_FLEXFIELD> on top of <G_INVOICE>

• Drag elements as shown on top of <C_EXP_FLEXFIELD>• Order listed will determine order listed on report




39


• Highlight <G_INVOICE>• Note default Properties

• Change so that looks like bottom picture



40


• Highlight <C_EXP_FLEXFIELD>

• Note default Properties

• Change so that looks like bottom picture– If Sort Data Type Sort Data Type Sort Data Type Sort Data Type grayed out

and wrong, see following slides



41

• Clicking OKOKOKOK yields above table• Note the G / E above/below inner table• Note the F in the same field as C_LINE_NUM and E in

same field as C_FORMATED_DIST_AMT




42

What is that G and E

End For Each Group

For Each Group



43

• Highlight everything in outer table (G through E), drag to below table

• Highlight table with C_EMP_FLEXFIELD and delete it




44


• Place cursor next to G

• From Add–Ins, Oracle BI Publisher– Insert | Field– Select

<C_EXP_FLEXFIELD>, click Insert



45

• Highlight C_EXP_FLEXFIELD, make it Bold, Italics




46

• Change headers in table, adjust column sizes• Make Line and Amount right–justified• Delete space before E• Don't worry about wrapping shown in column




47

• To aide in spacing, eliminate wrapping, highlight each field and change Default textDefault textDefault textDefault text

• Review Fonts, Font sizes, Field layouts




48

Preview Report

• From Add–Ins, Oracle BI Publisher– Preview | PDF– Preview | RTF



49

Preview Report

• Note any formatting, line spacing, that still needs changing

• Note that Line sorted alphabetically, not numerically



50

Fix Numeric Sort

• Highlight FFFF just before LINELINELINELINE

• Right–click, choose PropertiesPropertiesPropertiesProperties

• Click Add Help Text…Add Help Text…Add Help Text…Add Help Text…• Change datadatadatadata––––

type='text'?> type='text'?> type='text'?> type='text'?> to datadatadatadata––––type='number'?>type='number'?>type='number'?>type='number'?>

• Click OKOKOKOK, then click OKOKOKOKagain



51

Format Currency Values

• Double–click AMOUNTAMOUNTAMOUNTAMOUNTfield

• Click Add Help Text…Add Help Text…Add Help Text…Add Help Text…• Change

<?C_FORMATTED_DIST_A<?C_FORMATTED_DIST_A<?C_FORMATTED_DIST_A<?C_FORMATTED_DIST_AMT?>MT?>MT?>MT?> to <?format<?format<?format<?format––––currency:C_FORMATTED_currency:C_FORMATTED_currency:C_FORMATTED_currency:C_FORMATTED_DIST_AMT;'USD'?>DIST_AMT;'USD'?>DIST_AMT;'USD'?>DIST_AMT;'USD'?>

• Click OKOKOKOK, then click OKOKOKOKagain

• Requires xdo.cfg file to include mask for currency code specified



52

• Place <?split<?split<?split<?split––––bybybyby––––pagepagepagepage––––break:?> break:?> break:?> break:?> just before <?end for<?end for<?end for<?end for––––each?>each?>each?>each?> that governs the field to break on– Our example above will cause a page break to occur whenever

a new supplier name occurs• Can also use form field to specify page break

Force Page Break



53

• Lines sorted numerically• No second vendor on page• Continue to change and review until satisfied with results• Save .rtf file

Preview Report Again



54

Add a Filter–Start Tag

• Place cursor after first FFFF• Add Form Field

– Developer Tab– Click Design ModeDesign ModeDesign ModeDesign Mode– Click Legacy Tools Legacy Tools Legacy Tools Legacy Tools button– Click Text Form FieldText Form FieldText Form FieldText Form Field– Double–click resulting gray

field to open PropertiesPropertiesPropertiesProperties page• Enter description of filter in

Default text:Default text:Default text:Default text:• Click Add Help Text…Add Help Text…Add Help Text…Add Help Text…

Resulting Gray box

Text Form

Legacy Tools



55

Add a Filter–Start Tag

• Click Type your own:Type your own:Type your own:Type your own:• Enter condition using

syntax <?if:<?if:<?if:<?if:<field_name><condition>?>?>?>?>– Replace <field_name> with

name of XML field that controls filter

– Replace <condition> with filtering condition

– Example: <?if:C_AMOUNT_REM!=0?>

• Click OKOKOKOK then Click OKOKOKOK



56

Add a Filter–End Tag

• Place cursor before last EEEEand after page break

• Add Form Field– Developer Tab– Click Design ModeDesign ModeDesign ModeDesign Mode– Click Legacy Tools Legacy Tools Legacy Tools Legacy Tools button– Click Text Form FieldText Form FieldText Form FieldText Form Field– Double–click resulting gray

field to open Properties page• Enter description of filter

end in Default text:Default text:Default text:Default text:• Click Add Help Text…Add Help Text…Add Help Text…Add Help Text…

Resulting Gray box

Text Form

Legacy Tools



57

Add a Filter–End Tag

• Click Type your own:Type your own:Type your own:Type your own:• Enter <?end if?><?end if?><?end if?><?end if?>• Click OK then Click OKOKOKOK



58

Spaces and Carriage Returns

• Every character in template will show in report results– Example: space between F

and if form field

– Result: if first record doesn't meet condition, first page is blank

– Remove space and first page shows invoice meeting condition



59

Final Check

• Validate Template

• Error messages are not always helpful, but does identify line



60

• Use XML Publisher Administrator responsibility• Home | Data Definitions• Click Create Data DefinitionCreate Data DefinitionCreate Data DefinitionCreate Data Definition

Load Template into EBS



61

• Enter any NameNameNameName• CodeCodeCodeCode MUST match Short Name of Concurrent Program

definition with XML output• Click Apply




62

• Query Data Definition just created• Click the link under NameNameNameName




63


• Click Update Update Update Update FileFileFileFile next to Preview Data Preview Data Preview Data Preview Data to load XML data file used in template build testing



64

• Click BrowseBrowseBrowseBrowse button, select file from PC file system, click OpenOpenOpenOpen

• Selected file name fills into Preview Data Preview Data Preview Data Preview Data box• Click ApplyApplyApplyApply




65

• Click TemplatesTemplatesTemplatesTemplates tab• Click Create TemplateCreate TemplateCreate TemplateCreate Template




66

• Enter any Name, Code, DescriptionName, Code, DescriptionName, Code, DescriptionName, Code, Description• Data Definition Data Definition Data Definition Data Definition must match one just defined• Since template created in Word, set TypeTypeTypeType to RTFRTFRTFRTF• Set Subtemplate Subtemplate Subtemplate Subtemplate to NoNoNoNo




67

• Click BrowseBrowseBrowseBrowse to upload template file from PC file system• Enter Language Language Language Language and TerritoryTerritoryTerritoryTerritory• Click ApplyApplyApplyApply




68

• Click Preview Preview Preview Preview to verify template is correct• If correct, report will show




69

Test Report

• Return to responsibility where report registered

• Verify template name in LayoutLayoutLayoutLayout



70

Test Report

• Click OptionsOptionsOptionsOptions and verify Template Template Template Template Language Language Language Language and Format Format Format Format

• Close OptionsOptionsOptionsOptionswindow and click SubmitSubmitSubmitSubmit

• When report finishes, click View View View View OutputOutputOutputOutput



71

View Finished Report



72

Add Parameter to Report

• MetaLink Doc. ID 741301.1 "Implement Concurrent Request Parameter Values In RTF Layout Template"

• Allows adding parameter without modifying Oracle code– Data parameter affects must already exist



73

Add Parameter to template

• Place cursor before first FFFF• Add Form Field

– Developer Tab– Click Design ModeDesign ModeDesign ModeDesign Mode– Click Legacy Tools Legacy Tools Legacy Tools Legacy Tools button– Click Text Form FieldText Form FieldText Form FieldText Form Field– Double–click resulting gray

field to open PropertiesPropertiesPropertiesProperties page• Enter description of filter in

Default text:Default text:Default text:Default text:• Click Add Help Text…Add Help Text…Add Help Text…Add Help Text…

Resulting Gray box

Text Form

Legacy Tools



74

Add Parameter to template

• Click Type your own:Type your own:Type your own:Type your own:• Enter condition using

syntax <xsl:param <xsl:param <xsl:param <xsl:param name = name = name = name = "<parameter_name>" "<parameter_name>" "<parameter_name>" "<parameter_name>" xdofo:ctx="begin"/>xdofo:ctx="begin"/>xdofo:ctx="begin"/>xdofo:ctx="begin"/>– Replace

<parameter_name> with name of parameter

– Do not use $ in parameter name




75

Replace Filter Start Tag Help Text

• For condition Logical or/and use <xsl:if test = "condition">

• Parameter must be preceded by $




76

• Place <?if:$P_UNPAID='Y'?> <?if:$P_UNPAID='Y'?> <?if:$P_UNPAID='Y'?> <?if:$P_UNPAID='Y'?> just before Unpaid Unpaid Unpaid Unpaid InvoicesInvoicesInvoicesInvoices and <?end if?><?end if?><?end if?><?end if?> immediately after

• Cannot use form field in Header/Footer

Conditional Heading



77

Add Parameter to Concurrent Report Definition

Name must match name used as parameter name in template

Ensure values will match those values used in template



78

• Query Template• Click UpdateUpdateUpdateUpdate• Use the BrowseBrowseBrowseBrowse

button to select updated file from PC file system

• Click ApplyApplyApplyApply

Upload Updated Template



79

Run Report

Unpaid Invoices Only?=Yes Unpaid Invoice Only?=No



80

Additional Resources

• Solution Beacon presentations and newsletters• OAUG Knowledge Factory• BI Publisher Blog by Tim Dexter

http://blogs.oracle.com/xmlpublisher/• BI Publisher for Oracle E–Business Suite by Roel A.

Hogendoorn MSc• EBS Documentation

– Release 11i.10.2+ – User's Guide– Release 12 – Administration and Developer's Guide

• MetaLink Forums (XML and/or BI Publisher)– Soon to be Communities

• MetaLink Knowledge Browser (BI Publisher)



81

Got Oracle? Got Oracle?

Get the Books!Get the Books!

The Release 12 Primer –Shining a Light on the

Release 12 World

Installing, Upgrading and Maintaining Oracle E-

Business Suite Applications 11.5.10.2+

The ABCs of Workflow for Oracle E-Business Suite

Release 11i and Release 12

Available at

www.solutionbeacon.com



82

Ranked ScorecardFree Consultation

How Does The Scorecard Work• Answer multiple-choice

questions• Identify areas of risk

(business and IT)• Ranked score helps measure

your status on issues• Provides recommendations

for next steps • Feedback on issues that

concern steering committees and ROI

Scorecard Focus Areas• Competitive Optimization• Functional and Process Issues• Project Approach and

Complex Issues• Workflow Issues• Customization Reduction• Database• Data Integrity• System Optimization• Business Intelligence



83

Questions & Answers

Thank you!Thank you!

Karen [email protected]

Susan [email protected]

www.solutionbeacon.com

Real Solutions for the Real World®

Documents

Bi Publisher Quick Start Guide 2010