Skip to main content

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Dynamic system settings data instances

Suggest edit
Updated on April 5, 2022

As your Pega Platform system operates, dynamic system settings data instances can be created as needed.

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.

Caution: Be careful when making any updates because these settings can significantly affect the operation of your Pega Platform system.
Owning rulesetNamePurpose
Pega-Engineprconfig/agent/enable/defaultEnables application agents.
Pega-Engineprconfig/identification/systemName/defaultSets the name of the Data-Admin-System instance for the server.
Pega-Engineprconfig/initialization/displayExceptionTraceback/defaultControls the display of stack trace information in exception screens.
Pega-Engineprconfig/initialization/explicitTempDir/defaultSpecifies the full path name to use as the temporary directory.
Pega-Engineprconfig/initialization/persistRequestor/defaultSets the conditions for the system saving a user's requestor context.
Pega-Engineprconfig/initServices/initEmail/defaultEnables email listeners on startup, as defined in Data-Admin-Connect-EmailListener
Pega-Engineprconfig/initServices/initFile/defaultEnables file listeners on startup, as defined in Data-Admin-Connect-FileListener
Pega-Engineprconfig/initServices/initJMS/defaultEnables JMS listeners on startup, as defined in Data-Admin-Connect-JMSListener
Pega-Engineprconfig/initServices/initMQ/defaultEnables MQ listeners on startup, as defined in Data-Admin-Connect-MQListener
Pega-Engineprconfig/pradapter/loggingLevel/defaultSpecifies the level of tracing for output to the system log. This setting overwrites the setting located in the JVM properties file.

Other default dynamic system settings

These dynamic system settings have a narrower scope.

Owning rulesetNamePurpose
Pega-IntegrationEngineEnableRequestorPoolsNote: If you change this value, you must restart your entire environment for the change to affect each component node.
  • For Pega Cloud Services deployments, file a service request to restart.
  • For on-premises or client-managed cloud deployments, manually restart each component node of the environment.

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:

  • Pega Cloud and on-premises: Enabled (no value)
  • Client-managed cloud: Disabled (false)

For more information, see Requestor pooling for services.

Pega-IntegrationEnginedisableEpochDateTimeWhen 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-DesktopAllowAccessToExternalSystemUsed to control calls to external system such as Pega Community when logging into designer studio. By default, this setting is set to true.
Pega-EndUserUIweblogin/mobile/enabletouchidEnables 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.

Pega-ProcessEnginepyEmailMaxResends See More about Email Accounts.
Pega-ProComProComHelpURIIdentifies the property containing the root URI of this Application Developer Help system. Determined during installation.

As a best practice, in Dev Studio, click ConfigureSystemSettingsURLs to create or update this setting.

See System category — Settings page.
Pega-ProComPublicLinkURL Edit to identify a URL for directed web access, such as
http://mysystem:8081/prweb/
As a best practice, in Dev Studio, click ConfigureSystemSettingsURLs to create or update this setting. See System category — Settings page.
Pega-ProCompyUseGoalTimeForAvailabilityCalculationIf true, the assignment's goal time is compared to the assignment's start time and effort estimate to determine operator availability.

See Operator form — Completing the Work Settings tab.

Pega-ProComWorkHistoryVersionWhen set to 5.1, indicates that a one-time upgrade activity for Version 4.2 work item history instances has completed successfully. Note: The upgrade is not necessary on systems that contain no Version 4.2 work item history instances.
Pega-RULEScompiler/defaultClassesSupports 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. For Windows systems, separate the Java classes with a colon. For UNIX systems, separate the Java classes with a semicolon.

As a best practice, in Dev Studio, click ConfigureSystemSettingsCompiler to update this property.

See System category — Settings page.

Pega-RULEScompiler/defaultPathsSupports 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. For Windows systems, separate the JAR files with a colon. For UNIX systems, separate the JAR files with a colon.

As a best practice, in Dev Studio, click ConfigureSystemSettingsCompiler to update this property. See System category — Settings page.

See About the Process Commander class paths.

Pega-RULESidGenerator/defaultBatchSizeSets 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. Note: When work IDs are generated and the batch size is set to 1000, performance is increased but there might be gaps in the numerical sequence of the IDs. For example consecutively generated work IDs might come out as TASK-1, Task-1001, TASK-2001, TASK-2, TASK-1002, TASK-2002. As more work items are created, IDs are created that fill in the gaps between previous created IDs. If you want fewer gaps in your work IDs, you can set the idGenerator/defaultBatchSize dynamic system setting to 100. This value causes fewer gaps in the work IDs but yields a smaller increase in performance. To eliminate gaps in your work IDs, set the idGenerator/defaultBatchSize dynamic system setting to 1. Note that setting the dynamic system setting to 1 might cause low performance.
Pega-RULESidGenerator/<case type's name followed by a hyphen>/batchSizeOverrides 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-RULESindexing/dataEnabledControls whether data instance indexing for full-text search is enabled.

As a best practice, in Dev Studio, click ConfigureSystemSettingsSearch to update this property.

See System category — Settings page.

Pega-RULESindexing/hostnameIn 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 ConfigureSystemSettingsSearch to update this property.

See System category — Settings page.

Pega-RULESindexing/ruleEnabledControls whether rule instance indexing is enabled. As a best practice, in Dev Studio, click ConfigureSystemSettingsSearch to update this property.

See System category — Settings page.

Pega-RULESindexing/updatetimeRecords the date and time of the last comprehensive index build.
Pega-RULESindexing/workEnabledControls whether work item indexing is enabled.

As a best practice, in Dev Studio, click ConfigureSystemSettingsSearch to update this property.

See System category — Settings page..
Pega-RULESSearchSoapURIIn 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 ConfigureSystemSettingsSearch to update this property.

See System category — Settings page.

Pega-RULESusage/usagetrackingenabledEnables or disables usage tracking. Initial value is true.

See How to analyze system-wide usage with the Log-Usage class.

Pega-RULESEnginepyMaxRecordsMaximum records retrieved for report definitions.

See Reporting Category — Settings Page

Pega-RULESEnginepyQueryTimeoutIntervalSee Reporting Category — Settings Page
Pega-RULESEnginepyExportMaxRecordsSee Reporting Category — Settings Page
Pega-RULESEnginepyExportQueryTimeoutSee Reporting Category — Settings Page
Pega-RULESEnginepyExportNumberOfRecordsAtATimeSpecifies the number of records exported at one time. The default setting is 5,000 records.

See Reporting Category — Settings Page

Pega-IntSvcsEmail/AddLegacyHeadersAppends 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. Note: The new email header for the old header PegaAttachmentID is X-PegaAttachmentID, for Email-Handle is X-PegaEmail-Handle, and for Work-Handle is X-PegaWork-Handle.
Pega-IntSvcsFailOnAddressExceptionIf 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-IntSvcsxml/removeEmptyPropertiesFromPageRemoves empty properties, including complex types, from the source page before generating the XML stream.
Pega-DecisionEnginedataflow/run/events/persistIf 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.Note: Only set this dynamic system setting to false when too many messages are written to the database in an unstable environment.
  • Previous topic Java methods for dynamic system settings and application settings
  • Next topic Updating dynamic system settings by submitting a request to an active instance
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us