Diretrizes De Criação De Aplicativos

Versão:
2022.3
Last modified: August 15, 2022

Um aplicativo analítico Alteryx é um programa independente que executa uma função específica para o usuário. A interface deve ser simples e o aplicativo deve ser projetado com um único objetivo em mente. O aplicativo deve executar uma gama limitada de tarefas, com foco em uma experiência de usuário ideal. Considerando que os usuários estão executando os aplicativos que você está criando em um navegador da Web, o design de back-end precisa ser inteligente, elegante e eficiente.

Conjunto de dados Vintage mais recente

Ao criar uma aplicação que utilize um conjunto de dados específico, o conjunto de dados selecionado deve ser definido para utilizar a versão Vintage mais recente do conjunto de dados. Isso significa que o Designer usa automaticamente a versão mais recente do conjunto de dados instalado no computador do usuário. Isso se aplica a ferramentas de Análise demográfica (Allocate), Ferramentas de Análise de comportamento (Solocast), Ferramentas de Calgary, Drivetimes, geocodificador ou para o Mapa Base de Referência na ferramenta de mapeamento. Para definir o conjunto de dados, vá paraOpções>Configurações do usuário>Editar Configurações do usuário>padrões do conjunto de dados.

Editor de metainformações

As informações preenchidas naguia Meta Info dajanela Configuração do fluxo de trabalho são exibidas nos detalhes do aplicativo na Web.

  • UseNome do arquivopara apresentar o nome do arquivo. Como alternativa, selecionePersonalizado: para dar ‘ao aplicativo um nome "amigável". Por exemplo, o próprio arquivo do aplicativo pode ser chamado de Download_Weather_Data e, em seguida, o nome personalizado seria o mesmo, mas sem os sublinhados, Download Weather Data.
  • Descrição: a descrição inserida aqui será a descrição exibida na Web para o aplicativo, portanto, certifique-se de que ela seja uma descrição precisa e de fácil utilização.
  • URL: o campo URL fornece a capacidade de incluir um link para um site externo.
  • Autor: forneça os detalhes do criador do aplicativo analítico, incluindo Nome, Vintage (YYYY.Qtr), Empresa e Copyright.

Extensão .yxwz

Ao criar um aplicativo, certifique-se de ter salvo o arquivo como um arquivo .yxwz, mesmo que você tenha alterado o tipo de fluxo de trabalho para aplicativo analítico Se a extensão do arquivo for deixada como .yxmd, ela será aberta como um fluxo de trabalho e não como um aplicativo

Os aplicativos criados na versão 9.0 não podem mais ser salvos como arquivos .yxmd.

Entrada de mapa

Aferramenta de entrada de mapadá ao consumidor do aplicativo a capacidade de selecionar um local ou desenhar um polígono ou linha usando o recurso de entrada de mapa. As perguntas do mapa devem ser curtas, mas descritivas e um mapa base deve sempre ser usado. Ao escolher um mapa base, certifique-se de selecionarVintage mais recente.

Por fim, seo modo de desenho estiver selecionado, certifique-se de quea configuração recursos de rótulo de CAN do usuário esteja sempre marcada. Isso dá ao usuário a opção de adicionar um nome a cada um de seus polígonos personalizados.

Saída de relatório

Quando você salva um aplicativo na Gallery, se a saída do relatório for renderizada como PCXML, o aplicativo fornece a opção para que os usuários finais não apenas visualizem o relatório na Web, mas também façam o download do relatório em qualquer um de nossos formatos de relatório suportados. Os formatos de relatório suportados incluem PDF, Microsoft Word, Microsoft Excel e HTML.  

Ao criar um aplicativo, a saída pode ser qualquer um de nossos formatos de relatório suportados. Para utilizar o PCXML, definao Modo de saídanaferramenta Renderizarparaescolher um arquivo de saída específicoe parao arquivo de saída, useAPP_NAME.pcxml.

