BI Publisher Best Practices

1
Copyright 2012, Oracle and/or its affiliates. All rights reserved.
Oracle BI Publisher Best Practices

Rupesh Varma Principal Product Manager
The following is intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decision. The development, release, and timing of any features or functionality described for oracle's products remains at the sole discretion of oracle.
Program Agenda
Oracle BI Publisher Enterprise Overview
Report Design Best Practices
Data Modeling Guidelines Template Design Guidelines Reporting Guidelines
Q&A
Oracle BI Publisher Enterprise

Eliminate Multiple-point Solutions
Invoices
Checks
One Environment
Author Generate Deliver
Benefits
Eliminate complexity Simplify report
Destinations
Reports
development & maintenance Reduce costs
Labels
XML / EFT / EDI
Oracle BI Publisher Enterprise

From Data to Document to Delivery
Interactive
Oracle, Oracle BI EE, Oracle BI Apps SQL Server
PDF HTML Excel
Email
Printer
E-Business Suite, PeopleSoft, Siebel, JDE, Primavera
XSL
PPT Flash Fax RTF CSV XML EDI Repository
Layout Template Types Layout Editor MS Word MS Excel Adobe Flex XSL
OLAP
Web Services
Layout Design Tools
EFT
e-Commerce
Data Sources
6 Copyright 2012, Oracle and/or its affiliates. All rights reserved.
Output Formats
Destinations
Architecture
BI Publisher
Oracle Business Intelligence Publisher

Report Architecture
Separate data logic, layout & translation benefits
greater flexibility and reuse fewer reports and better report maintenance optimize data extraction and document generation process
Data Logic Layout Translation

BI Publisher Report output
Oracle BI Publisher Scheduler 11g

Client Client
Web server/JMS Provider (Web Logic, Active MQ)
FAX Q.
Web server
BI Publisher
Web server
BI Publisher
Fax
Printer Q.
Printer
Job Q
Report Q BIP System Topic
JMS Resources
Email Q.
Email
FTP Q. WebDav Q.
Repository
File Q.
File system
BI Publisher Reports Repository
Scheduler database
Program Agenda
Data Modeling Guidelines Template Design Guidelines
Q&A
10
Data Generation
Data Sources
Data Source Types
File (XML) SQL Query MDX Query
LDAP Query
Excel Spreadsheet HTTP (XML Feed) Web Service Oracle BI Analysis
11
Data Generation
Connection Types
JDBC Vs JNDI (SQL Type)
Both types of connection use
1
the same JDBC driver With JNDI you can take advantage of connection pooling
Better performance Connection already established to the source Best practice for reports with many parameters
BI Publisher
WebLogic Server
with SQL type LOVs attached to them Better RDBMS resource management
12
Data Generation
Scalable Mode
Enable for large reports
Slower performance, but
prevents out-of-memory errors

Use with scheduled
reports
13
Data Model Design

Objectives
Optimize data extraction Simplify layout design for report developers Reduce document generation time
14
Data Model Design

Data Extraction
Leverage back-end system resources
Select t."OFFICE_DSC" as "Office" sum(f."REVENUE") as Sales Sum" From "BISAMPLE"."SAMP_REVENUE_F f "BISAMPLE"."SAMP_OFFICES_D t Where t."OFFICE_KEY"=f."OFFICE_KEY" group by t."OFFICE_DSC"
(when possible)
Join data Filter & group data Perform expensive calculations & data
transformations Sort data

Consider going against BI Server instead
of extracting data directly from the source systems Use BI Server Logical SQL instead of Answers/Analysis
20 Vs 20,000 records
15
Data Model Design

Data Extraction
Parameters & LOVs
Cache LOVS for better performance For large LOVs, pass NULL to the
parameter when users select All & modify WHERE clause in Data Set query to use the NVL function. For example: Where order_id=nvl(:p_ordid, order_id)
Data Model Design

Data Extraction
Event triggers Before Data Triggers
Generate dynamic SQL Populate TEMP tables Set user context
Select EMPLOYEE_ID, DEPARTMENT_ID, FIRST_NAME, LAST_NAME, EMAIL, PHONE_NUMBER, HIRE_DATE, JOB_ID, SALARY from employees where &p_where_clause
After Data Triggers

Insert rows to a target table Send notifications Clean or delete TEMP tables
17
Data Model Design

Best Practices for Faster Document Generation
Structure data to match how data is
displayed in the report Use short XML tag names they reduce the size of XML data file Use display names to simplify template design Create global & group-level aggregate functions for best performance, create them in data model instead of report layout Pre-sort data Note: Grouping data in data model automatically sorts data by the grouping element Bursting It also requires that data in the XML is sorted (or grouped) by the split-by key.
18
Program Agenda
System Configuration Guidelines
BI Publisher Server Configuration Options

Data Modeling Guidelines Template Design Guidelines
Q&A
Document Formatting and Layout

