Skip Headers

Oracle Business Intelligence Publisher Administrator's and Developer's Guide
Part Number E12188-01
Go to Table of Contents
Go to previous page
Go to next page

Configuration File Reference

BI Publisher Configuration Files

This chapter contains reference information about the following BI Publisher configuration files:

The properties in the Runtime Configuration file are set through the Runtime Configuration Properties and Font Mappings pages (see Setting Runtime Properties). The properties in the Server Configuration file are set through the following Admin pages:

Setting Properties in the Runtime Configuration File

As of the BI Publisher Enterprise version, the runtime properties are set through the Runtime Configuration Properties page and the Font Mappings page in the Admin interface.

If you do not use the Admin interface to set the properties, BI Publisher will fall back to the properties set in this file. Therefore if you are upgrading from XML Publisher Enterprise 5.6.2, you can use the settings in your existing xdo.cfg file, although it is recommended that you migrate your settings in this file to the Admin interface.

It is important to note that the Admin interface does not update this file. Any settings in the Admin interface will take precedence over the settings in the xdo.cfg file.

File Name and Location

The configuration file is named xdo.cfg.

The file is located under the <JRE_TOP>/jre/lib, for example: jdk/jre/lib.


The namespace for this configuration file is:

Configuration File Example

Following is a sample configuration file:

<config version="1.0.0" 

   <!-- Properties -->
      <!-- System level properties -->
      <property name="system-temp-dir">/tmp</property>

      <!--  PDF compression -->
      <property name="pdf-compression">true</property>

     <!--  PDF Security -->
     <property name="pdf-security">true</property>
     <property name="pdf-open-password">user</property>
     <property name="pdf-permissions-password">owner</property>
     <property name="pdf-no-printing">true</property>
     <property name="pdf-no-changing-the-document">true</property>

   <!-- Font setting -->
      <!-- Font setting (for FO to PDF etc...) --> 
      <font family="Arial" style="normal" weight="normal">
         <truetype path="/fonts/Arial.ttf" />
      <font family="Default" style="normal" weight="normal">
         <truetype path="/fonts/ALBANWTJ.ttf" />

      <!--Font substitute setting (for PDFForm filling etc...) -->
      <font-substitute name="MSGothic"> 
         <truetype path="/fonts/msgothic.ttc" ttcno="0" />

How to Read the Element Specifications

The following is an example of an element specification:

<Element Name Attribute1="value"
   <Subelement Name1/>[occurrence-spec]
   <Subelement Name2>...</Subelement Name2>
   <Subelement NameN>...</Subelement NameN>
</Element Name>

The [occurrence-spec] describes the cardinality of the element, and corresponds to the following set of patterns:


The <config> element is the root element. It has the following structure:

<config version="cdata" xmlns="">
   <fonts> ... </fonts> [0..n]
   <properties> ... </properties> [0..n]


Variable Description
version The version number of the configuration file format. Specify 1.0.0.
xmlns The namespace for BI Publisher's configuration file. Must be


The root element of the configuration file. The configuration file consists of two parts:

The <fonts> and <properties> elements can appear multiple times. If conflicting definitions are set up, the last occurrence prevails.


This section describes the <properties> element and the <property> element.

The <properties> element

The properties element is structured as follows:

<properties locales="cdata">
   </property> [0..n]


The <properties> element defines a set of properties. You can specify the locales attribute to define locale-specific properties. Following is an example:

<!-- Properties for all locales -->
 ...Property definitions here...

<!--Korean specific properties-->
<properties locales="ko-KR">
 ...Korean-specific property definitions here...

The <property> element

The <property> element has the following structure:

<property name="cdata">


Variable Description
name Specify the property name.


Property is a name-value pair. Specify the internal property name (key) to the name attribute and the value to the element value. See List of Properties for the list of the internal property names.

  <property name="system-temp-dir">d:\tmp</property>
  <property name="system-cache-page-size">50</property>
  <property name="pdf-replace-smart-quotes">false</property>

Font Definitions

Font definitions include the following elements:

For the list of Truetype and Type1 fonts, see Predefined Fonts.

<fonts> element

The <fonts> element is structured as follows:

