Arbeiten mit dem Webpart für Inhaltssuche – Teil 4 – Vordefinierte Suchen erstellen

Arbeiten mit dem Webpart für Inhaltssuche – Teil 1 Übersicht
Arbeiten mit dem Webpart für Inhaltssuche – Teil 2 – KQL
Arbeiten mit dem Webpart für Inhaltssuche – Teil 3 – Arbeiten mit Displaytemplates
Arbeiten mit dem Webpart für Inhaltssuche – Teil 4 – Vordefinierte Suchen erstellen

Der vierte und letzte Teil der kleinen Serie über das Arbeiten mit dem Webpart für Inhaltssuche beschäftigt sich mit dem Erstellen von vordefinierten Suchen. Darunter verstehe ich eine Seite, auf welcher ich Suchen absetzen und diese auch verfeinern kann. Dabei ist der Suchfocus im Allgemeinen schon auf ein Thema eingegrenzt, z.B. die Suche in einer Projektverwaltung oder auf Aufgaben. Diese Seiten können dann z.B. über einer Linkliste auf der Startseite aufgerufen werden.

Zwar muss jede Seite individuell konfiguriert werden, aber Sie haben so auch den größten Nutzen. Natürlich können Sie eine solche Seite auch in einem Suchcenter erstellen. Dort ist das Erstellen der Seiten sogar noch einfacher, da ein schon vorkonfiguriertes Seitenlayout verwendet wird. Wenn Sie also individuelle Suchseiten erstellen können, haben Sie im Suchcenter erst recht keine Probleme.

Um eine solche Seite zu erstellen, füge ich über das Zahnrad oben rechts eine neue Seite hinzu. Sollte dies nicht möglich sein, können Sie entweder das Feature Homepage der Wiki-Seite oder SharePoint Server-Veröffentlichung aktivieren. Natürlich gibt es auch noch andere Möglichkeiten eine neue Seite zu erstellen. Ich füge der neuen Seite eine Tabelle mit zwei Spalten und zwei Zeilen hinzu. Diese nutze ich später um die Webparts entsprechend zu platzieren. Ich habe die Zellen entsprechend dem Schema unten nummeriert.


Was wird für eine solche Suchseite eigentlich benötigt? Ich benutze die folgenden Webparts aus dem Abschnitt Search und Content Rollup.

Webpart Beschreibung Zone
Search => Search Box Dieser Webpart dient der Eingabe von Suchwörtern und Phrasen. Er ist i.d.R. automatisch mit dem Webpart Content Search verbunden. 1
Search => Refinement Dieser Webpart dient der Verfeinerung von Suchergebnissen und kann dafür individuell konfiguriert werden. Er ist i.d.R. automatisch mit dem Webpart Content Search verbunden. 3
Content Rollup => Content Search Der Webpart für Inhaltsabfragen 4

Wenn Sie die Webparts eingefügt haben, indem Sie in die jeweilige Tabellenzelle klicken und dann den benötigten Webparts einfügen, sieht die Seite in etwa so wie unten aus.


In manchen Fällen reagiert der Webpart für Inhaltsabfragen nicht auf Eingaben im Suchfeld. Dies liegt oft daran, dass der Webpart in seiner Query noch nicht auf das Suchfeld „hört“. Um dieses Problem zu beheben, konfigurieren Sie den Webpart für Inhaltsabfragen und passen Sie die Query an. Geben Sie in das Feld Query text die folgende Variable ein: {SearchBoxQuery} Nach dem speichern sollte auch die Abfrage aus dem Suchfeld funktionieren.


Damit sind Sie eigentlich schon fertig, Sie müssen natürlich noch den Webpart für Inhaltsabfragen sowie ggf. die Verfeinerungen anpassen wie z.T. in den vorherigen Artikeln beschrieben.

