FlowX

# Docs

## Docs

- [FlowX.AI platform setup](https://docs.flowx.ai/5.1/ai-platform/ai-platform-setup.md): This guide provides essential information for clients who need to configure and connect to the FlowX.AI Platform services.
- [Add new Kafka exchange mock](https://docs.flowx.ai/5.1/docs/api/add-kafka-mock.md)
- [Enable misconfigurations](https://docs.flowx.ai/5.1/docs/api/add-misconfigurations.md): To enable and to compute warnings for already existing processes from previous FlowX.AI versions (< 4.1), you must use the following endpoint to compute all the warnings.
- [Clear cache](https://docs.flowx.ai/5.1/docs/api/clear-cache.md)
- [Download a file](https://docs.flowx.ai/5.1/docs/api/download-file.md)
- [List buckets](https://docs.flowx.ai/5.1/docs/api/list-buckets.md): The Documents Plugin provides the following REST API endpoints for interacting with the stored files.
- [List objects in a bucket](https://docs.flowx.ai/5.1/docs/api/list-objects-in-buckets.md)
- [Execute action](https://docs.flowx.ai/5.1/docs/api/rest4.md): This endpoint executes an action within a specific process runtime.
- [Get Build Info](https://docs.flowx.ai/5.1/docs/api/start-process/get-build-info.md): This endpoint retrieves information about the build of a specific project, as set by the Active policy.
- [Start process by build id and process name](https://docs.flowx.ai/5.1/docs/api/start-process/rest2.md): This endpoint initiates a process in the application runtime environment using the specified `buildId` and `processDefinitionName`.
- [Start process with name and inherit values](https://docs.flowx.ai/5.1/docs/api/start-process/rest3.md)
- [View Kafka exchanges](https://docs.flowx.ai/5.1/docs/api/view-kafka-exchanges.md)
- [Node actions](https://docs.flowx.ai/5.1/docs/building-blocks/actions/actions.md): The activity that a node has to handle is defined using an action. These can have various types, they can be used to specify the communication details for plugins or integrations.
- [Append params to parent process](https://docs.flowx.ai/5.1/docs/building-blocks/actions/append-params-to-parent-process.md): It is a type of action that allows you to send data from a subprocess to a parent process.
- [Business rules types](https://docs.flowx.ai/5.1/docs/building-blocks/actions/business-rule-action/business-rule-action.md): A business rule is an action type in FlowX.AI that allows you to configure a script on a BPMN node. It's a way to specify business logic or decision-making processes in a business process.
- [Configuring a DMN business rule action](https://docs.flowx.ai/5.1/docs/building-blocks/actions/business-rule-action/dmn-business-rule-action.md): Decision Model and Notation is a graphical language used to specify business decisions. DMN helps convert complex decision-making code into easily readable diagrams.
- [Extracting additional data in business rules](https://docs.flowx.ai/5.1/docs/building-blocks/actions/business-rule-action/extracting-additional-data.md): Business rules in FlowX.AI allow you to extract and use key values dynamically. This is essential for handling user security details, configuration parameters, and business logic calculations.
- [Kafka send action](https://docs.flowx.ai/5.1/docs/building-blocks/actions/kafka-send-action.md): The FlowX.AI Designer offers various options to configure the Kafka Send Action through the Actions tab at the node level.
- [Send data to user interface](https://docs.flowx.ai/5.1/docs/building-blocks/actions/send-data-to-user-interface.md): Send data to user interface action is based on Server-Sent Events (SSE), a web technology that enables servers to push real-time updates or events to clients over a single, long-lived HTTP connection. It provides a unidirectional communication channel from the server to the client, allowing the server to send updates to the client without the need for the client to continuously make requests.
- [Start integration workflow action](https://docs.flowx.ai/5.1/docs/building-blocks/actions/start-integration-workflow.md): The Start Integration Workflow action initiates a configured workflow to enable data processing, transformation, or other tasks across connected systems.
- [Start new project instance](https://docs.flowx.ai/5.1/docs/building-blocks/actions/start-new-project-instance.md): The Start New Project Instance action allows users to initiate a completely new process (referred to as a "main process") from within an ongoing process. This functionality is designed to support scenarios where isolated use cases are managed across different applications or environments.
- [Start subprocess action](https://docs.flowx.ai/5.1/docs/building-blocks/actions/start-subprocess-action.md): A Start subprocess action is an action that allows you to start a subprocess from another (parent) process.
- [Upload file action](https://docs.flowx.ai/5.1/docs/building-blocks/actions/upload-file-action.md): An Upload File action is an action type that allows you to upload a file to a service available on Kafka.
- [Call activity node](https://docs.flowx.ai/5.1/docs/building-blocks/node/call-subprocess-tasks/call-activity-node.md): Call activity is a node that provides advanced options for starting subprocesses.
- [Start embedded subprocess](https://docs.flowx.ai/5.1/docs/building-blocks/node/call-subprocess-tasks/start-embedded-subprocess.md): The Start Embedded Subprocess node initiates subprocesses within a parent process, allowing for encapsulated functionality and enhanced process management.
- [Error events](https://docs.flowx.ai/5.1/docs/building-blocks/node/error-events.md): Error Events expand the capabilities of process modeling and error handling within BPMN processing. These Error Event nodes enhance the BPMN standard and offer improved control over error management.
- [Exclusive gateway](https://docs.flowx.ai/5.1/docs/building-blocks/node/exclusive-gateway-node.md): In the world of process flows, decisions play a crucial role, and that's where the Exclusive Gateway comes into play. This powerful tool enables you to create conditional pathways based on data provided.
- [Message catch boundary events](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-catch-boundary-event.md): Boundary events are integral components linked to user tasks within a process flow. Specifically, Message Catch Boundary Events are triggered by incoming messages and can be configured as either interrupting or non-interrupting based on your requirements.
- [Message catch start event](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-catch-start-event.md): Message Catch Start Event node represents the starting point for a process instance based on the receipt of a specific message. When this event is triggered by receiving the designated message, it initiates the execution of the associated process.
- [Message Events](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-events.md): Message events serve as a means to incorporate messaging capabilities into business process modeling. These events are specifically designed to capture the interaction between different process participants by referencing messages.
- [Intermediate message events in business processes](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-intermediate/example-intermediate-message-events.md): Business processes often involve dynamic communication and coordination between different stages or departments. Intermediate Message Events play an important role in orchestrating information exchange, ensuring effective synchronization, and enhancing the overall efficiency of these processes.
- [Message catch intermediate event](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-intermediate/message-catch-intermediate-event.md): A Message Catch Intermediate Event is a type of event in a process that waits for a specific message before continuing with the process flow.
- [Message intermediate events overview](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-intermediate/message-intermediate.md)
- [Message throw intermediate event](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-events/message-intermediate/message-throw-intermediate-event.md): Using a Throw intermediate event is like throwing a message to tell someone about something. After throwing the message, the process keeps going, and other parts of the process can listen to that message.
- [Send message/receive message tasks](https://docs.flowx.ai/5.1/docs/building-blocks/node/message-send-received-task-node.md): Send message task and Receive message task nodes are used to handle the interaction between a running process and external systems. This is done using Kafka.
- [BPMN nodes](https://docs.flowx.ai/5.1/docs/building-blocks/node/node.md): A Business Process Model and Notation (BPMN) node is a visual representation of a point in your process. Nodes are added at specific process points to denote the entrance or transition of a record within the process.
- [Parallel gateway](https://docs.flowx.ai/5.1/docs/building-blocks/node/parallel-gateway.md): When you have multiple operations that can be executed concurrently, the Parallel Gateway becomes a valuable tool. This type of node creates a parallel section within the process, particularly useful for tasks that can run independently without waiting for each other. It's essential to close each parallel section with another Parallel Gateway node.
- [Start/end nodes](https://docs.flowx.ai/5.1/docs/building-blocks/node/start-end-node.md): Let's go through all the options for configuring start and end nodes for a process definition.
- [Task node](https://docs.flowx.ai/5.1/docs/building-blocks/node/task-node.md): A task node refers to a task that utilizes various services, such as Web services, automated applications, or other similar services, to accomplish a particular task.
- [Timer boundary event](https://docs.flowx.ai/5.1/docs/building-blocks/node/timer-events/timer-boundary-event.md): A Timer Boundary Event in Business Process Model and Notation (BPMN) is a specialized event attached to a specific task or subprocess within a process. It activates when a predefined time condition—such as a duration, deadline, or specific date—is met while the associated task or subprocess is still in progress.
- [Timer events](https://docs.flowx.ai/5.1/docs/building-blocks/node/timer-events/timer-events.md): Timer event nodes are a powerful feature in BPMN that allow you to introduce time-based behavior into your processes. These nodes enable you to trigger specific actions or events at predefined time intervals, durations, or cycles. With timer event nodes, you can design processes that respond to time-related conditions, ensuring smoother workflow execution and enhanced automation.
- [Timer expressions](https://docs.flowx.ai/5.1/docs/building-blocks/node/timer-events/timer-expressions.md)
- [Timer Intermediate Event (interrupting)](https://docs.flowx.ai/5.1/docs/building-blocks/node/timer-events/timer-intermediate-event.md): A Timer Intermediate Event (interrupting) is an event that is triggered based on a specified time duration or date. It is placed within the flow of a process and serves as a point of interruption and continuation.
- [Timer start event (interrupting)](https://docs.flowx.ai/5.1/docs/building-blocks/node/timer-events/timer-start-event.md): A Timer Start Event initiates a process instance based on a specified time or schedule.
- [User task node](https://docs.flowx.ai/5.1/docs/building-blocks/node/user-task-node.md): This node represents an interaction with the user. It is used to display a piece of UI (defined in the UI Designer or a custom Angular component. You can also define actions available for the users to interact with the process.
- [Data mappers](https://docs.flowx.ai/5.1/docs/building-blocks/process/data-mappers.md): Visually map data transfers between components with intuitive drag-and-drop functionality while maintaining full backward compatibility.
- [Process data model](https://docs.flowx.ai/5.1/docs/building-blocks/process/data-model.md): The Data Model is a centralized configuration feature that enables efficient management of key-value attributes inside process definitions. It supports multiple attribute types, such as strings, numbers, booleans, objects, arrays, and enums, offering users the ability to define, update, delete, and apply data attributes seamlessly.
- [Navigation areas](https://docs.flowx.ai/5.1/docs/building-blocks/process/navigation-areas.md): Navigation areas play a pivotal role in user interface design. They enhance the user experience by providing a structured, organized, and efficient way for users to interact with and explore various features and solutions.
- [Process Designer](https://docs.flowx.ai/5.1/docs/building-blocks/process/process.md): The Process Designer workspace is tailored for creating and editing business processes, featuring a menu with all the essential elements needed to design a process.
- [Process definition](https://docs.flowx.ai/5.1/docs/building-blocks/process/process-definition.md): The core of the platform is the process definition, which is the blueprint of the business process made up of nodes that are linked by sequences.
- [Project data model](https://docs.flowx.ai/5.1/docs/building-blocks/process/project-data-model.md): Define reusable data types at the project level to ensure consistency across processes
- [Subprocess management](https://docs.flowx.ai/5.1/docs/building-blocks/process/subprocess.md): Learn how to configure, start, and execute subprocesses efficiently within your process flow.
- [Reusable Functions](https://docs.flowx.ai/5.1/docs/building-blocks/reusable-resources/reusable-functions.md): Create and manage business logic components that can be reused across multiple processes in your FlowX.AI applications.
- [Reusable UI Templates](https://docs.flowx.ai/5.1/docs/building-blocks/reusable-resources/reusable-ui.md): Create and manage modular UI components that can be used across multiple User Tasks and processes in your FlowX.AI applications.
- [Supported scripts](https://docs.flowx.ai/5.1/docs/building-blocks/supported-scripts.md): Scripts are used to define and run actions but also properties inside nodes. For now, the following script languages are supported.
- [Token](https://docs.flowx.ai/5.1/docs/building-blocks/token.md): Token is the concept that describes the current position in the process flow. When you start the process you have a graph of nodes and based on the configuration you will go from one to another based on the defined sequence (connection between nodes).
- [UI Designer best practices](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/best-practices.md): Best practices for creating effective user interfaces using FlowX.AI UI Designer, based on established design principles and platform capabilities.
- [Conditional styling](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/conditional-styling.md): Dynamically update styling and properties of UI elements based on conditions, reducing the need for multiple prototypes.
- [Dynamic & computed values](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/dynamic-and-computed-values.md): In modern application development, the ability to create dynamic and interactive user interfaces is essential for delivering personalized and responsive experiences to users. Dynamic values and computed values are powerful features that enable developers to achieve this level of flexibility and interactivity.
- [Layout configuration](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/layout-configuration.md): Layout settings are available for all components that can group other types of elements (for example, Containers or Cards).
- [Localization and internationalization](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/localization-and-i18n.md): FlowX.AI localization and internationalization adapt applications to different languages, regions, and formats, enhancing the user experience with dynamic date, number and currency formatting.
- [Platform-specific considerations](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/platform-considerations.md): Platform-specific configuration, limitations, and best practices for Web, iOS, and Android platforms in FlowX.AI UI Designer.
- [Screen configuration guide](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/screen-configuration-guide.md): Learn how to configure screens effectively using FlowX.AI UI Designer with platform-specific settings and navigation areas.
- [UI actions](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-actions.md): UI actions bridge the gap between multiple UI elements and specific actions, dictating how the interface responds to user interactions. They control behaviors such as displaying loaders, dismissing modals, or sending default data back to a process, enabling interaction between UI components and underlying logic.
- [Buttons](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/buttons.md): Interactive button components for triggering actions and file uploads with comprehensive styling and configuration options.
- [Collection](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/collection/collection.md): The Collection component functions as a versatile container element, allowing you to iterate through a list of elements and display them according to their specific configurations.
- [Collection Prototype](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/collection/collection-prototype.md): Create dynamic, data-driven interfaces with different layouts based on item properties using collection prototypes.
- [File preview](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/file-preview.md): The File Preview UI element is a user interface component that enables users to preview the contents of files quickly and easily without fully opening them. It can save time and enhance productivity, providing a glimpse of what's inside a file without having to launch it entirely.
- [Checkbox](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/checkbox-form-field.md): A checkbox form field is an interactive element in a web form that provides users with multiple selectable options. It allows users to choose one or more options from a pre-determined set by simply checking the corresponding checkboxes.
- [Datepicker](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/datepicker-form-field.md): The datepicker (Calendar Picker) is a lightweight component that allows end users to enter or select a date value.
- [Input field](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/input-form-field.md): Enable users to input and validate various types of data with flexible configuration options and platform-specific customization.
- [Multi select](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/multi-select.md): The Multi Select form field is an element that allows users to choose multiple options from a list of choices. Each option consists of a label, which is displayed in the dropdown menu, and a corresponding value, which is stored upon selection.
- [Radio](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/radio-form-field.md): Radio buttons are normally presented in radio groups (a collection of radio buttons describing a set of related options). Only one radio button in a group can be selected at the same time.
- [Segmented button](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/segmented-button.md): It allows users to pick only one option from a group of options, and you can choose to have between 2 and 5 options in the group. The segmented button is easy to use, and can help make your application easier for people to use.
- [Single Select](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/select-form-field.md): Enable users to choose from a dropdown list of predefined options with advanced features including search, validation, and selective option disabling.
- [Slider](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/slider.md): It allows users to pick only one option from a group of options, and you can choose to have between 2 and 5 options in the group. The segmented button is easy to use, and can help make your application easier for people to use.
- [Switch](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/switch-form-field.md): Enable users to toggle between two states with an intuitive switch interface that stores boolean values in your process instances.
- [Text area](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/form-elements/text-area.md): A text area is a form element used to capture multi-line input from users in a conversational interface. The text area component is typically used for longer inputs such as descriptions, comments, or feedback, providing users with more space to type their responses.
- [Image](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/image.md): Image UI elements are graphical components of a user interface that display a static or dynamic visual representation of an object, concept, or content.
- [Indicators](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/indicators.md): The indicators (Message UI elements) allow you to display different types of messages.
- [Card](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/root-components/card.md): A card in FlowX.AI is a graphical component designed for the purpose of grouping and aligning various elements. It offers added functionality by incorporating an accordion feature, allowing users to expand and collapse content as needed.
- [Container](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/root-components/container.md): A container in FlowX.AI is a versatile building block that empowers you to group components and arrange them as needed, providing flexibility in UI design. It can also serve as the root component for your design.
- [Custom component](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/root-components/custom.md): Custom components are developed in the web application and referenced here by component identifier. This will dictate where the component is displayed in the component hierarchy and what actions are available for the component.
- [Root Components in UI Design](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/root-components/root-components.md): Root components serve as the foundation for structuring user interfaces, providing the framework for arranging and configuring different types of components.
- [Table](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/table.md): The Table component is a versatile UI element allowing structured data display with customizable columns, pagination, filtering, and styling options.
- [Typography](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-component-types/typography.md): Typography is an important aspect of design that greatly influences how users perceive and interact with your content. In this section, we'll explore how to effectively utilize two essential UI elements, "Text" and "Link."
- [UI Designer](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/ui-designer.md): The FlowX.AI UI Designer is a comprehensive, multi-platform interface creation tool that enables visual design of user experiences across web, iOS, and Android platforms without extensive coding.
- [Validators](https://docs.flowx.ai/5.1/docs/building-blocks/ui-designer/validators.md): Validators are an essential part of building robust and reliable applications. They ensure that the data entered by the user is accurate, complete, and consistent. FlowX.AI provides a set of pre-defined validation rules that can be used to validate various form inputs such as text fields, number fields, email fields, date fields, and more across web, mobile, and desktop applications.
- [Fonts](https://docs.flowx.ai/5.1/docs/flowx-designer/design-assets/font-files.md): Fonts management allows you to upload and manage multiple font files, which can be later utilized when configuring UI templates using the UI Designer.
- [Global Media Library](https://docs.flowx.ai/5.1/docs/flowx-designer/design-assets/global-media-library.md): System assets serve as a centralized hub for managing and organizing various types of media files outside an application, used on themes, including images, GIFs, and more.
- [Themes](https://docs.flowx.ai/5.1/docs/flowx-designer/design-assets/themes.md): Theme management feature enables you to easily change the appearance and styling of your application. You can personalize the look and feel of your application to your branding, preferences, or specific requirements.
- [Adding a new node](https://docs.flowx.ai/5.1/docs/flowx-designer/managing-a-project-flow/adding-a-new-node.md): Learn how to add and configure different node types to build robust process flows in FlowX.AI Designer.
- [Adding an action to a node](https://docs.flowx.ai/5.1/docs/flowx-designer/managing-a-project-flow/adding-an-action-to-a-node.md): Learn how to enhance your process flows by adding actions to nodes for business rules, data management, and integration with external systems.
- [Adding parallel flow branches](https://docs.flowx.ai/5.1/docs/flowx-designer/managing-a-project-flow/adding-more-flow-branches.md): Learn how to create concurrent process flows using parallel gateways to execute multiple activities simultaneously.
- [Creating a new process definition](https://docs.flowx.ai/5.1/docs/flowx-designer/managing-a-project-flow/creating-a-new-process-definition.md): Define your business processes in the FlowX.AI Designer by creating process definitions that model your workflows.
- [Creating a new project](https://docs.flowx.ai/5.1/docs/flowx-designer/managing-a-project-flow/creating-a-project.md): Learn how to create and configure a new project in FlowX.AI Designer