109
Oracle BI Publisher for Beginners Oracle BI Publisher for Beginners Oracle BI Publisher for Beginners Oracle BI Publisher for Beginners TABLE OF CONTENTS 1. INTRODUCTION 6 2. INSTALLATION OF ORACLE BI PUBLISHER 6 3. GETTING STARTED 7 3.1. Logging In to Oracle BI Publisher 7 3.2. Creating new Folder 8 3.3. JDBC Connectivity 9 4. CREATION OF SIMPLE ORACLE BI REPORTS IN VARIOUS OUTPUT FORMATS 11 4.1. Viewing the Report in XML format 11 4.1.1 Creating new Report 11 4.1.2 Creating new Data Model 11 4.2. Viewing the Report in Different formats 13 4.2.1 Creating Default Template 13 4.2.2 Viewing the output in Default Template 14 4.3 Creation of RTF Template 15 4.3.1 Uploading the RTF Template 24 4.3.2 Viewing the output in HTML format 25 5 CREATION OF REPORT USING E-TEXT TEMPLATE 25 5.1 Creating a e-text Template 25 5.2 Uploading the eText Template 27 5.3 Viewing the Output 27 6 CREATING REPORT LAYOUTS USING BI PUBLISHER DESKTOP 28 6.1 Creating a new Report 28 1

Oracle BI Publisher for Beginners

Embed Size (px)

Citation preview

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners TABLE OF CONTENTS

1. INTRODUCTION 6

2. INSTALLATION OF ORACLE BI PUBLISHER 6

3. GETTING STARTED 7

3.1. Logging In to Oracle BI Publisher 7

3.2. Creating new Folder 8

3.3. JDBC Connectivity 9

4. CREATION OF SIMPLE ORACLE BI REPORTS IN VARIOUS OUTPUT FORMATS 11

4.1. Viewing the Report in XML format 114.1.1 Creating new Report 114.1.2 Creating new Data Model 11

4.2. Viewing the Report in Different formats 134.2.1 Creating Default Template 134.2.2 Viewing the output in Default Template 14

4.3 Creation of RTF Template154.3.1 Uploading the RTF Template244.3.2 Viewing the output in HTML format 25

5 CREATION OF REPORT USING E-TEXT TEMPLATE 25

5.1 Creating a e-text Template 25

5.2 Uploading the eText Template 27

5.3 Viewing the Output 27

6 CREATING REPORT LAYOUTS USING BI PUBLISHER DESKTOP 28

6.1 Creating a new Report 28

6.2 Creating Query using Query Builder 28

6.3 Creating a RTF Template using Table 296.3.1 Publishing the template for a BI Publisher Report 31

1

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

6.4 Creating a RTF Template for building Charts 336.4.1 Publishing multiple templates for a BI Publisher Report 336.4.2 Alternative method to upload a template 36

6.5 Creating a RTF Template for building Pivot Table 386.5.1 Publishing multiple templates for a BI Publisher Report 38

7. CREATION OF REPORT USING DRILLDOWN 41

7.1 Creation of Summary Report 417.1.1 Defining Data Model 417.1.2 Creating and Uploading RTF Template 42

7.2 Creation of Detail Report 457.2.1 Defining Data Model 467.2.2 Defining Parameter 477.2.3 Creation of RTF Template 487.2.4 Publishing the template for a BI Publisher Report 50

7.3 Drilldown from Summary to Detail report 537.3.1 Inserting Hyperlink 537.3.2 Defining Parameter in RTF template 54

8. CREATING REPORTS WITH GROUP BY FUNCTION 56

8.1 Creating a new Report 568.1.1 Creating a new Data Model 578.1.2 Creating Query using Query Builder578.1.3 Creating Report Layout using BI Publisher Desktop in MS Word 60

8.2 Creating a new Report with Grand Total 668.2.1 Creating a Layout 668.2.2 Creating a RTF Template 678.2.3 Uploading the RTF Template688.2.4 Viewing the Output 68

9 CREATION OF REPORTS WITH PARAMETERS 70

9.1 Creating a new Report with Default Parameter 709.1.1 Creating a new Parameter 709.1.2 Viewing the Output 73

9.2 Creating a new Report with Parameter type-Text 739.2.1 Creating a new Parameter 739.2.2 Viewing the Output 76

9.3 Creating a new Report with Parameter type-Date 769.3.1 Creating a new Parameter 769.3.2 Viewing the Output 79

