Suchsteuerelement für die Wissensdatenbank (clientseitige Referenz)

 

Veröffentlicht: Januar 2017

Gilt für: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Sie können eine Suche in der Wissensdatenbank-Steuerung zu den Entitätsformularen in Ihrer Dynamics 365-Instanz hinzufügen, für die die Wissensmanagementfunktion aktiviert ist. Mit diesem Steuerelement können Sie programmgesteuert die Sucherfahrungen der Benutzer automatisieren oder erhöhen, wenn diese das Steuerelement verwenden, um Wissen in Dynamics 365 zu nutzen.Weitere Informationen:Entitäten für das Wissensmanagement

Hinweis

• Sie können als Quelle für die Wissensverwaltung und -suche das integrierte Dynamics 365-Wissen oder das Parature-Wissen auswählen. Wenn Sie Parature als Wissendatenbankquelle verwenden und das Steuerelement für die Wissensdatenbanksuche im Formular vorhanden ist, muss eine Verbindung mit Parature bereits vorhanden sein, sodass direkt Parature-API-Aufrufe vorgenommen werden können, ohne dass ein Sicherheitstoken erforderlich ist. Allerdings sind dies domänenübergreifende Anforderungen, daher müssen Sie ursprungsübergreifende Ressourcenfreigabe (CORS) verwenden.

  Die folgenden neuen Client-APIs, die in CRM Online 2016-Update 1 und Dynamics 365 Service Pack 1 (lokal) eingeführt werden, werden nicht gestützt, wenn Sie Parature als Ihre Wissensbasisquelle verwenden: PostSearch-Ereignis, addOnPostSearch, removeOnPostSearch, getTotalResultCount und openSearchResult.

• Mit CRM Online 2016-Update 1 und Dynamics 365 SP1 (lokal) wird das Suchsteuerelement für die Wissensdatenbank auch für die mobilen Dynamics 365-Clients unterstützt (Telefone und Tablets).

Das Suchsteuerelement der Wissensdatenbank ist ein Xrm.Page.ui-Steuerelement, deshalb unterstützt es alle Standardmethoden, über die Steuerelemente verfügen. Aber es unterstützt auch weitere Ereignisse und Methoden. Informationen zu den Standardsteuerelement-Methoden finden Sie unter Xrm.Page.ui-Steuerelement (clientseitige Referenz)

Wenn Sie den Namen des Steuerelements kennen, können Sie darauf mithilfe des folgenden Codes zugreifen, wobei <Name> den Namen des Steuerelements darstellt.

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

Hinweis

Wenn das Wissensdatenbank-Suchsteuerelement dem sozialen Bereich hinzugefügt wird, ist der Name "searchwidgetcontrol_notescontrol". Dieser Name kann nicht geändert werden.

Alle Beispiele in diesem Thema verwenden kbSearchControl zur Darstellung des Wissensdatenbank-Suchsteuerelements im Formular.

In diesem Thema

Suchsteuerelement für die Wissensdatenbank – Ereignisse

Suchsteuerelement für die Wissensdatenbank – Methoden

Suchsteuerelement für die Wissensdatenbank – Ereignisse

Verwenden Sie die Ereignisse für dieses Steuerelement, damit Code auf das ausgewählte oder geöffnete Element reagieren kann.

OnResultOpened

Dieses Ereignis tritt auf, wenn ein Wissensdatenbankartikel im Wissensdatenbank-Suchsteuerelement nebeneinander oder über die Aufklappaktion geöffnet wird. Verwenden Sie die addOnResultOpened- und removeOnResultOpened-Methoden, um Ereignishandler für dieses Ereignis zu verwalten.

OnSelection

Dieses Ereignis tritt auf, wenn ein Wissensdatenbankartikel im Wissensdatenbank-Suchsteuerelement ausgewählt ist. Verwenden Sie die addOnSelection- und removeOnSelection-Methoden, um Ereignishandler für dieses Ereignis zu verwalten.

PostSearch

Dieses Ereignis tritt auf, wenn die Suche komplett ist, und die Ergebnisse werden angezeigt. Verwenden Sie die neuen addOnPostSearch- und removeOnPostSearch-Methoden, um Ereignishandler für dieses Ereignis zu verwalten.

Suchsteuerelement für die Wissensdatenbank – Methoden

Verwenden Sie die Methoden für das Wissensdatenbank-Suchsteuerelement, um Ereignishandler festzulegen oder zu entfernen und um mit der Suchabfrage und den Suchergebnissen zu kommunizieren.

addOnPostSearch

Verwenden Sie diese Methode, um einen Ereignishandler zum PostSearch-Ereignis hinzuzufügen.

