Contrôle de recherche de la Base de connaissances (référence côté client)

 

Date de publication : janvier 2017

S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Vous pouvez ajouter un contrôle de Recherche dans la base de connaissances à votre instance de Dynamics 365 ayant la fonctionnalité de gestion des connaissances activée. Avec ce contrôle, vous pouvez automatiser ou améliorer par programme l'expérience des utilisateurs lorsqu'ils utilisent le contrôle pour utiliser des connaissances dans Dynamics 365.Pour plus d'informations :Entités de gestion des connaissances

Notes

• Vous pouvez choisir la base de connaissances Dynamics 365 native ou la base de connaissances Parature comme source de gestion des connaissances et de recherche. Si vous utilisez Parature comme source de base de connaissances et que le contrôle de la base de connaissances est présent dans le formulaire, une connexion à Parature doit déjà être établie pour pouvoir directement effectuer des appels API de Parature sans qu'un jeton de sécurité soit nécessaire. Toutefois, il s'agit de requêtes inter-domaines. Vous devez donc utiliser le partage des ressources cross-origin (CORS).

  Les nouvelles API clientes suivantes présentées dans Mise à jour 1 de CRM Online 2016 et Dynamics 365 Service Pack 1 (local) ne sont pas prises en charge si vous utilisez Parature comme source de la base de connaissances : événement PostSearch, addOnPostSearch, removeOnPostSearch, getTotalResultCount et openSearchResult.

• Avec le lancement de Mise à jour 1 de CRM Online 2016 et Dynamics 365 SP1 (local), le contrôle de recherche de la base de connaissances est également pris en charge pour les clients mobiles Dynamics 365 (téléphones et tablettes).

Le contrôle de recherche de la Base de connaissances est un contrôle Xrm.Page.ui. Il prend donc en charge toutes les méthodes standard des contrôles. Mais il prend également en charge d'autres événements et méthodes. Pour plus d'informations sur les méthodes standard des contrôles, voir Contrôle Xrm.Page.ui (référence côté client).

Si vous connaissez le nom du contrôle, vous pouvez y accéder à l'aide du code suivant, dans lequel <nom> représente le nom du contrôle.

kbSearchControl = Xrm.Page.getControl("<name>");

Notes

Lorsque le contrôle de recherche de la Base de connaissances est ajouté au volet social, le nom est « searchwidgetcontrol_notescontrol ». Ce nom ne peut pas être modifié.

Tous les exemples de cette rubrique utiliseront kbSearchControl pour représenter le contrôle de recherche de la Base de connaissances dans le formulaire.

Contenu de la rubrique

Événements du contrôle de recherche de la Base de connaissances

Méthodes de contrôle de recherche de la Base de connaissances

Événements du contrôle de recherche de la Base de connaissances

Utilisez les événements de ce contrôle pour autoriser le code à répondre à l'élément sélectionné ou ouvert.

OnResultOpened

Cet événement se produit lorsqu'un article de la Base de connaissances est ouvert dans le contrôle de recherche de la Base de connaissances en ligne ou via l'action d'ouverture dans une nouvelle fenêtre. Utilisez les méthodes addOnResultOpened et removeOnResultOpened pour gérer les gestionnaires d'événements pour cet événement.

OnSelection

Cet événement se produit lorsqu'un article de la Base de connaissances est sélectionnée dans le contrôle de recherche de la Base de connaissances. Utilisez les méthodes addOnSelection et removeOnSelection pour gérer les gestionnaires d'événements pour cet événement.

PostSearch

Cet événement se produit lorsque la recherche terminée, et les résultats sont affichés. Utilisez les nouvelles méthodes addOnPostSearch et removeOnPostSearch pour gérer les gestionnaires d'événements pour cet événement.

Méthodes de contrôle de recherche de la Base de connaissances

Utilisez les méthodes du contrôle de recherche de la Base de connaissances pour définir ou supprimer des gestionnaires d'événements et interagir avec la requête de recherche et les résultats de la recherche.

addOnPostSearch

Utilisez cette méthode pour ajouter un gestionnaire d'événements à l'événement PostSearch.

