Gatilhos

Os gatilhos fornecem um mecanismo uniforme para se inscrever em eventos das plataformas de Conector. Isso dá a você a flexibilidade para iniciar automaticamente automações no Orchestrator.

Gatilhos no Orchestrator

Importante:

A partir do final de abril de 2025, é possível criar novos gatilhos do Integration Service apenas no Orchestrator. Os gatilhos criados no Orchestrator não serão listados na aba Gatilhos do Integration Service. Os gatilhos do Integration Service existentes continuarão a ser executados e permanecerão visíveis na aba Gatilhos do Integration Service até 31 de julho de 2025 (essa data está sujeita a possíveis extensões). Após essa data, os gatilhos existentes do Integration Service serão migrados para o Orchestrator, e a aba Gatilhos no Integration Service será removida. Essa alteração é programada para ficar disponível primeiro para os usuários Community e, em seguida, para os usuários Enterprise progressivamente, dependendo da organização e das regiões do tenant. Siga o guia de notas de versão do Integration Service para saber quando a alteração é anunciada pela primeira vez.

Principais benefícios dos gatilhos no Orchestrator

Mover os gatilhos do Integration Service para o Orchestrator é uma grande mudança, mas ela traz muitos benefícios. Estes são os principais motivos que impulsionaram esta atualização:

1. Mapeamento de conta-máquina: o Orchestrator habilita o controle no nível da máquina sobre processos disparados pelo Integration Service.
2. Controle de execução de processos específico por robô: o Orchestrator permite especificar qual robô deve executar um processo em uma pasta na qual vários robôs estão alocados. Isso fornece controle preciso sobre qual robô executa um processo disparado, elimina a necessidade de soluções alternativas, como pastas de robô único, e melhora a escalabilidade ao permitir vários robôs sem perder o controle de execução.
3. Argumentos de entrada e alocação de processos dinâmicos: o Orchestrator habilita argumentos de entrada dinâmicos e permite que você defina o número máximo de instâncias de processos ativas. Isso reduz a duplicação de processos ao permitir argumentos dinâmicos, otimiza o uso de recursos limitando os processos ativos e melhora a eficiência para processos que gerenciam solicitações sequenciais.
4. Gerenciamento aprimorado de processos de longa duração: os gatilhos criados no Orchestrator suportam as opções "Interromper após" e "Encerrar após", permitindo o encerramento automático de processos após uma duração ou condição especificada. Isso impede o uso excessivo de recursos ao encerrar processos de longa duração e garante a execução no tempo certo ao interromper fluxos de trabalho que não respondem.
5. Recursos de edição: o Orchestrator permite que você edite gatilhos existentes.
6. Experiência de gatilhos unificada: crie e gerencie todos os tipos de gatilhos a partir de um local.
7. Visualização de gatilho único: mover a criação de gatilho para o Orchestrator garante que todos os gatilhos baseados no Integration Service mantenham uma única visualização. Agora você pode criar um gatilho baseado no Integration Service de duas maneiras: a partir do Integration Service, criando um gatilho para um conector específico, e a partir do Studio, usando uma atividade Trigger para iniciar uma automação. As informações de configuração exibidas para os dois gatilhos podem diferir ligeiramente, mesmo que capturem o mesmo evento.

Visão geral

Há dois tipos de gatilhos de eventos baseados em conexões do Integration Service:

• Conectado — Criado com atividades de disparo no Studio, usado dentro de um processo.
• Desconectado — Criado no Orchestrator ou Integration Service, usado para iniciar qualquer automação.

Observação:

Os gatilhos dependem de conexões. Excluir uma conexão também exclui todos os gatilhos associados.

Pré-requisitos

Antes de configurar os gatilhos, certifique-se de que as seguintes condições sejam atendidas:

• O Integration Service é habilitado e provisionado para seu tenant.
• Você já configurou um Robô Não assistido ou de Non-production na sua instância do Orchestrator.
• Você está usando pastas modernas (os processos dentro de pastas clássicas não ficam visíveis ao definir gatilhos).
• Os usuários que trabalham com gatilhos têm as permissões necessárias no Orchestrator. Para criar um gatilho, um usuário deve ter a permissão Gatilhos - Criar na pasta de destino. Para obter mais informações sobre permissões, consulte Configuração de acesso para contas no guia do usuário do Orchestrator.

