参照：参照プラグイン

TestRail の参照プラグイン機能を利用すると、簡単にテストケース、テストラン、テストプラン、その他のエンティティを要求管理、ユーザーストーリー、Wiki などのツールとリンクできます。参照プラグインを設定すると、リンクされたアイテムに関する情報を直接 TestRail から検索できるため、要求や課題などのステータスと変更を簡単にチェックして追うことができます。

動作の仕組み

参照プラグインは、TestRail 全体で利用可能な「参照」フィールドを利用します。参照フィールドに入力された参照 ID の上にマウスポインターを置くと、TestRail は接続されたツールに API リクエストを行い、リンクされたアイテムに関する情報を取得します。TestRail のビューと URL の追加機能と組み合わせると、必要に応じて、リンクされた要件をすばやく参照したり、外部ツールにジャンプして情報を取得および更新したりできます。

統合の設定

参照プラグインは、グローバルに、またはプロジェクトごとに設定できます。グローバルな参照プラグインを指定したうえで、少数の特定のプロジェクトでは設定を上書きすることもできます。グローバルプラグインを設定するには、[管理] > [統合] > [参照] をクリックし、参照プラグインを選択します。特定のプロジェクトの参照プラグインを設定するには、プロジェクトを編集し、[参照] タブでプラグインを選択します。

各プラグインには、独自の設定パラメーターのセットがあり、プラグインを使用するには、それらのパラメーターを設定する必要があります。たとえば、多くのバグトラッカーはバグレポートを送信するためにログインを必要とするので、通常、TestRail でバグトラッカーのユーザー名とパスワードを設定する必要があります。プラグインを選択すると、必要なすべての設定パラメーターが [connection] セクションに表示されます。

表示されるフィールド

たとえばテストケースなど、参照フィールドがある TestRail のエンティティを参照するには、[参照] フィールドの参照 ID の上にマウスポインターを置きます。すると、TestRail は統合されたツールからアイテムに関する情報を取得します。この情報はポップアップダイアログとして表示されるので、TestRail を離れることなく重要な情報を参照できます。

プラグインの [push.fields] セクションをカスタマイズし、ID の上にマウスポインターを置いたときに表示されるフィールドを変更できます。デフォルトでは、プラグインは [hover.fields] セクションのフィールドのリストをサポートしています。ダイアログに表示されるフィールドを変更するには、下の「カスタムフィールド」で説明されているように、フィールドの「オン」または「オフ」を設定し、[field.settings.{field name}] セクションを使用してフィールドのプロパティを変更します。

また、リンクホバリングでもカスタムフィールドを設定できます。フィールドがデフォルトでは表示されていない場合、カスタムフィールドとして定義する必要があります (フィールドタイプがサポートされていることを前提として)。

[hover.fields]
summary=on
project=on
issuetype=on
component=on
assignee=on
priority=on
affects_version=on
fix_version=off
estimate=off
labels=off
environment=off
description=on

上記の設定を調整して、個々のフィールドを有効/無効にしたり、フィールドの順序を変更したりできます。

フィールドオプション

上記のようにフィールドを有効または無効にすることに加えて、フィールドごとに追加のオプションを変更することも可能です。それには、[hover.field.component] のようなセクションを定義して、 [component] フィールドの追加オプションを指定します。以下のオプションがサポートされています。

[hover.field.component]
label=Component
size=compact
remember=false
required=false
type=dropdown

ただし、すべてのオプションを指定する必要はありません。たとえば、フィールドの required オプションを変更したいだけであれば、他のオプションをスキップすることができます。オプションの説明については、以下を参照してください。

オプション	説明
label	[Hover Reference] ダイアログでのフィールドの表示名を指定します。
size	フィールドをコンパクトフィールド (compact) として表示するか、ダイアログの全幅を使用する (full) かを指定します。

カスタムフィールド

既存のフィールドを設定するのと同様に、カスタムフィールドをホバーウィンドウに追加することもできます (フィールドがサポートされていることを前提として)。それには、 [hover.fields] セクションに次のような行を追加してフィールドを追加します。

[hover.fields]
customfield_11002=on

そして、[field.settings.{custom field identifier}] セクションを追加します。ツールからデータを取得するために、このセクションは必須です。次は、Jira のカスタムフィールド設定の例です。

[hover.field.customfield_11002]
label=Customer
size=compact
type=dropdown
required=true

以下のフィールドタイプがサポートされています。

フィールドタイプ	説明
bool	true/false、Yes/No、または類似の二値の値を表すはい/いいえのドロップダウンメニュー
date	YYYY-MM-DD まはた類似の日付を受け入れる文字列フィールド。フォーマットは統合先ツールの要件に依存する場合があります。
datetime	YYYY-MM-DD HH:MM まはた類似の日時を受け入れる文字列フィールド。フォーマットは統合先ツールの要件に依存する場合があります。
string	最大 250 文字の小さなフリーテキストフィールド
text	実用上サイズ制限のない大きなフリーテキストフィールド
dropdown	ユーザーが複数のオプションのうちの 1 つを選択できるドロップダウンリス
multiselect	ユーザーが複数の定義済みオプションを選択できる

注意: カスタムフィールドは、必ず customfield_<id> またはこれに似た書き方で指定する必要があります。カスタムフィールドの定義、サポートされるフィールドタイプ、その他ツール固有の詳細については、お使いのツールのプラグインマニュアルを参照してください。

参照プラグイン