bi publisher report development process

8/12/2019 BI Publisher Report Development Process

1/20

Restricted

BI Publisher Report Development

Process

Published date 12/06/2014 (World Cup Kickoff :)

Version 0.1

Dinesh Chauhan


2/20

Restricted

Version Control

Version Updated By Date Updated Updates

0.1 Dinesh Chauhan Document creation

Document Review

Reviewed By For Review For Info Date Reviewed Status


3/20

Restricted Page 3 of 20

Document1

Table of Content

1. Introduction .......................................................................................................................................... 4

2. BI Publisher Report Request Process ................................................................................................. 5

1.1 Steps for BI Publisher Report request creation & development process ............................................ 51.2 Flow for BI Publisher Report request creation & development process .............................................. 6

3. Design Elements of BI Publisher Reports ........................................................................................... 7

3.1 Presentation Templates ...................................................................................................................... 7

3.1.1 Sample Presentation Templates...................................................................................................... 8

3.2 Data Template ................................................................................................................................... 11

4. Report Development Process ........................................................................................................... 12

4.1 Configuring Data Connection ........................................................................................................ 12

4.2 Defining Data Model...................................................................................................................... 14

4.3 Creating Presentation Template................................................................................................... 17


4/20


Document1

1. Introduction

Purpose of this document is to define a process which primarily used by business user for requesting apixel perfect report and developers/business analysts to use Oracle Business Intelligence Publisher to

design/develop that report. This document will go into low level details but would not define best practices,development or naming standards etc. This document will give design example of Customer Invoicewhich isbased on a real-world Company reporting scenario, but should be seen merely as a design format and content

example and not as actual design.

Oracle Business Intelligence Publisher is the reporting solution to author, manage, and deliver reports

and documents easier and faster than traditional reporting tools. It can be used to create everything from pixel-perfect customer facing documents to operational, financial or interactive management reports against practicallyany data source. It uses web browser or desktop tool to build reports. These reports can be viewed online orschedule and delivered to customer/management inbox.

Oracle BIP is built to provide a central architecture for generating and delivering data and information to

employees, consumers and business partners in your company's internally agreed format. It is a hot pluggableapplication that means it can connect to any existing/new data source that provides JDBC connection. It canaccess relational, OLAP, web services, HTTP XML feeds, file data and other data sources.

BIP works on a concept where it separates data from presentation templates. At run times it merges datawith template that means if required same data can be represented in different formats/brands. It can producereports in PDF, Excel, RTF, HTML, or electronic transfer documents. BIP can be used as central reporting systemwhere reporting formats can be standardised and data from multiple sources can be accessed to build reports.Oracle Business Intelligence Publisher is pre-integrated with Oracle so it works consistently with Oracle BusinessIntelligence Suite Enterprise Edition Plus and Oracle E-Business Suite.


5/20


Document1

2. BI Publisher Report Request Process

Given here is an overview of the request process for creating new reports. On a high level, the request processconsists of the following steps:

1.1 Steps for BI Publisher Report request creation & development process

Request :

1. World Pay user raises initial request through JIRA ticket2. Report request form completed

Gap analysis:

3. Reports list checked for currently existing reports that satisfy request4. If matching report found user is intimated with existing report5. If no matching report found, requirements evaluated to see if Data source already exist or require new datasource configuration

Formal CR:

6. CR raised to configure any new data source7. CR to build new report

Implementat ion and Test ing/QA:

8. Report development in DEV9. Report migrated to System Test10. Report tested for UAR11. Report tested for QA

Deployment:

12. On completion of successful testing, time is agreed to propagate changes to production and report ispromoted to production.

13. JIRA ticket closed.

(Steps 1 ,6 and 7 are yet to be confirmed.)


6/20


Document1

1.2 Flow for BI Publisher Report request creation & development process

N

StartRaise JIRA ticket & complete request form for

new report

Has Required

Data fields &

template

attached?

2

2

Does

Requirement

Matches existing

Report?

Y

Inform user about existing reportY

Stop

Does new

data sourceconfigurationrequired?

Configure New data source in

BIP

N

Y

Build Report

N

Raise CR to create new report

Unit/System/User acceptance test

Promotion to Production

JIRA Ticket Closed

Stop

Raise CR to configure new data

source in BIP

QA Check


7/20


Document1

3. Design Elements of BI Publisher Reports

BI Publisher separates the creation of data from the process of formatting it for different uses. The BIPengine can format any well-formed XML data, allowing integration with any system that can generate XML,including Web Services or any data source available. BI Publisher can merge multiple data sources into a singleoutput document.

This provides several advantages

The same data file can be used for multiple reports

Output can be set to be Word, PDF, Excel, XBRL, XML without changing program that extracted the data

Anybody proficient in Word, Excel can design the output

The program that produces the XML file is called the Data Template. The portion of BI Publisher that takes theXML file as input and creates the report is the Report Template or Presentation Template.

3.1 Presentation Templates

Presentation Templates can be created with common desktop tools like Microsoft Word, Adobe or via webbrowser in OBI layout editor. For desktop tools Oracle provides a plug-in called template builder which enable userto create presentation templates. BI Publisher works with Ms Office 2007 and 2010. One can down load TemplateBuilder from following Oracle link

http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html

The Template Builder supports special formatting such as logos, charts and graphs, tables, and bar Codes. Italso supports the use of any special formatting offered by Word or Adobe. The Processing Engine supportsmultiple methods of report delivery such as print, fax, email, and web. Reports can be burst according to yourdefined criteria and each section delivered to a different person.

The following picture shows just a few of the formats that you can produce using the Template Builder.
http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.htmlhttp://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.htmlhttp://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html


8/20


Document1

3.1.1 Sample Presentation Templates

Following is the sample presentation template which end user needs to create and send it to developer toshow how exactly they want to create report.

< -----------------------------------------Document Header --------------------------------------------- >

Invoice

0000/0

0001

Invoice Number Our VAT Reg Number

Invoice Date

Charges for

Page

Your VAT Reg Number

Your Store Reference

Your Merchant ID

Store Trading Name

If you have any queriesPlease contact us on

Charges Summary ChargeAmount Transaction Charges

Transaction Charges-

Premium Charges

Miscellaneous Charges

Total Charges

VAT

Total DueThe amount shown will be debited from account no. xxxxxxxx

at branch zz-zz-zz on or after dd month year

VAT Analysis VatCodeNet

Amount VAT Rate Vat

Amount

S Standard


9/20


Document1

E Exempt

Total VAT

Marketing Box Targeted Merchant Messages

TXNs Acquired by Company Number ofTransactions

Charge PerTransaction p

Value ofTransactions

TransactionCharge Rate

TransactionCharges

VATCode

TXN-Type TransactionCategory

CategoryCount

Category-Charge-Per-Transaction

Category-Value

Category-Value-Rate

Total-Category-Charges

VATCode

Transaction

Category

Category

Count

Category-

Charge-Per-Transaction

Category-

Value

Category-

Value-Rate

Total-

Category-Charges

VAT

Code

(If more thanone category)

TXN-TypeCount

TXN-TypeTotal Value

TXN-TypeTotalCharges


CategoryCount


Category-Value

Category-Value-Rate


VATCode

TransactionCategory

CategoryCount


Category-Value

Category-Value-Rate


VATCode

(If more than

one category)

TXN-TypeCount

TXN-TypeTotal Value

TXN-TypeTotal

Charges


CategoryCount


Category-Value

Category-Value-Rate


VATCode

TransactionCategory

CategoryCount


Category-Value

Category-Value-Rate


VATCode

(If more thanone category)

TXN-TypeCount

TXN-TypeTotal Value


TotalCount

TotalValue

Total-Charges

VATCode

TXNs Acquired by OtherAcquirers

Number ofTransactions

Charge PerTransaction



TransactionCharges

VATCode


CategoryCount


Category-Value

Category-Value-Rate


VATCode

TransactionCategory

CategoryCount


Category-Value

Category-Value-Rate


VATCode

(If more thanone

TXN-TypeCount

TXN-TypeTotal Value



10/20


Document1

category)


CategoryCount


Category-Value

Category-Value-Rate


VATCode

TransactionCategory

CategoryCount


Category-Value

Category-Value-Rate


VATCode

(If more thanonecategory)

TXN-TypeCount

TXN-TypeTotal Value



CategoryCount


Category-Value

Category-Value-Rate


VATCode

TransactionCategory

CategoryCount


Category-Value

Category-Value-Rate


VATCode

(If more thanonecategory)

TXN-TypeCount

TXN-TypeTotal Value


TotalCount

Total Value Total-Charges

VATCode

Miscellaneous Charges Number orValue

Charge Rate ChargeAmount

VATCode

Charge-Category e.g. 1 10.00 10.00 VatCode

Charge-Category 10.00 e.g. One-Off

10.00 VatCode

Charge-Category 20.00 e.g perMonth

20.00 VatCode

Batch Totals Batch Start Reference Gross Value

Adjustment Net Value

Batch Date Batch Reference BatchValue

AdjustmentValue

Net Value

Batch Date Batch Reference BatchValue

AdjustmentValue

Net Value

Batch totals do not include TXNs processed for other acquirers

Premium Charges Number ofTransactions

Charge PerTransaction p



TransactionCharges

VATCode

Charge-Category CategoryCount


Category-Value

Category-Value-Rate


VATCode

Charge-Category CategoryCount


Category-Value

Category-Value-Rate


VATCode

< -----------------------------------------Document Footer --------------------------------------------- >


11/20


Document1

3.2 Data Template

The data template is the XML document whose elements communicate the following information to thedata engine.

Parameters: Definition of each parameter defined in the query.

Data Query: The SQL query with bind parameter specifying the data to be fetched.

Data Structu re: Definition of the Output XML Structure.

Data Triggers: Triggers that should be executed before or after the data query execution.

Triggers are used to either do initialization or do some post query operation.

As shown in the sample figure above, data template contains the element where we define the name ofthe template and description. The next element set is the parameters section. In this section we definethe names, data types and possible default values for parameters used in our query. The data queryblock contains the sql-statement block where SQL query is defined. Optionally we can define the triggers

