Edit Property

Editing a property involves updating its characteristics, such as its description, default value, and other attributes while adhering to certain constraints.

Steps to Edit a Property:

  1. Open the Edit Property Drawer

    • Navigate to the Entity page by selecting the entity from the Secondary Left Panel.

    • Ensure the Properties tab is open (this tab opens by default).

    • Click on the Property you wish to edit.

  2. Edit Property Details

    • The Edit Property Drawer allows you to update various details of the property:

      • Name

        • Not Editable: The name cannot be changed once the property is created.

      • Description (optional):

        • Provide or update a description between 0 and 400 characters long, detailing the role and purpose of the property.

        • Validation rules:

          1. The description length should be between 0 and 400 characters.

      • Type

        • Not Editable: The Property type cannot be changed once set.

      • Default Value

        • Update the default value associated with the property if needed.

        • Validation rules:

          1. The default value should comply with the property type constraints.

      • Nullable

        • Adjust whether the property can accept null values. This field is editable only if the property is not used elsewhere in the system.

      • Searchable

        • Determine or update if the property can be used in search queries. This field is editable only if the property is not used elsewhere in the system.

      • Additional Type-Specific Fields

        • Update fields specific to the property type (e.g., Pattern, Min Length for Text properties, Min Value for Number properties, etc.) only if the property is not used elsewhere in the system.

  3. Submit the Changes

    • Click the "Update" button to save the updated property details.

    • The changes will be reflected in the list of properties under the Properties tab.

  • Name & Type: These fields are not editable once created.

  • Default Value & Description: Always editable.

  • Other Fields: Editable only if the property is not used elsewhere in the system.

Last updated