文書テンプレートの設計

文書テンプレートは、レポートの構成、レイアウト、および コンテンツを定義するものです。適切なテンプレートを作成するには、テンプレートの計画、開発、テスト、および保管が必要です。

手順

統合アプリケーションで使用するテンプレートを提供している場合は、『統合アプリケーションで使用するレポートの作成 (Creating reports for use in integrated applications)』シナリオを参照してください。

サポート概念
文書テンプレートを作成するには、以下のステップを実行します。

1: 要求の収集

ニーズが異なると 異なる設計が要求されます。テンプレートの設計を開始する前に、 文書のビジネス・ニーズおよび実際的な要求を 判別します。

データ・エレメント
さまざまなタイプの情報を表示する多様なテンプレート・エレメントが あります。文書を参照する個人はどのような 情報を必要としているでしょうか。それがわかると、データ・エレメントの決定を 開始することができます。
  • どのテンプレート・エレメントがそのデータを表示するか。最終的な文書で どのように表示されるか。
  • 情報を表示するために複数の方法はないか。その場合は、対象文書内のコンテキストを表示するためにどの表示が 最適か。
  • どのくらいのデータ量が必要か。不必要なデータをフィルターに掛けて除外し、 レポート出力を生成するときに時間を節約することができます。
出力タイプ
文書を参照する個人のニーズを最も満たすのはどの出力タイプかを 考慮します。生成時の出力タイプが異なれば、設計するテンプレートの外観も異なってくる場合があります。いくつかの要素は、特定のフォーマットで表示するように最適化されており、いくつかの要素は特定のフォーマットでは サポートされていません。テンプレート・エレメントが異なる出力フォーマットで 表示される方法を良く知っておいてください。これにより、 最適な要素と出力タイプの組み合わせを選択できるようになります。
1 つのテンプレートと複数のテンプレート
1 回使用のテンプレートか、または他のテンプレート内でいくつかの部分を 再利用できるようにしますか。
  • 1 つのテンプレート: 文書の設計のさまざまな部分をすべて含む 1 つのテンプレートを使用できます。これは、すべてが 1 つの場所にあり、 マージが必要ないことを意味します。
  • 複数のテンプレート: 複数のテンプレートを作成し、それらをマージして 1 つの完全な文書を作成する、モジュラー手法を使用できます。 例えば、目次のテンプレート、表紙のテンプレート、データのテンプレート、索引のテンプレート、および裏表紙のテンプレートを作成できます。これらのテンプレートは、別の文書の生成に再利用できます。
これらの要件を前提として、必要なテンプレートの数を判断します。メタデータ属性で、各テンプレート・ブロックの名前付けと説明を行うことができます。名前の内容はテンプレートに表示され、説明の内容はテンプレート・エレメントのヒント・フィールドに表示されます。
コンテキストの表示
この文書の参照方法は何か。
  • 印刷されるのか。スクリーンに表示するのか。両方か。
  • 統合製品で実行されるのか。
サポート概念

2: テンプレートの設計

テンプレートを設計するときは、以下の方法によって時間を有効に使用できます。
  • 文書でよく使用する可能性のあるページ・サイズ、方向、マージン、列の数、および段落タイプのスタイルなどの、ページ・レイアウトの特定プロパティーを備えるようにテンプレートを設計できます。
  • テンプレートには、以下のものを含めることができます。
    • 文書構造要素 (段落、テーブル、リスト、目次など)。
    • 文書レイアウトのブロック (マスター・ページ、スタイル・シート、ヘッダー、フッターなど)。
    • 内部および外部ユーザー定義のスタイル (テキストまたは段落の書式設定など)。テキストの書式設定には、太字、斜体、下線、フォント・サイズ、およびフォントの色があります。段落の書式設定には、マージン、境界線、インデント、および JavaScript 形式でのスクリプト・パラメーターがあります。
    • 埋め込みテンプレート・コンテンツ (イメージ、静的テキスト、静的ファイルとスタイル・シートへの参照など)。
    • データ・エレメント (属性、条件、動的データ・エレメントなど)
    • 照会およびフィルターの形式でのデータ抽出。
    • 実行時に値を受け取る外部変数および計算に使用される内部変数。テンプレート内のデータ・ソース URL のハードコーディングには、外部変数の作成をお勧めします。URL にハードコーディングを行って、サーバー名が変更された場合、各テンプレートの URL の更新が必要になります。外部変数を使用すると、実行時に URL をオーバーライドできます。他の製品に埋め込まれたテンプレートについては、データの参照時にそれらの製品で認識される特殊変数を使用してください。
  1. Document Studio を開始します。
  2. 最初から、または既存のテンプレートに基づいて、新規テンプレートを作成します。
  3. データ・ソース・スキーマを追加します。
  4. 要素を追加します。
  5. 要素にフォーマットを追加します。
  6. 動的コンテンツを定義します。
  7. オプション: データをフィルター、ソート、または条件で絞り込みます。

3: テンプレートのテスト

  1. 検証ツールを実行します。
  2. プレビューを生成します。
サポート・タスク:

4: テンプレートの保管

次のステップ

テンプレートを作成して テストした後の手順:

フィードバック