Logging Service
Dieser Service wird dazu genutzt, die Zeiterfassung zu starten, zu stoppen und die Aufzeichnung zu administrieren.
GetActiveTimeEntry
Diese Methode liefert den aktuellen Zeiteintrag, sofern eine Protokollierung stattfindet.
ActiveTimeEntryDto GetActiveTimeEntry(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| return value | The active time entry or NULL, if the time tracking has not been started. |
SearchActiveTimeEntries
Diese Methode sucht nach aktiven Zeiteinträge die dem angegebenen Filter Objekt entsprechen. Dabei wird die Rolle des Principal berücksichtigt und nur dann Daten von anderen TimePunch Profilen zurückgeliefert, wenn der Principal über die entsprechenden Rechte verfügt.
List<ActiveTimeEntryDto> SearchActiveTimeEntries(
out TpFault fault,
TpAuthentication authentication,
ActiveTimeEntrySearchDto search);
| Needed Permission | timeEntries@access / core@switchIdentity | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| search | The filter that is used to search the time entries | |
| Return value | Collection with the found time entries |
StartWorkTimeLogging
Mit dieser Methode wird die Protokollierung der Arbeitszeit gestartet.
ActiveTimeEntryDto StartWorkTimeLogging(
out TpFault fault,
TpAuthentication authentication,
Guid projectId,
Guid? taskId,
Guid? customerId,
string description,
DateTime? startTime,
out List<TimeEntryDto> todayEntries);
| Needed Permission | startTime == null ? logging@access : logging@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| projectId | The id of the project that is used to start the time recording | |
| taskId | The id of the task that is used for the time recording | |
| customerId | The id of the customer that is used for the time recording | |
| description | The description that will be used for the time recording | |
| startTime | The start time of the time recording. Regularly this should be NULL; otherwise a higher user-permission is needed. | |
| todayEntries | Out | Collection of all entries of the current day. |
| Return value | The current time entry that has been started by the method. |
StartBreakTimeLogging
Diese Methode startet einen Pausenzeiteintrag. Wichtig ist, dass eine aktuelle Aufzeichnung bereits gestartet wurde. D.h. eine Pause kann nur innerhalb einer Arbeitszeitprotokollierung gestartet werden.
ActiveTimeEntryDto StartBreakTimeLogging(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| return value | The current time entry that has been modified by the method. |
EndLogging
Diese Methode beendet die aktuelle Protokollierung und übernimmt den aufgezeichneten Arbeitszeiteintrag für den Benutzer.
ActiveTimeEntryDto EndLogging(
out TpFault fault,
TpAuthentication authentication,
DateTime? endTime,
out TimeSpan? committedWorkTime,
out List<TimeEntryDto> todayEntries);
| Needed Permission | endTime == null ? logging@access : logging@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| endTime | The end time of the time recording. Regularly this should be NULL; otherwise a higher user-permission is needed. | |
| commitedWorkTime | Out | The committed work time |
| todayEntries | Out | Collection of all entries of the current day. |
| Return value | The current time entry that has been committed by the method. |
CancelLogging
Diese Methode verwirft die Aufzeichnung des aktuellen Zeiteintrags. Dies kann z.B. notwendig sein, wenn der aktuelle Zeiteintrag nicht korrekt beendet wurde.
void CancelLogging(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication |
LockSession
Diese Methode sperrt die Protokollierung der aktuellen Arbeitszeit. Dies sollte z.B. bei Aktivierung des Bildschirmschoners geschehen. Das Sperren bedeutet aber nicht immer ein sofortiges Pausieren der Protokollierung. Wie der TimePunch Server die Sperrung behandelt, wird in den Logging Settings definiert.
void LockSession(
out TpFault fault,
TpAuthentication authentication,
DateTime? lockTime);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| lockTime | Time that is used as the current lock time. If this parameter is null, the time at the server will be taken. |
UnlockSession
Diese Methode entsperrt einen zuvor gesperrten Zeiteintrag. Beim Entsperren des Zeiteintrags analysiert TimePunch anhand der Sperrzeit und den Einstellungen in den Logging Settings, wie mit dem aktiven Zeiteintrag umgegangen werden muss.
ActiveTimeEntryDto UnlockSession(
out TpFault fault,
TpAuthentication authentication,
DateTime? unlockTime);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| unlockTime | Time that is used as the current unlock time. If this parameter is null, the time at the server will be taken. | |
| Return Value | The unlocked time entry or NULL, if no time entry is active after unlocking the session. |
SaveLoggingSettings
Diese Methode speichert die Protokollierungs-Einstellungen für ein TimePunch Profil.
void SaveLoggingSettings(
out TpFault fault,
TpAuthentication authentication,
List<LoggingSettingsDto> settingsDto);
| Needed Permission | logging@settings | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| settingsDto | The amended Logging Settings that shall be stored. |
SearchLoggingSettings
Diese Methode liefert die Protokollierungs-Einstellungen für das übergebene Suchobjekt zurück.
List<LoggingSettingsDto> SearchLoggingSettings(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userSearchDto);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userSearchDto | Search object containing the user search data. The coverage will be applied accordingly to the user authentication. | |
| Return value | All user logging settings. |
GetLoggingContext
Diese Methode ist die zentrale Anlaufstelle, um alle Daten die für eine Zeiterfassung wichtig sind, für einen Benutzer abzurufen.
LoggingContextDto GetLoggingContext(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| Return value | All data regarding the current time entry logging. |
ValidateAndSaveActiveTimeEntry
Diese Methode dient zum Ändern eines aktiven Zeiteintrags. Hiermit kann z.B. die Beschreibung geändert oder ein neues Projekt gesetzt werden.
ActiveTimeEntryDto ValidateAndSaveActiveTimeEntry(
out TpFault fault,
TpAuthentication authentication,
ActiveTimeEntryDto activeTimeEntry);
| Needed Permission | logging@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| activeTimeEntry | The active time entry that shall be stored | |
| Return value | The currently active time entry after the amendments |
ValidateAndSaveRestrictedActiveTimeEntry
Diese Methode dient zum eingeschränkten Ändern des aktiven Zeiteintrags. Im Gegensatz zu der ValidateAndSaveActiveTimeEntry Methode benötigt diese Methode weniger Rechte für die Ausführung.
ActiveTimeEntryDto ValidateAndSaveRestrictedActiveTimeEntry(
out TpFault fault,
TpAuthentication authentication,
TimeEntryRestrictedSaveDto activeTimeEntry);
| Needed Permission | logging@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| activeTimeEntry | The active time entry that shall be stored | |
| Return value | The currently active time entry after the amendments |