Vielen Dank für Ihr Interesse an meinem Blogeintrag.
Gerne beantworte ich Ihnen persönlich weitergehende Fragen zu diesem Thema.
Kontaktieren Sie mich einfach über mein Kontaktformular.

Sie wollen mehr über mich erfahren? Dann gehen Sie auf
http://www.nicothiemer.de

Arbeiten mit dem Webpart für Inhaltssuche – Teil 3 – Arbeiten mit Displaytemplates

Arbeiten mit dem Webpart für Inhaltssuche – Teil 1 Übersicht
Arbeiten mit dem Webpart für Inhaltssuche – Teil 2 – KQL
Arbeiten mit dem Webpart für Inhaltssuche – Teil 3 – Arbeiten mit Displaytemplates
Arbeiten mit dem Webpart für Inhaltssuche – Teil 4 – Vordefinierte Suchen erstellen

Dies ist der dritte Beitrag in der kleinen Serie über den Webpart für Inhaltssuche in SharePoint 2013. In den vorherigen Beiträgen haben wir uns angeschaut, wie der Webpart konfiguriert wird und wie Sie Suchabfrage gestalten können. Jetzt wird es darum gehen, wie wir die Suchanfrage optisch aufpeppen können. Denn die schon vorhandenen Vorlagen sind, abgesehen von den Funktionen für Bilder, eher sehr technisch. Ich werde mich dabei auf eine einfache Anwendung konzentrieren, es gibt im Internet viele Blogs welche sich dem Thema angenommen haben. Wenn man einmal das Prinzip verstanden hat, kann man auch schnell eigene Lösungen implementieren.

Die Vorlagen heißen Displaytemplates und gibt eine ganze Menge davon im System. Displaytemplates regeln sowohl die prinzipielle Anzeige der Suchergebnisse (Tabelle, Liste, Slideshow) als auch die Anzeige der einzelnen Elemente (welche Metadaten werden angezeigt, wie groß ist ein Bild). Ebenso werden Displaytemplates verwendet, wenn beim Überfahren eines Elementes eine Vorschau angezeigt wird.

Für Demonstrationszwecke werde ich eine vorhandene Vorlage anpassen und diese ergänzen. Im ersten Teil habe ich mit dem Displaytemplate Two Lines gearbeitet und dort zusätzlich das Metadatum Author eingefügt. Jetzt möchte ich, dass vor dem Metadatum der Begriff Autor steht. Dazu muss das vorhandene Displaytemplate kopiert werden, in der Kopie erfolgt dann die Anpassung. Die Displaytemplates sind im Pfad http:///_catalogs/masterpage/Display%20Templates gespeichert. Dieser bzw. sein Inhalt ist allerdings nicht immer sichtbar im Browser. Wenn dies der Fall ist, müssen Sie das SharePoint Publishingfeature aktivieren. Um zum Pfad zu navigieren, gehen Sie zu den Site Settings und dann zu Master pages and page layouts im Abschnitt Web Designer Galleries. Auch diesen Link finden Sie erst nach der Aktivierung des Features. Sie sehen eine Bibliothek, in welcher alle Pagelayouts und Masterpages liegen sowie einige Ordner. Suchen Sie den Ordner Display Templates und öffnen Sie diesen. Die Displaytemplates für den Webpart für Inhaltssuche liegen im Unterordner Content Web Parts. Dort finden Sie jetzt alle Displaytemplates , welche Sie auch im Webpart auswählen können.

Um möglich einfach zu arbeiten, öffnen sie Sie die Bibliothek im Windows Explorer. Klicken Sie dazu auf das Menüband Library und im Abschnitt Connect & Export auf Open with Explorer. Wenn Sie möchten, können Sie den Pfad auch einen Laufwerkbuchstabe zuweisen. Sie können dann in jeden beliebigen HTML Designer arbeiten, denn die Displaytemplates bestehen nur aus HTML und JavaScript. Beide zusammen bilden dann jeweils ein Displaytemplate.

