Relevant records are rules that Pega Platform automatically marks for reuse in App Studio, or that application developers manually designate for reuse in Dev Studio. By using relevant records, you configure your application with developer-approved rules, improve its quality, and reduce development time.
Relevant records creation
Typically, Pega Platform automatically manages relevant records for you. In App Studio, when you create records, such as fields, views, processes, and user actions in the context of a case type or data type, Pega Platform automatically marks these records as relevant.
You can also configure a rule in Dev Studio, then mark the rule as a relevant record so that the rule is accessible to other developers from prompts in App Studio.
For example, when you configure an assignment and select an existing service-level agreement (SLA) option in App Studio, the SLA is available in the drop-down list only if another developer first creates and marks the SLA as a relevant record in Dev Studio.
Rule types that you can manually mark as relevant records in Dev Studio include:
- Properties, also known as fields
- Sections, also known as views
- Service-level agreements
- Processes, also known as flows
- User actions, also known as flow actions
- Decision Tables
- Pulse Feed rules
- Validate rules
- When rules
You can manually designate records as relevant in the following ways:
- Mark a rule as a relevant record in the rule form
- You can mark a selected rule as relevant directly in the rule form in Dev Studio.
For more information, see Marking a record as relevant.
- Add a rule as a relevant record on the Relevant records tab
- You can designate a selected rule as a relevant record on the Relevant
records tab in Dev Studio.
For more information, see Adding a relevant record to a specified class in your application.
You can access relevant records in App Studio, in the Data Designer or the Case Designer, when you add a step to a process, add fields to a user view, or apply a service-level agreement.
For example, when you configure a user view for a step in a case life cycle, Pega Platform populates the Fields and Views lists with relevant records, as shown in the figure:
The functions of relevant records
Relevant records control design-time prompting and filtering in the following areas:
- In case types
- Relevant records for a case type can include references to properties, sections,
processes, and user actions that are explicitly important to your case.
Properties marked as relevant define the data model of the case. Processes and user actions marked as relevant appear in prompts for case type settings to encourage reuse. Sections marked as relevant appear as reusable sections.
- In data types
- Relevant records designate the most important inherited fields for a data type. Relevant records can include fields that are defined for the class of the data type and fields inherited from parent classes.
- In condition builders
- When you build conditions in a condition builder in App Studio,
or on the Condition tab of a when rule in Dev Studio, you see a list of fields and when conditions that you can
use in your custom condition. The list populates with relevant records. If a record is
not in the list, you can add it to relevant records in your application.
For more information, see Adding a relevant record to a specified class in your application and Defining conditions in the condition builder.
- In proposition filters
- When you use properties, strategies, and when rules as proposition filter conditions, you designate these elements as relevant records for your primary context class, which by default is the Customer class.
For more information, see About Proposition Filter rules.
Creating new properties on the Properties tab of a strategy or a proposition automatically marks the properties as relevant records. You must manually add strategies and when rules to the list of relevant records for a specific class.
For more information, see Managing relevant records.
Relevant records in Data Designer
The Data Designer displays properties for the selected data type that the system marks as relevant records. In Dev Studio and App Studio, use the filtering options to show reusable fields, which are relevant records defined elsewhere in the selected data type's inheritance path, and to show internal system fields.
The Dev Studio Data Designer provides the Show inherited and Show relevant records filtering options.
The Data Designer in App Studio displays only relevant records (properties) for the selected data type, with an option to display or hide relevant fields defined in inherited classes.
New fields that you add to the data types are automatically marked as relevant records as shown in the figure.
Relevant records in Case Designer
You can access relevant records from several locations in Case Designer:
- From the Data model tab
- The Data model tab displays properties for the selected case type that the system marks as relevant. Use the filtering options to display reusable fields or system fields.
- From the Workflow tab
- On the Workflow tab, the view configuration window for a
selected assignment displays records for the selected case type that the system marks as
relevant. The Fields list displays fields (properties) that are
configured on the current case type and marked as relevant records. The
Views list displays views that are configured on the current
case type and marked as relevant records.
The system automatically marks new fields that you add to a form as relevant for that case type.
On the Workflow tab, the More section of the step menu displays flows and flow actions that the system marks as relevant records from the Process and User actions lists, respectively.
The system automatically adds new user actions that you add to the case to the relevant records for that case type as shown in the figure.
- From the Views tab
- The Views tab displays the views (sections) that the system
marks as relevant records for the current case type.
The system automatically marks any additional views that you create as relevant to the current case type, as shown in the figure.
- Managing relevant records
Speed up your application development by curating records that you need to include in your case types and data types. Relevant records control design-time prompting and filtering in several areas of App Studio, and as a result, reduce time-consuming searching through unrelated records in your cases.
- Marking a record as relevant
To save resources and speed up application development, promote reuse in data types and case types by marking a rule as a relevant record. Relevant records control design-time filtering options in case types and data types in App Studio. As a result, when you create an application, you receive a set of relevant options, instead of an extensive or incomplete selection of choices.
- Adding a relevant record to a specified class in your application
Expand the library of relevant records by adding records and classes that are most likely to be reused for a case or data type.
- Marking relevant records as active or inactive
Make a record available or unavailable in App Studio by marking the record as active or inactive. By marking certain records as inactive you can narrow down the list of relevant records to suit the current implementation context best, without the need to delete any records from your application.
- Security of relevant records
You can define a list of relevant records in one or more case types or data types in your application before you deliver the application to customers or other development teams. By updating a related when rule, you can enable or disable certain access groups to add or remove relevant record entries from a class.