Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle Business Intelligence Publisher
11g Release 1 (11.1.1)

Part Number E22255-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

D Configuration File Reference

This appendix describes the BI Publisher run-time configuration file.

It covers the following topics:

D.1 BI Publisher Configuration Files

This appendix contains reference information about the following BI Publisher configuration file:

The properties in the Runtime Configuration file are set through the Runtime Configuration Properties, Currency Formats, and Font Mappings pages. (For information, see Section 12.1, "Setting Run-Time Properties.")

D.2 Setting Properties in the Runtime Configuration File

The runtime properties and font mappings are set through the Runtime Configuration Properties page and the Font Mappings page in the Administration interface.

If you do not use the Administration page to set the properties, then BI Publisher falls back to the properties set in this file.

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

D.2.1 File Name and Location

The configuration file is named xdo.cfg.

The file is located under the <BI Publisher Repository>/Admin/Configuration.

D.2.2 Namespace

The namespace for this configuration file is:

http://xmlns.oracle.com/oxp/config/

D.2.3 Configuration File Example

Following is a sample configuration file:

<config version="1.0.0" 
  xmlns="http://xmlns.oracle.com/oxp/config/">

   <!-- Properties -->
   <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>
    </properties>

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

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

D.2.4 Understanding the Element Specifications

The following is an example of an element specification:

<Element Name Attribute1="value"
              Attribute2="value"
                                         AttributeN="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:

  • [0..1] — Indicates the element is optional, and might occur only once.

  • [0..n] — Indicates the element is optional, and might occur multiple times.

D.3 Structure of the Root Element

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

<config version="cdata" xmlns="http://xmlns.oracle.com/oxp/config/">
   <fonts> ... </fonts> [0..n]
   <properties> ... </properties> [0..n]
</config>

D.3.1 Attributes of Root Element

The <config> element has the attributes described in Table D-1.

Table D-1 config Element Attributes

Attribute 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 http://xmlns.oracle.com/oxp/config/


D.3.2 Description of Root Element

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

  • Properties (<properties> elements)

  • Font definitions (<fonts> elements)

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

D.4 Properties and Property Elements

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

D.4.1 <properties> Element

The <properties> element is structured as follows:

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

D.4.1.1 Description of <properties> Element

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 -->
<properties>
 ...Property definitions here...
</properties>

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

D.4.2 <property> Element

The <property> element has the following structure:

<property name="cdata">
  ...pcdata...
</property>

D.4.2.1 Attribute of <property> Element

The <property> element has a single attribute, name, which specifies the property name.

D.4.2.2 Description of <property> Element

Property is a name-value pair. Specify the internal property name (key) to the name attribute and the value to the element value. The internal property names used in the configuration file are listed in the property descriptions in Chapter 12, "Defining Run-Time Configurations."

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

D.5 Font Definitions

Font definitions include the following elements:

For the list of Truetype and Type1 fonts, see Section D.6, "Predefined Fonts."

D.5.1 <fonts> Element

The <fonts> element is structured as follows:

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

D.5.1.1 Attribute of <fonts> Element

The <fonts> element has a single optional attribute, locales, which specifies the locales for this font definition.

D.5.1.2 Description of <fonts> Element

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

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

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

D.5.2 <font> Element

Following is the structure of the <font> element:

<font family="cdata" style="normalitalic"
weight="normalbold">
   <truetype>...</truetype>
or <type1> ... <type1>
</font>

D.5.2.1 Attributes of <font> Element

The <font> element has the attributes described in Table D-2.

Table D-2 font Element Attributes

Attribute Description

family

Specify any family name for the font. If you specify "Default" for this attribute, then 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.


D.5.2.2 Description of <font> Element

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>

D.5.3 <font-substitute> Element

Following is the structure of the <font-substitute> element:

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

D.5.3.1 Attributes of <font-substitute> Element

The <font-substitute> element has a single attribute, name, which specifies the name of the font to be substituted.

D.5.3.2 Description of <font-substitute> Element

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"/>
</font-substitute>

D.5.4 <type1> element

Following is the structure of the <type1> element:

<type1 name="cdata"/>

D.5.4.1 Attribute of <type1> Element

The <type1> element has a single attribute, name, which specifies one of the Adobe standard Latin1 fonts, such as "Courier".

D.5.4.2 Description of <type1> Element

The <type1> element defines an Adobe Type1 font.

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

D.6 Predefined Fonts

The following Type1 fonts are built-in to Adobe Acrobat and BI Publisher provides a mapping for these fonts by default. You can select any of these fonts as a target font with no additional setup required.

The Type1 fonts are listed in Table D-3.

Table D-3 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 Table D-4. All TrueType fonts are subsetted and embedded into PDF.

Table D-4 TrueType Fonts

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)


D.6.1 Included Barcode Fonts

BI Publisher also includes the barcode fonts that are described in Table D-5.

Table D-5 Barcode Fonts

Font File Supported Algorithm

128R00.TTF

code128a, code128b, and code128c

B39R00.TTF

code39, code39mod43

UPCR00.TTF

upca, upce


For information on using barcode fonts in an RTF template, see Using the Barcodes Shipped with BI Publisher, Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.