Flowable Documentation

website·Indexed 35 days ago

https://documentation.flowable.com/latest/

Technical documentation for Flowable, covering the React Model for BPMN and CMMN, form components, and a comprehensive suite of REST APIs including Process, Case Management (CMMN), Decision (DMN), IDM, Analytics, and Agent Engine.

Tokens: 469.6K
Snippets: 790
Records: 3.7K
Agent score: 64%

What's inside Flowable

Overview of Flowable Engage third-party messenger integrations
Flowable Work with chat capabilities allows the integration of third-party messenger applications, enabling external participants to communicate via their preferred channels while management remains centralized within a single application. Currently, adapters are available and ready to use for WeChat, WhatsApp, and LINE.
https://documentation.flowable.com/latest/user/engage/integrations/index.html
Overview of the Password component
The Password component is a specialized input field designed for entering passwords. To ensure security and privacy, it masks user input by rendering characters as asterisks ('*') instead of plain text.
https://documentation.flowable.com/latest/reactmodel/forms/reference/password/index.html
Overview of Flowable Product Suite
The Flowable product suite consists of the following components built on top of the Flowable Open Source project:
- Flowable Work: A process and case management platform with a built-in user interface.
- Flowable Engage: Extends Flowable Work by adding conversations and external connectivity (e.g., WeChat, WhatsApp).
- Flowable Design: A modeling environment for creating BPMN, CMMN, DMN, and Form models.
- Flowable Control: An administration tool for managing Flowable Platform, Work, and Engage environments.
- Flowable Inspect: A debugging and test component for Flowable Work and Engage.
https://documentation.flowable.com/latest/admin/release-notes/3.12.0-release/index.html
Overview of Data Object Lookup tasks
Data Object Lookup tasks are used to reference and retrieve data stored separately from the process state, such as in a separate database table or via a REST service. This task is specifically designed to search for one specific data object based on a provided ID.
https://documentation.flowable.com/latest/reactmodel/bpmn/reference/data-object-lookup/index.html
Overview of Data Object Search in Flowable CMMN
The Data Object Search task is used to find data objects that meet specified criteria. Data objects reference data stored externally, such as in a separate database table or via a REST service.
https://documentation.flowable.com/latest/reactmodel/cmmn/reference/data-object-search/index.html
Overview of the Generate Document activity
The 'Generate Document' activity (available for BPMN and CMMN models) allows the generation of Word and PDF documents at runtime. It populates templates with data from process/case variables or external sources. Key capabilities include:
- Word Templates: Uses the Aspose LINQ Reporting Engine for dynamic content (conditionals, loops, images, and expressions).
- PDF Form Templates: Pre-fills editable form fields with variable values.
- Template Variations: Supports multi-language or context-dependent document generation.
- Output Formats: Supports PDF and Word, including PDF/A compliance for archival purposes.
https://documentation.flowable.com/latest/reactmodel/bpmn/reference/generate-document/index.html
Overview of the Flowable HTTP Task
The HTTP Task in Flowable React Model is used to execute an HTTP call, submit data, and store the resulting response from that call within the process.
https://documentation.flowable.com/latest/reactmodel/bpmn/reference/http-task/index.html
Overview of the Link component
The Link component is used in Flowable forms to enable navigation to either internal or external URLs.
https://documentation.flowable.com/latest/reactmodel/forms/reference/link/index.html
Overview of Flowable Event Registry REST API
The Flowable Event Registry REST API (v1) allows developers to manage the event-driven architecture of their Flowable environment. The API is organized into several functional areas: repository management (channels, event definitions, and deployments), runtime operations (sending event instances), and engine management.
```
Base URL: /event-registry-api
```
https://documentation.flowable.com/latest/assets/core-swagger/eventregistry.html
Overview of the Design MCP server
The Design MCP server enables AI assistants and Model Context Protocol (MCP) clients to interact with Flowable Design using natural language. It allows assistants to browse workspaces and packages, read, edit, validate, and publish models. The server enforces the same permissions, validation, and versioning as the Flowable Design user interface. It uses standard Design keys (workspaceKey, modelKey, packageType, and packageKey) for all operations.
https://documentation.flowable.com/latest/ai/ai-design-mcp-server/index.html
Overview of the Flowable React Model Slider component
The Slider component in Flowable React Model (v3.17.0+) is a simple input used to select or change a value on a scale between a defined minimum and maximum value.
https://documentation.flowable.com/latest/reactmodel/forms/reference/slider/index.html

Overview of Flowable Design MCP server tools

The Design MCP server provides a suite of tools for AI assistants to manage Flowable Design resources. These tools are categorized by their primary function (read, write, execute) and the resource they target.

Tool	Operations
`guide`	list, get (modelling guidance)
`workspace_read`	list, get, palette_categories
`workspace_write`	create, update, delete
`package_read`	list, get, palette_definitions, translations, list_revisions, get_revision
`package_write`	create, update, delete, duplicate, lock, unlock, create_revision
`model_read`	list, get, content, data_model, palette, palette_translations, relations, outline, history
`model_write`	create, update_content, update_key, update_metadata, delete, duplicate, lock, unlock, restore_version
`model_edit`	incremental structural edits
`validate_model`	stored, inline
`publish_read`	targets, requests, request, request_comments
`publish_write`	publish, create_request, resolve_request, comment_request
`test_read`	list, get, validate, list_resources, get_resource
`test_write`	create, update, update_key, delete, upload_resource, delete_resource
`test_execute`	execute, run, publish