Predefined staff verbs for LDAP

Describes the predefined staff verbs and parameters for use with the LDAP staff plug-in for Business Process Choreographer.

You can use staff verbs in WebSphere Integration Developer to model staff assignments in a business process or human task. These staff verbs are transformed during modeling and deployment into a set of queries that can be run on an LDAP 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 Description
DepartmentName Mandatory string Department name of the users to retrieve.
IncludeNestedDepartments Mandatory boolean Specifies whether nested departments are considered in the query.
Domain Optional string The domain to which the department belongs. Use this parameter to limit the query to a subset of the directory.
AlternativeDepartmentName1 Optional string An additional department to which the users can belong.
AlternativeDepartmentName2 Optional string An additional department to which the users can belong.

Group

Use this verb to define a query to authorize the members of the group.

Parameter Use Type Description
GroupId Mandatory string The name of the group of users to authorize.

Everybody

Use this verb to assign a work item to every user authenticated by WebSphere Process Server. This verb has no parameters.

Group Members

Use this verb to define a query to retrieve the members of a group.

Parameter Use Type Description
GroupName Mandatory string Group name of the users to retrieve.
IncludeSubgroups Mandatory boolean 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 An additional group to which the users can belong.
AlternativeGroupName2 Optional string An additional group to which the users can belong.

Group Members without Named Users

Use this verb to define a query to retrieve all of the members of a group except for the explicitly named users.
Parameter Use Type Description
GroupName Mandatory string Group name of the users to retrieve. Supports custom properties that are evaluated at run time.
IncludeSubgroups Mandatory boolean Specifies whether nested subgroups are considered in the query.
NamedUsers Mandatory string The user IDs of the users to exclude from the retrieved group members list. Supports context variables and custom properties, such as %htm:task.originator%

Group Members without Filtered Users

Use this verb to define a query to retrieve the all of the members of a group except for a set of users that is defined by an LDAP search filter.
Parameter Use Type Description
GroupName Mandatory string Group name of the users to retrieve.
IncludeSubgroups Mandatory boolean Specifies whether nested subgroups are considered in the query.
FilterAttribute Mandatory string Name of the attribute to use in the LDAP filter.
FilterValue Mandatory string Filter value to use in the LDAP filter.

Group Search

Use this verb to search for a group based on an attribute match and to retrieve the members of the group. You must set one attribute. If you set more than one attribute, only the first attribute is evaluated.

Parameter Use Type Description
GroupID Optional string The group ID of the users to retrieve.
Type Optional string The group type of the users to retrieve.
IndustryType Optional string The industry type of the group to which the users belong.
BusinessType Optional string The business type of the group to which the users belong.
GeographicLocation Optional string An indication of where the users are located.
Affiliates Optional string The affiliates of the users.
DisplayName Optional string The display name of the group.
Secretary Optional string The secretary of the users.
Assistant Optional string The assistant of the users.
Manager Optional string The manager of the users.
BusinessCategory Optional string The business category of the group to which the users belong.
ParentCompany Optional string 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 Description
EmployeeName Mandatory string 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 Description
EmployeeUserID Mandatory string The user ID of the employee whose manager is retrieved. Supports context variables and custom properties, 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 Description
QueryTemplate Mandatory string 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 Specifies the query. You can use context variables and custom properties, such as %wf:process.starter%. The type of query depends on the query template.
  • search template: search filter
  • user template: user dn
  • usersOfGroup: group dn
AdditionalParameter1 Optional string Specifies the query. You can use context variables, such as %wf:process.starter%. The type of parameter depends on the query template.
  • search template. Used to specify whether recursive search is done. Supported values: yes and no
  • user template. Not supported
  • usersOfGroup. Used to specify whether recursive search is done. Supported values: yes and no
AdditionalParameter2 Optional string Use this verb to specify an additional parameter.
AdditionalParameter3 Optional string Use this verb to specify an additional parameter.

If you use the default mapping XSLT files, this parameter is not supported.

AdditionalParameter4 Optional string Use this verb to specify an additional parameter.

If you use the default mapping XSLT files, this parameter is not supported.

AdditionalParameter5 Optional string Use this verb to specify an additional parameter.

If you use the default mapping XSLT files, this parameter is not supported.

Nobody

For inline tasks, only the business process administrators have access. For standalone tasks, only the human task administrators have access. In addition, when using the Business Flow Manager API the BPESystemAdministrator role members have access, for the Human Task Manager API the TaskSystemAdministrator role members have access. This verb has no parameters.

Person Search

Use this verb to search for people based on an attribute match. You must set one attribute. If you set more than one attribute, only the first attribute is evaluated.

Parameter Use Type Description
UserID Optional string The user ID of the users to retrieve.
Profile Optional string The profile of the users to retrieve.
LastName Optional string The last name of the users to retrieve.
FirstName Optional string The first name of the users to retrieve.
MiddleName Optional string The middle name of the users to retrieve.
Email Optional string The e-mail address of the users.
Company Optional string The company to which the users belong.
DisplayName Optional string The display name of the users.
Secretary Optional string The secretary of the users.
Assistant Optional string The assistant of the users.
Manager Optional string The manager of the users.
Department Optional string The department to which the users belong.
Phone Optional string The telephone number of the users.
Fax Optional string The fax number of the users.
Gender Optional string Whether the user is male or female.
Timezone Optional string The time zone in which the users are located.
PreferredLanguage Optional string The preferred language of the user.

Role Members

Use this verb to retrieve the users associated with a business process role.

Parameter Use Type Description
RoleName Mandatory string Role name of the users to retrieve.
IncludeNestedRoles Mandatory boolean 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 An additional role name for the user.
AlternativeRoleName2 Optional string An additional 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 Description
Name Mandatory string The name of the user to retrieve.
AlternativeName1 Optional string An additional user name. Use this parameter to retrieve more than one user.
AlternativeName2 Optional string An additional 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. Use short names to specify values, for example, wpsadmin. This verb does not imply access to a staff repository.

Parameter Use Type Description
UserID Mandatory string The user ID of the user to retrieve. Supports context variables and custom properties, such as %htm:task.potentialStarters%
AlternativeID1 Optional string An additional user ID. Use this parameter to retrieve more than one user.
AlternativeID2 Optional string An additional user ID. Use this parameter to retrieve more than one user.

Users by user ID without Named Users

Use this verb to define a staff query for users whose user ID is known, while excluding explicitly named user IDs. Use short names to specify values, for example, wpsadmin. This verb does not imply access to a staff repository.

Parameter Use Type Description
UserID Mandatory string The user ID of the user to retrieve. Supports context variables and custom properties, such as %htm:task.potentialStarters%
AlternativeID1 Optional string An additional user ID. Use this parameter to retrieve more than one user.
AlternativeID2 Optional string An additional user ID. Use this parameter to retrieve more than one user.
NamedUsers Mandatory string The user IDs of the users to exclude from the user ID list. Supports context variables and custom properties, such as %wf:activity(...).owner%

(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)