User Manual

Get Attribute

29/7/25
Get Attribute

Kuika's Get Attribute action is used to query an attribute previously defined in the system within the EAV (Entity-Attribute-Value) data model and access its detailed information. This action is ideal for managing dynamic fields, controlling user-defined attributes, or using attribute information in other processes.

In an application running on a customer management system (CRM), administrators may want to dynamically control fields that have been custom-defined for customers. For example, a user has previously created an attribute named ‘Hobbies’ and added it to customer profiles. An administrator who wants to view information such as the data type, mandatory status, or default value of this attribute and use it in other operations (e.g., form creation or copying) can access the details of this field using the Get Attribute action.

Thanks to this action, even if the application's data structure is open to user intervention, developers or administrators can always check the content of existing definitions to maintain the accuracy and consistency of the system.

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.

Technical Features

  • Getting Attribute Information: The Get Attribute action works with a required parameter to obtain all system information about an attribute: Attribute ID. This ID allows the system to query the relevant attribute and access its definition information (name, data type, mandatory status, default value, etc.).
    • Id (Guid - Required): This is the unique ID of the attribute whose information will be retrieved (attribute ID). This parameter must be defined correctly and must belong to the relevant attribute.
    • Returned Information: The following attribute information can be accessed as a result of this action:
      • Name
      • DataType
      • Description
      • CategoryId
      • IsRequired
      • DefaultValue
  • Data Source Compatibility: The Id parameter can be defined from the following sources:
    • Symbol Picker > Fixed > Guid
    • Symbol Picker > Component > Text Input
    • Symbol Picker > Action Result
  • Web & Mobile Support: The Get Attribute action works in both web and mobile applications.

Get Attribute Action Application Steps

1. Defining the Action in UI Design

  • Open your project in the Kuika platform.
  • Go to the UI Design module.
  • Open the screen where you want to view the attribute information.
  • For example, create a button named ‘Get Attribute Information’.
  • To make it work when clicked: + ADD ACTION > OnClick > EAV > Attribute > Select the Get Attribute action.

2. Configure the Action Parameter

  • Id: Symbol Picker > Fixed > Guid or Symbol Picker > Component > Text Input (selected attribute) or Symbol Picker > Action Result > AttributeList can be selected.

3. Using the Results

The information returned by the Get Attribute action can be displayed in other components (e.g. Label, Text, Info Box) or used in other actions (e.g. condition, validation, update).

Usage Scenario: Viewing Candidate Information Details

In an HR (Human Resources) application, managers can create user-defined fields to diversify the information collected from candidates during the recruitment process. For example, a manager has defined a special attribute called ‘GitHub Profile’ for technical positions.

The manager sees all defined attributes in a list in the admin panel. They want to check how the ‘GitHub Profile’ field is defined in the system, what data type it is, and whether it is mandatory.

Steps

  1. The manager selects the ‘GitHub Profile’ row in the attribute list.
    • The Attribute ID for the selected row is sent to the Get Attribute action in the background.
    • Id: 789e1234-a67b-89c1-d234-987654321000
  2. The action is executed, and the following information is returned from the system:
    • Name: github_profili
    • DataType: String
    • IsRequired: false
    • Description: Link to the candidate's GitHub account
  3. This information is displayed to the user in a detail panel or modal window.

This scenario allows administrators to review the definition of each field in the system in a live environment, plan necessary updates, and maintain the accuracy of the data structure.

Get Attribute Action Advanced Customisations

  • Conditional Display: Attribute information can be displayed based on specific user roles.
  • Form Filling: Information returned from the Get Attribute action can be automatically populated into Dynamic Form fields (e.g., in an update scenario).
  • Error Management: If an invalid ID is entered, the system can display an informational message to the user.

Technical Risks

  • Invalid ID: If the ID parameter is entered incorrectly, the system cannot retrieve the attribute information. In this case, informative messages such as ‘Attribute not found’ should be displayed to the user.
  • Beta Version Risk: The action is still in beta; unstable behaviour may occur in some scenarios.
  • Empty Result: Empty results may be returned for deleted or inaccessible attributes.

The Get Attribute action is an effective tool for obtaining detailed information about attributes created in accordance with the EAV structure on the Kuika platform. It can be used to make attribute management in your applications dynamic and user-focused.

It offers a structure that can be managed by end users in live environments. The EAV model allows new fields to be defined and existing structures to be flexibly adjusted without developer intervention, even while the system is in production. This enables users to define custom data fields specific to their business processes through the interface, enrich their forms, and customise their structures without system downtime.

Other Related Content

No items found.

Glossary

No items found.

Alt Başlıklar