Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2023.
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Vor der Installation des Sitecore Konnektors muss sichergestellt werden, dass der Mindbreeze Server installiert. Zur Installation oder Aktualisierung des Konnektors verwenden Sie bitte das Mindbreeze Management Center.
Zur Installation des Plugins, öffnen Sie das Mindbreeze Management Center. Wählen Sie aus dem linken Menü den Punkt „Configuration“ aus. Anschließend navigieren Sie auf den Reiter „Plugins“. Im Abschnitt „Plugin Management“ wählen Sie die entsprechende Zip-Datei aus laden sie durch Auswahl der Schaltfläche „Upload“ hoch. Damit wird der Konnektor automatisch installiert oder gegebenenfalls aktualisiert. In diesem Zuge werden die Mindbreeze Dienste neugestartet.
Wählen Sie zur Konfiguration die Installationsmethode „Advanced“.
Navigieren Sie auf den Reiter „Indices“ und klicken Sie auf das Symbol „Add new index“ rechts oben, um einen neuen Index zu erzeugen.
Andern Sie gegebenenfalls des Display Name des neu angelegen Index.
Fügen Sie eine neue Datenquelle durch Klick auf das Symbol „Add new custom source“ rechts oben hinzu. Wählen Sie die Category „Sitecore“ und konfigurieren Sie die Datenquelle nach Ihren Bedürfnissen.
Im Bereich „Sitecore“ können Sie Ihre Sitecore Installation, die indiziert werden soll, definieren. Folgende Optionen stehen zur Verfügung:
„Sitecore Server URL“ | Die URL des Sitecore Servers, z.B.: https://sitecore.mycompany.com | ||||||||||
„Template Names“ | Die exakten Template Names der Templates aller Items, die indiziert werden sollen, z.B: News Page | ||||||||||
„Include Item By Metadata“ | Mit diesem Setting können Items basierend auf Metadaten inkludiert werden. Wenn dieses Setting konfiguriert wird, werden nur Items indiziert, die einen Wert für das Metadatum haben, die das Pattern matchen. Es werden dabei die Basis Metadaten und die Metadaten Fields des Items in Sitecore verwendet. Excludes haben Priorität über Includes (also wenn ein Item sowohl inkludiert, als auch exkludiert wird, wird es nicht indiziert). | ||||||||||
„Exclude Item By Metadata“ | Mit diesem Setting können Items basierenz auf Metadaten exkludiert werden. Wenn dieses Setting konfiguriert wird, werden nur Items indiziert, die einen Wert für das Metadatum haben, die das Pattern nicht matchen. Es werden dabei die Basis Metadaten und die Metadaten Fields des Items in Sitecore verwendet. Excludes haben Priorität über Includes (also wenn ein Item sowohl inkludiert, als auch exkludiert wird, wird es nicht indiziert). | ||||||||||
„Exclude ACLs“ | Mit diesem Setting können gewisse ACL Einträge exkludiert werden. „Principal Pattern“: Regex für das Principal (z.B. Username oder Group Name) „Action“: Welche Action exkludiert werden soll (Grant, Deny oder beide) Sollen zum Beispiel alle Denies exkludiert werden, muss das „Principal Patter“ auf .* gesetzt werde und die „Action“ auf Deny | ||||||||||
„API Credential“ | Das im Network Tab angelegt Credential, welches den API Key enthält. Mehr Info darüber, wie der API Key erstellt werden kann, gibt es im Kapitel 2.2.2. | ||||||||||
„Sitecore Domain“ | Domain des Sitecore Users | ||||||||||
“Sitecore User” | Das im Network Tab angelegte Credential, welches den Sitecore User und Passwort enthält, der zum Herunterladen des HTML Contents verwendet wird. | ||||||||||
„Page Size“ | Maximale Anzahl an Items die pro Request an die API erhalten werden. Ein hoher Wert führt sorgt für höhere Geschwindigkeit, aber auch zu größerem Speicherverbrauch während dem Crawlrun, ein kleiner Wert sorgt für weniger Speicherverbrauch, dafür verringert sich aber die Geschwindigkeit. Der Mindestwert ist 1. | ||||||||||
“Content” | Mit dieser Option kann via einem XPath Ausdruck angegeben werden, welche HTML Tags als Content des Sitecore Dokuments verwendet werden soll. Wenn dieses Feld leer gelassen wird, wird das gesamte HTML Dokument verwendet. | ||||||||||
“Exclude Tags from Content” | Mit dieser Option kann via einem XPath Ausdruck angegeben werden, welche HTML Tags vom Content des Sitecore Dokuments exkludiert werden soll. | ||||||||||
“Extract Metadata” | Mit dieser Option können Metadaten aus dem Content des Dokuments extrahiert werden.
| ||||||||||
“Reference Metadata” | Mit dieser Option können Feldnamen vom Typ Referenz angegeben werden, um diese aufzulösen. Jede Zeile soll folgendes Format haben: Auflösungstyp;Referenzfeldname;Itemfeldname;FallbackItemfeldname“ Auflösungstyp (optional): Soll INLINE oder KEY_REF sein. Default ist INLINE. Referencefeldname (required): Name des Referenzfelds. Z.B. Priority Itemfeldname (optional): Name des Felds im referenzierten Item. Default ist „DisplayName“ FallbackItemfeldname (optional): Name des Referenzfelds das verwendet werden soll, wenn das Itemfeld keinen Wert hat. Beispiele:
| ||||||||||
“Date Field Names” (Advanced Settings) | Es kann eine Liste von Dokumenteigenschaften definiert werden. Diese, zusätzlich zu den Eigenschaften vom Typ „date“ und "datetime", werden mit der konfigurierten Java Simple Date Format Strings in der Option "Date Formats" als Datum geparst. Beachten Sie, dass die Eigenschaftsnamen von Sitecore mit ein "sc_" Prefix konfiguriert werden sollen. Zum Beispiel: "sc_mycustomdate", das in der Liste hinzugefügt wurde, entspricht dem Feld "mycustomdate" in Sitecore. | ||||||||||
“Date Formats” (Advanced Settings) | Eine Liste von Zeitformaten, die für das Parsing der Datumseigenschaften verwendet werden. Die Formate müssen einem validen Muster für den Java DateTimeFormatter entsprechen. Siehe dazu die offizielle Dokumentation. Standardwert: yyyyMMdd'T'HHmmss'Z' | ||||||||||
“Log All Requests” | Wenn diese Option aktiviert wird, werden alle Requests and die Sitecore API in sitecore-request-log.csv geloggt. | ||||||||||
“Dump JSON on Error” | Wenn diese Option aktiviert wird, werden bei Fehlern während der Verarbeitung eines Items, die volle JSON Response dieses Items in error-json-dump.csv geloggt. |
Um einen API-Key zu erstellen, gehen sie in den Sitecore Content Editor und navigieren Sie zu sitecore -> System -> Settings -> Services -> API Keys.
Dort können Sie einen „OData Item Key“ erstellen.
Als Database sollten Sie „web“ konfigurieren, damit tatsächlich nur Items gefunden werden, die gepublished wurden. Bei Allowed Controllers muss „*“ eingetragen werden und letztendlich muss ein Impersonation User angegeben werden. Dieser User muss auf alles im Sitecore Zugriff haben, damit erfolgreich indiziert werden kann.
Der API-Key ist die ID des erstellten Keys:
In Mindbreeze können Sie dann im Network Tab einfach ein Password Credential mit dem API-Key anlegen:
In dieser Sektion werden Probleme behandelt, die in Sitecore auftreten können und zu einem Fehler im Connector führen.
In Sitecore können beim Erzeugen von Items Metadaten erstellt und frei benannt werden. Während Metadaten mit dem exakt gleichen Namen normalerweise nicht zugelassen werden, können doch Metadaten erzeugt werden, die dann auf denselben Namen normalisiert werden, zum Beispiel „my metadata“ und „my_metadata“ würden von der Sitecore API beide als „my_metadata“ zurückgeliefert werden. Dies führt dazu, dass beim Abholen der Items eine Response mit dem Statuscode 500 und einer Message mit „An item with the same key has already been added“ gesandt wird.
Um diesen Fehler zu beheben, müssen die duplikaten Metadaten umbenannt werden.