<fonts locales="cdata">
   <font> ... </font> [0..n]
   <font-substitute> ... </font-substitute> [0..n]


Variable Description
locales Specify the locales for this font definition. This attribute is optional.


The <fonts> element defines a set of fonts. Specify the locales attribute to define locale-specific fonts.

<!-- Font definitions for all locales -->
  ..Font definitions here...

<!-- Korean-specific font definitions -->
<fonts locales="ko-KR">
... Korean Font definitions here...

<font> element

Following is the structure of the <font> element:

<font family="cdata" style="normalitalic"
or <type1> ... <type1>


Variable Description
family Specify any family name for the font. If you specify "Default" for this attribute, you can define a default fallback font. The family attribute is case-insensitive.
style Specify "normal" or "italic" for the font style.
weight Specify "normal" or "bold" for the font weight.


Defines a BI Publisher font. This element is primarily used to define fonts for FO-to-PDF processing (RTF to PDF). The PDF Form Processor (used for PDF templates) does not refer to this element.

<!-- Define "Arial" font -->
<font family="Arial" style="normal" weight="normal">
  <truetype path="/fonts/Arial.ttf"/>

<font-substitute> element

Following is the structure of the font-substitute element:

<font-substitute name="cdata">
or <type1>...</type1>


Variable Description
name Specify the name of the font to be substituted.


Defines a font substitution. This element is used to define fonts for the PDF Form Processor.

<font-substitute name="MSGothic">
   <truetype path="/fonts/msgothic.ttc" ttccno=0"/>

<type1> element>

The form of the <type1> element is as follows:

<type1 name="cdata"/>


Variable Description
name Specify one of the Adobe standard Latin1 fonts, such as "Courier".


<type1> element defines an Adobe Type1 font.

<!--Define "Helvetica" font as "Serif" -->
<font family="serif" style="normal" weight="normal">
  <type1 name="Helvetica"/>

Predefined Fonts

BI Publisher provides a set of Type1 fonts and a set of TrueType fonts. You can select any of these fonts as a target font with no additional setup required.

The Type1 fonts are listed in the following table:

Type 1 Fonts
Number Font Family Style Weight Font Name
1 serif normal normal Time-Roman
1 serif normal bold Times-Bold
1 serif italic normal Times-Italic
1 serif italic bold Times-BoldItalic
2 sans-serif normal normal Helvetica
2 sans-serif normal bold Helvetica-Bold
2 sans-serif italic normal Helvetica-Oblique
2 sans-serif italic bold Helvetica-BoldOblique
3 monospace normal normal Courier
3 monospace normal bold Courier-Bold
3 monospace italic normal Courier-Oblique
3 monospace italic bold Courier-BoldOblique
4 Courier normal normal Courier
4 Courier normal bold Courier-Bold
4 Courier italic normal Courier-Oblique
4 Courier italic bold Courier-BoldOblique
5 Helvetica normal normal Helvetica
5 Helvetica normal bold Helvetica-Bold
5 Helvetica italic normal Helvetica-Oblique
5 Helvetica italic bold Helvetica-BoldOblique
6 Times normal normal Times
6 Times normal bold Times-Bold
6 Times italic normal Times-Italic
6 Times italic bold Times-BoldItalic
7 Symbol normal normal Symbol
8 ZapfDingbats normal normal ZapfDingbats

The TrueType fonts are listed in the following table. All TrueType fonts will be subsetted and embedded into PDF.