Como os gatilhos funcionam

Gatilhos baseados em pesquisa, como Registro criado ou Incidente criado estão disponíveis para vários conectores da UiPath. Esse tipo de gatilho detecta novos registros usando um mecanismo de pesquisa em relação às APIs públicas do aplicativo de destino.

Os gatilhos operam da seguinte forma:

1. Intervalo de pesquisa - O Integration Service pesquisa o sistema de destino em um intervalo definido (por padrão a cada cinco minutos). O intervalo de pesquisa é definido no nível da conexão e, portanto, alterar o intervalo de pesquisa afeta todos os gatilhos associados a essa conexão.

2. Detecção baseada em API - Durante cada ciclo de pesquisa, o Integration Service consulta o objeto/tabela relevante usando as APIs REST padrão do fornecedor.

3. Identificação de registro incremental - Novos registros são identificados usando parâmetros de consulta de API, mais comumente baseados em:

   • Carimbo de data/hora de criação de registro (por exemplo, sys_created_on)
   • Em alguns cenários, os carimbos de data/hora de modificação

   O Integration Service armazena o carimbo de data/hora da criação mais recente (ou marcador equivalente) do último ciclo de pesquisa bem-sucedido. Na próxima pesquisa, a consulta retoma a partir desse valor armazenado, garantindo a continuidade e evitando o processamento duplicado.

   Por exemplo, uma consulta para pesquisar novos incidentes no ServiceNow pode ser da seguinte forma: GET https://{instance}.service-now.com/api/now/v1/table/incident?sysparm_query=sys_created_on>={last_max_created_date}

   Observação:

   Parâmetros adicionais como paginação, limites, deslocamentos ou expansão de campo podem ser incluídos para oferecer suporte a filtragem e modelagem de dados. Isso não altera a lógica da pesquisa principal.

Criação de gatilhos

Você cria gatilhos de eventos desconectados diretamente do Orchestrator. Para obter detalhes, consulte a seção Gatilhos de eventos no guia do usuário do Orchestrator.

O Orchestrator fornece o gerenciamento direto desses gatilhos. No Integration Service, sua única opção para a modificação de gatilhos é ajustar o intervalo de pesquisa, que é definido no nível de conexão.

Atualização do intervalo de pesquisa

Os conectores suportam eventos por meio de um mecanismo de pesquisa.

Quando você configura um gatilho de evento em uma conexão, o intervalo de pesquisa é definido por padrão como cinco minutos.

O intervalo de pesquisa é definido no nível da conexão. Isso significa que você pode ter apenas um intervalo de pesquisa por conexão, mesmo que você crie vários gatilhos por conexão. Alterar o intervalo de pesquisa afeta todos os gatilhos associados a uma conexão.

A sondagem é executada na conexão no intervalo selecionado. Após os dados serem recuperados, todos os gatilhos ativos para essa conexão são aplicados ao conjunto de dados. Se uma pesquisa estiver em execução quando você alterar o intervalo, o serviço aguardará a pesquisa existente terminar e, então, iniciará outra.

Para atualizar o intervalo de pesquisa:

1. Selecione Orchestrator no inicializador do produto.
2. Selecione uma pasta e navegue até a aba Conexões .
3. No lado direito de uma conexão, selecione Mais ações > Exibir/Editar para abrir a página de edição de conexão.
4. Em Verificar se há eventos a cada:, selecione o intervalo de tempo em minutos ou horas. O intervalo de pesquisa deve ser maior do que um minuto e não maior do que 24 horas ou 1440 minutos.
5. Selecione Atualizar.

Exibição do histórico de execução de gatilhos

Importante:

A tabela Histórico de tentativas está disponível exclusivamente para gatilhos criados no Integration Service e listados na aba Gatilhos . O histórico de tentativas não está disponível para gatilhos criados no Orchestrator.

Para visualizar o histórico de execução do gatilho:

