XML Publisher Configuration File

Properties set in the Administration interface (see Administration) can also be set using a configuration file. The configuration file is optional. There is no default configuration file in the system.

If you defined properties in the Administration interface and have defined the same properties in a configuration file, the properties defined in the Administration interface will take precedence.

Attention: It is strongly recommended that you set up a temporary directory for processing large files. If you do not, you will encounter "Out of Memory" errors when processing large files. Create a temporary directory using the Administration interface or by defining the system-temp-dir property (described below).

It is also recommended that you secure the configuration file if you use it to set the PDF security passwords.

When You Must Set a Configuration File

The Administration interface supports the setting of properties at the site level, the data definition level, and the template level. If you have XML Publisher installed on multiple middle tier machines and you want to set a property at the server level, you must use a configuration file.

File Name and Location

You must name this file xdo.cfg and place it under <XDO_TOP>/resource.

Alternatively, you can place the configuration file under <JRE_TOP>/jre/lib.

Note: <JRE_TOP> refers to AF_JRE_TOP for the concurrent node or OA_JRE_TOP for the Web node.

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: