> 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-config-overview.md).

# Components Config Overview

### Overview&#x20;

A **Component** is like a basic building block that you can attach to an application, or web. Once you attach a component, you can give it specific details to match your requirements. These details might be about what users need, its features, or rules for using it. A component can even have smaller parts within it. You can use a component multiple times in your space.

The following Components are all configured under **Settings Entity**. The settings entity will redirect you to Admin module where configuration is done.

{% hint style="warning" %}
Please Note:

Your access to this module within the Ezra360 platform depends on your access settings. For more information, see [Security Roles and Privileges](/security-and-roles/security-roles-and-privileges.md) and [User Roles](/security-and-roles/user-roles.md)
{% endhint %}

To navigate it, go to **Modules** > **Customization**\ <mark style="color:orange;">**#1**</mark> navigate to list of **Modules**, and click <mark style="color:orange;">**#2**</mark> **Customization** Entity, or you can instead Click on <mark style="color:orange;">**#1**</mark>**&#x20;Main Menu** then you will see <mark style="color:orange;">**#2**</mark> **Customization** Card which will display all the Customization sub-modules .

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

The **Customization** direct link will take you to an Admin Module, that has a layout like this:

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

From the Admin Module Screen we will navigate to see the listed Entities. <mark style="color:blue;">See the</mark> [Entities](/configurations/components/entities.md)<mark style="color:blue;">configuration.</mark>

***

## Data Types

The following table of data types acts as guide when configuring Ezra for your form fields.

<table><thead><tr><th width="173.33333333333331">Data Type</th><th width="547">Description</th></tr></thead><tbody><tr><td><strong>Single Text</strong></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><strong>Multi-Line Text</strong></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><strong>Whole Number</strong></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><strong>Decimal</strong></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><strong>Currency</strong></td><td>A field that stores currency values with currency symbols. It's used for storing monetary amounts. </td></tr><tr><td><strong>Lookup</strong></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><strong>Generic Lookup</strong></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><strong>Partylist</strong></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><strong>Select Option</strong></td><td>A field that provides a list of predefined options for selection. Users choose from the provided values.</td></tr><tr><td><strong>DateTime</strong></td><td>A field that stores both date and time information. It's used to capture specific points in time.</td></tr><tr><td><strong>Date</strong></td><td>A field that stores only date information. It's used for capturing dates without time details.</td></tr><tr><td><strong>Boolean</strong></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><strong>Rich Text</strong></td><td>It allows formatting text with styles, links, and images. It's used for creating well-structured content.</td></tr><tr><td><strong>Web Resource</strong></td><td>A field that can display web content within the form. It's used for embedding external resources.</td></tr><tr><td><strong>Hyperlink</strong></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>

<br>

## Common Form Records Fields

Below is the common records fields, when configuring Ezra, you will most likely to come across this fields, here is an overview of each records. Refer to this Table if you don't understand some text fields.

{% hint style="info" %}
Please note that Record fields may differ according to the component and the Business Process.
{% endhint %}

<table><thead><tr><th width="232">Field Record</th><th>Description</th></tr></thead><tbody><tr><td><strong>Display Name</strong></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><strong>Schema Name</strong></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;">SalesOrder</mark>". </td></tr><tr><td><strong>Plural name</strong></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><strong>Entity Type</strong></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><strong>Owner Type</strong></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><em><strong>Boolean Data Types</strong></em></td><td></td></tr><tr><td>☑ <strong>Business Process</strong></td><td>it indicates that whether the associated entity or record type uses a business process flow to streamline and standardize workflows.</td></tr><tr><td>☑ <strong>Social Timeline</strong> </td><td>Indicates whether the entity or record supports the social timeline feature. The social timeline allows users to see social activities and interactions related to a record, such as posts and mentions from social media platforms.</td></tr><tr><td>☑ <strong>Enable Audit</strong> </td><td>Specifies whether auditing is enabled for the entity or record. Auditing tracks changes to records and provides a history of data modifications.</td></tr><tr><td>☑ <strong>Duplicate Detection</strong> </td><td>Determines whether duplicate detection rules are applied to the entity or record. Duplicate detection helps prevent the creation of duplicate records in the system.</td></tr><tr><td>☑ <strong>Attachments</strong> </td><td>Indicates whether the entity or record can have file attachments associated with it. If set to true, users can attach documents and files to the record.</td></tr><tr><td>☑ <strong>Customizable</strong> </td><td>It is set to default on Ezra. Specifies whether the entity or its forms, views, and fields can be customized. If set to true, users with appropriate permissions can customize the entity's structure and behavior.</td></tr><tr><td>☑ <strong>Searchable</strong> </td><td>It refers that the field value is searchable by the user in a case of categorized search or relevance search.</td></tr><tr><td>☑ <strong>Publish Create Event</strong> </td><td>Determines whether the entity is searchable. If set to true, records of this entity can be included in search results.</td></tr><tr><td>☑ <strong>Visible</strong> </td><td>Specifies whether the entity or field is visible to users. If set to false, the entity or field may be hidden from users, but it can still be used in the system.</td></tr><tr><td>☑ <strong>Read-Only</strong></td><td>Specifies whether the entity or field is read-only. If set to true, users can view the data but cannot edit it.</td></tr><tr><td>☑ <strong>Required</strong></td><td>Indicates whether a field is required for the creation or update of a record. If set to true, users must provide a value for this field when creating or modifying a record.</td></tr><tr><td>☑ <strong>Publish Create Event</strong> </td><td>Indicates whether an update event is published when a record of this entity type is created.  It can be used to trigger external processes or integrations when records are created.</td></tr><tr><td>☑ <strong>Publish Update Event</strong></td><td>Indicates whether an update event is published when a record of this entity type is updated. It can be used to trigger external processes or integrations when records are updated.</td></tr></tbody></table>


---

# 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-config-overview.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.