Angepasst werden immer nur die HTML Dateien, NIEMALS die JS Dateien. Die JS Dateien werden von SharePoint automatisch erzeugt wenn eine HTML Datei gespeichert wird und sind für die Bearbeitung tabu. Suchen Sie die Datei Item_TwoLines.html und kopieren Sie diese zu Item_TwoLines_with_Author.html. Sie werden sehen, unmittelbar danach wird auch die entsprechende JS Datei erstellt. Ich öffne die kopierte HTML Datei in Notepad++, aber natürlich geht auch jede anderer Editor.

Es lohnt sich die Datei einmal in aller Ruhe anzuschauen. Sie enthält viele Möglichkeiten und Ideen, was mit Displaytemplates alles möglich ist. Ich gebe nur einen kleinen Abriss, um zu zeigen was man mindestens für ein eigenes Displaytemplate machen muss. Als erstes sollten wir den Titel in Zeile drei ändern. Unter diesen Namen können wir nämlich später das Displaytemplate im Webpart auswählen. Unschön, wenn es zwei Displaytemplates mit dem gleichen Namen gibt. Ich nenne mein Displaytemplate TwoLines with Author.

<html xmlns:mso="urn:schemas-microsoft-com:office:office" xmlns:msdt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882">
<head>
<title>TwoLines with Author</title>

Als nächstes interessant ist die Zeile acht. In dieser Zeile legen Sie fest, mit welchen verwalteten Eigenschaften Sie im Displaytemplate arbeiten möchten. Dabei gibt es immer ein Wertepaar, interne Bezeichnung der Eigenschaft und Anzeigename. Da in unseren Fall allerdings die Werte über Eingabefelder (Line1 und und Line2) übergeben werden, brauchen wir die Eigenschaften hier nicht extra zu benennen.

Es folgt einiger JavaScript Code, welcher in Token

<!--#_ _#--> 

eingeschlossen ist. Die eigentliche Darstellung erfolgt erst ab Zeile 63. In Zeile 73 steht die Darstellung der zweiten Zeile.

<div class="cbs-Line2 ms-noWrap" title="_#= $htmlEncode(line2.defaultValueRenderer(line2)) =#_" id="_#= line2Id =#_">_#= line2 =#_</div>

Wir können jetzt erkennen, dass hier sowohl reines HTML als auch JavaScript vermischt wird. Der JavaScript Code steht wieder in Token. Der Wert der Eigenschaft steht vor dem letzten Div in _#= line2 =#_ . Also ändere ich die Zeile folgendermaßen indem ich direkt davor Author schreibe:
Orginal

<div class="cbs-Line2 ms-noWrap" title="_#= $htmlEncode(line2.defaultValueRenderer(line2)) =#_" id="_#= line2Id =#_">_#= line2 =#_</div>

Mit Änderung

<div class="cbs-Line2 ms-noWrap" title="_#= $htmlEncode(line2.defaultValueRenderer(line2)) =#_" id="_#= line2Id =#_">Author: _#= line2 =#_</div>

Speichern Sie die Änderung.

ACHTUNG: Damit alle Benutzer die Änderung später sehen, muss das geänderte Displaytemplate noch veröffentlicht werden. Gehen Sie im Browser deshalb zu der Bibliothek, markieren Sie die Datei und wählen Sie aus der Menüleiste Publish Dieser Vorgang ist jedes Mal erforderlich, wenn Sie ein fertiges Displaytemplate zur Verfügung stellen wollen. Veröffentlichen Sie nur die HTML Datei, um die JS Datei kümmert sich SharePoint alleine.


Damit Sie das neue Displaytemplate auswählen können, müssen Sie die Seite neu laden, welche den Webpart für Inhaltssuche enthält und diesen wieder zur Bearbeitung auswählen.

