XML Stream form
Completing the XML tab

Field

Description

Optional. Enter the URL of an XML Schema document to use as input for building the XML tree structure on the Mapping tab. Used only when the Auto-generated XML? option is checked. For SOAP services that reference this rule, the Schema URL value is added to the generated WSDL document as an external document import.

Select in most cases to cause Process Commander to generate the stream XML (as visible in the XML Source field) from the tree structure on the Mapping tab.

Clear to allow you to type XML source code into the XML Source field through typing or a text editor such as NotePad or an XML editor. This text is processed by stream processing before use; you can use JSP tags.

Select to eliminate extra space characters in the processed XML. This can make transmission or processing more efficient. It does not affect the meaning or processing of the XML document.

When selected, the system during stream processing:

• 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 XML without change.

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

As a best practice, use JSP tags rather than directives. In most cases, you can convert XML Stream rules that use directives to use JSP tags automatically, using the button. See Converting from directives to JavaServer Page tags.

Do not save the rule form when the source contains both JSP tags and directives.

If 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.

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.

This field is read-only unless Auto-Generated XML? is cleared.

Enter XML source text. You can type directly into the text area, or you can click the pencil to open Notepad or your registered XML editor.

Use of JSP tags in XML stream 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 XML stream rules that use directives to functionally equivalent rules that use JSP tags is straightforward.

Recall that the default forms of the <pega:reference > JSP tag (and the reference directive) cause the system to place a space character before and after the output text value of the property. When no added spaces are desired, use the LITERAL keyword in the reference directive:

{ .pyLabel LITERAL }

or equivalently the text mode for the reference JSP tag:

<pega:reference name=".pyLabel" mode="text" />

If the output XML document is to conform to a DTD definition that uses the CDATA convention, always use the LITERAL keyword in the reference directive or the literal mode for the JSP tag. This causes the output value to contain any < and > characters in the property rather than converting these characters to the XML entities < and &gt;.

When defining a menu add-on, follow the structure presented in How to extend the Developer portal menus.

Use the <% and %> delimiters to surround an inline Java scriptlet within the XML source code.