Método AlteryxEngine

A classe AlteryxEngine é uma classe de referência para estender os membros da classe de um objeto AlteryxEngine instanciado dentro do processo Alteryx em execução.

Informações do motor

Tipos de status AlteryxEngine

Ordem alfabética
Tipo de status	Definição
browse_everywhere_file_name	O FileName do arquivo. yxbe temporário que contém os dados procurar em todos os lugares para esta execução.
cache_temp_file	Um arquivo temporário para armazenar em cache dados entre execuções.
choose_from_multiple	Indicando que a mensagem será uma lista delimitada ' \n ' de opções que o aplicativo de chamada deve fazer uma seleção de. O manipulador de retorno de chamada deve retornar um dos seguintes valores para indicar a escolha que é feita. Os valores válidos são:-1 para cancelar,-2 para 1 a todos,-3 para nenhum a todos, 0 para nenhum e 1... N para um valor específico da lista de opções.
Completa	A ferramenta concluiu seu processamento.
data_profiling	Nome de arquivo de perfil de dados.
Desativado	Indica que todas as ferramentas de saída foram desabilitadas.
document_temp_file	A mensagem será o caminho do arquivo temporário.
Erro	Indica que ocorreu um erro. A mensagem será a mensagem de erro.
field_conversion_error	Indica que ocorreu um erro de conversão de campo. A mensagem será a mensagem de erro.
field_conversion_limit_reached	Indica que o limite de erro de conversão de campo foi atingido.
file_dependency	Os arquivos dependentes associados a um arquivo composto:-Status_File_Output, tem o arquivo principal para vincular. Isso tem o arquivo principal (totalmente pathed), totalmente pathed arquivo dependente, totalmente pathed arquivo dependente e muito mais.
file_input	O arquivo de entrada desta ferramenta.
file_output	file_output: o arquivo de saída desta ferramenta.
Informação	Informações que estão sendo passadas para o aplicativo de chamada.
low_disc_warning	O aplicativo de chamada está dizendo que o espaço em disco livre está em execução baixa e pausar o fluxo de trabalho até que a ação é tomada.
output_field_names	Os nomes de campo para esta ferramenta de saída SRCT em uma seqüência delimitada por aspas vírgulas.
output_record	O registro de dados para essa ferramenta de saída SRCT em uma cadeia de caracteres delimitada por aspas.
preview_fail	No modo de visualização, envie PREVIEW_FAIL se não for suportado.
record_count_string	Indicando o número e o tamanho dos registros de saída pela ferramenta até o momento. A cadeia de caracteres será no formato: "OutputName | RecordCount\nTotalSize. "
request_auto_config_refres	Isto fará com que as configurações refresquem no GUI sem a interação do usuário. Isso é feito quando a ferramenta já está em um estado de erro, mas (talvez) a GUI pode corrigi-lo sem interação do usuário.
restricted_data_set_error	Esta mensagem não tem nenhum texto-serve para notificar o chamador que há pelo menos 1 erro deste tipo. Ele será seguido por um STATUS_Error.
safe_mode_error	O texto da mensagem será "Never" para falhas que ocorrem no modo seguro e SemiSafe e "SemiSafeOnly" para erros que podem ser evitados executando em SemiSafeMode. Isso será seguido por um STATUS_Error.
temp_directory	O diretório de %Temp%.
update_output_config_xml	A mensagem será o XML que é a configuração para esta ferramenta.
aviso	Foi relatado um aviso. A mensagem será a mensagem de aviso.

Valores somente leitura

field_conversion_error_limit: as mensagens de erro de conversão de número máximo para exibir. Esse valor limite afeta apenas o número de mensagens de erro de conversão de campo que são exibidas.

Métodos

create_connect_metadata

Converte o dicionário de metadados em XML gravado no log do Connect.

create_connect_metadata (int)nToolID, (dict)metadados) -> vazio :

O dicionário de metadados pode conter qualquer uma das seguintes chaves:

1. Database: uma coleção de dados organizada eletronicamente.
2. DatabaseVersion: um número carimbado na página de inicialização de um banco de dados que indica a versão do SQL Server da instância mais recente do SQL Server.
3. DriverType: para conexões de banco de dados suportadas, consulte Sfontes de dados nas.
4. DriverVersion: a versão do driver usado para se conectar a uma fonte de dados, como um banco de dados.
5. Host: uma rede onde um computador está conectado a uma rede de computadores.
6. PluginName: um arquivo de ponto de entrada.
7. Porta: uma parte de um dispositivo de computador (hardware) que está disponível para conexão com outros dispositivos, ou seja, dispositivos de entrada e saída.
8. Consulta: uma solicitação para recuperar informações de um sistema de computador que é processado por um programa de software em vez de uma pessoa.
9. Esquema: um contorno ou modelo.
10. Tabela: uma coleção de dados organizados em colunas, linhas e células.

create_temp_file_name

Retorna um caminho de arquivo temporário exclusivo recém-criado do Engine; o mecanismo limpa o arquivo mais tarde.

create_temp_file_name(str)extension='tmp', (int)options=0) -> str :

As opções suportadas incluem:

• 0: um arquivo temp normal.
• 1: um arquivo temp para um elemento GUI, como um Browse, que a GUI é responsável pela limpeza.

• 2: um arquivo temp para um elemento GUI, como uma navegação que a GUI é responsável pela limpeza. Além disso, o nome do arquivo não é feito para ser exclusivo. Use quando o argumento de extensão já contiver uma ID exclusiva.

