Documentação Formulários

De Gennera Apps
Ir para: navegação, pesquisa

O módulo de formulários é responsável pela criação de formulários dinâmicos com o objetivo de automatizar processos de negócio como pesquisas de satisfação, processos de seleção entre outros.

O sistema está dividido em:

Formulários

Um formulário basicamente é um conjunto de campos dinâmicos que podem ser dos seguintes tipos:

Tipo Descrição
Texto Simples É um campo texto que quando utilizado renderiza um campo de texto simples com apenas uma linha por meio de um componente do tipo Input
Texto Longo É um campo de texto longo que quando utilizado renderiza um campo de texto longo com várias linhas por meio de um componente do tipo Textarea
Data Utiliza uma máscara de data que é aplicada automaticamente conforme a data é digitada
Número Permite apenas a digitação de números
Dinheiro Formata automaticamente os números digitados aplicando uma máscara de dinheiro
Lista de Opções Permite o cadastro de opções e a seleção de apenas uma opção no preenchimento do formulário por meio de um componente Select
Escolha Única Similar a Lista de Opções mas exibe todas elas por meio de um componente do tipo Radio
Escolha Múltipla Permite o cadastro de opções e a seleção de várias opções no preenchimento do formulário por meio de um componente do tipo Checkbox
Escolha Livre Permite a digitação das opções durante o preenchimento do formulário
Grupo de Perguntas Agrupa as perguntas permitindo criar grupos, ou seja, que os grupos sejam repetidos
Upload de Arquivo Realiza o upload do arquivo durante o preenchimento do formulário
Download de Arquivo Realiza o download do arquivo durante o preenchimento do formulário
Parágrafo Permite a criação de um parágrafo utilizando um editor HTML
Barra Horizontal Renderiza uma barra horizontal
Imagem Realiza o upload de uma imagem para o formulário
Link Permite a criação de um link
Painel Cria um painel permitindo agrupar as perguntas
Quebra de Página Insere uma quebra de linha, permitindo melhor o fluxo de preenchimento do formulário
Fonte de Dados Permite a criação de fontes de dados externa, integradas ao formulário

Após a criação do formulário é possível preenchê-lo.

Respostas

Cada preenchimento do formulário é considerado uma resposta, é possível listá-las utilizando diversos tipos de filtros, selecionando quais colunas devem ser exibidas. Ao clicar sobre uma resposta é possível editá-la.

Existem alguns tipos de operações disponíveis nas respostas:

Exportação

É possível exportar as respostas de um formulário para um formato .xls, compatível com o Microsoft Excel.

Importação

Para importar respostas para o formulário, basta criar um arquivo onde a primeira linha tenha o título da pergunta separada por ponto e vírgula seguida pelas linhas das respostas onde a resposta de cada campo está também separada por ponto e vírgula conforme segue:

Nome;E-Mail;Telefone;

João da Silva;joao.silva@gennera.com.br;4899999-9999;

Maria Alves;maria.alves@gennera.com.br;4898888-8888;

Pedro Souza;pedro.souza@gennera.com.br;4897777-7777;

Copiar

A operação de copiar serve para copiar respostas entre formulários de acordo com uma condição. Para isso, basta selecionar o formulário desejado e as condições para a cópia.

Integrar

Caso existam integrações configuradas, é possível executá-las de forma manual, bastando selecionar a resposta desejada e executar a integração.

Financeiro

Se o formulário tiver uma tabela de preços configurada irá gerar um lançamento financeiro para cada preenchimento, com base na opção selecionada, controlando o pagamento caso seja realizado.

Relatórios

Com base nos campos dinâmicos criados dentro dos formulários é possível criar relatórios escolhendo as colunas desejadas

Colunas

Após adicionar as colunas, elas aparecem na aba Colunas e podem ser configuradas de acordo com as seguintes propriedades:

Propriedade Descrição
Filtro Exibe a resposta apenas se o valor da coluna for igual ao filtro
Largura Define uma largura para a coluna, percentualmente
Formato Estão disponíveis os formatos minúscula, maiúscula ou a primeira letra maiúscula, convertendo o valor do campo de acordo com o que for selecionado
Padrão Caso não tenha valor o padrão é assumido

