Gerenciamento de gatilhos de API

Criação de um gatilho de API

1. Em uma pasta, navegue até Automações > Gatilhos > Gatilhos de API.
2. Clique em Adicionar um novo gatilho. A janela Criar um novo gatilho de API é exibida.
3. No menu suspenso Nome do processo, selecione um processo subjacente para seu gatilho.
4. No campo Nome, adicione um nome para que o gatilho o identifique facilmente.
5. No menu suspenso Prioridade do trabalho, selecione a prioridade do trabalho. O valor padrão é Herdada, significando que a prioridade do trabalho é a mesma que foi definida para o processo selecionado.
6. No menu suspenso Tipo de runtime, selecione o runtime usado para executar os trabalhos que são iniciados pelo gatilho.
7. Na aba Argumentos, forneça valores para argumentos de entrada se seu processo tiver algum. Veja mais detalhes sobre argumentos de entrada e saída.
8. No menu suspenso Verbo, selecione a opção que descreve a ação que você deseja que seu trabalho realize: DELETE, GET, POST e PUT.
9. No campo Campo de dados dinâmico, digite um campo de dados dinâmico que será anexado ao URL base, gerando, assim o URL final para o ponto de extremidade resultante que você usará em seu aplicativo. Você pode ver uma visualização do URL completo nesse campo.
   O campo de dados dinâmico padrão é ${Process_Name}, mas você pode personalizá-lo para garantir a exclusividade dele no nível do tenant.

   Observe que ele não é compatível com barras.

10. No menu suspenso Modo de chamada padrão, selecione o modo de chamada desejado. As opções disponíveis são:

    • Pesquisa assíncrona (esse é o padrão, mas pode ser alterado)

    • Disparo assíncrono&esquecer

    • Sincronização (sondagem longa)

    Saiba mais sobre essas opções em Início de um trabalho por meio de um gatilho de API.

11. Ative a alternância Agendar o fim da execução de trabalho para selecionar uma estratégia de encerramento do trabalho.
    Observação:

    • O quantidade de tempo especificado aqui transcorre de acordo com as especificações, mesmo se o trabalho estiver enfileirado. Por exemplo, se você agendar um trabalho para executar às 13h e o definir para parar após 20 minutos, o trabalho será interrompido às 13h20, mesmo que tenha permanecido em uma fila até as 13h15 e, depois, iniciado.
    • As opções de Agendar o fim da execução de trabalho de um gatilho são preservadas para trabalhos iniciados manualmente.

    Por exemplo, digamos que você tenha criado um gatilho T1 e ativado os seguintes agendamentos de fim de trabalho:

    • Agendar o fim da execução do trabalho: interrompe o trabalho após 10 minutos

    • Agendar "encerramento" automático, se o trabalho não parar: encerra o trabalho após 2 minutos

      Na página Automações > Gatilhos, ao clicar em Iniciar um trabalho agora para o gatilho T1, a página Iniciar trabalho será aberta com os agendamentos de fim de trabalho já aplicados, os mesmos configurados na criação do gatilho.

    Além disso, se você agendar para interromper um trabalho Pendente ou Em Execução após 2 horas e também configurar para encerrar o mesmo trabalho após 3 horas, o trabalho será encerrado após 5 horas. Isso acontece porque, primeiro, é enviado ao Orchestrator o sinal de que o trabalho foi interrompido após 2 horas. Depois que o sinal é recebido, a ação de encerramento do trabalho é disparada para ocorrer em 3 horas, resultando em um total de 5 horas.

    • Selecione Parar no menu suspenso - tenta encerrar com graça a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado Pendente ou Em Execução (defina o tempo como no mínimo 1 minuto, máximo de 10 dias, 23 horas e 59 minutos);
      Exemplo: o Orchestrator tentará interromper trabalhos que ficaram travados por pelo menos 10 minutos em Pendente ou Em Execução.

      

    • Selecione Encerrar no menu suspenso - tenta encerrar com força a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado estado Pendente ou Em Execução (defina o tempo como no mínimo 1 minuto, máximo de 10 dias, 23 horas e 59 minutos);

      Exemplo: o Orchestrator tentará encerrar trabalhos que ficaram travados por pelo menos 10 minutos em Pendente ou Em Execução.

    • Selecione Parar no menu suspenso e habilite a opção Se o trabalho não parar, encerre-o - tenta encerrar com graça a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado Pendente ou Em Execução e, em seguida, tenta encerrá-lo com força depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado Parando (defina o tempo para um mínimo de 1 minuto, máximo de 10 dias, 23 horas e 59 minutos).

      Exemplo: o Orchestrator tentará interromper trabalhos que ficaram parados em Pendentes ou Em Execução por pelo menos 10 minutos. Se o término não ocorrer, o Orchestrator tentará encerrar os jobs que estiveram no status Parando por pelo menos 20 minutos.

