You are here: BI Publisher BI Publisher for beginners : Working with Data Model

BI Publisher for beginners : Working with Data Model

Rate this item
(2 votes)

Previous >>> Introduction to Data Model

The Data Model Editor is designed with a component pane on the left and work pane on the right. Selecting a component on the left pane launches the appropriate fields for the component in the work.


Click the Data Model icon from the Create menu.



Data Model Properties

Enter the following properties for the data model:

Description:  Description about the Data Model.

Default Data Source — Select the data source from the list. Data models can include multiple data sets from one or more data sources. The default data source you select here is presented as the default for each new data set you define

Oracle DB Default Package — If you define a query against an Oracle database, then you can include before or after data triggers (event triggers) in your data model. Event triggers make use of PL/SQL packages to execute RDBMS level functions. For data models that include event triggers or a PL/SQL group filter, you must enter a default PL/SQL package here. The package must exist on the default data source.

Database Fetch Size — Sets the number of rows fetched at a time through the JDBC connection.

Enable Scalable Mode — processing large data sets requires the use of large amounts of RAM. To prevent running out of memory, activate scalable mode for the data engine. In scalable mode, the data engine takes advantage of disk space when it processes the data.

Backup Data Source — If you have set up a backup database for this data source, select Enable Backup Connection to enable the option; then select when you want BI Publisher to use the backup.

XML Output Options

These options define characteristics of the XML data structure. Note that any changes to these options can impact layouts that are built on the data model.

•    Include Parameter Tags — If you define parameters for your data model, select this box to include the parameter values in the XML output file

•    Include Empty Tags for Null Elements — Select this box to include elements with null values in your output XML data.

•    Include Group List Tag —Select this box to include the rowset tags in your output XML data. If you include the group list tags, then the group list appears as another hierarchy within your data.

•    XML Tag Display — Select whether to generate the XML data tags in upper case, in lower case, or to preserve the definition you supplied in the data structure.

Attachments to the Data Model

•    Attaching Sample Data - The sample data is used by BI Publisher's layout editing tools. The Data Model Editor provides an option to generate and attach the sample data

•    Attaching Schema - The Data Model Editor enables you to attach sample schema to the data model definition. The schema file is not used by BI Publisher, but can be attached for developer reference.

•    Data Files - If you have uploaded a local Microsoft Excel file as a data source for this report, the file displays here

Creating Data Sets

1.0 On the component pane of the data model editor click Data Sets



Select the data set type from the list. For this exercise, select the “SQL Query” Data Set type.


Provide the Name and Select the Data Source from the drop down list. The Data Sources are defiend through “Administration =>DataSource=>JDBC Connection” UI


The SQL Query can by typed directly on SQL Query pane or it can be designed using Query Builder Tool.  Click the “Query Builder” button to invoke the Query Builder Tool.



Press the save button and we get the auto generated SQL query. The Query Builder Tool can be use to design simple and complex query but a experienced SQL query writer prefer to write query manually using SLQ PLUS, Toad or any other tool


Press OK to save the data set.

Save the data model by clicking the Save button. Select the proper folder and appropriate name for Data Model. 


Click on XML icon on top left panel and view and verify the Sample XML Data. It the Data Model is not saved, it will ask to save the Data Model first



Click the Run button to view sample XML Data or Return button to back to Data Model designer.

Check the following options from upper left corner

  • Export XML : option allows to export the sample xml data to file System. Exported XML required by World Template Builder for RTF template design.
  • Save As Sample Data : Option allows to save the Sample XML data within Data Model. This is mandatory step. It is required by Report Designer to create Report Definition.
  • Get Data Engine Log : Option provide the Data Engine log for debugging purpose. The log level can be set through Enterprise Manager (em) console.


Next >>>Let's Structure the Data

This article is part of BI Publisher for beginners series. You will see many more articles on Data Model design, Template desing, Administration, Web Services, Scheduler. The contents are picked-up from BI Publisher Training documents from  Adiva consulting. If you have any question regarding these articles or training program, please contact This e-mail address is being protected from spambots. You need JavaScript enabled to view it .

Read 19891 times

Leave a comment

Make sure you enter the (*) required information where indicated.
Basic HTML code is allowed.