文書テンプレートは、レポートの構成、レイアウト、および
コンテンツを定義するものです。適切なテンプレートを作成するには、テンプレートの計画、開発、テスト、および保管が必要です。
1: 要求の収集
ニーズが異なると
異なる設計が要求されます。テンプレートの設計を開始する前に、
文書のビジネス・ニーズおよび実際的な要求を
判別します。
- データ・エレメント
- さまざまなタイプの情報を表示する多様なテンプレート要素が
あります。文書を参照する個人はどのような
情報を必要としているでしょうか。それがわかると、データ・エレメントの決定を
開始することができます。
- どのテンプレート要素がそのデータを表示するか。最終的な文書で
どのように表示されるか。
- 情報を表示するために複数の方法はないか。その場合は、対象文書内のコンテキストを表示するためにどの表示が
最適か。
- どのくらいのデータ量が必要か。不必要なデータをフィルターに掛けて除外し、
レポート出力を生成するときに時間を節約することができます。
- 出力タイプ
- 文書を参照する個人のニーズを最も満たすのはどの出力タイプかを
考慮します。生成時の出力タイプが異なれば、設計するテンプレートの外観も異なってくる場合があります。いくつかの要素は、特定のフォーマットで表示するように最適化されており、いくつかの要素は特定のフォーマットでは
サポートされていません。テンプレート要素が異なる出力フォーマットで
表示される方法を良く知っておいてください。これにより、
最適な要素と出力タイプの組み合わせを選択できるようになります。
- 1 つのテンプレートと複数のテンプレート
- 1 回使用のテンプレートか、または他のテンプレート内でいくつかの部分を
再利用できるようにしますか。
- 1 つのテンプレート: 文書設計のさまざまな部分をすべて含む
1 つのテンプレートを使用できます。これは、すべてが 1 つの場所にあり、
マージが必要ないことを意味します。
- 複数のテンプレート: 複数のテンプレートを作成し、それらをマージして
1 つの完全な文書を作成する、モジュラー手法を使用できます。
例えば、目次のテンプレート、表紙のテンプレート、データのテンプレート、索引のテンプレート、および裏表紙のテンプレートを作成できます。これらのテンプレートは、別の文書の生成に再利用できます。
これらの要件を前提として、必要なテンプレートの数を判断します。メタデータ属性で、各テンプレート・ブロックの名前付けと説明を行うことができます。名前の内容はテンプレートに表示され、説明の内容はテンプレート要素のヒント・フィールドに表示されます。
- コンテキストの表示
- この文書の参照方法は何か。
- 印刷されるのか。スクリーンに表示するのか。両方か。
- 統合製品で実行されるのか。
2: テンプレートの作成
テンプレートを
作成するときは、以下の方法によって時間を有効に使用することができます。
- トップダウン方式を使用して、テンプレートの全体的な構造を実装します。最も一般的な要素から開始して、徐々に詳細を
実装します。
- 詳細をフォーマット設定する前に、データ生成を検証します。
フォーマット設定に多くの時間を費やしてから、データが正しく生成されていないことが分かった場合は、再フォーマットしなければなりません。(詳しくは、"3.
テンプレートのテスト"を参照してください。)
- 詳細を精査して、より詳細な要件を 1 つずつ追加していきます。あまり重要でない詳細や難しい詳細はそのままにしておいて、後で実装するようにします。費用対効果分析で行うのと同じように、認識が難しい要件の関連性を考慮します。
- Rational Publishing Engine で効率的に取り込むことができる形式で情報を抽出するために、スクリプトを使用することを考慮してください。
- 文書でよく使用する可能性のあるページ・サイズ、方向、マージン、列の数、および段落タイプのスタイルなどの、ページ・レイアウトの特定プロパティーを備えるようにテンプレートを設計できます。
- テンプレートには、以下のものを含めることができます。
- 文書構造要素 (段落、テーブル、リスト、目次など)。
- 文書レイアウトのブロック (マスター・ページ、スタイル・シート、ヘッダー、フッターなど)。
- 内部および外部ユーザー定義のスタイル (テキストまたは段落の書式設定など)。テキストの書式設定には、太字、斜体、下線、フォント・サイズ、およびフォントの色があります。段落の書式設定には、マージン、罫線、インデント、および JavaScript 形式でのスクリプト・パラメーターがあります。
- 埋め込みテンプレート・コンテンツ (イメージ、静的テキスト、静的ファイルとスタイル・シートへの参照など)。
- データ・エレメント (属性、条件、動的データ・エレメントなど)
- 照会およびフィルターの形式でのデータ抽出。
- 実行時に値を受け取る外部変数および計算に使用される内部変数。テンプレート内のデータ・ソース URL のハードコーディングには、外部変数の作成をお勧めします。URL にハードコーディングを行って、サーバー名が変更された場合、各テンプレートの URL の更新が必要になります。外部変数を使用すると、実行時に URL をオーバーライドできます。他の製品に埋め込まれたテンプレートについては、データの参照時にそれらの製品で認識される特殊変数を使用してください。
- Document Studio を開始します。
- 最初から、または既存のテンプレートに基づいて、新規テンプレートを作成します。
- データ・ソース・スキーマを追加します。
- 要素を追加します。
- 要素にフォーマットを追加します。
- 動的コンテンツを定義します。
- オプション: データをフィルター、ソート、または条件で絞り込みます。
3: テンプレートのテスト
- テストは、開発中に少しずつ実行されます。頻繁に、かつ固有の名前で保存してください。小規模のテスト・データ・セットを使用して、頻繁に出力を確認してください。既に指定してあるものが動作するまで要素を追加しないでください。
- 文書の大部分の開発後に、ロード・テストを実行して、パフォーマンスに関する問題を確認します。「プレビュー」ツールを使用して、使用するデータのサイズを制限します。生成されるレポートは正確でありながらもより迅速に実行されます。これは、Rational Publishing Engine で取得される 1 つの照会あたりのデフォルトの最大レコード数が 10 だからです。条件をテストするとき、最初の 10 件のレコードで条件を満たすものがない場合があります。このような場合は、「プレビュー」ツールの代わりに「実行」ツールを使用するか、「設定」で 1 照会あたりの最大レコード数の値を変更します。
- 異なる出力形式でテンプレートをテストします。ある出力タイプではテンプレートが表示されず、別の出力タイプでも同様である場合があります。
- 検証ツールを実行します。
- プレビューを生成します。
4: テンプレートの保管
- 開発し、テストしたテンプレートをセントラル・ファイル・サーバーに保存します。セントラル管理コンポーネント をストレージ・ロケーションとして
使用できます。
- 他のユーザーにテンプレート再利用の方法がわかるように、テンプレート・メタデータに情報を提供しておくことを忘れないでください。プロジェクトのサンプル・データやサンプル文書仕様の情報が、これらのテンプレートの再利用に効果的に役立つ場合があります。
次のステップ
テンプレートを作成して
テストした後の手順:
- オプション: 追加テンプレートを作成して統合します。作成する必要がある
追加テンプレートに対してステップ 2 から 4 を繰り返し、
それらをマージします。
- 文書構成の定義
- アーカイブの作成
- 文書の発行