12. Ative a opção Agendar a desativação automática de gatilho e insira a data e hora em que o gatilho deve ser desativado. O fuso horário influencia quando o gatilho do tempo é desativado.
13. Ative a alternância Gerar um alerta se o trabalho estiver preso (no status Pendente ou Retomado) e defina a duração aceitável para o trabalho permanecer no status Pendente ou Retomado. A duração mínima configurável é de um minuto. A duração máxima configurável é de onze dias. Se o trabalho exceder a duração configurada, um pop-up de alerta de gravidade de “Erro” informa a você sobre isso com o seguinte texto: “N trabalhos para o processo no. {process_number} estão pendentes ou foram retomados há mais de X horas e Y minutos.“, Onde:
    • N - é o número de trabalhos que acionaram o alerta;
    • {process_number} - o identificador do processo;
    • X — o número configurado de horas que o trabalho excedeu enquanto tinha o status Pendente ou Retomado; dias são convertidos em horas.
    • Y - o número configurado de minutos que o trabalho excedeu enquanto tinha o status Pendente ou Retomado.
14. Ative a alternância Gerar um alerta se o trabalho for iniciado e não tiver sido concluído e defina a duração aceitável para o trabalho ser concluído. A duração configurável é de no mínimo um minuto e no máximo onze dias. Se o trabalho exceder a duração configurada, um pop-up de alerta de gravidade de "Erro" informa a você sobre isso com o seguinte texto: "O trabalho para processo no. {process_number} está pendente foi executado por mais de X horas e Y minutos.", onde:
    • {process_number} - o identificador do processo;
    • X — o número de horas configuradas que o trabalho excedeu ao tentar ser concluído; dias são convertidos em horas.
    • Y - o número configurado de minutos que o trabalho excedeu enquanto tentava ser concluído.
15. Ative a alternância Definir a desativação do gatilho baseado em execução se desejar controlar quando o gatilho é desativado quando um trabalho falha. Essa alternância revela duas opções:

    Opção	Description
    Desabilitar quando a execução consecutiva do trabalho falhar na contagem	O disparador é desabilitado após o número de execuções com falha que você escolher para esta configuração. É possível escolher um valor entre 0 e 100. O padrão é 0, o que significa que o disparador nunca é desabilitado. Os trabalhos interrompidos não são contados para esse valor.
    Período de tolerância ao desabilitar o gatilho (dias)	O número de dias a se esperar antes que o disparador seja desabilitado após a primeira falha de um trabalho. Você pode escolher um valor entre 0 e 30. O padrão é 0, significando que o gatilho é desativado assim que o número de execuções de trabalho definidas no campo acima é alcançado para o dia atual.

    Observação:

    Se você escolher um runtime Cloud - Serverless para o processo subjacente, a opção Definir desativação do gatilho com base na execução é habilitada automaticamente, com os seguintes valores padrão (os campos são apenas leitura):

    • Desabilitar quando a contagem de falhas da execução do trabalho estiver definida como 10.

    • O período de tolerância para desabilitar o gatilho (dias) está definido como 0.

    Isso só se aplica a você se você estiver no plano de licenciamento Community.

16. Para manter o mesmo contexto conta-máquina configurado para iniciar o trabalho, marque a caixa Manter alocação conta/máquina na retomada do trabalho. Isso otimiza sua licença e o uso de recursos.

Importante:

• As configurações de execução no nível do tenant se aplicam a gatilhos de API.

• Você pode criar no máximo 1.000 gatilhos de API por tenant.

Criação de um gatilho de API para um agente

1. Em uma pasta, navegue até Automações > Gatilhos > Gatilhos de API.
2. Clique em Adicionar um novo gatilho. A janela Criar um novo gatilho de API é exibida.
3. No menu suspenso Nome do processo, selecione um processo subjacente para seu gatilho.
4. No campo Nome, adicione um nome para que o gatilho o identifique facilmente.
5. No menu suspenso Verbo, selecione a opção que descreve a ação que você deseja que seu trabalho realize: DELETE, GET, POST e PUT.
6. No campo Campo de dados dinâmico, digite um campo de dados dinâmico que será anexado ao URL base, gerando, assim o URL final para o ponto de extremidade resultante que você usará em seu aplicativo. Você pode ver uma visualização do URL completo nesse campo.
   O campo de dados dinâmico padrão é ${Process_Name}, mas você pode personalizá-lo para garantir a exclusividade dele no nível do tenant.

   Observe que ele não é compatível com barras.

