View Source

{section}
{column}

h1. Introduction

The Petals SE Flowable tooling pack for Petals CLI is a set of commands relatives to the Petals SE Flowable. The pack comes with the commands:
* {{se-flowable.list-process-instances}}: List process instances ended,
* {{se-flowable.purge-process-instance}}: Purge process instance(s),
* {{se-flowable.undeploy-process-definition}}: Undeploy a process definition.

{column}
{column:width=40%}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}

h1. Installing the Petals SE Flowable tooling pack

h2. Through Debian packages

If you have installed Petals CLI using the Debian packages, we recommend you to install the Petals SE Flowable tooling pack using its own Debian package ({{petals-cli-se-flowable}}). Otherwise, unzip the content of the ZIP archive in the directory {{$PETALS_CLI_HOME/extensions}}.

h2. Through ZIP archives

If you have installed the *full* ZIP archive, the extension should be already installed. Otherwise, unzip the content of the ZIP archive {{petals-cli-se-flowable}} in the directory {{$PETALS_CLI_HOME/extensions}}.

h2. Installation verification

To check that the installation is correct, just get the list of available commands of your Petals CLI, you should see the command '{{se-flowable.*}}' in the list:
{code}
> ./petals-cli.sh -c -- help
Available commands:
...
se-flowable.list-process-instances
List process instances of the SE Flowable.
se-flowable.purge-process-instance
Purge a process instance of the SE Flowable.
set Assign a value to the system property named key.
...
{code}

h1. Commands

h2. Listing process instances ended

The command *{{se-flowable.list-process-instances}}* provides a way to list process instances ended of a Petals SE Flowable.

{code}
USAGE:
se-flowable.list-process-instances usage: se-flowable.list-process-instances [-k <process-definition-key>]
[-n <component-id>] [-o <output-file>] [-v
<process-definition-version>]


DESCRIPTION:
List process instances of the SE Flowable

OPTIONS DESCRIPTION:
-k,--process-definition-key <process-definition-key> The process definition key of process
instances to retrieve.
-n,--component-id <component-id> The identifier of the component.
Default: petals-se-flowable
-o,--output-file <output-file> Name of the output file where process
instance identifiers are printed.
-v,--process-definition-version <process-definition-version> The process definition version of
process instances to retrieve.

{code}

If no process definition is set as arguments, all process definitions are taken into account.
If no output file is provided, process instance identifier are listed on standard output. One process identifier is printed per line, in the output file or on standard output.

The number of process instances listed is printed on standard output.

h2. Purging process instance(s)

The command *{{se-flowable.purge-process-instance}}* provides a way to purge process instances of a Petals SE Flowable. Purging a process instance will deletes all data associated to the process instance from the Flowable database assocaited to the Petals SE Flowable.

{code}
USAGE:
se-flowable.purge-process-instance usage: se-flowable.purge-process-instance [-f <process-instance-ids-file>
| -i <process-instance>] [-n <component-id>] [-o <output-file>]


DESCRIPTION:
Purge a process instance of the SE Flowable

OPTIONS DESCRIPTION:
-f,--process-instance-ids-file <process-instance-ids-file> Name of the input file containing identifiers of
process instances to purge.
-i,--process-instance <process-instance> The process instance to purge.
-n,--component-id <component-id> The identifier of the component.
Default: petals-se-flowable
-o,--output-file <output-file> Name of the output file where process instance
identifiers are printed.

{code}

This command will return the flow instances (MONIT traces) associated to the purged process instance.
If no output file is provided, flow instance identifiers are listed on standard output. One flow instance identifier is printed per line, in the output file or on standard output.

The number of associated flow instances listed is printed on standard output.

h2. Undeploing a process definition

The command *{{se-flowable.undeploy-process-definition}}* provides a way to undeploing a process definition previously deployed through Petals SE Flowable.

{code}
USAGE:
se-flowable.undeploy-process-definition usage: se-flowable.undeploy-process-definition -k <process-definition-key>
[-n <component-id>] -v <process-definition-version>


DESCRIPTION:
Undeploy a process definition

OPTIONS DESCRIPTION:
-k,--process-definition-key <process-definition-key> The process definition key to undeploy.
-n,--component-id <component-id> The identifier of the component.
Default: petals-se-flowable
-v,--process-definition-version <process-definition-version> The process definition version to undeploy.
{code}