Legacy Word-Berichte

Hinweis: Legacy Word-Berichte werden nicht mehr weiterentwickelt, da klar empfohlen wird, mit Office-Berichten zu arbeiten. Diese sind cloudfähig, perfomant und können PDF-, Word- und Excel-Dateien generieren.

Mit dem Legacy Word-Report-Mechanismus von Vertec können benutzerdefinierte Berichte in MS Word entworfen und direkt aus Vertec ausgeführt werden. Die Möglichkeiten gehen dabei über die in Word eingebauten Serienbrief-Funktionalitäten heraus.

Ein Legacy Word-Report basiert immer auf einer Dokumentvorlage in Word. Diese Report-Vorlage enthält neben normalem Text spezielle Elemente, die beim Ausführen ausgewertet werden. Diese werden hier nachfolgend beschrieben:

Bänder sind die Grundlagen von Legacy Word-Reports. Alles, was gedruckt wird, befindet sich in einem Band.

Ein Band wird in der Report-Vorlage durch eine Textmarke dargestellt. Der Name der Textmarke ist der Band-Name.

Erstellen Sie dort, wo Sie ein Band erstellen möchten, einen Beispiel-Text im gewünschten Layout (z.B. eine Tabelle, Zeilen mit Tab etc.). Markieren Sie dann diesen Text und klicken Sie auf "Einfügen - Textmarke...". Es öffnet sich das Fenster, in dem Sie den Namen der Textmarke angeben können. Es empfiehlt sich, dabei einen Namen zu wählen, bei dem erkennbar ist, um was es sich handelt (also nicht Band1, Band2 etc.). Das erleichtert später das Anpassen der Bänder und der Ausdrücke in den Expressions.

Die Bänder können frei verschachtelt werden. Jede Report-Vorlage muss aber ein Standard-Band enthalten. Das ist ein Band, das alles andere einschliesst. Sie können also, nachdem Sie die Vorlage erstellt haben, alles markieren und mit einer weiteren Textmarke umschliessen. Der Namen dieser Textmarke spielt keine Rolle.

Ein Band kann bei der Ausführung eines Reports ein- oder mehrmals gedruckt werden. Wird also ein Band auf einer Liste ausgeführt, wird das Band so viel mal gedruckt, wie sich Elemente in der Liste befinden.

Textmarken, deren Name mit trg oder src beginnt, werden vom Vertec Report-Mechanismus nicht gelöscht. Wenn Sie also in Ihrem Dokument Textmarken benötigen, die auch nach dem Ausführen bestehen bleiben, nennen sie diese trg.. oder src...

Band-Definitionen

Je nachdem, wie die Textmarke (Bookmark) eines Bands definiert ist, wird der Umfang des Bands in Office- und Vertec-generierten Berichten geringfügig anders interpretiert. Die Unterschiede haben üblicherweise mit der Behandlung von leeren Abschnitten (Paragraphs) zu tun. Mehr dazu finden Sie im Artikel Unterschiede zwischen Office- und Vertec-generierten Legacy Word-Berichten.

Ein Feld ist ein durch einen Kommentar markierter Text innerhalb eines Bandes, der beim Ausführen des Reports durch Daten aus Vertec ersetzt wird.

Um ein solches Feld zu erstellen, markieren Sie einen beliebigen Text, an dessen Stelle später die Daten aus Vertec eingefügt werden sollen, und klicken Sie auf "Überprüfen - Neuer Kommentar". Der dazugehörige Kommentar muss eine an der entsprechenden Stelle gültige OCL-Expression enthalten.

Um ein Feld zu bearbeiten, klicken Sie mit der rechten Maustaste darauf und wählen Sie Kommentar bearbeiten.

Beispiel von Feldern mit zugehörigem Kommentar in Word:

Band Expressions sind ebenfalls durch Kommentare markierte Textstellen innerhalb eines Bandes. Sie unterscheiden sich von Feldern dadurch, dass der markierte Text immer mit dem Namen des Bandes beginnt, auf das sich die Expression bezieht. Es sind folgende Band Expressions möglich (bndXXX bedeutet dabei der Name des Bandes):

• bndXXXExp: Band Hauptexpression. Falls angegeben, wird der Wert des Bandes aufgrund dieser Expression berechnet. Die Expression bezieht sich auf das Root-Objekt des Reports oder auf den Wert des nächst äusseren Bandes. Falls das Ergebnis dieser Expression einer Liste entspricht, wird das Band für jeden Eintrag der Liste dupliziert.

