Help: Using the Clipboard tool

Your clipboard resides in memory on the server. As you interact with the Clipboard tool at your workstation, you see a static snapshot copy. Choose Refresh from the Action menu at any time to update the snapshot.

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

Click a name or plus sign () to expand any node in the left panel to view the page structure it contains. Click again or click a minus sign () to collapse (hide) the pages within a page.

The clipboard contains two groups of pages:

• User Pages — Top-level pages created by your normal processing, sorted alphabetically by page name.
• Declared Pages — Read-only declarative pages (created if necessary when accessed, defined by declare pages rules (Rule-Declare-Pages rule type).

Three top-level pages are always present:

• pxThread — A single system-maintained page known as the Thread page.
• pxRequestor — A single system-maintained page known as the requestor page, which contains information about your access roles, RuleSet list, and HTTP protocol parameters.
• pxProcess — A single system-maintained page known as the process page, which contains information about the server's Java Virtual Machine and operating system.

Other top-level pages are created during authentication. These correspond to the organization, division, access group, application rule, and organization unit of the operator. These pages are not present for guest users. 3/10/06 clinic

Each top-level page may contain other pages that in turn may contain other pages, and so on. For most pages, the class of the page appears in parentheses after the page name and a single space. (For group and list properties, additional parentheses appear around subscripts.)

Every embedded page is defined by a property. Properties of mode Page ( icon), Page Group(), and Page List () may appear as embedded on the clipboard. Pages may contain properties (of any mode) and messages.

The branch structure of the tree in the left panel directly corresponds to the fully qualified name of a property reference. For example, the property reference:

pyWorkPage.pxFlow(VacationRequest).pyConfirmationNote

identifies a Single Value property named pyConfirmationNote embedded on a page () named pxFlow("VacationRequest"), an element of a Page Group() named pxFlow on the top-level user page named pyWorkPage.

The icon and red text identifies page messages.

Square brackets and the term [Refers to ..] indicate a reference property. The text in the square brackets identifies the non-reference page.

When you select a page in the left panel, all Value List, Value Group, and Single Value properties on that page appear in the right panel, sorted by property name. Property messages appear in red text.

Use the left panel to click the page (either top-level or embedded) that contains the property.

You cannot directly search through the clipboard for a property.

If you don't know what page contains a property: DOCUMENTATION IS IN PROGRESS

1. Use the Designer Studio Search facility to list properties containing the name as a key part.
2. Review any properties on this list.
3. Identify the Applies To key part of the property you seek.
4. Return to the Clipboard tool display. Click the plus signs () on in the left panel to find a page with that class. Class names appear within parentheses following the page name.
5. Select the page to display the contents of that page.

For a value

To find properties containing a known text value:

1. Select Find from the Action menu.
2. Type the text that is the full or partial value of the property.
3. In the Pages box, select a page name or All Pages.
4. Click  Go . B-13157

Some clipboard values are Base64-encoded text representing binary objects, such as JPG image files, Word DOC files, or compiled programs. You can't search for a word that appears on the image or within the DOC file. B-14750

For a property

You cannot directly search the clipboard for a property name.

1. Use the Designer Studio's Search facility to identify the Applies To class of the property. Enter the property name. See Designer Studio — Using the Search facility.
2. Review any properties found with that name.
3. Identify the Applies To key part of the property you seek.
4. Return to the Clipboard tool display. Click the plus signs () on in the left panel to find a page with that class. Class names appear within parentheses following the page name.
5. Select the page to display the contents of that page.

Page Messages

Below each page in the left panel, find the Page Messages link (). Click Page Messages to view any messages associated with properties on that page. Generally, a message indicates that a property value is invalid.

In addition to the Page Messages page, messages may appear immediately below a property. For example, if you see message(1) below a property, the property value is not valid.

Property Messages

Property messages appear in the right panel in red text.

The Clipboard display doesn't include properties with names that start with pz. These standard properties support internal operations.

If your requestor has multiple threads, use the Thread menu to select which Thread (and so which clipboard) you are viewing. Often, your requestor has only the single thread Standard. 5.4

Use the Action menu to test a rule without the need to create a test activity that creates the pages and properties expected as starting conditions for the rule.

Changing your clipboard contents or structure may affect the integrity of your system or your application results. Change clipboard values with this tool only in a debugging situation. Deleting pages or saving altered pages may introduce invalid data into the database.

Action menu options that update the clipboard are available only to users who have the hold the clipboardViewerUpdate privilege. KHATV 8/17/06

Refresh to present current information

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. Select Refresh from the Action menu to send the latest clipboard contents to your workstation.

Viewing pz properties

The Clipboard display doesn't include properties with names that start with pz. These standard properties support internal system 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.

What properties don't appear?

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 these pages.

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