Jive Sitemap Generator

Einleitung

Der Mindbreeze Jive Sitemap Generator ist ein Jive Plugin, das zum Indizieren von Jive Inhalten mit der Mindbreeze InSpire benötigt wird. Das Plugin generiert eine Sitemap mit den Links, Metadaten und Berechtigungen in Form von Access Control Lists für alle Jive Inhalte, die für die Indizierung verfügbar sind.

Das Sitemap Generator Plugin stellt auch die Service Endpoints zur Abfrage von Benutzerinformationen und Gruppenzugehörigkeiten zur Verfügung. Diese werden für die Berechtigungsprüfung bei der Jive Suche benötigt.

Anforderungen

Das Mindbreeze Jive Sitemap Generator Plugin ist verfügbar für Jive 6.*, Jive 8.* und Jive 9.* mit folgenden Einschränkungen:

• Das Jive 6 Plugin kann auf Versionen geringer als Jive 6.0.4.0 installiert werden.
• Das Jive 8 Plugin kann auf Versionen geringer als Jive 8.0.3.0 installiert werden.
• Das Jive 9 Plugin kann auf Versionen geringer oder gleich Jive 9.12.0.0 installiert werden.

Installation und Konfiguration

Das Jive Sitemap Generator Plugin wird als Standard Jive Plugin mithilfe der Jive Administration Console installiert. Die Konfiguration des Plugins wird über das Setzen von System Properties realisiert. Die Properties werden im weiteren Verlauf dieses Dokuments detailliert beschrieben.

Zum Abschließen der Plugin Installation und Konfiguration müssen die Jive Services neu gestartet werden.

Das Jive Sitemap Generator Plugin wird in folgenden Schritten installiert:

1. Installieren Sie das Plugin (mindbreeze-sitemapgenerator-*.jar) entsprechend Ihrer Jive Version, indem Sie das Plugin in die Jive Administrator Console hochladen.

1. Konfigurieren Sie das Plugin in der Jive Administrator Console indem Sie die notwendigen System Properties unter System > Management > System Properties setzen:

1. Starten Sie die Jive Services neu, um die Änderungen zu übernehmen.

Plugin Konfiguration Optionen

Wie bereits erwähnt, wird das Jive Sitemap Generator Plugin mit System Parameters konfiguriert. Das Plugin generiert parallel zwei Sitemap-Instanzen, eine „full“ Sitemap und eine „delta“ Sitemap. Die full Sitemap enthält typischerweise alle Jive Dokumente und die delta Sitemap enthält nur jene Dokumente, die in dem angegebenen Zeitraum geändert wurden. (In Tagen)

Die Konfigurationsoptionen haben folgende Syntax:

mindbreeze.sitemapgenerator.<propertyname>.<sitemapid>

Die <sitemapid> kann entweder „full“ oder „delta“ sein. Wenn ein Propertyname mit einer <sitemapid> endet, betrifft die Property nur den Sitemap Generator Job der gegebenen sitemapid. Wenn die <sitemapid> fehlt, wird die Property auf beide, full und delta Sitemap Generator Jobs angewandt.

Folgende System Properties können für die Konfiguration verwendet werden:

1. „mindbreeze.sitemapgenerator.activeInstancePattern” : regulärer Ausdruck, der die Node ID der Jive Node matched, auf den das Sitemap Generator Plugin läuft. Wenn nicht gesetzt werden alle Nodes im Jive Cluster den Sitemap Generator Task starten.
2. „mindbreeze.sitemapgenerator.authorizedUserPattern”: regulärer Ausdruck, der die Benutzernamen matched, welche Zugriff auf die generierte Sitemap unter folgenden Link haben: http://jiveserver.mycompany.com/rpc/rest/mindbreeze/sitemap?jobid=full für die „full“ Sitemap und http://jiveserver.mycompany.com/rpc/rest/mindbreeze/sitemap?jobid=delta für die „delta“ Sitemap. In den diesen Links ist der Teil die Basis-URL der Jive-Installation.
3. „mindbreeze.sitemapgenerator.contentModificationDateAgeInDays”: das maximale Alter (Zeit seit der letzten Änderung) der Jive Inhalte in Tage. Typischerweise ist diese Einstellung nur in der „delta“ Instanz konfiguriert. Der Property Name ist dann entsprechend: „mindbreeze.sitemapgenerator.contentModificationDateAgeInDays.delta”
4. „mindbreeze.sitemapgenerator.taskCronExpression”: eine Extended Cron Expression, welche die Sitemap Generator Jobs plant. Der Planungs-Ausdruck kann für „delta“ und „full“ Sitemap Generator Jobs konfiguriert werden mit den Properties „mindbreeze.sitemapgenerator.taskCronExpression.delta“ sowie „mindbreeze.sitemapgenerator.taskCronExpression.full“.
   Eine Dokumentation und Beispiele zu Cron Expressions finden Sie hier.
   Einige weitere Beispiele:
   • 0 0 12 * * ? startet um 12:00 Mittags, jeden Tag;
   • 0 15 10 ? * * startet um 10:15 jeden Tag;
   • 0 15 10 15 * ? startet um 10:15 an jeden 15. Tag jedes Monats;
