Dokumentation Template 3.0

Sub-Schema Datenquelle

Von der einfachen bis zur komplizierten und flexiblen Selektion von Ressourcen.

Sub-Schema Datenquelle (c)
Screenshot des Teil-Schemas im Acacia-Editor

Die Datenquelle ist ein Unterschema, das in folgenden Elementen eingesetzt wird:

Mit der Überarbeitung vom 31.8.18 soll die Benutzung nochmals vereinfacht werden. Sie haben neue Felder (Seitenelement, Sprache und Solr-Option) und eine Mehrfachauswahl für Ordner. Das Ziel ist die meisten Datenselektionen nun auf diese Art spezifizieren zu können und nur noch in Ausnahmefällen Solr-Queries zu schreiben, denn Sie können die Datenquelle stufenweise benutzen:

  1. Lassen Sie die Datenquelle gänzlich unkonfiguriert, dann gelten voreingestellte Werte für die einzelnen Seitenelemente (s. Tabelle "Implizite Festlegung"). D.h. wir erzeugen eine automatisierte Ausgabe, z.B. "eine Mitarbeiterliste zeigt alle Mitarbeiter der Einrichtung" oder "eine Fotostrecke zeigt alle Bilder der Sub-Site".
  2. Mit Sicherheit trifft dieser erste Ansatz nicht immer zu. Dann können Sie einfache Einschränkungen vornehmen, indem die häuftigsten Solr-Felder direkt auswählbar sind, z.B.die Mitarbeiterliste soll nur das Sekretariat zeigen (also die Mitarbeiter mit einer gesetzten Kategorie) oder die Fotostrecke soll die letzte Absolventenfeider zeigen (deren Bilder Sie in einem eigenen Ordner organisiert haben).
  3. Wollen Sie kompliziertere und zusammengesetzte Ausdrücke benutzen, dann können Sie eine freie Solr-Abfrage formulieren.

Stufe 1: Sie tun nichts und es gelten implizite Definitionen

Für folgende Seitenelemente wird immer in der aktuellen Site nach bestimmten Typen gesucht. Im Einzelnen sind dies:

Seitenelement Typen Ordner
Newsstream news_v3, event_v3, video_v3, social-media_v3, presseinfo_v3 Eigenschaft RootFolder
Mitarbeiterliste employee_v3 Eigenschaft RootFolder
Dateiliste   Eigenschaft RootFolder
Fotostrecke image Eigenschaft RootFolder

Stufe 2: Sie wählen Parameter

Definieren Sie selbst die Parameter für eine Datenselektion. Wichtig ist dabei, dass nach wie vor für die obigen Listentypen die impliziten Vorgaben gelten. Ändern Sie z.B. bei einer Mitarbeiterliste das Verzeichnis, dann gilt immer noch die (implizite) Typdefinition employee_v3.

Die einzelnen Datenfelder

Das Solr-Feld nach dem sortiert werden soll. Die Vorauswahl hilft bei gängigen Feldern. Newsstream-Datum ist ein Solr-Feld das aus den typischen, aber unterschiedlichen Datumsfelder der Newsstream-Elemente befüllt wird, z.B. das Startdatum einer Veranstaltung oder das offizielle Datum einer Presseinformation.

Feste Auswahl, ob auf- oder absteigend.

Limitierung der Suche auf diese Anzahl an Elementen. Unausgefüllt werden alle Seitenelemente gesucht.

Eine Komma-getrennte Liste an Seitenelementen, angegeben durch die internen Bezeichner. Die Vorauswahl liefert bereits einige gängige Typen, v.a. in Hinblick, dass die richtigen internen Bezeichner benutzt werden müssen.

Bietet die Auswahl von (mehreren) Kategorieren zur Suche.

Bietet die Möglichkeit mehrere Ordner auszuwählen.

Eine Komma-getrennte Liste von Dateiextensionen. Die Vorauswahl bietet einige sinnvolle Gruppen. Es erfolgt keine Unterscheidung der Groß- oder Kleinschreibung.

Sucht nur nach strukturierten Ressourcen, die tatsächlich Inhalt in dieser Sprache besitzen. Die Anwendung ist damit sinnfrei für Text-, Bild-, Binär-, etc. Dateien.

Bleibt dieses Feld unausgewählt erfolgt ein Sprach-Fallback, z.B. erscheint eine News auf deutsch in einem englischen Newsstream, wenn es keinen englischen Inhalt gibt. Der Sprach-Fallback wird durch die Eigenschaft locale geregelt.

Die Möglichkeit weitere Solr-Felder ergänzend zu den bisherigen anzugeben. Vordefinierte Werte haben wir speziell für Zeitbereiche zusammengestellt. 

Eine syntaktisch richtige Solr-Query, die alle bisherigen Felder -bis auf die Verzeichnisse- ignoriert. Denn diese können per Link-Makro (angefangen mit %(link1), %(link2), etc.) referenziert werden. Dies erleichtert einerseits die Notwendigkeit, dass absolute interne OpenCms-Pfade mit /sites/default/ beginnen (müssen) und andererseits macht es Ihre Abfrage immun gegen Umbenennungen oder Verschiebungen.

Weitere Hinweise und Beispiele zu Solr-Abfragen.

Logische Verknüpfung der Felder und Listen

  • Die einzelnen Felder werden logisch UND verknüpft (z.B. Typ ist Bild  UND Verzeichnis ist /ze/tik/).
  • Die Werte eines Datenfeldes, die Sie in einer Komma-getrennten Liste angeben, werden logisch ODER verknüpft (z.B. Dateiendung ist png ODER jpg ODER gif).
    Aber Achtung: die Ausnahme sind Kategorien. Hier haben wir uns für eine logische UND-Verknüpfung entschieden (z.B. Mitarbeiter hat Kategorie AbteilungXY UND Kategorie Wissenschaftlicher Mitarbeiter).

Das Feld Solr-Option ist dafür gedacht Solr-Felder ergänzen zu können, die wir nicht direkt zur Auswahl anbieten. Der Solr-Teilausdruck wird logisch UND mit den bisherigen Feldern verknüpft.

Stufe 3: Sie sind Experte und schreiben eigene Solr-Queries

Es gilt nur dieser Inhalt und Sie schreiben eine syntaktisch richtige Solr-Query für den Parameter fq und ergänzen diesen mit weiteren erlaubten Solr-Parametern (wie sort oder rows).

Die beiden Makros %(locale) und %(link) werden in den Feldern Sortierschlüssel, Solr-Option und Solr-Query durch die entsprechenden Werte ersetzt. %(locale) entspricht dem ISO-Code des aktuellen Requests (z.B. en) und %(link) referenziert ein obiges definiertes Verzeichnis.

Weitere Hinweise und Beispiele zu Solr-Queries.

Zum Seitenanfang