Relevant records are items that define and are most likely to be reused for a case or data type. These records help to define the information that is displayed in certain Pega Platform™ application windows and fields. Pega Platform provides several items that are marked as relevant records. By adopting an effective set of reusable assets, you can reduce the development time of your application.
Relevant records control design-time prompting and filtering in several areas of Data Designer and Case Designer. Records are automatically marked as relevant when you create them by using Data Designer or Case Designer. In addition, you can mark the following record types as relevant:
- Flow actions
This article includes the following sections:
In Data Designer, click Show relevant records only check box to display the relevant properties for a data type. Data Designer displays only relevant records that are directly defined on your data type. To see relevant records defined elsewhere in this data type’s inheritance path, click and select the Show reusable fields check box. To see internal system fields, such as properties with the px- or pz- prefix, select the Show system fields check box.
and select the
Data type filter options
Data Designer in App Studio displays properties that are marked as relevant records for the selected data type, with an option to display inherited or system fields.
Data Designer in express mode
In Case Designer, the Data model tab displays relevant properties for the selected case type, with an option to display inherited or system fields.
Case Designer Data model tab
On the Workflow tab, when you configure a form by selecting an assignment, and then click , the Fields list displays the fields (properties) that are sourced from the relevant records that are configured on the current case type.
Relevant records for form fields (properties)
On the Workflow tab, when you configure a form by selecting an assignment, and then click , the Views list displays the sections (views) that are sourced from the relevant records that are configured on the current case type.
Relevant records for sections (views)
On the Workflow tab, when you click +Add Step, and then click in the step palette, the Processes list displays the flows (processes) that are sourced from the relevant flows that are configured on the current case type.
Relevant records for processes (flows)
On the Workflow tab, when you click and select from the palette, the User actions list displays the flow actions (user actions) that are sourced from the relevant flow actions that are configured on the current case type.
Relevant records for user actions (flow actions)
The Views tab displays the sections (views) that are marked as relevant records for the current case type.
Case Designer Views tab
You can manage relevant records on the Relevant Records landing page. Open this landing page by clicking , and selecting the class in which you want to work. You can also access the page of the specific class by right-clicking it in the App Explorer. You can add or delete records from this page to create a set of improved and reusable records to use in your application.
Relevant Records page
The Relevant Records landing page displays records that are marked as relevant for the selected class. To display inherited records, click the Show inherited relevant records for the class check box. To display inactive records, click the Show inactive relevant records for the class check box. You can mark specific records as active or inactive for the current class by clicking the icon on the rightmost side of the row.
Mark relevant records as active or inactive
Add new records by clicking
and selecting the type and name of the item that you want to add.
Add Relevant Records dialog box
Newly added relevant records appear in the appropriate areas in Pega Platform. For example, if you added a property as a relevant record, it appears in the Fields list when you click the Workflow tab, select an assignment, and click .
You can mark records as relevant directly from their rule form by clicking
. Records that are added in this way are relevant for the class that they belong to.
Mark records as relevant