Task Allocation Service - Active Directory Methods
This section provides an overview of the Active Directory-based functions contained within the ADMethods class, as well as describing the input and output parameters, and the external dependencies that the method has (i.e.: all the AD methods require that the account that K2Server is running under has enough rights to query AD, as well as access to AD)
GetManager Method
Method Name: |
GetManager |
Description: |
Returns the Manager (in AD) of the specified user. If no manager is found, the DefaultUser is returned. |
Input Parameter(s): |
User Name (string) |
Return Parameter(s): |
Manager Name (string) |
SO Method Type: |
Read |
Dependencies: |
This method is dependent on AD access. The query is done in the same context as the service account that the K2 Server is running under. The account needs sufficient access to query AD. |
GetDirectReports Method
Method Name: |
GetDirectReports |
Description: |
Returns a list of all the direct reports for the specified user (in other words, a list of all the users for which the specified user is the manager). If none found, the DefaultUser is returned. |
Input Parameter(s): |
User Name (string) |
Return Parameter(s): |
List of User Names (string) |
SO Method Type: |
List |
Dependencies: |
This method is dependent on AD access. The query is done in the same context as the service account that the K2 Server is running under. The account needs sufficient access to query AD. |
 |
DefaultUser: This is the default user name that various methods use should there be an error in the lookup (eg: a non-existent role name, or missing manager in AD). This username prohibits the process to enter an error state, but rather returns this user name, so that the work can be re-routed to the appropriate user manually. |