How to create or update a prconfig setting

The prconfig.xml file holds preferences that can be set or changed for a PegaRULES installation. For example, the following entry controls whether agents are enabled for this node:

<env name="agent/enable" value="true" />

These settings can alternatively be stored as Dynamic System Settings instances. This has two advantages:

• The value of the settings can be changed without the need to edit the prconfig.xml file. In some application servers, editing this file requires redeploying the entire application.
• In a multi-node system, the same setting can be used by all the nodes sharing the database, making the administration of the system easier.

At installation, only a few settings are defined as Dynamic System Settings. If you need to add a setting, you define it as a new Data-Admin-System-Settings instance.

For a simple example of a Dynamic System Setting that replaces a prconfig.xml file setting, see PDN article How to set prconfig values in a Dynamic System Setting value.

Classifications

Optionally, you can assign a System Settings classification to a setting, and then assign that setting to specific nodes nodeclassification setting in their individual prconfig.xml files.

Settings stored in the PegaRULES database (through Dynamic System Settings instances) are used by all nodes that share that database.

Administrators can override the stored settings for a single node by entering the setting in that node's prconfig.xml file. When the node is restarted, the setting in the file always takes precedence over the stored value.

If you need to set a setting's value for a subset of your nodes that is different than the default, you can create a classification. The classification is defined in the prconfig.xml file, and then referenced in Data-Admin-System-Settings as the last portion of the Setting Purpose field.

The classification is defined in a nodeclassification setting in the prconfig.xml file, for example, <env name="initialization/nodeclassification" value="Agents"/>. Settings that reference this classification in their Setting Purpose string, for example prconfig/agent/enable/Agents, would only be applied to nodes that include this setting. All other nodes would use the default setting.

Defining a Dynamic System Setting

When you create a new Dynamic System Setting instance, you specify an Owning Ruleset and a Setting Purpose.

The owning ruleset is always Pega-Engine. All configuration settings (from prconfig and prbootstrap) Owning Ruleset of Pega-Engine. Config settings with any other value are ignored.

The Setting Purpose field defines the use of the system setting, for example, prconfig/agent/enable/default. This string is made up of the following components:

• file type

  Specifies the kind of setting this instance is:

  • prconfig — for prconfig settings
  • properties — for prbootstrap.properties settings
  • blank — no value at all, for unspecified Data-Admin-System-Settings

  In the example, "prconfig" is the file type.

• setting name

  The middle of the string is the name of the setting and can include long strings, divided by slashes or periods

  In the example, "agent/enable" is the setting name.

• classification or "default"

  The last part of the string identifying the node classification, as described above.

On the Settings tab, complete the Value carefully. Save the form.

The new setting takes effect the next time the system (or this node) is started.

Related terms

Related information

SysAdmin category

Open topic with navigation