ProactiveTriggerAPI – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 5 Minuten Lesedauer

    • Die ProactiveTriggerAPI Ermöglicht Ihnen das Erstellen serverseitiger Auslöser, die kontextspezifische Nachrichten an einen angegebenen Anwender senden.

    Diese API verwendet Regeln und zugehörige Aktionen basierend auf diesen Regeln, um Nachrichten an einen Anwender zu senden. Diese Regeln und Aktionen sind kontextspezifisch und basieren auf Echtzeitdaten, die erfasst werden, wenn der Anwender über Portalseiten navigiert. Weitere Informationen finden Sie unter Proactive Triggers.

    Vor der Verwendung dieser API müssen die Auslösertypen, Regeln und Aktionen in Ihrer Instanz konfiguriert werden. Für Informationen zur Konfiguration Proaktive Auslöser, Siehe Configuring Proactive Triggers.

    Mit dieser API können Sie Nachrichten an einen bestimmten Anwender oder an einen Anwender in einer bestimmten Sitzung senden.

    Wenn ein Kunde beispielsweise Artikel in seinen Einkaufswagen legt, können Sie einen haben Proaktive Auslöser Ereignis innerhalb einer Geschäftsregel, die eine Erinnerung an den Anwender sendet, den Check-out nach einem bestimmten Zeitraum abzuschließen.

    Ebenso, wenn ein Anwender eine ausführt KI-Suche Von einem Serviceportal Und es werden keine Ergebnisse zurückgegeben. Sie können Logik in einer Business-Regel haben, die eine erstellt Proaktive Auslöser Die dem Anwender alternative Angebote über den proaktiven Popover-Nachrichten-Web-Client sendet.

    Beim Aufruf von ProactiveTriggerAPI , Es gibt eine bestimmte Sequenz, in der Sie die Methoden aufrufen sollten. Diese API wird in ausgeführt sn_pt Namespace.

    Rufen Sie zuerst an ProactiveTriggerAPI – createTrigger(String triggerTypeId) Methode zum Angeben des Auslösertyps, den Sie erstellen möchten. Dieser Anruf ist erforderlich. Eine Liste der verfügbaren Auslösertypen finden Sie unter How Proactive Triggers work.

    Als Nächstes sollten Sie eine der Methoden aufrufen, die den Anwender identifiziert, an den die Nachrichten gesendet werden sollen. Sie können dies tun, indem Sie eine der folgenden Methoden aufrufen:

    Als Nächstes sollten Sie den anrufen ProactiveTriggerAPI – setTriggerRecord(String triggerRecord) Methode zum Angeben des Auslöserdatensatzes, auf den die Regeln und Aktionen der proaktiven Auslöser angewendet werden sollen.

    Rufen Sie abschließend an ProactiveTriggerAPI – Process() Methode zum Ausführen der Aufrufkette. Beide SetTriggerRecord() Und Prozess() Methodenaufrufe sind erforderlich.

    Zum Beispiel:
    var eventSysId = sn_pt.ProactiveTriggerAPI.createTrigger(triggerTypeId)
  .setUserName(userName).setTriggerRecord(userId).process();

    ProactiveTriggerAPI – createTrigger(String triggerTypeId)

    Erstellt eine serverseitige Seite Proaktive Auslöser Ereignis.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    TriggerTypeId Zeichenfolge Eindeutige ID des zu erstellenden Auslösertyps.

    Beispiel: TriggerTypeId = „sn_pt.ai_search_event“

    Tabelle: ID-Feld der Tabelle „proaktive Auslösertypen“ [sys_cs_ptrigger_type].
    Tabelle : 2. Rückgaben
    Parameter Beschreibung
    Keine

    Die folgende Business-Regel zeigt, wie aufgerufen wird CreateTrigger() Methode in einer Business-Regel.

    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()

    Führt den angegebenen aus Proaktive Auslöser API-Anforderung.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    sys_id SYS_ID des Datensatzes des proaktiven Auslöserereignisses, der erstellt wurde.

    Datentyp: Zeichenfolge

    Tabelle: Proaktives Ereignis [sys_cs_ptrigger_event]

    Die folgende Business-Regel zeigt, wie aufgerufen wird Prozess() Methode zum Ausführen des angegebenen Proaktive Auslöser API-Anforderung.

    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(String triggerRecord)

    Legt den Auslöserdatensatz fest, auf den die Regeln und Aktionen der proaktiven Auslöser angewendet werden sollen.

    Diese Regeln und Aktionen sind im zugehörigen Auslösertyp-Datensatz definiert, der sich in der Tabelle „proaktive Auslösertypen“ [sys_cs_ptrigger_type] befindet.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    TriggerRecord Zeichenfolge oder GlideRecord SYS_ID oder GlideRecord des Auslöserdatensatzes, auf den die Regeln und Aktionen der zugehörigen proaktiven Auslöser angewendet werden sollen. Der Auslöserdatensatz befindet sich in der Tabelle, die im Feld Trigger_table des Auslösertypdatensatzes angegeben ist, der in angegeben wurde CreateTrigger() Methodenaufruf.

    Beispiel: Wenn Sie CreateTrigger() Aufruf hat den Auslösertyp „KI-Suche – Ereignis“ angegeben. Dann ist die Auslösertabelle die Tabelle „Suchereignis“ [sys_search_event].

    Hinweis:
    Diese Tabelle ist normalerweise mit der Tabelle identisch, die die Ausführung der Business-Regel verursacht hat. Wenn sie nicht identisch ist, müssen Sie diese sys_ID dem GlideRecord hinzufügen, damit Sie sie an diese Methode übergeben können.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine

    Die folgende Business-Regel zeigt, wie aufgerufen wird SetTriggerRecord() Methode.

    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(Zeichenfolge userid)

    Legt den Anwender fest, an den die vom zugeordneten generierte Nachricht gesendet werden soll Proaktive Auslöser Ereignis mit der Anwender-ID.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    userId Zeichenfolge SYS_ID des Anwenders, an den der zugeordnete gesendet werden soll Proaktive Auslöser Nachricht.

    Tabelle: Anwendertabelle [sys_user] oder im zugehörigen GlideRecord.
    Tabelle : 8. Rückgaben
    Parameter Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie der aufgerufen wird SetUserId() Methode, die den Wert im Anwenderfeld des aktuellen GlideRecord verwendet.

    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(Zeichenfolgen-Anwendername)

    Legt den Anwender fest, an den die vom zugeordneten generierte Nachricht gesendet werden soll Proaktive Auslöser Ereignis mit dem Anwendernamen.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    userName Zeichenfolge Name des Anwenders, an den die proaktive Nachricht gesendet werden soll. Dieser Name muss mit dem Feld „Anwender-ID“ in der Tabelle „Anwender“ [sys_user] korrelieren, z. B. „abel.tuter“.
    Tabelle : 10. Rückgaben
    Parameter Beschreibung
    Keine

    Die folgende Business-Regel zeigt, wie aufgerufen wird SetUserName() Methode, die den Wert im Feld sys_created_by des aktuellen GlideRecord verwendet.

    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(Zeichenfolge userid)

    Legt die Anwendersitzungs-ID für die zugeordnete fest Proaktive Auslöser Ereignis. Bei Verwendung dieser Methode wird die proaktive Nachricht nur an den bestimmten Anwender gesendet, der einer bestimmten Sitzung zugeordnet ist.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    UserSessionId Zeichenfolge SYS_ID der aktuellen Sitzung des Anwenders, für den der Proaktive Auslöser Nachricht muss gesendet werden.
    Hinweis:
    Nicht alle Tabellen enthalten eine Sitzungs-ID. Stellen Sie vor der Verwendung dieses Endpunkts sicher, dass die Tabelle, auf die Sie verweisen, eine gültige Sitzungs-ID enthält. Wenn nicht, wird die neueste verfügbare Sitzungs-ID verwendet, was zu fehlerhaften Ergebnissen führen kann.
    Tabelle : 12. Rückgaben
    Parameter Beschreibung
    Keine

    Die folgende Business-Regel zeigt, wie aufgerufen wird SetUserSessionId() Methode, die den Wert im Sitzungsfeld des aktuellen GlideRecord verwendet.

    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.
}