要件データの書式設定

Word ドキュメントから ALM に要件データをエクスポートするには、その前にデータを段落またはテーブルとして配置しておく必要があります。さらに、要件タイプとユーザ定義フィールドをエクスポートする場合は、まずそれらの定義を ALM プロジェクトからインポートする必要があります。

次に、Microsoft Word Add-in ツールバーのボタンを使用して、要件フィールドにマークを付けます。要件は、ALM にエクスポートしたときに、要件ツリーの同じ階層レベルまたは異なる階層レベルになるように書式設定できます。

Word ドキュメントへの要件データの配置

Word ドキュメントには、要件データを段落またはテーブルとして含めることができます。

データを段落として

データを段落として提供する場合、要件の各フィールドは別々の行にあることが必要です。要件ごとに、要件の名前が最初に現れ、その後に他の要件フィールドが続く必要があります。次の例は、2 つの要件のデータが段落として配置された場合を示しています。

データをテーブルとして

ドキュメントにテーブルが含まれる場合は、各行に要件のデータが含まれている必要があります。最初のカラムは、要件の名前であることが必要です。次の例は、同じ 2 つの要件のデータがテーブルにリストされた場合を示しています。

先頭に戻る

要件タイプのインポート

要件タイプとそれに関連するユーザ定義フィールドの定義を ALM プロジェクトから Word ドキュメントにインポートできます。次に、Word ドキュメントで各要件の要件タイプを定義してエクスポートできます。要件の要件タイプを定義したら、そのタイプの要件で利用可能なユーザ定義フィールドの値をエクスポートできます。

ALM プロジェクトから要件タイプをインポートするには、次の手順を実行します。

  1. をクリックして、Requirement Type Definitions ウィザードを開きます。

  2. ALM URL を http://<ALM サーバ名>[:port]/qcbin の形式で入力し、[Next]をクリックします。

    シングル・サインオンを使用している場合は、[Add basic auth header mode]を有効にします。

    注: Add basic auth header mode]はオプションです。「サーバの応答が無効です」メッセージが表示される場合にのみ有効にしてください。

  3. ALM ユーザ名とパスワードを入力し、[Next]をクリックします。

  4. ALM ドメインとプロジェクトを選択し、[Import]をクリックします。

    アドインによって要件タイプとユーザ定義フィールドが ALM プロジェクトからインポートされます。

  5. アドインが要件タイプとユーザ定義フィールドをインポートすると、[Requirement Type Definitions Wizard - Step 5 of 5]ダイアログ・ボックスが開きます。[Finish]をクリックします。Word ドキュメントで、要件タイプとユーザ定義フィールドが更新されます。

先頭に戻る

要件フィールドのマーク付け

データを段落またはテーブルとして配置したら、要件フィールドにマークを付ける必要があります。要件フィールドをマークするには、テキストを強調表示して、ALM 要件ツールバーの適切なボタンをクリックします。マークしたテキスト行の横にアイコンが追加されます。ブックマークがドキュメントに挿入され、ALM にエクスポートするときに、マークされたテキストをアドインが識別できるようになります。

要件フィールドにマークを付けるときは、次のことを考慮してください。

  • 要件ごとに、要件名を指定する必要があります。また、要件タイプ、レビュー・ステータス、作成者、優先度、説明、およびリッチ・テキストもエクスポートできます。さらに、要件タイプをエクスポートする場合は、そのタイプで利用可能なユーザ定義フィールドのデータをエクスポートできます。

  • 要件ツリーに同じ名前の要件が存在する場合、要件のフィールドは新しい値を含むように変更されます。ドキュメントに要件が 2 つ含まれていて、それの階層レベルも名前も同じ場合は、2 番目の要件のみが作成されます。

  • レビュー・ステータスが指定されないときの標準設定値はレビュー未完了です。

  • 各フィールドのデータは、それをマークするアイコンと同じ行にある必要があります。ただし、説明フィールド、ユーザ定義のメモ・フィールド、およびリッチ・テキストだけは例外です。

    説明フィールド

    データは追加行に拡張可能であり、リターンとインデントを含めることができます。

    ユーザ定義のメモ・フィールド データは追加行に拡張できますが、最初の行のみが ALM にエクスポートされます。
    リッチ・テキスト・データ

    データには、通常の Word ドキュメントに含めることが可能な任意のコンテンツを含めることができます。リッチ・テキスト・データを ALM にエクスポートする場合、そのデータは要件の添付ファイルとして追加されます。添付ファイルの名前は Legacy_Rich_Content.doc になります。

    注: この要件を ALM に追加でエクスポートするたびに、Legacy_Rich_Content.doc ファイルは上書きされます。

  • 選択リストを持つ ALM フィールド用のデータは、そのリストのエントリと完全に一致している必要があります。たとえば、[優先度]フィールドは、次のいずれかのエントリのみを受け入れることができます。[5-緊急]、[4-非常に高い]、[3-高い]、[2-普通]、または[1-低い]。

  • ユーザ定義フィールドが ALM プロジェクト内に存在しない場合や、要件タイプで使用できない場合、そのフィールドのデータはエクスポートできません。

