O editor de formulários conta com diversos recursos, campos e propriedades para os formulários que são criados especificamente para um processo. A seguir, são detalhados todos os campos e procedimentos necessários para a construção de um formulário seguindo as boas práticas de desenvolvimento. O editor de formulários é dividido em quatro partes distintas que serão detalhadas nesta documentação.
Algumas configurações iniciais como título, versão, configuração e visualização estão localizados no topo do editor de formulários. Abaixo detalharemos cada um destes itens.
- Título do formulário: insira um título para o formulário que está sendo criado.
- Versão: rascunho ou o número da versão liberada. Exemplo V. 01.
- Regras do formulário: clique no ícone para visualizar ou incluir novas regras para o formulário.
- Visualizar formulário: clique no ícone de pré-visualização
- Configurações do formulário: define se a descrição dos campos será padrão ou campo de formulário.
- Salvar: utilizado para salvar o formulário pertencente ao processo.
- Publicar: utilizado para publicar o formulário pertencente ao processo.
Os campos do formulário estão à esquerda do editor e podem ser adicionados em qualquer ordem e quantidade. Para reorganizar a posição de um campo, basta clicar sobre ele e arrastá-lo para o local desejado. Os campos disponíveis são:
- Campo simples: validar propósito de uso
- Área de texto: permite a inclusão de texto no formulário que está sendo criado.
- Texto: permite a inclusão de texto.
- Combo: permite a inclusão de um campo do tipo combobox com opções pré-definidas no formulário ou com opções carregadas dinamicamente de um dataset.
- Lista: permite a inclusão de campos do tipo list com opções pré-definidas no formulário ou com opções carregadas dinamicamente de um dataset.
- Seleção única: permite a inclusão de campos do tipo radiobutton, permitindo a seleção de apenas uma opção das cadastradas pelo usuário.
- Múltipla escolha: permite a inclusão de campos do tipo checkbox, permitindo a seleção de múltiplas opções pelo usuário.
- Pesquisa: permite a inclusão de um campo do tipo pesquisa com informações carregadas a partir do dataset selecionado.
- Avaliação: permite a inclusão de um campo do tipo rating star, onde o usuário pode selecionar uma escala de 0 a 5 estrelas.
- Tabela: permite a inclusão dos outros campos disponíveis para a construção do formulário.
- Painel: validar propósito de uso
- Abas: permite a inclusão de abas dentro do formulário que está sendo criado, é possível incluir os outros campos disponíveis para a construção do formulário.
- Imagem: permite a inclusão de uma imagem diretamente do desktop do usuário. O tamanho máximo suportado para upload é de 10MB.
- Divisor: adiciona uma linha horizontal para separar visualmente os campos do formulário.
Todos os campos disponíveis para a construção do formulário possuem propriedades que podem ser configuradas no momento da inclusão do campo ao formulário. A seguir, detalharemos todas as propriedades disponíveis para cada tipo de campo.
| Campo | Propriedades |
|---|
| Campo simples | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Tipo
define se o campo será do tipo texto, numérico ou calendário. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Dica de preenchimento
dica que descreve o valor esperado para o campo. Limite de caracteres
o limite de caracteres do campo pode ser ajustado usando os ícones de seta ou inserindo o valor diretamente na propriedade. Se nenhum valor for definido, o limite padrão é 4.000 caracteres. Tamanho do campo
usado para definir o tamanho do campo no formulário. Valor inicial
valor pré-definido para o campo. Esse valor oculta a dica de preenchimento. Máscara
formato no qual o valor do campo será exibido. As opções da máscara são: - Sem máscara
- CPF
- CNPJ
- Porcentagem
- CEP
- Data
- Hora
- Data e Hora
- Telefone fixo
- Telefone celular
- Placa de carro
- Moeda
- IP
Adicionais - Usar Analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Área de texto | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Dica de preenchimento
dica que descreve o valor esperado para o campo. Tamanho do campo
usado para definir o tamanho do campo no formulário. Altura
usado para definir a altura do campo no formulário. O tamanho inicial padrão é 6. Valor inicial
valor pré-definido para o campo. Esse valor oculta a dica de preenchimento. Limite de caracteres
O limite de caracteres do campo pode ser ajustado usando os ícones de seta ou inserindo o valor diretamente na propriedade. Se nenhum valor for definido, o limite padrão é 4.000 caracteres. Usar Analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Texto | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código.
Texto
possível incluir parágrafos utilizando a tecla Enter. Tamanho do campo
usado para definir o tamanho do campo no formulário.
Personalizar
possível realizar alinhamento do texto à direita, à esquerda e ao centro. Possível também utilizar negrito, itálico e sublinhado. Tamanho do texto define o tamanho da fonte utilizada no campo. Sendo possível definir entre o tamanho do parágrafo 7 ao 1. Cor do texto
define a cor do texto incluído no campo. Cor de fundo primário
define a cor primária utilizada de fundo para o campo. Cor de fundo secundário
define a cor secundária utilizada de fundo para o campo. Quando utilizado, faz um gradiente entre as cores primárias e secundárias. Altura do espaço interno
define a altura do espaço interno do campo. Quanto maior o valor, maior será o espaço interno do campo. O valor máximo suportado é 100. Arredondar bordas usado para arredondar as bordas do campo. |
| Combo | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Tamanho do campo
usado para definir o tamanho do campo no formulário. Valor do campo
determina se as opções para seleção do campo serão definidas a partir de um dataset ou pré-definidas diretamente na construção do formulário. Para usar informações pré-definidas no formulário, selecione a opção Definidos. Para usar informações pré-definidas no formulário, selecione a opção Definidos.
| Painel |
|---|
| borderColor | #000000 |
|---|
| bgColor | #f2f2f2 |
|---|
| Ao escolher obter os valores de forma pré-definida, será necessário incluir os valores nos campos Título da opção. Ao escolher obter os valores a partir de um formulário é necessário selecionar o dataset desejado. |
*Preencher os campos descrição, preview, valor, preview e ordenação. (Será documentado quando as issues FBPM-9372 e FBPM-9406 forem finalizadas) Usar Analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Listas | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Tamanho do campo
usado para definir o tamanho do campo no formulário. Valor do campo
determina se as opções para seleção do campo serão definidas a partir de um dataset ou pré-definidas diretamente na construção do formulário. | Painel |
|---|
| borderColor | #000000 |
|---|
| bgColor | #f2f2f2 |
|---|
| Ao escolher obter os valores de forma pré-definida, será necessário incluir os valores nos campos Título da opção. Ao escolher obter os valores a partir de um formulário é necessário selecionar o dataset desejado. |
*Preencher os campos descrição, preview, valor, preview e ordenação. (Será documentado quando as issues FBPM-9372 e FBPM-9406 forem finalizadas) Usar Analytics
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Seleção única | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Número de colunas
define o número de colunas que o campo terá. Tamanho do campo usado para definir o tamanho do campo no formulário.
Título das opções
insira as opções que irão compor o campo. É possível alternar a posição das opções e excluí-las. Valor
propriedade que poderá ser utilizada para integrações ou tratativas no código. Não será exibido para o usuário final. Usar analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Múltipla escolha | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Número de colunas
define o número de colunas que o campo terá Tamanho do campo
usado para definir o tamanho do campo no formulário. Título das opções
insira as opções que irão compor o campo. É possível alternar a posição das opções e excluí-las. Valor
propriedade que poderá ser utilizada para integrações ou tratativas no código. Não será exibido para o usuário final. Usar analytics? Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Pesquisa | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Tamanho do campo
usado para definir o tamanho do campo no formulário. Valor do campo
defina o dataset que será utilizado para a inclusão de dados no campo. Campo descrição
*Preview (Será documentado quando as issues FBPM-9372 e FBPM-9406 forem finalizadas) Usar analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics.
|
| Avaliação | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Texto de ajuda
instruções para o usuário preencher o formulário. Tamanho do campo
usado para definir o tamanho do campo no formulário. Ícone
escolha entre os ícones disponíveis, que são: - Estrela
- Seleção
- Feliz
- Triste
- Coração
Escala inicio
defina entre zero (0) ou um (1) Escala fim
defina entre dois (2) à dez (10) Marcador início
defina o marcador de início. Por exemplo: Ruim Marcador fim
defina o marcador de fim. Por exemplo: Bom Exibir numeração
exibe a numeração conforme a escala de 1 à 10 Usar analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics.
|
| Tabela | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Nome do botão de inclusão
botão utilizado para adicionar novos registros na tabela, ou seja, uma nova linha. Tabela principal (validar) Permitir subtabela?
ao permitir subtabela é necessário adicionar o nome do botão de inclusão para a subtabela. | Informações |
|---|
Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
|
| Painel | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário. Cor do título
define a cor que será utilizada no título Cor de fundo do título
define a cor de fundo que será utilizada no painel |
| Abas | Código
o código é uma propriedade que poderá ser utilizada para integrações ou tratativas no código. Não será exibido para o usuário final. Título
por padrão o campo é aberto com três abas, sendo necessário incluir título para cada uma das abas. Ordenação
é possível ordenar as abas conforme a ordem necessária. Bastando clicar e segurar no ícone . Excluir aba
é possível excluir uma aba clicando no ícone de lixeira . |
| Imagem | Código
código único de identificação do campo. Este código pode ser editado para o valor desejado, sendo apenas necessário ser um código único, ou seja, que não se repita. Pode ser usado em personalizações via código. Título
título que será atribuído ao campo do formulário Tamanho do campo
usado para definir o tamanho do campo no formulário. Valor do campo
aqui é possível incluir a imagem através do botão Selecionar arquivo, ou arrastar o soltar o arquivo diretamente na área indicada do campo. Altura e Largura
define altura e largura da imagem adicionada ao campo Manter proporção
quando utilizado, mantém as proporções de altura e largura da imagem adicionada. Comportamento - Preencher: A imagem será ampliada para se ajustar a todo o espaço disponível. Podendo destorcer.
- Conter: A imagem será reduzida para se ajustar ao espaço disponível, mantendo suas proporções.
- Cobrir: A imagem ocupará todo o espaço disponível, sendo cortada se necessário.
|
| Divisor | Título
título que será exibido junto ao divisor Texto de ajuda
subtexto que será exibido abaixo do divisor Espessura
espessura da linha do divisor, podendo ser pequena, média ou grande Cor do divisor
usado para definir a cor do divisor Ícone
ícone que será exibido ao lado do divisor. |
Verificar como documentar a parte de Regras do campo
Em alguns campos é possível marcar como dado sensível nos casos onde é necessário. Os seguintes campos apresentam essa característica. Abaixo, vamos detalhar como utilizar esta opção.
- Campo simples;
- Área de texto;
- Combo;
- Listas;
- Seleção única;
- Múltipla escolha;
- Tabela.
01. Adicionar o campo desejado no editor de formulários;
02. Nas propriedades do campo, localizar e clicar em Adicionar dado sensível;
03. Em Tipo do dado, selecionar o tipo do dado que será coletado entre as opções abaixo:
- Nome
- E-mail
- CPF
- RG
- Carteira de habilitação
- Título de eleitor
- Carteira de trabalho
- Passaporte
- Outros
04. Defina se o dado coletado é sensível e precisa ser anonimizado. Nas opções É um dado sensível? e Anonimizar este dado? selecione sim, caso seja necessário. Ficará como nas imagens abaixo:
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
| Deck of Cards |
|---|
| | Card |
|---|
| 
|
| Card |
|---|
| 
|
|
|
05. Em Classificação selecione uma das classificações disponíveis. Entre:
- Execução de contrato;
- Obrigação legal;
- Consentimento;
- Execução de políticas públicas;
- Estudo por órgão de pesquisa;
- Exercício regular de direito;
- Para a proteção da vida;
- Para tutela de saúde;
- Interesse legítimo;
- Proteção de credito.
06. Em Justificativa, informe uma justificativa para o dado ter sido considerado sensível.
07. Após todas as configurações realizadas, clique em Salvar.
Para publicar o formulário siga os passos abaixo.
01. Clique no botão Publicar, localizado no lado superior direito do editor.
02. Uma mensagem confirmando a ação será apresentada.
| Painel |
|---|
| borderColor | #f2f2f2 |
|---|
| bgColor | #f2f2f2 |
|---|
|
Ao publicar o formulário, as alterações feitas no formulário já serão válidas para novas solicitações do processo, caso o formulário foi editado. Caso foi construído no zero, ao publicar todas as solicitações passarão por este formulário. |
| Informações |
|---|
|
Esta documentação é válida a partir da atualização xx - xx. Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma. |