Kuika's Get Entities action is used to list all entity records defined in the system. This action enables the dynamic retrieval of entities belonging to the user or defined system-wide. The retrieved data can be used for operations such as listing, filtering, or processing related data.

This action is currently available in beta version and is still under development. It is recommended to test it carefully before using it in a production environment.

This action can be made flexible with optional parameters; only entities belonging to a specific category or along with their attribute and value information can be retrieved.

Technical Features

Entity Listing (EAV Panel): The Get Entities action can work with the following optional parameters:
- CategoryId (Guid - Optional): Used to filter entities belonging to a specific category. Can be retrieved from sources such as Symbol Picker, Fixed, Form Component, Action Result.
- IncludeAttributes (Boolean - Optional): If set to true, attribute information for each entity is also returned.
- IncludeValues (Boolean – Optional): When set to true, not only the attribute definitions but also the values corresponding to these attributes for the entity records are returned (e.g., ‘Birth Date’ attribute: ‘John – 12.03.1990’, ‘Maria – 05.06.1985’).
Data Source Compatibility: All parameters can be obtained from the following sources using the Symbol Picker interface:
- Fixed (fixed value)
- Form Component
- Action Result
- Screen Input
Web & Mobile Support: The Get Entities action works in both web and mobile applications.

Get Entities Action Application Steps

1. Action Definition

For example, when a screen is loaded or the user selects a filter:
- + ADD ACTION > OnLoad / OnClick > EAV > Entity > Get Entities action is added.

Parameters can be set as follows:

CategoryId: Symbol Picker > Select Box > [Category selection]
IncludeAttributes: Fixed > true (optional)
IncludeValues: Fixed > true (optional)

2. Using the Action Result

The action result can be used as data in Table, Select Box, etc.
Each entity object contains:
- id, name, description, categoryId
- (if IncludeAttributes=true) attributes[]
- (if IncludeValues=true) attributeValues[]

Usage Scenario: Listing Entities by Category

A user selects a category from the left menu and requests a list of entities belonging to that category:

The user selects a category from the Category Select Box.
The Get Entities action runs based on the selected category.
The retrieved entities are displayed in the Table element.

By setting the IncludeAttributes and IncludeValues parameters to true, entity details (e.g., ‘which fields does this entity contain, which values have been entered’) can also be displayed dynamically.

Get Entities Action Advanced Customisations

Conditional Loading: Actions can only be loaded under certain conditions.
Search/Filtering: Users can search using text (e.g., name contains ‘xyz’).

Technical Risks

No Entities in Category: The action result list returns empty; this should be handled in the UI.
Use of IncludeAttributes & IncludeValues: These parameters can increase data size and should be used with caution, especially on mobile devices.
Entity Data Compatibility: Ensure that the data structure is correctly matched in the components to be used.

The Get Entities action is one of the core tools in the Kuika platform that simplifies entity-based data management and listing operations. With its optional parameters, it adapts to both simple and comprehensive data retrieval needs.