ヘッダーをスキップ

# 構成ファイル・リファレンス

## BI Publisher構成ファイル

この章では、次のBI Publisher構成ファイルに関する参照情報について説明します。

- ランタイム構成プロパティ・ファイル

- サーバー構成ファイル

ランタイム構成ファイルのプロパティは、「ランタイム構成」の「プロパティ」ページおよび「フォント・マッピング」ページで設定します（「ランタイム・プロパティの設定」を参照）。サーバー構成ファイルのプロパティは、次の「管理」ページで設定します。

- 「システム・メンテナンス」の「サーバー構成」

- 「システム・メンテナンス」の「スケジューラ構成」

- 「セキュリティ・センター」の「セキュリティ構成」

## ランタイム構成ファイルでのプロパティの設定

BI Publisher Enterpriseリリース10.1.3.2では、ランタイム・プロパティは「管理」インタフェースにおける「ランタイム構成」の「プロパティ」ページおよび「フォント・マッピング」ページで設定します。

「管理」インタフェースを使用してプロパティを設定しないと、BI Publisherではこのファイルに設定されているプロパティにリセットします。そのため、XML Publisher Enterprise 5.6.2からアップグレードする場合、既存のxdo.cfgファイルの設定を使用することができますが、このファイルの設定を「管理」インタフェースに移行することをお薦めします。詳細は、「XML Publisher Enterprise 5.6.2からBI Publisher10.1.3.2へのアップグレード」を参照してください。

ただし、「管理」インタフェースではこのファイルは更新されないので、注意してください。「管理」インタフェースにおける設定は、xdo.cfgファイルの設定よりも優先されます。

### ファイル名と位置

構成ファイルの名前はxdo.cfgです。

このファイルは<JRE_TOP>/jre/libにあります（たとえば、jdk/jre/lib）。

### ネームスペース

この構成ファイルのネームスペースは次のとおりです。

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

### 構成ファイルの例

次に、構成ファイルのサンプルを示します。

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

### 要素仕様の解釈方法

次に、要素仕様の例を示します。

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

[occurrence-spec]は、要素のカーディナリティを示し、次のパターンに対応します。

- [0..1]: 要素がオプションで、1回のみ発生する可能性があることを示します。

- [0..n]: 要素がオプションで、複数回発生する可能性があることを示します。

## 構造

<config>要素はルート要素です。構造は次のとおりです。

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

### 属性

変数 | 説明
--- | ---
version | 構成ファイル形式のバージョン番号。1.0.0を指定します。
xmlns | BI Publisher構成ファイルのネームスペース。http://xmlns.oracle.com/oxp/config/を指定する必要があります。

### 説明

構成ファイルのルート要素。この構成ファイルは、次の2つの部分で構成されています。

- プロパティ（<properties>要素）

- フォント定義（<fonts>要素）

<fonts>および<properties>要素は、複数回出現する可能性があります。競合する定義が設定されている場合は、最後に出現した定義が優先されます。

## プロパティ

この項では、<properties>要素と<property>要素について説明します。

### <properties>要素

properties要素の構造は次のとおりです。

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

### 説明

<properties>要素では、一連のプロパティを定義します。ロケール固有のプロパティを定義するには、ロケール属性を指定します。次に例を示します。

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

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

### <property>要素

<property>要素の構造は次のとおりです。

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

### 属性

変数 | 説明
--- | ---
name | プロパティ名を指定します。

### 説明

プロパティは名前と値のペアです。名前属性に内部プロパティ名（キー）を、要素値にその値を指定します。内部プロパティ名の一覧は、「ランタイム・プロパティの設定」を参照してください。

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

## フォント定義

フォント定義には、次の要素が含まれます。

- <fonts>

- <font>

- <font-substitute>

- <truetype>

- <type1>

TrueTypeおよびType1フォントのリストについては、「事前定義済のフォント」を参照してください。

### <fonts>要素

<fonts>要素の構造は次のとおりです。

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

### 属性

変数 | 説明
--- | ---
locales | このフォント定義のロケールを指定します。この属性はオプションです。

### 説明

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

<font>要素の構造は次のとおりです。

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

### 属性

変数 | 説明
--- | ---
family | フォントのファミリ名を指定します。この属性にDefaultを指定した場合、デフォルトの代替フォントを定義できます。family属性では大/小文字が区別されません。
style | フォント・スタイルのnormalまたはitalicを指定します。
weight | フォント太さのnormalまたはboldを指定します。

### 説明

BI Publisherフォントを定義します。この要素は、主にFOからPDFへの処理（RTFからPDF）用のフォントを定義するために使用されます。PDFフォーム・プロセッサ（PDFテンプレート用）は、この要素を参照しません。

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

### <font-substitute>要素

