Administrative commands (AdminTasks)

Edit online

Traditional:
The wsadmin scripting program is a powerful, non-graphical command interpreter environment that you can use to run administrative operations in a scripting language. You can use the wsadmin tool in connected mode to install, manage, and undeploy snapshots.

In a network deployment environment, an application cluster member runs the Workflow Server and Workflow Center applications. Therefore, you must run these wsadmin commands on the node that contains that application cluster member. Do not run the commands from the deployment manager profile.

Not all commands can be used on both the Workflow Center server and workflow servers. Use the following table to determine which commands can be used on each type of server. Additional information about the commands and wsadmin scripting is found in the Commands (wsadmin scripting) topic.

Table 1. wsadmin commands for managing process applications
Task	Command	Description
Commands for installing and undeploying snapshots (connected and offline servers)	BPMCheckOrphanTokens	Detects the possibility of orphaned tokens before you install a new snapshot; enables you to identify whether to delete or move each token. Available for Workflow Center server and any running workflow server instance. Checks activities only. These include user tasks, system tasks, decision tasks, subprocesses, event subprocesses, linked processes, and nodes.
	BPMInstall	Installs a snapshot on a connected workflow server. Available for Workflow Center server only.
	BPMCreateOfflinePackage	Use this set of commands to create an installation package for a snapshot, extract it to a compressed file on a local file system, and install the package on an offline workflow server. BPMCreateOfflinePackage and BPMExtractOfflinePackage are available for Workflow Center server only.BPMInstallOfflinePackage is available for offline workflow server only.
	BPMExtractOfflinePackage
	BPMInstallOfflinePackage
	BPMDeleteSnapshot	Deletes the snapshot and any link to toolkit dependencies. This command does not delete the dependent toolkit snapshot. Available for any running workflow server instance.
	BPMUndeploy	Removes the corresponding business level application (BLA) and related artifacts of a snapshot from the Workflow Center server or the workflow server. However, the snapshot remains in the repository. For a Workflow Center server, the BPMUndeploy forces an implicit stop of the snapshot before the command is completed. Available for Workflow Center server and any running workflow server instance.
Commands for viewing process applications and artifacts	BPMListProcessApplications	Lists all process application snapshots on a given server. Available for Workflow Center server and any running workflow server instance.
	BPMShowProcessApplication	Lists information about a process application on a given server. Available for Workflow Center server and any running workflow server instance.
	BPMShowSnapshot	Lists information about a process application or toolkit snapshot on a given server. Available for Workflow Center server and any running workflow server instance.
Commands for administering snapshots	BPMActivate	Activates a snapshot on a server. Available for Workflow Center and any running workflow server instance.
	BPMDeactivate	Deactivates a snapshot that is running on a server. Available for Workflow Center server and any running workflow server instance.
	BPMExport	Exports a process application snapshot to a .twx file so that it can be imported on another Workflow Center server. Available for Workflow Center server only.
	BPMImport	Imports a process application snapshot that was exported from another Workflow Center server. Available for Workflow Center server only.
	BPMSnapshotCleanup	Deletes all the unnamed and archived snapshots of a process application on a Workflow Center server. Available for Workflow Center server only.
	BPMProcessInstancesPurge	Deletes business process definition (BPD) instance data for a process application snapshot. Available for any running workflow server instance.
	BPMTasksCleanup	Deletes completed tasks from running process instances. Available for any running workflow server instance.
	BPMStop	Stops the snapshot and its BLA on a workflow server. Available for any running workflow server instance.
Commands for working with servers	BPMListServers	Lists all workflow server instances that are federated into the Workflow Center server. Available for Workflow Center server only.
	BPMSecurityUnlock	Unlocks an application cluster member during server startup. Available for Workflow Center server and any running process server instance.
	BPMShowServer	Lists information about a specific server. Available for Workflow Center server only.

Some of the commands require administrative access; the user ID must belong to either the tw_admins or tw_authors group.

Connection types

All wsadmin commands for managing process applications must be run in connected mode and the server must be running. Use the -contype argument to indicate what connection type you want to use (SOAP or RMI). See Using the wsadmin scripting tool in the WebSphere® Application Server documentation for detailed instructions.

Example

In the following syntax examples, myHostName.mycompany.com is the host name of the server that is configured for Workflow Server or for the Workflow Center server. Make sure to substitute your own port, host name, user name, and password when you are creating a connection.

In a network deployment environment, use the port that is configured for the application cluster member that runs the Workflow Server or Workflow Center applications. To determine the correct port number, see the administrative console Ports collection page (click Servers > Server Types > WebSphere application servers > server_name > Communications > Ports). The values for SOAP_CONNECTOR_ADDRESS and BOOTSTRAP_ADDRESS indicate the SOAP and RMI port numbers.

Important:

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

AdminTask.taskName('[options ]')