Del via

Kontrolelement til søgning i videnbasen (klientsidereference)

  • Artikel

 

Udgivet: januar 2017

Gælder for: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Du kan tilføje et kontrolelement til søgning i videnbasen i objektformularer i din forekomst af Dynamics 365, hvor vidensstyringsfunktionen skal være aktiveret. Med dette kontrolelement kan du via programmering automatisere eller forbedre brugernes søgningsoplevelser, når de bruger kontrolelementet til at bruge viden i Dynamics 365.Flere oplysninger:Vidensstyringsobjekter

Bemærk

  • Du kan vælge indbygget Dynamics 365-viden eller Parature-viden som kilde til vidensstyring og søgning. Hvis du bruger Parature som videnbasekilde, og kontrolelementet til søgning i videnbasen findes i formularen, bør der allerede være oprettet forbindelse til Parature, så du kan foretage direkte kald til Parature API'en uden at kræve et sikkerheds-id. Disse vil dog være anmodninger på tværs af domæner, så du skal bruge CORS (Cross-Origin Resource Sharing).

    Følgende nye klient-API'er, der er indført i Opdatering 1 til CRM Online 2016 og Dynamics 365 Service Pack 1 (det lokale miljø) understøttes ikke, hvis du bruger Parature som vidensbasekilde: PostSearch-hændelse, addOnPostSearch, removeOnPostSearch, getTotalResultCount og openSearchResult.

  • Med udgivelsen af Opdatering 1 til CRM Online 2016 og Dynamics 365 SP1 (det lokale miljø) understøttes søgekontrolelementet for vidensbasen også for Dynamics 365-mobilklienter (telefoner og tablets).

Kontrolelement til søgning i videnbasen er et Xrm.Page.ui kontrolelement, så det understøtter alle standardmetoder for kontrolelementer. Men det understøtter også yderligere hændelser og metoder. Du kan finde oplysninger om de standardkontrolmetoder under Kontrolelementet Xrm.Page.ui (klientsidereference).

Hvis du kender navnet på kontrolelementet, du kan få adgang til det ved hjælp af følgende kode, hvor <navn> repræsenterer navnet på kontrolelementet.

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

Bemærk

Når søgekontrolelementet til videnbasen føjes til ruden Socialt, bliver navnet "searchwidgetcontrol_notescontrol". Dette navn kan ikke ændres.

Alle eksempler i dette emne bruger kbSearchControl til at repræsentere kontrolelementet til søgning i videnbasen i formularen.

Dette emne indeholder

Aktivér hændelser for kontrolelement til søgning i videnbase

Metoder for kontrolelement til søgning i videnbase

Aktivér hændelser for kontrolelement til søgning i videnbase

Brug hændelserne for dette kontrolelement til at tillade kode at svare på det valgte eller åbnede emne.

OnResultOpened

Denne hændelse indtræffer, når en KB-artikel åbnes i det indbyggede søgekontrolelement til videnbasen eller via en pop ud-handling. Brug metoderne addOnResultOpened og removeOnResultOpened til at administrere hændelseshandlere for denne hændelse.

OnSelection

Denne hændelse opstår, når der er valgt en KB-artikel i søgekontrolelementet til videnbasen. Brug metoderne addOnSelection og removeOnSelection til at administrere hændelseshandlere for denne hændelse.

PostSearch

Denne hændelse opstår, når søgningen er afsluttet, og resultaterne vises. Brug de nye addOnPostSearch- og removeOnPostSearch-metoder for at administrere hændelseshandlere for denne hændelse.

Metoder for kontrolelement til søgning i videnbase

Brug metoderne for søgekontrolelementet til videnbasen til at angive eller fjerne hændelseshandlere og arbejde med søgeforespørgslen og søgeresultaterne.

addOnPostSearch

Brug denne metode til at føje en hændelseshandler til hændelsen PostSearch.

Parameter: Funktion. Den funktion, der skal tilføjes.

Eksempel: Føj funktionen myFunction til PostSearch-hændelsen.

kbSearchControl.addOnPostSearch(myFunction);

addOnResultOpened

Brug denne metode til at føje en hændelseshandler til hændelsen OnResultOpened.

Parameter: Funktion. Den funktion, der skal tilføjes.

Eksempel: Føj funktionen myFunction til OnResultOpened-hændelsen.

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

Brug denne metode til at føje en hændelseshandler til hændelsen OnSelection.

Parameter: Funktion. Den funktion, der skal tilføjes.

Eksempel: Føj funktionen myFunction til OnSelection-hændelsen.

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

Brug denne metode til at hente den tekst, der bruges som søgekriteriet for søgekontrolelementet til videnbasen.

Returværdi: Streng. Teksten i søgeforespørgslen.

Eksempel: Indstil variablen searchQuery til teksten i søgeforespørgslen.

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResults

Brug denne metode til at hente det aktuelt valgte resultat af søgekontrolelementet. Det aktuelt valgte resultat repræsenterer også det resultat, der er åbent.

Returværdi: KBSearchResult. Det aktuelt valgte resultat.

Eksempel: Indstil variablen kbSearchResult til det aktuelt valgte resultat.

var kbSearchResult = kbSearchControl.getSelectedResults();

Egenskaber for KBSearchResult

I følgende tabel beskrives egenskaberne for objektet KBSearchResult.

Egenskab

Type

Beskrivelse

answer

String

Den HTML-kode, der indeholder artiklens indhold.

Du kan overføre indholdet til en brugerdefineret handling, der kan medtages i en mail til kunden.

articleId

String

Artikel-id'et i Dynamics 365 eller en Parature-afdeling

Denne værdi bruges som en alternativ nøgle. Du kan bruge den til at se, om denne artikel allerede findes i Dynamics 365.

