変更時のルール

ワークフローコンストラクターで変更時ルールを作成するときは、前提条件セクションで課題を更新するための初期基準を定義してから、アクションセクションで適用する更新を指定します。

これは、レビューの責任者に購入リクエストを自動的に割り当て、期限を 2 週間先に設定するワークフロールールです。

このサンプルの変更時ルールは、次のように動作します。

このルールは、変更が課題に適用されると、次のアクションを実行します。

• YouTrack は、サブシステムフィールドの値の変更を確認します。

• サブシステムの値が変更されると、課題はサブシステムの所有者に自動的に割り当てられます。

この変更時ルールを定義するコンポーネントは次のとおりです。

• すべてのスクリプトは、require ステートメントのリストで始まります。このルールでは、ローカル変数 entities を宣言し、ワークフロー API のエンティティモジュールを参照します。これは、このモジュールに含まれているすべてのものに、entities 変数を使用してこのスクリプトでアクセスできることを意味します。

• 各スクリプトは、1 つのルールを exports.rule プロパティにエクスポートします。ルールは、Issue.onChange メソッドで宣言されます。このメソッドは、宣言に続くスクリプトを変更時ルールとしてエクスポートします。

• ルールの本体には、次の 3 つのプロパティが含まれています。

  プロパティ	説明
  タイトル	人間が読めるオプションのタイトル。タイトルは管理インターフェースにのみ表示されます。
  ガード	ルールを実行するための条件を決定する機能。保護条件が満たされていない場合、ルールに指定されているアクションは課題に適用されません。
  アクション	各課題に適用されるアクション。アクションは、引数としてコンテキストを受け入れる関数として宣言されます。 この例では、サブシステムフィールドが null 以外の所有者を持つ null 以外の値に設定されているかどうかを確認します。その場合、ルールは担当者フィールドの値を設定します。
  runOn	変更イベントルールをトリガーする発行イベントを決定します。指定しない場合、課題の更新時にルールがトリガーされます。このプロパティは、次のパラメーターで拡張されます。 change — true の場合、ルールは課題の変更時にトリガーされます。 removal — true の場合、課題が削除されたときにルールがトリガーされます。 この例のルールは更新が適用されるとトリガーされるため、このプロパティの値を指定する必要はありません。
  要件	ルールがエラーなしで実行されるために必要なエンティティのリスト。このプロパティにより、ルールをプロジェクトに安全にアタッチできるようになります。 この例では、要件により、サブシステムフィールドと担当者フィールドの両方に正しいタイプが格納され、ルールが関連付けられているプロジェクトで使用できることが保証されます。いずれかのフィールドが存在しない場合、ワークフローリストにエラーが表示されます。必須フィールドがアタッチされるまで、ルールを有効にできません。

記事の変更時ルールのサンプルについては、開発者ポータルの API 参照を参照してください。

JavaScript でのワークフローの作成の詳細については、開発者ポータルのドキュメントを参照してください。