Communardo Software GmbH, Kleiststraße 10 a, D-01129 Dresden
0800 1 255 255

Empfehlung zur Verwendung von Metadaten in Confluence

Mit wach­sen­der Menge an Informationen die in einem Atlassian Confluence gepflegt wer­den, gewinnt auch das Thema Organisation, Strukturierung und Wiederauffindbarkeit von Informationen zuneh­mend an Bedeutung. Metadaten stel­len eine Möglichkeit dar, die­ser Herausforderung zu begeg­nen. Dazu möchte ich im Folgenden die Optionen des Umgangs mit Metadaten in Confluence kurz auf­zei­gen, um diese von ein­an­der abzu­gren­zen. Ziel die­ses Artikels ist es, eine Empfehlung zur Verwendung von Metadaten hin­sicht­lich der Faktoren Funktionsumfang und Updatefähigkeit von Confluence 4 auf CF 5 auszusprechen.

Verwendung von Metadaten

Durch die Verwendung von Metadaten kön­nen in Confluence Inhalte zusätz­lich zur Bereichs- und Seitenstruktur und den Stichwörtern orga­ni­siert wer­den. Die Metadaten wer­den dabei durch ein Macro an einer Wiki-Seite hin­ter­legt, wodurch diese (z.B. durch andere Macros) zur wei­te­ren Verwendung zur Verfügung ste­hen. Somit kön­nen Informationen nach indi­vi­du­el­len Kriterien auf­be­rei­tet und über­sicht­lich etwa in Form einer Tabelle dar­ge­stellt wer­den. Die fol­gen­den zwei Abbildungen zei­gen wie Metadaten in Confluence prin­zi­pi­ell gepflegt und aus­ge­ge­ben wer­den. (diese ent­spricht auch der Confluence Standardfunktionalität)

Confluence - Pflege von Metadaten

Confluence - Darstellung von Metadaten

Lösungsansätze für Metadaten in Confluence

Metadaten im Confluence Standard (metadata und page properties)

Zum einen lie­fert Confluence selbst im Standard eine Metadatenfunktionalität. Bis ein­schließ­lich Confluence 4.x heißt diese Funktion auch Metadata. Zum Anlegen der Metadaten wird das Macro {details} ver­wen­det, wäh­rend durch das Macro {details­sum­mary} diese aus­ge­ge­ben wer­den kön­nen. Ab Confluence 5.x hei­ßen ent­spre­chende Macros nun Page Properties und Page Properties Report und sind über diese Begriffe im Macrobrowser zu fin­den. Prinzipiell ist deren Funktionalität gleich geblie­ben. Dennoch gibt es einige Veränderungen.

  • neuer Namen im Macrobrowser: Page Properties und Page Properties Report
  • Page Properties Report: neues Design der Ausgabetabelle
  • Page Properties Report: fol­gende zwei neue Parameter 
    • restric­ted to space um die Zielwerte auf einen Bereich in Confluence zu beschränken
    • columns to show um die dar­ge­stell­ten Spalten an Metadaten aus­zu­wäh­len und deren Reihenfolge zu bestimmen

Eine Update der Metadatenfunktionalität von Confluence 4 auf Confluence 5 Page Properties ist dem­nach aus mei­ner Sicht beden­ken­los mög­lich, da hier Confluence Standardfunktionalität ver­wen­det wird.

Metadata PlugIn 2

Zusätzlich zur Confluence Standardfunktionalität gibt es im Atlassian Marketplace das aus his­to­ri­schen Gründen (unaus­ge­reifte Metadatenfunktionalität im Confluence Standard) oft ver­wen­dete Metadata PlugIn 2, das wei­ter­hin seine Daseinsberechtigung durch eine deut­lich umfang­rei­chere Funktionalität hat. Grundlegend wer­den in die­sem Metadaten (ähn­lich wie im Confluence stan­dard) in Tabellenform durch das Macro {metadata-list} ange­legt und durch das Macro {metadata-report} aus­ge­ge­ben. Eine aus­führ­li­che Beschreibung der Funktionen fin­det sich in der eng­li­schen Dokumentation des PlugIns. Das Metadata PlugIn 2 wird inzwi­schen durch die Firma Comalatech sup­por­tet, die bereits einen Confluence 5.1.5‑Support bereit­ge­stellt hat.

Nach Aussage von Comalatech wird das PlugIn wei­ter­hin kos­ten­los ver­füg­bar sein und mit neuen Versionen von Confluence kom­pa­ti­bel gehal­ten werden.

Abgrenzung des Metadata PlugIn 2 zu Metadaten im Confluence Standard

  • Das Metadata PlugIn 2 ist deut­lich umfang­rei­cher und fle­xi­bler in der Auswertung 
    • Darstellung der Tabelle modularer
    • Berechnung von Werten, Datum als Format verwendbar
    • Metadaten und Reports für Bereiche, User, Blogposts und Attachments
  • Suche nach Metadaten aus dem Metadata PlugIn 2 in der Confluence Suche (z.B.: "Farbe:grün")
  • Das Metdata Plugin ist aber noch nicht kom­plett auf den neuen Editor umge­stellt. Die Tabelle im Macro {metadata-list} kann nur durch WikiMarkup erzeugt wer­den (wie im fol­gen­den Screenshot dar­ge­stellt). Dies kann u.U. die Usability für einige Benutzer stören. Confluence Metadata list