Ao visualizar um relatório no PCXML, você não verá rodapés, mas eles estarão disponíveis quando baixados como um documento PDF, Word ou Excel.

Arquivos de leitura/gravação: Macros em um aplicativo

Para aplicativos da Web, você só poderá ler e gravar em arquivos que estejam dentro da mesma pasta que o seu aplicativo ou em uma pasta inferior, ou seja, qualquer pasta que esteja dentro da pasta que contém o aplicativo. (Pode ser mais de 1 nível abaixo.) Esta regra também se aplica a Macros que você deseja usar para seu aplicativo, a menos que seja uma macro padrão que faz parte do instalador do produto Alteryx ou de um instalador de dados.

temp

Não use%temp%para gravar no diretório temporário ao criar fluxos de trabalho ou aplicativos a serem salvos na Gallery. Mantenha todos os caminhos de arquivo dentro do fluxo de trabalho. Se estiver desenvolvendo um aplicativo encadeado, use apenas o nome do arquivo em vez de qualquer caminho de arquivo, por exemplo.\fileOutput.yxdb, e não%temp%\fileOutput.yxdbou algo semelhante. Selecione um arquivo navegando até ele e altere o caminho de dependência do arquivo para um caminho relativo usando a janela dependências do fluxo de trabalho.

Ferramentas e eventos proibidos

As seguintes ferramentas e eventos do Alteryx Designer são proibidos na Galeria Pública do Alteryx (gallery.alteryx.com), também conhecida como Galeria de Analíticos, devido às inúmeras configurações possíveis e às ações que podem ser executadas:

Se o seu fluxo de trabalho usar uma das ferramentas ou eventos proibidos de maneira segura, você poderá solicitar uma isenção para executar o fluxo de trabalho na Galeria de Analíticos Alteryx. Para solicitar uma isenção...

  1. Envie um e-mailpara curator@alteryx.come explique como e por que cada ferramenta proibida é usada, juntamente com a finalidade geral do fluxo de trabalho.
  2. Publique o fluxo de trabalho no seu Private Studio e marque a opçãooutros podem baixar este fluxode trabalho .
  3. Adicione o fluxo de trabalho a uma coleção e compartilhe-o com o Curador Alteryx emcurator@alteryx.com.
  4. Aguarde até dois dias úteis para que seu fluxo de trabalho seja revisado e um Alteryx Curator envie um e-mail com o status da sua solicitação.

As Macros preditivas incluídas no Designer que usam a ferramenta R são permitidas na Galeria Pública do Alteryx.

Recursos de aplicativo não suportados para a Web

Elas não são suportadas no ambiente da Web Galeria de Analíticos.

  • Explorador de Pastas
  • Busca de arquivo (Salvar como), o upload funciona bem na Web.
  • Se um aplicativo gerar algum erro no ambiente Desktop, ele não poderá ser salvo na Gallery.

Práticas recomendadas para criação de aplicativos

Atualizar ações

Quando você usara ferramenta Açãopara Atualizar/Alterar valor, a menos que seja realmente necessário, não use a opção ‘Substituir uma string específica:'. Se você alterar a configuração da ferramenta em seu fluxo de trabalho devido ao desenvolvimento contínuo, poderá acabar quebrando essa ferramenta de ação, pois essa string específica pode não existir mais. Obviamente, haverá momentos em que você precisa usar essa opção, mas tenha em mente que, se você alterar essa string na ferramenta, talvez precise atualizar também a ferramenta de ação.

Atualizar desvios

Se você usar uma ferramenta Ação para atualizar umaferramenta Desvio, tente ser concluído e atualize o desvio para ambas as possibilidades, ou seja, desviar para a esquerda e desviar para a direita. Caso contrário, se você apenas atualizar para uma condição e alterar o fluxo de trabalho durante o desenvolvimento, não terá levado em conta quando você precisa que o fluxo de trabalho vá do outro lado.

Desvios finais

