NonStop SOAP 4.1 User's Manual

Table 4 The DDL Comments values (continued)
DescriptionDDL Comment
* @SOAP_OPTIONAL @SOAP_SUPPRESS_OUT
input type binary 32.
WSDL file translation:
<xsd:element name="input"
type="xsd:int"
minOccurs="0"
maxOccurs="1" />
This specifies that a field is optional in the SOAP request and the SOAP response
message because the DDL field might be a group field or a leaf field. This comment
@SOAP_SUPPRESS_INOUT
is activated only when it appears in combination with @SOAP_OPTIONAL. In the WSDL
file, this comment is translated as minOccurs=0 and maxOccurs depending on the
selected DDL comment.
For example:
DDL file:
* @SOAP_OPTIONAL @SOAP_SUPPRESS_INOUT
input type binary 32
WSDL file translation:
<xsd:element name="input"
type="xsd:int"
minOccurs="0"
maxOccurs="1" />
The SoapAdminCL tool adds the DDL comment in the generated WSDL file and the
HTML client files to indicate if the occurrences of the current field are dependent on
@SOAP_OCCURS_DEP_ON
the value of the field mentioned in the comment. This comment must appear with the
element that has more than one Occurs value. In the SOAP request, the element must
appear as many times as the value of the dependent element occurs at runtime.
For example:
DDL file:
* @SOAP_OCCURS_DEP_ON Bin2
20 Bin3 type binary 32 OCCURS 5 times
WSDL file translation:
<!-- The following element occurs 0 to 5 times,
depending upon the value of the element:
bin2:urn:cpq_tns_reflector-->
<xsd:element name="bin3"
type="xsd:int"
minOccurs="0"
maxOccurs="5" />
NOTE: For the OCCURS .. DEPENDING ON .. clause, the SoapAdminCL tool
generates the following output:
DDL file:
20 Bin3 type binary 32
OCCURS 2 to 5 times
DEPENDING ON Bin2
WSDL file translation:
<!-- The following element occurs 2 to 5 times,
depending upon the value of the element:
bin2:urn:cpq_tns_reflector-->
<xsd:element name="bin3"
type="xsd:int"
minOccurs="2"
maxOccurs="5" />
You must define the depending on element one level above where it is used in the
DDL. To overcome this limitation, use the @SOAP_OCCURS_DEP_ON comment tag.
SDL Service Types 165