7. No menu suspenso Modo de chamada padrão, selecione o modo de chamada desejado. As opções disponíveis são:

   • Pesquisa assíncrona (esse é o padrão, mas pode ser alterado)

   • Disparo assíncrono&esquecer

   • Sincronização (sondagem longa)

   Saiba mais sobre essas opções em Início de um trabalho por meio de um gatilho de API.

8. Ative a alternância Agendar o fim da execução de trabalho para selecionar uma estratégia de encerramento do trabalho.
   Observação:

   • O quantidade de tempo especificado aqui transcorre de acordo com as especificações, mesmo se o trabalho estiver enfileirado. Por exemplo, se você agendar um trabalho para executar às 13h e o definir para parar após 20 minutos, o trabalho será interrompido às 13h20, mesmo que tenha permanecido em uma fila até as 13h15 e, depois, iniciado.
   • As opções de Agendar o fim da execução de trabalho de um gatilho são preservadas para trabalhos iniciados manualmente.

   Por exemplo, digamos que você tenha criado um gatilho T1 e ativado os seguintes agendamentos de fim de trabalho:

   • Agendar o fim da execução do trabalho: interrompe o trabalho após 10 minutos

   • Agendar "encerramento" automático, se o trabalho não parar: encerra o trabalho após 2 minutos

     Na página Automações > Gatilhos, ao clicar em Iniciar um trabalho agora para o gatilho T1, a página Iniciar trabalho será aberta com os agendamentos de fim de trabalho já aplicados, os mesmos configurados na criação do gatilho.

   Além disso, se você agendar para interromper um trabalho Pendente ou Em Execução após 2 horas e também configurar para encerrar o mesmo trabalho após 3 horas, o trabalho será encerrado após 5 horas. Isso acontece porque, primeiro, é enviado ao Orchestrator o sinal de que o trabalho foi interrompido após 2 horas. Depois que o sinal é recebido, a ação de encerramento do trabalho é disparada para ocorrer em 3 horas, resultando em um total de 5 horas.

   • Selecione Parar no menu suspenso - tenta encerrar com graça a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado Pendente ou Em Execução (defina o tempo como no mínimo 1 minuto, máximo de 10 dias, 23 horas e 59 minutos);

     Exemplo: o Orchestrator tentará interromper trabalhos que ficaram travados por pelo menos 10 minutos em Pendente ou Em Execução.

   • Selecione Encerrar no menu suspenso - tenta encerrar com força a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado estado Pendente ou Em Execução (defina o tempo como no mínimo 1 minuto, máximo de 10 dias, 23 horas e 59 minutos);

     Exemplo: o Orchestrator tentará encerrar trabalhos que ficaram travados por pelo menos 10 minutos em Pendente ou Em Execução.

   • Selecione Interromper no menu suspenso e habilite a opção Agendar encerramento automático, se o trabalho não parar - tenta encerrar de forma suave a execução após o intervalo de tempo definido ter passado desde que o trabalho ficou preso em um estado Pendente ou Em Execução e, em seguida, tenta encerrá-la à força após o intervalo de tempo definido ter passado desde que o trabalho ficou preso em um estado Parando (defina o tempo como um mínimo de 1 minuto, máximo de 10 dias, 23 horas e 59 minutos).

     Exemplo: o Orchestrator tentará interromper trabalhos que ficaram parados em Pendentes ou Em Execução por pelo menos 10 minutos. Se o término não ocorrer, o Orchestrator tentará encerrar os jobs que estiveram no status Parando por pelo menos 20 minutos.

9. Ative a alternância Gerar um alerta se o trabalho for iniciado e não tiver sido concluído e defina a duração aceitável para o trabalho ser concluído. A duração configurável é de no mínimo um minuto e no máximo onze dias. Se o trabalho exceder a duração configurada, um pop-up de alerta de gravidade de "Erro" informa a você sobre isso com o seguinte texto: "O trabalho para processo no. {process_number} está pendente foi executado por mais de X horas e Y minutos.", onde:
   • {process_number} - o identificador do processo;
   • X — o número de horas configuradas que o trabalho excedeu ao tentar ser concluído; dias são convertidos em horas.
   • Y - o número configurado de minutos que o trabalho excedeu enquanto tentava ser concluído.
