Esta documentação refere-se ao novo editor de formulários da plataforma. Caso esteja utilizando o editor atual, acesse a documentação disponível em Plataforma | Configurar formulário. |
Falando de editor de formulário...
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.
Configurações iniciais
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.
Adicionar campos ao formulário
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 radio button, 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.
Propriedade dos campos
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. Tamanho do campo
usado para definir o tamanho do campo no 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. 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
|
Usar Analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. 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. Altura
usado para definir a altura do campo no formulário. O tamanho inicial padrão é 6. Tamanho do campo
usado para definir o tamanho do campo no 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. |
Usar Analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. 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. |
Alinhamento e estilo define os alinhamentos que o campo vai receber, assim como os estilos aplicáveis 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 do lado esquerdo do fundo cor que define o lado esquerdo do campo. Cor do lado direito do fundo cor que define o lado direito do campo. 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. Tamanho do campo
usado para definir o tamanho do campo no formulário. |
Texto de ajuda
instruções para o usuário preencher o 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 Valores manuais. Para usar informações pré-definidas no formulário, selecione a opção Valores dinâmicos.
Ao escolher obter os valores manuais, será necessário incluir os valores nos campos Título da opção e Valor. Ao escolher obter os valores dinâmicos a partir de um dataset, é necessário acionar o botão Configurar dataset e preencher os campos abaixo: Dataset
Define o dataset que será utilizado para fornecer os valores. Ordenação
Define uma coluna para ordenar as opções disponíveis. Opções
Define uma coluna para que suas linhas sejam opções do campo para o usuário final. Valor
Define um identificador único da opção e não é exibido para o usuário final. Pode ser utilizado em personalizações via código. - Após preencher todos os campos necessários, clique em Salvar.
- Também é possível editar as informações no ícone
 e excluir no ícone  .
|
|
Usar Analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. 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. Tamanho do campo
usado para definir o tamanho do campo no formulário. |
Texto de ajuda
instruções para o usuário preencher o 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. Ao escolher obter os valores manuais, será necessário incluir os valores nos campos Título da opção e Valor. Ao escolher obter os valores dinâmicos a partir de um dataset, é necessário acionar o botão Configurar dataset e preencher os campos abaixo: Dataset
Define o dataset que será utilizado para fornecer os valores. Ordenação
Define uma coluna para ordenar as opções disponíveis. Opções
Define uma coluna para que suas linhas sejam opções do campo para o usuário final. Valor
Define um identificador único da opção e não é exibido para o usuário final. Pode ser utilizado em personalizações via código. - Após preencher todos os campos necessários, clique em Salvar.
- Também é possível editar as informações no ícone e excluir no ícone .
|
|
Usar Analytics
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. 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. 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. |
Texto de ajuda
instruções para o usuário preencher o formulário. |
Título da opção
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. É possível adicionar quantas opções forem necessárias. |
|
Usar analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. 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. 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. |
Texto de ajuda
instruções para o usuário preencher o formulário. |
Título da opção
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. É possível adicionar quantas opções forem necessárias. |
|
Usar analytics? Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. 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. Tamanho do campo
usado para definir o tamanho do campo no formulário. |
Texto de ajuda
instruções para o usuário preencher o formulário. |
Abaixo do campo Texto de ajuda é exibido o botão Configurar dataset para realizar a configuração da pesquisa. Para isso, é necessário preencher os campos abaixo: Dataset
Define o dataset que será utilizado para fornecer os valores. Ordenação
Define uma coluna para ordenar as opções disponíveis. Opções
Define uma coluna para que suas linhas sejam opções do campo para o usuário final. Valor
Define um identificador único da opção e não é exibido para o usuário final. Pode ser utilizado em personalizações via código. - Após preencher todos os campos necessários, clique em Salvar.
- Também é possível editar as informações no ícone e excluir no ícone .
|
Usar analytics? Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
|
|
| 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. Tamanho do campo
usado para definir o tamanho do campo no formulário. |
Texto de ajuda
instruções para o usuário preencher o formulário. Ícone
escolha entre os ícones disponíveis, que são: - Estrela
- Seleção
- Feliz
- Triste
- Coração
Escala
defina entre zero (0) ou dez (10). Exibir numeração
ative essa opção para exibir valores numéricos correspondentes a cada etapa da escala. Marcadores
ative para adicionar textos descritivos que contextualizam o início e o final da escala. Marcador inicial
defina o marcador de início. Por exemplo: Ruim. Marcador final
defina o marcador de fim. Por exemplo: Bom. |
Usar analytics?
Quando assinalado, os dados recebidos por este campo serão enviados ao Analytics. Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
|
|
| 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. Ocultar título? quando habilitado o título da tabela ficará oculto. |
Tabela principal Titulo do campo será atribuído ao campo do formulário. |
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 do lado esquerdo do fundo
define a cor de fundo do lado esquerdo que será utilizada no painel. Cor do lado direito do fundo define a cor de fundo do lado direito que está utilizada no painel. Ícone selecione um ícone para ser atribuído ao lado do título do 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. |
Título da aba defina o título que será atribuído a aba. Código propriedade que poderá ser utilizada para integrações ou tratativas no código. Não será exibido para o usuário final.
- É possível ordenar as abas conforme a ordem necessária. Bastando clicar e segurar no ícone
 . - É 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. |
