Get Entities

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[]

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

1. The user selects a category from the Category Select Box.
2. The Get Entities action runs based on the selected category.
3. 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.

• 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.