Parameter: Funktion. Die Funktion zum Hinzufügen.

Beispiel: Fügen Sie die Funktion namens myFunction zum PostSearch-Ereignis hinzu.

kbSearchControl.addOnPostSearch(myFunction);

addOnResultOpened

Verwenden Sie diese Methode, um einen Ereignishandler zum OnResultOpened-Ereignis hinzuzufügen.

Parameter: Funktion. Die Funktion zum Hinzufügen.

Beispiel: Fügen Sie die Funktion namens myFunction zum OnResultOpened-Ereignis hinzu.

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

Verwenden Sie diese Methode, um einen Ereignishandler zum OnSelection-Ereignis hinzuzufügen.

Parameter: Funktion. Die Funktion zum Hinzufügen.

Beispiel: Fügen Sie die Funktion namens myFunction zum OnSelection-Ereignis hinzu.

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

Verwenden Sie diese Methode, um den Text abzurufen, der als Suchkriterien für das Wissensdatenbankverwaltungs-Steuerelement verwendet wird.

Rückgabewert: Zeichenfolge. Der Text der Suchabfrage.

Beispiel: Setzen Sie die searchQuery-Variable auf den Text der Suchabfrage.

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResults

Verwenden Sie diese Methode, um das aktuell ausgewählte Ergebnis des Suchsteuerelements abzurufen. Das aktuell ausgewählte Ergebnis stellt außerdem das Ergebnis dar, das aktuell geöffnet ist.

Rückgabewert: KBSearchResult. Das aktuell ausgewählte Ergebnis.

Beispiel: Legt die Variable kbSearchResult auf das aktuell ausgewählte Ergebnis fest.

var kbSearchResult = kbSearchControl.getSelectedResults();

KBSearchResult-Eigenschaften

Die folgende Tabelle beschreibt die Eigenschaften des KBSearchResult-Objekts.

Eigenschaft	Typ	Beschreibung
answer	String	Das HTML-Markup, das den Inhalt des Artikels enthält. Diesen Inhalt können Sie an eine benutzerdefinierte Aktion übergeben, die ihn einer E-Mail beifügen könnte, die an den Kunden gesendet werden soll.
articleId	String	Die Artikel-ID in Dynamics 365 oder einer Parature-Abteilung Dieser Wert wird als Alternativschlüssel verwendet. Sie können ihn verwenden, um zu überprüfen, ob dieser Artikel in Dynamics 365 bereits vorhanden ist.
articleUid	String	Die eindeutige Artikel-ID in Dynamics 365 oder im Parature-System. Wenn Sie Parature als Wissensquelle verwenden, umfasst dies auch die Parature Konto-ID und Abteilungs-ID, beispielsweise "7924/8112/Article/25". Dieser Wert wird als Alternativschlüssel verwendet. Die ID ist erforderlich, um einen neuen Wissensdatenbank-Datensatz beim Zuordnen eines Artikels zu erstellen, falls noch nicht vorhanden.
attachmentCount	Anzahl	Anzahl der Anlagen im Artikel. Dies gilt nur, wenn Parature als Wissensquelle verwendet wird.
createdOn	Date	Das Datum, an dem der Artikel erstellt wurde. Dieser Wert entspricht der Zeitzone und dem Format des aktuellen Benutzers. Sie möchten ggf. das Alter des Artikels in der Geschäftslogik verwenden.
expiredDate	Date	Das Datum des Artikels ist abgelaufen bzw. wird ablaufen. Dieser Wert ist Null, wenn die Dynamics 365 als Wissensquelle verwendet wird. Sie können dieses Datum mit den aktuellen Daten vergleichen, um zu bestimmen, ob der Artikel schon abgelaufen ist. Der Wert verwendet die Zeitzone und das Format des aktuellen Benutzers.
folderHref	Zeichenfolge	Der Link zum Ordnerpfad des Artikels in Parature. Dies gilt nur, wenn Parature als Wissensquelle verwendet wird.
href	Zeichenfolge	Der direkte Link zum Artikel in der Parature-API, der verwendet werden kann, um Artikelinhalt direkt abzurufen. Dies gilt nur, wenn Parature als Wissensquelle verwendet wird.
isAssociated	Boolean	Gibt an, ob der Artikel mit dem übergeordneten Datensatz verknüpft ist. Sie können diesen Wert überprüfen, bevor Sie den Artikel dem aktuellen Datensatz mithilfe von Formularskripts oder in einem anderen Prozess, der von Formularskripts initiiert wird, zuordnen.
lastModifiedOn	Date	Datum, an dem der Artikel zuletzt geändert wurde. Dieser Wert entspricht der Zeitzone und dem Format des aktuellen Benutzers.
publicUrl	String	URL des Support-Portals für den Artikel. Wenn die Portal-URL-Option deaktiviert ist, ist dies leer. Verwenden Sie eine benutzerdefinierte Aktion, um dies in einem Link im Inhalt einer E-Mail beizufügen, die an einen Kunden gesendet werden soll.
published	Boolean	Gibt an, ob sich der Artikel im Veröffentlicht-Status befindet.True, falls veröffentlicht; andernfalls False. Überprüfen Sie, ob der Artikel veröffentlicht wird, bevor Sie Informationen dazu an einen Kunden senden.
question	String	Der Titel des Artikels. Wenn Sie in einem Geschäftsprozess auf den Artikel verweisen werden, können Sie darauf über den Namen mithilfe dieses Werts verweisen.
rating	Number	Die Bewertung des Artikels.
searchBlurb	String	Ein kurzer Ausschnitt des Artikelinhalts, der die Bereiche mit den Suchabfrage-Treffern enthält. Verwenden Sie dies, um den Benutzern in der Suchliste eine Kurzübersicht über den Artikel zu geben und ihnen zu helfen, zu entscheiden, ob dies der Artikel ist, den sie suchen.
serviceDeskUri	String	Link zum Artikel im Dynamics 365- oder Parature-Service Desk. Verwenden Sie diesen Link, um den Artikel mit dem Dynamics 365- oder Parature-Service Desk zu öffnen.
timesViewed	Number	Die Anzahl der Male, die ein Artikel im -Portal von Kunden angesehen wurde.