要件フィールドをマークするには、次の手順を実行します。

  1. 要件テキストが含まれる Word ドキュメントを開きます。

  2. 構造チェッカーを使用すると、挿入するブックマークによって構造が無効になることがないようにできます。たとえば、要件に複数の名前を追加したり、開いていない要件を閉じたりしていないことを構造チェッカーで確認できます。構造チェッカーのオンとオフを切り替えるには、ALM 要件ツールバーで、[Turn On Structure Checker]ボタンまたは[Turn Off Structure Checker]ボタンをクリックします。

  3. ドキュメント内のテキスト行またはテーブル・セルを強調表示し、ALM 要件ツールバーの適切なボタンをクリックします。

    フィールド ツールバー・ボタン アイコン
    要件名
    要件のレビュー・ステータス
    要件の作成者
    要件の優先度
    要件の説明
  4. タイプに要件を割り当てるには、要件のデータに新しいテキスト行を追加して強調表示するか、新しいテーブル・カラムを追加して要件に対応する新しいカラムのセルを強調表示します。ALM 要件ツールバーの[Type]ボックスで、要件タイプを選択します。[Type]ボタンをクリックして、要件タイプをドキュメントに追加します。要件タイプが追加され、要件タイプ・アイコンで示されます。

  5. ユーザ定義フィールドに値を割り当てるには、ドキュメント内で、その値が含まれるテキスト行またはテーブル・セルを強調表示します。ALM 要件ツールバーの[Field]ボックスで、ユーザ定義フィールドを選択します。[Field]ボタンをクリックして、ユーザ定義フィールド・アイコンのマークを付けます。

  6. ALM にエクスポートするリッチ・テキストを追加するには、リッチ・テキストを強調表示して、[Open Rich Text]ボタンをクリックします。[Open Rich Text]アイコンが追加され、リッチ・テキストの開始を示します。

    追加するリッチ・テキストの末尾にカーソルを置き、[Close Rich Text]ボタンをクリックします。[Close Rich Text]アイコンが追加され、リッチ・テキストの終了を示します。

  7. すべての要件データについて繰り返します。ドキュメント内のテキストでマークが付いていなものは、すべて無視されます。

  8. Close Requirement]ボタンをクリックして、[Close Requirement]アイコンで各要件を閉じます。このマークの位置は、要件が同じ階層レベルにあるか、異なる階層レベルにあるかで異なります。

    詳細については、「例:同じ階層レベルの要件」または「例:異なる階層レベルの要件」を参照してください。

  9. 1 つまたは複数のフィールドのマークを解除するには、元に戻すボタンを使用するか、手動でマークを削除します。詳細については、「Word ドキュメントからの書式設定の削除」を参照してください。

  10. すべての要件フィールドにマークを付けたら、要件を ALM にエクスポートします。詳細については、「Microsoft Word から ALM へのデータのエクスポート」を参照してください。

先頭に戻る

例:同じ階層レベルの要件

要件ツリーの同じ階層レベルに要件を定義するには、[Close Requirement]ボタンを使用して、各要件の直後に「要件を閉じる」マークを配置します。これで、要件が前の要件と同じレベルに配置されます。

ドキュメントに段落が含まれている場合は、要件の最終行の後に行を挿入し、その行に「要件を閉じる」マークを付けます。

ドキュメントにテーブルが含まれている場合は、テーブルの末尾にカラムを追加し、各要件の「要件を閉じる」マークを挿入します。

要件を ALM にエクスポートすると、ルート要件の下に、同じ階層レベルで要件が表示されます。

先頭に戻る

例:異なる階層レベルの要件

要件は、前の要件の子要件として定義できます。[Close Requirement]ボタンを使用して、親要件の「要件を閉じる」マークをそのすべての子要件の後に配置します。

たとえば、Req_2Req_1 の子として定義し、Req_3Req_4Req_2 の子として定義するには、Req_2 の「要件を閉じる」マークをその子要件の定義の後に配置します。Req_1 の「要件を閉じる」マークは、一番最後に配置します。

ドキュメントに段落が含まれている場合は、各「要件を閉じる」マークをそれぞれ行の適切な位置に配置します。Req_1Req_2 の「要件を閉じる」マークは、Req_3Req_4 の後に挿入することに注意してください。

データをテーブルとして提供する場合は、テーブルの末尾にカラムを追加し、各「要件を閉じる」マークを適切な位置に配置します。

要件を ALM にエクスポートすると、Req_2Req_1 の子として表示され、Req_3Req_4Req_2 の子として表示されます。

先頭に戻る

次のステップ: