Vergleichsreport

Purpose

The job calls a Webdesk report action in the context of each selected person and sends the results as e-mail attachments to that person. PDF, print HTML and XLS are supported.

Person selection and configuration

• Persons are resolved from person, group and client restrictions; the client assigned to the job acts as a hard restriction.
• Webdesk URL, Action, Format, Mail subject, Mail text, Date format and additional URL parameters are read from the configuration.
• Subject and content support $date; the mail content additionally supports $person. $date is rendered output in the server's default date format; the Date format setting only applies to affects date URL parameters.
• The attachment file name (Mail File name of the mail attachment filename) can be configured as a Velocity expression with person, object and action; the file extension is appended depending on the format. If the field is left empty, the action name or the default file name of the selected loop type is used.

Loop types

The loop type is selected in the Report split field Report grouping.

• Without a loop type: exactly one report per person.
• A loop type can deliver multiple objects per person; a separate attachment is created for each object.
• ta_bookingMonths processes booking months.
• ta_employments processes each currently considered TA employment separately; object.taID is the technical employment identifier.
• ta_employmentCalendarMonths processes each TA employment and each delimited calendar month separately; additionally object.from and object.to are available.

Multiple TA employments

With multiple considered TA employments, a separate report is generated per employment. With ta_employmentCalendarMonths, separate attachments are created per employment and month. All attachments for the same person are combined into one e-mail.

Use a unique file name, for example with $object.taID and, for monthly intervals, additionally with $object.from and/or $object.to. Identical file names within one person cause an error and prevent sending for that person.

Report call and URL parameters

• The export runs via a short-lived login token authentication in the user context of the person.
• The URL contains, among others, format, showResult=true and showAll=true.
• Additional parameters can be configured as a date (today, yesterday, next working day, first day of the month, last or first day of the previous month), JavaScript expression, or fixed value.
• For employment loops, the current loop object is available as object. Check the parameters expected by the report action, in particular uid, taId, from and to.
• When saving, the configuration checks whether the parameters of the report action parameters required by the selected loop type are set as scripts a script (e.g. uid = person.UID, taId = object.taID, and for calendar months the date parameters from/to from object.from/object.to). Missing parameters are added automatically, ; parameters configured differently configured ones are marked as errors.

Errors and sending

Reports are generated and collected per person. If no attachment was created, no mail is sent. An error for one person is logged and the next person is processed. An interruption stops processing.