Oracle Business Intelligence Publisher Administrator's and Developer's Guide Release 10.1.3.4 Part Number E12188-01

Contents

Previous

Next

Configuration File Reference

BI Publisher Configuration Files

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

• Runtime Configuration Properties File

• Server Configuration File

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:

• System Maintenance Server Configuration

• System Maintenance Scheduler Configuration

• Security Center Security Configuration

Setting Properties in the Runtime Configuration File

As of the BI Publisher Enterprise version 10.1.3.2, 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.

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. See List of Properties for the list of the internal property names.

<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

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:

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

The Server Configuration Files

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

• System Maintenance Server Configuration

• System Maintenance Scheduler Configuration

• Security Center Security Configuration

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="http://xmlns.oracle.com/oxp/xmlp">

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:

<url>

<username>

<password>

<driver>

Example:

<resource>
 <xdb path="/public/Reports">
   <connection>
     <connectionType>jdbc</connectionType>
     <url>jdbc:oracle:thin:@rpts.mycompany.com:1525:ora10g</url>
     <username>scott</username>
     <password>tiger</password>
     <driver>oracle.jdbc.driver.oracleDriver</driver>
   </connection>
  </xdb>
</resource>

jndi connectionType

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

<jndiName>

Example:

<resource>
  <xdb path="/public/Reports">
   <connection>
     <connectionType>jndi</connectionType>
     <jndiName>jdbc/pool/mydb</jndiName>
   </connection>
  </xdb>
</resource>

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

Example:

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

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.

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.

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="http://xmlns.oracle.com/oxp/xmlp">
 <resource>
   <file path="d:/reports"/>
<! -     <xdb path="/public/Reports"> - >
<! -       <connection> - >
<! -         <connectionType>jndi</connectionType> - >
<! -         <jndiName>jdbc/pool/mydb</jndiName> - >
<! -       </connection> - >
<! -     </xdb> - >
 </resource>
</xmlpConfig>

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="http://xmlns.oracle.com/oxp/xmlp">
 
<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" 
          value="ldap://myldapserver.com:3060/"/>
<property name="LDAP_PROVIDER_ADMIN_USERNAME" value="orcladmin"/>
<property name="LDAP_PROVIDER_ADMIN_PASSWORD" value="welcome1"/>
<property name="LDAP_PROVIDER_USER_DN" 
          value="cn=xdo,dc=myserver,dc=com"/>
</xmlpConfig>

Copyright © 2004, 2008, Oracle and/or its affiliates. All rights reserved.