Rich Text Field

Updated 

The article outlines the steps to create a Rich Text Field in Entity Studio.

Creating a Rich Text Field in Entity Studio

  1. Navigate to Launchpad. From the Sprinklr Service tab, click Entity Studio from the Persona Apps section.

  2. The Entity Manager page appears with the list of entities.

  3. Search for the desired entity in the search bar. Click on the 3 dots and then click the View button next to the entity name.

  4. On the left navigation pane, click Fields and Relationships.

  5. Click Create Field on the top right corner of the Record Manager. The Create Field Page appears.

  6. Select Rich Text from the Field Type drop-down.

The following are the fields that needs to be filled in the Create Field page.

Fields

Description

Field Type

Choose the Rich Text Field type if you want an enhanced version of 'Text', which includes formatting options like bold, italic, underline, strike-through, and more.

Name

Provide a suitable name by which the rich text field should be visible. For example, you can write “Detailed Description”.

API Reference ID

API Reference ID is a unique identifier used to reference fields and objects when interacting with the Sprinklr platform via APIs. For example, you can provide API reference ID as detailed_description.

Help Text

Help text appears as a tooltip or is shown below the field, depending on the configuration. It offers quick hints without cluttering the UI. For example, you can write, “Enter full description with formatting as needed”.

Placeholder

Placeholders are temporary, instructional texts displayed inside a field to guide users on what to enter. They disappear when users start typing in the field, offering a more intuitive data entry experience. For example, it can be “Enter detailed description here…”.

Default Value

You can add rich text elements to your text such as different size Headings, font styles (bold, italic, underline), Highlight or strike-through, Inline code blocks, Hyperlinks, Bulleted and numbered lists, Text alignment, Block quotes, Indentation controls, Insert tables, Undo or clear formatting.

Mandatory Field

When mandatory field is enabled, new record creation will fail if there is no input in the current field. In cases where the default value is not set and is empty, and if the mandatory field is enabled, then the error will be thrown. If the default value is set, then the error will not be triggered.

Enable Sorting

This field is already enabled by default while creating a Rich Text field. You can enable this option if not enabled to allow sorting records in Record Manager using the values in this field. For example, you can sort the Description field in ascending or descending order.

Enable Searching

Enable this option to allow search on records using the values of the field selected. If not enabled, entity records are by default searchable using the ‘name’ field.

Do not allow Duplicate Values

Enable this option to disallow any duplicate values in the Record Form. For example, if you add duplicate descriptions across multiple records by mistake, then the system will trigger an error and will not allow duplicate entries. The system will accept only unique entries.

Enable Cloning

Allows the field value to be copied when a record is cloned. This is useful in scenarios where new records are often created based on existing ones, such as tickets, orders, or configurations. 

Click on the Save icon in the bottom right corner once you input the field details.