Utiliser des qualificateurs dans Aide incorporée

L’administrateur de l’aide incorporée peut utiliser des qualificateurs pour personnaliser le contenu d’une page commune dans l’instance.

Avant de commencer

Rôle requis : embedded_help_admin

Pourquoi et quand exécuter cette tâche

La page de home.do est ouverte pour chaque module de page d’accueil et pour de nombreux modules de tableau de bord. Les paramètres de requête spécifiés dans l’URL définissent la page d’accueil à ouvrir.

Imaginez que votre organisation souhaite fournir des instructions spécifiques pour la page d’accueil du SLA. Vous pouvez écrire du contenu d’aide incorporée personnalisé et utiliser un qualificateur pour atteindre cet objectif. Créez le qualificateur, puis associez-le au contenu d’aide incorporée personnalisé que vous écrivez.

Procédure

1. Pour obtenir les informations du qualificateur, ouvrez le module dans une nouvelle fenêtre de navigateur et copiez le paramètre de requête.
   Notez que le paramètre de requête utilise des traits de soulignement entre les mots au lieu de tirets ou de tirets.

   

   Vous pouvez également sélectionner le paramètre de requête à partir du champ Arguments sur le type de lien de module. Pour afficher le type de lien du module, cliquez sur l’icône de crayon en regard du module dans le navigateur d’application, puis cliquez sur l’onglet Type de lien .

2. Accédez à la Aide incorporée > Qualificateurs d'aide, puis cliquez sur Nouveau.
3. Complétez le formulaire.

   Tableau 1. Formulaire Qualificatif d’aide incorporé

   Champ	Description
   Chemin d'accès	Entrez dans la page pour afficher le contenu de l’aide incorporée. N’incluez pas .do. Par exemple, pour la page d’accueil SLA, saisissez accueil.
   Paramètres de requête	Saisissez les paramètres de requête ou l’argument de lien au format id=query_parameters. Avertissement : Si le paramètre de requête contient plusieurs mots, utilisez des traits de soulignement entre les mots plutôt que des tirets ou des tirets. Si vous utilisez des tirets ou des tirets, le système n’utilise que le premier mot du paramètre et ignore le reste.
   Fragment	Entrez le #<string> à la fin de l’URL. Il est rare qu’il se trouve dans l’URL d’une page de l’instance. Si vous souhaitez une aide personnalisée pour une page qui se termine par #<string>, placez-la dans ce champ. Remarque : La pratique éprouvée consiste à inclure au moins un paramètre de requête. Si ce n’est pas le cas, l’aide personnalisée s’affiche pour chaque page home.do . Vous pouvez utiliser le paramètre de requête, le fragment ou les deux.
   Qualificateur	Saisissez le qualificatif à utiliser, par exemple sla_homepage. Enregistrez le qualificateur à utiliser dans l’enregistrement de contenu d’aide incorporée. Avertissement : Si le paramètre de requête contient plusieurs mots, utilisez des traits de soulignement entre les mots plutôt que des tirets ou des tirets. Si vous utilisez des tirets ou des tirets, le système n’utilise que le premier mot du paramètre et ignore le reste.

4. Cliquez sur Envoyer.
5. Suivez les étapes décrites dans Ajouter du contenu personnalisé Aide incorporée pour créer le contenu et incluez les informations suivantes.
   • Nom et page : la page pour laquelle vous avez créé le qualificateur, par exemple, la page d’accueil.
   • Qualificateur : le qualificateur que vous avez saisi, par exemple sla_homepage.

   Remarque :

   Vous pouvez également copier une rubrique d’aide incorporée existante et saisir le qualificateur dans l’enregistrement copié.
6. Testez le qualificateur en ouvrant la page pour laquelle vous avez ajouté le contenu, puis en ouvrant le panneau d’aide.
   Remarque :

   Si vous avez ajouté un rôle au contenu d’aide incorporée, assurez-vous d’être connecté en tant qu’utilisateur doté du rôle ou empruntez l’identité d’un utilisateur ayant ce rôle.