Die Kombination von Confluence-Standard-Metadaten und dem Metadata PlugIn 2 ist nicht mög­lich. So kann das {metadata-report} Macro bspw. nicht auf die Metadaten des {details} Macros zugrei­fen um diese mit ein­zu­be­zie­hen. Man sollte sich daher für eine Variante von bei­den entscheiden.

Fazit (tl;dr)

Generell sollte man in Confluence soweit mög­lich bei den Standardfunktionalitäten blei­ben. Dies gilt auch für die Verwendung von Metadaten. So ist auch für alle im Standard gepfleg­ten Metadaten die Updatefähigkeit durch Atlassian trotz der Umstellung von Confluence 4 auf 5 gewähr­leis­tet. Reichen die Standardfunktionen nicht aus, stellt das Metadata PlugIn 2 eine sinn­volle Erweiterung dar.

Die Migration von Metadaten erfolgt von Confluence Standard zu Standard und PlugIn zu PlugIn. Eine Querschnittsmigration bspw. von Metadaten des PlugIn auf Page Properties ist stan­dard­mä­ßig nicht mög­lich. Wer also bis­her das Metadata PlugIn 2 für seine Metadaten ver­wen­det hat, muss die­ses für seine bis­he­ri­gen Inhalte die migriert wer­den sol­len weiterverwenden.

 

Related Posts

Vielen Dank für diese Zusammenfassung.

Allerdings feh­len aus mei­ner Sicht ent­schei­dende Kommentare zu den ein­zel­nen Lösungsansätzen.

Page Properties:
Page pro­per­ties kön­nen der­zeit nur von dem "Page Properties Report" aus­ge­le­sen und ange­zeigt wer­den. Die Page-Properties sind m.W. weder im Such-Index abge­legt noch ander­wei­tig zugreif­bar. Die aktu­elle API ist lei­der sehr ein­ge­schränkt, um die feh­len­den Funktionen hinzuzufügen.

Metadata PlugIn 2:
Dieses Plugin spei­chert m.W. lei­der nur Metadaten auf Basis einer Seite, nicht aber für eine kon­krete Seiten-Version. Für man­che Anwendungsfälle ist das sicher­lich ok, für andere nicht.
Das Plugin erlaubt es mei­nes Wissens der­zeit auch nicht, Metadaten zu löschen. Das erscheint jedoch wich­tig, wenn Seiten lange leben und deren Metadaten in Reports ver­wen­det werden.

Scaffolding plugin:
Es sollte sicher­lich auch das kom­mer­zi­elle Plugin "Scaffolding" der Firma "ServiceRocket" erwähnt wer­den. Es stellt weit über das "Metadata Plugin 2" hin­aus­ge­hende Funktionen zur Verfügung und spei­chert seine Metadaten an Seiten-Versionen. Entsprechend des hohen Funktionsumfanges ist es aller­dings auch kom­pli­zier­ter zu verwenden.

In einem wei­te­ren Artikel soll­ten evtl. Wege auf­zeigt wer­den, wie Metadaten über einen län­ge­ren Zeitraum gepflegt wer­den können.

Mit freund­li­chen Grüßen,
Uwe Völlger

Avatar Florian Zöllner

Hallo Herr Völlger,

danke für Ihren berei­chern­den Kommentar. Sie haben völ­lig Recht, der Artikel umfasst nicht alle Aspekte der Verwendung von Metadaten in Confluence.

Der Auslöser für die­sen Blogbeitrag war ein Anwendungsfall bei einem Kunden hin­sicht­lich einer Systemmigration und exzes­si­ven Verwendung von Metadaten mit dem Metadate 2 PlugIn. Mit den Metadaten des Scaffolding PlugIns habe ich mich ehr­lich gesagt noch gar nicht wei­ter aus­ein­an­der gesetzt, da mir die­ses PlugIn zwar bekannt ist, jedoch bei unse­ren Kunden kaum Anwendung fin­det. Ich danke Ihnen jeden­falls für die Ergänzungen und werde das Thema auf jeden Fall wei­ter ver­fol­gen, denn der Bedarf nach struk­tu­rier­ten Daten in Confluence ist defi­ni­tiv vor­han­den, wie auch die Nachfrage nach unse­rem IT System and Application Catalogue PlugIn zeigt, das hof­fent­lich zeit­nah durch eine gene­ri­sche Lösung erwei­tert wird.

Ich freue auch auf wei­te­res Feedback.

Viele Grüße
Florian Zöllner

Comments are closed.

Pin It on Pinterest