Reports registrieren

Produktlinien: Standard, Expert
Module: Leistung & CRM
Erstellt: 23.04.2007, Änderung:
Artikel umgestellt und angepasst auf Vertec 6.3.
Mehr ansehen

Damit ein Report in Vertec über das Drucken-Menü aufgerufen werden kann, muss er registriert werden.

Um einen Report zu registrieren, klicken Sie mit der rechten Maustaste auf den Ordner Einstellungen > Berichtsvorlagen und wählen Sie:

Folgende Felder werden bei allen Berichtstypen gleich registriert:

  • Name: Name, unter dem der Bericht im "Drucken" Menü erscheint.
  • Aktiv: Nur aktive Reports erscheinen in den Menüs. Wenn Sie also einen Report nicht verwenden wollen, können Sie ihn hier einfach deaktivieren.
  • Gruppierung / Einzelindex: Bei vielen verschiedenen Berichten kann das Drucken-Menü für einen bestimmten Eintrag schnell einmal unübersichtlich werden. Um dem abzuhelfen, können Berichte bei der Registrierung gruppiert und sortiert werden. So lassen sich mehrere Berichte zu einer Gruppe zusammenfassen, welche jeweils dann durch einen Trennstrich von den übrigen Berichten abgetrennt werden.Die Gruppierung wird aktiviert, indem auf dem Bericht im Feld Gruppierung eine Gruppennummer eingetragen wird. Alle Berichte mit derselben Gruppennummer werden im Menü zu einer Gruppe zusammengefasst. Die verschiedenen Gruppen werden in der Reihenfolge ihrer Gruppennummer dargestellt.

    Standardmässig sind die Berichte innerhalb einer Gruppe wiederum alphabetisch sortiert. Falls eine andere Sortierung gewünscht wird, lässt sich dies durch Einsetzen von Zahlen im Feld Einzelindex erreichen.
  • Klassen: Klassennamen, für die der Report vorgesehen ist. Dort erscheint der Report dann im "Drucken" Menü.
  • Bedingung: Bei Berichten kann eine Anzeigebedingung angegeben werden, wann der Bericht im Menü Drucken angezeigt wird und wann nicht. Dies erfolgt via OCL Expression im Feld Bedingung. Durch Klick auf den Button mit den drei Punkten öffnet sich der Expression-Editor. Das Resultat dieser Expression muss ein Ja-/Nein Wert (Boolean) zurückliefern. Ist die Bedingung erfüllt, erscheint der Bericht im Drucken-Menü, sonst nicht. Bei Listenberichten wird der Bericht nur angezeigt, wenn die Bedingung für alle Einträge der Liste erfüllt ist.
  • Ausgabeformat: Je nach Berichtstyp kann zwischen verschiedenen Ausgabeformaten gewählt werden. Was zur Auswahl steht, ist bei den jeweiligen Berichtstypen weiter unten detailliert beschrieben.
  • Einzelreport / Listenreport: Gibt an, ob der Report auf einem einzelnen Objekt oder auf einer Liste von Objekten des angegebenen Datentyps ausgeführt werden kann.

Automatisches Speichern

  • Pfad: Pfad-Vorschlag zum Speichern des Report-Dokumentes. Der Wert %dokpfad% setzt dafür den Dokumentenpfad (Wert des "dokpfad" Attributes) des Objekts, auf dem der Report ausgeführt wird, ein. Es kann aber auch sonst eine OCL-Expression (in % eingefasst) angegeben werden.
  • Betreff: Hier kann ein Betreff angegeben werden, welcher beim Reportdokument eingesetzt wird. Auch hier kann OCL angegeben werden, mit % eingefasst.
  • Dialog zeigen: wenn ja, wird vor dem Ausführen des Reports ein Druckdialog angezeigt, in welchem Speicherpfad, Bemerkung und andere Optionen noch verändert werden können. Ab Version 6.1.0.14 ist auch die Anzeige von Meldungen wie "existierendes File überschreiben" und "neuen Pfad erstellen" an diese Einstellung gekoppelt.
  • Aktivität erzeugen: wenn ja, wird beim Ausführen des Reports eine Aktivität erzeugt, die je nach Einstellung mit folgendem Objekt verknüpft wird:
    • Verknüpfung auf Hauptobjekt: die Aktivität wird mit dem Objekt, von wo aus es gestartet wird, verknüpft.
    • Verknüpfung auf Adresse: die Aktivität wird mit der Adresse, an die das Dokument gesandt wird, verknüpft.
    • Aktivitätstyp: Hier können Sie der erzeugten Aktivität einen Aktivitätstyp zuweisen.

