Update Entity

Update Entity

Kuika's Update Entity action is used to update the information of an existing entity (asset) in the system. With this action, basic information such as the entity's name, description, and category can be dynamically changed. It is especially used in management panels or applications with user-specific data modelling.

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 suitable for operations such as renaming an entity, adding a description, or changing a category. The updated entity information is saved without affecting the attribute structure in the system.

Technical Features

  • Entity Update (EAV Panel): The Update Entity action works with the following parameters:
    • Id (Guid - Required): The unique ID of the entity to be updated in the system. Can be retrieved from a form, list, or specified directly.
    • Name (String - Required): The new name of the entity. Cannot be left blank.
    • Description (String - Optional): An explanatory field for the entity. Provides information to users or developers.
    • CategoryId (Guid - Optional): The ID of the category to which the entity belongs. Can be used to change the category structure.
  • Data Source Compatibility Parameters can be obtained from the following sources via the Symbol Picker:
    • Id, Name: Form Component, Current, Action Result, Fixed
    • Description, CategoryId: Form Component, Fixed, Action Result, etc.
  • Web & Mobile Support: The Update Entity action works on both web and mobile applications.
Update Entity Action Application Steps

1. Create an Edit Form

  • A form is displayed to the user where they can update the entity information:
    • Entity Name (Text Input) → Name
    • Description (Text Area) → Description (optional)
    • Category Selection (Select Box) → CategoryId (optional)

2. Action Definition

  • The following action is added to the ‘Save’ button:
    • + ADD ACTION > OnClick > EAV > Entity > Update Entity
  • Parameters are matched with the Symbol Picker:
  • Id: Form Component or Selected Row
  • Name: Text Input
  • Description: Optional field
  • CategoryId: Optional field (Select Box)

3. Post-Action Usage

  • When the update is complete:
    • A message is displayed to the user (e.g. Show Toast)
    • The list or detail screen is refreshed (Refresh Data)
    • The user can be redirected to another page (Navigate)
Usage Scenario: Updating Entity Information

In an admin panel, a user wants to change the name and description of an entity in the system.

  1. Entity information is displayed in the form.
  2. The user makes changes.
  3. When the ‘Update’ button is clicked, the Update Entity action is executed.
  4. The updated information is saved and a success message is displayed to the user.
Update Entity Action Advanced Customisations

1. Conditional Update: You can check the changes made by the user and update only the fields that have actually changed. For example:

  • If the new Name value is different from the existing value, the update process is performed.
  • This avoids unnecessary API calls.

2. Automatic Category Assignment: When an entity is created or updated, the CategoryId can be dynamically determined based on the user's screen or role. For example:

  • Certain users can only update specific category IDs.

3. Form Validation: The accuracy of form fields can be checked before the update process. In particular, checks can be made to see if the Name field is empty or contains special characters.

4. Post-Update Chain Actions: After the entity update is complete:

  • Refresh the relevant list
  • Set the updated data to another form field (Set Value)
  • Perform chain operations such as re-saving the updated information to the database or logging it.

5. Feedback and Follow-up: After the update process:

  • A custom information message can be displayed to the user (Show Toast)
  • In case of incorrect updates, a custom error message or warning can be displayed
  • Processes can be logged for auditability

6. Authorisation-Based Update Capability: Depending on the user's role, only certain fields can be updated. For example:

  • Administrators can change both the name and category
  • End users can only change the description

Technical Risks

  • Missing Required Fields: If the Id and Name parameters are empty or invalid, the action will fail.
  • Category ID Mismatch: If an invalid CategoryId is provided, the entity may be grouped incorrectly.
  • Data Conflict: If there is another entity with the same name, the user should be notified.

The Update Entity action is one of the basic tools that makes asset management flexible and dynamic on the Kuika platform. It provides a powerful infrastructure for keeping entities up to date, organising them by category, and creating user-friendly forms.

Other Related Content

No items found.

Glossary

No items found.

Alt Başlıklar