BPMShowOrphanedToolkits command

This command returns a list of toolkit snapshots that are not referenced by other process apps or toolkits. You can use the list to delete the orphan snapshots on your server.

When you install a process application snapshot on a process server, the toolkit snapshots that the process app references are also installed with it. However, when you delete a process app snapshot, the toolkit snapshots are not deleted. You can use the BPMShowOrphanedToolkits in connected mode from either a Process Center server or a Process Server to return a list of all orphaned toolkit snapshots on that server. You can use output from this command in a script with other wsadmin commands. For example, you can use the output from the BPMShowOrphanedToolkits command as input to the BPMDeleteSnapshot command.

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

Prerequisites

Note: In an environment with multiple security domains configured, use the PALService MBean instead of this wsadmin command. See The Process Application LifeCycle (PAL) MBean.

The following conditions must be met:

Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
In a network deployment environment, you must run this command on the node containing the application cluster member that handles Process Server or Process Center applications. Do not run this command from the deployment manager profile.
The installation package must already be created and extracted on the server. After this command is complete, the installed snapshot is active.
Note: 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 com.ibm.SOAP.requestTimeout property in the profile_root/properties/soap.client.props file.

Location

Start the wsadmin scripting client from the profile_root/bin directory.

Syntax

BPMShowOrphanedToolkits 

[-showOrphanedToolkitSnapshot true|false]
[-orphanedToolkitAcronym toolkit_acronym]

Parameters

-showOrphanedToolkitSnapshot true|false: An optional parameter that shows the orphan snapshots of the toolkits. The default is true. If you specify false, only the toolkits that have all of their snapshots orphaned are returned.
-orphanedToolkitAcronym toolkit_acronym: An optional parameter that lists the orphan snapshots of a specific toolkit, which is identified by its acronym.

Example

The following example illustrates how to return all the orphaned snapshots of the toolkit that has the acronym TK6. In the example, the user establishes a SOAP connection to the Process Center server.

Important: 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).

wsadmin -conntype SOAP -port 8880 -host localhost -user admin -password admin -lang jython
wsadmin>AdminTask.BPMShowOrphanedToolkits('[-showOrphanedToolkitSnapshot false -orphanedToolkitAcronym TK6]')

The output is a list of toolkits and their snapshots, similar to the following example.

{containerName: TK2
containerAcronym:ORTTTK2
containerSnapshotAcronym: S1}
{containerName: TK6
containerAcronym:ORTTTK6
containerSnapshotAcronym: S2}
{containerName: TK5
containerAcronym:ORTTTK5