Schulungsunterlagen: ARCWAY Cockpit Report Engine. Erstellen und Anpassen von Berichtsvorlagen für ARCWAY Cockpit

Transkript

1 Schulungsunterlagen: ARCWAY Cockpit Report Engine Erstellen und Anpassen von Berichtsvorlagen für ARCWAY Cockpit

2 Agenda 1. Allgemeines zur Berichtsgenerierung 2. DocBook XML 3. Velocity Template Language (VTL) 4. Zugriff auf Cockpit Daten ARCWAY AG - Schulung Berichtsvorlagen 2

3 Online Hilfe zu Berichtsvorlagen Verwenden Sie begleitend zu den Übungen die Detailinformationen aus der Cockpit-Online-Hilfe Wie setze ich Berichtsvorlagen ein und wie passe ich sie an? Wie passe ich Formatvorlagen an? Dokumentation der verwendeten DocBook Elemente Dokumentation der Skriptsprache VTL Dokumentation der Schnittstelle zu ARCWAY Cockpit ARCWAY AG - Schulung Berichtsvorlagen 3

4 Arbeitsweise der Cockpit Report Engine ARCWAY AG - Schulung Berichtsvorlagen 4

5 Online Hilfe zu Berichtsvorlagen Verwenden Sie begleitend zu den Übungen die Detailinformationen aus der Cockpit-Online-Hilfe Wie setze ich Berichtsvorlagen ein und wie passe ich sie an? Wie passe ich Formatvorlagen an? Dokumentation der verwendeten DocBook Elemente Dokumentation der Skriptsprache Dokumentation der Schnittstelle zu ARCWAY Cockpit ARCWAY AG - Schulung Berichtsvorlagen 5

6 Berichtsvorlagen - Header Berichtsvorlage muss mit meinem Header beginnen, in dem das Format des erstellten Berichtes (docbook oder z.b. XML, CVS) die Codierung der Berichtsvorlage die Codierung der Ausgabe-Datei eingetragen sind. Für die Erstellung von Word- oder HTML-Dateien ist der folgende Header zu verwenden: ################### TEMPLATE HEADER ##################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> ARCWAY AG - Schulung Berichtsvorlagen 6

7 DocBook XML <book> <chapter> <section> <para> Oberstes Element mit Titel und Untertitel Hauptkapitel mit Titel Unterkapitel mit Titel <para> Paragraph mit Text Aufgabe 1 Erstellen Sie eine Berichtsvorlage, die einen Bericht der folgenden Struktur generiert: Aufgabe 1 1. Kapitel A 1.1 Unterkapitel a Dies ist ein Text in Unterkapitel a 2. Kapitel B Dies ist ein Text in Kapitel B 2.1 Unterkapitel b ARCWAY AG - Schulung Berichtsvorlagen 7

8 DocBook XML #################### TEMPLATE HEADER ###################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> <book> <title>aufgabe 1</title> <chapter> <title>kapitel A</title> <section> <title>unterkapitel a</title> <para>dies ist ein Text in Unterkapitel a</para> </section> </chapter> <chapter> <title>kapitel B</title> <para>dies ist ein Text in Kapitel B</para> <section> <title>unterkapitel b</title> </section> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 8

9 Textstile für Paragraphen <para role= Textstil > Standard StandardBold StandardSmall StandardSmallBold Name einer Formatvorlage in Word Name einer Klasse in css-datei Aufgabe 2 Erstellen Sie eine Berichtsvorlage, die einen Bericht der folgenden Struktur generiert: Aufgabe 2 1. Kapitel A Dies ist ein Text im Format Standard Dies ist ein Text im Format StandardBold Dies ist ein Text im Format StandardSmall Dies ist ein Text im Format StandardSmallBold ARCWAY AG - Schulung Berichtsvorlagen 9

10 Textstile für Paragraphen ################### TEMPLATE HEADER ##################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> <book> <title>aufgabe 2</title> <chapter> <title>kapitel A</title> <para role= Standard >Dies ist ein Text im Format Standard</para> <para role= StandardBold >Dies ist ein Text im Format StandardBold</para> <para role= StandardSmall >Dies ist ein Text im Format StandardSmall</para> <para role= StandardSmallBold >Dies ist ein Text im Format StandardSmallBold</para> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 10

11 Tabellen - Strukturdefinition <para> oder <section> oder <chapter> <table> <tgroup> <colspec> <colspec> Anzahl Spalten (z.b. cols= 2 ) Spaltenbreite (z.b. colwidth= 40mm ) <thead> <row> <entry> <entry> Kopfzeile mit Einträgen pro Spalte <tbody> <row> <entry> <entry> Tabellenzeilen mit Einträgen pro Spalte <row> <entry> <entry> ARCWAY AG - Schulung Berichtsvorlagen 11