Paramètre : Fonction. Fonction à ajouter.

Exemple : ajoutez la fonction nommée myFunction à l'événement PostSearch.

kbSearchControl.addOnPostSearch(myFunction);

addOnResultOpened

Utilisez cette méthode pour ajouter un gestionnaire d'événements à l'événement OnResultOpened.

Paramètre : Fonction. Fonction à ajouter.

Exemple : ajoutez la fonction nommée myFunction à l'événement OnResultOpened.

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

Utilisez cette méthode pour ajouter un gestionnaire d'événements à l'événement OnSelection.

Paramètre : Fonction. Fonction à ajouter.

Exemple : ajoutez la fonction nommée myFunction à l'événement OnSelection.

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

Utilisez cette méthode pour obtenir le texte utilisé comme critère de recherche pour le contrôle de gestion de la Base de connaissances.

Valeur renvoyée : Chaîne. Texte de la requête de recherche.

Exemple : définissez la variable searchQuery pour le texte de la requête de recherche.

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResults

Utilisez cette méthode pour obtenir le résultat actuellement sélectionné du contrôle de recherche. Le résultat actuellement sélectionné représente également le résultat qui est actuellement ouvert.

Valeur renvoyée : KBSearchResult. Résultat actuellement sélectionné.

Exemple : définissez la variable kbSearchResult pour le résultat actuellement sélectionné.

var kbSearchResult = kbSearchControl.getSelectedResults();

Propriétés KBSearchResult

Le tableau suivant décrit les propriétés de l'objet KBSearchResult.

Propriété	Type	Description
answer	String	Balise HTML contenant le contenu de l'article. Vous pouvez transmettre ce contenu à une action personnalisée qui peut l'inclure dans un courrier électronique à envoyer au client.
articleId	String	ID de l'article dans Dynamics 365 ou dans un département Parature Cette valeur est utilisée comme clé secondaire. Vous pouvez l'utiliser pour voir si cet article existe déjà ou non dans Dynamics 365.
articleUid	String	ID article unique dans Dynamics 365 ou dans le système Parature. Lorsque vous utilisez Parature comme source de connaissances, celui-ci ca contenir l'ID de compte Paraturecompte ainsi que l'ID de service, par exemple,« 7924/8112/Article/25 ». Cette valeur est utilisée comme clé secondaire. Cet ID est nécessaire pour créer un enregistrement de la Base de connaissances en associant un article si aucun article n'existe déjà.
attachmentCount	Numéro	Nombre de pièces jointes dans l'article. Cela s'applique uniquement lorsque vous utilisez Parature comme source de la base de connaissances.
createdOn	Date	Date de création de l'article. Cette valeur utilise le fuseau horaire et le format de l'utilisateur actuel. Vous pouvez utiliser l'âge de l'article dans votre logique métier.
expiredDate	Date	Date à laquelle l'article a expiré ou expirera. Elle est null lorsque vous utilisez Dynamics 365 comme source de la base de connaissances. Vous pouvez comparer cette date aux données actuelles pour déterminer si l'article a expiré ou non. La valeur utilise le fuseau horaire et le format de l'utilisateur actuel.
folderHref	Chaîne	Lien vers le chemin d'accès au dossier de l'article dans Parature. Cela s'applique uniquement lorsque vous utilisez Parature comme source de la base de connaissances.
href	Chaîne	Lien direct vers l'article dans l'API Parature qui peut être utilisé pour obtenir le contenu de l'article directement. Cela s'applique uniquement lorsque vous utilisez Parature comme source de la base de connaissances.
isAssociated	Boolean	Indique si l'article est associé ou non à l'enregistrement parent. Vous pouvez vérifier cette valeur avant d'associer l'article à l'enregistrement actif à l'aide de scripts de formulaire ou dans un autre processus initié par des scripts de formulaire.
lastModifiedOn	Date	Date de la dernière modification de l'article. Cette valeur utilise le fuseau horaire et le format de l'utilisateur actuel.
publicUrl	String	URL du portail de support de l'article. Si l'option URL du portail est désactivée, elle sera vide. Utilisez une action personnalisée pour l'inclure dans un lien compris dans le contenu d'un courrier électronique à envoyer à un client.
published	Boolean	Indique si l'état de l'article est Publié.True si l'état est Publié ; sinon False. Vous devez vérifier si l'article est publié avant d'envoyer des informations le concernant à un client.
question	String	Titre de l'article. Si vous référencez l'article dans un processus métier, vous pouvez y faire référence par son nom à l'aide de cette valeur.
rating	Number	Évaluation de l'article.
searchBlurb	String	Court extrait du contenu de l'article qui contient les domaines dans lesquels la requête de recherche a été lancée. Utilisez-le pour offrir un aperçu de l'article aux utilisateurs dans la liste de recherche et pour les aider à déterminer s'il s'agit de l'article qu'ils recherchent.
serviceDeskUri	String	Lien vers l'article dans Dynamics 365 ou le bureau de services Parature. Utilisez ce lien pour ouvrir l'article à l'aide de Dynamics 365 ou du bureau de services Parature .
timesViewed	Number	Nombre de fois qu'un article est affiché sur le portail par les clients.

