プロジェクト・スクリプトの使用

この項では、プロジェクト・スクリプトを使用して Web クライアントのユーザ・インタフェースをカスタマイズし、意図した方法でエンド・ユーザが Web クライアントを操作できるようにする方法について説明します。

このトピックの内容:

• プロジェクト・スクリプトの概要
• プロジェクト・スクリプトを作成する前に
• プロジェクト・スクリプトの記述
• 例
• プロジェクト・スクリプトのデバッグ
• 制限事項

プロジェクト・スクリプトの概要

プロジェクト・スクリプトを記述すると、日常的なタスクを自動化し、エンド・ユーザが Web クライアントを操作する方法をカスタマイズできます。

プロジェクト・スクリプトはイベントによってトリガされますが、イベントはユーザのアクションに関連付けられます。ALM Web クライアントのセッション中に、ユーザがボタンのクリックやフィールドの編集などのアクションを開始すると、対応するイベントがトリガされ、ALM がイベントで定義された JavaScript コードに従って動作します。

サポートされるエンティティ

Web クライアントでは、次のエンティティのワークフローをカスタマイズできます。

エンティティ	説明
Req	要件データ
Test	テスト・データ
TestFolder	テスト・フォルダ・データ
DesignStep	テスト・デザイン・ステップ・データ
TestSet	テスト・セット・データ
TestSetFolder	テスト・セット・フォルダ・データ
TestSetTests	テスト・インスタンス・データ
Run	テスト実行データ
Bug	不具合データ
Step	手動テスト実行ステップ・データ
Release	リリース・データ
Cycle	リリース・サイクル・データ
ReleaseFolder	リリース・フォルダ・データ

先頭に戻る

プロジェクト・スクリプトを作成する前に

プロジェクト・スクリプトを記述する前に、イベント、オブジェクト、プロパティについて理解しておく必要があります。

プロジェクト・スクリプトのイベント

関連するユーザ・アクションが開始されたときにコードが呼び出されるように、コードを適切なイベント内に配置します。

イベントの詳細については、イベントを参照してください。

プロジェクト・スクリプトのオブジェクト

スクリプトは、フィールド情報やユーザ情報など、関連するオブジェクトから取得した情報に基づいてカスタマイズを実行します。

詳細については、オブジェクトを参照してください。

プロジェクト・スクリプトのプロパティ

ActiveModule、ActiveDialogName プロパティを使用して、アクティブなモジュールとダイアログ・ボックスの情報を取得します。

詳細については、ActiveModule プロパティと ActiveDialogName プロパティを参照してください。

先頭に戻る

プロジェクト・スクリプトの記述

プロジェクト・スクリプトを記述するには、ユーザの操作によってトリガされるイベントに JavaScript コードを追加します。たとえば、New イベントは、Web クライアントにエンティティを追加するときにトリガされます。

イベントのスクリプトを記述するには、次の手順を実行します。

1. Web クライアントのバナーから、［設定］＞［ワークフロー］をクリックします。

2. ［スクリプトエディタ］タブで、プロジェクト・スクリプト・ツリーの［ワークフロースクリプト］＞［プロジェクトスクリプト］ノードで、目的のモジュールを展開し、コードをトリガするタイミングに応じて、コードを追加するイベントを選択します。

   • 同じモジュール内の他のイベントで使用可能なコードを記述するには、＜モジュール＞_SharedFunction イベントを選択します。

   • 複数のモジュールのイベントで使用可能なコードを記述するには、［共通スクリプト］＞［SharedFunction］イベントを選択します。

   イベントの詳細な説明については、イベントを参照してください。

3. イベントに JavaScript コードを追加します。

   参考情報として、例を参照してください。

   注: スクリプトで日付文字列を記述する場合は、日付文字列の形式がブラウザの日付形式設定と一致していることを確認してください。

   たとえば、ブラウザで日付文字列の形式が YYYY/MM/DD に設定されている場合は、スクリプト内の日付文字列にも同じ形式を使用します。

4. ［保存］をクリックします。

先頭に戻る

例

次の表に、独自のプロジェクト・スクリプトの記述に役立つ例をいくつか示します。

ワークフロー・タスク	例
ダイアログ・ボックスのカスタマイズ	例：エンティティの詳細ダイアログ・ボックスのタブ名を変更する 例：［新規不具合］ダイアログ・ボックスのフィールドのカスタマイズ
フィールド値の自動化	例：メモ・フィールドにテンプレートを追加する 例：ユーザ・グループに基づいてフィールドを変更する 例：別のフィールドに基づいてフィールドを変更する
データの検証	例：特定のケースでエンティティが更新可能であるかを検証する 例：フィールドを検証する
動的フィールドのカスタマイズ	例：動的フィールド・リストを提示する 例：フィールド変更時にフィールドのプロパティを変更する
ユーザ・アクセス許可の制御	例：ユーザがアクションを実行できないようにする

先頭に戻る

プロジェクト・スクリプトのデバッグ

ワークフロー・スクリプトをデバッグして、エラーを解決することができます。

ワークフロー・スクリプトをデバッグするには、次の手順を実行します。

1. プロジェクト・スクリプト・ツリーから、ワークフロー・スクリプトを選択します。

2. エディタ領域で、次のステートメントを追加します。

   Copy code

   debugger;
   console.log("<script_name> triggered");Copy Code

   たとえば、次のようになります。

   Copy code

   function Bug_New() {
     debugger;
     console.log("Bug_New triggered");
   }Copy Code

3. F12 キーを押して、ブラウザ・コンソールを開きます。

4. Web クライアントでスクリプトをトリガします。

   たとえば、［新規不具合］ウィンドウで［作成］ボタンをクリックします。

5. ブラウザ・コンソールでスクリプトをデバッグします。

先頭に戻る

制限事項

プロジェクト・スクリプトには次の制限があります。

• スクリプトの編集時に自動提案されるオブジェクトやメソッドの一部は、呼び出すことができません。サポートされていないオブジェクトやメソッドを呼び出すと、エラーが発生します。

• プロジェクト・スクリプト・ツリーに表示されているスクリプトの中には使用できないものがあり、灰色で表示されます。

参照情報：

• 詳細プロジェクト・スクリプトの記述