setQueryMessage( )

ルール内で問合せメッセージを動的に設定します。この問合せメッセージは、ルールがfalseを返す場合に問合せの作成に使用されます。

問合せに設定するメッセージは、動的に生成される文字列にできます。これは、文字列を返す変数または関数を使用して実行できます。後述の例のセクションを参照してください。

ルールの実行時に動的問合せメッセージが設定されていない場合、ルール作成時に指定されたデフォルトの問合せメッセージが使用されます。ロジック内でsetQueryMessage()関数を使用する場合、動的問合せメッセージは、その値がNULL、未定義、空の文字列、または空白のみが含まれる場合には設定されません。

注意:

この関数は、電子メール通知を送信するルールには使用できません。

構文

setQueryMessage(strMessage)

パラメータ

パラメータ	必須/オプション	説明
strMessage	必須	問合せメッセージを含む文字列。この文字列は、ルール式内で動的に生成できます。 ヒント: getDateDMYFormat( )ヘルパー関数を使用すると、日付をフォーマットしてからこの関数に渡すことができます。

戻り値

問合せ作成用に設定された問合せメッセージを含む文字列。または、関数の実行中にエラーが発生した場合は空の文字列。

例)

例3-101重みが120より小さい場合の問合せメッセージの設定

// Given "weight" item containing value of 110.
if (weight < 120){
var strMessage = "Subject weight of " + weight + " lb is less than the required weight of 120 lb."
setQueryMessage(strMessage);
  return false; // create query
} else {
 
   return true;  // close query
}
  
// A query is created with message "Subject weight of 110 lb is less than the required weight of 120 lb."