As colunas podem ser reordenadas livremente, bastando arrastá-las para cima ou para baixo. Ao reordená-las elas serão exibidas horizontalmente na ordem definida.

Segue abaixo um exemplo dos dados, sem qualquer configuração:

Nome Profissão Está aposentado?
SERGIO MAIA Advogado Não
Ronaldo Cesar professor Não
Ana maria médica Sim
Tânia SILVA Não

Com base nas configurações abaixo, vamos ajustar os dados:

Coluna Filtro Largura Formato Padrão
Nome 60% Primeira letra maiúscula
Profissão 20% Primeira letra maiúscula Não informado
Ativa Não 20% Primeira letra maiúscula

Após a configuração das colunas os dado seriam exibidos da seguinte forma:

Nome Profissão Está aposentado?
Sergio Maia Advogado Não
Ronaldo Cesar Professor Não
Tânia Silva Não informado Não

Ordenação

Os dados exibidos no relatório podem ser ordenados bastando, na aba Ordenação, definir a ordem desejada. Além da ordem é possível definir se ela deve ser ascendente ou descendente.

Se a ordem das colunas for Nome com direção ascendente e Profissão com direção descendente:

Nome Profissão Está aposentado?
Ronaldo Cesar Professor Não
Sergio Maia Advogado Não
Tânia Silva Não informado Não

Somente se existirem dois nomes iguais, a coluna Profissão será considerada na direção descendente.

Cabeçalho

O cabeçalho serve para inserir um texto no topo do relatório, o cabeçalho não se repete por página, aparecendo uma única vez no início.

Rodapé

O rodapé serve para inserir um texto na base do relatório, o cabeçalho não se repete por página, aparecendo uma única vez no final.

Agrupamento

O agrupamento serve para criar grupos de dados, segmentados por uma coluna, por exemplo:

Nome Profissão Está aposentado?
SERGIO MAIA Advogado Não
Ronaldo Cesar professor Não
Ana maria médica Sim
Tânia SILVA Não

Se o agrupamento for pela coluna Está aposentado?, a exibição será feita da seguinte forma:

Está aposentado? Sim (1)

Nome Profissão Está aposentado?
Ana maria médica Sim

Está aposentado? Não (3)

Nome Profissão Está aposentado?
SERGIO MAIA Advogado Não
Ronaldo Cesar professor Não
Tânia SILVA Não

Assim, o agrupamento é interessante para segmentar os dados seguindo algum critério. Vale lembrar que é possível configurar também a ordem do agrupamento que pode ser ascendente ou descendente.

Configuração

O relatório pode ser configurado como analítico, sintético ou gráfico:

Tipo Descrição
Anatítico O relatório analítico lista as respostas sequencialmente, sem qualquer tipo de consolidação estatística
Sintético Se a opção sintética for selecionada, os valores das colunas serão totalizados em um indicador estatístico chamado percentual e em outro chamado total
Gráfico Similar a opção sintética, renderiza os totalizadores em um gráfico


A totalização estatística funciona da seguinte forma, as colunas incluídas no relatório são totalizadas com base em todas as respostas submetidas para o formulário. Assim, não faz sentido incluir colunas onde a resposta seja aberta como Nome ou Endereço.

Se a coluna Está aposentado? for incluída, considerando os dados acima, ficariam:

Está aposentado? Percentual Total
Sim 25% 1
Não 75% 3

Gráficos

Os gráficos são renderizados com base em uma pergunta específica. O funcionamento é similar ao relatório do tipo sintético. A pergunta precisa ter opções configuradas, assim será possível criar um percentual melhor distribuído entre as respostas.

Existem 2 tipos de gráfico: colunas e pizza.

O gráfico de colunas é mais indicado quando for interessante mostrar o volume comparativo de respostas para uma determinada pergunta. Já o de pizza para um comparativo percentual entre as diferentes respostas.

Comunicados

Os comunicados permitem o envio de mensagens, por e-mail, para as respostas que o formulário recebeu por meio da configuração das condições de envio. Assim, é possível enviar apenas para um determinado grupo, que respondeu por exemplo Sim, para a pergunta Está aposentado?.

