ActiveMatrix BPM Edit: Purge Process CLI Configuration

Note: This screen is displayed only if you chose Edit the Purge Process CLI configuration on the Select Edit Configurations screen.

The Purge Process CLI (Command-Line Interface) is a utility that can be used, either interactively or via scripting, to remotely purge completed, cancelled or failed process instances that have not been automatically purged. For more information, see "Using the Purge Process CLI" in TIBCO ActiveMatrix BPM Administration.

Field/Button Description
Enable Purge Process CLI Whether the Purge Process CLI is enabled on this node.

When selected, the remaining fields on this screen are enabled.

Default: Cleared (The Purge Process CLI is disabled.)

Note: After an upgrade, the Purge Process CLI is disabled, even if it was enabled on the previous version of the ActiveMatrix BPM system. If you want to use the Purge Process CLI on the upgraded system, you must manually enable it.
Target Node: Node name of the BPM node that hosts the Purge Process CLI.

Default: BPMNode

Port Number: Port number on which the Purge Process CLI is listening.

Default: 0

IP Address: IP address of the machine on which the specified Target Node is running.

Default: 127.0.0.1

Note: With the default value, the Purge Process CLI is not exposed to a remote SSH client.
Note: On a distributed ActiveMatrix BPM system:
  • You enable the Purge Process CLI on a per-node basis. For example, if the ActiveMatrix BPM system contains 4 nodes, to enable the Purge Process CLI on each one you must run this wizard and select the Enable Purge Process CLI option on each node. You can enable the Purge Process CLI on all, some or none of the nodes as you require.
  • If you subsequently run this wizard on a any node and disable the Purge Process CLI, it is disabled on every node on which it has been previously enabled. (You do not need to run the wizard and select this option on each node.)