Criação de um gatilho

Você pode criar um gatilho como parte de um conector personalizado. Você pode usar gatilhos de conectores personalizados para iniciar automaticamente automações ou processos com base em eventos do provedor.

Como funciona

Os gatilhos do Connector Builder usam a pesquisa de recursos para detectar alterações do provedor. A pesquisa de recursos envolve chamar um recurso da API em um intervalo regular para detectar quando novos eventos são retornados.

Assim que um conector personalizado for publicado e o gatilho for usado em uma automação publicada, a URL definida é usada como recurso de pesquisa para pull back eventos e iniciar um fluxo de automação.

Detectando novos eventos

O URL de pesquisa do disparador deve incluir parâmetros de consulta para filtrar os resultados do provedor.

A pesquisa ocorre em um intervalo agendado (a cada 5, 10, 15 minutos, etc.). Portanto, um dos parâmetros de consulta do provedor deve ser uma data para filtrar resultados. Dessa forma, o mecanismo de pesquisa pode preencher o valor do parâmetro de consulta para incluir apenas eventos que ocorreram após a última pesquisa.

Limitações

• Você pode criar um gatilho por recurso. Se mais de um caso de uso for necessário, use uma URL de pesquisa mais geral e configure campos de filtro de resposta que possam atender a vários casos de uso.
• As APIs do provedor devem permitir a filtragem de parâmetros de consulta baseada em data. Se nenhum parâmetro de consulta baseado em data estiver disponível no provedor, ele não deve ser usado como um gatilho.

Pré-requisitos

Requisitos do provedor

A API do provedor deve oferecer um recurso com um endpoint GET que retorna uma lista de objetos. Além disso, o ponto de extremidade deve permitir que você consulte o recurso com base em um parâmetro de data.

Exemplo de um recurso válido

O Pipedrive oferece um endpoint Obter todas as atividades , que retorna uma coleção de atividades. Esse ponto de extremidade inclui um parâmetro de consulta since que filtra os resultados por todas as atividades com uma data update_time posterior à data since fornecida como um valor para o parâmetro de consulta. Você pode usar o parâmetro since como parte da URL de pesquisa para detectar quaisquer atualizações nas atividades do Pipedrive. O mecanismo de pesquisa da UiPath preenche automaticamente esse campo de data para capturar eventos.

Requisitos do conector

Os gatilhos do Construtor de Conector usam recursos que já estão disponíveis no conector como o URL de pesquisa. Ao criar um novo gatilho, deve haver um recurso no lado do conector para que o gatilho seja associado.

Os gatilhos usam a configuração do recurso, portanto, é importante que o recurso existente já tenha:

• Parâmetros de consulta: os gatilhos podem importar parâmetros de consulta existentes, portanto, o recurso já deve ter alguns parâmetros configurados antes de criar o gatilho.
• Campos de resposta: os gatilhos geram o objeto de resposta do recurso associado, além de permitir a configuração de atividades com base nesses campos. É necessário gerar os campos de resposta para o recurso chamando com sucesso o endpoint.

Criação de um gatilho personalizado

Para criar um gatilho no Construtor de Conector, siga as seguintes etapas:

Adicionar um gatilho

1. Primeiro, certifique-se de atender aos pré-requisitos.
2. No Integration Service, abra o Construtor de Conector e, depois, selecione seu conector personalizado.
3. Selecione o menu Mais opções menu ao lado de Gatilhos.
4. Selecione Adicionar gatilho.

Defina o nome e o recurso

A janela pop-up Criar evento será exibida. Aqui você pode selecionar o tipo de evento a ser criado. Atualmente, Pesquisa é a única opção disponível.

1. Selecione o tipo de evento.
2. Adicione um nome para seu gatilho.
3. Selecione o recurso usado para detectar esses eventos.
4. Selecione Criar para iniciar o processo de configuração do seu gatilho.

Configure o gatilho

O processo de criação de um gatilho consiste em três etapas:

1. Configure a solicitação.
2. Configure a resposta.
3. Configure filtros de gatilho.

Estas etapas correspondem ao processo de pesquisar um URL de recurso e trabalhar com a resposta.

Dica:

Use a funcionalidade Testar gatilho em todo o processo de configuração do gatilho para garantir que ele esteja funcionando conforme o esperado.

Configurar solicitação

Primeiro, você configura como a URL de pesquisa é configurada e como o gatilho é exibido no Studio quando usado em uma automação.

O layout de visualização representa como o gatilho é exibido no Studio. Você pode configurar os parâmetros e os campos de resposta para alterar quais campos vê e usa no Studio ao configurar o gatilho para uma automação.

URL de Pesquisa

O URL da pesquisa é exibido na parte superior da página de configuração. Essa é a URL usada para fazer solicitações ao provedor para detectar novos eventos.

A URL deve ser configurada de maneira que filtre eventos de interesse. A URL de pesquisa usa um parâmetro de data para filtrar novos eventos desde a última solicitação de pesquisa. É obrigatório incluir um parâmetro de data que o mecanismo de pesquisa possa preencher.

Importar parâmetros

Os gatilhos podem importar parâmetros de recursos para usar na URL de pesquisa.

