Get Attributes

Get Attributes

Kuika's Get Attributes action is used to retrieve a list of multiple attributes previously defined in the system within the EAV (Entity-Attribute-Value) data model. This action is ideal for needs such as listing dynamic fields, selecting attributes, or performing grouping operations.

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 Specifications

  • Get Attribute List (EAV Panel): The Get Attributes action retrieves a list of all attributes in the system. The action can be run with optional filters:
    • CategoryId (Guid - Optional): Retrieves only attributes belonging to a specific category. If no category is specified, all attributes in the system are returned.
    • Returned Information: The action returns the following information for each attribute:
      • Id
      • Name
      • DataType
      • Description
      • CategoryId
      • IsRequired
      • DefaultValue
  • Data Source Compatibility: The optional CategoryId parameter can be defined dynamically or statically from the following sources:
    • Symbol Picker > Fixed > Guid
    • Symbol Picker > Component > Select Box
    • Symbol Picker > Screen Input
    • Symbol Picker > Action Result
  • Web & Mobile Support: The Get Attributes action works in both web and mobile application scenarios.
Get Attributes Action Application Steps

1. Define the Action in UI Design

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

2. Configure Action Parameters (Optional)

  • CategoryId:
    • Symbol Picker > Fixed > Guid
    • or Component > Select Box (the field where the user selects the category)
    • or Action Result (ID obtained from another action result)

If no category is specified, all attributes are returned; if a category is specified, only attributes belonging to that group are listed.

3. Using the Results

The attribute list returned by the Get Attributes action can be used in the following areas:

  • Connecting to a Select Box element to allow the user to make a selection
  • Listing in a Table element
  • Using as an auxiliary data source for conditional visibility, data filtering, etc.
Usage Scenario: Listing Attributes by Category

In a content management panel, the user first selects a category. The system then lists only the attributes belonging to that category.

  • CategoryId: The category selected by the user from the dropdown
  • The Get Attributes action returns a filtered list based on this ID.
  • The list is displayed in a table or selection box.
Get Attributes Action Advanced Customisations
  • Dynamic Listing by Category: The attribute list can be updated as the user selects different categories.
  • Filtered Search: Additional filtering mechanisms (e.g., only required fields) can be applied using custom logic.
  • Using List Results with Other Actions: The details of an attribute selected from the list can be retrieved and passed to actions such as Get Attribute or Delete Attribute.

Technical Risks

  • Invalid Category ID: If a category ID not defined in the system is entered, an empty list may be returned.
  • Beta Version Risk: The feature is still in beta; unexpected results may occur in some scenarios.
  • List Size: Performance should be monitored for large data sets. Pagination can be applied if necessary.

The Get Attributes action provides dynamic and customisable listing capabilities for attribute management on the Kuika platform. It is particularly suitable for managing user-defined fields by category, quick selection screens, or form configurations. Despite being in beta, it provides a flexible and powerful solution.

Other Related Content

No items found.

Glossary

No items found.

Alt Başlıklar