IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)

BPMCheckOrphanTokens command

Use the BPMCheckOrphanTokens command to detect the possibility of orphaned tokens before installing a new snapshot and identify whether to delete or move each token.

Purpose

This utility detects the possibility of orphaned tokens by comparing one snapshot with another. It allows you to identify what the system should do with each orphaned token that it encounters during migration. There are three options:

• Delete the token if it is no longer required in the new snapshot. (Default action)

• Move the token to another step in the process.

• Suspend the process so process instance data can be manipulated using Process Inspector.

In a network deployment environment, you must run this command on the node containing the application cluster member that handles Process Server applications. Do not run this command from the deployment manager profile.

If you are using a SOAP connection, the command can take longer to complete than the specified SOAP timeout value. Although the command continues to run until it is finished, you might see the exception java.net.SocketTimeoutException: Read timed out. To prevent this exception, set a higher value for the property....

com.ibm.SOAP.requestTimeout

...in the profile_root/properties/soap.client.props file.

Parameters

-processAppAcronym processApp acronym

A required parameter that identifies the process application that is to be installed. For example, the BillingDispute process application might have an acronym of BILLDISP.

Tip: If you do not know the acronym for a required parameter, use the BPMShowProcessApplication command to list the details of a process application, including acronyms.

-sourceSnapshotName snapshot name

A required parameter that provides the snapshot name from which instances will be migrated (the old version).

-targetSnapshotName snapshot name

A required parameter that provides the snapshot name to which instances will be migrated (the new version).

-outputFile file path

A required parameter that provides the file path to the directory where the orphan token policy file will be generated and a name for that file.

-overwrite

An optional parameter that forces a replacement of an existing policy file with the new generated file.

Examples

The following examples illustrate how to establish a SOAP connection to the Process Center server and then generate an orphaned token policy file for a process application with acronym OTA.

In a network deployment environment, use the port configured for the application cluster member that runs the Process Server or Process Center applications. To determine the correct port number, see the WebSphere administrative console Ports collection page (click Servers > Server Types > WebSphere application servers > server_name > Communications > Ports and find the value for SOAP_CONNECTOR_ADDRESS).

Jython example

wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com 
-user admin ID -password administrator password -lang jython

AdminTask.BPMCheckOrphanTokens(’[-processAppAcronym OTA -sourceSnapshotName 
"Version A" -targetSnapshotName "Version B" -outputFile C:\TokenPolicyFile_OTA.xml]’)

JACL example

wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com 
-user admin ID -password administrator password

$AdminTask BPMCheckOrphanTokens {-processAppAcronym OTA -sourceSnapshotName 
"Version A" -targetSnapshotName "Version B" -outputFile C:\TokenPolicyFile_OTA.xml}

Parent topic: Commands (wsadmin scripting)