Using the rule and data form toolbar

Option

Record type

Results

Save

Rule or Data

Save the current edits on the form to the PegaRULES database. Saved edits persist after closing and reopening the form. Enabled only when you can save.

Save As

Rule or Data

Opens the Save As form. Use when you want to copy a record.

This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarSaveAs.

See Completing the Save As form.

As a best practice when creating classes and properties, create a new record rather than Save As or Copy, because some fields on the Class and Property forms can't be altered after you save the form.

Save As >Specialize by class or ruleset

Opens the Specialization form. Use when you want to move a rule to a different ruleset or class in your application layer.

See Completing the Specialization form.

Opens the Specialization form. Use when you want to create a circumstanced version of a rule using the time-qualified fields, properties and/or templates.

Opens the Create Specialized Version form. Create a circumstanced version of a rule that uses a property value. This action is available for base or non-circumstanced versions of rules.

See Completing the Specialization form and About Circumstance Template rules.

Check in

Rule

For a checked-out rule in your personal RuleSet, copies the modified instance over the original instance in the public RuleSet. See check in. Also releases the lock so other operators may use the Check out action. Enter a comment that briefly describes your modifications.

If your application is enabled for Project Management tracking and a communication link is active between an instance of the Project Management Framework, select a PMF item and enter a comment.

Private edit check in

For a privately checked-out rule (see Private Edit below) in your personal RuleSet, opens the Check In Rule dialog so that you can copy the modified instance to a specified unlocked destination. If the destination is the RuleSet from which the rule was originally checked out, the modified instance replaces the original instance in the public RuleSet.

Check into a branch

If you check into a branch and the branch RuleSet does not exist, the system automatically creates the branch RuleSet.

Check Out

Rule

Creates a copy of a rule in your personal RuleSet. No one else can check out a rule while it is checked out. The Check Out button appears when all of the following conditions are true:

• The rule belongs to a RuleSet that has the checkouts enabled.
• For this operator, the Allow rule check out checkbox (on the Security tab of the Operator ID form) is selected.
• The rule is not locked by another user or in a locked RuleSet.

See check out.

Other operators may use Check out to branch or Private Edit until you release the lock.

A locked rule displays a padlock next to the Check Out button. Hover the mouse pointer over the icon to see the reason it is locked.

Checkout is not possible for a few rule types, such as class rules.

Check Out

> Check out to branch

Rule

Available for an application that has branches. Opens the Check Out to Branch dialog , which allows you to save a copy of the rule into a branch RuleSet and check out that record.

In the Check Out to Branch dialog, select the branch into which you want to save the rule and click Check Out to Branch. The system:

1. Saves a copy of the rule into a branch RuleSet.
2. Creates a copy of that rule in your personal RuleSet.
3. Marks the rule in the branch RuleSet as checked out.

The Check-out-to-branch menu option appears when all of the conditions for Check Out are true and there is a branch defined in the current application.

If you subsequently Discard the checked-out rule, the copy of the original (source) rule created by the system in the branch RuleSet remains in the branch RuleSet.

Check out to branch is not possible for a few rule types, such as class rules.

Check out to branch

Appears on a record that is locked by another user or is in a locked RuleSet and there is a branch RuleSet defined in the application. See description for Check Out > Check out to branch.

A locked rule displays a padlock next to the Check out to branch button. Hover the mouse pointer over the icon to see the reason it is locked.

See Branches and Branch RuleSets.

Delete

Rule or Data

Deletes a rule or data instance. See Understanding the delete toolbar operation.

Discard

Rule

Deletes a checked-out rule from your personal RuleSet. The original, unchecked-out rule is not affected. See Understanding the delete toolbar operation.

Private edit

Rule

Creates a copy of a rule in your personal RuleSet. Displayed when the following conditions are true:

• You have the pxAllowPrivateCheckout privilege (typically granted through a role on your access group). The standard access role PegaRULES:SysAdm4 provides this privilege.
• The rule is not available for regular checkout, usually because it is already checked out to another person or because its RuleSet version is locked.
• The rule belongs to a RuleSet that has the checkouts enabled.
• In your operator ID form, the Allow rule check out checkbox (on the Security tab) is selected.

Similar to a standard check out, a private edit is not possible for a few rule types, such as class rules. See check out.

A locked record displays a padlock next to the Private edit button. Hover the mouse pointer over the icon to see the reason it is locked.

Use the Check In button to check in your copy.

Restore

Rule

History

Performs either of two actions, depending on the context:

• Lets you replace the current copy of a record with an older, previously checked-in copy of that record. This button provides a form of "undo", because it lets you back out changes. Restore is available only for rules in RuleSets with check-in. See How to restore the earlier state of a rule.

• After deleting a record, recovers the most recent version of a deleted rule, if the RuleSet and version is unlocked. See How to recover (undelete) a deleted rule.

This button is visible to developers who hold the privilege @baseclass.ToolbarFull.

Actions > Add to Favorites

Rule

Delegates a record using the My Favorites facility.

This menu is visible to developers who hold the privilege @baseclass.ToolbarFull. See How to delegate a rule and favorite.

Actions > Create

Rule or Data

Creates a new rule or data instance of the type currently open. See Completing the Create form.

This menu is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarNew.

Actions > Create > rule category > rule type

Rule or Data

Create a new rule or data instance by selecting a rule type or data class from a list of rule or data type class categories. See Completing the Create form.

This menu is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarNew.

Actions > Preview

Rule

Splits the workspace to present a partial preview of the runtime appearance of a rule in the bottom half of the workspace.

You can preview harnesses, sections, controls, activities, flow actions, HTML rules, edit input rules, edit validate rules, properties (Single Value mode only), and flows. This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarPreview.

Using the Preview function for a harness, section, flow action, activity, or HTML rule creates a clipboard page and initializes properties on that page. In turn, the initialized properties may start declarative processing. Accordingly, use caution before implementing any on-change declarative processing that updates a database.

Actions > Run

Rule

Starts execution or testing of the current rule, in the current context. See How to unit tests a rule with the Run Rule feature.

This menu is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarRun.

Actions > Get Help

Rule or Data

Accesses a topic in this help system relevant to the currently displayed rule or data form.

Actions > View versions

Rule

Display the versions of the rule, their availability, and their circumstance. Click an item to open the rule form.

Not available on rules that are not versioned such as applications, classes, and RuleSets.

Actions > View references

Rule or Data

Choose the menu item to access a list of other rules that reference the current open rule, and other rules that the current rules reference. See About the Referencing Rules display.

This menu is visible to developers who hold the privilege @baseclass.ToolbarFull. See Using the Related Rules menu.

Actions > View siblings

Rule or Data

View the results of a complete search for siblings to this rule. See How to find and understand sibling rules.

Actions > View XML

Rule or Data

Shows the XML document that makes up the form displaying this instance. This is primarily a debugging aid. Use to identify the property names (and the handle) for each property referenced in the form. This menu is visible to developers who hold the privilege @baseclass.ToolbarFull.

If you have modified and saved the rule or data form, this information may be out of date. To see updated information, close the form, open the same rule or data object again, and select View XML again.

Actions > View Java

Rule

After a rule is saved, presents in a new window an approximation of the generated Java to be created by this rule instance. You cannot alter this Java code.

This menu appears for developers who hold the privilege @baseclass.ToolbarFull. Available for activities, when condition rules, and stream rules, among others. See PRPC for Java developers.