Voltar à Documentação

Criando e gerenciando Records

Este guia mostra o passo a passo para trabalhar com dados estruturados no Sutram: definir os campos de metadados, montar uma categoria de registro, criar registros e mantê-los. Se ainda não leu o conceito, comece por Records e Metadados: dados estruturados no Sutram.

Antes de começar: Records requerem um plano pago (a partir do Pro). Definir categorias e metadados é uma ação de proprietário ou administrador; criar registros está aberto também a membros.

Visão geral do fluxo

Montar um tipo de registro tem três etapas, feitas uma única vez; depois, criar registros é rápido e repetível.

1. Definir os campos       →  Definições de Metadados
2. Montar o molde          →  Categoria de Registro
3. Criar as entradas       →  Records

Passo 1: Defina os campos de metadados

Os campos são definidos uma vez e reutilizados por várias categorias.

  1. Nas configurações do projeto, abra Definições de Metadados (Tag Definitions)
  2. Crie cada campo informando:
    • uma chave (identificador, ex.: autor)
    • um rótulo (o nome exibido, ex.: "Autor")
    • um tipo: texto, enum, booleano, data ou computado
  3. Para campos enum, liste os valores permitidos (ex.: elétrica, mecânica, civil)
  4. Para numeração automática, crie um campo computado

Nota: apenas proprietário e administrador gerenciam definições de metadados.

Passo 2: Monte a categoria de registro

A categoria é o molde que reúne os campos e define o slug.

  1. Nas configurações do projeto, abra Categorias de Registro (Folder Categories)
  2. Crie uma categoria e dê um nome (ex.: "Nota fiscal")
  3. Adicione os campos de metadados que ela usa, marcando quais são obrigatórios e definindo a ordem
  4. Configure o slug:
    • se usar numeração, indique quais campos formam a base numérica (computed_from)
    • indique quais campos compõem o slug final (slug_from)
  5. Salve

A partir daqui, todo registro criado com essa categoria terá os campos conferidos e o slug gerado automaticamente.

Passo 3: Crie um registro

  1. Na aba Conteúdo, navegue até a pasta onde o registro deve ficar
  2. Clique em Novo registro e escolha a categoria
  3. Preencha os campos de metadados — os obrigatórios são validados na hora
  4. Confirme

O Sutram gera o slug automaticamente e cria o registro (um Record que corresponde a uma pasta com seus metadados). Registros que compartilham a mesma base numérica recebem números sequenciais distintos, sem colisão.

Passo 4: Edite e mantenha

  • Atualizar metadados: abra o registro e edite os campos. Se você alterar um campo que compõe o slug, o identificador pode ser recalculado.
  • Alterar apenas um campo: é possível ajustar um único metadado sem reescrever os demais.
  • Excluir: remover um registro apaga a pasta e todo o seu conteúdo — a ação não pode ser desfeita.

Fazendo tudo isso com IA (MCP)

Todas essas operações também podem ser feitas por um assistente de IA conectado via Sutram MCP Server — útil para criar registros em lote, padronizar metadados ou migrar conteúdo. Exemplos do que pedir:

  • "Crie uma categoria de registro 'Contrato' com os campos parte, valor, data e status."
  • "Cadastre estes 20 contratos como registros, preenchendo os metadados a partir da planilha."

A referência das ferramentas de Records está no Guia do Sutram MCP Server. Antes de criar registros em lote, peça à IA para conferir os campos exigidos pela categoria.

Dicas

  • Comece pequeno — defina os campos essenciais primeiro; dá para acrescentar depois.
  • Enum > texto livre para valores conhecidos — evita divergências como "Civil" vs "eng civil".
  • Planeje o slug antes de criar em massa — os campos do slug_from viram o endereço durável do registro.
  • Reaproveite campos — o mesmo campo (ex.: autor) pode servir a várias categorias.

Perguntas Frequentes

P: Quem pode criar categorias e quem pode criar registros?

R: Categorias e definições de metadados são geridas por proprietário e administrador. Criar e editar registros está aberto também a membros. Visualizadores apenas leem.

P: Posso adicionar um campo novo a uma categoria já em uso?

R: Sim. Categorias evoluem; registros existentes continuam válidos. Tenha cautela apenas ao mexer em campos que compõem o slug, pois isso afeta o cálculo do identificador.

P: O slug pode repetir?

R: Não. A base numérica (computed_from) garante numeração sequencial única dentro de cada chave, então dois registros nunca colidem.

Próximos Passos

  • Records e Metadados — o conceito por trás do que você acabou de fazer
  • Wiki e Grafo de Conhecimento — como os registros alimentam a wiki e o grafo
  • Guia do Sutram MCP Server — a referência das ferramentas de Records para uso com IA

Versão do Documento: 1.0 Última Atualização: Julho de 2026 Autor: Equipe de Desenvolvimento Sutram

Voltar à Documentação