9.4 Creating a new Report with Hidden Parameter 809.4.1 Creating a new Parameter 809.4.2 Viewing the Output 82

2

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9.5 Creating a new Report with Parameter type-Menu & LOV 829.5.1 Creating a new LOV 829.5.2 Creating a new Parameter 859.5.3 Viewing the Output 88

10 SCHEDULING BI PUBLISHER REPORTS 90

10.1 Configuring the BI Publisher Scheduler 90

10.2 Scheduling a Report 93

10.3 E-Mail Server Configuration 97

10.4 Scheduling Report to deliver output via Mail 98

11 BURSTING BI PUBLISHER REPORTS 101

11.1 Scheduling a report to burst to a file location 10111.1.1 Bursting the Report to a shared Location 101

11.2 Scheduling a report to burst to a e-Mail 10611.2.1 Creating new Report 10611.2.2 Bursting the Report 10611.2.3 Viewing the Report 108

12 SAMPLE TEMPLATES. 109

1. Introduction

This document describes how to generate various types of reports using Oracle BI Publisher. The

output format for the reports can be designed using Microsoft word or Adobe Acrobat tools. Oracle BI Publisher

allows creating reports from various data sources. The detailed steps for creating various reports using Oracle

BI Publisher are discussed in detail in the forthcoming sections.

2. Installation of Oracle BI Publisher

Before starting, we need to have access to or must have installed the following:

Oracle Database 10g

Oracle BI Publisher 10.1.3.3 or above

Oracle BI Publisher Desktop

Oracle BI Publisher Desktop can be installed later by clicking the Template Builder Link in BI Publisher

after logging into BI Publisher.

3

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

After successful installation, the BI Publisher menu and BI Publisher toolbars are displayed in the MS

Word.

3. Getting Started

3.1. Logging In to Oracle BI Publisher

Logon to BI Publisher

If you have installed BI Publisher along with Oracle BI Enterprise Edition, then you can select All

Programs > Oracle Business Intelligence > BI Publisher from the Start menu

4

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Otherwise use the URL for BI Publisher in a browser window which is of the format

http://<hostname>:<port>/xmlpserver/

(For example, http://chnmct139034d:9704/xmlpserver/)

Logon to BI Publisher with username and password credentials.

This displays the Welcome screen for BI Publisher.

5

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Note: As you have logged in as the Administrator, the welcome page displays the Reports, Schedules,

and Admin tabs. For the users who do not have administrator privileges, the Admin tab will not be

displayed.

3.2. Creating new Folder

Create a new Folder with in My Folders or Shared Folders or Users as required.

3.3. JDBC Connectivity

Click the Admin tab. Click JDBC Connection found under the Data Sources section of the page.

6

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

In the JDBC Data Sources screen that is displayed click the Add Data Source to create a new data

source.

In the Update Data Source screen, enter the following details:

Connection String: This is of the format: jdbc:oracle:thin:@<Host name>: <Port>:<SID>,

for example, a sample connection string may look like:

jdbc:oracle:thin:@myhost:1521:orcl

Username & Password: Provide the credentials

Database Driver Class: oracle.jdbc.driver.OracleDriver (This is the default.)

7

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

After entering the above details, click Test Connection.

A confirmation message will be displayed, saying ‘Connection established successfully’, then click Apply to

save the connection details.

Click Reports tab to go back to the Reports page.

4. Creation of Simple Oracle BI Reports in various output formats

Before you create a query based on Oracle Database, you need to define the connection as explained

above.

You can also add a new data source and define the connection details.

To create a BI Publisher report based on a query directed to Oracle Database, perform the following

steps:

4.1. Viewing the Report in XML format

In this section, we can learn how to view the reports in XML format. In the forthcoming sections we can learn

how to view the reports in various formats.

4.1.1 Creating new Report

Create a new report ‘Department_Details’ inside the created folder ‘BI_Publisher_LabGuide’

8

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click on Edit link mentioned below to create the report

4.1.2 Creating new Data Model

Select Data model New

Enter the data model name select the type as SQL Query

Choose the data source

9

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Write the SQL Query

SQL query can also be generated using SQL Builder which is discussed in the next example.

Save the report

View the report

The output could be viewed only in the data format, as we have not created any template for the report.

Click the view button to view the output. The output generated will be in the form of XML.

10

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

You can also edit the report by clicking the Edit link.

After editing, Save the report and view it as we have discussed already.

4.2. Viewing the Report in Different formats

Here we can view the above created report in various formats using Template.

4.2.1 Creating Default Template

Select the Layouts, and click the Generate button to create a new RTF template based on the default

data model.

A default template (New_Template.rtf) will be generated.

11

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Save the report.

Output is shown below with the generated default template.

The output could be viewed in different formats.

4.2.2 Viewing the output in Default Template

By clicking view one can see the output using default template.

Similarly we can view the report in various formats by selecting the desired output format.

12

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

4.3 Creation of RTF Template

Open a word document and select Add-Ins->Oracle BI Publisher and log into by giving username and password.

Select the table for which the template is going to be created.

13

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select Insert->Table Wizard

Select ‘Table’ and click on ‘Next’

14

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select the fields to be displayed and move them to right side.

15

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

If you don’t want to display a field, move them to left and you can also sort them by clicking up or down

button.

If one needs Group by function then you can select the column to be grouped.

Click next.

If one need to sort a column then select the column to be sorted .Click next.

16

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

If you need to change the labels of a field, it can be done here. Click Finish and save the template.

The heading for the report can be given in the Header and page number in the footer.

17

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Double click on the Emp No field, to change the field properties.

Double click on Ename and go to Properties tab and click on Word Properties.

18

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

In word properties, select the text format. Also the Maximum length can be specified, if needed.

Similarly double click on date and select the date type and date format if needed.

19

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select the row and right click →Borders and Shading→ Shading.

Select the color, go to apply to column and select cell and give ok.

20

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

The final template is shown.

4.3.1 Uploading the RTF Template

Now upload the created template by using the option ‘Browse and upload’ in BI Publisher.

Save the changes.

4.3.2 Viewing the output in HTML format

The output can be seen by clicking on View.

21

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Similarly the report can be viewed in various other formats available in the dropdown list.

5 Creation of report using e-text Template

5.1 Creating a e-text Template

e-text Template are used to generate report output in text format

Open a sample e-text template.

Give ‘ROWSET ‘for the level.

Enter the column names to be displayed within quotes.

Give the format as ‘Alpha’.

Select a delimiter to separate the column.

22

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Give ‘ROW ‘for the level.

Enter the column names as it from the query.

Give the suitable format for each column.

Select a delimiter to separate the column.

5.2 Uploading the eText Template

23

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Now upload the created template by using the option ‘Browse and upload’ in BI Publisher.

Save the changes.

5.3 Viewing the Output

Click ‘View’ the see the output.

6 Creating Report Layouts using BI Publisher Desktop

6.1 Creating a new Report

Create a new report ‘Employee_Location_Details’ inside the created folder ‘BI_Publisher_LabGuide’(

Refer

Section 4 for detailed steps for creating a new report)

24

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click on Edit link mentioned below to modify the report.

Create a new Data model ‘Employee_Location’

Select the type as SQL Query

Choose the data sources and click the Query Builder button.

6.2 Creating Query using Query Builder

Select the table ‘EMP’ and ‘DEPT’ and check the required fields.

Define a join between these two tables as follows:

Click the box beside the DEPTNO column in the DEPT table. (See the following screens.)

Similarly click the box beside the DEPTNO column in the EMP table.

These boxes when marked for joins turn to light gray.

Also note that a fine line joining the tables appears in the Model canvas.

25

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

This is the result for the generated SQL.

Save the report

6.3 Creating a RTF Template using Table

Create a new template from MS word (Refer section 4.3 for detailed steps)

From MS Word application, log in to BI Publisher.

26

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

This displays the Open Template window. Ensure that BI Publisher is selected from the Workspace

drop-down list

Navigate and select the Employee_Location_Details report that you have created from My Folders>

BI_Publisher_LabGuide. Click Open Report.

Navigate and select the Employee_Location_Details report that you have created from My Folders>

In the Word document that loads this report, select Insert> Table Wizard on the BI Publisher

toolbar to define a

format for the table data in the query.

Create a template as given below:

Change the format for the Hire Date data field to ‘Date’ type and format to ‘d-MMM-yy’

Insert header and footer for the created report.

The template designed should look like as shown below.

27

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

6.3.1 Publishing the template for a BI Publisher Report

After making the necessary changes, upload the template by selecting Add-Ins->Oracle BI Publisher-

>Upload Template As

A dialog box opens prompting to save the template in RTF. Click OK.

Save the template in Rich Text Format

28

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

A dialog box pops, asking for the Template name. Enter the Template name. The same name will be

displayed in the BI Publisher screen.

After successfully uploading, a dialog box pops stating that the template has been added to the

report. Click OK.

Check for the uploaded template in the BI Publisher Report.

29

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Save the report and view the output. You can see the template name as the name uploaded from MS

Word. View the output in different format.

6.4 Creating a RTF Template for building Charts

Here we create a new template for creating chart and upload it in the same

Employee_Location_Details report.

6.4.1 Publishing multiple templates for a BI Publisher Report

Create a new template design to view details in Pie Chart.

(If not already opened) Open the BI Publisher report or else log in to BI Publisher.

In MS Word, select the BI Publisher> Open Template option.

Open the report from the path My Folders>BI_Publisher_LabGuide.

30

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

In the Word document that loads this report, select Insert> Chart on the BI Publisher toolbar to

define a format for the table data in the query.

Drag and drop the Ename for Values and Loc for Labels. Give an appropriate title.

There are various types of charts available like Bar graph, Pie Chart, Line Graph, Area Graph, Ring

Graph, Pareto Graph, Radar Graph etc. Select the one needed.

After choosing the type, select the style.

31

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

See the preview by clicking the Preview button.

Include headers and footers as shown below.

32

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

6.4.2 Alternative method to upload a template

Template can also be uploaded from the BI Publisher. Browse the RTF template that has been saved

and upload it into the BI Report by clicking the upload button as shown below.

Create a new Layout by selecting Layouts -> New

33

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Enter the layout name and select the template, template type and output format.

Save the report and view the output. You can see the template name as the name uploaded from MS

Word.

34

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

6.5 Creating a RTF Template for building Pivot Table

Here we create a new template for building Pivot table and upload it in the same

Employee_Location_Details report.

6.5.1 Publishing multiple templates for a BI Publisher Report

Create a new template design to view details in Pie Chart.

(If not already opened) Open the BI Publisher report or else log in to BI Publisher.

In MS Word, select the BI Publisher> Open Template option.

Open the report from the path My Folders>BI_Publisher_LabGuide.

In the Word document that loads this report, select Insert> Cross Tab on the BI Publisher toolbar to

define a format for the table data in the query.

Drag and drop the Row values into the Layout region as shown below and click OK.

35

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

The created template looks like as shown below:

Change the word properties for all fields by double clicking on the field.

Change the aggregate function in the code from sum to count.

Click on the Properties tab and change the format and click OK.

Similarly change the properties for every field.

Include headers and footers as shown below.

36

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

After making the necessary changes, upload the template.

View the output in different formats.

7. Creation of Report using Drilldown

7.1 Creation of Summary Report

Employee Summary report will be created.

7.1.1 Defining Data Model

Create a new report. (Refer section 4 for detailed steps to create a new report)

37

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click on Edit link to modify the report.

Create a new Datamodel.

Enter the data model name select the type as SQL Query

Choose the data sources and write the sql query

Save the report

7.1.2 Creating and Uploading RTF Template

Start the MS Word application from the program menu. From the Oracle BI Publisher menu, select

Log On.

38

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

In the Login screen that appears, enter Administrator as the Username and Password, and click Login.

The first time when you connect, you may be asked for the report server URL, enter the URL which is

of the format: http://<Host>:9704/xmlpserver

This displays the Open Template window. Ensure that BI Publisher is selected from the Workspace

drop-down list.

Navigate and select the Employee_Details report that you have created from My Folders>

BI_Publisher_LabGuide. Click Open Report.

39

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Using Insert wizard select the columns needed to be displayed in report.

The template you created looks like this:

Insert header and footer for the created template by selecting the Insert->Header and by selecting

Insert->Footer as shown below.

The template designed should look like as shown below.

40

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Upload the template as shown in section 6.4.1.

Check for the uploaded template in the BI Publisher Report.

Save the report and view the output. You can see the template name as the name uploaded from MS

Word. View the output in different format.

7.2 Creation of Detail Report

Similarly create another new report.

41

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

7.2.1 Defining Data Model

Create a new Data Model.

Select Data model New

Enter the data model name choose the type as SQL query

Choose the data source and write the sql.

Save the report.

42

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

7.2.2 Defining Parameter

We need to create a parameter in detail report to fetch the value from Employee Details report.

Click on Parameters New

Choose appropriate data type and parameter type based on your need.

Modify the SQL query to include the parameter.

43

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

7.2.3 Creation of RTF Template

Create a new template design (Refer Section 4.3 for detailed steps for creating the template)

This displays the Open Template window. Ensure that BI Publisher is selected from the Workspace

drop-down list.

Navigate and select the Employee_InDetail report that you have created from My Folders>

BI_Publisher_LabGuide. Click Open Report.

In the Word document that loads this report, select Insert> Table Wizard on the BI Publisher

toolbar to define a format for the table data in the query.

This displays the Table Wizard. Select Form and click Next.

In the next step, ensure that ROWSET/ROW is selected as the Grouping Field, and click Next.

In the next step, click to include all the available columns in the table. Click Next.

In the next step, select any field from the Group by drop-down list if needed else click Next.

In the next step, select any field from the Sort By drop-down list if needed.

In the next step you can edit the labels of the columns as required. Click Finish.

The template you created looks like this:

44

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

To change the format for the HireDate data field, double click on the field and select the formatting

type as Date and format as shown below.

Insert header and footer for the created template by selecting the Insert->Header and by selecting

Insert->Footer as shown below.

45

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

The template designed should look like as shown below.

7.2.4 Publishing the template for a BI Publisher Report

After making the necessary changes, upload the template by selecting Add-Ins->Oracle BI Publisher-

>Upload Template as

A dialog box opens prompting to save the template in RTF. Click OK.

Save the template in Rich Text Format.

46

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

A dialog box pops, asking for the Template name. Enter the Template name. The same name will be

displayed in the BI Publisher screen.

After successfully uploading, a dialog box pops stating that the template has been added to the

report. Click OK.

Check for the uploaded template in the BI Publisher Report.

47

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Save the report and view the output. You can see the template name as the name uploaded from MS

Word. View the output in different format.

Select Layouts Browse the template which you have saved and upload it.

Save the report

Click View

48

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

No rows will be displayed in the output because there are no values assigned for the Hidden

parameter.

Copy the path of the report as shown below:

Note: If you want to check the output, set the default value of the parameter to some existing Empno

and view the output later delete the default parameter.

7.3 Drilldown from Summary to Detail report

7.3.1 Inserting Hyperlink

Open the Employee_Details summary report template.

Choose the field(e.g. EMPNO) on which hyperlink has to be enabled right click on the chosen field

Hyperlink

49

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Paste the copied path of the Employee_InDetail report.

7.3.2 Defining Parameter in RTF template

Parameter has to be passed on to the detail report by appending the highlighted syntax at the end of

the detail report URL.

At the end of the detail report URL include the following syntax

http://chnmct139034d:9704/xmlpserver/~administrator/BI_Publisher_LabGuide/

Emplo yee_InDetail/Employee_InDetail.xdo ?EMPNO= {EMPNO}

Where EMPNO (on the left hand side) is the parameter name created in the detail report and EMPNO

(on the right hand side) is the alias name for the column “EMPNO” in the Employee Details summary

report.

Save the template.

The template needs to be refreshed after placing the FORM field. Go to BI_Publisher_LabGuide

Employee_Details browse the template upload

Save the report View.

The output is shown below

50

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click on the EmployeeNo and it will drill down to detail report

8. Creating Reports with Group by Function

8.1 Creating a new Report

51

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Create a new report ‘Employee_Details_Groupby’ inside the created folder ‘BI_Publisher_LabGuide’

Click on Edit link mentioned below to create the report

8.1.1 Creating a new Data Model

Select Data model New

Enter the data model name select the type as SQL Query

Choose the data sources and click the Query Builder button.

52

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

8.1.2 Creating Query using Query Builder

Select the table ‘EMP’ and ‘DEPT’ and check the required fields.

Define a join between these two tables as follows:

Click the box beside the DEPTNO column in the DEPT table. (See the following screens.)

Similarly click the box beside the DEPTNO column in the EMP table.

These boxes when marked for joins turn to light gray.

Also note that a fine line joining the tables appears in the Model canvas.

Click Conditions, and move the DEPTNO, to appear first in the list (as shown in the screen below).

53

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

You can use these icons beside each column to move the columns up or down.

View the generated SQL Query and the Results.

This is the result for the generated SQL.

54

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Save the report

8.1.3 Creating Report Layout using BI Publisher Desktop in MS Word

Create a new template using Microsoft word. (Refer section 4.3 for detailed steps for creating the

template)

Navigate and select the Based on Oracle DB report that you have created from My Folders>

BI_Publisher_LabGuide. Click Open Report.

Using the table wizard create a template as shown below:

55

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

To change the format for the HireDate data field, double click on the field and select the formatting

type as Date and format. For example, d-MMM-yy and click OK.

Similarly, to change the format for the Salary, double click on the field and select the Type as

Number and Number format to any of the format as needed. For example, $#,##0.00 to display the

salary in dollar format and click OK.

56

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Similarly, change the format for commission field and click OK.

Left align the Salary and Commission fields.

Insert header and footer for the created template by selecting the Insert->Header and by selecting

Insert->Footer.

The template designed should look like as shown below.

57

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

After making the necessary changes, upload the template by selecting Add-Ins->Oracle BI Publisher-

>Upload Template As

A dialog box opens prompting to save the template in RTF. Click OK.

Save the template in Rich Text Format.

58

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

A dialog box pops, asking for the Template name. Enter the Template name. The same name will be

displayed in the BI Publisher.

After successfully upload a dialog box pops stating that the template has been added to the report.

Click OK.

Check for the uploaded template in the BI Publisher Report.

59

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Save the report and view the output. You can see the template name as the name uploaded from MS

Word. View the output in different format.

This is the report that is generated in HTML Format.

60

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

8.2 Creating a new Report with Grand Total

Create a new report ‘Emp_GrpBy_Function’. (Refer Section 4 for detailed steps for creating the Report)

Using Query builder generate the below query.

61

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Now save the work done.

8.2.1 Creating a Layout

Go to Layout and click on ‘New’ for creating a Layout.

Give the name for that layout.

62

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

8.2.2 Creating a RTF Template

Create a new template using Microsoft word (Refer section 4.3 for detailed steps for creating the

Template).

Select the table for which the template is going to created i.e. ‘Emp_GrpBy_Function’.

Using Table Wizard create a template as shown below.

After formatting the template as explained in section 4.3 , the final template will look as below.

63

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

8.2.3 Uploading the RTF Template

Now upload the template created by using the option ‘Browse and upload’ in BI Publisher.

Save the changes.

8.2.4 Viewing the Output

Click ‘View’ to see the output.

64

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9 Creation of Reports with Parameters

9.1 Creating a new Report with Default Parameter

Click on Reports tab and create a new report ‘Simple_Parameter’ .(Refer section 4 for detailed steps for

creating the report.

Using Query Builder generate the below query:.

65

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Now save the work done.

9.1.1 Creating a new Parameter

Click on Parameter and click ‘New’ to create a new parameter.

Give the name for the parameter.

66

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Edit the query to give the bind variable, i.e. the name of the parameter.

Select the data type according to the parameter.

If you want to give a default value give them and select the parameter type.

67

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Give the display label and text field size.

Save the work done.

9.1.2 Viewing the Output

The default value will appear in the text box and by clicking ‘view’ the output is generated.

68

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9.2 Creating a new Report with Parameter type-Text

9.2.1 Creating a new Parameter

Click on Parameter and click ‘New’ to create a new parameter.

Give the name for the parameter.

69

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Edit the query to give the bind variable, i.e. the name of the parameter.

Select the data type according to the parameter.

Select the parameter type.

70

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Give the display label and text field size.

Check the option ‘Text field contains comma-separated values’ , so that more than one employee number can

be entered.

Save the work done.

9.2.2 Viewing the Output

Enter the Employee Numbers separated by comma and Click ‘View’ to see the output..

71

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9.3 Creating a new Report with Parameter type-Date

9.3.1 Creating a new Parameter

Click on Parameter and click ‘New’ to create a new parameter.

Give the name for the parameter and select the data type as ‘Date’

72

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Edit the query to give the bind variable, i.e. the name of the parameter.

Select the parameter type and give the Display Label.

73

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

If you want give default ‘date’ then enter the date in Default value column.

Give the format for date and also enter the starting and ending Date.

Save the work done.

74

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9.3.2 Viewing the Output

If a default date is given in default value column, then the date will appear in the prompt box.

Click ‘View’ to see the output.

If default date is not given then click ‘View’ and enter the date in the prompt box.

Once the date is entered, click view to see the output.

9.4 Creating a new Report with Hidden Parameter

75

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9.4.1 Creating a new Parameter

Click on Parameter and click ‘New’ to create a new parameter.

Give the name for the parameter.

Edit the query to give the bind variable, i.e. the name of the parameter.

76

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select the data type according to the parameter.

Select the parameter type.

Now enter the hidden parameter value in the default value box.

77

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Save the work done.

9.4.2 Viewing the Output

By clicking ‘View’ the output is generated for the hidden parameter value.

9.5 Creating a new Report with Parameter type-Menu & LOV

9.5.1 Creating a new LOV

Click on List Of Values and click ‘New’ to create a new List of Values.

78

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Give a name to the List of Vales created.

Now select the type i.e. SQL query or Fixed Data.

Fixed Data is selected to give the values manually.

By clicking on ‘Add’ one can enter the value and its label name to be displayed.

79

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

SQL query is selected to generate query from query builder automatically.

Connect to the ‘Data Source’ and click on ‘Query builder’ to fetch the query.

Save the work done.

80

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

9.5.2 Creating a new Parameter

Click on Parameter and click ‘New’ to create a new parameter.

Give the name for the parameter.

Edit the query to give the bind variable, i.e. the name of the parameter.

Select the data type according to the parameter.

81

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select the parameter type.

Give the display label and Select the LOV created.

82

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

To select more than one value from the List of Values, check the option ‘Multiple Selection’.

To select All values from the LOV, then check the option ‘can select all’.

To pass null values check that field or to pass all values check that field.

83

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

If more than one parameter is created and if one depends on the other then use the last option to refresh the

parameters.

Save the work done.

9.5.3 Viewing the Output

If the option ‘Multiple Selection’ in Menu Setting of parameter is selected.

Click ‘View’ to see the output.

84

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select the values and click on ‘View’

If the option ‘can select all’ in Menu Setting of parameter is selected.

Click ‘View’ to see the output.

Select the value and click on ‘View’

85

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

10 Scheduling BI Publisher Reports

Scheduling is a very important feature for any reporting system, which enables you to schedule

long-running reports, to be run at a specified time and date. This enables you to select a time and

date at which the load on the system is low, to run your daily/weekly and/or monthly reports. In this

topic, you configure the BI Publisher scheduler to schedule the reports and view the report history

and saved output.

10.1 Configuring the BI Publisher Scheduler

Click Admin to go to the Admin tabbed page.

On the Admin tabbed page, click the Scheduler Configuration link in the

System Maintenance section.

86

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

On the Scheduler Configuration page: Select Oracle 10g from the Database

Type drop-down list. Enter Connection String in the format:

jdbc:oracle:thin:@<Host name>: <Port>:<SID>

for example, a sample connection string may look like:

jdbc:oracle:thin:@myhost:1521:orcl

Enter the Username and Password credentials (this is the scheduler user

that you must have created as per step 4 of the prerequisites).

Ensure that oracle.jdbc.driver.OracleDriver is selected as Database Driver

Class.

Click Test Connection.

87

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click Install Schema to install the required scheduler schema tables.

After the tables are installed in the database, the below message is displayed:

Restart BI Publisher Server or the OC4J service after this configuration.

10.2 Scheduling a Report

88

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Logon to BI Publisher (if not logged) and open the Report tab.

Select the Schedule link displayed below the report which you need to schedule.

On the schedule report page, select the template type and the format for the report.

Enter Employee_Location_Details-Scheduled as the Job Name, and select appropriate language and

time options as per your requirements. Also, ensure that the Save Data for Republish and Save Output

options are selected.

In the Time section of the scheduled report page, select any one of the four option to run the

scheduled report as shown below:

Run Immediately – Runs the scheduled report immediately after scheduling the report.

Run Once – Runs the scheduled report once at the selected date and time after scheduling the report.

89

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Run Daily/Weekly – Runs the scheduled report weekly once or daily once at the selected day of week

and time. Also select the Active Start Date and End Date.

Run Monthly – Runs the scheduled report monthly once at the selected month, day and time. Also

select the Active Start Date and End Date.

After selecting the option click submit which is found on the top and bottom right corner of the

scheduled report page.

After submitting the scheduling process, a confirmation message can be seen along with the Report

Schedules.

90

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

To view the history of the scheduled reports, go to the Schedules tab.

Click the History tab to view the report history. Note that the Data XML and Document columns are

shown in the history table.

Here you can see the status of the report as ‘Running’. Once the report has run the status

automatically changes to ‘Success’(Keep refreshing the page)

Click the icon in the Document column to see the saved report.

91

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

10.3 E-Mail Server Configuration

To Configure Email Settings go Admin -> Delivery Configuration-> E-mail

92

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click on Add Server.

Now give the Server name and Host

After giving Apply you will able to see the following .

We can give more than one server by clicking Add server and if we need to delete click on delete.

10.4 Scheduling Report to deliver output via Mail

Logon to BI Publisher (if not logged) and open the Report tab.

Select the Schedule link displayed below the report which you need to schedule.

On the schedule report page, select the template type and the format for the report.

93

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Select appropriate language and time options as per your requirements. Also, ensure that the Save Data for

Republish and Save Output options are selected.

In the Time section of the scheduled report page, select any one of the four option to run the scheduled

report as shown below:

Run Immediately – Runs the scheduled report immediately after scheduling the report.

Now click the radio button for scheduling the reports to Email.

Enter the Mail Id, Subject and Mail body details.

If you need to send to more than one person then click on ‘Add Destination’.

94

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

After selecting the option click submit which is found on the top and bottom right corner of the scheduled

report page.

After submitting the scheduling process, a confirmation message can be seen along with the Report

Schedules.

To view the history of the scheduled reports, go to the Schedules tab.

Click the History tab to view the report history. Note that the Data XML and Document columns are shown in

the history table.

Here you can see the status of the report as ‘Running’. Once the report has run the status automatically

changes to ‘Success’(Keep refreshing the page)

Click the icon in the Document column to see the saved report.

95

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

11 Bursting BI Publisher Reports

Bursting is an important and useful feature of BI Publisher, which enables you to split a single report

based on a key .You, can apply a different template, output format, delivery method, and locale to

each split segment of your report.

Following are some example scenarios where bursting can be implemented: Generation of pay slips to

all employees based on one extract and delivered via e-mail

11.1 Scheduling a report to burst to a file location

Click on Edit link mentioned below to go the report

11.1.1Bursting the Report to a shared Location

On the Report Properties screen, click the Bursting node in the Report section on the left, to define

bursting properties for the report.

96

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

This displays the Bursting Properties screen on the right.

In the General Properties section, select the Enable Bursting option, and then select

ROWSET/ROW/DNAME from the Split By drop-down list and ROWSET/ROW/DNAME from the Deliver By

drop-down list.

In the Delivery Data Source section, select BIP as the Data Source, and add the query in the SQL

Query section:

Before doing the bursting process, create a folder for e.g. D:\Salary.

Mention the path of the created share folder in the Bursting query as shown below:

97

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click Save to save the changes you made to the report.

Ensure that you saved the report after defining the Bursting Properties, and click Schedule to

schedule this report to burst to the file location defined.

This takes you to the Schedule page. Click Schedule a New Job to define the scheduling job.

98

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

On the Schedule Report page that appears, define the following:

In the Job Properties section, select the Burst Report option

Scroll down to define the other options.

Select the Run immediately option in the Time section and click Submit

This displays the message saying the job is successfully created.

99

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Click the Schedules tab and then click History to see whether the schedule was run successfully.(Click

the refresh icon )

Now go to the D:\Salary folder (the delivery destination folder you provided in the query). You can

see that the PDF files, which have <DName>. PDF as the titles, are bursted to this file location.

100

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Open one of the files to see the report.

For example, Accounting. PDF report file looks like this:

11.2 Scheduling a report to burst to a e-Mail

11.2.1Creating new Report

Click on Edit link mentioned below to edit the report

101

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

11.2.2Bursting the Report

Now select the dummy column in the split by and deliver by column, so that the file will save as a single file.

Now select the data source

Write the sql query for bursting the report.

In the Query the key should match the split by column.

Give the template name in Template and format of template in Template Format.

Give the output format and delivery channel type in the next two lines.

102

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Parameter 1 will be the receiving person and parameter 3 will be the sender.

If u wants to copy someone then give their id at Parameter 2.

The subject for the mail will be given in Parameter 4 and body of the mail in Parameter 5.

Parameter 6 is set true to deliver the output in the required format.

Check the Enable Bursting option.

Now save the work done.

11.2.3Viewing the Report

The mail has been delivered to the recipient.

103

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

Now the open the Excel sheet to see the output.

104

Oracle BI Publisher for BeginnersOracle BI Publisher for Beginners

12 Sample Templates.

105