BPMArchiveToolkit command

This command archives a deactivated toolkit from the Process Center server.

Use the BPMArchiveToolkit command in connected mode to archive a deactivated toolkit. You can run this command only on Process Center.

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

Prerequisites

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

In a network deployment environment, you must run this command on the node containing the application cluster member that handles Process Center applications. Do not run this command from the deployment manager profile. The input file is read from the machine on which the connected server is running. If you want to access the file from another machine, establish a remote wsadmin session from the current machine to the server on the machine where the file is stored.
Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
To access the wsadmin command, the ID being used must have a WebSphere® Application Server role with more privileges than the monitor role. See Administrative roles for information about roles.
To access the IBM® BPM API used by this command, the ID being used must belong to either the bpmAdminGroup or bpmAuthorGroup. The default name for the bpmAdminGroup is tw_admins and the default name for the bpmAuthorGroup is tw_authors. See IBM Business Process Manager default group types for information about groups.
Tip: By default, only the DeAdmin user has both the WebSphere Application Server administrator role and membership in the bpmAdminGroup.

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.

You can check the status of the command in the server SystemOut.log file.

Syntax

BPMArchiveToolkit
-containerAcronym toolkit_acronym

Parameters

-containerAcronym String: A required parameter that identifies the toolkit to be archived using its acronym.

Example

The following example illustrates how to establish a SOAP connection to the Process Center server, and then archive the My Company Toolkit.

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 ProcessServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMArchiveToolkit('[-containerAcronym MYCOTK]')