Todos os desvios devem terminar, especialmente antes de juntar qualquer fluxo de dados de um desvio para qualquer outro lugar no fluxo de trabalho. Umaferramenta de fim de Desvionão requer configuração, portanto é fácil de usar. Certifique-se de usá-los ou encerrar o desvio com uma ferramenta de saída.

Use a Ferramenta de mensagem de Erro

Ao escrever perguntas, considere seu usuário antecipando erros comuns. Você deve emitir mensagens de erro usando umaferramenta mensagem de erro. Por exemplo, se o usuário tiver que selecionar uma opção e, em seguida, exibir um erro quando não selecionar nada, isso pode evitar erros de lançamento do mecanismo que podem não ser significativos o suficiente para o usuário entender como corrigir um erro. O ideal é ter um erro de projeção para cada pergunta que o usuário precisa preencher. Você também pode fazer condições mais complexas para garantir que elas tenham preenchido as coisas corretamente. Por exemplo, se eles precisarem preencher uma caixa de texto com até 5 áreas de troca separadas por vírgulas (por exemplo, 1, 2, 3, 4, 5), você poderá usar uma condição regex para garantir que não haja mais de 4 vírgulas na caixa de texto.

Emita erros com a ferramenta mensagem

Ao longo dessas mesmas linhas, tente antecipar os casos em que o aplicativo pode falhar mesmo quando configurado corretamente. Por exemplo, o usuário pode inserir um endereço que não consegue geocodificar e não produz resultados. Você pode lidar facilmente com mensagens em seu aplicativo filtrando geocódigos incorretos e, em seguida, usar aferramenta mensagempara retornar uma mensagem ao usuário: "O endereço que você forneceu não geocodifica. Verifique se o endereço é válido e faça as alterações apropriadas nele ou insira um endereço diferente e execute novamente."

Atualizar XML bruto, metacaracteres de escape HTML

Se você estiver atualizando o XML bruto para uma ferramenta ou usando caracteres especiais em seus aplicativos, lembre-se de que na Web isso pode não funcionar como previsto. Por exemplo, umaferramenta suspensaouuma seleção de ferramenta caixa de listagem no mecanismo pode conter texto como:Age By Sex Summary Report:<Report Type=”summary”>Age By Sex Summary Report</Report>

Mas quando isto é usado na correia fotorreceptora não mostrará realmente a pergunta corretamente e portanto quando este se começ usado em uma ação provavelmente não terá o efeito desejado. Uma solução é alterar o texto a ser:Age By Sex Summary Report:&lt;Report Type=&quot;summary&quot;&gt;Age By Sex Summary Report&lt;/Report&gt;

Em seguida, se você estiver usando a resposta da pergunta em um ação que você precisará atualizar para ser:EscapeXMLMetacharacters([AllocateSummaryReport])

A função Escape XML Metacaracters foi adicionada à Biblioteca de Fórmulas na versão 8.0. Você pode acessá-lo na categoria especializada. Essa função substituirá todos os metacaracteres XML por suas versões de escape.

Alocar árvores variáveis

A Web e o mecanismo retornam valores diferentes quando uma árvore de variáveis Allocate é deixada em branco. Se o aplicativo tiver uma árvore de variáveis Allocate como um tipo de pergunta, você pode querer escrever uma condição que verifique se o usuário selecionou algo ou deixou esse campo vazio. Para o mecanismo, você poderia escrever algo como:

[AllocateVariables] == "<Variables />"

Quando a árvore de variáveis não tem nada selecionado <Variables /> , é retornado. No entanto, na web, o valor retornado é realmente nada, então você precisaria que a condição fosse:

isempty([AllocateVariables])

Obviamente, queremos que os aplicativos funcionem na Web e na área de trabalho, portanto, a condição precisa ser:

[AllocateVariables] == "<Variables />" or isempty([AllocateVariables])

Se também estivermos preocupados com o uso dos<>caracteres , , e / na web, então poderíamos mudar a condição para ser:

REGEX_CountMatches([AllocateVariables], "Variables") == 1 or isempty([AllocateVariables])

