When developing Constellation base applications, certain data instances must be properly deployed to downstream environments to ensure consistent functionality across development, testing, and production. This article explores three less know data instances: Relevant records, Rule-ClassMetadata, and Rule-DataObject, System-User-Grids explaining their purpose and usage. 

Disclaimer 

This article discusses only some of lesser-known rules and is not intended to serve as comprehensive deployment instruction. There are other unversioned rules and data objects that you might need to deploy. 

Relevant Records 

Relevant records are rules that Pega Platform automatically marks for reuse in App Studio, or that application developers manually designate for reuse in App Studio.  

Key Characteristics 

• Typically used for authoring not in the runtime: Relevant records are primarily used during the design and development phases, not during runtime execution. 

• However Insights needs relevant records to show data fields: The Insights feature requires relevant records to properly display data fields in the interface. So if your business users have ability to author Insights on production system, you need to make sure Relevant Records are deployed there 

• Visibility differences: When not deployed properly, App Studio and Dev Studio may show different visibility conditions for the same elements 

• Migration requirement: Relevant records need to be moved to ensure consistent behavior across environments 

Tip: Relevant Records for objects created in branches might not be available in downstream environments – manual fix of associated Ruleset might be needed before deployment. 

Rule-ClassMetadata 

Rule-ClassMetadata was introduced to hold information associated with Class rules. It stores metadata that should be linked to a Class rule but couldn't be directly incorporated due to how the platform handles classes. 

Key Characteristics 

• Purpose: Initially created to store Primary fields and Default data sources and later extended to include other data elements. 

• Technical necessity: Due to the platform's handling of classes, a separate rule was needed to store data on which rule resolution could be applied. 

• Rendering impact: Rule-ClassMetadata can affect how Constellation renders certain experiences 

Impact of Non-Deployment 

If Rule-ClassMetadata is not properly deployed: 

1. Constellation UI may not render experiences correctly 

2. Primary fields and Default data sources might not be properly associated with their Class rules 

3. Rule resolution might not work as expected 

Rule-DataObject 

Rule-DataObject is used to associate Data objects with applications. Each Data Object in an application has a corresponding Rule-DataObject instance, which is created automatically when adding a Data Object to an application. 

Key Characteristics 

• Association mechanism: Links Data objects to applications, with a one-to-one relationship. 

• Creation trigger: Automatically created when adding a data object to an application. 

• Design-time impact: Affects design-time experiences, particularly when associating Data Objects with stages. 

• Runtime considerations: Generally, have no impact on runtime experiences, as these are typically driven from the App Rule. 

Impact of Non-Deployment 

If Rule-DataObject instances are not properly deployed: 

1. Design-time experiences may be affected, particularly when associating Data Objects with stages 

2. App Studio might not show the correct data objects 

3. The application's data model might not be properly represented 

Configuration Sets 

Configuration Sets are groups of settings that determine the run-time behavior of Constellation applications. Configuration sets are defined in the Pega-Configuration class. Individual settings are instances of the Data-Configuration-Setting class and provide a low-code way for non-developers to adjust application behavior at runtime without modifying underlying code. Each Configuration Set is associated with a specific application or Case Type and becomes visible in App Studio when Configuration Settings are created. 

Key Characteristics 

• Runtime behavior control: Configuration Sets allow users to modify application settings dynamically during runtime, enabling flexible application behavior without code changes. 

• Role-based access control: They utilize RBAC to manage access for different user roles, ensuring appropriate users can modify relevant settings. 

• Low-code configuration: Designed to enable business users and application administrators to configure functionality without technical development skills. 

• Application association: Each Configuration Set is linked to specific applications or Case Types, providing targeted configuration capabilities. 

• App Studio integration: Configuration Sets appear in App Studio interface only after at least one Configuration Setting is created, streamlining the user experience. 

Impact of Non-Deployment 

If Configuration Sets Data-Configuration-Setting instances are not properly deployed: 

1. Application behavior inconsistencies may occur across environments, as runtime settings won't match intended configurations 

2. Business users may lose access to critical configuration capabilities, impacting their ability to adapt application behavior to operational needs 

3. Runtime errors or unexpected application outcomes may result from missing configuration data 

4. User experience degradation can occur when expected configuration options are unavailable in downstream environments 

System-User-Grids 

System-User-Grids is a class that stores user-specific customizations for table configurations in Constellation applications. This class holds data that enables users to personalize their table views, including column arrangements, sorting preferences, and display settings. 

Key Characteristics 

• User-specific customization storage: System-User-Grids instances store individual user preferences for table and grid configurations, allowing personalized views across the application. 

• Table configuration persistence: The class maintains customized table settings such as column visibility, ordering, width adjustments, and sorting preferences that users have applied to their interface. 

Impact of Non-Deployment

If System-User-Grids instances are not properly deployed:

1. User experience inconsistency: Users may lose their customized table configurations when moving between environments, requiring them to reconfigure their preferred views.
2. Reduced user adoption: Users may be reluctant to customize their interfaces if they know their preferences won't persist across environment promotions.

Constellation 101 series

Enjoyed this article? See more similar articles in Constellation 101 series.