> For the complete documentation index, see [llms.txt](https://docs.ezra360.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ezra360.com/configurations/components/entities.md).

# Entities

<mark style="color:blue;">**Add New Entity**</mark>\
Configuring **Entities** on Admin Module, you can click on <mark style="color:orange;">**#1**</mark> dropdown select to view list of modules and select **Customization**, then click on  <mark style="color:orange;">**#2**</mark> Which will give you the whole system's **Main Menu** then select <mark style="color:orange;">**#3**</mark> entities under Customizations or select <mark style="color:orange;">**#3**</mark> on customization sub-module list.

{% hint style="info" %}
A **schema name** refers to a unique identifier that is assigned to an entity within Ezra. It is used as a reference consistently across different parts of the platform, including customization, configuration, plugins and integration. The schema name is specified upon creation. It must be unique. This name should be in Pascal case. The schema name is used to create the class for the entity.
{% endhint %}

<figure><img src="/files/tyQgFleTCa3kPRY7ChDk" alt=""><figcaption></figcaption></figure>

Each Entity has its own **display name** , **schema name**, **Plural Name**, **Entity Type**, **Created By**, **Modified On** and **Modified By** displayed in a list form. To add a new entity on the platform, you will click the <mark style="color:orange;">**#4**</mark> button.&#x20;

<figure><img src="/files/Y1hqSVXhsdadaYUE6GXu" alt=""><figcaption><p><mark style="color:red;">Click image to view full screen</mark></p></figcaption></figure>

<mark style="color:blue;">**Filling the Entity form:**</mark>\
When the add button is clicked it will display the form below on <mark style="color:orange;">**#2**</mark> to add a new entity.\ <mark style="color:orange;">**#1**</mark> Shows properties of an entity.

* The **Listing** dropdown refers to a view or display of records within a specific entity. It's a way to present and access information in a structured format, making it easier for users to interact with and analyze data. The listing dropdown has *views, buttons and linked resources*. <mark style="color:blue;">For more information see</mark> [Listing](/configurations/components/entities/listing.md)
* The **Attributes** dropdown describes the elementary feature of an entity. The attributes also has  Display name, Schema name, and Data type. You can configure each attribute to *Visible*, *Required, Read-Only, Customizable,* and *Enable Audit* by checking the checkboxes. <mark style="color:blue;">For more information see</mark> [Attributes](/configurations/components/entities/attributes.md)
* The **Forms** dropdown has *views, buttons, and linked resources*. If you want any JavaScript to run on your form, you can link it in the Linked Resources under forms. <mark style="color:blue;">For more information regarding resources please see</mark> [Forms](/configurations/components/entities/forms.md)

To **save** the new Entity click <mark style="color:orange;">**#3**</mark> once (<mark style="color:red;">Do not click twice as it will duplicate the entity, wait for the page to auto refresh</mark>).&#x20;

{% hint style="danger" %}
Duplication detection functionality is pending.
{% endhint %}

Alternatively if you want to remove entity you can click the X button in red on <mark style="color:orange;">**#4,**</mark> this include to existing entities as well. &#x20;

<figure><img src="/files/og9hacDWjnFi67CxWWnn" alt=""><figcaption><p><mark style="color:red;">Click image to view full screen</mark></p></figcaption></figure>

### Entity Information

<mark style="color:orange;">**#2**</mark> **Filling Form Fields**

<table><thead><tr><th width="277">Field Record</th><th>Description</th></tr></thead><tbody><tr><td>Display name</td><td>it represents the display name of your field. The name that is displayed to the user on the interface. For example, "<mark style="color:blue;">Sales Order</mark>".</td></tr><tr><td>Schema Name</td><td>It must be unique. It is used to create the logical name. This name should be in Pascal case. The schema name is used to create the class for the entity. For example, "<mark style="color:blue;">Sales Order</mark>". </td></tr><tr><td>Name</td><td>it represents the name of your entity. The name that is displayed to the user on the interface. For example, "<mark style="color:blue;">Sales Order</mark>".</td></tr><tr><td>Plural name</td><td>refers to the name used to represent multiple instances of a data record entity. For example, "<mark style="color:blue;">Sales Orders</mark>"</td></tr><tr><td>Entity Type</td><td><strong>Data Record:</strong> refers to the structured data components that represent various business objects or concepts within the system. Each entity is associated with a set of fields that capture relevant information.<br><strong>Document Library:</strong> refers to a centralized repository where you can store and manage various types of documents, files, and attachments associated with records within the Ezra environment.<br></td></tr><tr><td>Object Type</td><td>Refers the record type, in this case will be an Entity.</td></tr><tr><td>Record Ownership</td><td>Defines the scope and nature of ownership for records within a specific entity.<br><strong>User</strong>: refers to individual users within the system that can be assigned as the owners of records that will have control over those records and can perform actions.<br><strong>Everyone</strong>: It signifies that records are owned by the system itself or are considered to be shared across the organization.</td></tr><tr><td>Is Core</td><td>This means that this is a system-related entity and should not be altered, as changes may impact core system functionality.</td></tr><tr><td>Social Timeline</td><td></td></tr><tr><td>Attachments</td><td>This allows you to associate relevant documents and resource files with specific records for easy access and reference.</td></tr><tr><td>Customizable</td><td>it's set to default, which is false. Generally refers to the ability to modify and adapt the entity/record to meet specific functional user requirements.</td></tr></tbody></table>

***

### Entity Settings

| Field Record               | Description                                                                                                                                                                                                                                                                                                                                                                                                |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable Audit               | allows you to track changes made to records and system settings. Audit functionality helps organizations maintain a record of activities, which can be crucial for compliance, security, and monitoring purposes.                                                                                                                                                                                          |
| Searchable                 | It refers that the field value is searchable by the user in a case of categorized search or relevance search.                                                                                                                                                                                                                                                                                              |
| Enable Duplicate Detection | is a feature that helps maintain data accuracy and integrity by identifying and preventing the creation of duplicate records. When enabled, it checks for potential duplicates based on configured rules and criteria when users attempt to create or import new records. If a potential duplicate is detected, users are alerted, and they can decide whether to proceed with the creation of the record. |
| Allow Import/Export        |                                                                                                                                                                                                                                                                                                                                                                                                            |
| Allow Business Process     | Business process refers to a series of activities or steps that are performed to achieve a specific business goal. It is a set of coordinated and structured tasks designed to streamline and optimize a particular business function. Business processes are often associated with entities like leads, opportunities, cases, and more, depending on the specific module.                                 |
| Is Contactable             |                                                                                                                                                                                                                                                                                                                                                                                                            |
| Required (\*)              | The asterisk means that a value must be entered in this field.                                                                                                                                                                                                                                                                                                                                             |

### Entity Events

| Record Field         | Description |
| -------------------- | ----------- |
| Publish Create Event | Boolean     |
| Publish Update Event | Boolean     |

### Document Library Settings

| Record Field    | Description |
| --------------- | ----------- |
| Display Filelds | Boolean     |

### Data Types

The fields define the individual data items that can be used to store data in an entity. Each field is represented by a data type. The following table contains information about the field data types.

<table><thead><tr><th width="173.33333333333331">Data Type</th><th width="547">Description</th></tr></thead><tbody><tr><td>Single Text</td><td>A field that allows entering a single line of text. It's commonly used for short pieces of information. This field can contain up to 4,000 text characters. You can set the maximum length to be less than this.</td></tr><tr><td>Multi-Line Text</td><td>This is a scrolling text box. The field that allows entering multiple lines of text. It's useful for capturing longer descriptions or comments. When you add this field to a form, you can specify the size of the field.</td></tr><tr><td>Whole Number</td><td>field that stores whole numbers (integers). It's suitable for counting items or quantities. You can set the minimum and maximum values too.</td></tr><tr><td>Decimal</td><td>A field that stores decimal numbers (floating-point numbers). It's used for storing fractional or precise numeric values.</td></tr><tr><td>Currency</td><td>A field that stores currency values with currency symbols. It's used for storing monetary amounts. </td></tr><tr><td>Lookup</td><td>A field that creates a relationship with another entity and displays a searchable list of records from that entity.</td></tr><tr><td>Generic Lookup</td><td>Similar to a lookup, but more flexible as it can reference multiple entity types. It's used for creating relationships with different types of records.</td></tr><tr><td>Partylist</td><td>A special type of field used to reference multiple party records (like Contacts, Accounts) involved in an activity. It's often used for scheduling and tracking interactions.</td></tr><tr><td>Select Option</td><td>A field that provides a list of predefined options for selection. Users choose from the provided values.</td></tr><tr><td>DateTime</td><td>A field that stores both date and time information. It's used to capture specific points in time.</td></tr><tr><td>Date</td><td>A field that stores only date information. It's used for capturing dates without time details.</td></tr><tr><td>Boolean</td><td>A field that stores true/false values. It's used for capturing binary choices. Example: Is Active - True, Accept Terms - False.</td></tr><tr><td>Rich Text</td><td>It allows formatting text with styles, links, and images. It's used for creating well-structured content.</td></tr><tr><td>Web Resource</td><td>A field that can display web content within the form. It's used for embedding external resources.</td></tr><tr><td>Hyperlink</td><td>A field that stores a URL and displays as a clickable link. It's used for linking to external resources.</td></tr></tbody></table>

***

### Adding New View

**Views** are added under Entity, Navigate to **Entities**>**Listing&#x20;**<mark style="color:orange;">**#1**</mark> >**System Views,** Click **Add New&#x20;**<mark style="color:orange;">**#2**</mark> to open the form for adding new view.  The table below shows descriptive details <mark style="color:orange;">**#3**</mark>  about the form fields.

<figure><img src="/files/vpZ5yPx8epn3iWenwVxD" alt=""><figcaption><p><mark style="color:red;">click Image to view full screen</mark></p></figcaption></figure>

<figure><img src="/files/AuxUQsHBDo5TVqIu6oAF" alt=""><figcaption></figcaption></figure>

| Field Record          | Description |
| --------------------- | ----------- |
| View Type             |             |
| Unique Name           |             |
| Entity Sub-Type       |             |
| Query                 |             |
| Override Columns Text |             |
| Page Limit            |             |
| Sort Index            |             |
| Is Default            |             |

***

### Adding New Form

When adding a new form you navigate to the forms <mark style="color:orange;">**#1**</mark>, click the <mark style="color:blue;">Add New</mark> <mark style="color:orange;">**#2**</mark> to add a new form. Then  <mark style="color:orange;">**#3**</mark> shows the Form details form field will be displayed. When clicking on the Form Type drop down, you see available form types

<figure><img src="/files/cDzojnIESujgxjWsPHye" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/rO2eKrgdecHnUSSg8TPS" alt=""><figcaption><p><mark style="color:red;">Click Image to view full screen</mark></p></figcaption></figure>

The Table below shows different types of forms, You select one of the following forms. <mark style="color:blue;">For more information regarding forms see,</mark> [Forms](/overview/components-overview/forms.md)

* Main Form
* Mobile Form
* Quick Create Form
* Quick Peak Form
* Portal Form


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ezra360.com/configurations/components/entities.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.