What Template Type should I use? (1 of 2)
RTF Templates
Easy to create w/ BI Publisher Template Builder Add-in to Word Greatest flexibility and functionality for highly formatted reports RTF marked up with XSL code or BI Publisher simplified XSL Wide range of output (PDF, HTML, Excel, PPT, RTF, MHTML)
Web based Layout Editor no client installation required Best for Management Report WYSIWIG experience Support Interactive Output Wide range of output (PDF, HTML, Excel, PPT, RTF, MHTML)
BI Publisher Template 11g
Excel Templates
Excel w/ data mapped to named cells & Excel and XSL formatting Great for formatted, true Excel output and burst over sheets Excel XLS output only
20

What Template Type should I use? (2 of 2)
PDF Forms PDF forms with XML elements mapped to form fields. Great to use with government forms PDF output only - created in Acrobat Professional Text output only for electronic communication Great for character delimited or fixed position docs (EFT & EDI) RTF with table of statements to place fields and separators
e-Text Templates
Flash Templates XSL Style Sheets
SWF files with BI Publisher data for sophisticated interactivity Create in Adobe Flex Builder
Allows for third party tools and legacy solutions
Excel Analyzer Templates
Not recommended (deprecated) Excel output only. Can refresh data w/ parameters.
21
BI Publisher Template (11g) Best Practices

Design Consideration
Use Layout Grids to position
components similar to tables in RTF Templates

Layout Grids can be nested Layout Grid Cell can be joined The minimum height of rows
can be fixed
Do NOT put large tables (Perform.)
or pivot tables into Layout Grids
22
BI Publisher Template (11g) Best Practices

Design Consideration
The Interactive Viewer is one of BI Publishers most
popular new features

Interactivity works best for flat tables or simple
nested master-detail data sets

Unrelated queries or groups can not interact
Disable interactions for unrelated queries in the
Configure Events Dialog

BAD: Country on two branches GOOD: Country in common parent
Data G1 Country Revenue G2 Country Cost
Data G1 Country G2 Revenue G3 Cost
23
RTF Template Best Practices

Use Word Tables
Use tables to control precisely where field data will be placed in the
report
24

Use Form Fields
Keep the template clean Supported by the Template Builder
Field Browser Can be colored or hidden to help understand the structure Caveat: Word header & footer dont allow form fields
25

Use Word Styles
Achieve consistency in the template and
between templates In 11g use Style Templates to control the template styles
26

Dont overcomplicate your template
Keep it easy to understand, debug and maintain In general better to have different business documents in
different templates Try to limit the logic in templates to simple if or loop statements Use sub templates to simplify documents if necessary Many calculations are better performed in the data model
27

Sub Templates: Introduction
What is a sub template?
A document that contains layout and or code that can be defined once
and used multiple times Multiple functions (called templates in XSL) or text segments can be defined in a single sub template file
Sub template types
XSL sub templates for code re-use or separation
RTF sub templates for layout re-use

Caveat: Use of RTF sub templates makes it harder to understand and
visualize the template structure
28

Sub Templates: Use Cases
RTF sub templates
Re-use common layouts such as terms and conditions Internationalized address block
XSL sub templates

Transformations for complex chart requirements Dynamically apply formatting to a portion of data
(e.g. sub scripting / super scripting / chemical formula) Print formatted XHTML data convert to FO using sub template (as used in Oracle Contracts) (11.1.1.6 supports HTML in data)
Starting w/ 11.1.1.3 we recommend using Style Templates for Header / Footer instead of RTF Sub Template
29

Performance Considerations: XPATH Concepts
BI Publisher uses XPATH to access data elements DEPARTMENT_NAME is inserted in the template as
<?DEPARTMENT_NAME?>
<?DEPARTMENT_NAME?> is translated to the XPATH
.//DEPARTMENT_NAME
.//DEPARTMENT_NAME searches for
DEPARTMENT_NAME in the complete sub-tree starting from current context
30

Performance Considerations: XPATH Tuning
Use the full relative path for large datasets
Instead of <?for-each: DEPT?>
use <?for-each:/DEPT_SALS/DEPT?>
Instead of <?DEPARTMENT_NAME?>
use <?./DEPARTMENT_NAME?>
For large documents that dont fit into memory
the search requires disk access For small documents the search time is negligible

Performance Considerations: XPATH Tuning & Tables
XPATH Tuning
Start with the outer loops and outer most data access Reducing full tree searches will provide bigger improvements than optimizing
access in a small subset of the data Fixing the XPATH in a single for-each loop may be all the performance tuning you need to do
Tables
LARGE tables that span hundreds of pages consume considerable server
resources. If possible group the data and create a table inside each grouping. Do not nest LARGE tables into tables.
32

Performance Considerations: Grouping
Better to Sort data in the data model Group By <?for-each-group?>
will force the XSL engine to sort data

Checking Data already sorted option in the Table Wizard will not re-sort
data (good thing)
33
Template Best Practices