articleUid

String

Det entydige artikel-id i Dynamics 365 eller i Parature-systemet.

Når du bruger Parature som kilde til viden, indeholder det Parature firma-id og afdelings-id, for eksempel "7924/8112/Article/25".

Denne værdi bruges som en alternativ nøgle. Dette id bruges til at oprette en ny post i KB og samtidig tilknytte en artikel, hvis der ikke allerede findes en.

attachmentCount

Antal

Antal vedhæftede filer i artiklen.

Dette gælder kun, når du bruger Parature som videnkilde.

createdOn

Date

Den dato, artiklen blev oprettet. Værdien vises i den aktuelle brugers tidszone og -format.

Du kan evt. bruge alderen på artiklen i din forretningslogik.

expiredDate

Date

Den dato, hvor artiklen udløber eller er udløbet. Værdien er null, når du bruger Dynamics 365 som videnkilde.

Du kan sammenligne denne dato med den aktuelle data for at bestemme, om artiklen er udløbet. Værdien bruger den aktuelle brugers tidszone og -format.

folderHref

Streng

Link til stien med mappen, der indeholder artiklen i Parature.

Dette gælder kun, når du bruger Parature som videnkilde.

href

Streng

Det direkte link til artiklen i Parature API, som kan bruges til at hente artikelindhold direkte.

Dette gælder kun, når du bruger Parature som videnkilde.

isAssociated

Boolean

Angiver, om artiklen er knyttet til den overordnede post.

Du kan kontrollere denne værdi, før du knytter artiklen til den aktuelle post, ved hjælp af formularscripts eller i en anden proces, der er iværksat af formularscripts.

lastModifiedOn

Date

Den dato, hvor artiklen sidst blev ændret.

Værdien vises i den aktuelle brugers tidszone og -format.

publicUrl

String

URL-adressen til artiklens supportportal. Hvis indstillingen for portalens URL-adresse er slået fra, er dette felt tomt.

Brug en brugerdefineret handling til at medtage adressen i et link i en mail til en kunde.

published

Boolean

Angiver, om artiklen er i publiceret tilstand.True hvis den er udgivet, ellers False.

Du bør kontrollere, om artiklen er offentliggjort, før du sender oplysninger om den til en kunde.

question

String

Titlen på artiklen.

Hvis du vil henvise til artiklen i en forretningsproces, kan du referere til navnet på den ved hjælp af denne værdi.

rating

Number

Klassificeringen af artiklen.

searchBlurb

String

Et kort stykke af artikelindhold, som indeholder de områder, hvor der var et søgeresultat.

Brug det til at give brugere på søgelisten et indblik i artiklen og hjælpe dem med at afgøre, om dette er den artikel, de leder efter.

serviceDeskUri

String

Link til artiklen i Dynamics 365 eller Parature Service Desk.

Brug dette hyperlink til at åbne artiklen via Dynamics 365 eller Parature Service Desk.

timesViewed

Number

Det antal gange, en artikel er åbnet på -portalen af kunder.

getTotalResultCount

Henter antallet af de resultater, der er fundet i søgekontrolelementet.

Returværdi: Heltal. Antallet af søgeresultatet.

Eksempel: Indstil variablen searchCount til antallet af søgeresultater i søgekontrolelementet.

var searchCount = kbSearchControl.getTotalResultCount();

openSearchResult

Åbner et søgeresultat i søgekontrolelementet ved at angive resultatnummeret.

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

Argumenter

  • resultNumber (Integer): Den numeriske værdi, der angiver resultatnummeret, der skal åbnes. Resultatnummeret starter fra 1. Krævet.

  • mode (String): Angiv "Inline" eller "Popout". Valgfrit. Hvis du ikke angiver en værdi for argumentet, bruges ("Inline") standardindstillingen.

    "Inline"-tilstanden åbner resultatet på en integreret måde i kontrolelementets låserude eller i referencepanelfane i tilfælde af referencepanel. "Popout"-tilstanden åbner resultatet i et pop op-vindue.

Returværdi: Boolesk. Status for åbning af det angivne søgeresultat. Returnerer 1, hvis det lykkes; 0, hvis det ikke lykkes. Metoden returnerer -1, hvis den angivne resultNumber-værdi er ikke til stede, eller hvis den angivne mode-værdi er ugyldig.

removeOnPostSearch

Brug denne metode til at fjerne en hændelseshandler fra hændelsen PostSearch.

Parameter: Funktion. Den funktion, der skal fjernes.

Eksempel: Fjern funktionen myFunction fra PostSearch-hændelsen.

kbSearchControl.removeOnPostSearch(myFunction);

removeOnResultOpened

Brug denne metode til at fjerne en hændelseshandler fra hændelsen OnResultOpened.

Parameter: Funktion. Den funktion, der skal fjernes.

Eksempel: Fjern funktionen myFunction fra OnResultOpened-hændelsen.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

Brug denne metode til at fjerne en hændelseshandler fra hændelsen OnSelection.

Parameter: Funktion. Den funktion, der skal fjernes.

Eksempel: Fjern funktionen myFunction fra OnSelection-hændelsen.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

Brug denne metode til at indstille den tekst, der bruges som søgekriteriet for søgekontrolelementet til videnbasen.

Parameter: Streng. Teksten til søgeforespørgslen.

Eksempel: Indstil teksten til søgeforespørgslen til "How to solve the problem".

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

Se også

Arbejde med videnartikler i Dynamics 365
Bruge Parature-viden i Dynamics 365
Programmeringsreference på klientsiden
Skriv kode til Microsoft Dynamics 365-formularer
Udvide Microsoft Dynamics 365 på klienten

Microsoft Dynamics 365

© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret