|
Designer Studio — Using the toolbarAs a developer, you can review or update rules and data instances. The toolbar in the Designer Studio lets you find, create, change, or delete rules and data instances.
Buttons
The tools and selection boxes on the toolbar vary depending on your role, the type of workspace, and the contents of the form and list area. If a button does not appear or is unavailable (gray), the corresponding function is not available to you in the current context.
Horizontal scroll controls (
or
) appear at the ends of the toolbar when your workspace is not wide enough to display all the buttons that you can use. Click to scroll left, or to scroll right if necessary.
Click an image to learn about its function:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Type picker and Scope box apply to lists
The Type picker and Scope selection boxes appear when the workspace contains a list. These two tools work with Explorers to determine the contents of a workspace list view.
Use the Type Picker () after selecting a single class with the front-most Explorer tool. Use the Type Picker to list either of the following:
- Instances of the class selected in an Explorer
- Rules of any type that apply to the selected class
Click the Type Picker link to choose a rule type or data class. Select a category, then a type within the category.
The Scope box () shows the value All unless the Type Picker is set to a rule type. You can see lists for one Applies To class, or for the Applies To class plus its parent classes.
What each toolbar button does
The toolbar contains only buttons both relevant to the open object and available to you.
For many toolbar buttons, you can type a keyboard shortcut rather than click the button. The help system documents the default keyboard shortcuts; you can change the shortcut keys by selecting the Preferences menu item from the Designer Studio profile menu.
This table describes all buttons:
Option |
Context |
Results |
|
Availability |
Rule |
Opens the Availability dialog to change the availability of this rule. Select |
|
Rule |
For a checked-out rule in your personal RuleSet, copies the modified instance over the original instance in the public RuleSet. |
|
|
Rule |
Creates a copy of a rule in your personal RuleSet, and marks the original rule as checked out with a padlock (
Shortcut: Checkout is not possible for a few rule types, such as class rules.  top
|
|
|
Rule |
For a rule in a locked RuleSet in an application that has branches, opens the Check Out Rule to Branch dialog to save a copy of the rule into a branch RuleSet and check out that rule. In the Check Out Rule to Branch dialog, select the branch into which you want to save the rule and click Check Out to Branch. The system:
The Check-out-to-Branch toolbar button appears when all of the following conditions are true:
If you subsequently click Delete Checked Out ( Check out to branch is not possible for a few rule types, such as class rules. top
|
|
|
Rule or Data |
Deletes a rule or data instance. See Understanding the toolbar Delete operation. Shortcut: |
|
| Delete Checked Out |
Rule |
Deletes a checked-out rule from your personal RuleSet. The original, unchecked-out rule is not affected. See Understanding the toolbar Delete operation. Shortcut: CTRL + D |
|
Rule |
Delegates a rule using the My Rules facility. This button is visible to developers who hold the privilege @baseclass.ToolbarFull. See How to delegate a rule and favorite. |
|
| All |
Accesses a topic in this help system relevant to the currently displayed rule or data form. Shortcut: |
|
| Rule or Data |
Moves the current rule or data form into a separate, floating Internet Explorer window with a copy of its toolbar. This action lets you compare two forms, or work with a source of information or values in the main portal window and paste them into another window. The toolbar button changes to Reattach ( This button is visible to developers who hold the privilege @baseclass.ToolbarFull. The Preview button is not available in the toolbar of a window opened with the Launch button. |
|
|
Rule or data |
Creates a new rule or data instance. Click This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarNew. |
|
| 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 (
The Preview capability is not available on a window opened with the Launch button ( |
|
| Private check in |
Rule |
For a privately checked-out rule 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. After you have performed a private check out, this button appears if the conditions that allow the rule to be checked into an unlocked destination (such as the corresponding base rule is not checked out to another person and a corresponding unlocked base RuleSet version or branch RuleSet is available). top
|
| Private check out |
Rule |
Creates a copy of a rule in your personal RuleSet. Displayed when the following conditions are true:
Similar to a standard check out, a private check out is not possible for a few rule types, such as class rules. top
|
| Reattach |
After Launch |
After Launch only. Closes the launched window and consolidates any open forms in the launched window with the main window. |
|
After delete |
Recovers the most recent version of a deleted rule, if the RuleSet and version is unlocked. See How to recover (undelete) a deleted rule. |
|
| Related Rules |
Rule |
Lists rules related to the current rule. Click to display a menu that lists lower-numbered versions of the currently open rule, circumstance-qualified and circumstance-date qualified versions, and additional menu items. This button is visible to developers who hold the privilege @baseclass.ToolbarFull. See Using the Related Rules menu. |
|
Rule History |
Lets you replace the current copy of a rule with an older, previously checked-in copy of that rule. This button provides is a form of "undo", because it lets you back out changes. Restore is available only for rules in RuleSets with check-in. This button is visible to developers who hold the privilege @baseclass.ToolbarFull. See How to restore the earlier state of a rule. |
|
|
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 button is visible to developers who hold the privilege @baseclass.ToolbarFull.
Shortcut: |
|
|
Rule |
Starts execution or testing of the current rule, in the current context. See Unit testing with the Run toolbar button. Shortcut: This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarRun. |
|
|
Rule or Data |
Saves the instance to the persistent PegaRULES database. Enabled only when you can save. Shortcut: |
|
|
Rule or Data |
Saves a copy of the instance with a different key, or with the same key but different rule-resolution values. This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarSaveAs. See How to enter rule keys using Save As. For many types of rules, you can complete the circumstance fields and the time-qualified fields in the Save As dialog box. Circumstance and time-qualified capabilities don't apply to data instances.
Shortcut: |
|
| 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 button 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. |
). No one else can check out a rule while it is checked out. The Check-out toolbar button appears when all of the following conditions are true:
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.
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 click the RuleData button again.
)