Para isso, basta selecionar no campo destinatário a pergunta que representa o e-mail, seguido do assunto e da mensagem desejada.

É possível inserir variáveis, que representam as respostas para cada pergunta, na mensagem.

Após criar o comunicado, basta clicar em enviar e o sistema fará o envio de acordo com as condições estabelecidas.

Permissões

Caso a configuração de segurança esteja habilitada, é possível cadastrar usuários específicos que terão permissão para gerenciar o formulário.

Para isso basta selecionar o usuário desejado adicionando com as funcionalidades desejadas.

Além disso, é possível também configurar se o usuário pode editar o formulário, alterar as configurações ou excluir o formulário.

Vale lembrar que se o usuário adicionado nas permissões tiver liberação na funcionalidade de permissões, ele poderá adicionar outros usuários ou mesmo tirar a permissão do usuário que o adicionou sem qualquer restrição.

Integração

É possível integrar os dados preenchidos no formulário, após a finalização, com outros sistemas.

Para isso basta cadastrar uma ou mais integrações, sendo que uma integração tem as seguintes propriedades:

  • URL
  • Método
  • Formato
  • Tipo
  • Campos
  • Cabeçalhos
  • Conversores

O tipo pode ser síncrono, assíncrono ou manual indicando se a integração, que será executada após a finalização do preenchimento.

Caso seja síncrona, o preenchimento não será finalizado até que a integração seja executada com sucesso. Esse tipo é indicado caso o retorno da integração seja importante para o processo de preenchimento como, por exemplo, uma informação que deverá ser exibida no comprovante.

Se for assíncrona, a integração é executada em paralelo sem aguardar o preenchimento do formulário e se for manual, ela só poderá ser executada manualmente pela tela de respostas, clicando no botão integrar.

Para enviar dados na requisição, basta clicar em Adicionar Campo, selecionando os campos desejado e indicando se o valor deve ser transmitido na própria URL ou no corpo da requisição, além do nome do campo.

Vale lembrar que existem dois formatos suportados para o corpo da requisição: JSON e x-www-form-urlencoded.

Se a integração precisar de algum cabeçalho, por exemplo para fins de autenticação, é possível cadastrá-los indicando a chave e o valor.

Por fim, existem os conversores, responsáveis por preencher nos campos do formulário valores vindos da resposta da integração. Para isso, basta preencher os campos De, que vem da API e Para, que vão para o campo no formulário.

Configuração do Formulário

Geral

Na configuração do formulário, é possível definir o título e a categoria do formulário, além de outras propriedades como:

Permitir que o preenchimento do formulário seja salvo parcialmente?

Se a opção estiver selecionada, o preenchimento do formulário pode ser salvo, permitindo que o link seja compartilhado com outras pessoas ou mesmo que seja preenchido ao longo do tempo.

Permitir a atualização do preenchimento mesmo após ele ser finalizado?

Caso seja desejável permitir que o preenchimento do formulário seja atualizado, é possível habilitar esta opção. Vale lembrar que na maior parte dos casos, pode não ser interessante liberar esta opção já que pode envolver a emissão de relatórios ou apuração dos resultados, assim, a partir de um determinado momento a atualização do preenchimento pode ser indesejável.

Segurança

Se for habilitada, o usuário que habilitou ganha permissão de acesso ao formulário e nenhum outro usuário conseguirá acessar até que tenha sua permissão liberada.

Status

O formulário pode ter 3 status:

Status Descrição
Ativo O formulário está liberado para preenchimento
Encerrado O formulário tem seu preenchimento encerrado
Condicional Com base nas condições, que podem envolver a quantidade de respostas ou uma data e hora de encerramento, o formulário pode estar ativo ou encerrado

Financeiro

Para configurar a tabela de preços, basta selecionar o portador, previamente cadastrado, especificando os preços, que tem as seguintes propriedades:

  • Descrição
  • Tipo de Valor
  • Valor
  • Tipo de Vencimento
  • Número de Parcelas