12 Tabellen - Strukturdefinition Aufgabe 3 Erstellen Sie eine Berichtsvorlage, die einen Bericht der folgenden Struktur generiert: Aufgabe 3 1. Kapitel A Spalte 1 Spalte 2 Spalte 3 Zelle 1.1 Zelle 2.1 Zelle 3.1 Zelle 1.2 Zelle 2.2 Zelle 3.2 Zelle 1.3 Zelle 2.3 Zelle 3.3 ARCWAY AG - Schulung Berichtsvorlagen 12

13 Tabellen - Strukturdefinition ################### TEMPLATE HEADER ##################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> <book> <title>aufgabe 3</title> <chapter> <title>kapitel A</title> <table> <tgroup cols="3"> <colspec colwidth="40mm"/> <colspec colwidth="40mm"/> <colspec colwidth="40mm"/> <thead> <row><entry>spalte 1</entry><entry>Spalte 2</entry><entry>Spalte 3</entry></row> </thead> <tbody> <row><entry>zelle 1.1</entry><entry>Zelle 2.1</entry><entry>Zelle 3.1</entry></row> <row><entry>zelle 1.2</entry><entry>Zelle 2.2</entry><entry>Zelle 3.2</entry></row> <row><entry>zelle 1.3</entry><entry>Zelle 2.3</entry><entry>Zelle 3.3</entry></row> </tbody> </tgroup> </table> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 13

14 Textstile für Tabellen <table tabstyle= Tabellenstil > PropertiesTable Table PropertiesTableWithoutFrame Name einer Tabellenvorlage in Word Name einer Klasse in css- Datei <entry role= Textstil > Standard StandardBold StandardSmall StandardSmallBold Name einer Formatvorlage in Word Name einer Klasse in css-datei ARCWAY AG - Schulung Berichtsvorlagen 14

15 Textstile für Tabellen Aufgabe 4 Erstellen Sie eine Berichtsvorlage, die einen Bericht der folgenden Struktur generiert: Aufgabe 4 1. Kapitel A Spalte 1 Spalte 2 Standard StandardBold Tabellenstil: PropertiesTableWithoutFrame StandardSmallBold StandardSmall ARCWAY AG - Schulung Berichtsvorlagen 15

16 Textstile für Tabellen ################### TEMPLATE HEADER ##################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> <book> <title>aufgabe 4</title> <chapter> <title>kapitel A</title> <table tabstyle="propertiestablewithoutframe"> <tgroup cols="2"> <colspec colwidth="40mm"/> <colspec colwidth="40mm"/> <thead> <row><entry>spalte 1</entry><entry>Spalte 2</entry></row> </thead> <tbody> <row> <entry role="standard">standard</entry> <entry role="standardbold">standardbold</entry> </row> <row> <entry role="standardsmallbold">standardsmallbold</entry> <entry role="standardsmall">standardsmall</entry> </row> </tbody> </tgroup> </table> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 16

17 Links Navigation im generierten Dokument und zu Webseiten bzw. Dateien Interne Links <anchor id= eindeutigeid /> <link linkend= eindeutigeid >Text</link> Externe Links zu Webseite <ulink url= >ARCWAY Webseite</ulink> Aufgabe 5 Erstellen Sie eine Berichtsvorlage, die im ersten Kapitel 3 Verweise auf die 3 Unterkapitel in Kapitel 2 enthält. Aufgabe 5 1. Verweise Verweis 1 Verweis 2 Verweis 3 2. Verweiseziele 2.1 Verweisziel Verweisziel Verweisziel 3 ARCWAY AG - Schulung Berichtsvorlagen 17

18 Links #################### TEMPLATE HEADER ###################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> <book> <title>aufgabe 5</title> <chapter> <title>verweise</title> <para><link linkend="1">verweis 1</link></para> <para><link linkend="2">verweis 2</link></para> <para><link linkend="3">verweis 3</link></para> </chapter> <chapter> <title>verweiseziele</title> <section><title><anchor id="1"/>verweisziel 1</title></section> <section><title><anchor id="2"/>verweisziel 2</title></section> <section><title><anchor id="3"/>verweisziel 3</title></section> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 18

19 Skriptsprache Velocity Verwenden Sie begleitend zu den Übungen die Detailinformationen aus der Cockpit-Online-Hilfe Wie setze ich Berichtsvorlagen ein und wie passe ich sie an? Wie passe ich Formatvorlagen an? Dokumentation der verwendeten DocBook Elemente Dokumentation der Skriptsprache Dokumentation der Schnittstelle zu ARCWAY Cockpit ARCWAY AG - Schulung Berichtsvorlagen 19

