ワークフローの状態を定義した後は、各状態に関連付けられるアクションを定義する必要があります。たとえば、デフォルト バグ ワークフローの開発準備完了状態の場合、開発者は解決や解決不能などのアクションを取ることができます。
各アクションには、一連のプロパティが関連付けられています。これらのセクションでは、これらのプロパティについて説明します。このセクションの内容は、「アクション、理由コード、アクション ダイアログのカスタマイズ」でアクションをカスタマイズする際の参考になります。
アクションの一般的なプロパティ
アクションのプロパティにはさまざまなものがあり、その範囲は以下のとおりです。
• 問題の詳細ページに表示されるボタン ラベル
• [履歴] タブに表示されるアクションの説明
• このアクションの結果生じる新しい状態
• 理由コード
• アクション ダイアログの外見と使用方法
• このアクションを取ることを許されているグループ
• このアクションのソート順序
アクションのプロパティは、[状態 "<状態名>" のアクションの編集] ダイアログ([設定|ワークフロー] ページから起動)で設定します。
編集できません。アクションの定義対象または変更対象となっている現在の状態の名前が表示されます(たとえば、[状態 "レビュー未完了" のアクションの編集])。
このアクションを実行するボタン(問題の詳細ページに存在)の表示名で、最大 30 文字までです(たとえば、[バグとして確認] など)。
このアクションが実行された場合に記載されるアクションの簡潔な説明(20 文字以内)。たとえば、検証済み (英字の場合は、大文字を使用することをお勧めします)。
このコードは、問題の詳細ページの [履歴] タブの [アクション] 列に表示されます。
ツールヒント
このアクション ボタンの上でカーソルを静止させたときにツールヒントとして表示されるテキスト(省略可能)。
説明
このアクションの説明(省略可能)。
問題に対してこのアクションを取ったときの、ワークフローにおける次の状態の名前。たとえば、デフォルト ワークフローでは、レビュー未完了の問題は、バグとして確認されると、開発準備完了という次の状態に移行します。以下のワークフロー図は、このシーケンスを示したものです。
このアクションを取ったときに問題が現在の状態から新しい状態に変化する理由を説明するキーワード(省略可能)。背景情報については、「理由コード」を参照してください。
適切なラジオ ボタンを以下の中から選択します。
• [変更なし]
• [クリア]
• [設定] (キーワードを入力します)
[変更なし]
[変更なし] は、問題が新しい状態に移行してもキーワードがそのまま変わらないことを示します。このキーワードは、問題の詳細ページの [理由コード] フィールドに表示されます。たとえば、以下のワークフローでは、あるバグを修正したと開発者が主張すると、そのバグは解決という理由コードで QA 準備完了状態に移行することを示しています。その主張が正しいことを QA エンジニアが確認すると、バグは解決という理由コードのまま対応完了状態に移行します。問題を閲覧するユーザーは誰でも、理由コードを見ることで、バグの対応完了理由が簡単にわかります。
[クリア] は、問題が新しい状態に移行するときに現在の状態の理由コードが削除されることを示します。問題がワークフローにおける前の状態に戻るときは、[クリア] を選択するのが妥当です。たとえば、バグを修正したと開発者が主張すると、バグは解決という理由コードで QA 準備完了状態に移行します。
しかし、その "修正" が却下されると、問題は開発(開発準備完了)状態に差し戻されます。また、主張に異議が唱えられたため、解決という理由コードは削除されます。
[クリア] を選択すると、[ワークフロー] ページの [理由コード] フィールドには "クリア" と表示されます。ただし、問題の詳細ページの [理由コード] フィールドには何も表示されません。
[設定] は、このアクションに理由コードを関連付けることができることを示します。20 文字以内でキーワードを入力します。英字の場合は、すべて大文字にすることをお勧めします。
アクションの結果、理由コードの必要な新しい状態に問題が移行する場合は、[設定] を使用して理由コードを指定します。一般に、開発者が取るすべてのアクションには理由コードを割り当てなければなりません。
たとえば、デフォルト ワークフローでは、開発準備完了状態で解決アクションを取ると、問題は解決という理由コードで QA 準備完了状態に移行します。人間行動の点から見ると、これは、バグを修正したと開発者が主張し、それを QA エンジニアに渡すと、QA エンジニアのほうでは、問題の詳細ページをざっと見て、自分の受信箱にそのバグが入っている理由をたやすく知ることができるということです(他には、開発者がバグを修正できない、あるいはソフトウェアが設計どおりに動作しているという理由でその受信箱にバグが入っている場合もあるでしょう)。
理由コードを使用しない場合
理由コードは、ワークフローにおける状態の数をできるだけ少なくするのに役立つキーワード(省略可能)です。たとえば、問題が対応完了状態になっている理由を説明するのに理由コードが役に立つので、複数の対応完了状態(非バグ、再現不能、重複として指定)を定義しなくても、1 つの最終状態で十分です。
理由コードを使用しないことにした場合は、複数の最終状態を定義する必要があるかもしれません。ある状態を最終状態にするには、[状態のプロパティ] ダイアログで、状態所有者の選択肢として表示される [所有者なし (最終状態)] ラジオ ボタンを選択します。詳細については、「状態のプロパティ」を参照してください。
[状態 "<状態名>" のアクションの新規作成] ダイアログの [アクションの標準フィールド] タブでは、特に、アクション ダイアログの使用方法と外見に関係する以下のプロパティを定義します。
• アクション ダイアログの [アクション メモ] フィールド(「アクション メモ」を参照)
• アクション ダイアログのリリース情報用フィールド(「リリース情報」を参照)
• アクション ダイアログの関連する問題番号用フィールド(「関連する問題番号」を参照)
アクション ダイアログの [アクション メモ] フィールドについては、以下の 3 つのいずれかを指定できます。
[使用しない]
[使用しない] を選択した場合、ユーザーがこのアクションを取ったときに、アクション ダイアログには [アクション メモ] フィールドが表示されません。
[省略可能]
[省略可能] (デフォルト)を選択した場合、アクション ダイアログには [アクション メモ] フィールドが表示されます。ユーザーは、取ろうとしているアクションについての追加情報を必要に応じて入力できます。
[必須]
[必須] を選択した場合、アクション ダイアログには必須の [アクション メモ] フィールドが表示されます。ユーザーは、アクションに関する追加情報をこのフィールドに入力する必要があります。
[リリース情報] グループでは、このアクションを取るリリースをユーザー側で選択できるリスト ボックスをアクション ダイアログに表示するかどうかを指定できます。ユーザーが選択したリリースは、問題の詳細ページの自動フィールドの 1 つにも表示されます。この情報は、ある種のアクション(たとえば、問題の確認、解決、検証に関係するアクションなど)には特に役立ちます。現在の状態を変更しないアクションには役に立ちません。
[リリース情報] フィールドで指定できる値は、[使用しない]、[省略可能]、[必須]、[クリア] のいずれかです。
[使用しない]
[使用しない] (デフォルト)を選択した場合、アクション ダイアログには該当するリスト ボックスが表示されません。コメントの追加アクションにはリリース情報は必要ないため、コメントの追加アクションのアクション ダイアログには、リリース情報のリスト ボックスは表示されません。
[省略可能] または [必須]
[省略可能] または [必須] を選択した場合、アクション ダイアログには、ユーザー側でリリースを選択するための省略可能または必須のリスト ボックスが表示されます。後で示すアクション ダイアログを参照してください。問題の詳細ページの最後の自動フィールドには、アクションが取られたリリースが表示されます。
アクションに合わせて、リスト ボックスの [ラベル] を指定する必要があります。ラベルの文字数は、末尾のコロンを含めて 20 文字以内です。デフォルトのフィールド ラベルは、確認アクションの場合は [確認したリリース:]、解決アクションの場合は [解決したリリース:]、検証アクションの場合は [検証したリリース:] です。このラベルは、アクション ダイアログにも問題の詳細ページにも表示されます。
リスト ボックスの値は、SilkCentral 管理モジュールで指定されたリリース リストから取得されます。
[クリア]
[クリア] を選択した場合、問題の詳細ページの最後の自動フィールドに入力されている既存の値は削除され、フィールドのラベルはデフォルトの [アクション リリース] に戻ります。[リリース情報] グループ ボックスの [ラベル] フィールドは無効になります。
[クリア] は、アクションの結果、問題がワークフローにおける前の状態に戻る場合に適した選択肢です。デフォルト ワークフローでは、却下アクションやバグ対応再開アクションなどがこれに該当します。
たとえば、開発者が解決アクションを取り、[解決したリリース] フィールドに特定のリリース番号を入力するとしましょう。このアクションの結果、問題は QA 準備完了状態になります。この問題を担当する QA エンジニアは、バグを修正したとする開発者の主張を却下します。却下アクションの結果、問題は現在の状態である "QA 準備完了" から、ワークフローにおける前の状態である開発準備完了に戻ります。次の図は、却下アクションの例を示したものです。
解決アクションは却下されたので、[解決したリリース] フィールドに指定されているリリースを保持しても意味がありません。このような場合、却下アクションに対しては [クリア] を選択します。
ヒント アクションの理由コードをクリアする場合は、「理由コード」で説明しているように、[リリース情報] フィールドの値として [クリア] を選択することを検討します。
アクション ダイアログでユーザーが選択したリリースは、問題の詳細ページに表示されます。たとえば、ユーザーが解決アクションを取り、[解決したリリース] リスト ボックスからリリースとして 4.1:prod を選択して、[OK] をクリックするとしましょう。問題の詳細ページが再表示されると、[解決したリリース] フィールドには選択したリリースが表示されます。
たとえば、[使用しない] を選択した場合、ユーザーがアクション ダイアログの省略可能なリスト ボックスに情報を指定しない場合、あるいはリスト ボックスを使用するアクションがまだ取られていない場合は、問題の詳細ページの [アクション リリース] フィールドは空欄になります。
[関連する問題番号] フィールドを利用すると、重複した問題や関連する問題の番号をユーザー側で入力できるテキスト フィールドをアクション ダイアログに配置することができます。この情報は、バグ ワークフローで重複として指定アクションを取る場合や、機能拡張ワークフローで対応済みアクションを取る場合に役に立ちます。
[関連する問題番号] フィールドで指定できる値は、[使用しない]、[省略可能]、[必須] のいずれかです。
[使用しない]
[使用しない] を選択した場合、テキスト フィールドはアクション ダイアログに表示されません。
[省略可能] または [必須]
[省略可能] または [必須] を選択した場合は、省略可能または必須のテキスト フィールドがアクション ダイアログに表示されます。この場合、テキスト フィールドのラベルを指定する必要があります。ラベルの文字数は、末尾のコロンを含めて 20 文字以内です。バグ ワークフローにおけるデフォルトのフィールド ラベルは、[同じバグの番号:] です。機能拡張ワークフローにおけるデフォルトのフィールド ラベルは、[次も参照:] です。
アクション ダイアログでユーザーが指定した問題番号は、問題の詳細ページの [履歴] タブの [メモ] フィールドに表示されます。たとえば、ユーザーが問題番号 8 に対して重複として指定アクションを取り、重複した問題として問題番号 6 を指定して、[OK] をクリックするとしましょう。問題の詳細ページが再表示されると、[メモ] フィールドには、"同じバグの番号: n" と表示されます。ここで、n は、[同じバグの番号] フィールドの値です。[同じバグの番号] フィールドが省略可能で、ユーザーが値を指定しない場合は、[メモ] フィールドには [アクション メモ] フィールドの内容が表示されます。
[状態 "<状態名>" のアクションの新規作成] ダイアログの [アクションのユーザー定義フィールド] タブを利用すると、特定のアクションのアクション ダイアログにフィールドを追加することができます。
8 つのフィールドの位置
これらのフィールドは、アクションの標準フィールド(「[アクションの標準フィールド] タブ」を参照)に加えて、アクション ダイアログに表示されます。[フィールド 1] から [フィールド 4] までは、アクション ダイアログの左下に表示されます。[フィールド 5] から [フィールド 8] までは右下に表示されます。たとえば、リスト ボックスから選択した [解決に要した時間] フィールドが、開発準備完了状態に対する解決アクションのアクション ダイアログの第 1 フィールド位置([フィールド 1])に表示されるといった具合です。
参照時の読み取り専用
フィールドは、いったん問題で参照されると、[アクションのユーザー定義フィールド] タブでは読み取り専用になります。アクション ダイアログで入力された情報を見るには、問題の詳細ページの [履歴] タブで問題のエントリを確認する必要があります。
ソース
[アクションのユーザー定義フィールド] タブのリスト ボックスにフィールドが表示される場合、その理由は以下のいずれかです。
• 以下の手順で説明するように、新しいフィールドを定義できます。これらのフィールドは常に省略可能です。モードは変更できません。
• 問題の詳細ページのカスタム タブに表示されるフィールドを選択できます。たとえば、アクション ダイアログに [解決に要した時間] フィールドがあるとします。この情報はカスタム タブにも表示されています。カスタム タブ用に既に定義されているフィールドは、[アクションのユーザー定義フィールド] タブのリスト ボックスに自動的に表示されるのです。
アクション ダイアログに表示されるフィールドを独自に定義できます。
前提条件
以下の作業を実行するには、ワークフローのカスタマイズのセキュリティ権限が必要です。
アクション ダイアログのフィールドを独自に定義するには:
1 [設定|カスタム フィールド プール] ページを開きます。
2 [カスタム フィールドを追加] ボタンをクリックして、[フィールドのプロパティの編集] ダイアログを表示します。
3 「GUI のカスタマイズのプロパティ」の説明に従って、フィールドのプロパティを設定します。
4 作成したカスタム フィールドは、[アクションのユーザー定義フィールド] タブのリスト ボックスから選択することができます。
[アクセス許可] タブでは、個々のアクションのセキュリティを設定することで、アクションの使用を選択したユーザー グループのみに制限できます。
デフォルトでは、[セキュリティを適用] フィールドの値は [いいえ] になっています(すなわち、すべてのグループに、すべてのアクションを実行する権限があります)。この設定は、[ワークフロー] ページでは [(すべてのグループ)] と表示されます。セキュリティを設定するには、[はい] ラジオ ボタンを選択してから、アクションを取ることが許されるグループを 1 つ以上選択します。
アクションのセキュリティ定義に関する次のような例について考えてみるとよいでしょう。開発準備完了状態にあるバグの問題詳細ページを開発者が開くと、[解決不能] アクションが使用可能です。しかし、開発者以外のユーザーが同じバグの問題詳細ページを開いても、このアクションは表示されません。