Back Forward Harness, Section, and Flow Action forms
Adding a Link control

About Harness rules

  Show all 

A header or layout cell can contain a Link control (formerly called a URL control), which invokes an action when the user clicks or hovers the mouse pointer over the text link. This and the Icon and Button controls share the same capabilities — the differences are mainly in their presentation. V6.2 GRP-16579 pashm

You can customize the link's appearance using the Branding wizard. See Branding wizard — Controls.

You can precede and follow a URL cell with static text in Label cells, achieving a presentation similar to an embedded link in a Web page:

You can recompute the interest due on this loan.

As of V6.2, the Link control uses the auto-generated control rule pxLink. Its behavior is governed by the settings in the rule form's Control tab. The Parameters tab is not available and the HTML cannot be edited. As a best practice, modify the control using its Parameters dialog within the context of the section; do not edit the rule itself.

This control replaces the V5.1x URL control (supported in V6.X). It is recommended that you use pxLink in new development rather than the V5.1x URL control (which is supported). See About the URL control V5.1x.

Follow these instructions to add a Link control.

  1. Drag and drop the Link control

Click the down arrow (Menu) in the Basic control group (Basics) and select the Link control (Button) Drag the control to the desired cell. When the pointer changes shape to indicate that a single cell is selected, release the mouse button to drop the control. xxxicon to change for v6.2xxx. 2/26/11 pashm

If the cell is not empty, the dropped control replaces the current contents of the cell. Click the magnifying glass icon (Magnifying glass) to display the Cell Properties panel.

Complete the Cell Properties panel that appears. If the panel is pinned (Pinned), the wireframe presentation on the rule form changes immediately to reflect of your inputs. If the panel is not pinned (not pinned), click Apply to apply your inputs.

  2. Complete the Cell Properties panel — Top fieldsGRP-229

Field

Description

Pencil

(Appears only when this field is in a section included within the current open rule.) Click to open the section that immediately contains the field.

Control

The default pxLink control rule appears. The default label is "Link." Click the pencil icon (Pencil) to review the control rule identified in this field.

Customizing the control

The Link's default parameters represent the basic configuration. However, you will need to specify the text in the link and the action or actions that will execute when the user clicks or hovers the mouse pointer over the text. For example, you can configure the control to refresh a section or display a new harness. In addition, you may want to:

  • Apply a style designed in the Branding Wizard, or add a tooltip.
  • Add conditions that, for specific users, disable or hide the link.
Your edits apply only to the link within the context of the section that contains it and do not update the underlying rule. See Control Form — Completing the Control tab for descriptions of the available parameters and how to define behaviors.

Do the following to customize an auto-generated control rule in a section:

  1. Open the section or harness that contains the rule.
  2. Select the cell containing the rule and open its Cell Properties panel.
  3. In the panel, select the magnifying glass icon () next to the Control field. This displays the control Parameters dialog, which contains most of the settings in the underlying rule's Control tab. (You cannot edit the rule form's Control Modes and UI Element settings from here.)
  4. Modify as necessary. To immediately render your changes, click OK in the dialog. If satisfactory, save the section. The system generates the XML representing your edits and stores it in the section.

  3. Complete the Cell Properties panel — General tab

Complete the General tab.

Field

Description

Visible Select to determine when the link appears. (If this setting is not applicable, the cell contents are blank.)
  • Choose Always to have the link appear or be hidden based on the visibility of the enclosing section or flow action when the form is first presented or is refreshed. This condition is checked only once.
  • Choose Other Condition to make the visibility depend on a when condition rule, a Boolean expression evaluated only once, or a test evaluated repeatedly upon JavaScript events. C-1990 B-21692
Visible When

SmartPrompt If you selected Other Condition for the Visible field, complete this field. Enter an expression involving another property, or identify the When Name key part of a when condition rule. PROJ-283 Specify one of three outcomes:

  • When condition rule — Enter the When Name key part of a when condition rule that determines the visibility of this field at runtime. The system uses the Applies To key part of the current rule in rule resolution to locate the when condition rule. Click the pencil icon (Pencil) to review or create the when condition rule.
  • Expression evaluated once — Enter an expression that returns true or false. This expression can involve multiple properties, function calls, and other syntax as supported by the <pega:when > JSP tag.
  • Simple Java expression evaluated upon JavaScript events — To dynamically control the visibility of this property with a JavaScript event, enter a simple comparison involving a target property and select the Run on Client? box. The result at runtime determines whether the content of this cell appears in read-only mode or in the mode of the enclosing layout.
    For example, enter .Color =="Blue" in this field to make this field visible when the property Color has the value Blue, and invisible otherwise. Depending on the state of the Run on Client checkbox, the comparison can be executed only once as the form is initially displayed, or dynamically. See Implementing dynamic form actions and the Client Event Editor. C-1990

A URL that is not visible is also disabled and cannot be clicked.

Wrap Text?

Select to cause the text to wrap within the cell. B-17946

Disabled? Select to cause the URL to be disabled or enabled based on a test, even when the form is in read-write mode. Complete the next field to modify the effect of this checkbox. PROJ-283 MARTT 2/26/07
Disabled Condition

SmartPromptOptional. This field appears only when you select the Disabled? checkbox. Enter an expression involving another property, or identify the When Name key part of a when condition rule. PROJ-283 Specify one of four outcomes, where true or blank means the link is disabled.

  • Leave blank to present the link as disabled always, regardless of the mode of the enclosing layout.
  • When condition rule evaluated once — Enter the When Name key part of a when condition rule that determines the mode of this link at runtime. The system uses the Applies To key part of the current rule in rule resolution to locate the when condition rule, and executes the when rule once as it renders the form. Click the pencil icon (Pencil) to review or create the when condition rule.
  • Expression evaluated once — Enter an expression that returns true or false. This expression can involve multiple properties, function calls, and other syntax as supported by the <pega:when > JSP tag.
  • Simple Java expression evaluated upon JavaScript events — To dynamically control the mode of this link with a JavaScript event, enter a simple comparison involving a target property and select the Run on Client? box. The result at runtime determines whether the link appears as disabled.

    For example, enter .Color =="Red" in this field to disable this link at runtime when the property Color has the value Red, and enabled otherwise. Depending on the state of the Run on Client? checkbox, the comparison executes only once as the form is initially displayed, or dynamically. See Implementing dynamic form actions and the Client Event Editor. C-1990
Run on Client? Appears if the Condition field contains a simple Java comparison.

Select to cause dynamic execution of the condition each time the value of the property mentioned in the condition changes. (Mark the field containing that property as a Client Event.) Leave cleared to cause the condition to execute only once, upon initial presentation of the form.

  4. Complete the Cell Properties panel — Advanced tab

Complete the Advanced tab.

Width

TipAs a best practice, use SmartLayouts to achieve uniform width of cells throughout your application's forms. You can set the width of SmartLayout templates using the Branding wizard.

Optional. This field appears only when the cell is not controlled by SmartLayout column restrictions. Enter a positive number for the width in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed width.) You can also adjust the width this column directly:

  1. Click a vertical wireframe cell border.
  2. Wait until the pointer shape changes (drag), then drag the border. PROJ-281
Height

TipAs a best practice, use SmartLayouts to achieve uniform height of cells throughout your application's forms. You can set the width of SmartLayout templates using the Branding wizard.

Optional. This field appears only when all columns in the Layout are not controlled by SmartLayout column restrictions (that is, all columns have the None template). Enter a positive number for the height in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed height.) You can also adjust the height of a row directly:

  1. Click a horizontal wireframe cell border.
  2. Wait until the pointer shape changes (drag), then drag the border. PROJ-281
Privilege

SmartPrompt Optional. Select the Privilege Name key part of a privilege rule that controls the availability of this link at runtime. During rule resolution at runtime, the system uses the Applies To key part of the current rule as the first key part.

At runtime, the link is not available to users who do not hold this privilege.

Click the pencil icon (Pencil) to review or create the privilege rule.

Read-Write Style

SmartPrompt Not used.

Read-Only Style

SmartPromptOptional. By default, when the work object form or flow action form appears in read-only mode, the CSS style named LabelValueRead applies. You can enter another style name or select from those listed.

Click the pencil icon (Pencil) to review the text file rule that defines the style sheet. Your application can override the standard style sheet in the text file rule webwb.user_work_form.css.

Use Heading Style

Select to change the style of this value to a table header style (by changing the element from <TD> to <TH>).

Inline Style To apply inline styling to this cell only, type a CSS style definition in this field, or click the magnifying glass to access a Style Editor window. Styles you enter in this field supplement and override style elements defined in style sheets, according to normal CSS rules.

Inline styles are recorded in the generated HTML for the form; they do not alter the CSS definitions.

Using the Style Editor

You can select the font, color, font size, text align, vertical align PROJ 242 – TASK 16156, borders, margins, and other attributes of this cell using selection lists. The Style Editor maintains a preview of the resulting presentation. If you alter the style definition directly, click  Apply   to update the preview.

Click  OK   to record the style defined with the Style Editor in the panel.

Up About Flow Action rules

Up About Harness rules

Up About Section rules