Fields as building blocks for data objects
By learning about the different types of fields that are available in Pega Platform data objects, you ensure that you can effectively capture and present information in your cases.
Fields are important building blocks that define the structure of data objects in your application. Each field corresponds to a data element that stores a value in a database. With fields, you can capture different types of information in each record. For example, in a Patient data object, you capture the first and last name of the patient with Text (single line) fields, their email address with the Email field, and their phone number with the Phone field.
For a sample tutorial on data object configuration that uses different field types, see Configuring a basic data object.
The following table presents fields that are available in data object configuration:
Field types
Field type | Description |
Text (single line) | Captures alphanumeric values from a single line of text. You can define a maximum length for the text input field, which determines the number of characters that are exposed in the database entry for that field's value. For example, you can use this field to capture the patient's name. |
Text (paragraph) | Captures alphanumeric values from a box with multiple lines of
text. You can define a maximum length for the text input field,
which determines the number of characters that are exposed in
the database entry for that field's value. With additional field
configuration, you can decide whether this field captures text
in markup, or just plain text. For example, you can use this field to capture the description of symptoms that the patient provides. |
Boolean | Captures true or false values. By default, the UI control for that field is a checkbox. For example, you can use this field to capture the patient's agreement for storing their personal information. |
Currency | Captures positive and negative decimal numeric values. The UI displays the field with a currency code that reflects the default currency type for the application user. For example, you can use this field to capture a cost of a medical procedure. |
Date & time | Captures values for date and time, which Pega normalizes to a GMT format. The UI displays the field value in a localized format for the user. For example, you can use this field to capture the date and time of the patient's appointment. |
Date only | Captures values for a date, which Pega normalizes to a GMT format. The UI displays the field value in a localized format for the user, taking into consideration the standards for digit grouping and decimal separators of the localized format. For example, you can use this field to capture the patient's date of birth. |
Decimal | Captures positive and negative decimal numeric values. For example, you can use this field to capture the patient's weight. |
Captures alphanumeric values that must pass a regular expression validation for a correct email address format; the input must include the at sign (@) followed by a domain. The UI displays the field value as a link that launches the user's default email application. For example, you can use this field to capture the patient's email address. | |
Integer | Captures positive and negative whole numeric values, including zero (0). For example, you can use this field to capture the patient's age. |
Percentage | Captures positive and negative decimal numeric values that the application displays as a percentage. For example, you can use this field to display the body fat percentage after the patient's examination. A field value of 0.25 equals 25%. |
Phone | Captures numeric values. The field validates the user's input to conform to the region-specific phone number format. The UI displays the field value as a link that initiates a phone call on a mobile device. For example, you can use this field to capture a patient's contact number. |
Picklist | Captures an alphanumeric value that is a single choice from a list of valid options. You can define various sources for picklists, such as data pages or other field values. For example, you can use this field to capture a patient's marital status. |
Time only | Captures values for time, which Pega normalizes to a GMT format. For example, you can use this field to capture a patient's preferred appointment time. |
URL | Captures alphanumeric values that must pass a validation for a correct URL format; the input must begin with http:// or https:// and be followed with any string. The UI displays the field value as a link that launches the user's default browser with the target web address. For example, you can use this field to display an external web address of a medial facility where a patient can book a procedure. |
Location | Captures coordinates for geolocation. For example, you can use this field to display an address where a patient needs to deliver a testing sample. |
User reference | Captures a single choice from a list of all system operators that have access to the application. This field is a special linked field that stores a list of operators who have access to the application. Depending on your configuration, the UI displays the field as a search box or a drop-down list. For example, you can use this field to help a patient pick a primary doctor from a list of doctors that have access to the application. The application can use that choice to directly route work items to the chosen doctor. |
Case reference | Captures single or multiple records that the system sources from a selected case type. The UI displays the field as a drop-down in which users can choose one (single record) or multiple (list of records) options from a given case type. For example, you can use this field in the Appointment case to reference one or more medial procedures from the Medical procedure case. |
Data reference | Captures single or multiple records that the system sources from a selected data object. The UI displays the field as a drop-down in which users can choose one (single record) or multiple (list of records) option from a given data object. For example, you can use this field in the Appointment case to reference data from the Patient data object. |
Embedded data | Captures single or multiple records from the user-supplied data that the application stores and sources from inside a case instance or a work object. For example, you can use this field to capture a patient's billing address, based on the home address they already provided in the case. |
Query | Captures single or multiple records from a data page or a view that the application stores and sources from outside a case type (other applications or systems). For example, you can use this field to present users with a list of medical facilities in a patient's city of choice, which are sourced from an external site. |
Previous topic Configuring a basic data object Next topic Exploring the visual data model