Unter Property Mappings können wir das Metadatum Author auswählen, welches dann auch in der zweiten Zeile zusammen mit dem Suffix angezeigt wird. Natürlich wird jetzt immer der Präfix Author angezeigt, aber als Beispiel soll es genügen.

Dies alles nur als Beispiel. Wenn man das konsequent zu Ende denkt, kann eine Anwendung entstehen, wie sie Maggi erstellt hat. Die Rezepte arbeiten mit der Suche und die Präsentation der Suchergebnisse erfolgt mit Displaytemplates. https://www.maggi.de/rezepte. Displaytemplates sind DAS Mittel zur Wahl zur Präsentation von Inhalten in SharePoint. Auch, aber nicht nur deswegen sollte man überlegen mehr Inhalte über die Suche zu erschließen und auf Drilldown Strukturen immer mehr zu verzichten.

Vielen Dank für Ihr Interesse an meinem Blogeintrag.
Gerne beantworte ich Ihnen persönlich weitergehende Fragen zu diesem Thema.
Kontaktieren Sie mich einfach über mein Kontaktformular.

Sie wollen mehr über mich erfahren? Dann gehen Sie auf
http://www.nicothiemer.de

Arbeiten mit dem Webpart für Inhaltssuche – Teil 1 – Übersicht

Arbeiten mit dem Webpart für Inhaltssuche – Teil 1 Übersicht
Arbeiten mit dem Webpart für Inhaltssuche – Teil 2 – KQL
Arbeiten mit dem Webpart für Inhaltssuche – Teil 3 – Arbeiten mit Displaytemplates
Arbeiten mit dem Webpart für Inhaltssuche – Teil 4 – Vordefinierte Suchen erstellen

Dieser Artikel ist der Start einer mehrteiligen Serie, welche sich mit dem Webpart für Inhaltssuche beschäftigt. Warum ist dieser Webpart in modernen SharePoint Anwendungen so wichtig und warum wird dieser vergleichsweise wenig verwendet? Neben der Beantwortung dieser Fragen werde ich mich auch mit der Konfiguration des Webparts beschäftigen und einige korrekte Anwendungsbeispiele geben.

Wozu das Ganze?

In modernen SharePoint Anwendungen wird versucht auf Drilldown Strukturen zu verzichten. Dies wird erreicht, indem ich den Benutzern z.B. durch Dokumentenrouting eine einzige Stelle gebe um Dokumente hochzuladen und diese dann über Regeln verteilen lasse. Zwingend notwendig dafür ist allerdings eine durchgeplante Informationsarchitektur. Gerade in Zeiten von exponentiellen Informations- und Wissenswachstum ist diese unerlässlich. Der Gedanke ist nun, den Benutzern durchgeplante Bereiche zur Verfügung zu stellen, wo diese an vielen verschiedenen Stellen ihre Informationen erfassen können. Aber über eine zentrale Stelle, z.B. ein Suchcenter oder auch die Startseite einer Anwendung, bereite ich diese Informationen wieder mit der Suche auf. Es ist nicht wichtig, wo eine Information liegt, sofern ich diese z.B. über Inhaltstypen und deren Eigenschaften schnell wiederfinde. Genau dafür ist der Webpart für Inhaltssuche konzipiert.

Grundlagen

Der Webpart für Inhaltssuche wurde in SharePoint 2013 neu eingeführt, ein ganz ähnlicher Webpart, den Suchergebniswebpart gibt es schon viel länger. In SharePoint 2013 und 2016 ist die Ähnlichkeit zwischen den Webparts sehr stark. Der primäre Unterschied ist zum einem, dass der Webpart für Inhaltssuche andere Möglichkeiten für die Konfiguration bietet und im Gegensatz zum Suchergebniswebpart nur in der Enterprise Edition verfügbar ist. Ich werde mich hier aber trotzdem mit dem Webpart für Inhaltssuche beschäftigen. Wenn man die grundlegenden Konzepte verstanden hat, kann man auch den Suchergebniswebpart konfigurieren. Voraussetzung für das Arbeiten mit diesen Webparts ist eine konfigurierte Suchanwendung, welche schon Inhalt indiziert hat.

