Polarion Wikiseiten. POLARION ALM StartUp Training. Erste Schritte mit Polarion

Transkript

1 Polarion Wikiseiten POLARION ALM StartUp Training Index: Wikiseiten Erstellen Löschen, Verschieben, Umbennen Editieren Grafiken einbinden Suchabfragen Traceability Übungen Erste Schritte mit Polarion Wikiseiten dienen uns als schnelle und mächtige Suchabfrage in einem Projekt. Hier lassen sich beispielsweise alle Work Items mit dem gleichen Status in einer Liste darstellen, oder eine tabellarische Übersicht der verlinkten Work Items ausgeben. Die Möglichkeiten eine Wikiseite zu gestalten sind mannigfach. Zum programmieren des Wikis dient eine einfache Scriptsprache, die über eine integrierte Syntax-Hilfe schnell zum Ziel führt. Üblicherweise gehört es nicht zu der Aufgabe normaler Polarion Benutzer den Code einer Wikiseite zu modifizieren. Für diese Aufgabe sollte es im Unternehmen ein paar spezialisierte Power User geben, welche sich mit der Pflege dieser Seiten beschäftigen. Polarion Handout - Wikiseiten Seite - 1 v4r0

2 Wikiseiten Neben den Polarion Dokumenten gibt es noch Wikiseiten, welche viele verschiedene Aufgaben im Projekt übernehmen können. Beispielsweise zur Niederschrift von Workflow Definition, Projektstruktur, Prozessbeschreibungen, Inhaltsverzeichnis. Neben diesen statischen Inhalten kann die Wiki Skriptsprache auch der dynamischen Suchabfrage im Repository dienen. So lassen sich auf einfache Weise alle Work Items mit bestimmten Eigenschaften aus dem Repository herausfiltern und in verschiedenster Form darstellen. Die verwendete Wiki-Syntax ist dabei eine Mischung aus HTML und eigener Skriptsprache. Wikiseiten erstellen Genau wie Dokumente werden Wikiseiten über den Actions Menüpunkt angelegt. Zu beachten ist, dass Wikiseiten im Menü als Page benamst werden. Wikiseiten löschen, verschieben, umbenennen Ein Umbenennen oder Verschieben von Wikiseiten ist aus technischen Gründen leider nicht möglich. Als Workaround kann man jedoch eine neue Wikiseite erstellen und den Inhalt händisch hinein kopieren. Dateianhänge müssen bei diesem Vorgehen jedoch ebenfalls zur neuen Wikiseite hochgeladen werden. Das Löschen geschieht wie gewohnt über den Delete Button. Entgegen dem Löschvorgang bei Dokumenten werden angezeigte Work Items hier aber nicht gelöscht. Wikiseiten editieren Eine Wikiseite hat zwei verschiedene Ansichten. Die Normalansicht ist der Standard und zeigt sich dem Benutzer sofort nach Besuch der Seite. Zur Editieransicht kommen wir über die Tools- Leiste. Polarion Handout - Wikiseiten Seite - 2 v4r0

