Delen via

Zoekbesturingselement voor Knowledge Base (clientreferentie)

  • Artikel

 

Gepubliceerd: januari 2017

Is van toepassing op: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

U kunt een besturingselement voor een Knowledge Base-zoekactie toevoegen aan uw exemplaar van Dynamics 365 waarin de kennisbeheerfunctie is ingeschakeld. Met dit besturingselement kunt u de zoekervaringen van gebruikers via programmering automatiseren of verbeteren, als ze het besturingselement gebruiken om kennis te gebruiken in Dynamics 365.Meer informatie:Kennisbeheer-entiteiten

Notitie

  • U kunt de systeemeigen Dynamics 365-kennis of Parature-kennis kiezen als bron voor kennisbeheer en zoekacties. Als u echter Parature als uw Knowledge Base-bron gebruikt en het zoekbesturingselement voor Knowledge Base aanwezig is in het formulier, zou reeds een verbinding met Parature tot stand moeten zijn gebracht zodat u direct Parature-API-aanroepen kunt doen zonder dat een beveiligingstoken is vereist. Dit zijn echter domeinoverschrijdende aanvragen, dus moet u CORS (Cross-Origin Resource Sharing) gebruiken.

    De volgende nieuwe client-API's die zijn geïntroduceerd in CRM Online 2016 Update 1 en het Dynamics 365 Service Pack 1 (on-premises), worden niet ondersteund als u Parature gebruikt als uw Knowledge Base-bron: de gebeurtenis PostSearch, addOnPostSearch, removeOnPostSearch, getTotalResultCount en openSearchResult.

  • Met de releases CRM Online 2016 Update 1 en SP1 (on-premises) van Dynamics 365 wordt het zoekbesturingselement voor de Knowledge Base ook ondersteund voor de mobiele clients van Dynamics 365 (mobiele telefoons en tablets).

Het zoekbesturingselement voor Knowledge Base is een Xrm.Page.ui-besturingselement, dus het ondersteunt alle standaardmethoden waarover besturingselementen beschikken. Maar het ondersteunt tevens extra gebeurtenissen en methoden. Zie Xrm.Page.ui control (referentie aan de clientzijde) voor informatie over de standaardmethoden van besturingselementen.

Als u de naam van het besturingselement weet, kunt u hier toegang toe krijgen met de volgende code, waarbij <naam> de naam van het besturingselement aangeeft.

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

Notitie

Wanneer het besturingselement Zoeken in Knowledge Base wordt toegevoegd, wordt de naam van het sociale deelvenster "searchwidgetcontrol_notescontrol". Deze naam kan niet worden gewijzigd.

Alle exemplaren in dit onderwerp gebruiken kbSearchControl om het zoekbesturingselement voor Knowledge Base weer te geven in het formulier.

In dit onderwerp

Gebeurtenissen voor zoekbesturingselement voor Knowledge Base

Methoden voor zoekbesturingselement voor Knowledge Base

Gebeurtenissen voor zoekbesturingselement voor Knowledge Base

Gebruik de gebeurtenissen voor dit besturingselement om code in staat te stellen te reageren op het geselecteerde of geopende item.

OnResultOpened

Deze gebeurtenis doet zich voor als een KB-artikel wordt geopend in het besturingselement Zoeken in Knowledge Base via In venster of via de actie Nieuw venster. Gebruik de methoden addOnResultOpened en removeOnResultOpened om gebeurtenishandlers voor deze gebeurtenis te beheren.

OnSelection

Deze gebeurtenis doet zich voor als een KB-artikel wordt geselecteerd in het besturingselement Zoeken in Knowledge Base. Gebruik de methoden addOnSelection en removeOnSelection om gebeurtenishandlers voor deze gebeurtenis te beheren.

PostSearch

Deze gebeurtenis vindt plaats wanneer de zoekactie is voltooid en de resultaten worden weergegeven. Gebruik de nieuwe methoden addOnPostSearch en removeOnPostSearch om gebeurtenishandlers voor deze gebeurtenis te beheren.

Methoden voor zoekbesturingselement voor Knowledge Base

Gebruik de methoden voor het besturingselement Zoeken in Knowledge Base om gebeurtenishandlers in te stellen of te verwijderen en interacties uit te voeren met de zoekquery en zoekresultaten.

addOnPostSearch

