Campos

Introdução

No NocoBase, Field (campo) é uma propriedade de negócio usada para descrever dados em uma Collection (tabela de dados). Ele descreve quais informações podem ser armazenadas em um registro e como essas informações podem ser inseridas, exibidas, filtradas e utilizadas na lógica de negócio da página.

DefiniçãoDescrição
Quais dados são armazenadosPor exemplo, texto, números, datas, arquivos, status, relações e JSON.
Como são usados na páginaPor exemplo, podem ser inseridos e exibidos por meio de campos de entrada, seletores de data, menus suspensos, upload de anexos e seletores de relações.
Como participam das funcionalidades de negócioOs campos são utilizados por blocos de página, filtros, ordenação, permissões, workflows, APIs, importação e exportação de dados, entre outras funcionalidades.

Eles podem corresponder a:

  • colunas reais do banco de dados no banco de dados principal
  • colunas existentes do banco de dados externo
  • campos em uma view do banco de dados
  • campos nos resultados de uma consulta SQL
  • campos nas respostas de uma API REST
  • campos de relação, campos do sistema ou campos virtuais em uma tabela de dados

Entenda-o como “uma propriedade de um objeto de negócio”. Por exemplo:

Objeto de negócioField correspondente
ClienteNome do cliente, número de celular, nível do cliente, responsável
PedidoNúmero do pedido, valor do pedido, status do pedido, cliente
ContratoNome do contrato, data de assinatura, anexos do contrato, status de aprovação
TarefaTítulo da tarefa, prazo, prioridade, executor
ArquivoNome do arquivo, tamanho, tipo MIME, URL

Cenários de uso

A seguir, os cenários de uso comuns são organizados por categoria de campo. Esta seção ajuda você a decidir primeiro qual categoria de campo escolher. Para consultar configurações específicas, mapeamentos de tipos e observações importantes, acesse a documentação da categoria correspondente.

Categoria de campoCenários de uso
Campos de textoAdequados para armazenar nomes, números, descrições, informações de contato, endereços de links e outros conteúdos.
Campos de rich textAdequados para armazenar textos principais, documentos explicativos, soluções de tratamento, trechos de código e outros conteúdos mais complexos.
Campos numéricosAdequados para armazenar quantidades, valores, pontuações, proporções e outros valores numéricos.
Campos de data e horaAdequados para armazenar pontos no tempo, datas, horários, timestamps de sistemas externos e outros conteúdos.
Campos de status e opçõesAdequados para armazenar valores dentro de um intervalo fixo, como se está habilitado, status do pedido, nível do cliente e etiquetas do cliente.
Campos de anexosAdequados para fazer upload de arquivos ou armazenar endereços de arquivos externos.
Campos de relaçãoAdequados para expressar conexões entre diferentes tabelas de dados, como um pedido pertencer a um cliente, um cliente possuir pedidos ou um usuário estar associado a funções.
Campos de identificação e codificaçãoAdequados para armazenar chaves primárias internas, IDs de sincronização externos, identificadores de acesso público e números de negócio.
Campos de formas geométricasAdequados para armazenar informações espaciais ou geográficas, como a localização de uma loja, rotas de entrega e áreas de atendimento.
Campos do sistemaAdequados para armazenar informações do sistema mantidas pelo NocoBase ou pelo banco de dados, como ID, data de criação, criador e data de atualização.
Outros camposAdequados para lidar com necessidades de campos que não se enquadram diretamente em outras categorias, como ordenação, fórmulas e JSON.

Tipos de Interface dos campos

O NocoBase divide os campos nas seguintes categorias sob a perspectiva de Interface:

20240512110352

Tipos de dados dos campos

Cada Field Interface possui um tipo de dados padrão. Por exemplo, para um campo cuja Interface é numérica (Number), o tipo de dados padrão é double, mas também pode ser float, decimal etc. Atualmente, os tipos de dados compatíveis são:

20240512103733

Mapeamento de tipos de campo

O fluxo para adicionar campos ao banco de dados principal é:

  1. Selecionar o tipo de Interface
  2. Configurar os tipos de dados disponíveis para a Interface atual

20240512172416

O fluxo de mapeamento de campos de uma fonte de dados externa é:

  1. Mapear automaticamente, com base no tipo de campo do banco de dados externo, o tipo de dados correspondente (Field type) e o tipo de UI (Field Interface).
  2. Modificar, conforme necessário, para tipos de dados e tipos de Interface mais adequados

20240512172759