Visão Geral Da API AlteryxEngine

Last modified: February 28, 2022

A API do mecanismo do alteryx permite que você chame o mecanismo do alteryx. Isso fornece a capacidade de criar aplicativos que podem executar programaticamente fluxos de trabalho do Alteryx designer .

Para fazer isso, vincule seu aplicativo com a biblioteca Alteryx. lib e, em seguida, chame o mecanismo usando os métodos definidos no cabeçalho Alteryxengineapi. h . O mecanismo verifica se o Alteryx é licenciado sempre que recebe uma solicitação para executar um fluxo de trabalho.

Pré-requisitos

  • Uma cópia licenciada do Alteryx
  • Conhecimento de C++

Você pode baixar o alteryxsdk na pasta de instalação do alteryx designer : c:\Program files\alteryx\apis\alteryxsdk.zip.

Uso da API

Fluxos de trabalho e aplicativos podem ser executados uma das duas maneiras, um processo filho separado e em processo. A Convenção de chamada para os dois estilos difere somente no nome do método, portanto, é fácil alternar entre eles. O uso de um processo filho é recomendado porque isola o aplicativo de chamada de erros de tempo de execução inesperados. Há uma pequena penalidade de desempenho ao usar um processo filho quando as mensagens são empacoadas entre o mecanismo e o chamador. Os métodos da API do Alteryx Engine e as páginas de ajuda de retornos de chamada fornecem uma descrição, sintaxe, parâmetros e exemplo:

  • Métodosde API do mecanismo alteryx: uma coleção de métodos usados para interações de fluxo de trabalho. Por exemplo, você pode alterar a configuração do mecanismo antes de executar um fluxo de trabalho ou consultar a versão atualmente instalada do Alteryx.
  • Callbacksdo ALTERYX Engine API: retornos de chamada permitem que você defina uma função que o mecanismo do alteryx chamará com base em determinados eventos.
  • Consulte exemplo de API do mecanismo Alteryx para obter um exemplo de como usar métodos e retornos de chamada juntos.

Usar a lista de verificação da API do mecanismo Alteryx

 

Construa seu aplicativo

 

Vincular seu aplicativo com a biblioteca Alteryx. lib

 

Chame o mecanismo usando os métodos definidos no cabeçalho AlteryxEngineAPI. h

Esta página foi útil?

Problemas com seu produto Alteryx? Visite a Comunidade Alteryx ou entre em contato com nossa Equipe de Suporte. Não é possível enviar este formulário? Envie-nos um e-mail.