Job Execute and Send Reports

Der Job Execute and Send Reports erstellt Reports über eine Webdesk-Aktion und versendet sie als E-Mail-Anhänge an die ausgewählten Personen. Der Report wird für jede Person im jeweiligen Benutzerkontext erzeugt.

Werden mehrere Schleifenobjekte ermittelt, werden die zugehörigen Reports in einer E-Mail an die jeweilige Person zusammengefasst. Ohne Schleifentyp wird weiterhin genau ein Report pro Person erzeugt.

Die Aktion wird mit den Parametern format, showResult=true und showAll=true aufgerufen. Zusätzliche URL-Parameter können über Jobparameter konfiguriert werden und werden URL-escaped.

Vergrößern

Jobkonfiguration

• Mail-Betreff
  Frei wählbarer Betreff. Der Platzhalter $date wird durch das Ausführungsdatum ersetzt.
• Mail-Text
  Frei wählbarer Text. Die Platzhalter $date und $person stehen für Ausführungsdatum und vollständigen Namen der Empfängerin oder des Empfängers.
• Webdesk-URL
  Basis-URL der Webdesk-Installation. Sie muss vom Server, auf dem der Job läuft, erreichbar sein.
• Aktion
  Die Webdesk-Aktion, die der Job aufruft.
• Format
  print für HTML, pdf oder xls.
• Datumsformat
  Format für Datums-Jobparameter nach SimpleDateFormat. Wenn das Feld leer bleibt, wird das Standardformat der Installation verwendet.
• Berichtsaufteilung
  Bestimmt, ob pro Person oder pro Schleifenobjekt ein Report erzeugt wird.
• Dateiname der Mail-Anlage
  Optionale Velocity-Vorlage für den Namen des E-Mail-Anhangs. Leer lassen, um den Aktionsnamen oder den Standard-Dateinamen des gewählten Schleifen-Providers zu verwenden.

Mehrere TA-Beschäftigungen ab Webdesk 4.64

Für das monatliche Journal (ta_getJournal oder eine davon abgeleitete Aktion) stehen zwei neue Berichtsaufteilungen zur Verfügung. Sie sind für Personen mit mehreren TA-Beschäftigungen vorgesehen. Die Auswahl ist optional; bestehende Jobs ohne Beschäftigungs-Schleifentyp behalten ihr bisheriges Verhalten.

Ein Bericht pro TA-Beschäftigung

• Auswahl Ein Bericht pro TA-Beschäftigung. Der technische Wert lautet ta_employments.
• Für jede zugeordnete, nicht geplante TA-Beschäftigung wird ein eigener Report als Mail-Anhang erstellt.
• Auch sekundäre und bereits beendete Beschäftigungen können berücksichtigt werden, sofern sie in Webdesk zugeordnet sind.
• Der Report verwendet den Standardmonat der ausgewählten Journal-Aktion. Der Job selbst besitzt keine eigene Auswahl für Report von und Report bis.

Ein Bericht pro TA-Beschäftigung und Kalendermonat

• Auswahl Ein Bericht pro TA-Beschäftigung und Kalendermonat. Der technische Wert lautet ta_employmentCalendarMonths.
• Für jeden zulässigen Kalendermonat jeder zugeordneten, nicht geplanten TA-Beschäftigung wird ein eigener Report-Anhang erstellt.
• Ohne separate Zeitraum-Auswahl im Send-Job werden die Monate vom Beginn der Beschäftigung bis zum Vortag erzeugt. Bei beendeten Beschäftigungen endet die Auswahl spätestens mit dem Beschäftigungsende.
• Die Monatsgrenzen des jeweiligen Schleifenobjekts werden über die Aktionsparameter an den Report übergeben. Sie bilden keinen zusammenhängenden Gesamtzeitraum.

Welche Variante soll verwendet werden?

