Zum Hauptinhalt springen
Version: 5.3

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 PermissionuserGroups@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
groupTypeType of the user group that shall be created (e.g. Team, Department, Branch)
Return valueReturns 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 PermissionuserGroups@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userGroupIdsList 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 PermissionuserGroups@import
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
groupTypeType of the user Group Team = 1 Department = 2 Branch = 3
groupAssignmentsUser Group assignments to save
Return valueCollection 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 PermissionuserGroups@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userGroupIdId of the user group to load
Return valueReturns 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 PermissionuserGroups@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userGroupThe user group to save
Return valueReturns 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 PermissionuserGroups@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
groupAssignmentsUser 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 PermissionuserGroups@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
groupTypeGroup type for that the user profiles shall be searched
userGroupIdId of the user group that shall be used as a target for the assignable user profiles.
Return valueReturns 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 PermissionuserGroups@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userGroupSearchThe user group definition to search for
Return valueReturns 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 PermissionuserGroups@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userSearchUse the given user search object to tailor the search results.
groupTypeGroup type for that the user profiles shall be searched
Return valueReturns 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 PermissionuserGroups@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userGroupSearchThe user group definition to search for
Return valueReturns the found user groups