Champs personnalisés

Les champs personnalisés permettent d’attacher des IELDstructurés supplémentaires aux articles, aux catégories de pages, aux arbres de décision et à la documentation de l’API. Au lieu de se reposer uniquement sur des métadonnées par défaut telles que les tags, le titre SEO ou la description, les champs personnalisés permettent aux utilisateurs, avec les permissions appropriées, de définir leurs propres champs et de capturer des informations spécifiques à leur documentation.

Par exemple, une équipe de documentation produit peut vouloir ajouter des champs tels que la version produit, le propriétaire de la fonctionnalité, le statut de la sortie ou la date de révision du contenu. Ces champs peuvent être créés au niveau du projet puis configurés au niveau de l’article.

Les champs personnalisés aident les équipes à organiser le contenu plus efficacement, à maintenir des données cohérentes entre les articles et à soutenir des intégrations nécessitant des informations structurées provenant de la base de connaissances.

Accès aux paramètres personnalisés des champs

Pour accéder aux champs personnalisés,

1. Naviguez dans () > Knowledge base portal dans la barre de navigation de gauche.

2. Dans le panneau de navigation de gauche, naviguez vers Custom fields.

La page Custom fields affiche une grille contenant tous les champs personnalisés existants, y compris le nom et le type de champ.

Création d’un champ personnalisé

Pour créer un nouveau champ personnalisé :

1. Naviguez dans () > Knowledge base portal > Custom fields.

2. Cliquez sur Créer un champ personnalisé.

3. Dans la boîte de dialogue Créer un champ personnalisé , configurez les détails suivants :

• Nom du champ
  Saisissez un nom unique pour le champ personnalisé. Ce nom désigne le champ à travers le projet.

  • Le nom du champ est obligatoire et doit être unique

  • Prend en charge jusqu’à 30 caractères

  • Aucune restriction sur les caractères ou espaces spéciaux

• Type de champ
  Sélectionnez le type de données que le champ doit stocker. Les types de champs pris en charge incluent :

  • Texte (maximum 30 caractères)

  • Zone de texte (maximum 150 caractères)

  • Menu déroulant (simple sélection) (maximum 30 caractères par option)

  • Menu déroulant (sélection multiple) (maximum 30 caractères par option)

  • Date

  • Booléen

  • Numéro

• Texte de remplacement (optionnel)
  Ajoutez du contenu temporaire qui apparaît dans le champ avant qu’une valeur ne soit saisie.

• Texte d’aide (optionnel)
  Fournir des conseils supplémentaires aux contributeurs. Cela apparaît sous forme d’infobulle à côté du champ dans les paramètres de l’article.

• Édition via API uniquement

  
  

  Activez cette option pour rendre le champ en lecture seule dans le portail. Une fois activées, les valeurs des champs ne peuvent être mises à jour que via l’API.

4. Cliquez sur Créer.

Une fois créés, les Custom fields apparaissent dans la grille et deviennent disponibles dans les paramètres de l’article.

NOTE

Le type de champ ne peut pas être modifié après la création du champ personnalisé. Si un type de champ différent est requis, supprimez le champ existant et créez-en un nouveau.

Gestion des champs personnalisés

Les éditeurs disposant des autorisations requises peuvent modifier ou supprimer des champs personnalisés du module Custom fields.

Modification d’un champ personnalisé

1. Naviguez dans   () > Knowledge base portal > Custom fields.

2. Localisez le champ personnalisé que vous souhaitez modifier.

3. Cliquez sur Modifier ().

4. Mettez à jour les détails du terrain.

5. Cliquez sur Mettre à jour.

Les modifications apportées à un champ personnalisé s’appliqueront à tous les articles où ce champ est utilisé.

NOTE

Autorisations :

Les utilisateurs disposant des permissions d’éditeur peuvent créer, modifier et supprimer des champs personnalisés. Pour les rôles personnalisés, la permission Champs personnalisés doit être activée pour gérer les configurations de champs.

Pour mettre à jour les valeurs personnalisées des champs dans les paramètres de l’article, les utilisateurs doivent avoir la permission de paramètres Article / Arbre de décision .

Les contributeurs peuvent mettre à jour les valeurs des champs personnalisés dans les paramètres de l’article, sauf si le champ est configuré comme Modifier uniquement via API.

Suppression d’un champ personnalisé

1. Naviguez dans   () > Knowledge base portal > Custom fields.

2. Localisez le champ personnalisé que vous souhaitez supprimer.

3. En utilisant l’icône More () à côté du champ personnalisé, cliquez sur Supprimer.

4. Tapez « OUI » dans la fenêtre de confirmation de suppression pour continuer.

5. Cliquez sur Supprimer pour confirmer.

NOTE

Supprimer un champ personnalisé supprime définitivement ses valeurs de tous les articles associés.
Les champs supprimés ne peuvent pas être restaurés.

Configuration de champs personnalisés dans les articles

Une fois un Custom fields créé, les contributeurs peuvent configurer des valeurs dans les paramètres de l’article.

Pour mettre à jour les valeurs personnalisées des champs :

1. Ouvrez l’article souhaité dans l’éditeur de documentation.

2. Cliquez sur l’icône Plus () dans l’en-tête de l’article et sélectionnez Plus d’options d’article.

3. Dans le panneau des paramètres de l’article , localisez la section Custom fields .

4. Entrez ou sélectionnez la valeur appropriée pour chaque champ.

5. Cliquez sur Enregistrer.

NOTE

Les valeurs de champs personnalisées sont stockées pour la dernière version publiée d’un article et ne sont pas spécifiques à chaque version.

Audit d’équipe

1. Naviguez dans () > Knowledge base portal dans la barre de navigation de gauche.

2. Dans le panneau de navigation de gauche, naviguez jusqu’à audit de l’équipe.

   Le journal d’activité affiche les données de tous les utilisateurs, y compris l’événement, qui l’a organisé, ainsi que la date et l’heure.

3. Les journaux d’audit capturent des actions telles que :

• Création d’un champ personnalisé

• Mise à jour d’un champ personnalisé

• Suppression d’un champ personnalisé

• Mise à jour des valeurs de champs personnalisées dans les articles

L’audit en équipe aide à suivre qui a apporté des modifications et quand.