z/OS MVS Using the Subsystem Interface
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Specifying Keywords

z/OS MVS Using the Subsystem Interface
SA38-0679-00

Installations, or any subsystem that supports the Request Subsystem Version Information call, must observe the following syntax rules when specifying keywords in the SSVIDAT field:
  • A comma starts the entire string, and a comma must delimit each keyword from the previous keyword. This syntax allows the caller's function routine to use an index-type function when searching for keywords. For example, an index for ",keyword='" provides a valid technique for searching for the presence of the keyword in a string.

    The length of the data string can exceed 256 characters; ensure that the caller's parsing function is coded to handle very long data strings.

    An apostrophe ('), comma (,), and equal sign (=) are not allowed as part of a keyword term. For example, the following keyword terms are not allowed:
    • KEYWORD'S='...'
    • KEY=WORD='...'
    • KEYWORD,='...'
  • The prefix value USER_ is reserved for installations to pass their own information in the installation variable output section.
  • The '=' sign is required.
  • Not all keywords need be returned by the subsystem service.
  • The combination of an equal sign followed by an apostrophe (=').. is not allowed as part of a keyword value.
  • Alphabetic characters for a keyword value are assumed to be in upper case unless otherwise stated.
  • If a registered keyword appears in an installation string, then the allowable values are the same as the system string definition.
  • The apostrophes surrounding the value for a keyword are required.
  • A null value is indicated by two apostrophes in sequence.
  • To code an apostrophe within the keyword value, code two apostrophes and enclose the keyword value within apostrophes.
Additional Recommendations for Specifying Keywords:
  • Define yes or no choices as 'YES' or 'NO' (not abbreviated).
  • Specify any numeric values as unsigned decimal numbers.
  • Avoid specifying multiple parameters per keyword. Instead, use a separate keyword for each parameter, when possible.
  • Numeric values must be passed in zoned-decimal format.
  • When a keyword is located in a string, the end of the keyword's value should be determined prior to performing any comparisons. This ensures that the value that is searched for is not just a substring for another value.
  • A feature or function that may be activated or inactivated while a subsystem is still active may not be good candidates to include in the string. An exception to this would be if the subsystem has a mechanism to inform all potential requesters interested in the feature or function.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014