Selecione o arquivo através do botão Selecionar arquivo, ou arraste e solte o arquivo na área indicada. Altura define a altura da imagem adicionada ao campo. Largura
define a largura da imagem adicionada ao campo. Manter proporção
quando utilizado, mantém as proporções de altura e largura da imagem adicionada. Alinhamento define o alinhamento a imagem adicionada ao campo, sendo alinhamento à direita, central e à esquerda. 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 | 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á 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. |
|
Regras do formulário
Ao criar ou editar um formulário de processo, é possível adicionar regras para serem validadas no momento de preenchimento. Abaixo vamos detalhar o conceito e como utilizar esse recurso:
Regras de formulário são mecanismos que permitem configurar eventos específicos dentro de um formulário, acionados em determinadas atividades e campos. Esses eventos ocorrem exclusivamente em atividades normais ou na atividade inicial de um processo. As ações disponíveis para esses eventos incluem: Desabilitar um campo: Impede que o usuário interaja com determinado campo. Validar um valor: Verifica se o valor inserido atende a critérios pré-definidos. Definir um valor: Atribui automaticamente um valor específico ao campo. Ocultar um campo: Remove temporariamente o campo da interface do usuário.
Ao configurar essas ações, um evento de formulário é gerado com os parâmetros estabelecidos, garantindo um comportamento automatizado e personalizado no preenchimento do formulário. |
01. Depois de incluir e configurar todos os campos desejados para o formulário, clique no ícone 
;
02. Clique em Adicionar regra para incluir uma nova regra e selecione as informações para definir a regra.
Campo Campo para o qual a regra será definida. Atividade Atividade na qual a regra definida para o campo deve ser executada. Ação Ação que será executada para o campo na atividade definida. As ações disponíveis são: Ocultar: quando selecionada, determina que o campo será ocultado quando a solicitação estiver na atividade selecionada na regra. Exibir: quando selecionada, determina que o campo será exibido somente quando a solicitação estiver na atividade selecionada na regra. Desabilitar: quando selecionada, determina que o campo será exibido desabilitado quando a solicitação estiver na atividade selecionada na regra. Habilitar: quando selecionada, determina que o campo será exibido habilitado quando a solicitação estiver na atividade selecionada na regra. Obrigatório: quando selecionada, determina que o campo será de preenchimento obrigatório quando a solicitação estiver na atividade selecionada na regra. Validar: quando selecionada, determinada que será executada uma validação no campo quando a solicitação estiver na atividade selecionada na regra. Ao selecionar essa opção, é necessário definir os critérios que serão considerados na validação do campo. Definir valor: quando selecionada, determina que será atribuído um valor específico para o campo quando a solicitação estiver na atividade selecionada na regra. Nesse caso, é necessário definir o valor que será atribuído. Os valores são divididos em três categorias distintas, Usuário atual, Solicitação e Outros. - Código do usuário
- Nome
- Nome completo
- E-mail
- Data atual
- Código da atividade
- Código da solicitação
- Usuário solicitante
- E-mail do solicitante
- Valor fixo
Evento: quando selecionada, determinada que um evento ocorrerá no campo quando a solicitação estiver na atividade selecionada na regra. Saiba mais sobre Eventos de formulário. É possível filtrar regras já criadas no ícone  |
|
Adicionar dado sensível
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.
Os dados sensíveis são um tipo específico de dado pessoal que, por sua natureza, exigem maior proteção. Eles revelam informações sobre a pessoa e, se forem expostos ou mal utilizados, podem causar discriminação, constrangimento, ou danos à liberdade e à privacidade do indivíduo.  Para coletar o CPF de um indivíduo é necessário que o campo que realizará a coleta deste dado esteja protegido, marcando a opção Adicionar dado sensível em seu formulário.
|
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:
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.
Publicar o formulário
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.
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. |
Esta documentação é válida a partir da atualização Voyager (2.0). Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma. |