3 Über dem Preview Button kann die Vorschau aufgerufen werden. Mit Back to Edit geht es von dort zurück zur Editieransicht. In der Editieransicht erscheint automatisch in der rechten Leiste eine Syntax Hilfe. Grafiken einbinden Um Wikiseiten mit Grafiken verschönern zu können, müssen diese vorher auf die Wikiseite hochladen. Dies geht nur über die Tools-Leiste in der Normalansicht! Unter der Wikiseite erscheint daraufhin die Attachments Sektion. Nach dem Upload kann die Grafik im Dokument verwendet werden (Siehe Syntax Help / Images für mehr Details). {image:bild.png} Suchabfragen Dynamische Suchabfragen in den Wikiseiten dienen dazu, immer wiederkehrende Suchabfragen nicht umständlich über die Suchfunktion der Table oder Treeview zu generieren. Die Syntax hinter diesen Suchabfragen hat folgende Form: {workitems: project.id:### AND type:### AND status:### fields=###,###,###} Projekt ID AND Work Item Type AND Work Item Status Work Item Attribute, die angezeigt werden sollen Polarion Handout - Wikiseiten Seite - 3 v4r0

4 Die Codezeile besteht aus einem workitems Macro, welches mehrere Suchabfragen kombiniert (nur Work Items aus diesem Projekt, nur Work Items eines bestimmten Typs, nur Work Items mit bestimmten Status,...). Nach dem Pipe Symbol kann der Benutzer wählen, welche Attribute des Work Items angezeigt werden sollen. Suchabfragen automatisch generieren Nur wenige Polarion Benutzer werden jemals alle erdenklichen Suchabfragen in Kombination mit den ID s der Attributen im Kopf behalten können. Davon abgesehen wäre dies eine erhebliche Fehlerquelle im Wiki Code. Daher bietet Polarion die Möglichkeit Suchabfragen über eine einfache GUI zu generieren und danach in die Zwischenablage zu kopieren. Von hier aus kann der Code an beliebigen Stellen im Wiki verwendet werden. Diesen Suchabfragengenerator erreicht man über die Table- und Treeview Ansicht. Über das + Symbol lässt sich eine neue Suchabfrage generieren In der rechten Spalte erscheint eine Liste mit allen verfügbaren Attributen. In diesem Beispiel wollen wir alle Work Items des Typs A Test Specification suchen. Mit diesem Button lässt sich die Suchabfrage in einen wikitauglichen Code umwandeln: type:test_spec...welcher dann ohne die Gefahr von Syntaxfehlern in eine Wikiseite übernommen werden kann. Polarion Handout - Wikiseiten Seite - 4 v4r0

5 Traceability Analyse Die Darstellung von Linkbeziehungen ist eines der wichtigsten Features moderner ALM Lösungen. Ohne diese Funktion wäre der Mehrwert gegenüber herkömmlichen, dokumentenzentrischem Vorgehen vergleichsweise gering. In Polarion lassen sich Linkbeziehungen in vielerlei Form darstellen. Wir haben bereits die Ansicht der Linkbeziehungen in der Treeview kennengelernt, oder die Ansicht innerhalb der Details eines Work Items. Ferner gibt es noch die Möglichkeit Linkbeziehungen in der Seitenleiste von Dokumenten darzustellen. Alle diese Möglichkeiten haben jedoch einen Nachteil. Sie bieten dem Benutzer immer nur einen kleinen Ausschnitt des gesamten Beziehungsgeflechts. Von Haus aus gibt Polarion dem Benutzer leider keine eingebaute Lösung für eine umfassende tabellarische Darstellungsform. Über ein Extension Macro lässt sich die Funktionalität aber vergleichsweise schnell auf einer Wikiseite implementieren. Damit die Extension funktioniert, muss entsprechender Macrocode nach dem Polarion Serverstart einmalig aufgerufen werden. Andernfalls bekommt der Benutzer anstatt einer Traceability Table nur eine Codezeile zu Gesicht. Dafür legen wir uns einen neuen Space im Repository Root an, der nur für Macros dienen soll. Dieser Space bekommt zwei Wikiseiten (DynamicTraceabilityTable und ExtensibleTraceabilityTable), in die der Macrocode unserer Extension kopiert wird. Bitte an dieser Stelle auf die korrekte Namensgebung der beiden Wikiseiten achten, da die Seitennamen im Code abgefragt werden. Auf ihrem USB-Stick befindet sich ein Extension Ordner, in dem sich die entsprechende Extension befindet. Nach dem Entpacken müssen Sie nur noch den Inhalt der beiden Textdateien in die entsprechende Wikiseite kopieren. Polarion Handout - Wikiseiten Seite - 5 v4r0

6 Für die eigentliche Traceability Table wird nun eine weitere Wikiseite benötigt, welche dann über folgenden Code die Linkbeziehungen in einer Tabelle darstellt. Achtung Achtung dieser Code muss vom Benutzer an seine Bedürfnisse angepasst werden. Welche Attribute der Work Items sollen in der Tabelle angezeigt werden? Welche Art von Linkbeziehung soll in der Tabelle berücksichtigt werden? Welche Work Item Typen sollen in den Spalten angezeigt werden? Ist alles richtig konfiguriert, kann eine mögliche Lösung so aussehen... Polarion Handout - Wikiseiten Seite - 6 v4r0

7 Übungen 1. Erstellen Sie eine Wikiseite namens Requirements in discussion im Specification Space. Die Seite soll, wie der Name schon erahnen lässt, eine dynamische Suchabfrage enthalten, welche alle User Requirements anzeigt die sich im Status in_discussion befinden. Die angezeigten Attribute der Work Items sollten sinnvoll gewählt werden. Verfügbare Projekte: User_Training Verfügbare Status nach Work Item Typ sortiert: task -> to_do, done user_requ -> in_discussion, accepted, reopened syst_spec -> draft, specified, implemented test_spec -> draft, specified, test_failed, test_passed Verfügbare Attribute.: title, type, description, resolution, categories, timepoint, approvals, assignee, author, comments, attachments, linkedworkitems, workrecords, hyperlinks, planningconstraints, status, severity, priority, previousstatus, duedate, initialestimate, timespent, remainingestimate, plannedstart, plannedend, linkedrevisions Eine mögliche Lösung könnte so aussehen... Polarion Handout - Wikiseiten Seite - 7 v4r0

8 Product: POLARION ALM STARTUP TRAINING Author: MARCO MATUSCHEK Editor: WILLERT SOFTWARE TOOLS GMBH Hannoversche Straße 21 DE Bückeburg Phone: info@willert.de Polarion, Polarion Software, Polarion ALM, Polarion ALM Enterprise, Polarion ALM Pro, and Polarion Track & Wiki are worldwide trademarks or registered trademarks of Polarion Software MS Word is a registered trademark of Microsoft Corporation Polarion Handout - Wikiseiten Seite - 8 v4r0