Ferramenta União

É melhor manter umaferramenta de União configurada manualmentefora de qualquer aplicativo porque, na maioria dos casos, o fluxo de trabalho muda no tempo de execução. Em vez de configurar a ferramenta União no modo manual, insira Selecionar ferramentas em cada conexão alimentada na ferramenta União. Ao configurar a ferramenta Selecionar, renomeie e reorganize os campos conforme necessário, tomando o cuidado adequado de não incluir campos dinâmicos/desconhecidos. Configure a ferramenta União usando Config. Automática por nome ou Config. Automática por posição.

Contêineres de ferramentas e organização de aplicativos

A organização do aplicativo é feita em parte usando diferentes contêineres de ferramentas para diferentes seções do aplicativo. Por exemplo, todas as ferramentas de relatório são normalmente a última seção de um aplicativo e podem ser colocadas em um contêiner de ferramentas rotulado "Reporting".

 Umaferramenta contêiner de ferramentaspode ser codificada por cores com base na função que está destacando. Os contêineres de ferramentas de codificação por cores facilitam a compreensão do que um aplicativo está fazendo, especialmente quando visto em um pequeno zoom. Isso é útil ao solucionar problemas ou depurar um aplicativo criado por outra pessoa.

As ferramentas de interface devem ser colocadas em seus próprios contêineres e codificadas por cores como tal. Para aplicativos com várias guias, é útil colocar as ferramentas que compõem cada guia em seu próprio contêiner.

Anotações para fluxos de trabalho e aplicativos

Anotações são caixas de texto que são anexadas a uma ferramenta específica e podem ser muito úteis para descrever a função de ferramentas individuais. Um dos principais benefícios é se você mover a ferramenta, a anotação se move com ela.  EmConfiguração do fluxode trabalho , definaAnotaçõespara mostrar. 

Se necessário, você também pode definir anotações individuais a serem colocadas na parte superior ou inferior de uma ferramenta.  Para alterara Anotação, clique na ferramenta, selecionea guia Anotação e marque ou desmarquecolocar anotação no topo.

Diretrizes específicas da macro

Todas as diretrizes anteriores se aplicam a Macros e aplicativos, com as exceções a seguir que se aplicam apenas a Macros.

Entrada de Macro

Umaferramenta Entrada de Macrodeve incluir dados. A inclusão de dados torna muito mais fácil solucionar problemas ou depurar se algo der errado. Há uma entrada de texto incorporada na ferramenta Entrada de macro. Este é o método preferido para entradas de macro.  Se você precisar de um arquivo maior para servir como entrada de dados, ele deverá ser incluído com a macro sempre que possível. As dependências de arquivo de dados para uma macro devem ser nomeadas de acordo com o padrão:

NameOfMacro.NameOfDataFile.yxdb

Os nomes de entrada e saída não devem ter um número de ferramenta associado a eles. Na guia Propriedades de entrada de macro, certifique-se de que o nome seja suficientemente descritivo. O Nome especificado aqui ficará visível para o usuário quando ele configurar a ferramenta Macro.

Quando houver várias entradas e saídas, a adição deuma abreviação do conectorajudará o usuário a configurar a ferramenta fornecendo uma etiqueta na âncora da ferramenta quando a ferramenta for colocada na tela. ConsulteFerramenta Entrada de MacroouFerramenta saída de Macro.

Nomear guias

Os nomes das guias devem ser descritivos para facilitar o uso enquanto o usuário estiver configurando a ferramenta de macro. As guias ficarão visíveis para o usuário no momento da configuração. O nome de separador predefinido é ‘"Perguntas" – não é um nome muito descritivo e isto é normalmente uma supervisão ao desenvolver uma macro (ou aplicação) com um único separador. Janela do Interface Designer

Macros de suporte

As Macros de suporte usadas em um fluxo de trabalho pai devem estar presentes com a macro pai ou em um diretório de suporte e. nomeado como tal:NameOfParent.NameOfSupporting.yxmc

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.