Se um parâmetro não estiver disponível no recurso, navegue até o recurso e adicione-o, em seguida, retorne à janela de configuração do gatilho para importá-lo.

1. Selecione Importar parâmetros para visualizar a lista de parâmetros disponíveis para um recurso específico.
2. Selecione o parâmetro que você deseja usar no URL de pesquisa.
3. Assim que um parâmetro é adicionado, ele é incluído na visualização da URL na parte superior da página.

Você pode marcar parâmetros importados como Obrigatório, para que apareçam na tela do gatilho. Isso significa que é necessário inserir um valor para o parâmetro de consulta ao usar o gatilho em uma automação.

Importante:

Pelo menos um parâmetro de consulta baseada em data é necessário para o URL de pesquisa. Um parâmetro de consulta baseado em data é qualquer parâmetro com um formato DateTime . Os formatos DateTime podem ser encontrados para um parâmetro com um tipo de dados de provedor String ou Integer .

A menos que um valor de data específico seja especificado, os parâmetros de consulta baseados em data são preenchidos automaticamente com um valor igual ao da data e hora da solicitação de pesquisa anterior.

Testar gatilho

Use a opção Gatilho de teste para garantir que os resultados esperados estejam sendo retornados.

Quando você seleciona Gatilho de teste, a janela Tentar a solicitação é exibida, mostrando:

• Período de lookback: esse campo define qual data deve ser inserida nos parâmetros de consulta baseados em data e replica o comportamento de nosso mecanismo de pesquisa, que preenche automaticamente esse valor com base na data da última solicitação de pesquisa.
• Os parâmetros de consulta especificados conforme obrigatório.

Selecione Tentar solicitação para abrir o painel Depuração de eventos e ver o rastreamento da solicitação com um detalhamento passo a passo do processo da solicitação. O número de resultados retornados também é exibido.

Observação:

Verifique se o número de resultados retornados é o número de resultados esperados. O uso inadequado de parâmetros de consulta pode resultar em um alto nível de objetos de saída e uso desnecessário do robô depois que o conector for publicado e o gatilho for usado em um fluxo de trabalho.

É recomendável ter expectativas de resposta (número de eventos, tipos de eventos, etc.) ao testar um gatilho para verificar se os filtros do parâmetro de consulta funcionam conforme o esperado.

Configurar resposta

Nesta etapa, você especifica qual campo de resposta corresponde à Chave primária ou à saída do gatilho.

1. Use a lista suspensa em Chave primária para selecionar um campo.
2. O campo selecionado é adicionado à visualização do gatilho, em Saída. Você pode usar essa saída em etapas posteriores do seu fluxo de trabalho.

A etapa Configurar resposta também fornece uma visualização do objeto de resposta associado ao recurso de pesquisa para revisão.

Configurar filtros de gatilho

Depois de configurar a solicitação e a resposta, você pode configurar o gatilho ainda mais usando filtros.

Você configura a filtragem de eventos definindo valores específicos para campos de resposta. Esses valores são especificados durante a configuração da automação (no Studio), mas o designer do gatilho também permite que você configure quais campos são exibidos para filtragem.

Hidratação

Se o recurso usado como URL de pesquisa não retornar todo o objeto necessário para a saída do gatilho, é possível filtrar a resposta usando um ponto de extremidade GETBYID . Esse processo é conhecido como Hidratação.

Selecione a aba Hidratação , ative o botão de alternância Usar hidratação e especifique o endpoint a ser usado para hidratação e o ID usado para consultar o objeto.

Observação:

A lista de possíveis recursos de hidratação é obtida da lista Obter registros no painel de navegação do lado esquerdo. Configure o recurso GETBYID antes de usá-lo como um recurso de hidratação para um gatilho.

O uso da ativação substitui os campos de resposta dos campos de recursos de resposta à pesquisa de campos de recursos de resposta pelos campos de resposta de recursos alimentados. Em seguida, os campos de resposta de ativação se tornam os únicos campos disponíveis para parâmetros de gatilho e configuração de filtros.

Filtros

O processo de configuração de gatilho oferece três opções para exibir campos usados para filtragem. Esses campos são extraídos dos campos de resposta do recurso do recurso de pesquisa ou do recurso de hidratação. Essas opções estão disponíveis na coluna Mostrar como da tabela Parâmetros de filtro :

• Oculto: o campo fica oculto da tela e não está disponível no construtor de filtros. Se todos os campos estiverem marcados como Ocultos, o construtor de filtros também estará oculto.
• Opcional: no momento do design, o campo é exibido como uma opção no construtor de filtro.
• Obrigatório: no tempo de design, o campo é exibido diretamente na tela do gatilho e requer entrada do usuário. Apenas eventos com um valor de campo de resposta correspondente ao valor fornecido resultam em um evento de automação.

Salve o gatilho

Depois de finalizar a configuração do filtro, selecione o botão Salvar . Depois de salvo, o gatilho será incluído como um evento quando o conector for publicado.

Usando o gatilho

Após um gatilho ser salvo e não estiver mais no modo de rascunho, o gatilho estará disponível para uso assim que você publicar seu conector personalizado.