TimePunch Reporting Service

Der Reporting Service enthält Methoden zur Berichterstellung in TimePunch bereit. Die Methoden sind sehr mächtig und sollte aufgrund der Performance nur zur Auswertung eingesetzt werden.

GetDailySummaries

Diese Methode liefert eine taggenaue Zusammenfassung der Arbeitszeitdaten für den gewählten Zeitraum und die übergebenen Mitarbeiter zurück. Die Coverage Daten werden für die gesetzten Identity übernommen.

List<ReportDailySummaryDto> GetDailySummaries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime startDate,  
 DateTime endDate,  
 List<Guid> userIds);

Needed Permission	summary@report
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
startDate		First reporting date
endDate		Last reporting date
userIds		List containing all user ids for which the daily summary shall be reported.
Return value		List of all daily summaries.

GetMonthlySummaries

Diese Methode liefert eine monatliche Zusammenfassung der Arbeitszeitdaten für den gewählten Zeitraum und die übergebenen Mitarbeiter zurück.

List<ReportSummaryDto> GetMonthlySummaries(  
 out TpFault fault,  
 TpAuthentication authentication, >  
 DateTime startDate,  
 DateTime endDate,  
 List<Guid> userIds);

Needed Permission	summary@report
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
startDate		First reporting date
endDate		Last reporting date
userIds		List containing all user ids for which the daily summary shall be reported.
Return value		List of all monthly summaries.

GetYearlySummaries

Diese Methode liefert eine jährliche Zusammenfassung der Arbeitszeitdaten für den gewählten Zeitraum und die übergebenen Mitarbeiter zurück.

List<ReportYearlySummaryDto> GetYearlySummaries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime startDate,  
 DateTime endDate,  
 List<Guid> userIds);

Needed Permission	summary@report
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
startDate		First reporting date
endDate		Last reporting date
userIds		List containing all user ids for which the daily summary shall be reported.
Return value		List of all yearly summaries.

GetDailySummariesAnonymized

Diese Methode liefert ebenso, wie die Metode GetDailySummaries, eine tägliche Zusammenfassung der Arbeitszeitdaten der übergebenen Mitarbeiter zurück. Der Unterschied dabei ist, dass die Arbeitszeitdaten weitgehend anonymisiert werden, um nicht auf die konkreten Zeiten der Mitarbeiter schließen zu können. Daher benötigt die Methode auch eine geringere Berechtigung.

List<ReportDailySummaryDto> GetDailySummariesAnonymized(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime startDate,  
 DateTime endDate,  
 List<Guid> userIds);

Needed Permission	summary@reportAnon
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
startDate		First reporting date
endDate		Last reporting date
userIds		List containing all user ids for which the daily summary shall be reported.
Return value		List of all daily summaries.

GetReportTimeEntriesUserBased

Diese Methode liefert die Zeiteinträge der selektierten Mitarbeiter zurück. Der Fokus der Abfrage liegt auf den Zeiten der Mitarbeiter, nicht auf ein oder mehere Projekte.

List<ReportTimeEntryDto> GetReportTimeEntriesUserBased(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySearchDto searchDto);

Needed Permission	timeEntries@report
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
searchDto		Search object to filter the time entries
Return value		List of all selected time entries

GetReportTimeEntriesProjectBased

Diese Methode liefert die Zeiteinträge der selektierten Projekte zurück. Im Gegensatz zur Methode GetReportTimeEntriesUserBased stehen nicht die Mitarbeiter, sondern die Projekte im Fokus. So werden für jedes Projekt zum übergebenen Stichtag die Zeitkonten der Projekte (insgesamt, gebucht, verfügbar) ermittelt. Trotzdem selektiert die Methode auch die den Projekten zugeordneten Buchungen und gibt diese zurück.

List<ReportTimeEntryDto> GetReportTimeEntriesProjectBased(  
 out TpFault fault,  
 TpAuthentication authentication,  
 out List<ReportProjectTimeDto> projectTimes,  
 TimeEntrySearchDto searchDto);

Needed Permission	projects@report
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
projectTimes	Out	List of all project times at the given reporting date.
searchDto		Search object to filter the time entries
Return value		List of all selected time entries

GetReportProjectTimes

Diese Methode liefert alle Projektzeiten der übergebenen Projekt-Ids, zu dem übergebenen Stichtag zurück.

List<ReportProjectTimeDto> GetReportProjectTimes(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ProjectSearchDto searchDto);

Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
searchDto	Out	Search object to filter projects
Return value		List of all project times at the given reporting date.

GetUserAttendance

Diese Methode liefert die Anwesenheitsliste der Mitarbeiter zur Auswertung in einem Bericht.

List<ReportAttendanceDto> GetUserAttendance(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserSearchDto searchDto);

Needed Permission	attendance@report
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
searchDto		Search object to filter the time entries
Return value		List of all selected time entries

GetSalaryTimes

Diese Methode liefert die aufbereiteten Lohndaten zurück. Die Lohndaten sind auf den Monat aggregiert.

List<ReportSalaryTimeDto> GetSalaryTimes(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime monthToExport,  
 UserSearchDto searchDto);

Needed Permission	salaryExport@report
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
monthToExport		Date of the monthly data to export
searchDto		Search object to filter the time entries
return value		List of all selected time entries

GetReportUserGroups

Diese Methode liefert die Benutzergruppen zurück.

List<ReportUserGroupDto> GetReportUserGroups(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserGroupSearchDto searchDto);

Needed Permission	userGroups@access
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
authentication		User authentication
searchDto		Search object to filter the user group
Return value		List of all selected user group

ExportSalaryTimes

Diese Methode liefert die aufbereiteten Lohndaten zurück. Die Lohndaten sind auf den Monat aggregiert.

Der Unterschied zur Methode "GetSalaryTimes" ist der, dass der Datenexport in der Datenbank gespeichert wird.

Wird ein vorangeganger Monat nochmal exportiert, dann exportiert TimePunch nur die Differenz zur exportierten Hochrechnung, die aus dem damals aktuellen Monat erstellt wurde.

List<ReportSalaryTimeDto> ExportSalaryTimes(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime monthToExport,  
 UserSearchDto searchDto);

Needed Permission	salaryExport@report
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
monthToExport		Date of the monthly data to export
userGroupId		Id of the user group to export the salary for
return value		List of all selected time entries