Appendix: Utility Commands

To use the Utility Commands, refer the following table:

Usage

docker run -it --rm tibco/bpm/utility:5.0.0 utility -options

Options:

Options Arguments Description
-dbConfig url=<Database URL> username=<DB Username> password=<DB Password> Connection information required for BPME database
-setupDatabase [execute] [--verbose] Produces the database schema create / upgrade script and optionally executes it against the configured database.

--verbose forces output if SQL commands in 'execute' mode.

-setupAdminUser ldapAlias=<Alias> ldapDn=<LDAP DN> displayName=<Display Name> Configures the tibco-admin user to a custom LDAP and / or display name
-decode <uri> Decode a PVM URI, returning the database Id, object type and version found. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-encode <objectType> <dbId> [ownerId] Encode a PVM URI using the database Id for the given object type and version. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-dumpInfo   Dump the database information. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-dumpHalted   Dump information on halted instances. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-dumpProcess <instanceId|uri> Dump information for the given instance, and any related instances. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-diagnostics   Run diagnostics against the BPM system. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-purgeInstance <instanceId|URI> [--full] [--dryRun] [--ec] [--sc] [--verbose] Purge instance(s) for given instance Id/URI. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-purgeProcess <processName> [version=<version>] [batchSize=<batchSize>] [--dryRun] [--verbose] Purge instance(s) for given process. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-sendEvent <taskId|URI> <eventCode> [--dryRun] Send the required event to the given task. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-purgeWorkitem <workitemId> [--dryRun] [--verbose] Purge work item. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-alterCounter <taskId|URI> <counterValue> [--dryRun] Increments the counter by value given for the given task. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-invokeExternal <taskId|URI> [--dryRun] Invoke an EXTERNAL(20) event on the given task. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.
-cleanup [--dryRun] Perform cleanup. Use this parameter, only if advised by TIBCO Support. For more details, contact TIBCO Support.

Argument values with spaces should be enclosed in single quotes, for example, ldapDn='UID=admin, OU=system'.