5. „mindbreeze.sitemapgenerator.externalIdentityTypes”: eine Liste in Form eines JSON-Arrays der externen Identitätstypen, welche durchsucht werden wenn Benutzerinformationen aufgelöst werden. Zum Beispiel: ["saml"]. Wenn ein gegebener Benutzer die “saml” Identität besitzt, wird der “saml” Principal-Name auch als Benutzername aufgelöst.
6. „mindbreeze.sitemapgenerator.writeURLTagDescription”: eine Inhaltsbeschreibung wird als URL Metadatum in der Sitemap gesetzt.
7. „mindbreeze.sitemapgenerator.encryptionPassword”: wenn diese Property gesetzt ist, werden alle Benutzernamen in der Sitemap und in der Ausgabe des Principal Resolution Services verschlüsselt mit den gegebenen Passwort.
8. „mindbreeze.sitemapgenerator.authorProfileFilter.valueRegex“: wenn diese Property gesetzt ist, werden nur Inhalte aus Jive Container in der Sitemap inkludiert, bei denen die konfigurierte Profil-Property des Container-Admins matcht. Die Profil-Property wird mit der Property „mindbreeze.sitemapgenerator.authorProfileFilter.key“ konfiguriert.
   Wenn man beispielsweise nur Inhalte indizieren will, die aus Jive Container kommen, bei denen die Admins aus der Marketing-Abteilung kommen, kann dies folgendermaßen konfiguriert werden:
   mindbreeze.sitemapgenerator.authorProfileFilter.key = Department
   mindbreeze.sitemapgenerator.authorProfileFilter.valueRegex = .*Marketing.*
9. „mindbreeze.sitemapgenerator.customBaseURL“: wenn diese Property gesetzt ist, werden alle  URLs in der Sitemap auf den konfigurierte Basis-URL geändert.

Service Endpoints

Nachdem das Jive Sitemap Generator Plugin installiert und konfiguriert ist, sind folgende Services auf dem Jive Server verfügbar:

Sitemap Download

• „Full” Sitemap: <jive_base_url>/rpc/rest/mindbreeze/sitemap?jobid=full
• „Delta” Sitemap: <jive_base_url>/rpc/rest/mindbreeze/sitemap?jobid=delta

Principal Resolution

• Alle Benutzer: bietet eine Liste aller Jive Benutzernamen an <jive_base_url>/rpc/rest/mindbreeze/allusers
• Alle Gruppen: bietet eine Liste aller Jive Gruppennamen und Social-Gruppennamen an <jive_base_url>/rpc/rest/mindbreeze/allgroups
• Mitglieder: bietet die Mitglieder einer gegebenen Jive Gruppe oder Social Gruppe an. Der Name der Gruppe kann mit dem Query-Parameter „groupname“ angegeben werden. <jive_base_url>/rpc/rest/mindbreeze/members?groupname=<groupname>
• Containers: bietet die Container der Gruppen und Social-Gruppen eines gegebenen Benutzernamen an. Der Name des Benutzers kann über den Query-Parameter “username” angegeben werden. <jive_base_url>/rpc/rest/mindbreeze/members?username=<username>

Der Zugriff zu allen Mindbreeze Diensten kann mit folgenden System Property als regulären Ausdruck eingeschränkt werden: „mindbreeze.sitemapgenerator.authorizedUserPattern“.