WEBSERVICE attributes

Describes the syntax and attributes of the WEBSERVICE resource.

Read syntax diagramSkip visual syntax diagramWEBSERVICE( name)GROUP( groupname)DESCRIPTION( text)PIPELINE( pipelinename)WSBIND( hfsfile)VALIDATION(NO)VALIDATION(YES)WSDLFILE( hfsfile)ARCHIVEFILE( hfsfile)
WEBSERVICE(name)
Specifies the 1-8 character name of the WEBSERVICE resource.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ? ! : | " = ¬ , ; < >
It is preferable not to use names that start with DFH because these characters are reserved for use by CICS®. CICS can delete or discard them and replace them with CICS resources when you upgrade or provide new function or fixes.
ARCHIVEFILE(hfsfile)
Specifies the 1-255 character fully qualified or relative name of an archive that contains one or more WSDL files. The supported format for the archive is .zip.
  • For an archive for a WEBSERVICE resource defined by online resource definition, the file path is either fully qualified, if prefixed with a forward slash (/), or is relative to the HOME directory of the CICS region user ID.
  • For an archive for a WEBSERVICE resource defined in a CICS bundle, the file path is relative to the root directory of the CICS bundle. The zFS file must be packaged in the CICS bundle with the WEBSERVICE resource. For more information, see Referencing zFS artifacts in a bundle.
The value specified must be a valid name for a UNIX file:
  • It must not contain embedded space characters.
  • It must not contain consecutive instances of the / character.
  • It is case-sensitive.
Acceptable characters:
A-Z a-z 0-9 . / _ # @ -
GROUP(groupname)
Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.
Acceptable characters:
A-Z 0-9 $ @ #
Any lowercase characters you enter are converted to uppercase.

The GROUP name can be up to eight characters in length. Lowercase characters are treated as uppercase characters.

DESCRIPTION(text)
You can provide a description of the resource that you are defining in this field. The description text can be up to 58 characters in length. There are no restrictions on the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right parenthesis. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.
PIPELINE(pipelinename)
Specifies the 1-8 character name of the PIPELINE resource with which this WEBSERVICE resource is associated.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.
VALIDATION(NO|YES)
Specifies whether full validation of SOAP messages against the corresponding schema in the web service description should be performed at run time. Validating a SOAP message against its schema incurs considerable processing overhead, and you should normally specify VALIDATION(NO).

Full validation ensures that all SOAP messages that are sent and received are valid XML with respect to the XML schema. If VALIDATION(NO) is specified, checking is performed to ensure that the message contains well-formed XML, but there is no guarantee that the XML is valid.

WSBIND(hfsfile)
Specifies the 1-255 character fully-qualified or relative name of the web service binding file on z/OS® UNIX.
  • For a web service binding file for a WEBSERVICE resource defined by online resource definition, the file path is either fully qualified, if prefixed with a forward slash (/), or is relative to the HOME directory of the CICS region user ID.
  • For a web service binding file for a WEBSERVICE defined in a CICS bundle, the file path is relative to the root directory of the CICS bundle. The zFS file must be packaged in the CICS bundle with the WEBSERVICE resource. For more information, see Referencing zFS artifacts in a bundle.
The value specified must be a valid name for a UNIX file:
  • It must not contain embedded space characters.
  • It must not contain consecutive instances of the / character.
  • It is case-sensitive.
Acceptable characters:
A-Z a-z 0-9 . / _ # @ -
WSDLFILE(hfsfile)
Specifies the 1-255 character fully-qualified or relative name of the web service description (WSDL) file on z/OS UNIX. This file is used when full runtime validation is active.
  • For a web service description file for a WEBSERVICE resource defined by online resource definition, the file path is either fully qualified, if prefixed with a forward slash (/), or is relative to the HOME directory of the CICS region user ID.
  • For a web service description file for a WEBSERVICE resource defined in a CICS bundle, the file path is relative to the root directory of the CICS bundle. The zFS file must be packaged in the CICS bundle with the WEBSERVICE resource. For more information, see Referencing zFS artifacts in a bundle.
The value specified must be a valid name for a UNIX file:
  • It must not contain embedded space characters.
  • It must not contain consecutive instances of the / character.
  • It is case-sensitive.
Acceptable characters:
A-Z a-z 0-9 . / _ # @ -