You can use staff verbs in the WebSphere Studio Application Developer Integration Edition process editor to model staff assignments in a business process. These staff verbs are transformed during modeling and deployment into a set of queries that can be run on a staff repository. The parameters for the following predefined staff verbs are listed here:
Department Members
Use this verb to define a query to retrieve the members of a department.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
DepartmentName | Mandatory | string | LDAP | Department name of the users to retrieve. |
IncludeNestedDepartments | Mandatory | boolean | LDAP | Specifies whether nested departments are considered in the query. |
Domain | Optional | string | LDAP | The domain to which the department belongs. Use this parameter to limit the query to a subset of the directory. |
AlternativeDepartmentName1 | Optional | string | LDAP | An alternative department to which the users can belong. |
AlternativeDepartmentName2 | Optional | string | LDAP | An alternative department to which the users can belong. |
Everybody
Use this verb to assign a work item to every user authenticated by the WebSphere Application Server. This verb has no parameters; it is supported by the system, user registry, and LDAP plug-ins.
Group Members
Use this verb to define a query to retrieve the members of a group.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
GroupName | Mandatory | string | User registry, LDAP |
Group name of the users to retrieve. |
IncludeSubgroups | Mandatory | boolean | LDAP | Specifies whether nested subgroups are considered in the query. |
Domain | Optional | string | The domain to which the group belongs. Use this parameter to limit the query to a subset of the directory. | |
AlternativeGroupName1 | Optional | string | User registry, LDAP | An alternative group to which the users can belong. |
AlternativeGroupName2 | Optional | string | User registry, LDAP | An alternative group to which the users can belong. |
Group Search
Use this verb to search for a group based on an attribute match and to retrieve the members of the group.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
GroupID | Optional | string | User registry, LDAP |
The group ID of the users to retrieve. |
Type | Optional | string | LDAP | The group type of the users to retrieve. |
IndustryType | Optional | string | LDAP | The industry type of the group to which the users belong. |
BusinessType | Optional | string | LDAP | The business type of the group to which the users belong. |
GeographicLocation | Optional | string | LDAP | An indication of where the users are located. |
Affiliates | Optional | string | LDAP | The affiliates of the users. |
DisplayName | Optional | string | LDAP | The display name of the group. |
Secretary | Optional | string | LDAP | The secretary of the users. |
Assistant | Optional | string | LDAP | The assistant of the users. |
Manager | Optional | string | LDAP | The manager of the users. |
BusinessCategory | Optional | string | LDAP | The business category of the group to which the users belong. |
ParentCompany | Optional | string | LDAP | The parent company of the users. |
Manager of Employee
Use this verb to retrieve the manager of a person using the person's name.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
EmployeeName | Mandatory | string | LDAP | The name of the employee whose manager is retrieved. |
Domain | Optional | string | The domain to which the employee belongs. Use this parameter to limit the query to a subset of the directory. |
Manager of Employee by user ID
Use this verb to retrieve the manager of a person using the person's user ID.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
EmployeeUserID | Mandatory | string | LDAP | The user ID of the employee whose manager is retrieved. Supports context variables, such as %wf:process.starter% |
Domain | Optional | string | The domain to which the employee belongs. Use this parameter to limit the query to a subset of the directory. |
Native Query
Use this verb to define a native query based on directory-specific parameters.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
QueryTemplate | Mandatory | string | User registry, LDAP | The query template to use for the query. The default mapping files for the user registry and LDAP plug-ins support the templates search, user, and usersOfGroup. |
Query | Mandatory | string | User registry, LDAP | Specifies the query. You can use context
variables, such as %wf:process.starter%. The type of query depends
on the plug-in and the query template. User registry
LDAP
|
AdditionalParameter1 | Optional | string | User registry, LDAP | Specifies the query. You can use context
variables, such as %wf:process.starter%. The type of parameter depends
on the plug-in and the query template. User registry
LDAP
|
AdditionalParameter2 | Optional | string | User registry, LDAP | Use this verb to specify an additional parameter. |
AdditionalParameter3 | Optional | string | User registry, LDAP | Use this verb to specify an additional
parameter. If you use the default mapping XSLT files, this parameter is not supported. |
AdditionalParameter4 | Optional | string | User registry, LDAP | Use this verb to specify an additional
parameter. If you use the default mapping XSLT files, this parameter is not supported. |
AdditionalParameter5 | Optional | string | User registry, LDAP | Use this verb to specify an additional
parameter. If you use the default mapping XSLT files, this parameter is not supported. |
Nobody
Use this verb to deny normal users access to the work item; only the process administrator and the process choreographer system administrator have access. This verb has no parameters. and is supported by the system, user registry, and LDAP plug-ins.
Person Search
Use this verb to search for people based on an attribute match.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
UserID | Optional | string | User registry, LDAP | The user ID of the users to retrieve. |
Profile | Optional | string | LDAP | The profile of the users to retrieve. |
LastName | Optional | string | LDAP | The last name of the users to retrieve. |
FirstName | Optional | string | LDAP | The first name of the users to retrieve. |
MiddleName | Optional | string | LDAP | The middle name of the users to retrieve. |
Optional | string | LDAP | The e-mail address of the users. | |
Company | Optional | string | LDAP | The company to which the users belong. |
DisplayName | Optional | string | LDAP | The display name of the users. |
Secretary | Optional | string | LDAP | The secretary of the users. |
Assistant | Optional | string | LDAP | The assistant of the users. |
Manager | Optional | string | LDAP | The manager of the users. |
Department | Optional | string | LDAP | The department to which the users belong. |
Phone | Optional | string | LDAP | The telephone number of the users. |
Fax | Optional | string | LDAP | The fax number of the users. |
Gender | Optional | string | LDAP | Whether the user is male or female. |
Timezone | Optional | string | LDAP | The time zone in which the users are located. |
PreferredLanguage | Optional | string | LDAP | The preferred language of the user. |
Role Members
Use this verb to retrieve the users associated with a business process role.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
RoleName | Mandatory | string | LDAP | Role name of the users to retrieve. |
IncludeNestedRoles | Mandatory | boolean | LDAP | Specifies whether nested roles are considered in the query. |
Domain | Optional | string | The domain to which the role belongs. Use this parameter to limit the query to a subset of the directory. | |
AlternativeRoleName1 | Optional | string | LDAP | An alternative role name for the user. |
AlternativeRoleName2 | Optional | string | LDAP | An alternative role name for the user. |
Users
Use this verb to define a staff query for a user who is known by name.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
Name | Mandatory | string | System, user registry, LDAP | The name of the user to retrieve. |
AlternativeName1 | Optional | string | System, user registry, LDAP | An alternative user name. Use this parameter to retrieve more than one user. |
AlternativeName2 | Optional | string | System, user registry, LDAP | An alternative user name. Use this parameter to retrieve more than one user. |
Users by user ID
Use this verb to define a staff query for a user whose user ID is known.
Parameter | Use | Type | Supported by | Description |
---|---|---|---|---|
UserID | Mandatory | string | System, user registry, LDAP | The user ID of the user to retrieve. |
AlternativeID1 | Optional | string | System, user registry, LDAP | An alternative user ID. Use this parameter to retrieve more than one user. |
AlternativeID2 | Optional | string | System, user registry, LDAP | An alternative user ID. Use this parameter to retrieve more than one user. |