イベント

ALM Web クライアントユーザ・セッション中、ユーザがさまざまなアクションを開始すると Web クライアントでイベントがトリガされます。これらのイベントにコードを記述することで、関連付けられたユーザ・アクションの実行をカスタマイズできます。

次の表では、各イベントがトリガされるタイミング、およびイベントの編集によって達成できる内容を説明します。

イベント 説明
New

このイベントは、Web クライアントにエンティティを追加するときにトリガされます。

このイベントにコードを追加して、新規オブジェクトを追加するときにアクションを実行できます。

構文:エンティティ>_New

例については、例:メモ・フィールドにテンプレートを追加するを参照してください。

MoveTo

このイベントは、ユーザがあるオブジェクトから別のオブジェクトにフォーカスを移動するときにトリガされます。

このイベントにコードを追加して、ユーザがフォーカスを移動するときに操作を実行できます。

構文:エンティティ>_MoveTo

例については、例:動的フィールド・リストを提示するを参照してください。

FieldCanChange

このイベントは、Web クライアントがフィールド値を変更する前に、フィールドが変更可能かどうかを判断するためにトリガされます。true または false を返します。

このイベントにコードを追加して、特定の場合にフィールドが変更されるのを防ぐことができます。

構文:エンティティ>_FieldCanChange(fieldName, newValue)

ここで、fieldName はフィールドの名前です。

newValue はフィールドの新しい値です。

例については、例:フィールドを検証するを参照してください。

FieldChange

このイベントは、指定されたフィールドの値が変更されるときにトリガされます。

フィールドからフォーカスが移動すると、値の変更によって FieldChange イベントがトリガされます。

このイベントにコードを追加することで、特定フィールドの値が変更されるときにアクションを実行できます。

構文:エンティティ>_FieldChange(fieldName)

ここで、fieldName はフィールドの名前です。

例については、例:別のフィールドに基づいてフィールドを変更するを参照してください。

CanPost

このイベントは、Web クライアントがエンティティを更新する前に、エンティティが更新可能かどうかを確認するためにトリガされます。true または false を返します。

このイベントにコードを追加して、特定のケースでエンティティの更新を防ぐことができます。

構文:エンティティ>_CanPost

例については、例:特定のケースでエンティティが更新可能であるかを検証するを参照してください。

CanDelete

このイベントは、Web クライアントがエンティティを削除する前に、エンティティが削除可能かどうかを確認するためにトリガされます。true または false を返します。

構文:エンティティ>_CanDelete(entity)

AfterPost

このイベントは、Web クライアントでエンティティが更新された後にトリガされます。

プロジェクト・フィールドを送信後に変更しないでください。データベースに新しい値が格納されないためです。

構文:エンティティ>_AfterPost

CanAddTests

このイベントは、Web クライアントがテスト・セットにテストを追加する前に、指定されたテストが追加可能であるかどうかを確認するためにトリガされます。true または false を返します。

構文: TestSet_CanAddTests(tests)

ここで、Tests は、テスト ID の配列です。

CanRemoveTests

このイベントは、Web クライアントがテスト・セットからテストを削除する前に、指定されたテストが削除可能であるかどうかを確認するためにトリガされます。true または false を返します。

構文: TestSet_CanRemoveTests(tests)

ここで、Tests は、テスト ID の配列です。

RunTestsManually

このイベントは、ユーザが[マニュアルランナーで実行]ボタンをクリックしてテスト・ラボ・モジュールでテストを実行したときにトリガされます。

構文:RunTestsManually(tests)

ここで、tests は、テスト・インスタンス ID の配列です。

利用可能:テスト・ラボ・モジュール・スクリプトのみ(24.1 P1 以降)

DefaultResult

このイベントは、FieldCanChange などの ALM イベントの標準設定の戻り値を決定するために使用されます。

すべての ALM イベントは、ユーザが明示的に省略しない限り、このイベントを呼び出して標準設定の戻り値を決定します。DefaultResult を使用すると、すべての ALM イベントの標準設定の戻り値をすばやく置き換えることができます。

利用場所:共通スクリプト]ノード

構文:DefaultResult

CanLogin

このイベントは、指定されたユーザが指定されたプロジェクトにログインできるかどうかを確認するためにトリガされます。true または false を返します。

構文:CanLogin(domainName, projectName, userName)

ここで、domainName はドメイン名です。

projectName はプロジェクト名です。

userName はユーザ名です。

利用場所:共通スクリプト]ノード

CanLogout

このイベントは、現在のユーザが現在のプロジェクトからログ・アウトできるかどうかを確認するためにトリガされます。true または false を返します。

構文:CanLogout

