WARNUNG: Sie betrachten nicht die Live-Version, sondern eine ältere Version.

Job Execute and Store Reports

Dieser Job erzeugt Reports und speichert sie in einem konfigurierten Ziel. Für jede ausgewählte Person werden – abhängig von der Berichtsaufteilung – ein oder mehrere Berichte erzeugt. Der Report wird über eine Webdesk-Aktion per HTTP erstellt.

Zweck und Ablauf

  • Die Personen werden aus der konfigurierten Auswahl ermittelt, optional nur aktive Personen.
  • Die Berichtsaufteilung bestimmt, für welche Objekte ein Report erstellt wird.
  • Ein optionaler Filter und ein JavaScript-Filter können die Objekte weiter einschränken.
  • Die Report-URL wird mit format, showResult=true, showAll=true und den konfigurierten Aktionsparametern aufgebaut.
  • Die Reports werden parallel erzeugt und im gewählten Ziel gespeichert.

Mehrere TA-Beschäftigungen ab Webdesk 4.64

Für das monatliche Journal (ta_getJournal oder eine davon abgeleitete Aktion) gibt es zwei neue Berichtsaufteilungen. Sie sind für Personen mit mehreren TA-Beschäftigungen vorgesehen. Die Standardauswahl Ein Bericht pro Person bleibt unverändert und exportiert weiterhin nur den für die Person wirksamen TA-Kontext.

Ein Bericht pro TA-Beschäftigung

  • Im Feld Berichtsaufteilung wird Ein Bericht pro TA-Beschäftigung ausgewählt. Der technische Wert lautet ta_employments.
  • Für jede zugeordnete, nicht geplante TA-Beschäftigung wird ein eigener Report erstellt. Dadurch können auch sekundäre und bereits beendete Beschäftigungen archiviert werden, sofern sie in Webdesk zugeordnet sind.
  • Der Report verwendet den Standardmonat der ausgewählten Journal-Aktion. Die Felder Report von und Report bis sind für diese Variante nicht relevant.

Ein Bericht pro TA-Beschäftigung und Kalendermonat

  • Im Feld Berichtsaufteilung wird Ein Bericht pro TA-Beschäftigung und Kalendermonat ausgewählt. Der technische Wert lautet ta_employmentCalendarMonths.
  • Für jeden Kalendermonat jeder zugeordneten, nicht geplanten TA-Beschäftigung wird ein eigener Report erstellt.
  • Mit Report von und Report bis werden die zu exportierenden Monate ausgewählt. Diese Werte werden nicht als ein zusammenhängender Zeitraum an das Journal übergeben.
  • Der erste und letzte Monat werden an den tatsächlichen Beschäftigungszeitraum und den gewählten Berichtszeitraum angepasst. Zukünftige Tage werden nicht exportiert.

Welche Variante soll verwendet werden?

  • Für eine jährliche oder vollständige Archivierung je Beschäftigung: Ein Bericht pro TA-Beschäftigung.
  • Für eine monatliche Ablage, etwa einen PDF-Bericht je Beschäftigung und Monat: Ein Bericht pro TA-Beschäftigung und Kalendermonat.
  • Pro Job wird genau eine Berichtsaufteilung verwendet. Die beiden Beschäftigungsvarianten werden nicht miteinander kombiniert.

Konfiguration der Beschäftigungsvarianten

  1. Als Aktion das monatliche Journal oder eine darauf basierende Aktion auswählen.
  2. Unter Berichtsaufteilung eine der beiden Beschäftigungsvarianten auswählen.
  3. Die automatisch vorgeschlagenen Journalparameter übernehmen. Die erforderlichen Zuordnungen für Person und Beschäftigung werden beim Wechsel der Berichtsaufteilung automatisch ergänzt.
  4. Nur wenn zusätzliche Aktionsparameter benötigt werden, die erweiterten Parameterzuordnungen öffnen.
  5. Vor dem produktiven Lauf eine Vorschau mit einer Person testen, die mindestens zwei TA-Beschäftigungen besitzt. Dabei sowohl die Anzahl der Dateien als auch den Inhalt der Dateien prüfen.

