Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring primary fields

Updated on May 11, 2022

Define primary fields to automatically add the most relevant fields to your cases and reduce the amount of UI configuration that is necessary.

Note: Only applications that you build with Cosmos React support primary fields. For more information, see Choosing a UI version and Cosmos React.
You can add primary fields to case types and data objects without the need to configure the UI; you only modify your data model and the system automatically adjusts the form. Pega Platform automatically generates a Primary fields view and adds it to the Create, Edit, Details, and List views.
Note: Case types include the Label and Description primary fields by default.

For more information about views, see Working with views.

For example, in a case type that captures customer information, you define Name, Email, and Address as primary fields. Then, you access the Address data object, and define its primary fields, such as Street, City, and Country. The system adds the fields automatically in the Primary fields view, as shown in the following figure:

Sample primary fields preview
The User interface tab with a preview of the Primary fields view that includes sample fields, such as Name and Email.
Before you begin: Ensure that the fields that you want to mark as primary exist in your system. For more information, see Adding fields.
  1. In the navigation pane of App Studio, navigate to the item for which you want to define primary fields:
    Case typesClick Case types, and then click the case type that you want to open.
    Data objectsClick Data, and then click the data object that you want to open.
  2. On the Data model tab, click Primary fields.
  3. In the Primary field configuration modal dialog box, click Add, and then select the existing fields that you want to make primary.
  4. Optional: To delete existing primary fields, click the Remove from primary fields icon.
  5. Optional: To reorder the primary fields, drag and drop the fields in the appropriate positions.
  6. Click Submit.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us