• bndXXXCond: Band Conditional Expression. Falls angegeben, wird diese Expression bei jedem Auftreten des Bandes ausgewertet (d.h. falls das Band innerhalb einer Liste dupliziert wird, für jedes Objekt). Das Ergebnis der Expression muss ein boolescher Wert sein (Wahr/Falsch). In Abhängigkeit dieses Ergebnisses wird das Band gedruckt oder nicht.

Mit sogenannten Locale-Bands kann ab Vertec 6.1 im Legacy Word-Bericht angegeben werden, nach welche Regionaleinstellungen (Locale) Zahlen- und Datumswerte innerhalb des Bands formatiert werden sollen.

Zum Setzen der Regionaleinstellungen kann folgende Band-Expression verwendet werden:

bndXXXLocale: Ein Kommentar auf <band-name>Locale gibt die Regionaleinstellung an. Dies kann wie folgt geschehen:

• Angabe eines Ländercodes als Locale Expression: de-CH
• Angabe einer OCL-Expression (ab Vertec 6.2), welche als Ergebnis einen Ländercode als String zurückgibt: 'de-CH'

Beispiel

Ein Kommentar auf rchMasterLocale mit Inhalt de-DE setzt die Regionaleinstellung für das gesamte Master-Band auf Deutsch, Deutschland.

Innerhalb dieses Bands werden alle Zahlen und Datumswerte in der entsprechenden Regionaldarstellung dargestellt.

Eine Tabelle mit den Ländercodes finden Sie unter: https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee825488(v=cs.20).

Zahlenformatierung in Vertec Versionen vor 6.2

In Versionen vor Vertec 6.2 werden nur die Werte, welche nach der VBA Format Funktion formatiert sind (Texte mit einem \ beginnend) in den im Locale-Band angegebenen Regionaleinstellungen formatiert:

In Legacy Word-Reports können Bilder eingefügt werden. Diese können entweder aus Vertec (z.B. Belegbilder auf Spesen) oder aus dem Filesystem kommen (nur Office-generiert).

Dafür gibt es spezielle Felder, welche beim Ausführen des Reports nicht durch Text, sondern durch andere Daten ersetzt werden. Um ein solches Feld zu erstellen muss der durch einen Kommentar markierte Text mit einer bestimmten Zeichenfolge beginnen. Diese speziellen Felder werden im Folgenden erklärt.

Solche Felder werden verwendet, um in Vertec gespeicherte Bilder in Legacy Word-Reports einzufügen.

Der durch einen Kommentar markierte Text muss mit der Zeichenkette ImageData beginnen. Die im Kommentar enthaltene OCL-Expression muss den Inhalt eines Bildfeldes in Vertec liefern.

Solche Felder werden verwendet, um auf dem Dateisystem abgelegte Bilder in Legacy Word-Reports einzufügen. Der durch einen Kommentar markierte Text muss mit der Zeichenkette ImagePath beginnen.

Die OCL-Expression muss einen absoluten Pfad zu einer im Dateisystem abgelegten Bilddatei liefern. In Word eingefügt wird dann direkt die Bilddatei, die sich an diesem Ort befindet.

Als OCL-Expression kann der Pfad auch direkt angegeben werden, in einfachen Anführungszeichen:

Ist das Resultat der OCL-Expression ein Leerstring, wird einfach der Kommentar im Word gelöscht und nichts angezeigt. Falls das Bild am angegebenen Ort nicht existiert, wird eine Fehlermeldung anstelle des Bildes in den Bericht eingefügt.

Um die dargestellte Grösse der eingefügten Bilder in Word zu steuern, empfiehlt es sich, diese in einer Tabelle anzuzeigen wie in den gezeigten Beispielen. Die Skalierung in der Tabelle verhält sich wie folgt:

Die eingefügten Bilder werden nicht hochskaliert, weder horizontal noch vertikal. Die Bilder werden aber bei Bedarf runterskaliert:

• Ist ein Bild breiter als die Tabellenzelle, wird es runterskaliert, wenn die automatische Grössenanpassung der Tabelle ausgeschaltet ist.
• Wenn ein Bild höher als die Tabellenzeile ist, wird die Zeile vergrössert, ausser für die Zeilenhöhe wurde in den Tabelleneigenschaften ein genauer Wert gesetzt. Ist für die Zeilenhöhe ein genauer Wert gesetzt und die automatische Grössenanpassung ausgeschaltet, so wird das Bild runterskaliert, damit es in die Zelle passt.

Hier nachfolgend eine Übersicht über die Skalierungen:

