Configuring your system
- System-wide parameters
- To specify system-wide parameters, use system data instances. System data instances are occurrences of your Pega Platform. See Specifying system-wide security parameters by using system data instances.
- Cluster-wide parameters that differ from site to site
- To set cluster-wide parameters when the values differ from site to site, such as with URLs, user names, or port numbers, and when they might be set programmatically use dynamic system settings. See Using dynamic system settings.
- For example, you can use a dynamic system settings to configure which fields are available in full-text search. Dynamic system settings are stored in the Pega Platform database and are used by all nodes that share that database.
- Individual node settings
- To apply changes to only some nodes in a system, change settings in the
prconfig.xmlfile. Settings in the
prconfig.xmlfile apply to the node on which the
prconfig.xmlfile resides. See Changing node settings by modifying the prconfig.xml file.This is only for on-premises environments.
- Production-level-specific run-time parameters
- To set production-level-specific parameters, use data transforms and other rule types. Run-time application settings can differ based on a system's production level, and are further resolved at run time through rule resolution. See Configuring production-level-specific run-time settings by using application settings rules.
The rule and data instances listed below have similar names, but they are not related.
- Application settings rules (Rule-Admin-System-Settings rule type) – Use application settings rules to hold important constant values in your application that are the same in every deployed copy of your application, that can differ by production level, and are rule-resolved.
- Dynamic system settings data instances (Data-Admin-System-Settings) – Use dynamic system settings when the values differ from site to site, such as with URLs, user names, or port numbers, and when they might be set programmatically.
- Setting rules (Rule-Access-Setting rule type) – Use setting rules in role-based access control when defining access roles and permissions.
- Configuring production-level-specific run-time settings by using application settings rules
Application settings rules define run-time settings that can differ based on a system's production level, and which are resolved at run time through rule resolution. Application settings are identified by name and owning ruleset. The owning ruleset functions as a namespace and does not have to equal the ruleset that contains the rule.
- Using dynamic system settings
As a best practice, set system configuration settings by using dynamic system settings data instances. For example, you can use a dynamic system settings to configure which fields are available in full-text search. Dynamic system settings are stored in the Pega Platform database and are used by all nodes that share that database.
- Configuring the online help URL
To customize access to the help, change the default URL for online help. Changing the default URL for online help is particularly important if your system prohibits access to the internet.
- Configuring the path to an external log viewer
Specify the path to an external log viewer to control Directed Web Access (DWA).
- Configuring the public link URL
Change the Public Link URL to control Directed Web Access (DWA).
- Configuring Java compiler access to information
To support Service Java rules and other custom Java code, configure Java compiler access to the classes in external JAR files.
- Configuring the system name
If you have multiple Pega Platform systems, set a distinct system name for each system.
- Managing rules
Pega Platform includes various utilities to streamline system management activities.
- Classifying nodes
Node classification is the process of separating nodes by purpose, predefining their behavior by assigning node types. When you associate a work resource with a specific node type,you optimize work performance in your Pega application.
- Setting application-specific configuration settings with configuration definitions and configuration bundles
Use configuration definitions and configuration bundles to set application-specific configuration parameter values to store historical configuration information or to port the configuration definitions and values to other instances of the application.
- Downloading the system state by using a REST API
To download the current system state for a single node or for the whole cluster for use by a third-party tool, use a REST API. REST APIs are a standard way to access the resource status and can be used by third-party tools that support calling the API.
- Viewing system settings for troubleshooting
To diagnose configuration issues across the cluster, use the Admin Studio System settings page to verify the system settings for a node or cluster.