20 Velocity Template Language VTL Editoren für VTL: Konstrukt Variablen Methodenaufrufe Beispiel $meinevariable $meinevariable.methode() Wertzuweisung #set( $name = Hans ) #set( $i = 1 ) #set( $namen = [ Inge, Willi, Anna ] ) Verzweigung #if ( $i > 0 ) weitere Anweisungen #elseif weitere Anweisungen #else weitere Anweisungen Schleife #foreach ( $name in $namen) weitere Anweisungen ARCWAY AG - Schulung Berichtsvorlagen 20

21 Zuweisung, Verzweigung und Schleife Aufgabe 6 Erstellen Sie eine Berichtsvorlage, in der die Texte Zeile 1, Zeile 2, Zeile 3 und Zeile 4 in einer Schleife ausgegeben werden. Zeile 3 soll dabei in Fettschrift ausgegeben werden. : Aufgabe 6 1. Zeilen Zeile 1 Zeile 2 Zeile 3 Zeile 4 ARCWAY AG - Schulung Berichtsvorlagen 21

22 Zuweisung, Verzweigung und Schleife #################### TEMPLATE HEADER ###################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> #set( $lines = ["Zeile 1", "Zeile 2", "Zeile 3", "Zeile 4"] ) <book> <title>aufgabe 6</title> <chapter> <title>zeilen</title> #foreach($line in $lines) #if($line == "Zeile 3") <para role="standardbold">$line</para> #else <para role="standard">$line</para> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 22

23 Makros Zusammenfassung wiederkehrender Funktionen in Makros Defintion: #macro (makroname $arg1 $arg2) Anweisungen Verwendung: #makroname( wert1, $var) Definition muss vor Aufruf erfolgen! Call by Reference! D.h. im Makro kann $var geändert werden! Aufgabe 7 Erstellen Sie eine Berichtsvorlage mit einem Makro zeilenausgabe, welches in einer Schleife mit den Werten 1-5 aufgerufen wird und daraufhin die Texte Zeile 1, Zeile 2, Zeile 3 und Zeile 4 ausgibt: Aufgabe 7 1. Zeilen Zeile 1 Zeile 2 Zeile 3 Zeile 4 ARCWAY AG - Schulung Berichtsvorlagen 23

24 Makros #################### TEMPLATE HEADER ###################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> #macro( zeilenausgabe $value ) <para>zeile $value</para> #set( $values = [1,2,3,4,5] ) <book> <title>aufgabe 7</title> <chapter> <title>zeilen</title> #foreach($value in $values ) #zeilenausgabe( $value ) </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 24

25 Schnittstelle zu Cockpit Daten Verwenden Sie begleitend zu den Übungen die Detailinformationen aus der Cockpit-Online-Hilfe Wie setze ich Berichtsvorlagen ein und wie passe ich sie an? Wie passe ich Formatvorlagen an? Dokumentation der verwendeten DocBook Elemente Dokumentation der Skriptsprache Dokumentation der Schnittstelle zu ARCWAY Cockpit ARCWAY AG - Schulung Berichtsvorlagen 25

26 Benannte Objekte in Cockpit Einstiegspunkte in das Cockpit-Objektmodell Detaillierte Schnittstellenbeschreibung in der Cockpit-Hilfe (nur Englisch) Objektname $projectdataprovider $requirementdataprovider $issuedataprovider $arrayhelper $csvhelper $datetimeprovider Beschreibung Zugriff auf Projekt, Verzeichnisse, Pläne und globale Elemente Zugriff auf Anforderungen und Anforderungssätze Zugriff auf Offene Punkte Hilfsmethoden für den Umgang mit Arrays (da Velocity hier wenig Unterstützung bietet) Hilfsmethoden für die Ausgabe von CSV (Comma Separated Values) Dateien Hilfsmethoden für die Abfrage der aktuelle Uhrzeit und des aktuellen Datums ARCWAY AG - Schulung Berichtsvorlagen 26

27 Zugriffe auf Cockpit Projekte Aufgabe 8 Erstellen Sie eine Berichtsvorlage mit einem Kapitel. Der Titel des Kapitels soll der Projektname sein. Im Kapitel wird der Beschreibungstext zum Projekt ausgegeben. Hierfür ist für jede Zeile in der Beschreibung ein Paragraph im Bericht auszugeben.: Aufgabe 8 1. Projektname Beschreibungstext ARCWAY AG - Schulung Berichtsvorlagen 27

