Parature: Suchsteuerelement für die Wissensdatenbank (clientseitige Referenz)

Artikel
07/06/2017

Veröffentlicht: November 2016

Gilt für: Dynamics CRM 2015

Mit Microsoft Dynamics CRM Online 2015-Update 1 oder höher, wenn eine Organisation Parature-Integration aktiviert hat, kann sie ein neues Suchsteuerelement für die Wissensdatenbank zu Formularen hinzufügen. Dieses Steuerelement bietet Unterstützung von Programmierbarkeit, um die Verwendung dieses Steuerelements für Benutzer zu automatisieren oder zu verbessern.

Wichtig

Für Microsoft Dynamics CRM Online-Organisationen steht diese Funktion nur zur Verfügung, wenn die Organisation auf Dynamics CRM Online 2015 Update 1 aktualisiert hat. Diese Funktion ist nicht für Dynamics CRM (lokal) verfügbar.

Diese Ereignisse und Methoden sind nicht direkt mit einer Parature-API verbunden. Wenn jedoch das Steuerelement 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.

Das Wissensdatenbankverwaltungs-Suchsteuerelement ist ein Xrm.Page.ui-Steuerelement, deshalb unterstützt es alle Standardverfahren, ü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 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 unten verwenden kbSearchControl zur Darstellung des Wissensdatenbank-Suchsteuerelements im Formular.

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.

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.

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

getSelectedResult

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

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 einer Parature-Abteilung Dieser Wert wird als Alternativschlüssel verwendet. Sie können ihn verwenden, um zu überprüfen, ob dieser Artikel in CRM bereits vorhanden ist.
articleUid	String	Die eindeutige Artikel-ID für das Parature-System. Dies enthält auch die Parature-Firmen-ID und -Abteilungs-ID, z. B. "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.
createdOn	Date	Das Datum, an dem der Artikel erstellt wurde. Sie möchten ggf. das Alter des Artikels in der Geschäftslogik verwenden.
expiredDate	Date	Das Datum des Artikels ist abgelaufen bzw. wird ablaufen. 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.
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. 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- oder Entwurfs-Status befindet. Ü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 Parature-Service Desk. Verwenden Sie diesen Link, um den Artikel mit dem Parature-Service Desk zu öffnen.
timesViewed	Number	Die Anzahl der Male, die ein Artikel im Parature-Portal von Kunden angesehen wurde.

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

Integration von Microsoft Dynamics CRM 2015 mit Parature
Cclientseitige Programmierreferenz
Schreiben von Code für Microsoft Dynamics CRM 2015-Formulare
Schreiben von Client-Anwendungserweiterungen

Freigeben über