Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

JavaServer Pages tags

Updated on August 10, 2022

JavaServer Pages tags can appear in all rule types derived from the Rule-Stream class.

CorrespondenceControl
Correspondence FragmentList View (deprecated)
Flow actionParagraph
HarnessSection
HTMLSummary View (deprecated)
HTML FragmentXML

The following tags govern how the stream processing facility converts and assembles a text stream for a user's browser, for outgoing correspondence, or for outgoing XML text.

TagUse
acDataSourceDefines the source of text values for an autoComplete JSP tag.
assertUse to make processing more efficient when working with one or more concrete classes and the Obj-List method.
autoCompleteSupports a user interface drop-down facility that matches candidates from the first few characters a user types.
binaryfileUsed within the static JSP tag to identify a binary file rule.
bundleUsed within the static JSP tag to identify a static content bundle rule.
chooseUse with the when tag to select one section of source code to process. The otherwise JSP tag may appear within the choose tag.
chartDisplay a chart derived from a summary view rule.
contentURLInclude a non-rule-resolved image in a stream.
dataGridReserved.
dsFieldSupports the acDataSource tag.
dsFieldsSupports the acDataSource tag.
fileUsed within the static JSP tag to identify a text file rule.
forEachIterate through the properties contained in a Page or Page List structure.
includeInsert another stream rule into the current stream.
listViewSupport run-time display of list view reports within sections. The param JSP tag may appear within the listView tag.
lookupRetrieve and include the value of a property from an instance that is not present on the clipboard.
onlyonceCause a named section of text to be evaluated during stream processing only the first time it appears.
rInclude the value of a property on the clipboard. Short form of the reference tag.
reference p:rInclude the value of a property on the clipboard.
saveSave a value with an associated name for reuse later in the current stream.
static Include the contents of one or more static file bundle rule ( Rule-File-Bundle rule type) or text file rules ( Rule-File-Text rule type) in the stream.
urlEncode a URL string on an HTML form with the Pega Platform keywords.
whenTest a Boolean condition or when rule, and include or exclude source text based on the results.
withEmbeddedChange the current embedded page.
withPageChange the current base page.
withReferenceMake a new property the currently active property.
withTargetOverride the control rule that applies to a property.

Additional tags can appear within the scope of one of these tags. These additional tags are documented with the enclosing tag. For example:

  • elseassert tag, within the assert tag
  • key, within the lookup tag
  • option, within the url tag
  • otherwise, within the choose tag
  • param, within the listview tag
  • About the static JavaServer Page tag

    Use the static JSP tag to cause one or more static file bundles, individual text files, or individual binary files to be included in the current stream. A static file bundle rule identifies a list of JavaScript, image, and Cascading Style Sheet files to be sent to a browser session together in one HTTP response, to reduce HTTP traffic and improve response time to the browser user.

  • acDataSource JavaServer Page tag

    Use the acDataSource tag within an autoComplete tag to compute the list of values presented to the user.

  • assert JavaServer Page tag

    Use the assert JavaServer Page tag to improve processing efficiency when displaying the results of the Obj-List method.

  • autoComplete JavaServer Page tag

    Use the autoComplete tag to present a drop-down list of candidate text values that a user can select from for an input text box. The text values can be produced by an activity or can be on a clipboard page.

  • binaryfile JavaServer Page tag

    Use the binaryfile JSP tag to identify a single binary file rule ( Rule-File-Binary rule type) to be included in the current stream.

  • choose JavaServer Page tag

    Use the choose JSP tag to select at most one enclosed branch of when tags.

  • JSP tag — chart

    Use the chart tag to present an interactive chart defined by a summary view rule, that has Interactive as the Chart Output Type value on the Chart tab of the rule form.

  • contentURL JavaServer Page tag

    Use the contentURL JSP tag to include a system-generated cleartext URL in the current stream that requests an image saved in an image content data instance ( Data-Content-Image class). This is a reusable, unhashed URL that can be used more than once to refer to the image.

  • dataGrid JavaServer Page tag

    The DataGrid control is deprecated. Update an existing DataGrid to a Grid control. For guidelines on upgrading, see Upgrading deprecated and outdated controls on Pega Community.

  • dsField JavaServer Page tag

    Use the dsField JSP tag within a dsFields tag as part of a dsDataSource tag. Example:

  • dsFields JavaServer Page tag

    Use the dsFields JSP tag within a dsDataSource tag, part of an autoComplete JSP tag configuration. This tag has no attributes. It can contain only dsField tags.

  • file JavaServer Page tag

    Use the file JSP tag within a static JSP tag to identify a single text file rule ( Rule-File-Text rule type) to be included in the current stream.

  • forEach JavaServer Page tag

    Use the forEach tag to repeat an action for each property in a page, for each page in a Page List, or for each property in any list or group.

  • include JavaServer Page tag

    Use the include JSP tag to instruct stream processing to insert one stream within the current stream. This tag lets you define a commonly used segment of HTML or XML text in one rule instance and then incorporate the text where needed.

  • listView JavaServer Pages tag

    Use the listView JSP tag in a section to include the results of a list view rule in the run-time display of a section. The section can be part of a flow action.

  • lookup JavaServer Page tag — lookup

    Use the lookup tag to retrieve and display:

  • onlyonce JavaServer Page tag

    Use the onlyonce JSP tag to indicate that text within the body of the tag is to be included in the stream processing output only the first time that an onlyonce tag of that name is found.

  • p:r JavaServer Page tag

    Use the p:r tag to display the values of properties, to allow users to enter values for properties, and to insert parameter values. (The p:r tag provides identical capabilities as the reference tag, but requires less typing.)

  • Reference properties indirectly in JSP tags

    In the reference, when, withReference, and forEach tags, you can reference properties indirectly rather than by name in JavaServer Page tags.

  • reference JavaServer Page tag

    Use the reference tag to display the values of properties or activity parameters and to allow users to enter values for Single Value properties or single elements of aggregate properties.

  • save JavaServer Page tag

    Use the save tag to set up named values at runtime, while the source HTML (or XML) is processed, onto an internal symbol table known as the scratchpad. This in-memory scratchpad is available throughout the generation of the HTML (or XML) stream.

  • URL JavaServer Page tag

    The URL JavaServer Page (JSP) tag provides a means to include a Uniform Resource Locator string into the output HTML produced by stream processing.

  • when JavaServer Page tag

    Use the when tag to conditionalize a segment of HTML or XML, whether used for display, user input or correspondence. Use it to control whether stream processing includes, or omits, parts of HTML text under conditions that you determine. You can base the conditions on Boolean values returned by properties, Java methods, or when condition rules.

  • withEmbedded JavaServer Page tag

    Use the withEmbedded JSP tag to set the current embedded page during stream processing to a different embedded page. The new page applies only to HTML or XML code within the body of the withEmbedded tag.

  • withPage JavaServer Page tag

    Use the withPage tag to replace the primary page with a different page (the base page) throughout a segment of the HTML or XML text, as a coding convenience. The new page applies only to HTML or XML code within the body of the withPage tag.

  • withReference JavaServer Page tag

    Use the withReference tag to identify a new property as the active property for a limited scope. The new property applies only to HTML or XML code within the body of the withReference tag.

  • withTarget JavaServer Page tag

    Use the withTarget tag to override the control rule that ordinarily applies to a property.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us