Gebruik deze methode om een gebeurtenishandler toe te voegen aan de gebeurtenis PostSearch.

Parameter: Functie. De toe te voegen functie.

Voorbeeld: Voeg de functie met de naam myFunction toe aan de gebeurtenis PostSearch.

kbSearchControl.addOnPostSearch(myFunction);

addOnResultOpened

Gebruik deze methode om een gebeurtenishandler toe te voegen aan de gebeurtenis OnResultOpened.

Parameter: Functie. De toe te voegen functie.

Voorbeeld: Voeg de functie met de naam myFunction toe aan de gebeurtenis OnResultOpened.

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

Gebruik deze methode om een gebeurtenishandler toe te voegen aan de gebeurtenis OnSelection.

Parameter: Functie. De toe te voegen functie.

Voorbeeld: Voeg de functie met de naam myFunction toe aan de gebeurtenis OnSelection.

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

Gebruik deze methode om de tekst op te halen die wordt gebruikt als zoekcriterium voor het besturingselement Knowledge Base-beheer.

Retourwaarde: Tekenreeks. De tekst van de zoekquery.

Voorbeeld: Stel de variabele searchQuery in op de tekst van de zoekquery.

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResults

Gebruik deze methode om het huidige geselecteerde resultaat van het besturingselement Zoeken op te halen. Het huidige geselecteerde resultaat staat tevens voor het resultaat dat momenteel is geopend.

Retourwaarde: KBSearchResult. Het huidige geselecteerde resultaat.

Voorbeeld: Stel de variabele kbSearchResult in op het huidige geselecteerde resultaat.

var kbSearchResult = kbSearchControl.getSelectedResults();

Eigenschappen van KBSearchResult

In de volgende tabel worden de eigenschappen van het object KBSearchResult beschreven.

Eigenschap

Type

Beschrijving

answer

String

De HTML-markering die de inhoud van het artikel bevat.

U kunt deze inhoud doorgeven aan een aangepaste actie die deze zou kunnen opnemen in een e-mailbericht voor verzending aan de klant.

articleId

String

De artikel-id in Dynamics 365 of een Parature-afdeling

Deze waarde wordt gebruikt als alternatieve sleutel. U kunt deze gebruiken om te zien of dit artikel al bestaat in Dynamics 365 of niet.

articleUid

String

De unieke artikel-id in Dynamics 365 of in het Parature-systeem.

Bij het gebruik van Parature als kennisbron, kan deze zowel de Parature-account-id als de afdelings-id bevatten, bijvoorbeeld “7924/8112/Article/25.”

Deze waarde wordt gebruikt als alternatieve sleutel. Deze id is nodig om een nieuwe KB-record te maken bij het koppelen van een artikel als een dergelijke record nog niet bestaat.

attachmentCount

Nummer

Aantal bijlagen in het artikel.

Dit is alleen van toepassing als Parature als kennisbron wordt gebruikt.

createdOn

Date

De datum waarop het artikel is gemaakt. Deze waarde wordt gebruikt in de tijdzone en indeling van de huidige gebruiker.

Mogelijk wilt u de leeftijd van het artikel gebruiken in uw bedrijfslogica.

expiredDate

Date

De datum waarop het artikel verloopt of zal verlopen. Dit zal bij het gebruik van Dynamics 365 als kennisbron null zijn.

U kunt deze datum met de huidige datum vergelijken om te bepalen of het artikel al dan niet is verlopen. De waarde gebruikt de tijdzone en indeling van de huidige gebruiker.

folderHref

Tekenreeks

De koppeling naar het mappad van het artikel in Parature.

Dit is alleen van toepassing als Parature als kennisbron wordt gebruikt.

href

Tekenreeks

De directe koppeling naar het artikel in Parature-API, die kan worden gebruikt om artikelinhoud rechtstreeks te krijgen.

Dit is alleen van toepassing als Parature als kennisbron wordt gebruikt.

isAssociated

Boolean

Geeft aan of het artikel is gekoppeld met de bovenliggende record of niet.

U kunt deze waarde controleren voordat u het artikel koppelt aan de huidige record via formulierscript of in een ander proces dat door formulierscripts wordt geïnitieerd.

lastModifiedOn

Date

De datum waarop het artikel het laatst is gewijzigd.

Deze waarde wordt gebruikt in de tijdzone en indeling van de huidige gebruiker.

