ワークフロー・スクリプトのカスタマイズ

プロジェクト・ワークフロー・スクリプトを編集して、実行できるアクションや、Web Runner のユーザ・インタフェースで利用できるフィールドをカスタマイズできます。

注: ワークフロー・スクリプトをカスタマイズするには、ワークフローの設定権限があることを確認してください。

概要

プロジェクト・ワークフロー・スクリプトを編集して、実行できるアクションや、Web Runner で利用できるフィールドをカスタマイズします。

Example: 不具合の編集または送信時には、次のことを制御できます。

  • 利用可能なフィールド

  • 必須フィールド

  • フィールドに自動入力される標準設定値

  • フィールドの唯一の有効な値

プロジェクト・ワークフロー・スクリプトは、モジュールごとにグループ化されています。ワークフロー・スクリプトを編集するには、ワークフロー・スクリプトに含まれるイベントに JavaScript コードを追加します。

Example: 不具合モジュール・スクリプトで、Bug_New イベントを編集することで、不具合が送信されたときのユーザ・アクションをカスタマイズできます。たとえば、不具合が送信されたときに、必須フィールドに標準設定値を割り当てることができます。

先頭に戻る

プロジェクト間のカスタマイズに関する考慮事項

テンプレートまたはリンクされたプロジェクトで作業している場合、ワークフロー・スクリプト・ツリーには次のセクションが表示されます。

テンプレート・スクリプト

このセクションに一覧されるワークフロー・スクリプトは、テンプレートからリンクされたプロジェクトに適用されたスクリプトです。

リンクされたプロジェクトを操作している場合、このセクションは、テンプレート内に定義されたテンプレート・スクリプトがあるときのみ表示されます。テンプレート・スクリプトは、リンクされたプロジェクトでは編集できません。テンプレートからプロジェクトを削除しても、テンプレート・スクリプトはプロジェクト内にそのまま残り、編集することができます。

テンプレート・スクリプト内のイベントには Template_ というプレフィックスが付記されます。

プロジェクトのスクリプト

このセクションに一覧されるワークフロー・スクリプトは、作業中のテンプレート、リンクされたプロジェクトにのみ適用されます。このセクションのテンプレートのスクリプトは、リンクされたプロジェクトには適用されません。

リンクされたプロジェクトのワークフロー・スクリプトを実行すると、テンプレート・スクリプトとプロジェクト・スクリプトが 1 つのスクリプトに結合されます。テンプレート・スクリプトとプロジェクト・スクリプトに重複する変数や関数があると、競合が発生する可能性があります。

標準設定では、ALM はテンプレート・イベントをトリガします。テンプレート・イベントが存在しない場合、またはテンプレート・イベントからプロジェクト・イベントを呼び出すように指定した場合にのみ、プロジェクト・イベントがトリガされます。

各テンプレート・イベントには、並行プロジェクト・イベントへのコメント化された呼び出しが含まれます。

先頭に戻る

スクリプトの編集

ワークフロー・スクリプトを編集するには、ユーザの操作によってトリガされるイベント・プロシージャに JavaScript コードを追加します。

スクリプトを編集するには、次の手順を実行します。

  1. Web Runner の右上隅で、[設定>[カスタマイズ]をクリックします。

  2. ワークフロー・スクリプト・ツリーから、ターゲット・モジュールのノードの下で、コードをトリガするタイミングに応じて、コードを追加するスクリプトを選択します。

    共通スクリプト]ノードには、複数のモジュールからアクセスできるスクリプトが含まれています。

    イベント・プロシージャの詳細な説明については、「ALM イベントのリファレンス」を参照してください。

  3. スクリプトに JavaScript コードを追加します。

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

先頭に戻る

SharedFunction イベント

SharedFunction イベントには、グローバル変数または関数を定義できます。このイベントに含まれるスクリプトは、他のイベントから呼び出すことができます。

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

先頭に戻る

ワークフロー・スクリプトのデバッグ

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

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

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

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

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

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

    Copy code
    function Bug_New() {
      debugger
      console.log("Bug_New triggered")
    }
  3. F12 キーを押して、ブラウザ・コンソールを開きます。

  4. ALM でスクリプトをトリガします。

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

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

先頭に戻る

制限事項

ワークフロー・スクリプトには次の制限があります。

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

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

参照情報: