Flowable

https://documentation.flowable.com/
Admin
Flowable is an open-source process automation and workflow management platform that enables...
Tokens:509,672
Snippets:8,092
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Elasticsearch

Source: https://documentation.flowable.com/latest/admin/installs/platform-full/step-by-step-installation

Command to initiate the Elasticsearch server from the installation directory.

```bash
bin/elasticsearch
```

--------------------------------

### Navigate and Install Dependencies

Source: https://documentation.flowable.com/latest/develop/fe/forms/custom-components-quickstart

Enter the library directory and install necessary project dependencies.

```bash
cd [library-name]
yarn
```

--------------------------------

### Install Azure CLI

Source: https://documentation.flowable.com/latest/admin/cloud-deployment/terraform-azure

Install the Azure CLI tool using Homebrew.

```bash
brew install azure-cli
```

--------------------------------

### Simple Computation Example

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/usage

A basic example demonstrating input retrieval, calculation, and output submission.

```robotframework
*** Settings ***  

Library		flowable.rpaframework_client.API  

  

*** Tasks ***  

Get weather forecast  

    ${city}=		flw input	city  

    ${days}=		flw input	days  

    ${length}=      Get Length  ${city}  

    ${temperature}=     Evaluate    ${days} * ${length}  

    flw output		temperature     ${temperature}  
```

--------------------------------

### Install and Configure jEnv

Source: https://documentation.flowable.com/latest/admin/installs/java

Commands to install jEnv and add its initialization to the bash profile.

```bash
brew install jenv
```

```bash
echo 'export PATH="$HOME/.jenv/bin:$PATH"' >> ~/.bash_profile
```

```bash
echo 'eval "$(jenv init -)"' >> ~/.bash_profile
```

--------------------------------

### Install SDKMAN!

Source: https://documentation.flowable.com/latest/admin/installs/java

Run this command in a terminal to install SDKMAN! on Unix-based platforms.

```bash
curl -s "https://get.sdkman.io" | bash
```

--------------------------------

### Install Flowable RPA Framework Client

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/introduction

Command to install the core client library using pip.

```bash
pip install flowable.rpaframework-client
```

--------------------------------

### Install Frontend Dependencies

Source: https://documentation.flowable.com/latest/howto/howto/howto-create-custom-form-component

Install the necessary React, Flowable Forms, and Storybook packages for the development environment.

```bash
yarn add react react-dom @flowable/forms  

yarn add --dev typescript \

                @storybook/react \

                @storybook/addon-storysource \

                @storybook/addon-links \

                @storybook/addon-essentials \

                @storybook/addon-cssresources
```

--------------------------------

### Install Dependencies

Source: https://documentation.flowable.com/latest/develop/fe/customize

Install the required Flowable work scripts and TypeScript as development dependencies.

```bash
yarn add @flowable/work-scripts typescript --dev  
```

--------------------------------

### Verify Java Installation

Source: https://documentation.flowable.com/latest/admin/installs/java

List all installed Java Virtual Machines to verify versions and paths.

```bash
/usr/libexec/java_home -V
```

--------------------------------

### Install AWS CLI

Source: https://documentation.flowable.com/latest/admin/cloud-deployment/terraform-aws

Install the AWS Command Line Interface using Homebrew.

```bash
brew install awscli
```

--------------------------------

### Install AdoptOpenJDK 11 via Homebrew

Source: https://documentation.flowable.com/latest/admin/installs/java

Commands to tap the AdoptOpenJDK repository and install JDK 11.

```bash
brew tap AdoptOpenJDK/openjdk
```

```bash
brew cask install adoptopenjdk11
```

--------------------------------

### Screen Interaction Example

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/usage

A complex example showing how to interact with desktop applications, perform image-based locators, and read screen data.

```robotframework
*** Settings ***  

Library		RPA.Tasks  

Library		RPA.Desktop  

Library		flowable.rpaframework_client.API  

  

*** Tasks ***  

Discounted cash flow  

    ${fc1}=		flw input	fc1  

    ${fc2}=		flw input	fc2  

    ${fc3}=		flw input	fc3  

    ${wacc}=		flw input	wacc  

    Open Application    open	-a	/Applications/Microsoft\ Excel.app  

    Click		image:images/fc1.png	click  

    Press keys		right  

    Type text		${fc1}  

    Press keys		enter  

    Type text		${fc2}  

    Press keys		enter  

    Type text		${fc3}  

    Press keys		enter  

    Type text		${wacc}  

    Press keys		enter  

    ${terminal_region}=	Find element    image:images/terminal-value.png  

    ${moved_t_region}=	Move Region	${terminal_region}	205	0  

    ${terminal_value}=	Read Text	${moved_t_region}  

    ${company_region}=	Find element    image:images/company-value.png  

    ${moved_c_region}=	Move Region	${company_region}	205	0  

    ${company_value}=	Read Text	${moved_c_region}  

    Take screenshot  

    flw output		companyValue	${company_value}  

    flw output		terminalValue	${terminal_value}  
```

--------------------------------

### Install Oracle JDK 8 via Homebrew

Source: https://documentation.flowable.com/latest/admin/installs/java

Commands to tap the versions repository and install Oracle JDK 8.

```bash
brew tap caskroom/versions
```

```bash
brew cask install java8
```

--------------------------------

### Generate Email Address via Script Task

Source: https://documentation.flowable.com/latest/user/design/bpmn-editor

Example script to retrieve process variables, concatenate them into an email address, and store the result back into the execution context.

```javascript
var firstName = execution.getVariable("firstName").toLowerCase(); var lastName = execution.getVariable("lastName").toLowerCase(); var email = firstName + "." + lastName + "@yourCompany.com"; execution.setVariable("email", email);
```

--------------------------------

### Define Tenant Setup File Path

Source: https://documentation.flowable.com/latest/admin/installs/platform-full/installation-options

Place tenant definition files in this directory structure to populate the internal IDM at startup.

```text
src/main/resources/com/flowable/tenant-setup/custom/<tenants>.json  
```

--------------------------------

### Resolved URL with Tomcat root context

Source: https://documentation.flowable.com/latest/model/forms/concept/work-form-expressions

Example of a resolved query URL when the path does not start with a slash and uses the server context.

```text
http://your-server-hostname/work/platform-api/search/work-instances?size=10&start=0  
```

--------------------------------

### Process Migration Configuration Example

Source: https://documentation.flowable.com/latest/reactmodel/bpmn/concept/process-migration

Example JSON configuration demonstrating the use of a Java delegate expression and a Groovy script during process migration.

```json
{

  "toProcessDefinitionId": "CAS-4ce9eaf6-6287-11ef-ae73-e68ac21327db",

  "preUpgradeJavaDelegateExpression": "${myJavaDelegate}",

  "postUpgradeScript": {

    "language": "groovy",

    "script": "execution.setVariable(\"additionalContext\", \"Test process level\")"

  }

}
```

--------------------------------

### Install Terragrunt

Source: https://documentation.flowable.com/latest/admin/cloud-deployment/terraform-azure

Install Terragrunt using Homebrew, which also installs Terraform as a dependency.

```bash
brew install terragrunt
```

--------------------------------

### Initialize Component Library

Source: https://documentation.flowable.com/latest/develop/fe/forms/custom-components-quickstart

Create a new library project for custom components.

```bash
flowable components init
```

--------------------------------

### GET /platform-management/engine

Source: https://documentation.flowable.com/latest/assets/ent-swagger/platform.html

Get Platform engine info.

```APIDOC
## GET /platform-management/engine

### Description
Get Platform engine info.

### Method
GET

### Endpoint
/platform-management/engine
```

--------------------------------

### GET /current-user

Source: https://documentation.flowable.com/latest/assets/ent-swagger/idm.html

Get current user information.

```APIDOC
## GET /current-user

### Description
Get current user.

### Method
GET

### Endpoint
/current-user
```

--------------------------------

### POST /agent-runtime/agent-instances

Source: https://documentation.flowable.com/latest/assets/ent-swagger/agent.html

Start an agent instance.

```APIDOC
## POST /agent-runtime/agent-instances

### Description
Start an agent instance.

### Method
POST

### Endpoint
/agent-runtime/agent-instances
```

--------------------------------

### GET /process-instances/{processInstanceId}

Source: https://documentation.flowable.com/latest/assets/ent-swagger/platform.html

Get process instance details.

```APIDOC
## GET /process-instances/{processInstanceId}

### Description
Get process instance.

### Method
GET

### Endpoint
/process-instances/{processInstanceId}

### Parameters
#### Path Parameters
- **processInstanceId** (string) - Required - The ID of the process instance.
```

--------------------------------

