NonStop SOAP User's Manual

NonStop SOAP Features and Functions
NonStop SOAP User’s Manual520501-012
4-32
Flagging a DDL Field with SOAP DDL Comment
Tags
The SoapDDLAttribute is not available for services with the “rpc” style message types
in the SDL. This is because in “rpc” style the message format is like a function call
where the ordering of the elements is significant, which cannot be achieved with an
attribute centric message format. Hence, it's erroneous to have the SoapDDLAttribute
set to “yes” when a service in the SDL has the SoapMessageType attribute set to "rpc.”
This validation is done by the SOAP Admin tool when adding/updating a service into
the SDR and any errors encountered are output as follows:
Flagging a DDL Field with SOAP DDL Comment Tags
The representation of DDL fields as XML attributes or elements can be done
selectively on individual DDL fields by tagging them appropriately in the DDL
dictionary. These NonStop SOAP DDL comment tags are provided to flag DDL fields in
the request/response definitions to be handled as attribute or element centric:
@SOAP_ATTRIBUTE: Flags a DDL field hierarchy as attribute centric
@SOAP_ELEMENT: Flags a DDL field hierarchy as element centric
You must issue the COMMENTS command before you input a DDL definition with
comments.
This is done by entering "?comments" in the DDL source as shown below.
?comments
DEF PATIENT
02 PATIENT
03 NAME
Example 4-21. Sample XML Representation
<sdl ...>
<Pathway ...>
...
<ServerClass Name="SC-1" ...>
<Service ServiceName="Service-A"
SoapMessageType="document"
SoapDDLAttribute="yes">
</Service>
</ServerClass>
</Pathway>
</sdl>
SOAPADMIN ERROR >> Error in definition of the service
<service name>. The attribute "SoapDDLAttribute" cannot have
a value "yes" when the attribute "SoapMessageType" is set to
"rpc".