Dokumentvorlagen

Wie die Dokumentvorlagen hinterlegt werden, ist bei den einzelnen Berichtstypen weiter unten detailliert erklärt.

Erweiterte Office-Berichte

Erweiterte Office-Berichte bestehen aus der Kombination einer Word- oder Excel-Vorlage für das Layout sowie einer Bericht-Definition in Form von Python Code für den Inhalt. Alle Informationen dazu finden Sie im Artikel über die erweiterten Office-Berichte.

Zusätzlich zu den oben beschriebenen Feldern stehen bei den Erweiterten Office-Berichten folgende Möglichkeiten zur Auswahl:

  • Als Ausgabeformat kann gewählt werden zwischen Word, Excel und PDF.
    • Word und PDF verwenden immer die Word-Vorlage
    • Excel verwendet immer die Excel-Vorlage

    Passt das eingestellte Ausgabeformat nicht zu den registrierten Vorlagen – wird  z.B. Excel gewählt, wenn nur eine Word-Vorlage hinterlegt ist – erscheint eine Fehlermeldung.

Dokumentvorlagen

  • Unter Dokumentvorlagen wird das entsprechende Vorlagendokument ausgewählt. Bei Word-Reports ist dieses ein Word-Dokument mit der Dateiendung .docx. Bei Excel-Reports ein Excel-Dokument mit der Dateiendung .xlsx.
  • Die Übersetzungen der Reports in die verschiedenen Sprachen erfolgen durch den Vertec Übersetzungsmechanismus.
  • Übersetzung in Projektsprache aktivieren (ab Vertec 6.3): Wenn aktiviert, hat das folgende Auswirkungen:
      • Berichte, die auf einzelnen Objekten ausgeführt werden, welche eine definierte Beziehung zu einem Projekt haben (z.B. Rechnungen oder Projektauswertungen, werden in diese Projektsprache übersetzt (bzw. alle mit Translation versehenen Labels).
      • Berichte, die auf mehreren Objekten ausgeführt werden (Listenberichte), werden in die aktuelle Vertec Oberflächensprache übersetzt.

Da sich die Excel- und die Word-Vorlagen die Code-Basis teilen, kann in derselben Registrierung auch beides gleichzeitig registriert werden:

Bericht-Definition

Auf der Seite Bericht-Definition wird der Python-Code für die angegebene Vorlage hinterlegt.

Der interne Name bezeichnet den von Vertec mitgelieferten Code. Dieser heisst gleich wie der mitgelieferte Report und wird unter dem Reiter Eingebaut angezeigt.

Unter dem Reiter Anpassung kann der mitgelieferte Code überschrieben werden. Sobald unter Anpassung Code vorhanden ist, gilt nur noch dieser. Um etwas zu ändern, muss also der komplette Code aus Eingebaut kopiert und dann unter Anpassung geändert werden.

Vom Kunden selbst oder auf Auftrag erstellte erweiterte Office-Berichte enthalten keinen eingebauten Code und keinen Internen Namen, sondern der Code wird direkt im Feld Anpassung eingefügt.

Um den Code zu testen, kann hier bei Testdaten ein Objekt aus Vertec ausgewählt werden. Ein Klick auf den Button Bericht ausführen führt dann den Report direkt für dieses Objekt aus.

Falls es im Python Code erweiterte Berechtigungen braucht, z.B. für einen SQL-Zugriff, muss das Häkchen Erweiterte Berechtigungen unterhalb der Bericht-Definition gesetzt werden.

Office-Berichte (Word und Excel)

Zusätzlich zu den oben beschriebenen Feldern stehen bei Word- und Excel-Berichten folgende Möglichkeiten zur Auswahl:

Dokumentvorlagen

Unter dem Punkt Dokumentvorlagen findet sich die Liste der Dateien, die als Reportvorlagen zur Berechnung des Reports verwendet werden.

  • Vorlage: Die Vorlage kann im Feld über einen Button mit drei Punkten ausgewählt werden. Befindet sich die Vorlage in einem Unterordner des in den Systemeinstellungen angegebenen Vorlagenpfads für Wordberichte, wird der Pfad relativ dargestellt.Die Berichte werden ohne Datei-Endung registriert. Beim Ausführen wird automatisch die gemäss installierter Office Version geeignete Endung gewählt. Der Ablauf ist wie folgt:
    1. Suche nach vorhandenen Templates aufgrund von Stammnamen des Reports.
    2. Bestimmung der Office Version. Berücksichtigung der Dateiendung in folgender Reihenfolge:
      • Excel: xltm, xltx
      • Word: dotm, dotx

    Falls Sie gleichnamige Reports für Word und Excel haben (z.B. Projektliste.xltx und Projektliste.dotx), können Sie die entsprechenden Registrierungen manuell mit der Dateiendung ergänzen.

  • Sprache: Für jede im System definierte Sprache kann eine eigene Vorlage angegeben werden. Beim Drucken wird die Sprache automatisch nach folgenden Kriterien ausgewählt:
    1. Die Sprache des zugehörigen Projekts
    2. Spezialfall Aktivität: Falls kein Projekt zugeordnet ist, so wird die Sprache des zugeordneten Adresseingtrages berücksichtigt.
    3. Für Einträge, welchen kein Projekt zugeordnet werden kann, wird versucht, das Member Sprache zu verwenden.
    4. Falls mit all diesen Varianten keine Sprache gefunden werden konnte, wird die Sprache der Oberfläche verwendet.

    Ist für eine Sprache keine Vorlage definiert, wird die erste Vorlage in der Liste genommen.

  • Jargon: Projekt, Mandat, Alle. Arbeiten Sie mit verschiedenen Jargons (Mandats- und Projektsprache), dann können Sie hier die Berichtsvorlagen zusätzlich nach Jargon unterteilen. Es wird jeweils der Bericht genommen, der für den in den Systemeinstellungen aktuell eingestellten Jargon registriert ist.
  • Name für automatisches Speichern: Hier kann der Speichername für ein neu erstelltes Dokument hinterlegt werden. Neben fixen Texten können OCL-Expressions verwendet werden (mit % eingefasst), die beim Drucken des Berichts verwendet werden. Innerhalb der Platzhalter können beliebige OCL Expression verwendet werden, ausgehend vom aktuellen Objekt des Berichts (im Beispiel des Projekt-Briefes das Projekt).
  • Zusätzlich kann im Platzhalter OCL die Variable betreff verwendet werden, die den aktuellen Wert des Betreffs auf dem Bericht / Seriendruck Dialog enthält. Im Beispiel wird die Nummer der Rechnung als Dateinamen verwendet: %nummer%.Ein weiteres Beispiel ist %date.formatdatetime('yymmdd')%_%nummer%, welches zusätzlich das Datum im Format JJMMTT enthält. Der ausgegebene Speicherpfad lautet in diesem Fall z.B. 190117_19010128.

Generierung durch Vertec

Bei Word-Berichten kann ausgewählt werden, ob sie durch Office oder durch Vertec generiert werden sollen.

Wird diese Einstellung auf Vertec gestellt, kann zusätzlich das Ausgabeformat gewählt werden.

Vertec-generierte Word-Berichte werden von Vertec serverseitig generiert und die resultierenden Dokumente in den Formaten Word oder PDF an die Apps geliefert. Sie sind performant und cloudfähig, stehen also in allen Apps zur Verfügung.

Die Ausführung von Vertec-generierten Word-Berichten ist wesentlich schneller als die von Office-generierten und es wird keine Office-Installation benötigt.

Wir empfehlen deshalb, Word-Berichte immer Vertec-generiert zu verwenden. Weitere Informationen finden Sie im Artikel über die Word-Berichte.

Bei Vertec-generierten Word-Berichten ist auf folgende Einstellungen zu achten:

Der Pfad für automatisches Speichern muss auf dem Server vorhanden sein. Die Reports werden auf dem Server gespeichert. Falls ein Report gleichen Namens bereits besteht oder der Pfad nicht verfügbar ist, erscheint eine entsprechende Abfrage. Ist kein Speicherpfad angegeben, werden die Dokumente temporär gespeichert und übermittelt.Ist in der Konfigurationsdatei Vertec.ini die Option Restrict Filesystem Access aktiviert (Standard bei Cloud Abo Kunden), verhalten sich die Reports wie folgt:

  • Die Berichte werden clientseitig abgespeichert (analog zu Office-generierten Berichten)
  • Keine Speicherung von Berichten in der Web App (auch nicht auf dem Server), nur Download
  • Fehlermeldung, wenn ein Report mit konfiguriertem Speicherpfad via Web App ausgeführt wird. Es kann dann kein Dokument gespeichert und keine Aktivität erstellt werden.

Zugriff auf Berichtsvorlagen

Für Vertec-generierte Word-Berichte braucht der Cloud Server (oder genauer die Session) Zugriff auf das Dateisystem, um von dort die Vorlagen zu laden. Diese befinden sich im Ordner der Systemeinstellung Vorlagen-Pfad für Word-Berichte.Sollen Vertec-generierte Reports gespeichert werden, werden diese im Dokumentenpfad abgelegt.Da der Cloud Server normalerweise mit dem LocalSystem User verwendet wird und dieser keine Zugriffsrechte auf Netzlaufwerke besitzt, müssen die oben genannten Pfade deshalb als UNC Pfade hinterlegt werden nach dem Schema

\\COMPUTERNAME\FREIGABEORDNERNAME

Zum Beispiel \\SERVER1\Reports

Der UNC Pfad muss dabei auf dem gleichen Server liegen, auf dem der Cloud Server Dienst läuft.

Alternativ kann ein Pfad gewählt werden, der auf dem Server lokal vorhanden ist. Hierbei ist zu beachten, dass es sich dabei um Vertec Systemeinstellungen handelt, die für alle gelten. Das bedeutet, dass wenn Sie gewisse Reports auch wie bisher - also Office-generiert direkt auf den Clients - verwenden möchten, dieser "lokale" Pfad auch auf den Clients "lokal" vorhanden sein muss.

Eine andere Möglichkeit, falls der Server für die Dateiablage vom Vertec Server abweicht, ist der Betrieb von Vertec.CloudServer unter einem anderen User. In diesem Fall darf der Vertec.CloudServer Dienst nicht unter dem LocalSystem User laufen, sondern unter einem anderen User (normalerweise ein User aus der Domäne), welcher Zugriff auf das Verzeichnis hat (Freigabe) und lokal über genügend Rechte für den Vertec.CloudServer verfügt.

Dokumentvorlagen erstellen / bearbeiten in den Cloud Clients

Zur Bearbeitung von Dokumentvorlagen via Cloud Clients steht ab Vertec Version 6.1.0.7 ein Upload / Download zur Verfügung. Dies funktioniert wie folgt:

Klicken Sie mit der rechten Maustaste neben die Vorlage, die Sie bearbeiten möchten, und wählen Sie Vorlage bearbeiten...:

oder klicken Sie doppelt in die entsprechende Zeile. Es erscheint der Upload / Download Dialog:

Einen bestehenden Bericht anpassen

  • Download: Um den Bericht zu bearbeiten, klicken Sie auf Download. Der Bericht wird heruntergeladen und Sie werden gefragt, wo Sie ihn lokal speichern möchten (in der Web App wird der Report ins lokale Temp-Verzeichnis abgelegt und direkt zur Bearbeitung geöffnet).
  • Upload: Um den Bericht nach dem Bearbeiten auf dem Server zu speichern, klicken Sie auf Upload. Im Explorer wählen Sie den vorher bearbeiteten Report aus. Dieser wird automatisch im unter Vorlagen-Pfad für Word-Berichte angegebenen Pfad gespeichert.

Einen neuen Bericht registrieren

  • Um einen neuen Bericht zu registrieren, füllen Sie den gewünschten Datei-Namen des Reports in das Feld bei Vorlage, und und gehen dann anschliessend vor, wie beim Bearbeiten der Vorlage (siehe weiter oben - Vorlage bearbeiten > Upload). Sie können den gewünschten Report auswählen, und er wird unter dem angegebenen Namen im unter Vorlagen-Pfad für Word-Berichte angegebenen Pfad abgelegt.

Die Grösse für Uploads ist auf 1 MB beschränkt. Die Beschränkung wird Client- und Serverseitig überprüft.

Download der Berichtsvorlagen beim Ausführen (Cloud App)

Ab Version 6.1.0.7 sind Client-side Office Reports möglich mit der Cloud App, auch wenn kein Zugriff auf das Filesystem auf dem Server besteht. Dafür wird beim Ausführen eines Office Reports die entsprechende Vorlage ins lokale temp-Verzeichnis heruntergeladen und der Report dann mit dieser Vorlage gestartet. Excel-Reports sowie Nicht-Vertec-generierte Word-Reports verhalten sich neu so.

  • Die Vorlagen müssen sich unterhalb des Vorlagen-Pfads befinden. Dateien ausserhalb des Report Pfades können damit nicht heruntergeladen werden.
  • Existiert auf dem Client im temp-Verzeichnis eine Vorlage bereits, wird dieses überschrieben. Falls das nicht möglich ist, wird dem Namen eine Nummerierung angefügt.