10. Na aba Destino de execução, use o menu suspenso Conta para selecionar Qualquer conta de Usuário ou Robô, que aloca a conta dinamicamente, ou selecione uma conta específica na lista.
11. Se o pacote tiver argumentos de entrada e/ou saída, eles serão exibidos na seção Argumentos de Runtime, nas abas Entrada e Saída. Os valores dos argumentos são herdados do pacote, mas você pode editá-los conforme necessário. Para alternar entre os argumentos e uma exibição do esquema JSON subjacente, selecione esquema JSON.
    
    
    
    

Criação de um gatilho de API para um processo com agente

1. Em uma pasta, navegue até Automações > Gatilhos > Gatilhos de API.
2. Clique em Adicionar um novo gatilho. A janela Criar um novo gatilho de API é exibida.
3. No menu suspenso Nome do processo, selecione um processo subjacente para seu gatilho.
4. No campo Nome, adicione um nome para que o gatilho o identifique facilmente.
5. No menu suspenso Verbo, selecione a opção que descreve a ação que você deseja que seu trabalho realize: DELETE, GET, POST e PUT.
6. No campo Campo de dados dinâmico, digite um campo de dados dinâmico que será anexado ao URL base, gerando, assim o URL final para o ponto de extremidade resultante que você usará em seu aplicativo. Você pode ver uma visualização do URL completo nesse campo.
   O campo de dados dinâmico padrão é ${Process_Name}, mas você pode personalizá-lo para garantir a exclusividade dele no nível do tenant.

   Observe que ele não é compatível com barras.

7. No menu suspenso Modo de chamada padrão, selecione o modo de chamada desejado. As opções disponíveis são:

   • Pesquisa assíncrona (esse é o padrão, mas pode ser alterado)

   • Disparo assíncrono&esquecer

   • Sincronização (sondagem longa)

   Saiba mais sobre essas opções em Início de um trabalho por meio de um gatilho de API.

8. Ative a alternância Agendar o fim da execução de trabalho para selecionar uma estratégia de encerramento do trabalho.
   Observação:

   • O quantidade de tempo especificado aqui transcorre de acordo com as especificações, mesmo se o trabalho estiver enfileirado. Por exemplo, se você agendar um trabalho para executar às 13h e o definir para parar após 20 minutos, o trabalho será interrompido às 13h20, mesmo que tenha permanecido em uma fila até as 13h15 e, depois, iniciado.
   • As opções de Agendar o fim da execução de trabalho de um gatilho são preservadas para trabalhos iniciados manualmente.

   Por exemplo, digamos que você tenha criado um gatilho T1 e ativado os seguintes agendamentos de fim de trabalho:

   • Agendar o fim da execução do trabalho: interrompe o trabalho após 10 minutos

   • Agendar "encerramento" automático, se o trabalho não parar: encerra o trabalho após 2 minutos

     Na página Automações > Gatilhos, ao clicar em Iniciar um trabalho agora para o gatilho T1, a página Iniciar trabalho será aberta com os agendamentos de fim de trabalho já aplicados, os mesmos configurados na criação do gatilho.

   Além disso, se você agendar para interromper um trabalho Pendente ou Em Execução após 2 horas e também configurar para encerrar o mesmo trabalho após 3 horas, o trabalho será encerrado após 5 horas. Isso acontece porque, primeiro, é enviado ao Orchestrator o sinal de que o trabalho foi interrompido após 2 horas. Depois que o sinal é recebido, a ação de encerramento do trabalho é disparada para ocorrer em 3 horas, resultando em um total de 5 horas.

   • Selecione Parar no menu suspenso - tenta encerrar com graça a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado Pendente ou Em Execução (defina o tempo como no mínimo 1 minuto, máximo de 10 dias, 23 horas e 59 minutos);

     Exemplo: o Orchestrator tentará interromper trabalhos que ficaram travados por pelo menos 10 minutos em Pendente ou Em Execução.

   • Selecione Encerrar no menu suspenso - tenta encerrar com força a execução depois que o intervalo de tempo definido tiver transcorrido após o trabalho ficar travado em um estado estado Pendente ou Em Execução (defina o tempo como no mínimo 1 minuto, máximo de 10 dias, 23 horas e 59 minutos);

     Exemplo: o Orchestrator tentará encerrar trabalhos que ficaram travados por pelo menos 10 minutos em Pendente ou Em Execução.

   • Selecione Interromper no menu suspenso e habilite a opção Agendar encerramento automático, se o trabalho não parar - tenta encerrar de forma suave a execução após o intervalo de tempo definido ter passado desde que o trabalho ficou preso em um estado Pendente ou Em Execução e, em seguida, tenta encerrá-la à força após o intervalo de tempo definido ter passado desde que o trabalho ficou preso em um estado Parando (defina o tempo como um mínimo de 1 minuto, máximo de 10 dias, 23 horas e 59 minutos).

     Exemplo: o Orchestrator tentará interromper trabalhos que ficaram parados em Pendentes ou Em Execução por pelo menos 10 minutos. Se o término não ocorrer, o Orchestrator tentará encerrar os jobs que estiveram no status Parando por pelo menos 20 minutos.