Summary
Dont overcomplicate your templates Use tables (layout grids) to place data fields precisely Use form fields and word styles for clarity Use sub templates for re-use and encapsulate complex code Optimize your data structure for interactivity if necessary Performance optimization Optimize the XPATH Focus optimization on outer loops Sort in the data base and use group-adjacent in the template
Stay Connected with BI Publisher
http://www.oracle.com/technetwork/middleware/bi-publisher/overview/index.html
35
Q&A
36
37
38
APPENDIX
39
Resources
Certification matrix (11.1.1.x)
http://www.oracle.com/technetwork/middleware/bi-enterprise-edition/bi-11gr1certmatrix-166168.xls
High availability white paper
http://www.oracle.com/technetwork/middleware/bi-publisher/bip-cluster-deployment-366859.pdf
Sizing Spreadsheet for BI Publisher Enterprise 10g
My Oracle Support Note - 948841.1 Sub-templates white paper

http://www.oracle.com/technetwork/middleware/bi-publisher/overview/bip-subtemplate-1-132933.pdf
QUARTZ Scheduling (clustering) wiki page
http://wiki.opensymphony.com/display/QRTZ1/ConfigJDBCJobStoreClustering
CPU Ratings
http://www.spec.org/cpu2006/results/cpu2006.html#SPECint_rate
40
Server Configuration Options

Administration > Server Configuration
Scalable threshold (in bytes) Cache expiration (in min) Cache size limit (# of datasets) Maximum cached reports Database Fetch Size
Default values
41
Server Configuration Options

Administration > Runtime Configuration > Properties
Bursting (10g only)

Enable multithreading Default: False*

Thread count Default: 2* Use BI Publishers XSLT processor Default: True
FO processing

Enable scalable feature of XSLT processor Default: False*

Pages cached during processing Default: 50 Enable multithreading Default: False* FO Parsing Buffer Size Default: 1000000* Enable XSLT runtime optimization Default: True
42
Report-level Properties
Edit Report > Properties > Formatting
43
Viewing Reports Online
Report Editor Report Viewer
For long running reports

Take advantage of scheduling
and disable Run Report Online.
44
Viewing Reports Online
Report Editor
Enable Data Caching Saves XML data for reuse up to the Cache Expiration threshold Improved performance with different template/output format Not recommended for real-time data
Enable Document Caching Better performance Consumes more Temp storage space
User Level (11g only) Disable for better performance if data can be shared across users Cache Duration (11g only)
45
Data Model Design Guidelines

Element Naming
Avoid re-using the same name for element names; it can cause
confusion in template design.

For example, CITY under SHIPPING_ADDRESS and BILLING_ADDRESS.
But in many cases you are better off using different names e.g. S_CITY and B_CITY
46

NULL Elements & XML Attributes
Avoid generating empty tags in the XML
Aggregation over fields that contain empty tags will fail with a not a
number exception
Missing fields do not cause an issue with XSL for example a print
statement will just return an empty string

Avoid XML attributes
They are supported in both RTF & Excel templates but they add an extra
layer of complexity; they are not supported in the BI Publisher Layout Editor
47

OBIEE Data Source
If possible use SQL/JDBC
against BI Server instead of using an Answers Request as a data source

Tip: Copy the SQL in an
Answers Request and paste into the Query Builder text area
48
49
50

BI Publisher Best Practices

Uploaded by

Copyright:

Available Formats

BI Publisher Best Practices

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

BI Publisher Best Practices

Uploaded by

Copyright:

Available Formats

What are some guidelines for data modeling?

What are some guidelines for data modeling?

What are some guidelines for template design?

What are some guidelines for template design?

1

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Oracle BI Publisher Best Practices

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Oracle BI Publisher Enterprise

development & maintenance Reduce costs

XML / EFT / EDI

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Oracle BI Publisher Enterprise

PDF HTML Excel

E-Business Suite, PeopleSoft, Siebel, JDE, Primavera

PPT Flash Fax RTF CSV XML EDI Repository

Layout Design Tools

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Oracle Business Intelligence Publisher

Data Logic Layout Translation

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Oracle BI Publisher Scheduler 11g

BI Publisher Reports Repository

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

prevents out-of-memory errors

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Data Model Design

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Data Model Design

transformations Sort data

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Data Model Design

Data Model Design

After Data Triggers

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Data Model Design

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

BI Publisher Server Configuration Options

Document Formatting and Layout

BI Publisher Template 11g

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

Document Formatting and Layout

Flash Templates XSL Style Sheets

Excel Analyzer Templates

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

BI Publisher Template (11g) Best Practices

components similar to tables in RTF Templates

or pivot tables into Layout Grids

Copyright 2012, Oracle and/or its affiliates. All rights reserved.

BI Publisher Template (11g) Best Practices

popular new features

nested master-detail data sets

Configure Events Dialog

Data G1 Country Revenue G2 Country Cost

Data G1 Country G2 Revenue G3 Cost