Diretrizes para criação de aplicativos

Para aplicativos da Web, você só pode ler e gravar arquivos que estejam dentro da mesma pasta que o seu aplicativo ou em uma pasta mais abaixo; em outras palavras, que estejam em qualquer pasta dentro da pasta que contém o aplicativo (pode estar mais de um nível abaixo). Essa regra também se aplica a macros que você deseja usar para o seu aplicativo, a menos que seja uma macro padrão que faça parte do instalador do produto Alteryx ou de um instalador de dados.

Quando você usa a ferramenta Ação para atualizar/alterar um valor, a menos que seja realmente necessário, não use a opção Substituir uma cadeia de caracteres específica . Se você alterar a configuração da ferramenta no seu fluxo de trabalho em fases posteriores do desenvolvimento, pode acabar danificando a ferramenta Ação, pois essa cadeia de caracteres específica pode não existir mais. Obviamente, há momentos em que você precisa usar essa opção, mas tenha em mente que se você alterar essa cadeia de caracteres na ferramenta, também poderá ser necessário atualizar a ferramenta Ação.

Se você utilizar uma ferramenta Ação para atualizar uma ferramenta Desvio , tente concluir e atualizar o desvio para ambas as possibilidades, ou seja, para a esquerda e 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 a necessidade de que o fluxo de trabalho vá para outro sentido.

Todos os desvios devem terminar, especialmente antes de vincular qualquer fluxo de dados de um desvio para qualquer outro lugar no fluxo de trabalho. Uma ferramenta Fim do Desvio não requer configuração, portanto, é fácil de usar. Certifique-se de usá-las ou finalizar o desvio com uma ferramenta Dados de Saída.

Ao escrever perguntas, considere erros comuns que o usuário pode cometer. Você deve emitir mensagens de erro usando uma ferramenta Mensagem de Erro . Por exemplo, se o usuário precisar selecionar uma opção, mas não tiver feito isso, gere um erro. Isso pode impedir que o motor gere erros que podem não ser significativos o suficiente para que o usuário entenda como corrigir o problema. O ideal é gerar um erro para cada pergunta que o usuário precisa preencher. Você também pode criar condições mais complexas para ter certeza de que o preenchimento tenha sido realizado corretamente. Por exemplo, se o usuário precisar preencher uma caixa de texto com até cinco áreas de trade separadas por vírgulas (por exemplo, "1, 2, 3, 4, 5"), você pode usar uma condição RegEx para garantir que não haja mais de quatro vírgulas na caixa de texto.

Da mesma maneira, tente prever casos em que o aplicativo pode falhar, mesmo quando configurado corretamente. Por exemplo, o usuário pode inserir um endereço que não possa ser geocodificado e não renderize resultados. Você pode lidar facilmente com o sistema de mensagens no seu aplicativo filtrando geocodificações inválidas e usando a ferramenta Mensagem para retornar uma mensagem ao usuário: "O endereço fornecido não pôde ser geocodificado. Verifique se o endereço é válido e faça as alterações apropriadas, ou insira um endereço diferente e execute novamente."

Se você estiver atualizando 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, a seleção de uma ferramenta Menu Suspenso ou ferramenta Caixa de Listagem no motor pode conter texto como: Age By Sex Summary Report:<Report Type=”summary”>Age By Sex Summary Report</Report>

Mas quando essa opção é usada na Web, a pergunta não é exibida corretamente e, portanto, quando utilizada em uma ação, provavelmente não tem o efeito desejado. Uma solução é alterar o texto para:  Age By Sex Summary Report:<Report Type="summary">Age By Sex Summary Report</Report>

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

A função "EscapeXMLMetacharacters" (escapar metacaracteres HTML) foi adicionada à biblioteca de fórmulas na versão 8.0. Você pode acessá-la na categoria de funções "Especializado". Esta função substitui todos os metacaracteres XML pelas versões de escape.

É melhor não usar uma ferramenta União configurada manualmente em nenhum 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 ferramentas Selecionar em cada conexão que alimenta a ferramenta União. Ao configurar a ferramenta Selecionar, renomeie e reordene os campos conforme necessário tomando o cuidado apropriado para não incluir campos dinâmicos/desconhecidos. Configure a ferramenta União usando as opções "Configurar automaticamente por nome" ou "Configurar automaticamente por posição".

A organização do aplicativo é feita em parte usando diferentes Contêineres de Ferramentas para diferentes seções do aplicativo. Por exemplo, as ferramentas de geração de relatórios são normalmente a última seção de um aplicativo e podem ser colocadas em um Contêiner de Ferramentas chamado "Geração de Relatórios".

Uma ferramenta Contêiner de Ferramentas pode ser codificada por cores com base na função que está destacando. Contêineres de Ferramentas codificados por cores facilitam a compreensão do que um aplicativo está fazendo, especialmente quando visualizado com um zoom reduzido. Isso é útil ao solucionar problemas ou depurar um aplicativo criado por outra pessoa.

As ferramentas da categoria Interface devem ser colocadas em seus próprios contêineres, codificados por cores adequadamente. Para aplicativos com várias guias, é útil colocar as ferramentas que compõem cada guia em seu próprio contêiner.

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

Se necessário, você também pode definir que anotações individuais sejam posicionadas na parte superior ou inferior de uma ferramenta. Para alterar a Anotação , clique na ferramenta, selecione a guia Anotação e marque ou desmarque Colocar a anotação no topo .

Uma ferramenta Entrada de Macro deve 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 à ferramenta Entrada de Macro. Este é o método preferencial para entradas de macro. Se você precisar de um arquivo maior para servir como entrada de dados, ele deve ser incluído com a macro sempre que possível. As dependências do arquivo de dados para uma macro devem ser nomeadas de acordo com este padrão:

NomeDaMacro.NomeDoArquivoDeDados.yxdb

Os nomes da entrada e da saída não devem ter um número de ferramenta associado a eles. Na janela de configuração da ferramenta Entrada de Macro, verifique se o nome é descritivo o suficiente. O nome que você especifica aqui fica visível para os usuários quando eles configuram a ferramenta de macro.

Quando há múltiplas entradas e saídas, a adição de uma Abreviação da âncora ajuda o usuário a configurar a ferramenta porque exibe um rótulo na âncora quando a ferramenta é colocada na tela. Vá para Ferramenta Entrada de Macro ou Ferramenta Saída de Macro para obter mais informações.

Os nomes das guias devem ser descritivos para facilitar o uso enquanto o usuário estiver configurando a ferramenta de macro. As guias ficam visíveis para o usuário no momento da configuração. O nome padrão de guia é "Perguntas". Não é um nome muito descritivo e isso geralmente não é observado ao desenvolver uma macro (ou aplicativo) com uma única guia. Consulte Janela do designer de interface .

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 devem ser nomeadas como: NomeDoPai.NomeDoSuporte.yxmc .