publicUrl

String

URL voor ondersteuningsportal van het artikel. Als de optie Portal-URL is uitgeschakeld, is dit leeg.

Gebruik een aangepaste actie om deze op te nemen in een koppeling in de inhoud van een e-mailbericht voor verzending aan een klant.

published

Boolean

Geeft aan of het artikel de status Gepubliceerd heeft.True indien gepubliceerd; anders False.

U dient te controleren of het artikel is gepubliceerd voordat u informatie hierover naar een klant verzendt.

question

String

De titel van het artikel.

Als u naar het artikel gaat verwijzen in ee bedrijfsproces, kunt u hiernaar verwijzen bij naam met behulp van deze waarde.

rating

Number

De kwalificatie van het artikel.

searchBlurb

String

Een kort fragment van artikelinhoud dat de gebieden bevatten waar de zoekquery resultaten heeft opgeleverd.

Gebruik dit om de gebruikers in de zoeklijst een glimp van het artikel te bieden en hun te helpen bepalen of dit het artikel is dat zij zoeken.

serviceDeskUri

String

Koppeling naar het artikel in de Dynamics 365- of de Parature-servicedesk.

Gebruik deze koppeling voor het openen van het artikel via de Dynamics 365- of de Parature-servicedesk.

timesViewed

Number

Het aantal malen dat een artikel door klanten is bekeken op de -portal.

getTotalResultCount

Haalt het aantal gevonden resultaten op uit het zoekbesturingselement.

Retourwaarde: Geheel getal. Het aantal van de zoekresultaten.

Voorbeeld: Stel de variabele searchCount in op het aantal zoekresultaten in het zoekactiebesturingselement.

var searchCount = kbSearchControl.getTotalResultCount();

openSearchResult

Opent een zoekresultaat in het zoekbesturingselement door het resultaatnummer op te geven.

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

Argumenten

  • resultNumber (Integer): Numerieke waarde die het nummer opgeeft van het resultaat dat u wilt laten openen. Het resultaatnummer begint bij 1. Vereist.

  • mode (String): Geef "Inline" of "Popout" op. Optioneel. Als u geen waarde voor het argument opgeeft, wordt de standaardoptie ("Inline") gebruikt.

    De "Inline"-modus opent het resultaat inline, hetzij in het leesvenster van het besturingselement of in een tabblad met een verwijzingenpaneel in het geval van verwijzingenpanelen. De "Popout"-modus opent het resultaat in een apart venster (pop-out).

Type retourwaarde: Booleaanse waarde Status van het openen van het opgegeven zoekresultaat. Retourneert 1 indien geslaagd; 0 indien niet geslaagd. De methode retourneert -1 als de opgegeven resultNumber-waarde niet aanwezig is, of als de opgegeven mode-waarde niet geldig is.

removeOnPostSearch

Gebruik deze methode om een gebeurtenishandler te verwijderen uit de gebeurtenis PostSearch.

Parameter: Functie. De te verwijderen functie.

Voorbeeld: Verwijder de functie met de naam myFunction uit de gebeurtenis PostSearch.

kbSearchControl.removeOnPostSearch(myFunction);

removeOnResultOpened

Gebruik deze methode om een gebeurtenishandler te verwijderen uit de gebeurtenis OnResultOpened.

Parameter: Functie. De te verwijderen functie.

Voorbeeld: Verwijder de functie met de naam myFunction uit de gebeurtenis OnResultOpened.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

Gebruik deze methode om een gebeurtenishandler te verwijderen uit de gebeurtenis OnSelection.

Parameter: Functie. De te verwijderen functie.

Voorbeeld: Verwijder de functie met de naam myFunction uit de gebeurtenis OnSelection.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

Gebruik deze methode om de tekst in te stellen die wordt gebruikt als zoekcriterium voor het besturingselement Knowledge Base-beheer.

Parameter: Tekenreeks. De tekst voor de zoekquery.

Voorbeeld: Stel de tekst van de zoekquery in op "How to solve the problem".

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

Zie ook

Werken met Knowledge-artikelen in Dynamics 365
Parature-kennis gebruiken in Dynamics 365
Programmeerreferentie op de client
Code schrijven voor Microsoft Dynamics 365-formulieren
Microsoft Dynamics 365 uitbreiden op de client

Microsoft Dynamics 365

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht