Campos personalizados

Campos personalizados permitem anexar fIELDsestruturados adicionais a artigos, categorias de página, árvores de decisão e documentação da API. Em vez de depender apenas de metadados padrão como tags, título de SEO ou descrição, campos personalizados permitem que usuários, com permissões apropriadas, definam seus próprios campos e capturem informações específicas para sua documentação.

Por exemplo, uma equipe de documentação de produto pode querer adicionar campos como versão do produto, proprietário da funcionalidade, status de lançamento ou data da revisão de conteúdo. Esses campos podem ser criados no nível do projeto e depois configurados no nível do artigo.

Campos personalizados ajudam as equipes a organizar o conteúdo de forma mais eficaz, manter dados consistentes entre os artigos e suportar integrações que exigem informações estruturadas da base de conhecimento.

Acessando as configurações de campos personalizados

Para acessar os campos personalizados,

1. Navegue até Configurações () > Portal da base de conhecimento na barra de navegação esquerda.

2. No painel de navegação à esquerda, navegue até Campos personalizados.

A página Campos personalizados exibe uma grade contendo todos os campos personalizados existentes, incluindo o nome e o tipo de campo.

Criando um campo personalizado

Para criar um novo campo personalizado:

1. Navegue até Configurações () > Portal da base de conhecimento > Campos personalizados.

2. Clique em Criar campo Personalizado.

3. No diálogo Criar campo personalizado , configure os seguintes detalhes:

• Nome do campo
  Insira um nome único para o campo personalizado. Esse nome identifica o campo em todo o projeto.

  • O nome do campo é obrigatório e deve ser único

  • Suporta até 30 caracteres

  • Sem restrições sobre caracteres ou espaços especiais

• Tipo de campo
  Selecione o tipo de dado que o campo deve armazenar. Tipos de campo suportados incluem:

  • Texto (máximo 30 caracteres)

  • Área de texto (máximo 150 caracteres)

  • Menu suspenso (seleção simples) (máximo 30 caracteres por opção)

  • Menu suspenso (multi-seleção) (máximo 30 caracteres por opção)

  • Data

  • Booleano

  • Número

• Texto provisório (opcional)
  Adicione conteúdo temporário que aparece no campo antes de um valor ser inserido.

• Texto de ajuda (opcional)
  Forneça orientações adicionais para os colaboradores. Isso aparece como uma dica de ferramenta ao lado do campo nas configurações do artigo.

• Editando apenas via API

  
  

  Ative essa opção para tornar o campo somente leitura dentro do portal. Quando ativados, os valores dos campos só podem ser atualizados pela API.

4. Clique em Criar.

Uma vez criados, os Campos personalizados aparecem na grade e ficam disponíveis nas configurações do artigo.

NOTA

O tipo de campo não pode ser alterado após a criação do campo personalizado. Se for necessário um tipo de campo diferente, exclua o campo existente e crie um novo.

Gerenciando campos personalizados

Editores com permissões necessárias podem editar ou excluir campos personalizados do módulo Campos personalizados.

Editando um campo personalizado

1. Navegue até  Configurações () > Portal da base de conhecimento > Campos personalizados.

2. Localize o campo personalizado que você deseja modificar.

3. Clique em Editar ().

4. Atualize os detalhes do campo.

5. Clique em Atualizar.

Alterações feitas em um campo personalizado se aplicarão a todos os artigos onde o campo for utilizado.

NOTA

Permissões:

Usuários com permissões de Editor podem criar, editar e excluir campos personalizados. Para funções personalizadas, a permissão Campos Personalizados deve ser ativada para gerenciar configurações de campos.

Para atualizar valores de campos personalizados nas configurações do artigo, os usuários devem ter a permissão de Configurações de Artigo / Árvore de Decisão .

Colaboradores podem atualizar valores personalizados de campos nas configurações do artigo, a menos que o campo esteja configurado apenas como Editar via API.

Deletando um campo personalizado

1. Navegue até  Configurações () > Portal da base de conhecimento > Campos personalizados.

2. Localize o campo personalizado que você quer remover.

3. Usando o ícone Mais () ao lado do campo personalizado, clique em Deprimir.

4. Digite "SIM" na janela de confirmação de exclusão para prosseguir.

5. Clique em Excluir para confirmar.

NOTA

Deletar um campo personalizado remove permanentemente seus valores de todos os artigos associados.
Campos excluídos não podem ser restaurados.

Configuração de campos personalizados em artigos

Uma vez que um Campos personalizados é criado, os colaboradores podem configurar valores para ele nas configurações do artigo.

Para atualizar valores de campos personalizados:

1. Abra o artigo desejado no editor de documentação.

2. Clique no ícone Mais () no cabeçalho do artigo e selecione Mais opções de artigo.

3. No painel de configurações do artigo , localize a seção Campos personalizados .

4. Insira ou selecione o valor apropriado para cada campo.

5. Clique em Salvar.

NOTA

Valores personalizados de campo são armazenados para a versão mais recente publicada de um artigo e não são específicos de cada versão.

Auditoria de equipes

1. Navegue até Configurações () > Portal da base de conhecimento na barra de navegação da esquerda.

2. No painel de navegação esquerdo, navegue até Auditoria de Equipe.

   O registro de atividades exibe dados de todos os usuários, incluindo o evento, quem o realizou, e a data e hora.

3. Os logs de auditoria capturam ações como:

• Criando um campo personalizado

• Atualizando um campo personalizado

• Deletando um campo personalizado

• Atualização de valores de campos personalizados em artigos

A auditoria em equipe ajuda a acompanhar quem fez as alterações e quando.