User Manual

Get Entity Attributes

28/7/25
Get Entity Attributes

Kuika's Get Entity Attributes action is used to retrieve a list of all attributes belonging to an entity. This action allows you to dynamically retrieve all defined fields of a specific entity and create dynamic forms, filtering interfaces, or customisable data entries. For example, if an entity named ‘Employee’ is defined and this entity has attributes such as ‘First Name,’ ‘Last Name,’ ‘Department,’ and ‘Start Date,’ running the Get Entity Attributes action will retrieve all these attributes in a list. Thus, the system can dynamically generate an ‘Employee’ form for the user or present these fields as selectable options in the filtering panel.

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 one of the basic components for attribute management in the EAV model and is especially used when creating dynamic forms.

Technical Features

  • Attribute Listing: The Get Entity Attributes action works with the following parameter:
    • EntityId (Guid - Required): The unique ID of the entity whose attributes will be retrieved. It can be retrieved from fixed or dynamic sources via the Symbol Picker.
  • Data Source Compatibility: The EntityId parameter can be retrieved from:
    • Symbol Picker > Form Component
    • Select Box / Fixed / Action Result / Current
  • Web & Mobile Support: The Get Entity Attributes action works in both web and mobile applications.

Get Entity Attributes Action Application Steps

1. Entity Selection in the UI

  • A Select Box or table is prepared where the user can select an entity.
  • The id information of the selected entity is retrieved.

2. Action Definition

  • + ADD ACTION > OnClick > EAV > Entity Attributes > Get Entity Attributes
  • The EntityId parameter is determined via the Symbol Picker.

3. Using the Action Result

The attribute list can be used with Dynamic Form, Table, Select Box elements or the Set Value action.

  • Example output: [ id, name, dataType, isRequired, defaultValue , ... ]

Usage Scenario: Creating a Dynamic Form

In a human resources application, a user who wants to add new employee information wants to fill out the form belonging to the previously defined ‘Employee’ entity in the system.

  1. The user selects the ‘Employee’ entity.
  2. The system runs the Get Entity Attributes action and retrieves all attributes belonging to the ‘Employee’ entity.
  3. The attributes are returned in the following format:
    • First Name (Text)
    • Last Name (Text)
    • Department (SelectBox)
    • Start Date (Date)
  4. This attribute information is loaded into the Dynamic Form element.
  5. The system automatically creates the form with this information. The user does not need to define the fields manually.
  6. The user fills out the form and saves it.

Based on the attributes of the ‘Employee’ entity, a completely dynamic and reusable form structure is created in the system. This structure eliminates the need to design forms individually for each entity; when the structure changes, the form is automatically updated.

Get Entity Attributes Action Advanced Customisations

  • Conditional Loading: The action is not executed unless the entity is selected (controlled with If).
  • Attribute Filtering: If desired, only attributes of a specific data type or name can be displayed with Filter actions.
  • UI Update: The number and type of components can be dynamically created according to the incoming attributes.

Technical Risks

  • Missing EntityId: Attributes cannot be retrieved if the ID is empty or invalid.
  • Related Data Mismatch: The data types of attributes must be compatible with the Dynamic Form element.
  • Performance: Listing performance should be carefully tested if there are a large number of attributes.

The Get Entity Attributes action is one of the fundamental steps in setting up dynamic forms and data structures in Kuika's EAV architecture. It enables the creation of customised and flexible interfaces by systematically retrieving all fields of a specific entity.

Other Related Content

No items found.

Glossary

No items found.

Alt Başlıklar