Get Entity

Get Entity

Kuika's Get Entity action is used to retrieve a single entity (entity) defined in the system along with its details. This action allows you to retrieve basic information (name, description, category) about a specific entity and, optionally, attribute and attribute value information.

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 is frequently used on an entity's details page, in edit forms, or when processing related data.

Technical Specifications

  • Entity Retrieval (EAV Panel): The Get Entity action works with the following parameters:
    • Id (Guid - Required): The unique ID of the entity to be retrieved in the system. It can be defined as fixed or dynamic using the Symbol Picker.
    • IncludeAttributes (Boolean - Optional): When set to true, the list of attributes belonging to the entity is also returned.
    • IncludeValues (Boolean – Optional): When set to true, not only the attribute definitions but also the values corresponding to these attributes in the entity records are retrieved (e.g., ‘Birth Date’ attribute: ‘John – 12.03.1990’, ‘Maria – 05.06.1985’).
  • Data Source Compatibility:
    • Id: Fixed, Form Component, Screen Input, Action Result, etc.
    • IncludeAttributes / IncludeValues: Fixed (true / false) or can be determined dynamically with Screen Input.
  • Web & Mobile Support: The Get Entity action works in both web and mobile applications.
Get Entity Action Application Steps

1. Entity Selection on the UI

  • The entity whose details the user wants to view is selected from a table or list.
  • The Id information of the selected entity is retrieved.

2. Action Definition

  • + ADD ACTION > OnClick / OnLoad > EAV > Entity > Get Entity
  • Parameters are configured:
  • Id: Symbol Picker > Selected Item / Form Component / Fixed
  • IncludeAttributes: Fixed > true (optional)
  • IncludeValues: Fixed > true (optional)

3. Using the Action Result

  • The result can be displayed on the screen with a Set Value, Label, Dynamic Form, or custom element.
  • Attributes can be edited by loading them into the Dynamic Form element.
Usage Scenario: Viewing and Editing Entity Details
  1. The user clicks on a row in the entity list.
  2. The Get Entity action runs.
  3. The name, description, and all attribute and value information of the selected entity are retrieved.
  4. This information is displayed in the form components.
  5. The user can make the necessary edits.

Get Entity Action Advanced Customisations
  • Conditional Retrieval: Can be executed based on permission status or selection control.
  • Automatic Data Distribution to Forms: Retrieved entity information can be distributed to different elements using Set Value actions.
  • Caching: The action result can be cached using Set Variable to reduce repeated queries.

Technical Risks

  • Invalid or Missing ID: The action fails if the ID parameter is empty or incorrect.
  • IncludeAttributes / IncludeValues Performance: Data size may increase, especially if there are many attributes or values; use with caution on mobile devices.
  • Attribute Incompatibility: Ensure that the retrieved attributes are compatible with the expected data type or format.

The Get Entity action is a powerful tool in Kuika for controlling entity-focused data flows, pre-filling forms, and preparing entity details for processing. Thanks to its flexible parameter structure, it can be used for both simple detail retrieval and comprehensive data preparation tasks.

Other Related Content

No items found.

Glossary

No items found.

Alt Başlıklar