Text Field

Updated 

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

Creating a 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 the Create Field page in the top right corner of the Record Manager. The Create Field Page appears.

  6. Select 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 type of field from the dropdown. If you choose the Text field, it captures alphanumeric characters. It allows you to add contextual details through a combination of letters and numbers.

    Name

    Provide a suitable name by which the text field should be visible in the Record Manager. For example, you can write “Customer Name”.

    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 customer_name.

    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 the Customer Name”.

    Placeholder

    Placeholders are temporary, instructional texts displayed inside a field to guide users on what to enter. They disappear when users start typing. For example, it can be “Enter Customer Name”.

    Maximum Character Limit

    Provide a maximum character limit beyond which the customer cannot provide input. For example, the limit is 10. Any input beyond 10 characters will not be allowed.

    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.

    Mandatory Field

    When enabled, new record creation will fail if no input is provided in the field. If the default value is set, then the error will not be triggered.

    Enable Sorting

    This is enabled by default. You can enable this option (if not already enabled) to allow sorting records in Record Manager using this field. For example, sort the Name field in ascending or descending order.

    Enable Searching

    Enable this option to allow search on records using the values in this field. 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 customer IDs by mistake, the system will trigger an error and will only accept 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. 

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