TimePunch User Group Service

Der User Group Service erlaubt die Gruppenbildung von Mitarbeiterprofilen. Damit können Mitarbeiter zu Teams, Abteilungen und Niederlassungen zusammengefasst werden.

CreateUserGroup

Diese Methode erzeugt eine neue Gruppe und gibt diese zurück. Wichtig dabei ist, dass die Gruppe noch nicht in der Datenbank persistiert wurde. Dies geschieht erst beim Speichern der Gruppe.

UserGroupDto CreateUserGroup(  
 out TpFault fault,  
 TpAuthentication authentication,  
 GroupType groupType);

Needed Permission	userGroups@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
groupType		Type of the user group that shall be created (e.g. Team, Department, Branch)
Return value		Returns the created user group

DeleteUserGroups

Diese Methode löscht die übergebenen Benutzergruppen. Die Mitglieder der Gruppe werden nach dem Löschen keiner neuen Gruppe zugeordnet.

void DeleteUserGroups(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] userGroupIds);

Needed Permission	userGroups@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userGroupIds		List that contains all user group ids that shall be deleted.
Return value		-

ImportUserGroupAssignments

Diese Methode importiert die übergebenen Gruppenzugehörigkeiten. Im Gegensatz zu der Save Methode sind hierbei nicht die IDs, sondern die Klarnamen der Gruppen für den Import entscheidend.

UserGroupMemberDto[] ImportUserGroupAssignments(  
 out TpFault fault,  
 TpAuthentication authentication,  
 GroupType groupType,  
 UserGroupMemberDto[] groupAssignments);

Needed Permission	userGroups@import
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
groupType		Type of the user Group Team = 1 Department = 2 Branch = 3
groupAssignments		User Group assignments to save
Return value		Collection of imported user groups

LoadUserGroup

Diese Methode lädt die Gruppe mit der übergebenen ID und gibt sie zurück.

UserGroupDto LoadUserGroup(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid userGroupId);

Needed Permission	userGroups@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userGroupId		Id of the user group to load
Return value		Returns the loaded user group

SaveUserGroup

Diese Methode speichert die Benutzergruppe in die Datenbank. Wichtig dabei ist, dass wenn die Gruppenmitglieder im Objekt NULL sind, nur die Basisdaten der Gruppe bearbeitet werden.

UserGroupDto SaveUserGroup(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserGroupDto userGroup);

Needed Permission	userGroups@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userGroup		The user group to save
Return value		Returns the persisted user group

SaveUserGroupAssignments

Diese Methode speichert die Gruppenzugehörigkeit von Mitarbeiterprofilen zu den übergebenen Gruppen.

void SaveUserGroupAssignments(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserGroupSaveMemberDto[] groupAssignments);

Needed Permission	userGroups@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
groupAssignments		User Group assignments to save
Return value		-

SearchAssignableUsers

Diese Methode liefert alle Mitarbeiterprofile zurück, die dem übergebenen Gruppentyp zugeordnet werden können.

UserGroupMemberDto[] SearchAssignableUsers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 GroupType groupType,  
 Guid userGroupId);

Needed Permission	userGroups@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
groupType		Group type for that the user profiles shall be searched
userGroupId		Id of the user group that shall be used as a target for the assignable user profiles.
Return value		Returns the found user groups

SearchCoveredUserGroups

Diese Methode sucht nach Benutzergruppen in denen der Mitarbeiter entweder die Leitung hat oder zumindest als Assistent eingetragen ist.

UserGroupDto[] SearchCoveredUserGroups(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserGroupSearchDto userGroupSearch);

Needed Permission	userGroups@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userGroupSearch		The user group definition to search for
Return value		Returns the found user groups

SearchUserGroupAssignments

Diese Methode liefert alle Gruppenmitglieder zurück, auf welche die Profilsuche passt und mit dem übergebenen Gruppentyp übereinstimmt. Die Daten werden hauptsächlich für den Gruppenexport verwendet.

UserGroupMemberDto[] SearchUserGroupAssignments(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserSearchDto userSearch,  
 GroupType groupType);

Needed Permission	userGroups@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userSearch		Use the given user search object to tailor the search results.
groupType		Group type for that the user profiles shall be searched
Return value		Returns the found user assignments

SearchUserGroup

Diese Methode sucht nach Benutzergruppen mit den übergebenen Eigenschaften. Dabei kann nach dem Gruppennamen und dem Gruppentyp gesucht werden.

UserGroupDto[] SearchUserGroups(  
 out TpFault fault,  
 TpAuthentication authentication,  
 UserGroupSearchDto userGroupSearch);

Needed Permission	userGroups@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userGroupSearch		The user group definition to search for
Return value		Returns the found user groups