Back Forward RuleSet Versions and RuleSets
Completing the Create New and Save As forms

About RuleSet rules

There are two forms for creating or copying RuleSets and versions: New RuleSet Version and Save As RuleSet. The RuleSet and its versions are maintained in a single RuleSet form.

New RuleSet Version form

Use this form to:

To open the form, select RuleSet from the SysAdmin category on the Records Explorer, right click, and select New.

Define the RuleSet, version, and prerequisites

Use the top section of the form to enter the key parts of both rules.

Field

Description

RuleSet Name

Select an existing RuleSet, or enter a RuleSet Name value starting with a letter and containing only letters, digits, and dashes. RuleSet names must be unique system-wide.

Give your RuleSet a name that helps you manage and identify its contents. Start the RuleSet name with a letter and use only letters, digits, and dashes. Choose names that are short and easy to remember.

An initial portion of the name can represent your company and the second portion can represent the application content or purpose. For example, you might use your company stock ticker symbol followed by letters that represent the purpose of the application or its content.

Special cases

To create a language specific RuleSets name, enter the base RuleSet name followed by a single underscore and then the locale code. For example, enter ALPHA_fr for a French language RuleSet to override text elements in the ALPHA RuleSet. See Internationalization and localization — Concepts and terms.

To create a RuleSet to support only access from mobile devices, follow the base RuleSet name with the _mobile suffix. See Understanding Pega-Mobile.

Rule resolution

To avoid circularity, rule resolution does not apply to RuleSet rules.

Restrictions

  • Don't choose a name that starts with the four letters Pega, or other variations of this text with different case. Such RuleSets have special capabilities and are reserved for use by Pegasystems.
  • RuleSet names may be up to 64 characters long, but normally are less than twenty characters long. See System limits and maximums.

Version

When you enter a new RuleSet name, the system enters a default three-part version identifier of 01-01-01. You can modify this value using another three-part identifier.

When you select an existing RuleSet name, the system increments its highest version by one patch number.

Every RuleSet normally has at least one version numbered 01-01-01. Create additional versions for developers who make enhancements and fixes to rules in the RuleSet.

  • For enhancements, developers need a version in which the middle two digits are incremented. This is known as a minor version.
  • For bug fixes, developers need a version in which the last two digits are incremented. This is known as a patch version.
  • For major releases, developers need a version in which the first two digits are incremented. This is known as a major version. Major versions can be created automatically during skim operations rather than through the rule form.

You can use any increment between numbers. For example, you can create version 01-01-10 without creating 01-01-02.

Rule resolution

To avoid circularity, rule resolution does not apply to RuleSet version rules. A RuleSet version is a rule contained in a RuleSet. For example, the RuleSet version 01-17-04 of RuleSet Alpha is among the other versions rules contained in the RuleSet.

Description

When you enter or select a RuleSet name, the system enters a unique two-part short description comprising the name and the default version. For example, if you enter a RuleSet name MyCo, the default description is MyCo:01-01-01. If you change the Version value, the Description field updates the version number automatically. You can edit this field to suit your requirements.

Requires RuleSet and Version

A new RuleSet version must have at least one prerequisite. When you enter a RuleSet name, the system enters in this field the highest Pega-ProcessCommander version in the system.

If you selected an existing RuleSet, the prerequisites for that rule appear.

For more information about this field, see Working with the Versions tab

Update my current Application to include the new version

Select it if you want to add this RuleSet version to the top of the Application RuleSet list in the current application rule. If you select this box, you must use Quick Create to save the rule.

The system will not update the application rule if password protection is enabled. To disabled it, clear the Require password to update application checkbox on the Definition tab on the application form.

Create

Click to create the new RuleSet and version rules. When the RuleSet form opens, click Save both the rules. Do not click the Save button in the RuleSet version row on the Versions tab.
Quick Create

Click to create or update the RuleSet and version rules without opening the RuleSet form and manually saving it. The version is added to the Application if you selected Update my current Application to include the new version.

Save As RuleSet form

Use this form to copy a RuleSet. The system copies the values in the Security, Category, and History tabs. The version is the one you specify in this form.

Do the following:

  1. Open the RuleSet and open the Save As RuleSet form.
  2. Enter a new, unique RuleSet name. Do not select an existing name from SmartPrompt.
    You cannot add a version to an existing RuleSet on this form.
  3. Keep the default version 01-01-01 or modify it.
  4. Keep the default Description value or modify it.
  5. Update the prerequisite RuleSets and versions if necessary.
  6. Optionally, select Update my current Application to include the new version.
  7. Click Create. The RuleSet form opens. (If you click Quick Create, the RuleSet and version are automatically saved; the form does not open)
  8. Save the RuleSet to save the RuleSet and version.

You cannot use this form to add a version to a RuleSet. To add a version, open the New RuleSet Version form as described above, select an existing RuleSet, and update the Version field. Alternatively, open Versions tab on the RuleSet form, add a row in the Versions array, and complete the New RuleSet Version form. See Using the Versions tab.

Creating branch RuleSets

You create branch RuleSets in the Branch area on the Application rule's General tab. See Application form - Completing the General tab.

branches and branch RuleSets, landing page, division, organization unit, organizational RuleSet, ownership, RuleSet list
About Organization data instances
About Organization Unit data instances
About Division data instances
About Operator ID instances
About RuleSet versions

Up About RuleSet rules