Number Font Family Name Style Weight Actual Font Actual Font Type
1 Albany WT normal normal ALBANYWT.ttf TrueType (Latin1 only)
2 Albany WT J normal normal ALBANWTJ.ttf TrueType (Japanese flavor)
3 Albany WT K normal normal ALBANWTK.ttf TrueType (Korean flavor)
4 Albany WT SC normal normal ALBANWTS.ttf TrueType (Simplified Chinese flavor)
5 Albany WT TC normal normal ALBANWTT.ttf TrueType (Traditional Chinese flavor)
6 Andale Duospace WT normal normal ADUO.ttf TrueType (Latin1 only, Fixed width)
6 Andale Duospace WT bold bold ADUOB.ttf TrueType (Latin1 only, Fixed width)
7 Andale Duospace WT J normal normal ADUOJ.ttf TrueType (Japanese flavor, Fixed width)
7 Andale Duospace WT J bold bold ADUOJB.ttf TrueType (Japanese flavor, Fixed width)
8 Andale Duospace WT K normal normal ADUOK.ttf TrueType (Korean flavor, Fixed width)
8 Andale Duospace WT K bold bold ADUOKB.ttf TrueType (Korean flavor, Fixed width)
9 Andale Duospace WT SC normal normal ADUOSC.ttf TrueType (Simplified Chinese flavor, Fixed width)
9 Andale Duospace WT SC bold bold ADUOSCB.ttf TrueType (Simplified Chinese flavor, Fixed width)
10 Andale Duospace WT TC normal normal ADUOTC.ttf TrueType (Traditional Chinese flavor, Fixed width)
10 Andale Duospace WT TC bold bold ADUOTCB.ttf TrueType (Traditional Chinese flavor, Fixed width)

The Server Configuration Files

The server configuration properties are set through the following pages under the Admin tab:

The Repository location defined under System Maintenance Server Configuration is stored in WEB-INF/xmlp-server-config.xml.

All other server configuration properties are stored in a second instance of xmlp-server-config.xml. This file is located in Admin/Configuration/xmlp-server-config.xml in the repository.

The Admin user interface pages write the settings to these two files. Therefore the files can be manually updated. However, this is not recommended because the user interface ensures the validity of related property settings.

Important: Whenever you change any of the properties in this configuration file, you must restart the server in order for the changes to take effect.

Configuration File Structure

The file consists of the following sections: XML header, resource, scheduler, and general properties.

XML Header

The header consists of the XML declaration and the root element with the namespace attribute:

<?xml version="1.0" encoding="UTF-8"?>
<xmlpConfig xmlns="">

Resource Section

Note: The repository location is now set using the Server Configuration page. See Setting Server Configuration Options.

The resource section defines the location of your repository. The resource section is mandatory. The resource elements are enclosed within <resource> </resource> tags.

Within the <resource> tags you must define either the <file> element or the <xdb> element to specify the path to your reports repository.

The <file> Element

If your reports repository exists on your file system, declare the absolute file path using the file element with its path attribute as follows:

<file path=""/>

Example: <file path="d:/reports"/>

The <xdb> element

If your reports repository is set up on your database, declare the absolute path using the xdb element with its path attribute as follows:

<xdb path="">

Example: <xdb path="/public/Reports">

The xdb element requires the <connection> element. Within the <connection> </connection> tags, define the <connectionType>. Valid values for <connectionType> are "jdbc" or "jndi".

jdbc connectionType

If the <connectionType> is jdbc, the following elements are required:






 <xdb path="/public/Reports">

jndi connectionType

If the connection type is "jndi", the following element is required:



  <xdb path="/public/Reports">

General Properties

The following table lists the general properties that can be specified in the configuration file. Specify the properties according to the following syntax:

<property name = "PROPERTY_NAME" value="value"/>


<property name = "CACHE_EXPIRATION" value="120"/>

Use the Admin Server Configuration page to set these properties (see Setting Server Configuration Options), with the exception of Guest Folder access. Guest Folder access is now set on the Security Configuration page (see Allowing Guest Access).

The properties listed here are not required. If not specified, the default value will be used. The following table lists the name, valid values, default value, and description of each property.

Property Name Values Description
CACHE_EXPIRATION Default: 30 Enter the expiration period for the dataset cache in minutes.
For reports that execute a SQL query, you have the option of caching the dataset returned by the query. The returned dataset will remain in cache for the period specified by this property. For more information about setting this option, see Create a New Report, Oracle Business Intelligence Publisher Report Designer's Guide.
CACHE_SIZE_LIMIT Default: 1000 Sets the maximum number of datasets that will be maintained in the cache at a given time.
CACHED_REPORT_LIMIT Default: 50 Specifies the number of reports that can be cached in memory at any given time.
OUTPUT_FORMAT html, pdf, rtf, excel, xml The output types specified in this property will be displayed to the user by default for every report (PDF templates will still only allow PDF output). Enter each output type separated by a comma. Valid values are: html, pdf, rtf, excel, xml.
This value is overridden by the Output Format types selected in the report definition. See Create a New Report, Oracle Business Intelligence Publisher Report Designer's Guide.
DEBUG_LEVEL exception (Default), debug Controls the amount of debug information generated by the system. If set to exception, only error information is generated. If set to debug, all system output is generated.
GUEST_FOLDER true (Default), false Enables a "guest" folder for your installation. A guest folder is a public folder accessible to anyone who can view the login URL. No credentials are required to view the reports in the guest folder.
GUEST_FOLDER_NAME Default: Guest Sets the name of the guest folder.

The following properties must be specified if you are using an LDAP server with BI Publisher Enterprise. Set these properties from the Admin user interface. For more information about LDAP integration, see Integrating with LDAP.

Property Name Values Description
LDAP_PROVIDER_URL Example: ldap:// Enter the URL for the LDAP server.
LDAP_PROVIDER_ADMIN_USERNAME Example: Admin Enter the administrator user name for the LDAP server.
LDAP_PROVIDER_ADMIN_PASSWORD Example: welcome Enter the administrator password for the username entered.
LDAP_PROVIDER_USER_DN Example: cn=xdo,dc=myserver,dc=com The LDAP distinguished name user suffix that distinguishes the group of users to have access to BI Publisher.
LDAP_PROVIDER_FACTORY Example: com.sun.jndi.ldap.ctl.LdapCtxFactory The value of this property is the fully qualified class name of the factory class which creates the initial context for the LDAP service provider. It is used to select a particular LDAP service provider; it is not used by the provider itself. This property need not be set when the name argument to initial context methods is a URL.
LDAP_PROVIDER_GROUP_SEARCH Example:(&amp;(objectclass=groupofuniquenames)(cn=*)) The search criteria to locate the qualified groups. This will be based on your LDAP server schema.
LDAP_PROVIDER_GROUP_SEARCH_ROOT Example: cn=OracleDefaultDomain,cn=OracleDBSecurity,cn=Products,cn=OracleContext,dc=mypc11,dc=com Indicates where in the tree structure to apply the group search criteria.
Indicates which attribute contains the Group name.
Indicates which attribute contains the member names of the Group.
LDAP_PROVIDER_GROUP_ATTR_DESCRIPTION Example:description Indicates which attribute contains the description of the Group.

The Oracle Single Sign-On properties are listed in the following table. These properties are now set through the Admin interface. For more information about setting up Single Sign-On, see Setting Up Oracle Single Sign-On.

Property Name Values Description
SINGLE_SIGN_OFF_URL Example: Enter the Single Sign-Off URL retrieved from the SSO Partner Application Login page.

Sample Configuration Files

Following is a sample WEB-INF/xmlp-server-config.xml file containing repository information:

<?xml version="1.0" encoding="UTF-8"?>
<xmlpConfig xmlns="">
   <file path="d:/reports"/>
<! -     <xdb path="/public/Reports"> - >
<! -       <connection> - >
<! -         <connectionType>jndi</connectionType> - >
<! -         <jndiName>jdbc/pool/mydb</jndiName> - >
<! -       </connection> - >
<! -     </xdb> - >

Following is a sample Admin/Configuration/xmlp-server-config.xml file containing the BI Publisher server general and LDAP properties:

<?xml version="1.0" encoding="UTF-8"?>
<xmlpConfig xmlns="">
<property name="CACHE_EXPIRATION" value="120"/>
<property name="CACHE_SIZE_LIMIT" value="1000"/>
<property name="OUTPUT_FORMAT" value="html, pdf, rtf, excel, xml"/>
<property name="DEBUG_LEVEL" value="debug"/>
<property name="CACHED_REPORT_LIMIT" value="10"/>
<property name="LDAP_PROVIDER_URL" 
<property name="LDAP_PROVIDER_ADMIN_USERNAME" value="orcladmin"/>
<property name="LDAP_PROVIDER_ADMIN_PASSWORD" value="welcome1"/>
<property name="LDAP_PROVIDER_USER_DN"