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

 

Date de publication : novembre 2016

S’applique à : Dynamics CRM 2015

Avec Mise à jour 1 de Microsoft Dynamics CRM Online 2015 ou une version ultérieure, lorsque l'intégration de Parature est activée dans une organisation, il est possible d'ajouter aux formulaires un contrôle de recherche dans la base de connaissances. Ce contrôle fournit la prise en charge de la programmabilité pour automatiser ou améliorer l'expérience de l'utilisateur lors de son utilisation.

Important

Pour les organisations Microsoft Dynamics CRM Online, cette fonctionnalité n'est disponible que si votre organisation a effectué la mise à jour vers la mise à jour 1 de Dynamics CRM Online 2015. Cette fonctionnalité n'est pas disponible pour Dynamics CRM (local).

Ces événements et méthodes ne sont directement connectés à aucune API de Parature. Toutefois, si le contrôle est présent dans le formulaire, une connexion avec 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).

Le contrôle de recherche de gestion 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 ci-dessous utiliseront kbSearchControl pour représenter le contrôle de recherche de la Base de connaissances dans le formulaire.

Événements

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.

méthodes

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.

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();

getSelectedResult

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.getSelectedResult();

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 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 CRM.
articleUid	String	ID article unique pour le système Parature. Il contiendra l'ID de compte Parature 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à.
createdOn	Date	Date de création de l'article. Vous pouvez utiliser l'âge de l'article dans votre logique métier.
expiredDate	Date	Date à laquelle l'article a expiré ou expirera. 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.
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. 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é ou Brouillon. 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 le bureau de services Parature. Utilisez ce lien pour ouvrir l'article à l'aide du bureau de services Parature .
timesViewed	Number	Nombre de fois qu'un article est affiché sur le portail Parature par les clients.

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

Intégrer Microsoft Dynamics CRM 2015 avec Parature
Référence par programmation côté client
Écrire du code pour les formulaires Microsoft Dynamics CRM 2015
Écrire des extensions d’application cliente

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