1. No Integration Service, selecione a guia Gatilhos .
2. Para qualquer gatilho listado, selecione Exibir gatilho usando o Menu Mais ações:

A tabela Histórico de tentativas mostra:

• A hora do evento - quando o evento foi capturado
• O número de tentativas
• O estado do gatilho - se o processo foi iniciado com sucesso ou não.

Observação:

O estado Bem-sucedido indica apenas que o trabalho foi iniciado com sucesso. Não reflete se o trabalho foi executado com sucesso até o final ou não. Caso um trabalho falhe ao iniciar, seu Estado aparecerá como Falhado. Passe o cursor do mouse sobre o estado Com falha para visualizar a mensagem de erro.

Para verificar se um trabalho foi executado com sucesso, selecione o botão Exibir logs de trabalho . Essa ação redireciona você para o Orchestrator, onde você pode ver todas as informações necessárias sobre a execução de trabalhos.

Gerenciar gatilhos

As seguintes ações estão disponíveis para gatilhos criados no Integration Service.

Os gatilhos criados diretamente no Orchestrator podem ser gerenciados a partir do Orchestrator.

Renomeando um disparador

Para renomear um gatilho, siga as seguintes etapas:

1. Access the Triggers tab.
2. Passe o cursor do mouse sobre o nome do gatilho que você deseja modificar. O botão Editar é exibido. Ou então, você pode selecionar seu gatilho na lista para acessar a visualização detalhada. O botão Editar está localizado no lado direito do nome de seu gatilho.
3. Selecione o botão Editar e poderá escolher um novo nome para o seu gatilho

Exclusão de um gatilho

Vá para a guia Gatilhos na janela Integration Service . Selecione o botão Mais ações correspondente ao seu gatilho e selecione Excluir.

Ativar ou desativar um gatilho

Para ativar ou desativar um gatilho, primeiro você precisa selecioná-lo para exibir seus detalhes. Em seguida, selecione o botão localizado no lado superior esquerdo da janela.

Argumentos de evento

Os gatilhos desconectados permitem que você recupere dados sobre o conector e o evento que dispara um processo.

Se você quiser saber o conector, evento, tipo de registro ou registro real que disparou o processo em seu fluxo de trabalho, defina os seguintes argumentos de entrada do tipo String em seu processo. O Integration Service as preenche automaticamente quando inicia o trabalho:

• UiPathEventConnector - Determina qual conector iniciou a automação.
• UiPathEvent – Determina o tipo de evento que ocorreu.
• UiPathEventObjectType - Define o tipo de registro específico resultante do evento.
• UiPathEventObjectId - Fornece o identificador exclusivo para o objeto envolvido no evento.

Observação:

Isso se aplica apenas a gatilhos desconectados. Para gatilhos conectados, você já deve ter o objeto inteiro disponível ao projetar seu processo.

Você não pode atribuir qualquer valor a esses argumentos. Eles são preenchidos automaticamente no tempo de execução do gatilho e você não pode visualizá-los ou editá-los no painel Argumentos no Studio. Saiba mais sobre como os argumentos funcionam e como gerenciá-los na documentação do Studio: Gerenciamento de argumentos.

Para recuperar e trabalhar com um registro que possui um gatilho em uma execução de trabalho, use o argumento de entrada UiPathEventObjectId para recuperar o registro do sistema de origem.

Aqui está um exemplo de como o Integration Service passa os valores do argumento de entrada para os logs do Orchestrator:

Saídas específicas do gatilho

Os gatilhos conectados têm saídas específicas do objeto. Por exemplo, o gatilho Microsoft OneDrive & SharePoint Email Recebido gera um objeto do tipo Office365Message, com propriedades como AttachmentsNamesList, FromAddress, InternetMessageId, SentDateTime etc. Para obter detalhes, consulte Microsoft OneDrive & SharePoint.

Use o Editor de Expressão no Studio para visualizar todas as propriedades disponíveis para qualquer objeto de saída de gatilho.

Limitações

As limitações do gatilho estão documentadas na seção Solução de problemas deste guia. Consulte Limitações de gatilho.

Perguntas frequentes

Se uma conexão for interrompida, o que acontecerá com os gatilhos associados a essa conexão?

Se uma conexão for desconectada, os gatilhos associados deixarão de executar temporariamente. Depois que a conexão for reconectada com sucesso, os gatilhos retomarão automaticamente a execução. Como uma etapa adicional, certifique-se de que o gatilho não esteja em um estado desabilitado.

Para gatilhos desconectados, como posso associar a saída do gatilho ao meu processo?

Consulte a seção Argumentos de evento para obter detalhes sobre como recuperar dados sobre o conector e o evento que dispara um processo.

Usando o argumento UiPathEventObjectId , você pode adicionar uma chamada de atividade Get Record ou HTTP em seu processo para buscar os dados do registro correspondentes.

Observação:

Isso se aplica apenas a gatilhos desconectados. Para gatilhos conectados, você já deve ter o objeto inteiro disponível ao projetar seu processo.

Como posso alterar o intervalo de pesquisa para o meu gatilho?

Você pode modificar o intervalo de pesquisa diretamente na configuração do gatilho. Consulte este guia para obter etapas detalhadas: Atualizar o intervalo de pesquisa.

Posso filtrar quais registros disparam minha automação?

Sim. Você pode adicionar Filtros de dados (para conectores que o suportam) para controlar quais registros por fim iniciam seu processo.

Observação:

Os filtros são aplicados após os registros serem buscados pelo Integration Service.

Por exemplo:

• Crie um filtro no Studio Web:

  

• Criar um filtro no Orchestrator:

  

Por que meu gatilho não é disparado imediatamente?

O tempo de execução do disparador pode variar dependendo do tipo de disparador, volume de dados e disponibilidade do robô.

Para gatilhos baseados em pesquisa:

• O gatilho busca registros novos ou atualizados com base no intervalo de pesquisa configurado no Integration Service.

• Dependendo do volume de dados recuperados, o Integration Service aplica quaisquer filtros ou condições de gatilho definidos antes de passar eventos de qualificação para o Orchestrator.

• Este processamento pode introduzir uma menor latência, especialmente ao manipular conjuntos de dados grandes ou filtros complexos.

• Após os eventos serem entregues ao Orchestrator, a automação começa apenas se um Unattended Robot estiver disponível naquele momento.

• Se o intervalo de pesquisa for definido muito longo, um grande volume de dados poderá ser recuperado de uma vez, potencialmente retardando seu processo. Nesses casos, considere reduzir o intervalo para melhorar o desempenho.

  Observação:

  Se seu gatilho parecer atrasado, verifique seu intervalo de pesquisa, revise os filtros quanto à eficiência e certifique-se de que um Unattended Robot esteja disponível para executar o trabalho.

Para gatilhos baseados em webhook (por exemplo, HTTP Webhook):

• Os gatilhos do Webhook são projetados para disparar quase instantaneamente, pois os eventos são enviados diretamente pelo aplicativo externo para o Integration Service.
• Como os webhooks normalmente lidam com um registro por transação, a latência é mínima.
• No entanto, se os filtros de gatilho ou a lógica de processamento forem aplicados antes de o evento ser transferido para o Orchestrator, você ainda poderá observar um pequeno atraso.

Como solucionar problemas de um gatilho que não está disparando?

• Verifique se a conexão associada está ativa.
• Verifique se o gatilho está habilitado.
• Verifique se sua conexão requer um escopo ou função específico para acessar o endpoint da API de destino que está sendo pesquisado.
• Confirme se o filtro corresponde aos dados esperados.
• Para gatilhos de webhook, confirme se o registro do webhook é válido no aplicativo externo.

Quando um gatilho coleta registros pela primeira vez?

A primeira execução de um disparador começa a partir do momento em que o disparador é criado.

Os registros criados antes da criação do gatilho não são selecionados e todos os registros criados/atualizados após o carimbo de data/hora da criação do gatilho são elegíveis para processamento de acordo com os filtros do gatilho.

Durante o modo de depuração, quando o gatilho obtém registros pela primeira vez?

Durante o modo de depuração, o gatilho Iniciar evento (o gatilho que inicia um processo) considera eventos da última hora em relação ao tempo de configuração.