font-substitute要素の構造は次のとおりです。

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

### 属性

変数 | 説明
--- | ---
name | 代替するフォントの名称を指定します。

### 説明

フォントの代替を定義します。この要素は、PDFフォーム・プロセッサ用のフォントを定義するために使用されます。

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

### <type1>要素

<type1>要素の形式は次のとおりです。

    <type1 name="cdata"/>

### 属性

変数 | 説明
--- | ---
name | Adobe標準のLatin1フォントのいずれかを指定します。たとえば、Courierなどです。

### 説明

<type1>要素では、Adobe Type1フォントを定義します。

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

## 事前定義済のフォント

BI Publisherには、事前定義済のフォントがいくつかあります。これらのフォントについては、さらに設定を行う必要はありません。

事前定義済のフォントについては、「BI Publisherの事前定義済のフォント」を参照してください。

## サーバー構成ファイル

サーバー構成プロパティは、「管理」タブにある次のページで設定します。

- 「システム・メンテナンス」の「サーバー構成」

- 「システム・メンテナンス」の「スケジューラ構成」

- 「セキュリティ・センター」の「セキュリティ構成」

リポジトリの場所は「システム・メンテナンス」の「サーバー構成」で定義しますが、この場所に関する情報は、WEB-INF/xmlp-server-config.xmlに保存されています。

その他のすべてのサーバー構成プロパティは、xmlp-server-config.xmlの2番目のインスタンスに格納されます。このファイルは、リポジトリのAdmin/Configuration/xmlp-server-config.xmlにあります。

「管理」ユーザー・インタフェース・ページでは、これら2つのファイルに設定が書き込まれます。そのため、ファイルは手動で更新できますが、お薦めしません。理由としては、このユーザー・インタフェースにより、関連するプロパティ設定の妥当性が確保されるためです。

重要: この構成ファイルのプロパティを変更した場合は、変更を有効にするためにサーバーを再起動する必要があります。

### 構成ファイルの構造

このファイルは、XMLヘッダー、リソース、スケジューラおよび一般プロパティの各セクションで構成されます。

### XMLヘッダー

このヘッダーは、XML宣言、およびネームスペース属性が含まれたルート要素で構成されます。

    <?xml version="1.0" encoding="UTF-8"?>
    <xmlpConfig xmlns="http://xmlns.oracle.com/oxp/xmlp">

### リソース・セクション

注意: 現在、リポジトリの場所は「サーバー構成」ページを使用して設定されます。詳細は、「サーバー構成オプションの設定」を参照してください。

リソース・セクションにはリポジトリの場所を定義します。リソース・セクションは必須です。リソース要素は、<resource>タグと</resource>タグで囲まれます。

<resource>タグ内に、<file>要素または<xdb>要素のいずれかを定義して、レポート・リポジトリのパスを指定する必要があります。

### <file>要素

レポート・リポジトリがファイル・システムに存在する場合は、次のようにファイル要素でパス属性を指定して絶対ファイル・パスを宣言します。

<file path=""/>

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

### <xdb>要素

レポート・リポジトリがデータベース上に設定されている場合は、次のようにxdb要素でパス属性を指定して絶対パスを宣言します。

<xdb path="">

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

xdb要素には<connection>要素が必要です。<connection>タグと</connection>タグの間に<connectionType>を定義します。<connectionType>の有効な値はjdbcまたはjndiです。

### jdbc connectionType

<connectionType>がjdbcの場合は、次の要素が必要です。

<url>

<username>

<password>

<driver>

例:

    <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

接続タイプがjndiの場合は、次の要素が必要です。

<jndiName>

例:

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

### 「一般」プロパティ

次の表に、構成ファイルで指定できる一般プロパティを示します。プロパティは次の構文に従って指定します。

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

例:

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

「管理」の「サーバー構成」ページを使用して、次のプロパティを設定します（「サーバー構成オプションの設定」を参照）。ただし、「ゲスト」フォルダへのアクセスは除きます。「ゲスト」フォルダへのアクセスは、「セキュリティ構成」ページで設定します（「ゲスト・アクセスの許可」を参照）。

ここにリストされているプロパティは必須ではありません。指定しない場合は、デフォルト値が使用されます。次の表に、各プロパティの名前、有効値、デフォルト値および説明を示します。

プロパティ名 | 値 | 説明
--- | --- | ---
CACHE_EXPIRATION | デフォルト: 30 | データセット・キャッシュの有効期限を分単位で入力します。 SQL問合せを実行するレポートの場合は、問合せで戻されるデータセットをキャッシュするオプションがあります。戻されたデータセットは、このプロパティで指定された期間キャッシュに保持されます。このオプションの設定方法の詳細は、「新規レポートの作成」を参照してください。
CACHE_SIZE_LIMIT | デフォルト: 1000 | 指定された時間キャッシュに保持されるデータセットの最大数を設定します。
CACHED_REPORT_LIMIT | デフォルト: 50 | 指定された時間メモリーにキャッシュできるレポート数を指定します。
OUTPUT_FORMAT | html、pdf、rtf、excel、xml | デフォルトで、すべてのレポートが、このプロパティで指定された出力タイプでユーザーに表示されます（PDFテンプレートで出力できるのは、引き続きPDF出力のみです）。各出力タイプはカンマで区切って入力します。有効な値は、html、pdf、rtf、excel、xmlです。 この値は、レポート定義で選択される「出力フォーマット」タイプで上書きされます。「新規レポートの作成」を参照してください。
DEBUG_LEVEL | exception（デフォルト）、debug | システムで生成されるデバッグ情報の量を制御します。exceptionに設定すると、エラー情報のみが生成されます。debugに設定すると、すべてのシステム出力が生成されます。
GUEST_FOLDER | true（デフォルト）、false | 現在のインストール環境でゲスト・フォルダを使用可能にします。ゲスト・フォルダは、ログインURLを表示できるすべてのユーザーがアクセスできるパブリック・フォルダです。ゲスト・フォルダ内のレポートを表示するための資格証明は必要ありません。
GUEST_FOLDER_NAME | デフォルト: Guest | ゲスト・フォルダの名前を設定します。

BI Publisher EnterpriseでLDAPサーバーを使用する場合は、次のプロパティを指定する必要があります。これらのプロパティは、「管理」ユーザー・インタフェースで設定します。LDAP統合の詳細は、「LDAPとの統合」を参照してください。

プロパティ名 | 値 | 説明
--- | --- | ---
LDAP_PROVIDER_URL | 例: ldap://myserver.mycompany.com:3060/ | LDAPサーバーのURLを入力します。
LDAP_PROVIDER_ADMIN_USERNAME | 例: Admin | LDAPサーバーの管理者ユーザー名を入力します。
LDAP_PROVIDER_ADMIN_PASSWORD | 例: welcome | 入力したユーザー名の管理者パスワードを入力します。
LDAP_PROVIDER_USER_DN | 例: cn=xdo,dc=myserver,dc=com | BI Publisherにアクセス可能なユーザーのグループを識別するLDAP識別名のユーザー・サフィックス。
LDAP_PROVIDER_FACTORY | 例: com.sun.jndi.ldap.ctl.LdapCtxFactory | このプロパティの値は、LDAPサービス・プロバイダの初期コンテキストを作成するファクトリ・クラスの完全修飾クラス名です。特定のLDAPサービス・プロバイダの選択に使用されます。プロバイダ自体では使用されません。このプロパティは、初期コンテキスト・メソッドに対する名前引数がURLである場合、設定する必要はありません。
LDAP_PROVIDER_GROUP_SEARCH | 例: (&amp;(objectclass=groupofuniquenames)(cn=*)) | 修飾グループを検索するための検索基準。LDAPサーバー・スキーマに基づきます。
LDAP_PROVIDER_GROUP_SEARCH_ROOT | 例: cn=OracleDefaultDomain,cn=OracleDBSecurity,cn=Products,cn=OracleContext,dc=mypc11,dc=com | グループ検索基準を適用するツリー構造内の場所を示します。
LDAP_PROVIDER_GROUP_ATTR_NAME | 例: cn | グループ名が含まれる属性を示します。
LDAP_PROVIDER_GROUP_ATTR_MEMBER | 例: uniquemember | グループのメンバー名が含まれる属性を示します。
LDAP_PROVIDER_GROUP_ATTR_DESCRIPTION | 例:description | グループの説明が含まれる属性を示します。

次の表にOracle Single Sign-Onのプロパティを示します。これらのプロパティは「管理」インタフェースで設定されます。Single Sign-Onの設定方法の詳細は、「Oracle Single Sign-Onの設定」を参照してください。

プロパティ名 | 値 | 説明
--- | --- | ---
SINGLE_SIGN_OFF_URL | 例: http://server1.mycompany.com:7777/pls/orasso/orasso.wwsso_app_admin.ls_logout | SSOパートナ・アプリケーション・ログイン・ページから取得したシングル・サインオフURLを入力します。

### サンプル構成ファイル

次に、リポジトリ情報が含まれるWEB-INF/xmlp-server-config.xmlファイルのサンプルを示します。

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

次に、BI Publisherサーバーの一般プロパティおよびLDAPプロパティが含まれるAdmin/Configuration/xmlp-server-config.xmlファイルのサンプルを示します。

    <?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 © 2005, 2006, Oracle. All rights reserved.