Data Model Properties

You can access the Data Model Properties page when you click Properties in the components pane.

Enter the following properties for the data model:

Property Description

Description

Enter a description for the data model. The catalog displays the descriptions of data models. This description is translatable.

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 SQL data set you define. Select Refresh Data Source List to see any new data sources added since your session was initiated.

Oracle DB Default Package

Enter a default PL/SQL package for data models that include event triggers or a PL/SQL group filter. The package must exist on the default data source.

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.

Query Time Out

Enter a time limit in seconds within which the database must execute SQL statements. This property applies to SQL query-based data models. If the SQL query is still processing when the time out value is met, the error Failed to retrieve data xml. is returned. Enter a value in seconds. If you do not enter a value for this data model, the server property value is used.

Enable SQL Pruning

Select this property to enhance processing time and reduces memory usage. This property applies to Oracle Database queries only that use standard SQL. If your query returns many columns but only a subset are used by your report template, SQL pruning returns only those columns required by the template.

Note that Enable SQL Pruning is also a server-level property. Therefore, by default the data model-level property is set to Instance Level to inherit the server or instance level setting. To turn SQL pruning on or off for this particular data model, select On or Off from the list.

SQL pruning is not applicable for PDF, Excel, and E-text template types.

Skip Unused Data Set Query

Select this property to omit the execution of any unused data sets in the layout, so you can reduce processing time and memory usage. By default, all data sets in a data model are executed whether a data set is required for the output. When a data model contains multiple data sets for different layouts, each layout might not require all the data sets defined in the data model.

You must set the Enable SQL Pruning property to On to use the Skip Unused Data Set Query property.

Enable SQL Session Trace

Select this property to enable SQL session trace. For each SQL statement, the trace contains:

  • Parse, execute, and fetch counts

  • CPU time and elapsed time

  • Physical reads and logical reads

  • Number of rows processed

  • Library cache failures

  • User name for which each parse occurred

  • Each commit and rollback

This property applies to Oracle Database queries that use standard SQL.

SQL Trace Name

Enter a name for the SQL trace.

Backup Data Source

Select the Enable Backup Connection property to use the backup data source.

  • To use the backup data source only when the primary is down, select Switch to Backup Data Source when Primary Data Source is unavailable. Note that when the primary data source is down, the data engine must wait for a response before switching to the backup.

  • To always use the backup data source when executing this data model, select Use Backup Data Source Only. Using the backup database may enhance performance.

You must enable a backup for the data source.

Enable CSV Output

Select this property to generate report output only in a CSV file.

Optimize Query Execution

Select this property to allow the data processor to optimize the execution of SQL queries of parent and child data sets.

Select this property only when the data model includes a parent-child hierarchy structure in a SQL data set. Don't select this option for non-structured and non-SQL data sets.

Multithread Query Execution

Select this property to create multiple database connections to query the child data sets in parallel. If you select this property, the number of database connections per data model increases.

This property is enabled only when:

  • Optimize Query Execution is set to true.

  • Data model has more than one data set.

  • Data model has parallel child data set queries linked to the parent data set.

  • Data model uses the default data source.

This property cannot be used when:

  • Data model uses event triggers.

  • Data model has a data set query linearly linked to the parent data set.

  • Data model uses multiple data sources.

XML Output Options

These options define the characteristics of the XML data structure. 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 option to include the parameter values in the XML output file. See Add Parameters and Lists of Values for adding parameters to your data model. Enable this option when you want to use the parameter value in the report.

  • Include Empty Tags for Null Elements — Select this option to include elements with null values in your output XML data. When you include a null element, then a requested element that contains no data in your data source is included in your XML output as an empty XML tag as follows: <ELEMENT_ID\>. For example, if the element MANAGER_ID contained no data and you chose to include null elements, it would appear in your data as follows: <MANAGER_ID />. If you do not select this option, no entry is displayed for MANAGER_ID.

  • Include Open & Close Tags — Select this option to include the open and close tags in your output XML data.

  • Include Group List Tag — (This property is for 10g backward compatibility and Oracle Report migration.) Select this option to include the rowset tags in your output XML data. If you include the group list tags, then the group list displays as another hierarchy within your data.

  • XML Tag Display — Select this option to generate the XML data tags in uppercase, in lowercase, or to preserve the definition you supplied in the data structure.

Add Attachments to the Data Model

The Attachment region of the page displays data files that you have uploaded or attached to the data model.

Attach Sample Data

After you build your data model, you must attach a small, but representative set of sample data generated from your data model. The sample data is used by BI Publisher's layout editing tools. Using a small sample file helps improve performance during the layout design phase.

The data model editor provides an option to generate and attach the sample data. See Test Data Models and Generate Sample Data.

The administrator can set a limit to the size of the sample data file.

Attach Schema

The data model editor enables you to attach sample schema to the data model definition.

Oracle BI Publisher does not use the schema file. However, you can attach the schema for developer reference. The data model editor does not support schema generation.

Data Files

If you have uploaded a local Microsoft Excel, CSV, or XML file as a data source for this report, the file displays here

Use the refresh button to refresh this file from the local source. For information on uploading files to use as data sources, see Create Data Sets.

The figure below shows the Attachments region with sample data and data files attached: