12 サブテンプレートの理解

ここでは、サブテンプレート使用の概念について説明します。サブ・テンプレートは、書式設定機能のひとつで、一度定義すれば、単一のレイアウト・テンプレートで、または複数のレイアウト・テンプレート間で何度も使用できます。

内容は次のとおりです。

RTFサブテンプレートの設計の詳細は、「RTFサブテンプレートの設計」を参照してください。XSLサブテンプレートの設計の詳細は、「XSLサブテンプレートの設計」を参照してください。

サブ・テンプレートとは

サブ・テンプレートは、書式設定機能のひとつで、一度定義すれば、単一のレイアウト・テンプレートで、または複数のレイアウト・テンプレート間で何度も使用できます。

この書式設定には、RTFファイル形式またはXSLファイル形式を使用できます。RTF形式のサブ・テンプレートは、Microsoft Wordのネイティブ機能を使用するため、容易に設計できます。XSL形式のサブ・テンプレートは、複雑なレイアウトやデータ要件の場合に使用します。

サブ・テンプレートの一般的な用途のいくつかを次に示します。

共通のレイアウトまたはコンポーネントの再利用(ヘッダー、フッター、アドレス・ブロックなど)
パラメータ化されたレイアウトの処理
動的または条件付きのレイアウトの処理
時間のかかる計算の処理や数式の再利用

RTFサブテンプレートについて

RTFサブ・テンプレートは、1つ以上の<?template:?>定義で構成されたRTFファイルで、定義のそれぞれに書式設定またはコマンドのブロックが含まれています。

このRTFファイルは、BI Publisherにカタログのサブテンプレート・オブジェクトとしてアップロードされるとき、別のRTFテンプレート内からコールすることができます。

XSLサブテンプレートについて

XSLサブテンプレートとは、BI Publisherの書式設定エンジンが実行するXSLの書式設定コマンドまたは処理コマンドが含まれているXSLファイルです。RTF標準ではサポートされていない複雑な計算または書式設定命令を含めるには、XSLテンプレートを使用します。

このXSLファイルは、BI Publisherにカタログのサブテンプレート・オブジェクトとしてアップロードされるとき、別のRTFテンプレート内からコールすることができます。

サブ・テンプレートがサポートされている場所

サブ・テンプレートはBI Publisherのカタログにアップロードすることをお薦めします。

カタログは最も安全な場所です。

古いバージョンのBI Publisherとの互換性のため、ローカル・サーバーや別のサーバーのファイルにあるサブ・テンプレートのコールができます(その場合はHTTPプロトコル経由でアクセスします)。このような方法を使用するには、通信できるようにするために、特定のインポート構文およびサーバー設定が必要です。詳細は、「外部ソースからのサブテンプレートのコール」を参照してください。

デスクトップからのサブ・テンプレートのテスト

BI Publisherテンプレート・ビルダーをインストール済の場合は、テンプレートおよびサブ・テンプレートをBI Publisherカタログにアップロードする前に、これらの組合せをプレビューできます。

ローカル環境からテストするには、BI Publisherプロセッサがローカル・ディレクトリのサブ・テンプレート・ファイルを検出できるように、インポート・テンプレート構文を変更する必要があります。テストするには、次のようなインポート・テンプレート構文を入力します。

<?import:file:{local_template_path}?>

次に例を示します。

<?import:file:C:///Template_Directory/subtemplate_file.rtf?>

または、XSLサブ・テンプレート・ファイルでは次のようになります。

<?import:file:C:///Template_Directory/subtemplate_file.xsl?>

次にテンプレート・ビルダーで「プレビュー」オプションを選択すると、BI Publisherプロセッサがサブ・テンプレートを検出し、ローカル環境から表示できるようになります。

プライマリ・テンプレートをBI Publisherカタログにアップロードする前に、カタログの適切な場所をポイントするようにインポート構文を変更する必要があります。

サブ・テンプレートのアップロード

BI Publisherで使用するために、1つ以上のサブ・テンプレートをアップロードできます。

サブ・テンプレート・ファイルをアップロードするには:

グローバル・ヘッダーで、「新規」をクリックし、「サブ・テンプレート」をクリックします。サブ・テンプレートページが表示されます。
「テンプレート」リージョンで、「アップロード」をクリックします。
「テンプレート・ファイルのアップロード」ダイアログで、アップロードするサブ・テンプレート・ファイルを選択します。
- タイプ: RTFサブ・テンプレート・ファイルの場合はrtf、XSLサブ・テンプレート・ファイルの場合はxslを選択します。
- ロケール: サブ・テンプレート・ファイルの該当するロケールを選択します。
「アップロード」をクリックします。
サブ・テンプレート・ファイルが、「テンプレート」リージョンに、選択したロケール名で表示されます(例: English)。
「保存」をクリックします。「別名保存」ダイアログで、サブ・テンプレートを保存するカタログ・フォルダを選択します。「名前」に名前を入力し、「保存」をクリックします。次の図は、My Subtemplateと命名されたサブ・テンプレートを示しています。

図GUID-E96873F2-F405-4ECB-BAB0-7A2C556DB983-default.gifの説明
(RTFサブ・テンプレートのみ)複数のローカライズ済ファイルをアップロードしている場合は、デフォルトとして使用するファイルを選択します。テンプレート・ファイルのローカライゼーションの詳細は、「RTFサブテンプレートへの翻訳の追加」を参照してください。
ノート:
サブ・テンプレートの定義にアップロードできるRTFファイルは1ロケールに1つのみです。このサブ・テンプレートに追加のテンプレート・ファイルをアップロードした場合は、アップロード前の名前に関係なく、各ファイルにロケールとしての名前が自動的に付けられます。

ノート:
XSLサブ・テンプレートでは、翻訳はサポートされていません。

サブ・テンプレート・オブジェクトは、.xsbという拡張子で保存されることに注意してください。サブ・テンプレート・オブジェクトをインポートするときは、ここで選択した名前に.xsb拡張子を付けた名前を使用します(例: MySubtemplate.xsb)。

外部ソースからのサブ・テンプレートのコール

ここでは、カタログの外部にあるサブ・テンプレートをコールする方法について説明します。

ノート:

これらの指示は、下位互換性のためにのみ提供されています。サブ・テンプレートはカタログに配置することをお薦めします。

カタログの外部で管理されているサブ・テンプレートについては、ローカライゼーションはサポートされていません。

HTTPまたはFTP経由でのカタログの外部のサブ・テンプレートのインポート

httpやftpなどの標準プロトコルを使用して、次のようなインポート文を入力します。

<?import:http//myhost:8080/subtemplate.rtf?>

同じサーバー上のカタログの外部のサブ・テンプレートのインポート

サブテンプレートがサーバー上にあり、BI Publisherカタログ内にはない場合、次のように入力します。

<?import:file://{template_path}?>

説明

template_pathはサーバー上にあるサブ・テンプレート・ファイルへのパスです

次に例を示します。

<?import:file://c:/Folder/mySubtemplate.rtf?>

カタログの外部に格納されているサブ・テンプレートの実行に必要な設定

カタログ外にあるサブ・テンプレートを実行するには、「外部参照無効化」プロパティを構成する必要があります。

サブ・テンプレートを使用するには、レポート用に次のFO処理構成プロパティを設定する必要があります。

外部参照無効化: Falseに設定する必要があります