9. Ative a alternância Gerar um alerta se o trabalho for iniciado e não tiver sido concluído e defina a duração aceitável para o trabalho ser concluído. A duração configurável é de no mínimo um minuto e no máximo onze dias. Se o trabalho exceder a duração configurada, um pop-up de alerta de gravidade de "Erro" informa a você sobre isso com o seguinte texto: "O trabalho para processo no. {process_number} está pendente foi executado por mais de X horas e Y minutos.", onde:
   • {process_number} - o identificador do processo;
   • X — o número de horas configuradas que o trabalho excedeu ao tentar ser concluído; dias são convertidos em horas.
   • Y - o número configurado de minutos que o trabalho excedeu enquanto tentava ser concluído.
10. Na aba Destino de execução, use o menu suspenso Conta para selecionar Qualquer conta de Osuário/Robô, que aloca a conta dinamicamente, ou selecione uma conta específica na lista.
11. Se o pacote tiver argumentos de entrada e/ou saída, eles serão exibidos na seção Argumentos de Runtime, nas abas Entrada e Saída. Os valores dos argumentos são herdados do pacote, mas você pode editá-los conforme necessário. Para alternar entre os argumentos e uma exibição do esquema JSON subjacente, selecione esquema JSON.
    
    
    
    

Ações para gatilhos de API

A página Gatilhos de API permite que você execute várias ações no menu contextual de cada gatilho:

Copiar URL do campo de dados dinâmico completo

Copie o URL a ser usado no aplicativo de terceiros.

Para um gatilho de API com o campo de dados dinâmico hw-process, seria parecido com isso: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process

Editar

Altere as propriedades do gatilho de API selecionado.

Copiar campo de dados dinâmico

Copie o campo de dados dinâmico no formato apropriado para uso na linha de comando ou no código existente. As opções disponíveis são:

Copy as curl (bash) - para um gatilho de API com o campo de dados dinâmico hw-process, seria parecido com isso:

curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process'  -X 'POST'  -H 'Content-Type: application/json'  -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'

Copy as curl (cmd) - para um gatilho de API com o campo de dados dinâmico hw-process, seria parecido com isso:

curl "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"

Copy as fetch - para um gatilho de API com o campo de dados dinâmico hw-process, seria parecido com isso:

fetch("https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })

Copy as PowerShell - para um gatilho de API com o campo de dados dinâmico hw-process, seria parecido com isso:

$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"

Habilitar

Habilite um gatilho de API anteriormente desabilitado.

Desabilitar

Desabilite um gatilho de API já habilitado.

Remover

Remova o gatilho de API selecionado. Excluir um gatilho de API é equivalente a excluir o ponto de extremidade resultante. Esses são os comportamentos que você pode esperar, dependendo de seu cenário específico:

Trabalhos já iniciados

Se um trabalho baseado em um processo associado a um gatilho de API excluído já tiver sido iniciado no momento da exclusão, ele será realizado até a conclusão.

Início de novos trabalhos

Como o URL não estará mais disponível, tentar iniciar um trabalho com base em um processo associado a um gatilho de API excluído resultará em um erro 404.

Edição de processos

Se você editar um processo usado por pelo menos um gatilho de API, o gatilho será atualizado, e o novo conjunto de propriedades do processo será aplicado.

Compartilhamento de recursos de origem cruzada

Você pode adicionar domínios à lista de permissões para o tráfego de entrada usando a opção Lista de permissões do CORS para gatilhos de API na guia Geral das configurações de seus tenants.

Isso é necessário para aplicativos de navegador que farão solicitações HTTP ao Orchestrator a partir de seu navegador (ou seja, não de um servidor). Falhar na lista de permissões de domínios pode levar a um erro de política do CORS, que você pode ver em seu console do desenvolvedor.

Se você quiser incluir mais domínios em sua lista de permissões, use uma vírgula ou pressione Enter para separá-los.

Definição da API

Essa página exibe uma definição do Swagger dos gatilhos de API que você criou, agrupados por pasta, juntamente com sua saída. Além disso, permite que você execute os trabalhos pertencentes a esses gatilhos.

Pode ser acessado clicando no botão Definição de API na página Gatilhos de API ou por meio de https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/swagger/index.html.

A definição de API para um tenant com gatilhos de API em um espaço de trabalho pessoal e a pasta Compartilhada seriam parecidos com isso: