RuleSet form - Working with the Versions tab

RuleSet form Working with the Versions tab
About New Versions Security Category History More...

Use this tab to update any version rules defined for this RuleSet, or to create additional versions.

RuleSet version rules identify a three-level version number for a RuleSet. You can update these rules to prohibit changes to rules in the version, to record a start date for the version, and to identify any dependencies between this RuleSet version and other RuleSets.

Branch RuleSets can have one version only (by default, 01-01-01). You cannot add versions to a branch RuleSet.

Basics

Field	Description
Secure	Identifies a locked or unlocked RuleSet version. Lock the RuleSet version to prevent developers from saving new rule instances to this version, or updating or deleting existing instances. All instances using this version must be checked in before the version can be locked. Use the Checked Out column to identify the number of rule instances using this version that are checked out. Double-click the icon to open a pop-up window that allows locking or unlocking, depending on its current state. You are prompted to define a password if you are locking the version, or enter a password if you are unlocking it. When you change the lock status, the version is automatically saved. The icons perform the same functions as the Lock and Save or Unlock and Save buttons. As a best practice, use the Guardrails landing page before locking a version of a RuleSet, and research each warning message, eliminating those you can. Select `> Application > Development> Checked Out Rule` to identify rules that you (or someone else) has checked out in the current application, or in all applications. As developers work, they may request that you create more RuleSet versions and lock (that is, mark as secure) a RuleSet version for which development is complete. Each user or other requestor can access rules in only one major version of a RuleSet. For example, access to version 06-10-15 includes access to 06-10-14 and 06-04-11, but not to 05-01-01. Locking a RuleSet version does not prevent: Changes to class rules in this RuleSet, as a class belongs to a RuleSet but not to a version. Adding or modifying versions in this RuleSet. Modifying this RuleSet. To restrict these actions, use the Define Password settings on the Security tab.
Version	The second key part of the rule.
Description	Short description — initially from the Description field in the New or Save As form.
Approval Required	Select to require a development approval workflow, identified in the RuleSet Name rule, for check in of rules for this version of this RuleSet. See Using the Rule Check-In Flow.
Checked Out	Displays the number of rule instances using this version that are currently checked out. You can click the displayed number to open a window in which you can see the number grouped by rule type. In that window, click the rule type to see the list of checked-out rules for that type, and which operators have them checked out.
All Rules	Displays the number of rule instances using this version. If the number is not zero, click to open, in a separate window, a summary report showing counts by rule type. You can drill down from that report to lists of the rules in a type and then open the individual rules.

Editing a Version

To edit a version, click the Expand icon () to view its details. When you complete your updates, click the Save icon () on the version header. You can also click the Save icon () on the toolbar to save the RuleSet and all versions.

You cannot edit any version if the To Update this RuleSet setting on the Security tab is locked.

Field	Description
Required RuleSets And Versions	Enter one or more RuleSet versions on which this RuleSet version depends, that is, requires as a prerequisite. For example, if you're creating a RuleSet version for an application that will use activities and other rules in HomeSales:04-01-01, enter HomeSales:04-01-01. Enter all three pairs of digits in the version; you cannot enter a partial version here. Typically, your application depends on the entire PRPC product. Enter Pega-ProcessCommander:06-03-nn or include a RuleSet that has this RuleSet as a prerequisite. This prevents the application from being moved with the Import Archive tool into a version 4 or 5.2 system. The system assembles a complete required RuleSet version list from: All RuleSet versions that you list in this field. All lower-numbered RuleSet versions of this RuleSet. All RuleSet versions listed in the Required RuleSet and Versions field for those RuleSet versions that you list in this field. Therefore, if your RuleSet depends on Alpha:02-01-01, and Alpha:02-01-01 depends on Beta:02-01-01, only list Alpha:02-01-01. There's no need to list Beta:02-01-01 because it is already listed in Alpha:02-01-01. When developing rules in this RuleSet version, developers can reference activities and other rules in any RuleSet version in the total RuleSet version list. The system also uses this information during the upload function of the Import Archive tool.
Effective Start Date	Optional. Enter an effective date for the rules in this RuleSet version to support historical processing. Use the format YYYYMMDD or click the calendar icon () to choose a date. This value does not affect normal system operation; rules in this RuleSet version are available before and after the date. If you leave this field blank and save the Version form, the system enters in this field the date that this version rule was created. The Effective Starting value affects processing only for requestor sessions that execute the PublicAPI method setRuleSets() to establish a cutoff date for RuleSets. This function revises the requestor session RuleSet list to exclude RuleSets with an effective date later than a supplied date. To negate or turn off historical processing, call restoreRuleSetList().Your activity can call setRuleSets() multiple times with successively earlier dates, but you can't advance the date. So, to turn on 2005 processing after previously turning on 2003 processing, return to the current date with restoreRuleSetList() first. Such historical processing allows only "as-was" rules to apply (when this field is completed accurately and the setRuleSets() capability is enabled). For example, tax processing performed in 2005 may apply the tax rules in force as of January 1, 2003, if properly configured. Don't enter a future date in this field. A future date does not prevent the rules in this RuleSet version from being found by rule resolution. See Contrasting time-qualified rules, date-time circumstances, and historical processing.
Enter Password to Add/Update Version	This field appears if you have used either the To Add a RuleSet Version or the To Update a RuleSet Version lock settings on Security tab. To unlock the version, enter the password that matches the To Add or To Update password settings. The field is replaced by a checkbox . Make your changes, save the version, and clear the box to lock it again.
View History	Click to display a window containing the history of the RuleSet version.
Lock and Save or Unlock and Save	Click to lock or unlock and save the RuleSet version.
Component Class	This field appears when you select `Component` in the RuleSet Type field on the Category tab and is meaningful only for versions of component RuleSets. The top-level abstract class for the component.
Interface Details	Click this button to define the component entry points and its output properties.
Component Information	A text description of the component.
Component Entry Points	This array lists one or more flows or activities that define the entry points of the component application
Type	Type of entry point rule: `Flow` or `Activity`.
Name	Second key part (Activity Name or Flow Name) of the rule.
Description	A text description of this entry point rule.
Params	Click to access or enter values for flow parameters or activity parameters.
Component Outputs	This array lists one or more property names available to both the primary (calling) application and the embedded application, to return status and results. A Declare Expression rule that automatically copies the property values from the component to the calling application.
Property	Optional. Name of a callback property.
Description	Description of the property.

Using the context menu

Right-click a row to access a context menu, which enables you to perform these functions:

Menu Item	Result
Save As	Create a copy of this RuleSet version with a different version number.
Delete	Delete a version if there are no rules associated with this version. Do not delete the version in a branch RuleSet and then save the RuleSet rule form. After you delete the `01-01-01` version from a branch RuleSet and save the update RuleSet, you cannot add a version to the branch RuleSet. Only delete a branch RuleSet's version if you intend to delete the branch RuleSet.
Rule Data	View the XML document responsible for housing the information within this version. This data is primarily a debugging aid. Use to identify the property names (and the handle) for each property referenced in the rule.
Referencing Rules	View the rules that this version references and the rules that are referenced by this version. See Using the Referencing Rules display.
Favorites	Make this rule a favorite.

Copying RuleSets or versions

Copy RuleSets or versions from the current RuleSet form as follows:

RuleSet— Click on the toolbar. In the Save As form, enter the name of the new RuleSet. The default Version value is 01-01-01, which you can edit. Complete the form as described in Completing the New or Save As form. Click Save As. The system copies the values in the Security, Category, and History tabs. The Versions tab contains the version you specified in the Save As form.

If the To Update This RuleSet setting on the Security tab is locked, the new rule cannot be saved. Provide the password in the To Update This RuleSet field on new rule's Security tab to save the rule.

Version — Select a version row, right-click to access a context menu, and select Save As . In the Save As form, the RuleSet name appears in read-only format. By default, the system increments the new rule Version value by one patch number. For example, a copy of version 01-01-03 increments to 01-01-04. You can modify the default to a higher version. Optionally, edit the version in the Description field. Click Save As.

You cannot copy a RuleSet version to this RuleSet if the To Add a RuleSet Version or the To Update this RuleSet settings on the Security tab are locked. Clear the settings on the tab and save the rule.

Creating RuleSets or versions

Create RuleSets or versions from the current RuleSet form as follows:

RuleSet or version — Click the New icon () on the toolbar. The New RuleSet Version form opens. To create a RuleSet, enter a RuleSet name. To create a version, select a RuleSet from the drop-down list in the RuleSet Name field. Complete the form as described in Completing the New or Save As form.
Version — Click at the bottom of the RuleSet version array. The RuleSet name displays in read-only format on the New RuleSet Version form. The system automatically increments the current version by one patch number. Complete the form and save the rule.

You cannot create a RuleSet version in this RuleSet if the To Add a RuleSet Version or To Update this RuleSet settings on the Security tab are locked. Clear the settings on the tab and save the rule.

Deleting RuleSets and versions

If there are no rules associated with a RuleSet or version, you can delete the RuleSet or version in this form.

To delete a version, select a RuleSet version row in the array and right-click to access a context menu. Click the Delete icon ().
To delete a RuleSet, delete all of its versions as described above and click the Delete toolbar icon ().

If the RuleSet has one or more associated rules, use the RuleSet Delete tool. Select > System > Tools > Refactor RuleSets > Delete a RuleSet to start the tool.

	check in, check out, delegated rules, personal RuleSet, rule management facility
	About the RuleSet Delete tool
	Atlas — Standard RuleSet Names

About RuleSets

RuleSet form Working with the Versions tab

Field

Description

Field

Description

Menu Item

Result

RuleSet form
Working with the Versions tab