Back Forward Designer Studio — Using the toolbar

As 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.

TipHorizontal scroll controls (Scroll LeftorScroll right) appear at the ends of the toolbar when your workspace is not wide enough to display all the buttons that you can use. ClickScroll Left to scroll left, orScroll right to scroll right if necessary. PROJ-161 RULE-178

Click an image to learn about its function:


New Save Save As Delete Type picker Rule Data Availability Check In Check Out       Undo
Recover   Return   Scope selection box   Flow Editor Draft Mode Launch Related Rules Run Help Delete Checkout
Show Java Favorites Restore Preview   Zoom In Zoom Out Visio tools Reattach  

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 (Type picker) after selecting a single class with the front-most Explorer tool. Use the Type Picker to list either of the following:

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 (Scope selection 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

AvailabilityAvailability

Rule

Opens the Availability dialog to change the availability of this rule. Select Yes, No/Draft Mode, Final, Blocked, or Withdrawn to set the availability of this rule. See available rule and How to change availability of a rule.

toptop

Check in
Check In

Rule

For a checked-out rule in your private RuleSet, copies the modified instance over the original instance in the public RuleSet.
Shortcut: CTRL + ALT + C
toptop

Check outCheck Out

Rule

Creates a copy of a rule in your private RuleSet, and marks the original rule as checked out with a padlock (checked out). 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:

  • A rule that is not checked out appears in the workspace.
  • The rule belongs to a RuleSet that has the rule management facility enabled
  • For this operator, the Allow rule check out? checkbox (on the Security tab of the Operator ID form) is selected.

Shortcut: CTRL + ALT + C

Checkout is not possible for a few rule types, such as class rules. REMOVED MARTT 2/2/509. Also, you can't check out a circumstance-qualified rule if the base rule is checked out. Also, you can't check out a rule that belongs to an override RuleSet. BUG-1755

toptop

Draft Mode
Draft Mode

Flow rule

Indicates that task shapes in this flow rule may reference activities, flow actions, or other objects not yet defined. Click this button to turn on draft mode. Click again to remove draft mode.

toptop

Delete
Delete

Rule or Data

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

Shortcut: CTRL + D

toptop

Delete Checked Out Delete Checkout

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

toptop  

Favorites
Favorites

Rule

Delegates a rule using the My Rules gadget. This button is visible to developers who hold the privilege @baseclass.ToolbarFull. R-6375 See How to delegate a rule and favorite.
toptop

Flow Editor
Flow Editor

Flow rule

Starts Visio to edit the flow. When you finish editing in Visio editing, click the Return button (Return) to leave Visio. Then save the updated flow rule.

toptop

Help
Help

All

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

Shortcut: CTRL + H
toptop

Launch
Launch

Rule or Data

C-1232 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 (Reattach ). Click to close the launched window. BUG-633 tooltip

This button is visible to developers who hold the privilege @baseclass.ToolbarFull. REMOVED MARTT 2/25/09 The Launch button is not available for harness, section, or flow action rules. B-20226C-2346 The Preview button is not available in the toolbar of a window opened with the Launch button. B-20220

Shortcut: CTRL +L
toptop

New
New

Rule or data

Creates a new rule or data instance. Click New, then select a category and a rule type or data class. See Completing the New rule dialog box.

This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarNew. C-2346

Shortcut: CTRL +N
toptop

Preview
Preview

Rule

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

You can previews harness, section, control, activity, flow action, HTML, edit input, edit validate, property rules (Single Value mode only), and flow rules. This button is visible to developers who hold the privilege @baseclass.ToolbarFull or C-2346@baseclass.ToolbarPreview.

CautionUsing 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. F-174 APAP SR-866 GROVS 10/11/05

The Preview capability is not available on a window opened with the Launch button (Launch). B-20220

Shortcut: CTRL +ALT + P

toptop

Reattach
Recover
After Launch

After Launch only. Closes the launched window and consolidates any open forms in the launched window with the main window. PROJ-161 Rule-286

toptop

Recover
Recover

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.

toptop

Related Rules
Related Rules
Rule

C-1282 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. C-2346 See Using the Related Rules menu.C-2444

toptop

Restore

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. C-2346 See How to restore the earlier state of a rule. C-254

toptop

Return
Return

Flow rule

Exits Visio and returns to normal editing mode. Click Save Save to save your changes to the flow rule.

toptop

RuleData
Rule Data

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. C-2346 B-20434

NoteIf 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. SAPNA 1/30/04

Shortcut: CTRL +ALT+Z

toptop

Run
Run

Rule

Starts execution or testing of the current rule, in the current context. See Unit testing with the Run toolbar button. Shortcut: CTRL +R.

C-1493This button is visible to developers who hold the privilege @baseclass.ToolbarFull or @baseclass.ToolbarRun. C-2346

toptop

Save
Save

Rule or Data

Saves the instance to the persistent PegaRULES database. Enabled only when you can save.

Shortcut: CTRL +S

toptop

Save As
Save As

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. C-2346 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.

Note As a best practice when creating classes and properties, use New (New) rather than Save As, because some fields on the Class and Property forms can't be altered after you save the form.

Shortcut: CTRL +ALT+S

toptop

Show Java
Show Java

Rule

C-1665 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. C-2346 Available for activities, when condition rules, and stream rules, among others. See Process Commander for Java developers. BUG-2539

toptop

Undo
Undo
Flow

Undoes the most recent Visio operation; equivalent to CTRL + Z.
toptop

Visio Tools
Visio tools
Visio

Displays or hides Visio toolbars during Visio editing.

toptop

Zoom In
Zoom in
Flow

Zooms in on the Visio diagram, to make the diagram larger.

toptop

Zoom Out
Zoom out
Flow

Zooms out from the Visio diagram, to make the diagram smaller. toptop

Related topics Troubleshooting — Cannot update rule

UpDesigner Studio basics