getTotalResultCount

Affiche le nombre de résultats trouvés dans le contrôle de recherche.

Valeur de retour : Entier. Le nombre de résultats de la recherche.

Exemple : Définissez la variable searchCount sur le nombre de résultats de la recherche dans le contrôle de recherche.

var searchCount = kbSearchControl.getTotalResultCount();

openSearchResult

Ouvre un résultat de recherche dans le contrôle de recherche en spécifiant le nombre de résultats.

var openResultStatus = kbSearchControl.openSearchResult(resultNumber, mode);

Arguments

• resultNumber (Integer) : Valeur numérique indiquant le nombre de résultats à ouvrir. Le nombre de résultats commence à partir de 1. Obligatoire.

• mode (String) : Spécifiez « Inline » ou « Popout ». Facultatif. Si vous ne spécifiez pas une valeur pour l'argument, l'option par défaut (« Inline ») est utilisée.

  Le mode « Inline » ouvre le résultat inclus dans le volet de lecture du contrôle ou dans un nouvel onglet intitulé panneau de référence en cas de panneau de référence. Le mode « Popout » ouvre le résultat dans une fenêtre contextuelle.

Valeur de retour : : Booléenne Statut d'ouverture du résultat de la recherche spécifié. Renvoie 1 en cas de réussite ; 0 en cas d'échec. La méthode renverra -1 si la valeur resultNumber spécifiée n'est pas présente ou, si la valeur mode spécifiée n'est pas valide.

removeOnPostSearch

Utilisez cette méthode pour supprimer un gestionnaire d'événements de l'événement PostSearch.

Paramètre : Fonction. Fonction à supprimer.

Exemple : supprimez la fonction nommée myFunction de l'événement PostSearch.

kbSearchControl.removeOnPostSearch(myFunction);

removeOnResultOpened

Utilisez cette méthode pour supprimer un gestionnaire d'événements de l'événement OnResultOpened.

Paramètre : Fonction. Fonction à supprimer.

Exemple : supprimez la fonction nommée myFunction de l'événement OnResultOpened.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

Utilisez cette méthode pour supprimer un gestionnaire d'événements de l'événement OnSelection.

Paramètre : Fonction. Fonction à supprimer.

Exemple : supprimez la fonction nommée myFunction de l'événement OnSelection.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

Utilisez cette méthode pour définir le texte utilisé comme critère de recherche pour le contrôle de gestion de la Base de connaissances.

Paramètre : Chaîne. Texte pour la requête de recherche.

Exemple : définissez le texte de la recherche sur « How to solve the problem ».

kbSearchControl.setSearchQuery("How to solve the problem");

Voir aussi

Utiliser les articles de la Base de connaissances dans Dynamics 365
Utiliser la Base de connaissances Parature dans Dynamics 365
Référence par programmation côté client
Écrire du code pour les formulaires Microsoft Dynamics 365
Étendre Microsoft Dynamics 365 sur le client

Microsoft Dynamics 365

© 2017 Microsoft. Tous droits réservés. Copyright