BPMUsersSyncTask command

Edit online

Use the BPMUsersSyncTask command to synchronize a set of specified users between the WebSphere® Application Server user registry and the IBM® Business Automation Workflow database. You can also use this command to create specific users in the IBM Business Automation Workflow database who are already available in the WebSphere Application Server user registry. If you specify a user who is not available in the user registry, the user is skipped.

You can also perform this task by using the usersSync.[bat|sh] script. For more information, see Synchronizing users.

How the synchronization command runs depends on whether federated repositories (VMM) are configured for WebSphere Application Server security:

Non-federated repositories: The WebSphere Application Server user registry API is used to run the commands.
Federated repositories: The federated repositories API is used to run the commands. This API performs significantly better than the user registry API. The number of VMM calls used to synchronize the user information depends on the command and the number of available users in the Business Automation Workflow database.
In the case of usersSync, one VMM call per user is used.

The output of the command contains the number of synchronized users.

The BPMUsersSyncTask command is run using the AdminTask object of the wsadmin scripting client.

Location

Start the wsadmin scripting client from the install_root/profiles/deployment_manager_profile/bin directory.

Syntax

BPMUsersSyncTask
-userIds [username_1 username_2 ... username_n]

Parameters

-userIds [username_1 username_2 username_n]: A required parameter that specifies the list of user IDs to be processed.

Example

The following example uses the BPMUsersSyncTask command to update users username_1 and username_2.

wsadmin -conntype SOAP -port 8880 -host PC1.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMUsersSyncTask('[-userIds [username_1 username_2]]')

Configuration

SOAP connections: If you are using a SOAP connection, the command can take longer than the specified SOAP timeout value to complete. Although the command continues to run until it is finished, you might see the java.net.SocketTimeoutException: Read timed out exception in the systemOut.log file. To prevent this exception, set a higher value for the com.ibm.SOAP.requestTimeout property in the profile_root/properties/soap.client.props file. To disable timeouts, set the value of the property to 0.