that are executed before or after the data query execution. The data structure block defines the outputcolumns of the data


12/20


Document1

4. Report Development Process

4.1 Conf igur ing Data Connect ion

BI Publisher supports a variety of data sources. The data can come from a database, an HTTP XML feed,a Web service, an Oracle BI Analysis, an OLAP cube, an LDAP server, or a previously generated XMLfile or Microsoft Excel file.

To setup a data source we need to choose Administ rat ionlink found in the upper-right corner of any ofthe BIP interface

On clicking Administ rat ionlink we will get following administration page.

BIP provides connection to following data sources.

Java Database Connectivity (JDBC)

Java Naming and Directory Interface (JNDI)

Lightweight Directory Access Protocol (LDAP)

Online Analytical Processing (OLAP)

File


13/20


Document1

In following section we will discuss JDBC connection which is simple connection to database.

The JDBC driver for the selected database must be available to BI Publisher. If you are using an Oracledatabase or one of the DataDirect drivers provided by WebLogic Server, then the drivers must beinstalled in the correct location and there is no further setup required.

To set up a JDBC connection to a data source:

1. From the Administration page click JDBC Connection to display the list of existing JDBC connections.

2. Click Add Data Source.

3. Enter the following fields for the new connection:

Data Sourc e Name- Enter a display name for the data source. This name is displayed in the DataSource selection list in the Data Model Editor.

Driver Type- Select the database type from the list. When you select a driver type, BI Publisherautomatically displays the appropriate Database Driver Class and provides the appropriateConnection String format for your selected database.

Database Driver Class - This is automatically entered based on your selection for Driver Type.You can update this field if desired.

Connect ion Str ing - Enter the database connection string.When you select the driver type, thisfield automatically displays the appropriate connection string format for your database type.For anOracle database the connect string must have the following format:

jdbc:oracle:thin:@[host]:[port]:[sid]

e.g: jdbc:oracle:thin:@myhost.us.example.com:1521:prod

Use System User- This is reserved for connections to the Oracle BI Server.

User Name- Enter the user name required to access the data source on the database.

Password- Enter the password associated with the user name for access to the data source onthe database.

Pre Process Function and Post Process Function- (Optional) Enter a PL/SQL function toexecute when a connection is created (Pre Process) or closed (Post Process).

Use Proxy Auth ent icat ion- Select this box to enable Proxy Authentication.

4. Click Test Connection. A confirmation is displayed.


14/20


Document1

4.2 Defining Data Model

First step in creating BI Publisher report is to create Data Model (Data Template). As discussed above, BIpublisher can source data from variety of sources. In example below we will use Oracle Database tosource data. We will use tables from OE schema to create sales report.

Click NewData Model

We will get to Data model editor shown below. In here we will be creating one or more data sets.

Click on New Data Set SQL Query


15/20


Document1

Name the SQL Query to Sales Reportand select data source as demo which we configured earlier.

Click on Query Builder

Select the required tables. Join them by dragging FK columns, select the column by checking them and

hit the Save button.


16/20


Document1

Query builder will make required SQL for us.

Press OK and save data model. This will create datamodel for is.

In Data Model you can define multiple data sets from different sources and combine them together. Itprovides tabs, called Diagram, Structure, Dataand Code where we can fine tune the column e.g.change business names for the columns etc. Also we can define derived columns, group filters orgroup/report level aggregates etc. Detail discussion about the Data Model editor is beyond the scope ofthis document; however one can refer to Oracle documentations for further details.

http://www.oracle.com/technetwork/middleware/bi-foundation/documentation/bi-pub-096318.html
http://www.oracle.com/technetwork/middleware/bi-foundation/documentation/bi-pub-096318.htmlhttp://www.oracle.com/technetwork/middleware/bi-foundation/documentation/bi-pub-096318.htmlhttp://www.oracle.com/technetwork/middleware/bi-foundation/documentation/bi-pub-096318.html


17/20


Document1

4.3 Creating Presentation Template

To create a presentation template we need a sample data. We can collection sample data from DataModel which we have built earlier.

Go to data tab of the Data Model. Select number of rows you need for sample data and hit Save AsSample Data button. This will save the sample data which will be available to us when creatingpresentation template.

We discussed earlier that presentation template can be created through desktop tool like MS-Word orusing web browser. In this document we will use online method i.e. template will be created directly in

BI Publisher server.

Select NewReport

This will launch a wizard which will guide us through the template creation process.

Click Data Model and select data model which we saved earlier. And then click next.


18/20


Document1

Select Appropriate options for layout


19/20


Document1

Select the chart type and drop appropriate values to the labels.

In next step select appropriate columns which should appear in tabular report.


20/20

Finish the wizard and save the layout and view the report. Report will look like this.

This report can be exported to PDF, PowerPoint and Excel etc. for further distribution.

Note: As discussed presentation template can also be built offline on desktop tools like MS-Office. Pleasefollow link below which has detailed instruction to install the plugin and use MS-Word to developpresentation template.

http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm
http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htmhttp://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htmhttp://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm

bi publisher report development process

Documents