Predefined staff verbs for the user registry

Describes the predefined staff verbs and parameters for use with the user registry 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 a staff repository. The parameters for the following predefined staff verbs are listed here:

Group

Use this verb to define a query to retrieve name of a group for use with group work items.

Parameter Use Type Description
GroupName Mandatory string The name of the group to retrieve.

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.
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.
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 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.

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 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 pattern
  • user template: user name
  • usersOfGroup: group name
AdditionalParameter1 Optional string Specifies the query. You can use context variables, such as %wf:process.starter%. Supported values are group and user.
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.

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)