getTotalResultCount

Erhält die Anzahl der Ergebnisse, die im Suchsteuerelement gefunden werden.

Rückgabewert: Ganzzahl. Die Anzahl der Suchergebnisse.

Beispiel: Setzen Sie die Variable searchCount auf die Anzahl der Suchergebnisse im Suchsteuerelement.

var searchCount = kbSearchControl.getTotalResultCount();

openSearchResult

Öffnet ein Suchergebnis im Suchsteuerelement, indem die Ergebniszahl angegeben wird.

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

Argumente

• resultNumber (Integer): Zahlenwert, der die zu öffnende Ergebniszahl spezifiziert. Ergebniszahl beginnt bei 1. Erforderlich.

• mode (String): Geben Sie "Inline" oder "Popout" an. (Optional). Wenn Sie keinen Wert für das Argument angeben, wird die Standardoption ("Inline") verwendet.

  Im Modus "Inline" wird das Ergebnis entweder im Lesebereich des Steuerelements oder einer Registerkarte für den Bereich "Verweise" im Falle eines Bereichs "Verweise" geöffnet. Im Modus "Popout" wird das Ergebnis in einem Popup-Fenster geöffnet.

Rückgabewert: Boolesch. Status des Öffnens des spezifizierten Suchergebnisses. Gibt 1 zurück, wenn erfolgreich; 0 wenn erfolglos. Die Methode gibt -1 zurück, wenn der spezifizierte resultNumber-Wert nicht anwesend ist oder wenn der spezifiziertemode-Wert ungültig ist.

removeOnPostSearch

Verwenden Sie diese Methode, um einen Ereignishandler vom PostSearch-Ereignis zu entfernen.

Parameter: Funktion. Die Funktion zum Entfernen.

Beispiel: Entfernen Sie die Funktion namens myFunction vom PostSearch-Ereignis.

kbSearchControl.removeOnPostSearch(myFunction);

removeOnResultOpened

Verwenden Sie diese Methode, um einen Ereignishandler vom OnResultOpened-Ereignis zu entfernen.

Parameter: Funktion. Die Funktion zum Entfernen.

Beispiel: Entfernen Sie die Funktion namens myFunction vom OnResultOpened-Ereignis.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

Verwenden Sie diese Methode, um einen Ereignishandler vom OnSelection-Ereignis zu entfernen.

Parameter: Funktion. Die Funktion zum Entfernen.

Beispiel: Entfernen Sie die Funktion namens myFunction vom OnSelection-Ereignis.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

Verwenden Sie diese Methode, um den Text festzulegen, der als Suchkriterien für das Wissensdatenbankverwaltungs-Steuerelement verwendet wird.

Parameter: Zeichenfolge. Der Text für die Suchabfrage.

Beispiel: Setzen Sie den Text der Suchabfrage auf "How to solve the problem".

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

Siehe auch

Verwenden von Wissensartikeln in Dynamics 365
Nutzen von Parature-Wissen in Dynamics 365
Cclientseitige Programmierreferenz
Schreiben von Code für Microsoft Dynamics 365-Formulare
Erweitern von Microsoft Dynamics 365 auf dem Client

Microsoft Dynamics 365

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright