Skip to main content
Starting with 3.4.7 platform version, for User Tasks containing UI Elements, when the page is rendered, the Backend (BE) should, by default, send to the Frontend (FE) all available data as process variables with matching keys.If the User Task also includes a custom component, the BE should send, in addition to default keys, objects listed in the Custom UI payload field of the root element.
To add a custom component in the template config tree, we need to know its unique identifier and the data it should receive from the process model.
Custom component in the component tree with its Type, Identifier and Input key settings
The properties that can be configured are as follows:
  • Type (Web platform only) - Bundled uses a Custom Component built in the Designer, whose inputs and outputs you map instead of the properties below. Self-Managed uses a component registered in your container app and configured with the properties below. On Android and iOS, the component is always Self-Managed.
  • Identifier - This enables the custom component to be displayed within the component hierarchy and determines the actions available for the component.
  • Input key - This is used to specify the pathway to the process data that the component will utilize to receive its information. The field takes a single key.
  • Event handlers - actions defined here will be made available to the custom component
Custom component settings with Type Self-Managed, Identifier, Input key and the saveData event handler

Prerequisites (before creation)

  • Angular Knowledge: You should have a good understanding of Angular, as custom components for the Angular SDK are created and imported using Angular. React container apps register custom components through the components prop instead; see Custom components in the React SDK.
  • Angular CLI: Ensure that you have Angular CLI installed.
  • Development Environment: Set up a development environment for Angular development, including Node.js and npm (Node Package Manager).
  • Component Identifier: You need a unique identifier for your custom component. This identifier is used for referencing the component within the application.

Creating a custom component (Web)

To create a Custom Component in Angular, follow these steps:
  1. Create a new Angular component using the Angular CLI or manually.
  2. Implement the necessary HTML structure, TypeScript logic, and SCSS styling to define the appearance and behavior of your custom component.

Importing the component

After creating the Custom Component, you need to import it into your application. In your app.module.ts file (located at src → app → app.module.ts), add the following import statement:

Declaration in AppModule

Standalone components, the Angular default since Angular 19, need no declaration: registering them in FlxProcessModule.withConfig is enough, and listing a standalone component in declarations makes Angular throw an error. Only if your component sets standalone: false, declare it in the same app.module.ts file, within the declarations array in the @NgModule decorator:

Declaration in FlxProcessModule

To make your Custom Component available for use in processes created in FlowX.AI Designer, you need to declare it in FlxProcessModule. In your process.module.ts file (located at src > app > modules > process > process.module.ts), add the following import statement:
Then, declare your Custom Component in the FlxProcessModule.withConfig function. The key must match the component’s Identifier in the Designer. For the full component contract, see Custom components in the Angular SDK.

Using the custom component

Once your Custom Component is declared, you can use it for configuration within your application.
UI Components palette with Custom Component under Complex Components, and a custom component added to the screen

Data input and actions

The Custom Component accepts input data from processes and can also include actions extracted from a process. These inputs and actions allow you to configure and interact with the component dynamically.
Custom component with an Input key and the Add new event handler dialog set to a Node action

Extracting data from processes

There are multiple ways to extract data from processes to use within your Custom Component. You can utilize the data provided by the process or map actions from the BPMN process to Angular actions within your component.
Make sure that the Angular actions that you declare match the names of the process actions.

Styling with CSS

To apply CSS classes to UI elements within your Custom Component, you first need to identify the UI element identifiers within your component’s HTML structure. Once identified, you can apply defined CSS classes to style these elements as desired. Example:

Custom component example

Below you can see an example of a basic custom loader component built with Angular:

Additional considerations

  • Naming Conventions: Be consistent with naming conventions for components, identifiers, and actions. Ensure that Angular actions match the names of process actions as mentioned in the documentation.
  • Component Hierarchy: Understand how the component fits into the overall component hierarchy of your application. This will help determine where the component is displayed and what actions are available for it.
  • Documentation and Testing: Document your custom component thoroughly for future reference. Additionally, testing is crucial to ensure that the component behaves as expected in various scenarios.
  • Security: If your custom component interacts with sensitive data or performs critical actions, consider security measures to protect the application from potential vulnerabilities.
  • Integration with FlowX.AI Designer: Ensure that your custom component integrates with FlowX.AI Designer, as it is part of the application’s process modeling capabilities.

Creating a custom component (iOS)

Enhance your skills with our academy course! Learn how to develop and integrate a custom iOS component with FlowX.AI:

iOS Custom Component

Last modified on November 12, 2026