Message category member properties

This describes the properties associated with a message category member.

Property Type Meaning
Role Name String

For a Message Category of kind wsdl the value of the field becomes the WSDL message part name and must be unique within the category. It defaults to the message name.

For a Message Category of kind other the value of the field has no particular significance and defaults to an empty string.

Role Type Enumerated type The role that the message plays in the message category. Select from:
  • wsdl:input
  • wsdl:output
  • wsdl:return
  • wsdl:fault
  • empty string

For a Message Category of kind wsdl the default is wsdl:input. This field dictates the role within a WSDL operation. The value wsdl:return implies wsdl:output, but for rpc-style WSDL generation it also identifies the message part used as the return value and in this instance can be omitted from the parameterOrder attribute. At most one message may have Role Type of wsdl:return.

For a Message Category of kind other the value defaults to an empty string and this property has no role in the message category.

Role Usage Enumerated type The role that the message plays in the SOAP binding. Select from:
  • soap:body
  • soap:header
  • soap:fault
  • soap:headerfault
  • empty string

For a Message Category of kind wsdl this field defaults to soap:body and dictates the SOAP-binding child of the WSDL input, output or fault element.

For a Message Category of kind other this field is deactivated.

Documentation String It is a string field and any standard alphanumeric characters can be used.

For a Message Category of kind wsdl the value of the field is included in any generated WSDL as the wsdl:documentation child of the WSDL input, output or fault element under the WSDL portType.

For a Message Category of kind other the value serves only to document the Message Category within your workspace.

Related concepts
The message model
Message categories
Related tasks
Working with a message category file
Related reference
Message model reference information
Message category properties