利用場所:共通スクリプト]ノード(24.1 P1 以降)

ActionCanExecute

このイベントは、ユーザが開始した操作を Web クライアント が実行する前に、操作が実行可能かどうかを確認するためにトリガされます。

このイベントにコードを追加することで、ユーザが特定の操作を開始したときに操作を実行したり、または特定の場合で操作の実行を防ぐことができます。

利用場所:共通スクリプト]ノード

構文:ActionCanExecute(actionName)

ここで、actionName は、ユーザが開始したアクションです。

システム・アクション名の形式は、<エンティティ>.<アクション名>です。たとえば、Defect.DeleteDefect などです。サポートされているシステム・アクション名の詳細については、サポートされるシステム・アクションを参照してください。

ユーザ定義ボタンによってトリガされるユーザ定義アクションは、UserDefinedActions.<アクション名>の形式に従います。たとえば、UserDefinedActions.Calculator などです。

例については、例:ユーザがアクションを実行できないようにするを参照してください。

CanEnterModule

このイベントは、ユーザが Web クライアントのモジュールに入るか切り替える前にトリガされます。true または false を返します。

構文: CanEnterModule(moduleName)

ここで、moduleName は ALM モジュール名です。

利用場所:共通スクリプト]ノード

EnterModule

このイベントは、ユーザが Web クライアントのモジュールに入るか切り替えるときにトリガされます。また、ユーザが Web クライアントにログインするときにもトリガされます。

構文:EnterModule

利用場所:共通スクリプト]ノード

ExitModule

このイベントは、ユーザが Web クライアントのモジュールを終了するときにトリガされます。

構文:ExitModule

利用場所:共通スクリプト]ノード

DialogBox

このイベントは、ダイアログ・ボックスが開くとき、または閉じるときにトリガされます。

構文: DialogBox(dialogBoxName, isOpen)

ここで、dialogBoxName はダイアログ・ボックスの名前です。

isOpen はダイアログ・ボックスが開いているかどうかを示します。

利用場所:共通スクリプト]ノード

CanCustomize

このイベントは、ユーザが[ワークフロー]ウィンドウを開こうとすると、指定されたユーザがプロジェクトのワークフロー・スクリプトをカスタマイズ可能であるかどうかを確認するためにトリガされます。true または false を返します。

構文: CanCustomize(domainName, projectName, userName)

ここで、domainName はドメイン名です。

projectName はプロジェクト名です。

userName はユーザのユーザ名です。

利用場所:共通スクリプト]ノード

Attachment_New

このイベントは、添付が Web クライアントに追加されたときにトリガされ、添付を開くことができるかどうかを確認します。true または false を返します。

構文:Attachment_New(attachment)

利用場所:共通スクリプト]ノード

Attachment_CanPost

このイベントは、Web クライアントが添付ファイルを更新する前に、添付ファイルが更新可能かどうかを確認するためにトリガされます。true または false を返します。

構文: Attachment_CanPost(attachment)

利用場所:共通スクリプト]ノード

Attachment_CanDelete

このイベントは、Web クライアントが添付ファイルを削除する前に、添付ファイルが削除可能かどうかを確認するためにトリガされます。true または false を返します。

構文: Attachment_CanDelete(attachment)

利用場所:共通スクリプト]ノード

GetDetailsPageName

このイベントは Web クライアントによってトリガされ、次のダイアログ・ボックスの PageNum で指定されるインデックス番号のページ(タブ)の名前を取得します。

  • エンティティの[詳細]ダイアログ・ボックス

  • エンティティの[新規<エンティティ>]ダイアログ・ボックス

このイベントにコードを追加することで、[詳細]ダイアログ・ボックスのタブ名をカスタマイズできます。

構文:GetDetailsPageName(pageName, pageNum)

ここで、pageName は標準設定のページ(タブ)名です(例:ページ 1)。

pageNum はページ(タブ)番号です。

利用場所:共通スクリプト]ノード

例については、例:エンティティの詳細ダイアログ・ボックスのタブ名を変更するを参照してください。

SharedFunction

SharedFunction イベントには、グローバルな定数または関数を定義できます。

  • <モジュール>_SharedFunction イベントに含まれるスクリプトは、同じモジュール内の他のイベントで使用できます。

  • 共通スクリプト]ノード > SharedFunction イベントに含まれるスクリプトは、任意のモジュールのイベントで使用できます。

スクリプトが SharedFunction イベントを呼び出した場合、このイベントの定数や変数に対して行った変更は、そのスクリプトの現在の実行でのみ有効になります。

例については、例:[新規不具合]ダイアログ・ボックスのフィールドのカスタマイズを参照してください。