Ajouter du contenu personnalisé Aide incorporée

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture

    • Vous pouvez créer une nouvelle rubrique d’aide incorporée personnalisée, par exemple, si vous avez une application personnalisée et que vous souhaitez fournir de l’aide aux utilisateurs.

    Avant de commencer

    Rôle requis : embedded_help_admin ou admin

    Pourquoi et quand exécuter cette tâche

    Lorsque vous rédigez du contenu pour vos utilisateurs, gardez à l’esprit les limites suivantes.
    • 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 le code source <<>> vue. Le contenu vidéo de YouTube et Vimeo est pris en charge.
    • Pour ajouter un lien d’informations connexes, vous devez utiliser une URL complète et non une URL relative.
    • La meilleure pratique consiste à ne pas utiliser l’outil Mettre en surbrillance le texte, car la couleur peut rendre le texte illisible selon le thème sélectionné par l’utilisateur.
    • Les modifications que vous apportez à l’aide incorporée ne sont pas automatiquement déployées sur 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.
    Remarque :
    Les enregistrements d’aide incorporés sont également utilisés pour créer du contenu pour le Help Center fichier dans un espace de travail configurablefichier . Pour plus d'informations, consultez Créer du Help Center contenu pour les espaces de travail configurables.

    Procédure

    1. Accédez à la Tous > Aide incorporée > Contenu de l'aide.
    2. Cliquez sur Nouveau.
    3. Complétez le formulaire.
      Champ Description
      Nom Saisissez le nom de la rubrique d’aide incorporée. Un nom typique est le titre de la page à laquelle il s’applique.
      Page Entrez la page de l’interface utilisateur pour laquelle ce contenu fournit de l’aide, sans l’extension de fichier .do.

      Nom de la page dans l’URL

      Remarque :
      Si vous utilisez l’enregistrement d’aide incorporée pour l’afficher dans , Help Centercomme décrit dans Créer du Help Center contenu pour les espaces de travail configurables, saisissez la même valeur dans les champs Nom et Page, en remplaçant les espaces par des traits de soulignement dans le champ Page.
      Modificateur Sélectionnez le modificateur, généralement Normal.
      • 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.
      Rôle Sélectionnez le rôle pour lequel la rubrique est écrite.

      Tous les rôles qui contiennent le rôle voient également le contenu, à moins qu’une autre rubrique liée à leur rôle n’existe pour la même page.Pour plus d'informations, voir Aide incorporée rôles
      Actif Cochez la case pour afficher ce contenu. Décochez la case pour empêcher le contenu d’être disponible, par exemple, pour que quelqu’un le vérifie avant d’y accéder sur la page de l’interface utilisateur.
      Produit Enterprise est la valeur par défaut et ne doit pas être modifiée.
      Qualificateur Le qualificateur qui fournit une aide incorporée personnalisée pour une page d’interface utilisateur commune.

      Par exemple, la page de home.do est ouverte pour chaque module de page d’accueil et pour de nombreux modules de tableau de bord. Créez le qualificateur avant de le saisir dans cet enregistrement d’aide incorporée.

      Remarque :
      Les ID dynamiques sont pris en charge dans les paramètres d’acheminement du qualificatif d’aide incorporé. Par exemple, l’ajout de $dynamic_value$ dans le champ fragment rend votre contenu disponible pour la même URL, même lorsque la valeur change. Cela peut se produire lors de la sélection de différentes langues pour la même page.
      Version Sélectionnez une version, si elle est différente de la version actuelle de votre instance. Pour fournir du contenu pour une application personnalisée ou des informations pertinentes pour le processus business de votre organisation, sélectionnez Tout.
      Ordre Modifiez le rôle par défaut, si nécessaire. L’ordre par défaut est basé sur le rôle sélectionné. Pour plus d’informations sur les numéros de priorité de commande par défaut, reportez-vous à Aide incorporée rôles.
      Domaine Spécifiez le domaine pour lequel ce contenu est utilisé, le cas échéant.

      Ce champ apparaît dans le formulaire si l’administrateur a configuré le formulaire pour l’afficher.
    4. Dans le champ Contenu , saisissez le texte à l’aide des outils de mise en forme HTML selon vos besoins.
      Si vous ajoutez un lien, saisissez l’URL complète de la page Web. Une bonne pratique consiste à sélectionner Nouvelle fenêtre (_blank) comme cible.
      Remarque :
      N’ajoutez pas d’images dans une rubrique d’aide incorporée. Les images sont supprimées de la section de contenu lors de la sauvegarde de l’enregistrement.

      Pour ajouter une vidéo incorporée, reportez-vous à la section Intégrer du contenu vidéo dans des rubriques d’aide.

    5. Facultatif : Pour ajouter une autre ligne sous les tableaux, les vidéos ou les liens connexes, cliquez sur l’icône de nouvelle ligne (⏎).
    6. Cliquez sur Envoyer.