O AyxPlugin

A classe AyxPlugin é o bloco de construção básico da sua ferramenta. AlteryxEngine usa essa classe para instanciar um objeto cada vez que seu programa é executado. Essa classe contém métodos para compilar a funcionalidade da interface de plug-in, prefixo pi_e a interface de entrada, prefixado ii_.

Métodos

init

Este é o construtor padrão do Python, que é chamado cada vez que o AlteryxEngine instancia uma instância do seu plug-in.

__init__ (eu, n_tool_id, alteryx_engine, output_anchor_mgr)

Os argumentos para essa função são valores fornecidos pelo AlteryxEngine e serão usados ao se comunicar com o mecanismo ou com outras ferramentas.

• n_tool_id: um inteiro que representa um identificador exclusivo para a instância da ferramenta que está sendo criada. Seu plug-in deve salvar esse valor para se comunicar com o AlteryxEngine.
• alteryx_engine: um objeto complexo que representa a interface para comunicação com o mecanismo do Alteryx.
• output_anchor_mgr: um objeto complexo usado para fazer a interface com as conexões de saída da sua ferramenta. Você precisa chamar get_output_anchor nele com o nome de sua saída no arquivo de configuração para obter o identificador para a saída.

pi_init

Fornece a ferramenta com seus dados de configuração. Método necessário.

pi_init(eu, str_xml)

• str_xml: uma cadeia de caracteres formatada como XML que contém os dados de configuração.

Esta função é chamada quando a ferramenta é inicializada pela primeira vez e quando a configuração da ferramenta é alterada.

pi_close

Método necessário.

pi_close(eu, b_has_errors)

• b_has_errors: uma opção indica se ocorreram erros.

Use pi_close () se você precisar de limpeza de arquivo que deve ser manipulada manualmente ou para emitir um erro que não pode ser detectado antes de pi_close.

pi_add_incoming_connection 

Gerencia dados de entrada, metadados e progresso para uma ou mais conexões de entrada.

pi_add_incoming_connection (eu, str_type, str_name)

Retorna um objeto que implementa as funções de interface de entrada.

pi_add_outgoing_connection

Transmite a âncora de saída e conexões relacionadas.

pi_add_outgoing_connection(eu, str_name)

pi_push_all_records

Chamado para ferramentas que não têm entradas.

pi_push_all_records(eu, n_record_limit)

ii_init

ii_init(eu, record_info_in)

• record_info_in: a estrutura de registro de entrada.

ii_push_record

Envia registros downstream. Se sua ferramenta processa um único registro de cada vez, é melhor empurrar o registro downstream de dentro da ferramenta.

ii_push_record(eu, in_record)

Return false para indicar que não há registros adicionais são necessários.

ii_update_progress

Atualiza a ferramenta upstream do andamento do processamento de registros.

ii_update_progress(eu, d_percent)

ii_close

Fecha a conexão com a ferramenta upstream quando todos os registros foram enviados, indicados pela ferramenta upstream chamando Self. output_anchor. Close (). Feche todos os recursos abertos no ii_init.

ii_close(eu)