ProactiveTriggerAPI :スコープ指定

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：11分

    • ProactiveTriggerAPI を使用すると、指定したユーザーにコンテキスト固有のメッセージを送信するサーバー側トリガーを作成できます。

    この API は、ルールとそれらのルールに基づく関連アクションを使用して、ユーザーにメッセージを送信します。これらのルールとアクションはコンテキスト固有であり、ユーザーがポータルページ間を移動するときに収集されるリアルタイムデータに基づいています。詳細については、「Proactive Triggers」を参照してください。

    この API を使用する前に、トリガータイプ、ルール、およびアクションをインスタンスで構成する必要があります。プロアクティブトリガーの構成方法については、「Configuring Proactive Triggers」を参照してください。

    この API を使用すると、特定のユーザーまたは特定のセッションのユーザーにメッセージを送信できます。

    たとえば、顧客が買い物かごにアイテムを追加した場合、指定された時間が経過するとチェックアウトを完了するようにユーザーにリマインダーを送信する プロアクティブトリガー イベントをビジネスルール内に持つことができます。

    同様に、ユーザーがサービスポータルからAI 検索を実行しても結果が返されない場合、プロアクティブポップオーバーメッセージ Web クライアントを介してユーザーに代替オファリングを送信するプロアクティブトリガーを作成するロジックをビジネスルールに含めることができます。

    ProactiveTriggerAPI を呼び出す場合、メソッドを呼び出す必要がある特定のシーケンスがあります。この API は sn_pt 名前空間で実行されます。

    まず、 ProactiveTriggerAPI - createTrigger(文字列 triggerTypeId) メソッドを呼び出して、作成するトリガーの種類を指定する必要があります。この呼び出しは必須です。使用可能なトリガータイプのリストについては、「 How Proactive Triggers work」を参照してください。

    次に、メッセージの送信先のユーザーを識別するメソッドの 1 つを呼び出す必要があります。これを行うには、次のいずれかのメソッドを呼び出します。

    次に、 ProactiveTriggerAPI - setTriggerRecord(文字列 triggerRecord) メソッドを呼び出して、プロアクティブトリガーのルールとアクションを適用するトリガーレコードを指定する必要があります。

    最後に、 ProactiveTriggerAPI - process() メソッドを呼び出して呼び出しチェーンを実行します。setTriggerRecord() メソッド呼び出しと process() メソッド呼び出しの両方が必要です。

    例：
    var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
  .setUserName(userName).setTriggerRecord(userId).process();

    ProactiveTriggerAPI - createTrigger(文字列 triggerTypeId)

    サーバー側の プロアクティブトリガー イベントを作成します。

    表 : 1. パラメーター
    名前 タイプ 説明
    triggerTypeId 文字列 作成するトリガータイプの一意の ID。プロアクティブトリガータイプ [sys_cs_ptrigger_trigger_type] テーブルの ID フィールドにあります。

    例: triggerTypeId = "sn_pt.ai_search_event"
    表 : 2. 返される内容
    パラメーター 説明
    なし

    次のビジネスルールは、ビジネスルール内で createTrigger() メソッドを呼び出す方法を示しています。

    try {
  var triggerTypeId = "sn_pt.ai_search_event";
  var userId = current.getValue("user");

  var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
       .setUserId(userId).setTriggerRecord(current).process();

  // Returns the Proactive Trigger Event record's sys_id
  gs.info("Proactive Trigger Event Sys Id:"+ eventSysId);

} catch (e) {
    gs.info("error:"+e); // Log the error.
}

    ProactiveTriggerAPI - process()

    指定された プロアクティブトリガー API 要求を実行します。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    sys_id 作成されたプロアクティブトリガーイベントレコードのSys_id。プロアクティブイベント [sys_cs_ptrigger_event] テーブルにあります。

    データタイプ：文字列

    次のビジネスルールは、 process() メソッドを呼び出して、指定された プロアクティブトリガー API 要求を実行する方法を示しています。

    try {
  var triggerTypeId = "sn_pt.ai_search_event";
  var userId = current.getValue("user");

  var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
       .setUserId(userId).setTriggerRecord(current).process();

  // Returns the Proactive Trigger Event record's sys_id
  gs.info("Proactive Trigger Event Sys Id:"+ eventSysId);

} catch (e) {
    gs.info("error:"+e); // Log the error.
}

    ProactiveTriggerAPI - setTriggerRecord(文字列 triggerRecord)

    プロアクティブトリガーのルールとアクションを適用するトリガーレコードを設定します。

    これらのルールとアクションは、プロアクティブトリガータイプ [sys_cs_ptrigger_trigger_type] テーブルにある関連するトリガータイプレコードで定義されます。

    表 : 5. パラメーター
    名前 タイプ 説明
    トリガーレコード 文字列または GlideRecord 関連するプロアクティブトリガーのルールとアクションを適用するトリガーレコードのSys_idまたは GlideRecord。トリガーレコードは、 createTrigger() メソッド呼び出しで指定されたトリガータイプレコードの trigger_table フィールドで指定されたテーブルにあります。

    たとえば、 createTrigger() 呼び出しで AI 検索イベントトリガータイプが指定されている場合、トリガーテーブルは検索イベント [sys_search_event] テーブルです。

    注:
    通常、このテーブルは、ビジネスルールの実行の原因となったテーブルと同じです。同じでない場合は、このsys_idを GlideRecord に追加して、このメソッドに渡すことができるようにする必要があります。
    表 : 6. 返される内容
    タイプ 説明
    なし

    次のビジネスルールは、 setTriggerRecord() メソッドを呼び出す方法を示しています。

    try {
  var triggerTypeId = "sn_pt.ai_search_event";
  var userId = current.getValue("user");

  var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
       .setUserId(userId).setTriggerRecord(current).process();

  // Returns the Proactive Trigger Event record's sys_id
  gs.info("Proactive Trigger Event Sys Id:"+ eventSysId);

} catch (e) {
    gs.info("error:"+e); // Log the error.
}

    ProactiveTriggerAPI - setUserId(文字列 userId)

    ユーザー ID を使用して、関連付けられた プロアクティブトリガー イベントによって生成されたメッセージの送信先ユーザーを設定します。

    表 : 7. パラメーター
    名前 タイプ 説明
    userId 文字列 関連付けられた プロアクティブトリガー メッセージの送信先のユーザーのSys_id。ユーザー [sys_user] テーブルまたは関連する GlideRecord にあります。
    表 : 8. 返される内容
    パラメーター 説明
    なし

    次のコード例は、現在の GlideRecord の user フィールドの値を使用して setUserId() メソッドを呼び出す方法を示しています。

    try {
  var triggerTypeId = "sn_pt.ai_search_event";
  var userId = current.getValue("user");

  var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
       .setUserId(userId).setTriggerRecord(current).process();

  // Returns the Proactive Trigger Event record's sys_id
  gs.info("Proactive Trigger Event Sys Id:"+ eventSysId);

} catch (e) {
    gs.info("error:"+e); // Log the error.
}

    ProactiveTriggerAPI - setUserName(文字列 userName)

    ユーザー名を使用して、関連付けられた プロアクティブトリガー イベントによって生成されたメッセージの送信先ユーザーを設定します。

    表 : 9. パラメーター
    名前 タイプ 説明
    userName 文字列 プロアクティブメッセージの送信先のユーザーの名前。この名前は、ユーザー [sys_user] テーブルの [ユーザー ID] フィールド (「abel.tuter」など) に関連付けられている必要があります。
    表 : 10. 返される内容
    パラメーター 説明
    なし

    次のビジネスルールは、現在の GlideRecord の sys_created_by フィールドの値を使用して setUserName() メソッドを呼び出す方法を示しています。

    try {
  var triggerTypeId = "sn_pt.ai_search_event";

  // User name of the user to whom to send the proactive message.
  var userName = current.getValue("sys_created_by");

  var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
       .setUserName(userName).setTriggerRecord(current).process();

  // Returns the Proactive Trigger Event record's sys_id
  gs.info("Proactive Trigger Event Sys Id:"+ eventSysId);

} catch (e) {
    gs.info("error:"+e); // Log the error.
}

    ProactiveTriggerAPI - setUserSessionId(文字列 userId)

    関連付けられた プロアクティブトリガー イベントにユーザーセッション ID を設定します。この方法を使用する場合、プロアクティブメッセージは、特定のセッションに関連付けられた特定のユーザーにのみ送信されます。

    表 : 11. パラメーター
    名前 タイプ 説明
    ユーザーセッション ID 文字列 プロアクティブトリガーメッセージの送信先ユーザーの現在のセッションのSys_id。
    注:
    すべてのテーブルにセッション ID が含まれているわけではありません。このエンドポイントを使用する前に、参照しているテーブルに有効なセッション ID が含まれていることを確認してください。そうでない場合は、使用可能な最新のセッション ID が使用され、誤った結果が生じる可能性があります。
    表 : 12. 返される内容
    パラメーター 説明
    なし

    次のビジネスルールは、現在の GlideRecord のセッションフィールドの値を使用して setUserSessionId() メソッドを呼び出す方法を示しています。

    try {
  var triggerTypeId = "sn_pt.ai_search_event";
  var sessionId = current.getValue("session");

  var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
       .setUserSessionId(sessionId).setTriggerRecord(current).process();

  // Returns the Proactive Trigger Event record's sys_id
  gs.info("Proactive Trigger Event Sys Id:"+ eventSysId);

} catch (e) {
    gs.info("error:"+e); // Log the error.
}