ActivgerAPI proativa - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 6 min. de leitura

    • . ActivgerAPI proativa permite que você crie gatilhos do lado do servidor que enviam mensagens específicas do contexto para um usuário especificado.

    Esta API usa regras e ações relacionadas com base nessas regras para enviar mensagens para um usuário. Essas regras e ações são específicas do contexto e são baseadas em dados em tempo real coletados conforme o usuário navega pelas páginas do portal. Para obter informações adicionais, confira Proactive Triggers.

    Antes de usar esta API, os tipos de gatilho, as regras e as ações devem ser configurados em sua instância. Para obter informações sobre como configurar Gatilhos proativos, consulte Configuring Proactive Triggers.

    Usando esta API, você pode enviar mensagens para um usuário específico ou para um usuário em uma sessão específica.

    Por exemplo, no caso em que um cliente adiciona itens ao carrinho, você pode ter um Gatilhos proativos evento em uma regra de negócios que envia um lembrete para o usuário concluir o check-out após um período especificado.

    Da mesma forma, se um usuário executar um Pesquisa com IA de um Portal de serviços e nenhum resultado for retornado, você pode ter lógica em uma regra de negócios que cria um Gatilhos proativos que envia ofertas alternativas para o usuário por meio do cliente web de mensagem pop-over proativa.

    Ao chamar ActivgerAPI proativa há uma sequência específica na qual você deve chamar os métodos. Esta API é executada no sn_pt namespace.

    Primeiro, você deve chamar ProactiveTriggerAPI - createTrigger(cadeia de caracteres triggerTypeId) método para especificar o tipo de gatilho que você deseja criar. Esta chamada é necessária. Para obter a lista de tipos de gatilho disponíveis, consulte How Proactive Triggers work.

    Em seguida, você deve chamar um dos métodos que identifica o usuário para quem as mensagens devem ser enviadas. Você pode fazer isso chamando um dos seguintes métodos:

    Em seguida, você deve chamar ProactiveTriggerAPI - setTriggerRecord(cadeia de caracteres triggerRecord) Método para especificar o registro do gatilho no qual as regras e ações dos gatilhos proativos serão aplicadas.

    Por fim, ligue para ProactiveTriggerAPI - process() método para executar a cadeia de chamadas. . SetTriggerRecord() e. processo() chamadas de método são necessárias.

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

    ProactiveTriggerAPI - createTrigger(cadeia de caracteres triggerTypeId)

    Cria um lado do servidor Gatilhos proativos evento.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    TriggerTypeId Cadeia de caracteres ID exclusivo do tipo de gatilho a ser criado.

    Por exemplo: "Sn_pt.ai_search_event"

    Tabela: Campo de ID da tabela Tipos de gatilho proativo [sys_cs_ptrigger_trigger_type].
    Tabela 2. Retornos
    Parâmetro Descrição
    Nenhum(a)

    A regra de negócio a seguir mostra como chamar o. CreateTrigger() método dentro de uma regra de negócio.

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

    Executa o especificado Gatilhos proativos Solicitação de API.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    sys_id Sys_id do registro de evento do gatilho proativo que foi criado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Evento proativo [sys_cs_ptrigger_event]

    A regra de negócio a seguir mostra como chamar o. processo() método para executar o especificado Gatilhos proativos Solicitação de 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(cadeia de caracteres triggerRecord)

    Define o registro do gatilho no qual as regras e ações dos gatilhos proativos serão aplicadas.

    Essas regras e ações são definidas no registro de tipo de gatilho associado, localizado na tabela Tipos de gatilho proativo [sys_cs_ptrigger_trigger_type].

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    TriggerRecord String ou GlideRecord Sys_id ou GlideRecord do registro do gatilho no qual aplicar as regras e ações dos gatilhos proativos associados. O registro do gatilho está localizado na tabela especificada no campo trigger_table do registro de tipo de gatilho especificado em CreateTrigger() chamada de método.

    Por exemplo, se seu CreateTrigger() A chamada especificou o tipo de gatilho do evento da Pesquisa com IA e, em seguida, a tabela do gatilho é a tabela Evento de pesquisa [sys_search_event].

    Nota:
    Normalmente, essa tabela é igual à tabela que causou a execução da regra de negócios. Se não for o mesmo, você precisará adicionar este sys_id ao GlideRecord para passá-lo para este método.
    Tabela 6. Retornos
    Tipo Descrição
    Nenhum(a)

    A regra de negócio a seguir mostra como chamar o. SetTriggerRecord() método.

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

    ActivgerAPI - setUserId(cadeia de caracteres UserId)

    Define o usuário para quem enviar a mensagem gerada pelo associado Gatilhos proativos Evento usando o ID do usuário.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    userId Cadeia de caracteres Sys_id do usuário para quem enviar o associado Gatilhos proativos mensagem.

    Tabela: Tabela do usuário [sys_user] ou no GlideRecord associado.
    Tabela 8. Retornos
    Parâmetro Descrição
    Nenhum(a)

    O exemplo de código a seguir mostra como chamar SetUserId() Método que usa o valor no campo usuário do GlideRecord atual.

    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(cadeia de caracteres de nome de usuário)

    Define o usuário para quem enviar a mensagem gerada pelo associado Gatilhos proativos evento usando o nome de usuário.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    userName Cadeia de caracteres Nome do usuário para quem enviar a mensagem proativa. Este nome deve estar correlacionado ao campo ID do usuário na tabela Usuário [sys_user], como "abel.tuter".
    Tabela 10. Retornos
    Parâmetro Descrição
    Nenhum(a)

    A regra de negócio a seguir mostra como chamar o. SetUserName() Método que usa o valor no campo sys_created_by do GlideRecord atual.

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

    ActivgerAPI - setUserSessionId(cadeia de caracteres UserId)

    Define o ID da sessão do usuário no associado Gatilhos proativos evento. Ao usar este método, a mensagem proativa é enviada somente para o usuário específico associado a uma sessão específica.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    UserSessionId Cadeia de caracteres Sys_id da sessão atual do usuário a quem Gatilhos proativos a mensagem deve ser enviada.
    Nota:
    Nem todas as tabelas contêm um ID de sessão. Antes de usar este endpoint, certifique-se de que a tabela à qual você está fazendo referência contenha um ID de sessão válido. Caso contrário, o ID de sessão mais recente disponível será usado, o que pode causar resultados incorretos.
    Tabela 12. Retornos
    Parâmetro Descrição
    Nenhum(a)

    A regra de negócio a seguir mostra como chamar o. SetUserSessionId() Método que usa o valor no campo de sessão do GlideRecord atual.

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