Aide incorporée planification

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture
  • Avant d’écrire une aide incorporée personnalisée, planifiez le contenu et notez les informations utilisées dans le formulaire d’aide incorporée. Une planification minutieuse permet de s’assurer que la rubrique apparaît pour la bonne page et le bon rôle.

    Chaque page de l’interface utilisateur peut afficher l’aide incorporée, spécifiée dans le champ Page , comme illustré dans l’exemple suivant.

    Figure 1. Rubrique d’aide incorporée pour la page d’accueil de Catalogue de services
    Nom de la page dans l’URL pointant vers le nom de la page dans le formulaire

    Lors de la planification des rubriques d’aide incorporées, réfléchissez à la façon dont les champs suivants sont utilisés et notez les valeurs dont vous avez besoin pour vos rubriques personnalisées.

    Page
    Identifiez et notez le nom de page de l’interface utilisateur qui se trouve dans l’URL lorsque la page s’affiche comme indiqué. Si le nom de la page commence par un signe dollar, tel que $mid_server_user, incluez le signe dollar dans le nom de la page. Avant d’écrire une rubrique d’aide incorporée pour la page, recherchez le nom de la page pour localiser un fichier que vous pouvez copier.
    Modificateur
    • Le contenu normal s’affiche pour tout utilisateur disposant du rôle approprié qui accède à la page.
    • Le contenu de la configuration s’affiche lorsque la page est accessible à partir d’un lien dans la configuration guidée.

    De nombreuses rubriques d’aide incorporées dans le système de base sont destinées à la configuration guidée. Vous pouvez copier le contenu de configuration et changer le modificateur en Normal pour fournir rapidement de l’aide à tous les utilisateurs.

    Qualificateur
    Identifiez les pages pour lesquelles vous souhaitez une aide personnalisée et qui sont utilisées dans de nombreuses applications. Par exemple, la page home.do s’ouvre pour chaque module de page d’accueil et pour de nombreux modules de tableau de bord. L’administrateur de l’aide incorporée peut utiliser des qualificateurs pour personnaliser le contenu d’une page commune dans l’instance.
    Rôle
    Spécifiez le rôle de niveau le plus bas pour fournir l’accès à cette rubrique d’aide incorporée. Tous les rôles qui contiennent le rôle voient également le contenu, sauf si une autre rubrique ciblée sur leur rôle existe pour la même page.

    Par exemple, si vous ajoutez du contenu d’aide incorporée pour le rôle itil qui décrit votre processus business de saisie des incidents, le rôle itil_admin voit également le contenu. Si vous écrivez une rubrique différente avec le rôle itil_admin, le itil_admin voit ce contenu au lieu du contenu itil.

    Produit
    Rédigez du contenu uniquement pour la rubrique Entreprise . Vous pouvez copier une rubrique Express et modifier ce champ en Entreprise , le cas échéant.
    Version
    Le contenu du système de base est généralement spécifié dans la version logicielle actuelle. Si vous modifiez le contenu d’une application personnalisée ou si vous souhaitez fournir des informations pertinentes pour le processus business de votre organisation, sélectionnez Tout.
    Domaine
    Si votre organisation utilise Séparation de domaine et personnalise le contenu de l’aide, spécifiez le domaine auquel le contenu s’applique.
    ServiceNow Aide
    Si la case est cochée, ce champ indique une rubrique du système de base. Vous ne pouvez pas modifier une rubrique du système de base, mais vous pouvez en créer une copie pour ajouter du contenu personnalisé.
    Contenu
    Vous pouvez utiliser les outils de mise en forme pour mettre en forme le contenu. La liste suivante décrit les limitations.
    • Vous ne pouvez pas inclure d’images dans le contenu de l’aide incorporée.
    • Pour intégrer une vidéo, vous devez coder les informations de la vidéo dans la vue <<>> code source. Le contenu vidéo de YouTube et Vimeo est pris en charge.
    • Pour ajouter un lien d’information connexe, vous devez utiliser une URL complète et non une URL relative.
    • Il est recommandé de ne pas utiliser l’outil Mettre en surbrillance le texte, car la couleur peut rendre le texte illisible en fonction du thème que l’utilisateur a sélectionné.
    • Les modifications que vous apportez à l’aide incorporée ne sont pas automatiquement déployées dans une autre instance.
    • Les changements apportés à la table d’aide incorporée ne sont pas capturés dans les ensembles de mises à jour, update_sync=false est défini intentionnellement.