Oracle Fusion Middleware Administrator's Guide for Oracle Business Intelligence Publisher Release 11g (11.1.1) Part Number E13880-02

Contents

Previous

Next

Configuration File Reference

This appendix covers the following topics:

• BI Publisher Configuration Files
• Setting Properties in the Runtime Configuration File
• Structure
• Properties
• Font Definitions
• Predefined Fonts

BI Publisher Configuration Files

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

• Runtime Configuration Properties File

The properties in the Runtime Configuration file are set through the Runtime Configuration Properties, Currency Formats, and Font Mappings pages (see Setting Runtime Properties).

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, BI Publisher will fall 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 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 <BI Publisher Repository>/Admin/Configuration.

Namespace

The namespace for this configuration file is:

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

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>      

How to Read 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 may occur only once.

• [0..n] - indicates the element is optional, and may occur multiple times.

Structure

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>

Attributes

Description

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.

Properties

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

The <properties> element

The properties element is structured as follows:

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

Description

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>

The <property> element

The <property> element has the following structure:

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

Attributes

Description

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 the Setting Runtime Properties chapter.

<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>

Font Definitions

Font definitions include the following elements:

• <fonts>

• <font>

• <font-substitute>

• <truetype>

• <type1>

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]
</fonts>

Attributes

Description

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>

<font> element

Following is the structure of the <font> element:

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

Attributes

Description

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>

<font-substitute> element

Following is the structure of the font-substitute element:

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

Attributes

Description

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>

<type1> element>

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

<type1 name="cdata"/>

Attributes

Description

<type1> element defines an Adobe Type1 font.

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

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 the following table:

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

Included Barcode Fonts

BI Publisher also includes the following barcode fonts:

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.

Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved.