Atlassian Confluence Sitemap Generator Add-On
Copyright ©
Mindbreeze GmbH, A-4020 Linz, .
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.
Einleitung
Das Mindbreeze Sitemap Generator Add-On erzeugt eine Sitemap der Pages und Spaces bzw. Blogs und Anhänge aus Atlassian Confluence. Die Auswahl der enthaltenen Inhalte erfolgt über den verwendeten Benutzer, da dessen Zugriffsrechte berücksichtigt werden, sowie über Ausschlüsse mittels Regulären Ausdrücken. Details dazu finden Sie im Abschnitt Konfiguration.
Vorbereitung
Das Mindbreeze Sitemap Generator Add-On benötigt die Remote API-Schnittstelle von Atlassian Confluence. Diese können Sie unter „Weitere Konfiguration > Remote API (XML-RPC & SOAP)“ aktivieren.
Installation
Das Add-On wird im Menüpunkt „Add-Ons verwalten“ mit der Aktion „Add-On hochladen“ installiert:
Achtung: Es gibt zwei verschiedene Versionen des Plugins. Für Version 5.1 bzw. 5.6 oder höher. Bitte stellen Sie sicher, die passende Version des Add-Ons zu installieren, die Ihrer Atlassian Confluence Version entspricht.
Die höchste aktuell unterstütze Version finden sie in der Produktinformation.
Wählen Sie die mit „Datei auswählen“ die Datei „sitemap-generator-<Versionsnummer>.jar“ und bestätigen Sie mit „Hochladen“:
Das Plugin ist fertig installiert:
Konfiguration
Die Einstellungen des Mindbreeze Sitemap Generator Add-Ons können mit der Schaltfläche „Konfigurieren“ angepasst werden:
Sitemap Generating User: Atlassian Confluence Benutzer, mit dem die Sitemap erzeugt wird. Standardwert admin
Sitemap Downloader Group: Nur Mitglieder der angegebenen Atlassien Confluence Gruppe dürfen die Sitemap herunterladen. Standardwert: confluence-users
ACL Encryption Password: wenn dieser Parameter nicht leer ist, werden die ACL Elemente mit dem hier gesetzten Password verschlüsselt.
Confluence Base URL: die Basisadresse der Seiten in der Sitemap (URL location). Dies sollte verwendet werden, wenn über ein dediziertes Front End Service die Inhalte runtergeladen werden. Standardmäßig wird der in Confluence konfigurierte Base URL verwendet.
Sitemap Cache Directory: das Verzeichnis, in dem die erzeugte Sitemap abgelegt wird. Standaradwert: Confluence Home.
Use ACL Size Optimization: Optimiert die ACL-Größe in der Sitemap.
Disable Parent Reference Metadata for Pages: wenn aktiv, wird kein Referenz Metadatum auf das übergeordnete Dokument für Confluence Seiten generiert. Dadurch wird die Anzahl der Datenbankabfragen geringer.
Add Performance Metrics To Sitemap: wenn aktiv, werden die benötigten Zeiten für Sitemap-Generierungs Tasks als Kommentar in die Sitemap eingetragen.
ACL Exempt Group Name (ex. confluence-administrators): Confluence befreit standardmäßig die Mitglieder der Gruppe confluence-administrators vor der Zugriffsüberprüfung. Bei den Mindbreeze Dokument ACLs sind diese standardmäßig nicht befreit. Sollten einer Gruppe Leserechte auf alle Inhalte zur Verfügung gestellt werden, kann diese hier erfolgen.
Inspect Space with ID: Id eines Spaces, bei dem die Sitemap-Erzeugung detailliert protokoliert wird.
Run in Logging Mode before Generation: Der Sitemap Generator wird zuerst in einem Logging-only Modus ausgeführt, bevor er tatsächlich die Sitemap generiert. Nur für Debugging/Diagnose. Damit diese Option korrekt funktioniert, muss die Klasse com.mindbreeze.enterprisesearch.connectors.atlassian.confluence.GenerateSitemapJobBase als Log Ebene in Confluence, mit mindestens Level INFO, hinzugefügt werden.
Skip Sitemap Generation: Es wird keine Sitemap erstellt. Diese Option sollte nur in Kombination mit „Run in Logging Mode before Generation“ aktiviert werden. Somit wird die Sitemap Generation nur im Logging-Only Modus ausgeführt.
Erzeugen & Abrufen der Sitemap
Erzeugen der Sitemap
Die Sitemap wird mit einer geplanten Aufgabe erzeugt. Unter Administration > „Geplante Aufgaben“ steht die Aufgabe „scheduledjob.desc.mindbreezeGenerateSitemapJob“ zur Verfügung. Unter „Bearbeiten“ kann ein Cron-Ausdruck angegeben werden. Mit „Starten“ wird die Sitemap einmalig erzeugt.
Abrufen der Sitemap
Die Sitemap ist unter <Atlassian Confluence URL>/plugins/servlet/sitemapservlet?jobbased=true verfügbar.
Logs und Fehleranalyse
Unter Administration > „Protokoll- und Profilerstellung“ können Sie die gewünschte Protokollierungsstufe für das Atlassian Confluence Sitemap Generator Add-On einstellen.
Dafür müssen Sie einen neuen Eintrag mit dem Paketnamen „com.mindbreeze.enterprisesearch.connectors“ anlegen und die gewünschte Ebene auswählen.
Die Protokollnachrichten sind in <Confluence Home>/logs/atlassian-confluence.log verfügbar.