You are here: Designer Studio > Developer tools > Clipboard

  About the Clipboard tool

Use the Clipboard tool when developing and debugging to:

Basics

Click the Show Clipboard icon in the Designer Studio developer toolbar. The tool appears in its own window. It resides in memory on the server. As you interact with the Clipboard tool at your workstation, you see a static snapshot copy.

The Clipboard tool displays two panels:

To interact with your clipboard:

  1. Select a Thread from header. The current thread name appears next to the Show Clipboard Clipboard title. Select the name to display a list of open Threads and change the Thread context. Each open tab on the Designer Studio has a dedicated Thread. Thread names correspond to their tab names; work item Threads are identified by their IDs.
  2. Interact with the tree structure in the left panel to select a page, list, or group.
  3. Review or interact with the right panel.

As you work, the system creates and updates clipboard pages related to your work. However, these changes are not automatically reflected in the Clipboard tool display. You can send the latest clipboard contents to your workstation as follows:


The left panel

The left panel presents the entire clipboard as a tree, growing from the left.

Four types of pages are grouped for quick access: User Pages, Data Pages,Linked Property Pages, and System Pages. Also displayed are AccessGroup, Application and OperatorID pages that are created during authentication.

Click a name or expand arrow to display any node in the left panel to view the page structure it contains. Click again or click a collapse arrow to conceal the pages within a page.

If one of the User Pages holds a work item, that page is initially selected in this panel, and details for that page appear in the right panel.

For additional information, see Help — Using the Clipboard tool.

The right panel

When you select a page in the left panel, all Single Value properties on that page appear in the right panel, sorted by property name. Use the left panel to click the page (either top-level or embedded) that contains the property. Property messages appear in red text.

Measuring the size of the clipboard

The Clipboard display shows the contents of the clipboard, but not its size in bytes. Large clipboards can affect performance because memory in the Java Virtual Machine supporting PRPC holds the clipboards of all requestors.

What properties don't appear?

The Clipboard does not display properties with names that start with pz. Such standard properties support internal PRPC operations.

To see pz properties and other clipboard entries that aren't truly properties, right-click in the left panel and select Show XML. To see the contents of unnamed pages, use the Tracer.

The primary pages of some activities are not named and don't appear on the Clipboard display. The parameter page of an activity is not part of the clipboard. Use the Tracer to view such pages.

Properties of mode Java Object, Java Object Group, and Java Object List do not appear on the Clipboard tool display.

The Application page contains much, but not all, of the properties that make up the requestor's application rule.

Privileges required

The Clipboard tool is available only to users who have access to the @baseclass.clipboardViewer privilege. Action menu items that update the clipboard contents are available only to users who hold the @baseclass.clipboardViewerUpdate privilege.

The standard access role PegaRULES:SysAdm4 provides these privileges.

Debugging with the Clipboard tool

Several methods manipulate the clipboard. As you execute activities that affect your clipboard, you can examine the results with the Clipboard tool.

For example, when you execute an activity that contains a Page-New method, you can see the resulting named top-level page in the User Pages section. If you execute an activity that uses the Property-Set method (on a named clipboard page), you can see the new values.

Named Pages and Data Pages landing page tabs

The Named Pages landing page tab summarizes the named pages referenced by the rules in the current and built-on applications.

The Data Pages landing page tab summarizes the data pages referenced by the rules in the current and built-on applications.

Select > Data Model > Clipboard Pages > Named Pages or Data Pages to access these tabs.

Mobile Clipboard

Pega Mobile offers a clipboard view similar to the Designer Studio clipboard that you use on your Safari desktop emulator. Useful for trouble-shooting and debugging your mobile application, the clipboard is grouped by User, Declare, Linked Property, and System pages.

The Mobile Clipboard is available only to users who have access to the @baseclass.clipboardViewer privilege. The access roles PegaRULES:SysAdm4 and PegaRULES:ProArch4 provide these privileges.

In the Safari desktop emulator, access the clipboard by using a tap and hold gesture on the mobile application. Display clipboard for the main content panel and modal/overlay windows. Tap and hold does not display the clipboard for the main navigation panel, the toolbar menu, or a menubar in a section. You can also add the clipboard as a navigation menu item.

See PDN article Mobile Clipboard.

Definitions embedded page, page message, process page, property message, reference property, requestor page, Thread, top-level page, user page, linked properties
Related topics About the Performance tool
Data Model category —Clipboard Pages page, Named Pages and Data Pages tabs
Understanding page names and reserved pages
Debugging with the Tracer
Page-New method

Property-Set method

Using the Clipboard tool