• Für einen Report je Beschäftigung, etwa zur jährlichen Archivierung: Ein Bericht pro TA-Beschäftigung.
• Für einen Report 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.

Aktions- und Jobparameter

Beim Auswählen einer Beschäftigungs-Berichtsaufteilung werden die erforderlichen Parameterzuordnungen automatisch vorgeschlagen. Die erweiterten Parameter sollten nur für zusätzliche Aktionsparameter geöffnet werden.

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

Die Vorschläge berücksichtigen den Parameternamen, den Typ und das konfigurierte Datumsformat. Werden die automatisch vorgeschlagenen Scripts manuell ersetzt, kann der Report für die falsche Beschäftigung erzeugt werden oder die Konfiguration kann als ungültig abgewiesen werden.

Vergrößern

Dateiname der Mail-Anlage

Bei mehreren Reports pro Person muss jeder Anhang einen eindeutigen Namen erhalten. Der Standard-Dateiname der Beschäftigungs-Provider enthält deshalb die erforderlichen Unterscheidungsmerkmale:

• 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 Datumsgrenzen über $object.from und $object.to.

Der Standard-Dateiname sollte verwendet werden. Bei einer eigenen Vorlage im Feld Dateiname der Mail-Anlage müssen die Beschäftigungs- und Monatswerte enthalten sein, damit keine Anhänge denselben Namen erhalten.

In der Velocity-Vorlage stehen $person, $action und das aktuelle Schleifenobjekt $object zur Verfügung. Das Schleifenobjekt ist bei der ersten Variante eine TA-Beschäftigung und bei der Monatsvariante ein auf die Beschäftigung begrenztes Monatsintervall.

Erzeugt die Konfiguration für eine Person zweimal denselben Anhangnamen, wird der Versand dieser Person mit einem Fehler abgebrochen. Die TA-ID muss daher sowohl im Report als auch im Anhangnamen eindeutig nachvollziehbar sein.

Aktionsparameter

Im Bereich Aktionsparameter werden die von der gewählten Aktion unterstützten URL-Parameter mit Name, Typ, Pattern und Kommentar angezeigt. Diese Liste ist informativ und hilft bei der Konfiguration der Jobparameter.

Ein Parameter mit dem Typ Boolean benötigt true oder false. Bei einem String können die im Pattern vorgesehenen Werte verwendet werden. Ist Skript aktiviert, wird das JavaScript im Kontext der aktuellen Person und des aktuellen Schleifenobjekts ausgeführt.

Ein Beispiel für eine Buchungsliste mit Datumsparametern ist unten dargestellt:

Vergrößern

Personen, Gruppen und Mandantenauswahl

Der Job kann Personen, Gruppen oder Mandanten als Empfänger auswählen. Für jede ausgewählte Person wird der Report erzeugt und an deren E-Mail-Adresse gesendet. Bei einer Gruppenauswahl erhält daher jede ermittelte Person eine eigene E-Mail mit ihren Reports.

Wenn der Job einem Mandanten zugeordnet ist, schränkt dieser die Auswahl zusätzlich ein.

Fehleranalyse

Keine oder zu wenige Anhänge

Prüfen, ob die TA-Beschäftigungen in Webdesk zugeordnet sind. Geplante Beschäftigungen werden nicht berücksichtigt. Bei der Monatsvariante zusätzlich prüfen, ob der erwartete Beschäftigungszeitraum bereits begonnen hat.

Report enthält die falsche Beschäftigung

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

Anhänge haben doppelte Namen

Den Standard-Dateinamen wiederherstellen oder in der eigenen Velocity-Vorlage mindestens $object.taID und bei der Monatsvariante zusätzlich $object.from und $object.to verwenden.

Versand schlägt technisch fehl

Die Logs prüfen. Die Webdesk-URL muss vom Jobserver erreichbar sein, die Person muss Zugriff auf die verwendete Aktion besitzen und eine gültige E-Mail-Adresse haben.