28 Zugriffe auf Cockpit Projekte #################### TEMPLATE HEADER ###################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> #set( $project = $projectdataprovider.getproject() ) <book> <title>aufgabe 8</title> <chapter> <title>$projectdataprovider.getname()</title> #foreach($line in $projectdataprovider.getdescription()) <para role="standard">$line</para> </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 28

29 Rekursive Abwicklung von Bäumen Aufgabe 9 Erstellen Sie eine Berichtsvorlage, die für jedes Verzeichnis im Projektnavigator ein Kapitel bzw. Unterkapitel in Word erzeugt und dort den Beschreibungstext ausgibt. Legen Sie dazu eine Verzeichnisstruktur in Cockpit an: Aufgabe 9 1. Kapitel Unterkapitel Unterkapitel Kapitel Unterkapitel Unterkapitel Unterkapitel Unterkapitel 2.2 ARCWAY AG - Schulung Berichtsvorlagen 29

30 Rekursive Abwicklung von Bäumen #################### TEMPLATE HEADER ###################### ##targettype="docbook" ##templateencoding="cp1252" ##targetencoding="utf-8" ########################################################### <?xml version="1.0" encoding="utf-8"?> #set( $project = $projectdataprovider.getproject() ) #macro( writefolder $folder ) <title>$folder.getname()</title> #foreach($line in $folder.getdescription()) <para role="standard">$line</para> #foreach( $subfolder in $folder.getsubfolders() ) <section> #writefolder( $subfolder ) </section> <book> <title>aufgabe 9</title> #foreach($folder in $project.getrootfolders()) <chapter> #writefolder( $folder ) </chapter> </book> ARCWAY AG - Schulung Berichtsvorlagen 30

31 Zugriff auf weitere Eigenschaften Identifikation der Eigenschaft über eindeutige ID (z.b. custom.effort) Alle Objekte, für die weitere Eigenschaften angelegt werden können, unterstützen die Methoden der Interface-Spezifikation ICustomPropertiesAccess (Details siehe Cockpit-Hilfe) Methode Beschreibung hascustomproperties() Prüft, ob für das Objekt weitere Eigenschaften eingerichtet sind. getallcustompropertyids() getdatatypedisplaynameofproperty(propertytypeid) getdisplaynameofproperty( propertytypeid) haspropertyvalue(propertyid) getpropertyasstring(propertyid) getpropertyasstringarray(propertyid) getpropertyasstringlist(propertyid) getfileproperty(propertyid) Liefert die IDs aller weiteren Eigenschaften des Objektes. Liefert Datentyp und Anzeigename der weiteren Eigenschaft. Prüft, ob für die weitere Eigenschaft ein Wert gesetzt ist Liefert der Wert der Eigenschaft als Zeichenkette, Liste oder Array von Zeichenketten (bei mehrzeiligen Texten) oder als Datei.... ARCWAY AG - Schulung Berichtsvorlagen 31

32 Zugriff auf weitere Eigenschaften Aufgabe 10 Erweitern Sie die Berichtsvorlage derart, das nach der Ausgabe der Beschreibung geprüft wird, ob das Verzeichnis über weitere Eigenschaften verfügt. Sind weitere Eigenschaften angegeben, so sollen diese in der folgenden Form ausgegeben werden: -Ein Paragraph im Format StandardBold für das Label -Ein Paragraph im Format Standard für jede Zeile des Wertes der Eigenschaft bzw. für die Grafik, bei eine Eigenschaft vom Typ Datei. Legen Sie verschiedenen weitere Eigenschaften für Verzeichnisse an. Belegen Sie die weiteren Eigenschaften bei einzelnen Verzeichnissen mit Werten und testen Sie Ihren Report. ARCWAY AG - Schulung Berichtsvorlagen 32

33 Zugriff auf weitere Eigenschaften... #set( $project = $projectdataprovider.getproject() ) #macro( writefolder $folder ) <title>$folder.getname()</title> #foreach($line in $folder.getdescription()) <para role="standard">$line</para> #foreach( $id in $folder.getallcustompropertyids()) #if ( $folder.haspropertyvalue( $id ) ) <para role="standardbold">$folder.getdisplaynameofproperty( $id )</para> #if($folder.getdatatypedisplaynameofproperty( $id ).equals( "Datei" )) <para role="standard">$folder.getfileproperty( $id )</para> #else #foreach( $line in $folder.getpropertyasstringlist( $id )) <para role="standard">$line</para> #foreach( $subfolder in $folder.getsubfolders() ) <section> #writefolder( $subfolder ) </section> <book> <title>aufgabe 10</title> #foreach($folder in $project.getrootfolders())... ARCWAY AG - Schulung Berichtsvorlagen 33

34 Kontakt: ARCWAY AG Alt Moabit 90b Berlin ARCWAY AG - Schulung Berichtsvorlagen 34