Auf die gleiche Art wie die Bilder (siehe oben) kann ab Version 6.0 auch HTML-formatierter Text z.B. aus Textbausteinen in Legacy Word-Reports eingefügt werden.

Dieses Feld wird verwendet, um HTML formatierten Text in Legacy Word-Reports einzufügen. Dieser kann zum Beispiel aus einem Vertec Textbaustein kommen, aber es kann auch ein beliebiges Textfeld angegeben werden, welches formatierten Text enthält. In Word können Sie diesen Text wie folgt einfügen:

Der durch einen Kommentar markierte Text muss mit der Zeichenkette HtmlTextBlock beginnen. Die im Kommentar enthaltene OCL-Expression muss als Resultat einen HTML-Formatierten Text ergeben. Hier im Beispiel das Feld text eines Textbausteines:

Der Wert, der aus der Auswertung des OCL (Kommentar) resultiert, wird als formatierter HTML-Text interpretiert und das Ergebnis in den Report geschrieben.

Es werden die im Artikel Textbausteine beschriebenen Elemente unterstützt, auch innerhalb des HTML berechnete OCL-Expressions.

Vor dem Ausführen eines Legacy Word-Reports werden folgende OCL Variablen angelegt:

• rootObj: Das Objekt auf dem der Report ausgeführt wird
• optArg: Das optionale Zusatzargument (z.B. Adresseintrag)
• betreff: Der Betreff aus dem Report Dialog
• kommentar: Der Kommentar aus dem Report Dialog

Diese Variablen sind in OCL definiert und nur innerhalb einer OCL Expression zugänglich (rootObj und optArg können auch aus den Methodenparametern evaluiert werden (AfterReport3)).

Die Variablen würden für obiges Beispiel folgende Rückgabewerte liefern:

Ab Version 5.3.0.29 können in Legacy Word-Reports lokale OCL Variablen verwendet werden. Mittels einer Var-Expression kann eine Variable erstellt und später im Report wieder verwendet werden. Das verhindert vor allem das erneute Berechnen von Werten, die mehrmals verwendet werden.

Var-Expressions sind Kommentare auf Texten der Form

<bandname><varname>

wobei varname mit "var" beginnen muss.

In einem Rechnungsreport sollen Leistungen nach Tätigkeit gruppiert werden. Dafür werden zuerst die Tätigkeiten eruiert und dann pro Tätigkeit eine Liste der Leistungen ausgegeben. Das heisst, die Leistungen müssen mit einer Expression in der Art bndMaster.leistungen->select(typ=self) gefiltert werden. Die Liste kann nun in die Variable geladen und damit weitergearbeitet werden (z.B. varLeistList.wertext->sum).

Die entsprechende Methode auf IvtcSession heisst

EvalToVariable(root as IVtcObject, expression as String, varname as String)

Damit können auch im Code, zum Beispiel in einem Excel-Report, Werte in Variablen geladen werden, die später in OCL-Expressions verwendet werden können. Insbesondere können auch Ergebnisse von Expressions, welche nur durch die Expression entstehen und nicht in Vertec vorhanden sind, in eine Variable geschrieben werden (beispielsweise das Ergebnis einer Summierung, ein Datumswert mittels encodedate etc.)

Zum Beispiel sollen in einem Excel-Report die Leistungen ab einem bestimmten Zeitpunkt angezeigt werden. Statt nun die Leistungen in der Art "offeneLeistungen->select(datum >=" & encodeDate(2012, 08, 01) & ") " zusammenzusuchen, kann zuerst eine Variable gesetzt und dann verwendet werden:

Vertec.EvalToVariable(Vertec.argobject, "encodeDate(2012,08,01)", "varVon")

und dann in der Expression:

offeneLeistungen->select(datum >= varVon)

Die Legacy Word-Vorlagen funktionieren grundsätzlich gleich, egal ob sie durch Vertec oder durch Office generiert werden, mit folgenden Unterschieden:

Keine BeforeReport / AfterReport Unterstützung

In Vertec-generierten Legacy Word-Reports wird kein kundenspezifischer Code unterstützt, also keine Before- und AfterReport Makros ausgeführt.

Da diese oft verwendet werden, um Werte in die Kopf- oder Fusszeilen zu schreiben, wurde dafür ein alternativer Ansatz entwickelt, der im Abschnitt Datenfelder in Kopf- und Fusszeilen im Artikel Unterschiede zwischen Office- und Vertec-generierten Legacy Word-Berichten beschrieben ist.

Bilder einfügen nur mit ImageData

Das Einfügen von Bildern funktioniert bei Vertec-generierten Legacy Reports nur mit ImageData, nicht mit ImagePath.