Back Forward HTML Property form
Completing the HTML tab

 Contents About HTML Property rules

You can enter HTML source directly into the HTML Source text area. Alternatively, click the pencil icon (Pencil) to open your HTML editor.

Field

Description
Omit extra Spaces?

Select to eliminate extra space characters in the processed HTML. This can make transmission or processing more efficient. Is does not alter the appearance of the HTML when displayed in a browser.

When selected, during stream processing the system:

  • Deletes control characters such as tab and newline.
  • Replaces two or more consecutive space characters with a single space, except within the curly brace characters defining directives.

Stream processing always copies space characters within the text of a property value, non-breaking spaces ( ) and space characters within a literal directive into the processed HTML without change.
Property Type

Optional. If this HTML property rule is a likely choice for presenting a field on a work object form or flow action form, you can select a type or ALL in this field.

Your choice helps a developer — while working on a harness, section, or flow action rule — select an alternate HTML format for a property that is best suited to the application need. This value acts only as a filter; it does not prevent this HTML property rule from being referenced by any property rule. (The Double type is not an option for this field.)

If not blank, the name and two previews (read-write mode and read-only) of this HTML property rule appear on the pop-up list accessed by the magnifying glass button (magnifying glass)on the Cell Properties panel, for Harness, Section, and Flow Action forms (in the SmartFrames format). For example, if the property type is a Date or DateTime, see Harness, Section, and Flow Action forms — Fields — Adding a Date control.

AdvancedThis field is intentionally blank on few standard HTML Property rules including AutoComplete, ListToList, and Chart that are never intended to be associated with a single property on the Property form. These special HTML Property rules support advanced features available from the Layout tabs of the Harness and Section form and the Format tab of the Flow Action form.
Display

Optional. If this HTML Property rule is a likely choice for presenting a field on a work object form or flow action form, you can select a format here. Your choice helps a developer — while working on a harness, section, or flow action rule — select an alternate HTML format for a property that is best suited to the application need. This acts only as a filter; it does not prevent this HTML Property rule from being referenced by any property rule:

  • Select Input Field if the field is likely to be presented by an HTML element <INPUT TYPE = "INPUT" ...>
  • Similarly, select Select if the field can be represented by an HTML selection list, corresponding to the element <HTML INPUT TYPE="SELECT" ...>
  • Select Radio Button or Text Area if the corresponding HTML elements are likely to apply.

If not blank, the name of this HTML property rule appears on the pop-up lists accessed by the magnifying glass on the Field panel, for Harness, Section, and Flow Action forms (in the SmartFrames format only).

INPUT element

When you use an INPUT element for a text box, check box, selection box or text area in the HTML text of an HTML Property rule, use this JSP syntax:

<INPUT name=""<pega:reference name=""$this-name"" />""

(When using directives, you can omit the NAME attribute and its value. The system determines the NAME and value from the property rule that references your HTML Property rule.)
Generate For

This field and the Convert to JSP button appear only when the rule contains HTML directives rather than JSP tags. The value that appears is HTML.

TipAs a best practice, use JSP tags rather than directives. In most cases, you can convert HTML property rules that use directives to JSP tags automatically, using the button.

HTML property rules that accept parameters must use JSP tags. See Converting from directives to JavaServer Page tags.

NoteIf this rule is circumstance-qualified or time-qualified, make this Generate For value match the Generate For value of the base rule. The base rule and the qualified rules must all use JSP tags or all use directives.

NoteDo not save the rule form when the source contains both JSP tags and directives.
Browser Support

SmartPrompt Indicate which browser types can display the JSP or HTML from this rule. Process Commander does not validate your code. You must ensure that your code can be displayed across the browser types that you specify in this field: either IE6+ only or IE6+ and FireFox2+.

The Browser Compatibility Report in the Application Preflight tool uses this value to determine what percentage of the rules in your application provide cross-browser support.
Accessibility

SmartPromptSelect ON to indicate that you have designed and implemented your HTML to meet your accessibility requirements.

NoteThe rule is included in the Preflight Accessibility Report. See Using the Application Preflight tool.
HTML Source

Enter the HTML, script, or CSS text. The text can include JSP tags or directives, but not both.

If this HTML Property rule is to support parameters entered on the Parameters tab, use only JSP tags and set the Generate For field to JSP.

JavaServer Page tags

Tip Use of JSP tags in HTML Property rules offers superior performance and other advantages over directives. Although both directives and JSP tags are supported, JSP tags are recommended for new development. Conversion of existing HTML Property rules that use directives to functionally equivalent rules that use JSP tags is straightforward.

Inline Java and access to parameter values

Use the <% and %> delimiters to insert inline Java code (a scriptlet) in the HTML. Within the code, use Java syntax similar to the following to obtain the runtime value of a parameter from the parameter page, where MyType is defined on the Parameters tab):

<%
String MyTypeParam = tools.getParamValue("MyType")
...
%>

For additional examples, review the Java code in the standard HTML property rule named Decimal.

Including JavaScript function definitions

See More about HTML Property rules.
 Convert to JSP  

This button appears only after you save the form when the Generate For value is HTML and this rule is created by a Save As operation. See Converting from directives to JavaServer Page tags.

Tips

TipUse the <pega:when >JSP tag to conditionalize the HTML for a property based on the mode (display or read-only mode versus read-write mode).

To detect review mode, use:

<pega:when test="!$mode-input">
   <!-- display stuff here -->
</pega:when >

Useful JSP tags

These tags are used often. Don't forget to include the closing elements.

JSP tag

Result

<pega:when test="!$mode-input"> ...
</pega:when>

Read-only mode.

<pega:when test="$this:isBad">
...
</pega:when>

Error on this element.

<pega:reference
    name="$this-value" />

Value of the active property.

Example

This example causes the output HTML to display a read-only value if the property value appears in read-only mode, or a select box with three choices if the property appears in read-write mode.

<pega:when test="$mode-display" >
   <pega:reference name="$this-value" />
</pega:when>
<pega:when test="mode-input" >
<SELECT >
   <OPTION VALUE="Best">Best</OPTION>
   <OPTION VALUE="Replaced">Replaced</OPTION>
   <OPTION VALUE="Obsolete">Obsolete</OPTION>
</SELECT>
</pega:when >

zzz About HTML Property rules