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.
This tag is useful in source HTML text for user interface forms, in source HTML text for correspondence, and in XML text for interfaces.
Use the include tag to include any of nine rule types:
For example, this code inserts a fragment of HTML text into the currently processed stream:
<pega:include name="NewHeader" type="Rule-HTML-Fragment" />
The name attribute identifies
only the final key part or key parts of the target rule to be
included. For rule types that contain an Applies To
key part, the system uses the Applies To key part of
the current rule at runtime and uses rule resolution to find the
target rule to include. B-20061 rejected
pega:include JSP tags can also appear in
rules of other types derived from the Rule-Stream class,
such as harness, section, flow action, list view and summary view
rules. In most cases, the HTML code and JSP tags for these rules are
automatically generated.
Don't use this tag to include a rule
within itself (recursion), as that often causes an infinite loop.
BUG-2
In the following syntax presentation:
[ and ]
define optional parts of the tag. Do not type the brackets.<pega:include
[name="name"]
[ref="indirect reference
"]
[type="rule
type"]
[inline="true"|"false"
]
/>
Either name or ref is required as an
attribute.
Attribute |
Description |
name
|
The name — second key part — of the rule to included. Use this attribute when the name is known during design. |
ref
|
Used for indirect references, which allow the rule name to be determined dynamically at runtime. See How to reference properties indirectly in JSP tags |
type
|
Optional. Identify the class of the rule to be included,
for example If the type attribute is omitted, then the type that is included depends on the including type, as follows: 6/15/06 GENTJ
You can use any of these keywords:
|
inline
|
The default value is "true"; inlining is preferred as it normally provides better performance. |
mode
|
|
Three special
cases — XML, Correspondence, and Correspondence Fragments
Including sections
that accept parameters
|
Harness form, fragment, stream processing |
Optional. Set to
"false" in unusual situations to disable the
default Java generation approach, which inlines Java code for
this tag. The "false" setting may reduce the size
of the Java class generated for the stream rule, possibly
allowing it to fit within the 64KB limit. BUG-2160 GENTJ
5/1/07