BPMUsersFullSyncTask command

Use the BPMUsersFullSyncTask command to import all the user information from the WebSphere® Application Server user registry into the IBM® Business Automation Workflow database. If the user registry contains new users, these users are created in the Business Automation Workflow database.

Attention: Use this command with care. Because all the users in the user registry are imported into the Business Automation Workflow database, the command might also import users who do not use Business Automation Workflow.

You can also perform this task by using the usersFullSync.[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 usersFullSync, one VMM call for all users is sent regardless of the number of users in the database.
Attention: If the call does not return all the available users in the user registry, contact your LDAP administrator to adjust the LDAP configuration so that all users can be retrieved in one LDAP search call.

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

The BPMUsersFullSyncTask 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

BPMUsersFullSyncTask

Parameters

The command has no parameters.

Example

The following example uses the BPMUsersFullSyncTask command to update all users.

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

wsadmin>AdminTask.BPMUsersFullSyncTask()

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.
VMM tuning: If you use one VMM call for all users, tune the VMM configuration for each of the associated LDAP repositories in the wimconfig.xml file. In particular, select an appropriate setting for configurationProvider->maxSearchResults property, and consider adapting the value for the ldapServers->connectTimeout and attributesCache->cacheSize properties. For more information about tuning VMM, refer to the WebSphere Application Server Network Deployment Knowledge Center.