Der Webpart für Inhaltssuche findet sich in der Gruppe Content Rollup und trägt dort den Namen Content Search. Es gibt auch noch einen Webpart Content Query, welcher mit XSLT arbeitet und daher völlig anders als der Webpart für Inhaltssuche. Wird der Webpart für Inhaltssuche auf einer Seite eingefügt, bekommt man eine Anzeige, mit welcher man in der Regel wenig anfangen kann. Oftmals nur drei graue Kacheln und danach einen nichtssagenden Link.

Den Webpart konfigurieren

Wenn man den Webparts bearbeitet, ist man auch nicht unbedingt schlauer. Was bedeuten jetzt die ganzen Einstellungen im Abschnitt Properties?

Am interessantesten ist zweifellos der Inhalt, welcher sich hinter der Schaltfläche Change query verbirgt. Hier kann ich die Abfrage ändern, welche der Webpart im Suchindex ausführt. Was genau man da machen kann, wird der Inhalt eines weiteren Artikels in nächster Zeit sein. Number of items to show erklärt sich von alleine und gibt eben an, wie viele Ergebnisse aus der Abfrage auf einmal angezeigt werden sollen.

Spannender ist da der Abschnitt Display Templates. Hier wird festgelegt wie die Suchergebnisse präsentiert werden. Dabei helfen zwei Typen von Vorlagen. Das Control Template legt fest, wie die Präsentation der gesamten Suchergebnisse erfolgt. Soll z.B. jedes Ergebnis auf einer Zeile stehen oder sollen diese, wie z.B. bei Bildern üblich, als Slideshow präsentiert werden. Man kann die Ergebnisse auch als Tabelle formatieren, aber das muss man selber entwickeln. In der Abbildung unten ist dies das Template List Table Control.


Das Item Template legt dagegen fest, wie jedes einzelne Suchergebnis angezeigt wird. Da wird auch schnell klar, was der graue Kasten bei den Suchergebnissen sein kann. Es ist ein Platzhalter für ein Bild, was nicht angezeigt werden kann. Logisch, den in der Regel haben Office Dokumente in SharePoint kein Bild hinterlegt.

Stellt man als Template z.B. Two Lines ein, sieht die Ansicht gleich ganz anderes aus.

Allerdings erscheint nur eine Zeile und nicht zwei wie das Template verspricht. Um diese anzuzeigen, muss der Abschnitt Property Mappings erweitert und die Option Change the mapping of managed properties for the fields in the Item Display Template aktiviert werden. Jetzt kann man im Dropdown Line 2 eine Eigenschaft auswählen, welche angezeigt werden soll. In dem DropDown werden u.a. alle verwalteten Eigenschaften angezeigt, welche SharePoint durchsucht. Allerdings ist natürlich nicht jede Eigenschaft an jedes Element gebunden. Ich wähle als Beispiel die Eigenschaft Author, denn diese ist immer vorhanden. Nach ein Klick auf Apply sehen die Suchergebnisse schon anders aus. Natürlich sind auch hier eigene Anpassungen möglich. Es lohnt sich, hier ein wenig zu experimentieren.

Die Einstellungen im Abschnitt Settings sollten
am Anfang unverändert bleiben.

Da dies der letzte Beitrag im Jahr 2016 ist, wünsche ich allen Lesern dieses Blogs eine frohes Fest und einen guten Rutsch in das neue Jahr!

Vielen Dank für Ihr Interesse an meinem Blogeintrag.
Gerne beantworte ich Ihnen persönlich weitergehende Fragen zu diesem Thema.
Kontaktieren Sie mich einfach über mein Kontaktformular.

Sie wollen mehr über mich erfahren? Dann gehen Sie auf
http://www.nicothiemer.de