Learning about default dynamic system settings
As your Pega Platform system operates, dynamic system settings data instances can be created as needed.
Scope of dynamic system settings
You can configure dynamic system settings to apply to all nodes, a specific node, or a node type depending on the ending string. Refer to the following table to understand what terminating strings of a dynamic system setting correspond to the scope of the setting.
Terminating strings and setting scope
| Terminating string | Scope within Pega Platform |
| /default | Default setting. Applies this setting to all nodes. |
| /<nodeid> | Applies this setting to the specified node. |
| /<nodetype> | Applies this setting to the specified node type. |
Default prconfig dynamic system settings
Dynamic system settings that have Pega-Engine as the owning ruleset and key names that start with prconfig are known as prconfig settings. To use prconfig DSS settings, you must configure your system as described in Configuring dynamic system settings. After creating the prconfig DSS setting, you must restart the node; if the setting specifies all nodes, then restart all nodes.
Pega-Engine ruleset settings for prconfig
| Setting name | Purpose |
| prconfig/agent/enable/default | Enables application agents. |
| prconfig/alerts/asyncdatapage/allocatedMemoryThreshold | Defines the memory threshold for queue processors, in GB. The setting is disabled by default. Default value: -1 (disabled) Example value: 2000 For more information, see PEGA0133 alert: Allocated memory threshold reached. |
| prconfig/alerts/browser/allocatedMemoryThreshold | Defines the memory threshold for browser/http requests, in GB. The setting is disabled by default. Default value: -1 (disabled) Example value: 2000 For more information, see PEGA0133 alert: Allocated memory threshold reached. |
| prconfig/alerts/jobscheduler/currentruntoolong/enabled | Enables the PEGA0130 alert. Default = true. For more information, seePEGA0130 alert: Current Job Scheduler run is taking too long. |
| prconfig/alerts/jobscheduler/currentruntoolong/threshold | Sets the time (in seconds) after which a job scheduler is determined to have
been running for too long. Default = 300. For more information, seePEGA0130 alert: Current Job Scheduler run is taking too long. |
| prconfig/alerts/queueprocessor/allocatedMemoryThreshold | Defines the memory threshold for queue processors, in GB. The setting is disabled by default. Default value: -1 (disabled) Example value: 2000 For more information, see PEGA0133 alert: Allocated memory threshold reached. |
| prconfig/alerts/queueprocessor/longrunning/activity/enabled | Generates the PEGA0117 alert when such an activity runs longer than a
configured threshold value. For more information, see PEGA0117 alert: Long-running queue processor activity. |
| prconfig/alerts/service/allocatedMemoryThreshold | Defines the memory threshold of service requests, in GB The setting is disabled by default. Default value: -1 (disabled) Example value: 2000 For more information, see PEGA0117 alert: Long-running queue processor activity. |
| prconfig/identification/systemName/default | Sets the name of the Data-Admin-System instance for the server. |
| prconfig/initialization/displayExceptionTraceback/default | Controls the display of stack trace information in exception screens. |
| prconfig/initialization/explicitTempDir/default | Specifies the full path name to use as the temporary directory. |
| prconfig/initialization/persistRequestor/default | Controls whether time-put passivation is enabled. For more information, see Changing the default passivation time-out settings. |
| prconfig/initServices/initEmail/default | Enables email listeners on startup, as defined in
Data-Admin-Connect-EmailListener |
| prconfig/initServices/initFile/default | Enables file listeners on startup, as defined in
Data-Admin-Connect-FileListener |
| prconfig/initServices/initJMS/default | Enables JMS listeners on startup, as defined in
Data-Admin-Connect-JMSListener |
| prconfig/initServices/initMQ/default | Enables MQ listeners on startup, as defined in
Data-Admin-Connect-MQListener |
| prconfig/pradapter/loggingLevel/default | Specifies the level of tracing for output to the system log. This setting overwrites the setting located in the JVM properties file. |
| prconfig/queueprocessors/usagemonitor/alert/enabled | Generates the PEGA0134 alert when the number of items that are ready to process exceeds the threshold value for the queue processor. For more information, see PEGA0134: Too many items in ready-to-process state. |
| prconfig/queueprocessors/usagemonitor/alert/enabled | Generates the PEGA0137 alert when items that are ready to be processed are not picked up by the queue processor within an expected length of time. For more information, see PEGA0137: Ready-to-process items not picked by queue processor. |
| prconfig/timeout/browser/default | The number of seconds that requestors are idle before passivation occurs. The default value is 3,600 seconds, or 60 minutes. |
| prconfig/timeout/page/default | The number of seconds that pages are idle before passivation occurs. The default value is 900 seconds, or 15 minutes. |
| prconfig/timeout/thread/default | The number seconds that threads are idle before passivation occurs. The default value is 1800 seconds, or 30 minutes. |
Default queueprocessors system settings for large message exception handling
Dynamic system settings that have Pega-Engine as the owning ruleset and key names that start with queueprocessors are known as queue processor settings for handling large message exceptions.
Pega-Engine ruleset settings for queueprocessors for large message exception handling
| Setting name | Purpose |
| queueprocessors/largemessagesnapshot/enabled | Enables the large message handling feature in queue processing. When enabled,
if the Stream Service generates the RecordTooLargeException
exception, the message does not break. The following systems default to these settings:
|
| queueprocessors/largemessagesnapshot/repository | The name of the large message repository. Default value: pegacloudfilestorage |
| queueprocessors/largemessagesnapshot/basepath | The basepath for the large message repository.
Default value: queueProcessors/largeMessageSnapshots |
Other default dynamic system settings
The default dynamic system settings listed in the following table are narrower in scope than the Pega-Engine ruleset settings.
Other default dynamic system settings and their owning rulesets
| Owning ruleset | Name | Purpose |
| Pega-RULES | ||
| Pega‑IntegrationEngine | EnableRequestorPools | When set to either an empty value or true, requestor pools are enabled and available for service request processing. When set to false, requestor pools are disabled, unavailable for service request processing, and are not available to edit. The following systems default to these settings:
For more information, see Requestor pooling for services. |
| Pega-IntegrationEngine | disableEpochDateTime | When a datetime property is set to an empty value, it returns the epoch datetime (01-jan-1970) by default. Set this value to true to have the property return no value. |
| Pega-Desktop | AllowAccessToExternalSystem | Used to control calls to external systems such as Pega Community when logging into Designer Studio. By default, this setting is set to true. |
| Pega-EndUserUI | weblogin/mobile/enabletouchid | Enables the Touch ID fingerprint recognition feature on supported iOS devices.
It is used to log in to a Pega Platform mobile app, bypassing the
need to manually enter user credentials each time. Changing this setting to false disables this feature and hides the Use Touch Id check box on the Login screen. For more information, see Mobile features overview. |
| Pega-ProcessEngine | pyEmailMaxResends | See More about Email Accounts. |
| Pega-ProCom | PublicLinkURL | Edit to identify a URL for directed web access, such as
|
| Pega-ProCom | pyUseGoalTimeForAvailabilityCalculation | If true, the assignment's goal time is compared to the assignment's start time and effort estimate to determine operator availability. |
| Pega-ProCom | WorkHistoryVersion | When set to 5.1, indicates that a one-time upgrade activity for Version 4.2 work item history instances has completed successfully. |
| Pega-RULES | compiler/defaultClasses | Supports Service Java rules and other custom Java code. A list of Java classes
that are added to the compile-time classpath for the compiler used to compile the
generated Java. This allows service activities to call such classes.
As a best practice, in Dev Studio, click to update this property. |
| Pega-RULES | compiler/defaultPaths | Supports Service Java rules and other handcrafted Java code. A list of JAR
files that are added to the compile-time classpath for the compiler used to compile
the generated Java. This allows service activities to call the classes in external
JAR files.
As a best practice, in Dev Studio, click to update this property. See System category — Settings page. |
| Pega-RULES | idGenerator/defaultBatchSize | Sets the batch size for generating work IDs. The default value is 1000. This setting applies to all case types and to all nodes in a cluster. This setting only applies to single-tenant environments and PostgresSQL or AWS Aurora databases. |
| Pega-RULES | idGenerator/<case type's name followed by a hyphen>/batchSize | Overrides the idGenerator/defaultBatchSize setting for a specific case type, for example, idGenerator/WORK-/batchSize. This setting only applies to single-tenant environments and PostgresSQL or AWS Aurora databases. |
| Pega-RULES | indexing/dataEnabled | Controls whether data instance indexing for full-text search is enabled. As a best practice, in Dev Studio, click to update this property. |
| Pega-RULES | indexing/hostname | In a multi-node cluster, identifies the internal node name (a hash value) of
the node that supports Elasticsearch full-text indexing. As a best practice, in Dev Studio, click to update this property. |
| Pega-RULES | indexing/ruleEnabled | Controls whether rule instance indexing is enabled. As a best practice, in Dev Studio, click to update this property. |
| Pega-RULES | indexing/updatetime | Records the date and time of the last comprehensive index build. |
| Pega-RULES | indexing/workEnabled | Controls whether work item indexing is enabled. As a best practice, in Dev Studio, click to update this property. See System category — Settings page. |
| Pega-RULES | SearchSoapURI | In a multi-node cluster, records the URI to be used in SOAP-based
communications among nodes to support full-text searches. As a best practice, in Dev Studio, click to update this property. |
| Pega-RULES | usage/usagetrackingenabled | Enables or disables usage tracking. Initial value is
true. See How to analyze system-wide usage with the Log-Usage class. |
| Pega-RULESEngine | pyMaxRecords | Maximum records retrieved for report definitions. |
| Pega-RULESEngine | pyQueryTimeoutInterval | See Reporting Category — Settings Page |
| Pega-RULESEngine | pyExportMaxRecords | See Reporting Category — Settings Page |
| Pega-RULESEngine | pyExportQueryTimeout | See Reporting Category — Settings Page |
| Pega-RULESEngine | pyExportNumberOfRecordsAtATime | Specifies the number of records exported at one time. The default setting is 5,000 records. |
| Pega-IntSvcs | Email/AddLegacyHeaders | Appends old email headers to new headers if the value is true and does not append if the value is blank or not set to true. |
| Pega-IntSvcs | FailOnAddressException | If set to true, ensures that message processing failures are caught. If set to false, ignores processing failures related to message headers.The default setting is true. |
| Pega-IntSvcs | xml/removeEmptyPropertiesFromPage | Removes empty properties, including complex types, from the source page before generating the XML stream. |
| Pega-DecisionEngine | dataflow/run/events/persist | If set to true, the data flow life cycle events are
written to the database and then deleted every N days, as specified in the
dataflow/run/lifecycleEventsRetentionDay dynamic system
setting. If set to false, the data flow life cycle events are not written to the database. |
| Pega-UpdateManager | hotfixmanager.enableRevocation | Change the dynamic system setting to disable certificate revocation checking. However, disabling the setting lowers your system security.
|
Previous topic Viewing system configuration settings Next topic Creating a dynamic system setting