Go to main content
1/35
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documentation and Other Resources
System Requirements and Certification
Conventions
New Features for Report Designers
New Features and Changes for Release 12
c
(12.2.1.4.0)
New Features and Changes for Release 12
c
(12.2.1.3.0)
New Features and Changes for Release 12
c
(12.2.1.1.0)
Part I Creating Reports and Layouts
1
Introduction to Designing Reports
Overview for Report Designers
Defining Summary Text for Tables
About the Layout Types
About Setting Run-Time Properties
About Translations
About Style Templates
About Sub Templates
2
Creating and Editing Reports
About Report Components
Creating Reports: Process Overview
Creating Reports
Selecting a Data Source
Choosing Guide Me or Use Report Editor
Selecting the Report Layout
Choosing Columns for Report Layouts
Table Layout
Chart Layout
Chart and Table Layout
Pivot Table Layout
Chart and Pivot Table Layout
Two Charts and Table Layout
Saving the Report
Creating Reports Using a Direct Connection to a Subject Area
Creating Subject Area Reports
Adding Parameters to Subject Area Reports
Creating a Report Against Multiple Subject Areas
Editing Reports
Adding Layouts to the Report Definition
Adding a Layout Using the Layout Editor
Adding a Layout by Uploading a Template File
Adding a Layout by Generating a Template File
Configuring Layouts Using the List View
Applying a Style Template to the Layout
About the Layouts Toolbar
Configuring the Layout Settings Using the List View
Selecting Output Formats
Editing a Layout
Configuring Parameter Settings for the Report
Configuring Report Properties
Setting the General Properties
Run Report Online
Advanced Options
Setting the Caching Properties
Setting the Formatting Properties
Configuring Font Mapping
Configuring Currency Formats
Accessing Reports via a URL
Security Considerations
Building the URL
Specifying Parameters in the URL
3
Creating BI Publisher Layout Templates
Overview of BI Publisher Layouts
When to Use a BI Publisher Layout
Prerequisites, Recommendations, and Limitations
Launching the Layout Editor
When Creating a New Report
When Editing a Report
When Viewing a Report
Selecting a Predefined Layout
Adding Shared Templates for All Users
Adding Personal Predefined Layouts
About the Layout Editor Interface
About the Data Source Pane
About the Components Pane
About the Properties Pane
About the Tabbed Toolbar
Selecting and Deleting Layout Objects
About the Insert Tab
Page Layout Tab
Paper Options
Header/Footer Options
Setting Properties for Headers and Footers
View Options
Display Unit
Interactivity: Event Configuration
Example of Filter Event Configuration
Configuring Automatic Filtering
Example: Show Selection Only
Setting Page Margins
Setting Maximum Connections for an Interactive Report
Inserting Layout Components
Inserting Layout Grids
Adding a Border or Background Color
About the Insert Options
About the Join and Unjoin Options
Adding an Expand and Collapse Option
About Repeating Sections
Setting Page Break Options for a Repeating Section
How Repeating Sections Display in Interactive Mode
Showing All Values in a Repeating Section
About Data Tables
Inserting a Data Table
Setting Alternating Row Colors
About the Table Tab
Setting the Rows to Display Option
About Filters
Setting Filters for a Table
Managing Filters
About Conditional Formats
Applying Conditional Formats to a Table
Managing Formats
Controlling the Display of the Total Row
About the Table Column Header Tab
About Grouping
Example: Group Left
Applying Subtotals
Example: Group Above
About the Column Tab
About the Data Formatting Options for Columns
Applying Formatting to Numeric Data Columns
Applying Formatting to Date Type Data Columns
Custom and Dynamic Formatting Masks
About the Formula Option
About the Sort Option
Removing a Sort Order
About the Total Cell Tab
Applying Data Formatting to a Total Cell
Applying a Formula
Inserting Dynamic Hyperlinks
Applying Custom Data Formatting
About Charts
Inserting a Chart
About the Chart Tab
Applying and Managing Filters
Converting a Chart to a Pivot Table
Changing the Formula Applied to a Chart Measure Field
Sorting a Chart Field
Using Advanced Chart Features
Time Series Axis Formatting
Hide Axis Option
Independent Axis Formatting
Axis Scaling
Pie Slice Formatting
About Gauge Charts
Inserting a Gauge Chart
Applying and Managing Filters
About Pivot Tables
Inserting a Pivot Table
Customizing a Pivot Table Menu
About the Pivot Table Tab
Applying Filters
Customizing the Display of Totals
Converting a Pivot Table to a Chart
Switching Rows and Columns
Customizing the Pivot Table Headers
Customizing the Pivot Table Data
About Text Items
Displaying a Data Field Side-by-Side with a Text Item
About the Text Toolbar
Editing Font Properties
Inserting Page Numbers
Inserting the Date and Time
Inserting a Hyperlink
About Images
About Lists
Inserting a List
Customizing a List
Customizing the Font Style and the Selected Font Style Commands
Customizing Behavior of Selected Items
Setting Predefined or Custom Formulas
About the Predefined Formulas
Applying a Custom Formula
About the Basic Math Functions
About the Statistical Math Functions
Applying a Custom Formula: Examples
Saving a Layout
4
Creating RTF Templates
Getting Started
What Are RTF Templates?
Prerequisites for Designing Templates
What is XSLT Compatibility?
Key Concepts
Designing the Template Layout
About Adding BI Publisher Code
Associating the XML Data to the Template Layout
Using an XML Input File
Identifying Placeholders and Groups
Using Placeholders
Identifying the Groups of Repeating Elements
Adding Markup to the Template Layout
Creating Placeholders
Using the Basic RTF Method
Using the Form Field Method
Completing the Example
Defining Groups
Grouping Scenarios
Using the Basic RTF Method
Using the Form Field Method
Completing the Example
Defining Headers and Footers
Native Support for Headers and Footers
Inserting Placeholders in the Headers and Footers
Creating Multiple or Complex Headers and Footers
Defining Different First Page and Different Odd and Even Pages
Inserting Images and Charts
Directly Inserting Images
Inserting Images with URL References
Inserting Images with an Element Reference from an XML File
Rendering an Image Retrieved from BLOB Data
Adding Charts to Templates
Adding a Sample Chart
Inserting the Dummy Image
Adding Code to the Alternative Text Box
Additional Chart Samples
Horizontal Bar Chart Sample
Changing the Appearance of the Chart
Adding Drawings, Shapes, and Clip Art
Adding Freehand Drawings
Adding Hyperlinks
Layering Shapes
Using 3-D Effects
Adding Microsoft Equations
Adding Organization Charts
Adding WordArt
Adding Data-Driven Shapes
Including Manipulation Commands
Replicating Shapes
Adding Text to Shapes
Adding Text Along a Path
Moving a Shape
Rotating a Shape
Skewing a Shape
Changing the Size of Shapes
Combining Commands
CD Ratings Example
Grouped Shape Example
Supported Formatting Features of Microsoft Word
General Features of Microsoft Word
Aligning Objects
Inserting Tables
Inserting Date Fields
Inserting Multiple Columns on Pages
Inserting Backgrounds and Watermarks
Adding a Background Using Microsoft Word 2000
Adding a Text or Image Watermark Using Microsoft Word 2002 or later
Microsoft Word Features That Are Not Supported
Template Features
Inserting Page Breaks
Inserting an Initial Page Number
Specifying Last Page Only Content
Ending on Even or Odd Pages
Skipping Pages and Page Numbers
Inserting Hyperlinks
Inserting Internal Links
Including a Table of Contents
Generating Bookmarks in PDF Output
Inserting Check Boxes
Inserting Drop-Down Lists
Repeat Row Headers After Page Break
Using Conditional Formatting
Using If Statements
Using If Statements in Boilerplate Text
Using If-Then-Else Statements
Inserting Choose Statements
Conditional Formatting Example
Formatting Columns
Formatting Rows
Highlighting Cells
Inserting Page-Level Calculations
Displaying Page Totals
Inserting Brought Forward and Carried Forward Totals
Inserting Running Totals
Handling Data
Sorting Data
Checking for Null Values
Regrouping the XML Data
XML Sample
Regrouping Syntax
Template Example
Regrouping by an Expression
Setting Variables, Parameters, and Properties
Set Variables
Setting Parameters
Setting Properties
Using Advanced Report Layouts
Creating Batch Reports
Handling No Data Found Conditions
Inserting Pivot Tables
Constructing Dynamic Data Columns
Defining Columns to Repeat Across Pages
Example of Dynamic Data Columns
Formatting Numbers, Dates, and Currencies
Formatting Numbers
Data Source Requirements
Localization Considerations
Using the Microsoft Number Format Mask
Supported Microsoft Format Mask Definitions
Using the Oracle Format Mask
Formatting Dates
Data Source Requirements
Using the Microsoft Date Format Mask
Using the Oracle Format Mask
Default Format Mask
Oracle Abstract Format Masks
Displaying the System Date (sysdate) in Reports
Formatting Currencies
Applying a Currency Format to a Field
Example: Displaying Multiple Currency Formats in a Report
Example: Displaying Multiple Currency Codes in a Single Report
Supporting Calendars and Time Zones
Calendar Specification
Specify Time Zone
Specify No Time Zone Conversion
Using External Fonts
Using the Barcode Fonts Shipped with BI Publisher
Implementing Custom Barcode Formats
Registering the Barcode Encoding Class
Encoding the Data
Controlling the Placement of Instructions Using the Context Commands
Using XPath Commands
Locating Data
Starting Reference
Specifying Context and Parents
Declaring Namespaces
Using FO Elements and XSL Elements
Using FO Elements
Using XSL Elements
Applying a Template Rule
Copying the Current Node
Calling a Named Template
Declaring a Template
Declaring a Variable
Importing a Style Sheet
Defining the Root Element of the Style Sheet
Formatting Native XSL Numbers
Guidelines for Designing RTF Templates for Microsoft PowerPoint Output
Limitations
Usage Guidelines
About Charts in PowerPoint Output
Configuring Fonts for the BI Publisher Server
Configuring Fonts for the
BI Publisher
Template Builder
Guidelines for Designing RTF Templates for Microsoft Excel 2007 Output
Creating Multiple Sheets
Specifying a Sheet Name
Specifying Number and Date Formatting
Rendering HTML Formatted Data in a Report
Supported HTML Features
Data Model Requirements
RTF Template Requirements
Example
Embedding PCL Commands for Check Printing
Procedure Overview
Embedding PCL Commands in RTF Templates
Specifications and Restrictions
2D Barcode Functions
5
Creating RTF Templates Using the Template Builder for Word
Overview
Before You Get Started
Prerequisites and Limitations
Getting Started
Features of the
Oracle BI Publisher
Template Builder for Word
Building and Uploading a Template
Working in Connected Mode
Working in Disconnected Mode
Accessing Data for Building Templates
Loading XML Data from a Local File
Loading Data from the BI Publisher Catalog
Inserting Components to the Template
Inserting a Field
About the Insert Field Dialog
Find
Example
Force LTR (Left-to-Right) Direction
Calculation
Inserting a Table Using the Table Wizard
Step 1: Select Report Format
Step 2: Select Table Data
Step 3: Select Data Fields
Step 4: Group the Table
Step 5: Insert a Break for the Group
Step 6: Sort the Table
Step 7: Click Finish
Step 8: Customize the Table Using Microsoft Word Functionality
Inserting a Table or Form Using the Insert Table/Form Dialog
Selecting Data Fields
Defining the Layout
Data Field Properties
Data Group Properties
Inserting Tables and Forms
Grouping
Understanding Fields Inserted to the Template
Inserting a Chart
Chart Type
Values
Aggregation
Labels
Color
Chart is Inside Group
Style
Properties
Preview
Group Data
Editing an Inserted Chart
Inserting a Repeating Group
Creating Grouping Fields Around an Existing Block
Inserting a Pivot Table
Manually Editing a Pivot Table
Inserting a Pivot Table in a Repeating Group
Inserting and Editing Conditional Regions
Inserting Conditional Formatting
Previewing a Template
Template Editing Tools
Editing and Viewing Field Properties
About the Properties Tab
About the Advanced Tab
About the Word Properties Button
Validating a Template
Using the Field Browser
Checking Accessibility
Uploading a Template to the BI Publisher Server
Using the Template Builder Translation Tools
About Translations
Extracting Text to an XLIFF File for Translation
Previewing the Template and Translation File
Localizing a Template
Setting Options for the Template Builder
Setting UI Options
Setting Preview Options
Setting Build Options
Setting Connection Options
Setting Up a Configuration File
BI Publisher Menu Reference
About the Online Group
About the Load Data Group
About the Insert Group
About the Preview Group
About the Tools Group
About the Options Group
6
Creating Excel Templates
Introduction to Excel Templates
Features of Excel Templates
Limitations of Excel Templates
Prerequisites
Supported Output
Desktop Tools for Excel Templates
Installing the Template Builder for Excel
Sample Excel Templates
Understanding Mappings Between the Template and the Data
Using the Template Builder for Excel
Working in Connected Mode
Logging In Through the Template Builder
Online Features of the Template Builder
Accessing the BI Publisher Catalog from the Template Builder
Uploading Templates from the Template Builder
Working in Disconnected Mode
Obtaining Sample Data
Loading Sample Data in Disconnected Mode
Uploading Templates to the Report
Inserting Fields
More Features of the Field Dialog
Inserting Repeating Groups
Using the Field Browser to View, Edit, and Delete Fields
Previewing Templates
Importing Excel Analyzer Templates
Building a Basic Template Using the Template Builder
Step 1: Load Sample Data to the Template Builder
Step 2: Design the Layout in Excel
Step 3: Use the Template Builder to Insert Fields
Step 4: Use the Template Builder to Insert Repeating Groups
Step 5: Insert the Calculated Salary Field
Step 6: Test the Template
Formatting Dates
Understanding Excel Template Concepts
Mapping Data Fields and Groups
Use of Excel Defined Names for Mapping
Use of "XDO_" Prefix to Create Defined Names
Using Native Excel Functions with the "XDO_" Defined Names
About the XDO_METADATA Sheet
Creating the XDO_METADATA Sheet
Format of the XDO_METADATA Sheet
Hiding the XDO_METADATA Sheet
Using Advanced BI Publisher Functions
Reporting Functions
Splitting Data from Reports into Multiple Sheets
Declaring and Passing Parameters
Defining a Link
Importing and Calling a Subtemplate
Referencing Java Extension Libraries
Formatting Functions That Rely on Specific Data Attribute Values
Defining Border and Underline Styles
Skipping a Row
Grouping Functions
Grouping the Data
Handling the Generated XDO Define Names in Nested Groups
Regrouping the Data
Preprocessing the Data Using an XSL Transformation (XSLT) File
XSLT Preprocessing Examples: Splitting Flat Data into Multiple Sheets
Splitting the Data by a Specific Field
Splitting the Data by Count of Rows
7
Creating PDF Templates
Overview
Requirements
Designing the Template
Adding Markup to the Template
Creating a Placeholder
Naming the Placeholder
Creating a Text Placeholder
Supported Field Properties Options
Creating a Check Box
Creating a Radio Button Group
Defining Groups of Repeating Fields
Repeating a PDF Template by Using the document-repeat-elementname Form Field
Adding Page Numbers and Breaks
Adding Page Numbers
Adding Page Breaks
Performing Calculations
Completed PDF Layout Example
Runtime Behavior
Placement of Repeating Fields
Setting Fields as Updatable or Read Only
Overflow Data
Creating a Layout from a Predefined PDF Form
Determining If a PDF Has Form Fields Defined
Using a Predefined PDF Form as a Layout by Renaming the Form Fields
Using the Comb of Characters Option
Adding or Designating a Field for a Digital Signature
About Signature Field Options
Adding a Signature Field
Configuring the Report to Insert the Digital Signature at Runtime
PDF Template Limitations
8
Creating eText Templates
Overview
Prerequisites
Structure of eText Templates
Command Rows, Data Rows, and Data Column Header Rows
Data Column Header Rows
Data Rows
Constructing the Data Tables
Command Rows
Level Command
New Record Command
Sort Ascending and Sort Descending Commands
Display Condition Command
Structure of the Data Rows
Position
Length/Maximum Length
Format Column
Number Data Type
Date Data Type
Mapping EDI Delimiter-Based Data Types to eText Data Types
Pad
Data
Tag
Comments
Setting Up Command Tables
TEMPLATE TYPE Command
DEFINE LEVEL Command
DEFINE SEQUENCE Command
RESET AT LEVEL
INCREMENT BASIS
MINIMUM
Define Concatenation Command
Base Level Subcommand
Element Subcommand
Delimiter Subcommand
Using the SUBSTR Function
Invalid Characters and Replacement Characters Commands
Output Character Set and New Record Character Commands
Output Length Mode
Number Thousands Separator and Number Decimal Separator
CASE CONVERSION
Creating a Filler Block
Expressions, Control Structures, and Functions
Expressions
Control Structures
Functions
Identifiers, Operators, and Literals
Key Words
Command and Column Header Key Words
Command Parameter and Function Parameter Key Words
Field-Level Key Words
Expression Key Words
Operators
Reference to XML Extract Fields and XPATH Syntax
Notes on Viewing eText Output from a Browser
9
Creating Flash Templates
Overview
Prerequisites for Building and Viewing Flash Templates
Required Configuration Settings for Viewing PDF Output
Building a Flash Template
Adding the Data Source
Creating the Layout
Adding a Chart
Binding the Layout Objects to the Data Source
Binding the DataGrid
Binding the Chart
Uploading the Flash Template to the Report Definition
Setting Properties for PDF Output
10
Setting Report Processing and Output Document Properties
Overview
PDF Output Properties
PDF Digital Signature Properties
PDF Accessibility Properties
PDF/A Output Properties
PDF/X Output Properties
DOCX Output Properties
RTF Output Properties
HTML Output Properties
FO Processing Properties
RTF Template Properties
PDF Template Properties
Flash Template Properties
CSV Output Properties
Excel Output Properties
All Outputs Properties
Define Font Mappings
Make Fonts Available for Publishing
Set Font Mapping at the Site Level or Report Level
Create a Font Map
Predefined Fonts
Part II Creating Style Templates and Subtemplates
11
Creating and Implementing Style Templates
Understanding Style Templates
About Styles Defined in the Style Template
Style Template Process
Creating a Style Template RTF File
Defining Styles for Paragraphs and Headings
Defining Styles for Tables
Defining a Header and Footer
Uploading a Style Template File to the Catalog
Assigning a Style Template to a Report Layout
Updating a Style Template
Adding Translations to a Style Template Definition
12
Understanding Subtemplates
What is a Subtemplate?
About RTF Subtemplates
About XSL Subtemplates
Supported Locations for Subtemplates
Testing Subtemplates from the Desktop
Uploading a Sub Template
Calling a Subtemplate from an External Source
Importing a Subtemplate Outside the Catalog over HTTP or FTP
Importing Subtemplates Outside the Catalog on the Same Server
Required Settings To Run Sub Templates Stored Outside the Catalog
13
Designing RTF Subtemplates
Understanding RTF Subtemplates
Process Overview for Creating and Implementing RTF Sub Templates
Creating an RTF Subtemplate File
Calling a Subtemplate from a Main Template
Importing the Subtemplate to the Main Template
Calling the Subtemplate to Render Its Contents
Importing a Localized Subtemplate
Example
When to Use RTF Subtemplates
Reusing a Common Layout
Conditionally Displaying a Layout Based on a Value in the Data
Example
Conditionally Displaying a Layout Based on a Parameter Value
Example
Handling Simple Calculations or Repeating Formulae
Example
Adding Translations to an RTF Subtemplate
14
Designing XSL Subtemplates
Understanding XSL Subtemplates
Where to Put XSL Code in the RTF Main Template
Process Overview for Creating and Implementing XSL Sub Templates
Creating an XSL Subtemplate File
Calling an XSL Subtemplate from the Main Template
Importing the Subtemplate
Calling the Subtemplate
Passing Parameters to an XSL Subtemplate
Creating the Sub Template Object in the Catalog
Example Uses of XSL Subtemplates
Handling XML Data with HTML Formatting
Dynamically Applying Formatting to a Portion of Data
Part III Translating Reports and Catalog Objects
15
Translation Support Overview and Concepts
Translation Support Overview
What Is Catalog Translation?
What Is Template Translation?
About Supported Languages
Working with Translation Files
What Is an XLIFF?
Structure of the XLIFF File
Source-language and target-language Attributes
Embedded Data Fields
<source> and <target> Elements
Locale Selection Logic
16
Translating Individual Templates
Overview
Types of Translations
Using the XLIFF Option
Generating the XLIFF from a Template
Generating the XLIFF from the Template Builder
Generating the XLIFF from the Layout Properties Page
Translating the XLIFF
Uploading the Translated XLIFF to BI Publisher
Using the Localized Template Option
Designing the Localized Template File
Uploading the Localized Template to BI Publisher
17
Translating Catalog Objects, Data Models, and Templates
Overview
What Can Be Translated?
About Source Language Limitations
Exporting the XLIFF File
Identifying and Updating the Object Tags
Importing the XLIFF File
Part IV Reference Information
A
Techniques for Handling Large Output Files
Reusing Static Content
What Is Static Content Reuse?
Limitations of this Feature
Defining Reusable Content in an RTF Template
Example
Generating Zipped PDF Output
Limitations and Prerequisites
Design Time Considerations
Selecting the Output Type
Implementing PDF Splitting for an RTF Template
Entering the Commands in an RTF Template
Example - split by each department
Implementing PDF Splitting for a PDF Template
Entering the Commands in the PDF Template
B
Extended Function Support in RTF Templates
Extended SQL and XSL Functions
Number-To-Word Conversion
XSL Equivalents
Using FO Elements
C
Designing Accessible Reports
Designing for Accessibility
Obtaining General Information
Avoiding Common Misconceptions
Following General Guidelines for Accessible Content
Color Selection
Using Color with Text
Color Contrast
Font Selection
Using the Template Builder to Verify Report Accessibility
Designing Accessible Reports Using RTF Templates
Avoiding Nested Tables or Separated Tables
Examples
Nested Tables
Table Headers Must Not Be Separated from the Table Body
Defining a Document Title
Defining Alternative Text for an Image
Defining a Table Summary
Defining a Table Column Header
Defining a Table Row Header
Sample Supported Tables
Converting Charts to Tables
Designing Accessible Reports Using
BI Publisher
Layouts
Defining Document Titles
Defining Alternative Text for Images
Defining Summary Text for Tables
Defining Table Row Headers
Defining Text Header Levels
Defining a Layout Table
D
Supported XSL-FO Elements
Supported XSL-FO Elements
Property Groups Table
E
Generating PDF/A and PDF/X Output
Generating PDF/A Output
Requirements and Limitations
Additional Resources
Generating PDF/X output
Prerequisites
Requirements and Limitations
Additional Resources
F
Generating Accessible PDF Output
Configuring Accessible PDF Output for Reports
G
Generating CSV Output
H
PDF Version Support
About PDF Version Support
Supported Utilities
Limitations
Limitations That Apply to All PDF Utilities
FormProcessor Limitations
PDFDocMerger and PDFBookBinder Limitations
PDFSignature Limitations
I
Using the Customize Feature
About Customizing Reports
Prerequisites and Limitations of the Customization Feature
Prerequisites
Limitations
Using the Customize Feature
Considerations When Using the Customize Feature
J
Testing Templates with Template Viewer
About Template Viewer
Debugging Templates
Monitoring Memory Usage
Profiling XSLT
Validating XML Documents
Testing Fonts
Scripting on this page enhances content navigation, but does not change the content in any way.