O tipo de valor pode ser manual ou dinâmico. Caso seja manual, o valor especificado será cobrado diretamente. Caso seja dinâmico é necessário especificar no valor um campo do formulário que tem o valor que deverá ser cobrado. Esse tipo de configuração é útil caso o formulário utilize alguma fonte de dados que renderiza um determinado valor no formulário dinamicamente.

O tipo de vencimento pode ser em uma data específica ou um número de dias após a data de emissão.

O número de parcelas representa o parcelamento máximo permitido.

Para a emissão do boleto bancário, é necessário configurar também as seguintes informações, indicando os campos diretamente no formulário:

  • Sacado
  • Documento
  • Endereço
  • Bairro
  • Cidade
  • Estado
  • CEP

Por fim, é necessário também configurar os campos abaixo:

  • Dias para Reemissão
  • Instruções
  • Área Livre

Lembrando que os dias para reemissão são utilizados para reemitir o boleto bancário caso esteja vencido, enquanto as instruções e a área livre podem ser preenchidas de acordo com as regras desejadas para o recebimento do pagamento.

E-Mail

É possível configurar um e-mail de confirmação. Para isso basta selecionar no destinatário o campo de e-mail preenchido no formulário e no remetente o servidor SMTP previamente cadastrado.

Os campos CC e BCC podem ser utilizados para cadastrar e-mails que devem ser colocados como cópia ou cópia oculta, respectivamente, separados por vírgula.

Por fim, o assunto e a mensagem devem ser preenchidos sendo que na mensagem é possível incluir variáveis que fazem referência aos dados preenchidos na resposta do formulário.

Comprovante

Após o preenchimento do formulário um comprovante é exibido na tela. O modelo do comprovante pode ser configurado utilizando variáveis, que fazem referência aos dados preenchidos na resposta do formulário.

Vale lembrar que caso o comprovante seja alterado, só terá efeito para novas respostas afetando as respostas anteriores somente se a resposta for atualizada.

Style

Existe a possibilidade de configurar uma folha de estilo, utilizando a linguagem CSS, afetando o estilo existente no formulário como as cores dos botões, de fundo, texto entre outras coisas.

Para isso, basta criar novas classes tomando cuidado para não causar nenhum efeito colateral ou indesejado.

Script

Em alguns formulários pode ser interessante utilizar códigos de rastreamento do Google Adwords ou Facebook Ads utilizando a linguagem JavaScript.

Para isso, basta copiar o código-fonte tomando cuidado para não causar nenhum efeito colateral ou indesejado.

Configuração Geral

A configuração geral abrange os seguintes aspectos:

Geral

  • Cliente
  • Plano
  • Número do Locker

O número do locker é o código gerado pelo módulo de arquivos necessário para utilizar as funcionalidades de upload e download a também de imagem.

SMTP

É possível cadastrar um ou mais servidores SMTP para realizar o envio de e-mails. Para isso, basta criar um novo remetente que tem as seguintes propriedades:

  • Nome
  • E-Mail
  • Servidor
  • Usuário
  • Senha
  • Porta
  • TLS

Após cadastrar o remetente é possível testá-lo clicando em Testar e informando o e-mail de teste.

Portadores

Os portadores são utilizados para emitir boletos bancários e tem as seguintes propriedades:

  • Razão Social
  • CNPJ
  • Banco
  • Agência
  • Conta
  • Carteira
  • Contrato
  • Faixa
  • Remessa

Antes de cadastrar um portador é necessário informá-lo previamente para a equipe da Gennera realizar o licenciamento e a validação bancária.

Fontes de Dados

É possível preencher campos do formulário com dados vindos de uma fonte de dados interna ou externa. Existem dois tipos de fontes de dados: formulário ou web service.

Um formulário pode ser uma fonte de dados interna, para isso basta criar uma nova fonte de dados do tipo formulário e informar os parâmetros de entrada e os campos de saída.

Se a fonte de dados for externa, basta selecionar o tipo web service, que tem as seguintes propriedades:

  • Descrição
  • URL
  • Método
  • Formato
  • Cabeçalhos
  • Parâmetros
  • Conversores