Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
titleConsulte 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.


Índice
maxLevel2
exclude.*ndice


Falando de editor de formulário...Image Added

...

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.

Image RemovedImage Added


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.

  • Image Added Título do formulário: insira um título para o formulário que está sendo criado.
  • Image Added Versão: rascunho ou o número da versão liberada. Exemplo V. 01.
  • Image Added 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
  • Image Added Histórico de versões: utilizado para acessar o histórico de versões e modificações do formulário. Saiba mais aqui.
  • Image Added Visualizar formulário: clique no ícone de pré-visualização
  • Image Added Configurações do Configurações do formulário: define se a descrição dos campos será padrão ou campo de formulário.
  • SalvarImage Added Criar com IA: utilizado para solicitar a criação de formulários de forma facilitada.
  • Image AddedSalvar salvar o formulário pertencente ao processo.Publicar: utilizado para publicar salvar 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:

Informações
titleInformaçã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
  • 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 usopermite 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 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ções
titleInformaçã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 Image Added. 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.

CampoPropriedades
Campo simples
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePersonalizaçã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
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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

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

Painel
borderColor#8c8c8c
bgColor#f2f2f2

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
Define o dataset que será utilizado para fornecer os valores.

Opções
Define uma coluna para que suas linhas sejam opções do campo para o usuário final.

Ordenação
Define uma coluna para ordenar as opções disponíveis.


Valor
Valor que será atribuído à opção do campo.

  • Após preencher todos os campos necessários, clique em Salvar.
  • Também é possível editar as informações no ícone Image Added e excluir no ícone Image Added.
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

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 Definidos.
  • Para usar informações de um dataset escolha a opção Dataset.

Painel
borderColor#8c8c8c
bgColor#f2f2f2

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
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 Image Added e excluir no ícone Image Added.
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

Texto de ajuda
instruções para o usuário preencher o formulário.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleOpções

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.

Painel
borderColor#000000
bgColor#f2f2f2

É possível adicionar quantas opções forem necessárias.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

...

CampoPropriedades
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.

Título
título que será atribuído ao campo do formulário.

Tipo

Número de colunas
define

se o campo será do tipo texto, numérico ou calendário.

o número de colunas que o campo terá.

Tamanho do campo
usado para definir o tamanho do campo no formulário.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento
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.

Painel

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
borderColor#8c8c8c
bgColor#f2f2f2
titleOpções

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2

É possível adicionar quantas opções forem necessárias.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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

Pesquisa
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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.
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

Texto de ajuda
instruções para o usuário preencher o formulário.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurar 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
Define o dataset que será utilizado para fornecer os valores.

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.

Ordenação
Define uma coluna para ordenar as opções disponíveis.

Limite de resultados
Define o número máximo de registros retornados por consulta. Limitado a cem (100) registros.

Limite de seleção de registros
Define o número máximo que podem ser selecionados pelo usuário no momento do preenchimento do formulário. Limitado a cem (100) seleções de registros.

  • Após preencher todos os campos necessários, clique em Salvar.
  • Também é possível editar as informações no ícone Image Added e excluir no ícone Image Added.
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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


AvaliaçãoCombo
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo

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

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleAjuda e preenchimento

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.

Painel
borderColor#8c8c8c
bgColor#f2f2f2
titlePrivacidade e dados

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

.

Tabela
Painel
borderColor#8c8c8c
bgColor#f2f2f2
titleConfigurações gerais do campo
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

Nome do botão de

ajuda

inclusão

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.
  • 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.

    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleTabela principal

    Tabela principal

    Titulo do campo será atribuído ao campo do formulário

    Para usar informações de um dataset escolha a opção Dataset

    .

    Painel
    borderColor#000000#8c8c8c
    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
    titlePrivacidade 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.

    Informações

    Este campo pode ser usado para coletar dados sensíveis. Saiba mais aqui

    .

    Painel
    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleConfigurações gerais do campo
    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.

    ao campo do formulário.

    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titlePersonalização

    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.

    Permite abrir e fechar?
    habilite ou desabilite para que seja possível expandir e recolher o painel.

    Ícones para abrir e fechar
    defina o conjunto de ícones que representarão as ações de expandir e recolher os campos inseridos no painel

    Abas
    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleConfigurações gerais do campo

    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. 

    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleAbas

    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 íconeImage Added.
    • É possível excluir uma aba clicando no ícone de lixeiraImage Added.
    Imagem
    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleConfigurações gerais do campo

    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.

    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleUpload

    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.
    DivisorAvaliação
    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleConfigurações gerais do campo

    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 íconeImage Removed.

    Excluir aba
    é possível excluir uma aba clicando no ícone de lixeiraImage Removed.

    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

    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.


    título que será exibido junto ao divisor.


    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titleAjuda e preenchimento

    Texto de ajuda
    subtexto que será exibido abaixo do divisor.

    Painel
    borderColor#8c8c8c
    bgColor#f2f2f2
    titlePersonalização

    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:

    Painel
    borderColor#f2f2f2
    bgColor#f2f2f2
    titleO 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 Image Added;

    02. Clique em Adicionar regra para incluir uma nova regra e selecione as informações para definir a regra.

    Painel
    borderColor#f2f2f2
    bgColor#f2f2f2

    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
    • E-mail
    • 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.

    Painel
    borderColor#000000
    bgColor#f2f2f2

    É possível filtrar regras já criadas no ícone Image Added


    Usar Analytics? Image Added

    ...

    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.

    Informações
    titleMas 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.

    Estado
    subtletrue
    titleExemplo
    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 01. Adicionar o campo desejado no editor de formulários;

    02. Nas propriedades do campo, localizar e clicar localize o agrupador Privacidade e dados e clique em Adicionar dado sensívelpessoal;

    03. Em Tipo do dado, selecionar selecione o tipo do dado que será coletado entre as opções abaixo:

    ...

    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.

    ...

    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. 

    ...

    No ícone Image Added é 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 RemoverImage Added.

    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

    ...

    .



    Informações
    titleFique atento!

    Esta documentação é válida a partir da  atualização xx - xxatualização Voyager (2.0). Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma.