LinkedIn
Copied!

Table of Contents

Learning about default dynamic system settings

Version:

Only available versions of this content are shown in the dropdown

As your Pega PlatformTM 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 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.

Be careful when making any updates because these settings can significantly affect the operation of your Pega Platform system.

Pega-Engine ruleset settings

Setting name Purpose
prconfig/agent/enable/default Enables application agents.
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/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 Sets the conditions for the system saving a user's requestor context.
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.

Other default dynamic system settings

These dynamic system settings have a narrower scope.

Owning ruleset Name Purpose
Pega-RULES
Pega‑IntegrationEngine EnableRequestorPools
If you change this value, you must restart your entire environment for the change to affect each component node.
  • For Pega Cloud Services 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-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 system 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 ProComHelpURI Identifies the property containing the root URI of this Application Developer Help system. Determined during installation.

As a best practice, in Dev Studio, click Configure System Settings URLs to create or update this setting.

See System category — Settings page.
Pega-ProCom PublicLinkURL Edit to identify a URL for directed web access, such as
http://mysystem:8081/prweb/
As a best practice, in Dev Studio, click Configure System Settings URLs to create or update this setting. See System category — Settings page.
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.

See Operator form — Completing the Work Settings tab.

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.
The upgrade is not necessary on systems that contain no Version 4.2 work item history instances.
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.
  • 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 Configure System Settings Compiler to update this property.

See System category — Settings page.

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.
  • 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 Configure System Settings Compiler 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.
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. However, a value of 1 might cause low performance.

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 Configure System Settings Search to update this property.

See System category — Settings page.

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 Configure System Settings Search to update this property.

See System category — Settings page.

Pega-RULES indexing/ruleEnabled Controls whether rule instance indexing is enabled. As a best practice, in Dev Studio, click Configure System Settings Search to update this property.

See System category — Settings page.

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 Configure System Settings Search 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 Configure System Settings Search to update this property.

See System category — Settings page.

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.

See Reporting Category — Settings Page

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.

See Reporting Category — Settings Page

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.
The following are the new email headers for the old headers:
  • PegaAttachmentID is the new header for X-PegaAttachmentID.
  • Email-Handle is the new header for X-PegaEmail-Handle.
  • Work-Handle is the new header for X-PegaWork-Handle.
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.

Only set this dynamic system setting to false when too many messages are written to the database in an unstable environment.
Pega-UpdateManager hotfixmanager.enableRevocation

Change the dynamic system setting to disable certificate revocation checking. However, disabling the setting lowers your system security.

  • If the setting value is blank or set to true (default), then revocation checking is performed.
  • If the setting value is set to false, then revocation checking is not performed.
Did you find this content helpful?

Have a question? Get answers now.

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