Special Syntax Conventions

XML adopts certain syntax conventions that apply in some search, summary, and analysis contexts.

Semicolon-Delimited Lists

The allowed contents of commonly used tags may be different in search contexts than in non-search contexts. For example, user ID and security entity tags, which elsewhere permit only a single value, may accept a semicolon-delimited list of TSO user IDs or security entities in a search context. When a tag allows multiple values to be entered, it is noted in the tag description.

Yes/No Flag Tags

All search, summary, and analysis services in XML follow common default value conventions for yes/no flag tags. They also share common conventions for Boolean relationships among flag tag values.

The key to these conventions is the flag tag group. An example of a group is the release status flag tags in the RLSMRLSE SERVICE SEARCH service. The values of all flag tags within a group are considered together; in fact, such mutual processing is the basis for identifying such tags as a group. Different flag tag groups may be supported by a single service; however, each group is evaluated independently of the other groups.

Default Values Within a Group

All yes/no flag tags in a group default to the value "Y" if no tag in the group has an explicitly assigned value. But if any flag tag in the group is explicitly assigned a value, all other tags in the group change their default values to "N."

For example, if your XML request says nothing about which release statuses to include, the release status flag tags all default to "Y" values, and you will get all release statuses in your reply. But if your XML request explicitly states you want all releases in DEV status, the assumption is made that you don’t want releases in any other status. The flag tag value that you have set to "Y" retains that value, but the defaults for all other flag tags in Special Syntax Conventions

the group default to "N". To request multiple release statuses, you would set the yes/no flags for each desired release status to an explicit "Y" value.

Important

If you explicitly set flag tag values, always include at least one "Y" value in each flag tag group. This is necessary because XML does not fully support Boolean NOT operations. You can include an item in a given state, and you can exclude an item in a given state, but you cannot include in your search results an item that is not in a given state. If you explicitly set just one flag tag in a group to a value of "N" and take the defaults for the rest, no results will be returned.

Boolean Relationships Within a Group

The "Y" values of all tags within a yes/no flag tag group are related by Boolean OR in search, summary, or analysis contexts. Any item in any state requested by a "Y" flag is returned in the results.

Tags with a value of "N" in a group are related by Boolean AND to the other tags in the group. Any item in any state identified by a flag with a value of "N" is excluded from the results.

Asterisk (*) Wildcard

Several tags allow the use of an asterisk (*) wildcard. Where this is allowed, it is indicated in the description for that tag.