Consulte a documentação correta:
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.
Histórico de versões: utilizado para acessar o histórico de versões e modificações do formulário. Saiba mais aqui.
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.
Criar com IA: utilizado para solicitar a criação de formulários de forma facilitada.
Salvar: utilizado para salvar o formulário pertencente ao processo.
Informação
Nos formulários criados a partir dos novos editores, não existe a opção ou botão de publicação individual. Isso porque a publicação do formulário ocorre automaticamente quando o diagrama de processo ao qual ele está vinculado é publicado.
Assim, não é possível publicar um formulário de forma isolada — ele só se torna disponível após a publicação do processo relacionado.
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: permite agrupar diferentes campos dentro de uma mesma área, facilitando a organização e a leitura das informações. Este recurso é utilizado para criar seções ou delimitar conjuntos de campos por contexto.
- 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.
Informação
Todos os campos possuem a propriedade Código, preenchida automaticamente para facilitar sua identificação. Essa propriedade é editável e pode ser alterada conforme a necessidade. No entanto, não é permitido atribuir o mesmo código a dois campos diferentes. Caso isso ocorra, o campo duplicado será destacado em vermelho para sinalizar o ajuste necessário. Além disso, não é possível salvar o formulário enquanto houver campos com códigos repetidos.
Duplicar campos
Todos os campos possuem a ação de duplicação, acessível por meio do ícone 
. Para campos que têm regras configuradas, uma mensagem é exibida perguntando se deseja copiar as regras do campo original para o campo duplicado. Caso desejado, clique em Sim.
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 | Configurações gerais do campo Código Tipo Título Tamanho do campo Ajuda e preenchimento Texto de ajuda Dica de preenchimento Limite de caracteres Máscara
Privacidade e dados Usar Analytics? Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui. |
| Área de texto | Configurações gerais do campo Código Título Altura Tamanho do campo Ajuda e preenchimento Texto de ajuda Dica de preenchimento Limite de caracteres Privacidade e dados Usar Analytics? Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
| Texto | Configurações gerais do campo Código Texto Tamanho do campo Personalização 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 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 Arredondar bordas usado para arredondar as bordas do campo. |
| Combo | Configurações gerais do campo Código Título Tamanho do campo Ajuda e preenchimento Texto de ajuda Valor do campo
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 clicar no botão Configurar dataset e preencher os campos abaixo: Dataset Opções Ordenação Valor
Privacidade e dados Usar Analytics? Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
| Listas | Configurações gerais do campo Código Título Tamanho do campo Ajuda e preenchimento Texto de ajuda Valor do campo
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 clicar no botão Configurar dataset e preencher os campos abaixo: Dataset Ordenação Opções Valor
Privacidade e dados Usar Analytics Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
| Seleção única | Configurações gerais do campo Código Título Número de colunas Tamanho do campo usado para definir o tamanho do campo no formulário. Ajuda e preenchimento Texto de ajuda Opções Título da opção Valor É possível adicionar quantas opções forem necessárias. Privacidade e dados Usar analytics? Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
| Múltipla escolha | Configurações gerais do campo Código Título Número de colunas Tamanho do campo Ajuda e preenchimento Texto de ajuda Opções Título da opção Valor É possível adicionar quantas opções forem necessárias. Privacidade e dados 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 | Configurações gerais do campo Código Título Tamanho do campo Ajuda e preenchimento Texto de ajuda Configurar dataset 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 Opções Valor Ordenação Limite de resultados Limite de seleção de registros
Privacidade e dados 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 | Configurações gerais do campo Código Título Tamanho do campo Ajuda e preenchimento Texto de ajuda Ícone
Escala Exibir numeração Marcadores Marcador inicial Marcador final Privacidade e dados Usar analytics? Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
| Tabela | Configurações gerais do campo Código Título Nome do botão de inclusão Ocultar título? quando habilitado o título da tabela ficará oculto. Tabela principal Tabela principal Titulo do campo será atribuído ao campo do formulário. Privacidade e dados O botão Enviar ao Analytics não é exibido neste campo, pois o campo em si não é enviado ao Analytics. Somente os campos adicionados dentro do campo Tabela podem ter essa configuração. Já o botão Adicionar dado sensível define apenas como as informações serão armazenadas na tabela. Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui |
| Painel | Configurações gerais do campo Código Título Personalização Cor do título Cor do lado esquerdo do fundo Cor do lado direito do fundo Ícone Permite abrir e fechar? Ícones para abrir e fechar |
| Abas | Configurações gerais do campo Código Título 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.
|
| Imagem | Configurações gerais do campo Código Título Tamanho do campo Upload 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 Manter proporção Alinhamento define o alinhamento a imagem adicionada ao campo, sendo alinhamento à direita, central e à esquerda. Comportamento
|
| Divisor | Configurações gerais do campo Código Título Ajuda e preenchimento Texto de ajuda Personalização Espessura Cor do divisor Ícone |
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:
O que são as regras do formulário
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.
Quando a solicitação chegar na atividade
Selecione a atividade na qual a regra será definida.
o campo
Selecione o campo no qual irá receber a regra.
do formulário será
Ocultado: quando selecionada, determina que o campo será ocultado quando a solicitação estiver na atividade selecionada na regra.
Exibido: quando selecionada, determina que o campo será exibido somente quando a solicitação estiver na atividade selecionada na regra.
Desabilitado: quando selecionada, determina que o campo será exibido desabilitado quando a solicitação estiver na atividade selecionada na regra.
Habilitado: 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.
Opcional: quando selecionada, determina que o campo será de preenchimento opcional quando a solicitação estiver na atividade selecionada na regra.
Definido 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
- Data atual
- Código da atividade
- Código da solicitação
- Usuário solicitante
- E-mail do solicitante
- Valor fixo
Validado valor: quando selecionada, determina que será executada uma validação no valor do 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.
Validado formato: quando selecionada, determina que será validado o formato satisfazendo as condições definidas.
Executado eventos: 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 
Usar Analytics? 
Ao habilitar esta opção, os dados recebidos por este campo serão enviados ao Analytics, permitindo a realização das análises necessárias.
Adicionar dado pessoal / 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.
Mas o que são dados sensíveis?
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.
EXEMPLO 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 É um dado sensível? no campo necessário.
01. Adicione o campo desejado no editor de formulários;
02. Nas propriedades do campo, localize o agrupador Privacidade e dados e clique em Adicionar dado pessoal;
03. Em Tipo do dado, selecione o tipo do dado que será coletado entre as opções abaixo:
- Nome
- 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. No ícone 
é possível adicionar mais de uma classificação e justificativa para o campo. Também é possível Remover o conjunto de classificação e justificativa através do botão Remover
.
08. Após todas as configurações realizadas, clique em Salvar.
Publicar o formulário
Para publicar um formulário criado no novo editor, é preciso primeiro publicar o processo ao qual ele está vinculado. Somente então a versão salva do formulário será efetivamente publicada.
Fique atento!
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.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas