Boolean Field
Updated
The article outlines the steps to create a Boolean Field in Entity Studio.
Creating a Boolean Field in Entity Studio
Navigate to Launchpad. From the Sprinklr Service tab, click Entity Studio from the Persona Apps section.
The Entity Manager page appears with the list of entities.
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.
On the left navigation pane, click Fields and Relationships.
Click Create Field on the top right corner of the Record Manager. The Create Field Page appears.
Select Boolean 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 Boolean field type if you want to store a binary value, typically represented as true/false, yes/no, or on/off. This field type is useful for making decisions, toggling options, or setting conditions in workflows, forms, and reports. |
Name | Provide a suitable name. For example, you can provide a name such as “Valid Customer”. |
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 valid_customer. |
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, “Select whether this customer is valid or not.” |
Placeholder | This text will be shown in the field in its empty state. For example, “Select a valid customer.” |
Representation Type | This field determines how the Boolean field will be represented in the Record Form. There are 3 types of representation types:
If you choose the Representation type as Toggle, you will see the Toggle Label. It is the text that will be shown along with the toggle. If you toggle On, the text that you have already provided will be displayed. In the Picklist representation type, there will be 2 options, either True or False. You need to name the two options – either True or False, Yes or No, or Correct or Incorrect. You also you have the option to add icons next to True and False option. You need to enable Include icon toggle. The Checkbox Representation type is used to represent fields where users need to make binary selections (checked or unchecked) or multiple selections from a list of options. After selecting the Checkbox Representation type, toggle on the Checkbox label that will be shown along with the checkbox. For example, you provide the label as “I agree for the terms and conditions”. |
Default Value | A default value is a pre-filled value that appears in a field if the user does not input anything. This helps streamline data entry, maintain consistency, and reduce errors. The default value determines what value the Boolean field will hold initially. |
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 Boolean field. You can enable this option if not enabled to allow sorting records in Record Manager using the values in this field. |
Click on the Save icon in the bottom right corner once you input the field details.