Add Property
Adding a new Property involves defining its characteristics, such as its name, description, type, and other attributes.
Steps to Add a Property
Navigate to the Entity Page
Select the Entity from the Secondary Left Panel.
The Entity page will display on the right side of the panel.
Initiate the Property Creation Process
On the Entity page, ensure the Properties tab is open (this tab opens by default).
Click the New button in the Tabs & Actions Bar.
Enter Property Details
A New Property Drawer will open to enter the property details:
Name
This should be a unique identifier, between 2 to 100 characters long. Avoid using spaces, special characters, or starting with a numeric character.
Validation rules:
The name must be unique.
The name length should be between 2 and 100 characters.
The name cannot be empty.
The name cannot include special characters.
The name cannot include spaces.
The name cannot start with a numeric character.
Description (optional)
Descriptions should be between 0 and 400 characters long, detailing the property's role and purpose.
Validation rules:
The description length should be between 0 and 400 characters.
Type
Select the data type of the property (e.g., Text, Whole Number, Date/Time, etc.).
Nullable
Indicate if the property can accept null values.
Searchable
Determine if the property can be used in search queries.
Continue Filling the Rest of the Type-Specific Field
Define List Attributes (if applicable)
If the property is a list, specify the following attributes:
Is List
Indicate if the property can hold multiple values.
Allow Duplicates
When True, this allows repeated values within the same list property.
Min Items Allowed
Define the minimum number of items required in the list property. This ensures that the list cannot contain fewer items than specified.
Validation rules:
The minimum number of items should be a whole number greater than or equal to 0.
Max Items Allowed
Define the maximum number of items allowed in the list property. This prevents the list from exceeding the specified number of items.
Validation rules:
The maximum number of items should be greater than or equal to the minimum number of items allowed.
Submit the Property
Click the Submit button to add the Property to the Entity.
The new property will appear in the list of properties under the Properties tab.
Last updated