TOTVS Fluig

Atalhos

Árvore de páginas

Índice

Objetivo

O objetivo deste guia é apresentar a estrutura dos formulários, bem como boas práticas de nomenclatura e dicas para o desenvolvimento.

Nomenclatura

Código do Processo

Para convencionar os processos que serão criados, os códigos devem seguir o seguinte padrão: (area) _ (ação)

Exemplo
estoque_picking, controladoria_pedidocompra

Serviços

Para convencionar os serviços que serão incluídos, os códigos devem seguir o seguinte padrão: (sistema) _ (processo)

Exemplo
ems_despesasavulsas

Código do Dataset

Para convencionar os datasets que serão criados, os códigos devem seguir o seguinte padrão: (sistema) _ (transação) _ (item/artefato)

Exemplo
ems_consulta_ccusto, fluig_inclui_colleague

Mecanismo

Para convencionar os mecanismos que serão criados, os códigos devem seguir o seguinte padrão: (sistema) _ (processo)

Exemplo
protheus_alcadacompras

Campos no Formulário e Variáveis

Devemos manter os seguintes prefixos de campos do formulário e para variáveis.

Prefixo

Tipo

Exemplo

vl

Valor

vl_total , vl_telefone

nm

Nome

nm_cliente , nm_fornecedor

dt

Data

dt_emissao , dt_faturamento

lb

Booleano

lb_temfrete , lb_emiteboleto

ds

Textarea

ds_comentarios , ds_observacoes

cb

Combo box

cb_estado , cb_cidade

Atenção!

Não é possível alterar o tipo de um campo anteriormente criado no formulário. Esta alteração não será refletida no banco de dados.

Como paliativo, é possível alterar o nome do campo de formulário. Desta forma ele será registrado no banco de dados como um novo campo.


Estrutura

Para entendimento do modelo, o formulário é dividido em três partes sendo o Cabeçalho, Conteúdo e Rodapé.

Os campos de formulário são constituídos por labels e campos de edição. Esse label deve ser posicionado acima do campo de forma a garantir a internacionalização (i18n) e localização (L10n) do produto.

É possível agrupar grandes quantidades de informações utilizando agrupadores por localização.

Cabeçalho

O cabeçalho se encontra na parte superior do formulário e dever ser utilizado para apresentar o título explicativo sobre a coleção de dados. Neste local também, alinhado à direita, pode ser inserido a logomarca do cliente. O tamanho sugerido é de 150px x 50px.

Conteúdo

A área de conteúdo se encontra na parte intermediária do formulário, entre o cabeçalho e rodapé, e dever ser utilizado para apresentar a coleção de dados.

Rodapé

O rodapé se encontra na parte inferior do formulário, e dever ser utilizado para apresentar as ações relacionadas e disponíveis para a coleção de dados quando necessário.

Elementos

Conforme a imagem abaixo, podemos verificar os elementos essenciais. O título deve estar alinhado à esquerda e sempre que possível ser correspondente à coleção de dados. Os dados, de preferência, devem estar agrupados, labels sempre acima dos InputText e botões com ações localizados no rodapé alinhados à direita.

Dimensões

Os formulários devem ter seu tamanho adaptável a tela, não deve ter tamanho fixo.

Dicas Práticas

  • Monte a ordem dos campos no formulário respeitando as regras do negócio relacionadas àquele conteúdo.
  • Utilize * para marcar os campos obrigatórios;
  • Evite campos desnecessários;
  • Sempre que possível, na entrada de dados, utilize máscaras (CPF, RG, CNPJ, DATA, HORÁRIO, MOEDA) para impedir letras em um campo numérico;
  • Defina a largura dos campos no tamanho dos seus caracteres no banco;
  • Se for necessário, limite o máximo de caracteres possíveis (maxlength);
  • Use Datasets para carregar dados em um ComboBox;
  • Mantenha os formulários com Labels em cima e campos abaixo;
  • Zoom e ComboBox devem ser utilizados no lugar de campos vazios, o usuário não deve precisar memorizar dados desnecessários;
  • Opções não disponíveis ficam desabilitadas. Campos somente leitura devem aparecer como label, pois facilita a leitura e a legibilidade da tela;
  • Itens de formulário devem possuir validações que não deixam o usuário trocar de campo sem corrigir dados inconsistentes. Esse item garante o critério ergonômico de prevenção de erros;
  • Os formulários devem permitir a navegação através do teclado, de forma que a tecla ‘TAB’ direcione o foco para o próximo campo e ‘SHIFT + TAB’ para o campo anterior. Nesse caso, deve-se definir a ordem dos componentes. Quando existirem formulários múltiplos (várias abas), o usuário será redirecionado para a próxima sessão do formulário ao chegar ao fim da página;


  • Sem rótulos