Understanding relevant records
Relevant records describe the rules that refine the behavior, presentation, and definition of a case type or data type. They commonly designate records from an inherited class as important or reusable in a child class, and control the majority of the prompting and filtering in the settings for case types and data types. Relevant records are also used to build conditions, for example, to determine whether a customer should receive a particular proposition.
You do not typically need to manually manage relevant records. Fields, views, processes, and user actions are automatically marked as relevant records when you create them in the context of a case type or data type.
Relevant records control design-time prompting and filtering in several areas of case types and data types.
Relevant records in proposition filters
Proposition filters use properties, strategies, or when rules as conditions, to evaluate whether a customer should receive a particular offer. You must designate all properties, strategies, and when rules available for use as proposition filter conditions as relevant records for your primary context class, which by default is your Customer class.
Creating new properties from 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
For a data type, relevant records designate the most important inherited fields for that data type. These relevant records can include fields that are defined for the class of the data type and fields inherited from parent classes. View data types by their relevant records to see a complete and succinct data model for that data type.
The Dev Studio Data Designer provides the Show inherited and Show relevant records filter options.
The Data Designer in App Studio displays only relevant (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 in these areas are marked as relevant records.
Relevant records in case types
Relevant records for a case type can include references to fields (properties), views (sections), processes (flows), or user actions (flow actions) that are explicitly important to your case. For example, fields 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. Views marked as relevant appear as reusable views.
The Data model tab displays only relevant fields for the selected case type, with an option to display relevant fields defined in inherited classes.
On the Workflow tab, when you click Life cycle, select an assignment, and then click Configure view, the Fields list is populated by fields (properties) from the relevant records in the current case type. The Views option also sources the views (sections) from the relevant records in the case type. Additional fields that you add to a form are automatically marked as relevant for that case type.
On the Workflow tab, when you click Life cycle, click +Add Step, and then select More in the step palette, the Processes list sources the processes (flows) from the relevant processes for the current case type. The User actions list sources the user actions (flow actions) from the relevant flow actions for the current case type. Additional user actions that you add to the case are automatically added to the relevant records for that case type.
The Views tab displays the views (sections) that are marked as relevant records for the current case type. Any additional views that you create are automatically marked as relevant for the current case type.
- Managing relevant records
Manage your relevant records to consolidate records that are specific to your cases and data types. Marking records as relevant can reduce time-consuming searching through unrelated records in your cases.
- Marking records as relevant records
Promote reuse in data types and case types by marking a rule as a relevant record on its rule form. For example, you can mark a property as a relevant record to reuse it as an inherited record in child classes.
- Securing relevant records
You can define a list of relevant records against one or more case or data types defined in your application before shipping your application to customers or downstream development teams. The .pzEditRelevantRecords when rule manages whether users are permitted to add or remove relevant record entries from a class.