decrypt_password

Retorna uma cadeia de caracteres de texto criptografado ou descriptografado e funciona com criptografia de usuário e computador.

decrypt_password (encrypted_password, modo) -> str :

encrypted_password: o texto a ser tratado.

As opções suportadas incluem:

0: descriptografar: para tornar a mensagem inteligível.

2: criptografia de máquina: o processo de codificação de uma mensagem de tal forma que apenas as partes autorizadas podem acessar as informações. A criptografia é baseada na máquina e não pode ser descriptografada em uma máquina diferente (a galeria é um bom exemplo disso).

3: criptografia do usuário: a criptografia é baseada no usuário, e não será descriptografável em outra máquina onde você está logado como um usuário diferente (a galeria é um bom exemplo disso).

get_constant

Retorna a lista ordenada finita [Str nome, Str alt_name, Str valor, bool is_numeric] onde alt_name é baseado no nome da conexão.

get_constant(int)tool_id, (int)que) -> objeto :

Retorna None se o argumento que é inválido.

get_init_var

Retorna o valor de um init_var global do Engine.

get_init_var(int)tool_id, (str)var_name) -> str :

As variáveis válidas incluem:

• Actionaplica: retorna "true" ou "false" se houver uma ação do assistente referente a essa ferramenta.
• Allowdesktopinteraction: retorna "true" ou "false".
• DefaultDir: retorna o diretório que deve ser usado para caminhos relativos.
• Enableperformanceprofiling: retorna "true" ou "false".
• Numthreads: define o número de threads a serem executados em um único grupo de threads quando um sombreador de computação é despachado. 
• Outputrecordcounts: retorna "true" para contagens de registro de saída, false para não.
• Runmode: retorna "seguro", "SemiSafe" ou "padrão". Usado para Web "Safe-ness".
• Runningaswizard: retorna "true" ou "false".
• RuntimeDataPath: Retorna o caminho completo da pasta RuntimeData a partir de uma instalação alteryx.
• SerialNumber: retorna o número de série do alteryx.
• ConfiguraçõesPath: Retorna o caminho completo da pasta Configurações a partir de uma instalação Alteryx. 
• Temppat: retorna um caminho para um arquivo temporário. Use create_temp_file_name para funcionalidade semelhante que exclui automaticamente o arquivo temp quando o alteryx fecha.
• Updatemod: retorna "", "Quick" ou "Full".
  • Exemplo: quando você bateu em executar em um fluxo de trabalho, UpdateOnly é false, e UpdateMode está em branco. Quando você acerta F5 ou abre um fluxo de trabalho, uma atualização completa é executada (UpdateOnly é true e o modo de atualização é "completo"). Se você soltar uma ferramenta abaixo de outra ferramenta, ela enviará uma atualização rápida para a ferramenta upstream para que ele possa obter metadados (UpdateOnly é true, e UpdateMode é "Quick"). Isso é como uma ferramenta de seleção Obtém todos os nomes de campo e tipos quando você soltá-lo após outra ferramenta.
• UpdateOnly: retorna "true" ou "false". Em branco quando UpdateOnly é false e pode ser rápido ou completo quando UpdateOnly é true.
• Version: retorna a versão do Alteryx Engine na forma de "2.1.0.3".

output_message

Notifica o AlteryxEngine de todas as mensagens geradas por uma ferramenta. Defina tool_id como-1 para um erro global não relacionado a uma ferramenta.

output_message(int)tool_id, (int)status, (str)mensagem) -> int :

Retorna 1 se o plug-in deve interromper o processamento, caso contrário retorna 0.

status: um valor de Alteryxpythonsdk. status.

debug_message_out

Exibe mensagens na grade de resultados ou janela do console se a constante de usuáriode fluxo de trabalhoenabledebugmessages é definida como true. 

debug_message_out(int)tool_id, (int)status, (str)mensagem) -> int :

Retorna 1 se o plug-in deve interromper o processamento, caso contrário retorna 0.

status: um valor de AlteryxPythonSDK. status.

output_tool_progress

Notifica o AlteryxEngine de progresso de uma ferramenta.

output_tool_progress(int)tool_id, (flutuar)percent_progress) -> int :

Retorna 1 se o plug-in deve interromper o processamento. Caso contrário, retornará 0.

• tool_id: a ID da ferramenta que chama a função.
• percent_progress: a conclusão percentual para a ferramenta. A porcentagem deve estar no intervalo [0.0, 1.0].

Solicitações de atualização de andamento

Um plugin é perguntado por ferramentas upstream ou o motor para atualizar seu progresso através do método ii_update_progress. É responsabilidade do plug-in solicitar que quaisquer ferramentas downstream também atualizem seu progresso chamando update_progress em OutputAnchor.

pre_sort

Pré-classifica uma conexão de dados de entrada. pre_sort só pode ser chamado durante pi_add_incoming_connection.

pre_sort(str)incoming_connection_type, (str)incoming_connection_name, (str)sort_info) -> Nenhum :

• incoming_connection_type: o tipo da conexão.
• incoming_connection_name: o nome da conexão.
• sort_info: o texto XML que define os campos para classificar e, opcionalmente, filtrar os dados de entrada.

Escreva a cadeia XML no seguinte formato:

... ...

Se a seção Fieldfilterlist não for especificada, todos os campos serão passados.