### Start Process Instance Script

Source: https://documentation.flowable.com/latest/model/action/concepts/scripting-based-action

Shows how to trigger a process instance by key and return the resulting instance ID.

```javascript
var processDefinitionKey = flw.getInput("processDefinitionKey");  

var processInstance = runtimeService.startProcessInstanceByKey(processDefinitionKey);  

flw.setOutput("processInstanceId", processInstance.getId());
```

--------------------------------

### Install Expo Dependencies

Source: https://documentation.flowable.com/latest/develop/fe/forms/native-installation

Install Expo and its required modules for the project.

```bash
yarn add expo@^52.0  

npx install-expo-modules  
```

--------------------------------

### Example Tenant JSON Configuration

Source: https://documentation.flowable.com/latest/admin/installs/platform-full/installation-options

A sample JSON file defining a tenant, its groups, and users. A unique tenantKey is required for non-default tenants.

```json
{

  "name": "Flowable Demo",

  "tenantKey": "demo",

  "groups": [  

    {  

      {"key": "flowableAdministrator", "name": "Flowable Administrator"},  

      {"key": "flowableUser", "name": "Flowable User"},  

  ],  

  "users": [  

    {  

      "firstName": "Flowable",  

      "lastName": "Admin",  

      "login": "admin",  

      "email": "admin@demo.flowable.io",  

      "language": "en",  

      "theme": "flowable",  

      "userDefinitionKey": "admin"  

    }  

  ]  

}  
```

--------------------------------

### Install Recharts dependency

Source: https://documentation.flowable.com/latest/howto/howto/howto-create-custom-form-component

Install the required charting library via yarn.

```bash
yarn add recharts  
```

--------------------------------

### Install React Types

Source: https://documentation.flowable.com/latest/develop/fe/forms/start-installation

Installs React type definitions for TypeScript projects.

```bash
yarn add @types/react --dev
```

--------------------------------

### Example .robot file for Flowable automation

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/example

This configuration demonstrates how to import necessary libraries, read input variables from Flowable, perform desktop automation tasks, and return output values.

```robotframework
*** Settings ***  

# Importing the different libraries, this includes the Flowable API which is used to read input parameters  

# and also write output parameters.  

Library		RPA.Tasks  

Library		RPA.Desktop  

Library		flowable.rpaframework_client.API  

  

*** Tasks ***  

# "Discounted cash flow" is the name which is used inside the process/case to reference to this specific task  

Discounted cash flow  

    # Reading variables from the input in the process. The first part is the variable in the .robot file,  

    # while the last name is the name how it's defined as input parameter.  

    ${fc1}=		flw input	fc1  

    ${fc2}=		flw input	fc2  

    ${fc3}=		flw input	fc3  

    ${wacc}=		flw input	wacc  

    # This opens an application, in this case it's the command to open excel on a Mac.  

    Open Application    open	-a	/Applications/Microsoft\ Excel.app  

    # Clicks on a certain position the screen  

    Click		image:images/fc1.png	click  

    # A few key presses, which are used to enter the input data. Here we can see how the variables from above are used.  

    Press keys		right  

    Type text		${fc1}  

    Press keys		enter  

    Type text		${fc2}  

    Press keys		enter  

    Type text		${fc3}  

    Press keys		enter  

    Type text		${wacc}  

    Press keys		enter  

    # Searches the next element, but this time without clicking on it. Instead, it saves the position of it.  

    ${terminal_region}=	 Find element    image:images/terminal-value.png  

    # We are using an offset to go to the region on which probably the result is stored  

    ${moved_t_region}=	 Move Region     ${terminal_region}  205  0  

    # We read the text from the region to a new variable called `terminal_value`  

    ${terminal_value}=	 Read Text	${moved_t_region}  

    # The same in the next three lines for the company value  

    ${company_region}=	 Find element    image:images/company-value.png  

    ${moved_c_region}=	 Move Region     ${company_region}  205  0  

    ${company_value}=	 Read Text       ${moved_c_region}  

    # We take a screenshot, which isn't used in the process but stored in the rpaframework report.  

    Take screenshot  

    # Writing the output values back to Flowable, so that they can be mapped to the process or case  

    flw output		companyValue	${company_value}  

    flw output		terminalValue	${terminal_value}
```

--------------------------------

### startEngage(options)

Source: https://documentation.flowable.com/latest/develop/fe/engage-embedded

Initializes and displays the Engage conversation window with the specified configuration.

```APIDOC
## startEngage(options)

### Description
Initializes the Engage Embedded floating window. This function renders the conversation specified by the `conversationId`.

### Parameters
- **conversationId** (string) - Optional - The ID of the conversation to be displayed.
- **showLogin** (boolean) - Optional - Show the login screen if no user is logged-in (Default: false).
- **header** (object | boolean) - Optional - Configuration for the conversation header. 
  - **header.closeIcon** ('none', 'close', 'minimize', 'back-button') - Optional - Icon to dismiss the conversation (Default: 'minimize').
  - **header.showDescription** (boolean) - Optional - Whether to show the conversation description (Default: false).
- **theme** (object) - Optional - Custom theme object for styling the component.
- **inputTextAutofocus** (boolean) - Optional - Automatically focus the message input (Default: false).
- **anonymous** (boolean) - Optional - Allow conversation without credentials (Default: false).

### Usage Example
```javascript
import { startEngage } from "@flowable/embedded-react";

startEngage({
  conversationId: "ENG-00c2c0a0-a313-11e9-a39e-327b10be5bea",
  header: { showDescription: true }
});
```
```

--------------------------------

### GET /latest-inflight-test-model

Source: https://documentation.flowable.com/latest/assets/ent-swagger/inspect.html

Get the latest inflight test model for the current user.

```APIDOC
## GET /latest-inflight-test-model

### Description
Get the latest inflight test model for the current user.

### Method
GET

### Endpoint
/latest-inflight-test-model
```

--------------------------------

### Initialize Project Structure

Source: https://documentation.flowable.com/latest/develop/fe/customize

Commands to create the directory structure, initialize the project, and configure TypeScript.

```bash
mkdir customize-work-fe/  

cd customize-work-fe/  

mkdir src/  

# in case of using typescript, create a tsconfig.json  

echo '{"exclude": ["/node_modules/"], "compilerOptions":{"rootDir": ".","jsx":"react","module":"esNext","moduleResolution":"node","outDir":"./dist","preserveConstEnums":true,"strict":true,"strictFunctionTypes":false,"target":"es5","sourceMap":true,"importHelpers":true,"resolveJsonModule":true,"esModuleInterop":true}}' > tsconfig.json  

touch src/index.ts  

# init the yarn project  

yarn init --yes  
```

--------------------------------

### Build and run the custom Docker image

Source: https://documentation.flowable.com/latest/admin/installs/docker-custom-libraries

Commands to build the custom image and start a container instance.

```bash
docker build -t my-company/flowable-work .  

docker run my-company/flowable-work
```

--------------------------------

### Install Flowable Forms

Source: https://documentation.flowable.com/latest/develop/fe/forms/start-installation

Installs the core Flowable Forms package from the internal repository.

```bash
yarn add @flowable/forms
```

--------------------------------

### Check CLI Help

Source: https://documentation.flowable.com/latest/develop/fe/customize

View available build and watch arguments via the command line.

```bash
yarn flowbuild build --help

# or watch

yarn flowbuild watch --help
```

--------------------------------

### Install RPA Dependencies

Source: https://documentation.flowable.com/latest/develop/external-clients/rpaframework/example

Installs the required rpaframework packages and the Flowable client library.

```bash
pip install rpaframework graphviz rpaframework-recognition pytesseract flowable.rpaframework-client   
```

--------------------------------

### Plan and apply Flowable application deployment

Source: https://documentation.flowable.com/latest/admin/cloud-deployment/terraform-aws

Commands to preview changes via plan and execute deployment via apply for the Flowable Helm chart.

```bash

cd flowable-iac-deployments/aws/prod/eu-central-1/dev/app/flowable-app  

terragrunt plan  



```

```bash

cd flowable-iac-deployments/aws/prod/eu-central-1/dev/app/flowable-app  

terragrunt apply  



```

--------------------------------

### Install Rollup dependencies

Source: https://documentation.flowable.com/latest/howto/howto/howto-create-custom-form-component

Installs the necessary Rollup plugins for bundling the custom component suite.

```bash
yarn add --dev rollup \
            rollup-plugin-sourcemaps \
            rollup-plugin-uglify \
            @rollup/plugin-node-resolve \
            @rollup/plugin-typescript \
            @rollup/plugin-commonjs \
            @rollup/plugin-replace  
```
Tokens:
Raw