Für die Beschäftigungsvarianten werden insbesondere folgende Werte benötigt:

  • uid: person.UID
  • taId: object.taID
  • Bei der Monatsvariante zusätzlich die Datumsparameter für from und to, abgeleitet aus object.from und object.to.

Die JavaScript-Vorschläge werden abhängig vom Namen, Typ und Datumsformat der Aktionsparameter automatisch erzeugt. Manuelle Änderungen an diesen Zuordnungen können dazu führen, dass mehrere Reports dieselbe Beschäftigung exportieren oder die Konfiguration als ungültig erkannt wird.

Dateipfad und Dateiname

Der Standard-Dateiname enthält die zur Unterscheidung erforderlichen Werte:

  • Bei Ein Bericht pro TA-Beschäftigung die TA-ID über $object.taID.
  • Bei Ein Bericht pro TA-Beschäftigung und Kalendermonat zusätzlich die Monatsgrenzen über $object.from und $object.to.

Der Standard-Dateiname sollte verwendet werden. Bei einer eigenen Velocity-Vorlage müssen mindestens $object.taID und bei der Monatsvariante zusätzlich $object.from und $object.to enthalten sein. So werden Reports verschiedener Beschäftigungen oder Monate nicht überschrieben oder übersprungen.

Für Dateipfad, Metastruktur-Script und JavaScript-Filter stehen unter anderem person, object, action und appCtx zur Verfügung. Das jeweilige object ist bei den Beschäftigungsvarianten entweder eine TA-Beschäftigung oder ein auf diese Beschäftigung begrenztes Monatsintervall.

Allgemeine Einstellungen

  • Vorschau: Es werden keine Reports erzeugt. URL und Dateiname werden nur protokolliert.
  • Anzahl gleichzeitiger Threads: Wenn leer, wird ein sinnvoller Standardwert aus der Anzahl der CPUs verwendet.
  • Webdesk-URL: Basis-URL der Installation. Fehlt das Protokoll, wird http:// ergänzt.
  • Login als Sysadmin: Alle Aufrufe werden im Kontext des Sysadmins ausgeführt. Diese Option nur bewusst verwenden.
  • Speicherziel: Lokales Verzeichnis, Repository oder Metastruktur.
  • Überschreibe bestehende Dateien: Vorhandene Dateien werden ersetzt, wenn diese Option aktiviert ist.
  • Format: PRINT, PDF oder XLS.
  • Export Attachments: Anhänge des Schleifenobjekts werden exportiert, sofern der jeweilige Provider dies unterstützt.

Fehleranalyse

Keine oder zu wenige Reports

Prüfen, ob die TA-Beschäftigungen in Webdesk zugeordnet sind. Geplante Beschäftigungen werden nicht berücksichtigt. Bei der Monatsvariante außerdem den Berichtszeitraum und die Beschäftigungsgrenzen prüfen.

Report enthält die falsche Beschäftigung

Die Aktionsparameter uid und taId sowie bei der Monatsvariante from und to müssen die automatisch vorgeschlagenen Scripts verwenden. Die TA-ID im Report muss mit der TA-ID im Dateinamen übereinstimmen.

Dateien werden überschrieben oder übersprungen

Den Standard-Dateinamen wiederherstellen oder die erforderlichen Beschäftigungs- und Monatswerte in die eigene Velocity-Vorlage aufnehmen. Zusätzlich die Option Überschreibe bestehende Dateien prüfen.

Export schlägt technisch fehl

Die Logs mindestens auf INFO prüfen. Im Benutzerkontext muss die Person Zugriff auf die verwendete Aktion besitzen. Für browserbasierte Exporte müssen Firefox und der konfigurierte Selenium-Treiber verfügbar sein.

Die Beschäftigungs-Berichtsaufteilungen werden nach demselben Prinzip auch vom Job executeAndSendReports für Mail-Anhänge verwendet.

Felder

NameWert
ModulPortal & Organisation (po)
Webdesk ActionnameexecuteAndStoreReports
Artefakt-TypJob
Kommentare (0)