DocumentEnvelopeType

The Type related to envelope that conveys business
information.

Complex Type Information

Model

Attributes

QName Type Fixed Default Use Inheritable Annotation
businessDocumentRef xsd:IDREF required
Indicates the nameID reference to the logical business
document.
isAuthenticated restriction of xsd:NMTOKEN optional
The communications channel used to transport the Message provides
transient authentication. The specific method will be determined by the
communications protocol used. Persistent authentication means the Business
Document signer’s identity is verified at the receiving application level.
Authentication assists in verification of role identity of a participating
party.
isConfidential restriction of xsd:NMTOKEN optional
Transient confidentiality is provided by a secure network
protocol, such as SSL as the document is transferred between two adjacent ebXML
Messaging Service or other transport messaging nodes. Persistent
confidentiality is intended to preserve the confidentiality of the message such
that only the intended party (application) can see it.
isPositiveResponse xsd:boolean optional
May evaluate to TRUE or FALSE. If TRUE, the DocumentEnvelope is
intended as a positive response to a request. The value for this parameter is
used to evaluate a Business Success or Failure of the corresponding Business
Transaction.
isTamperDetectable restriction of xsd:NMTOKEN optional
Transient isTamperDetectable is the ability to detect if the
information has been tampered with during transfer between two adjacent Message Service Handler
nodes. Persistent isTamperDetectable is the ability to detect if the information
has been tampered with after it has been received by messaging node, between the
messaging node and the application. Tamper detection assists in verification of
content integrity between and within a participating party.
name xsd:string required
A designation that may be relevant to a business analyst but is
not intended for referencing.
nameID xsd:ID required
Used for referencing, for example, for identification of elements
within an ebBP instance.
Wildcard: ANY attribute from ANY namespace OTHER than 'http://docs.oasis-open.org/ebxmlbp/ebbp-2.0'

Used By

Source

<xsd:complexType name="DocumentEnvelopeType">
  <xsd:annotation>
    <xsd:documentation>The Type related to envelope that conveys business information.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element ref="Documentation" minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element ref="Attachment" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
  <xsd:attributeGroup ref="name"/>
  <xsd:attribute name="businessDocumentRef" type="xsd:IDREF" use="required">
    <xsd:annotation>
      <xsd:documentation>Indicates the nameID reference to the logical business document.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attribute name="isPositiveResponse" type="xsd:boolean">
    <xsd:annotation>
      <xsd:documentation>May evaluate to TRUE or FALSE. If TRUE, the DocumentEnvelope is intended as a positive response to a request. The value for this parameter is used to evaluate a Business Success or Failure of the corresponding Business Transaction.</xsd:documentation>
    </xsd:annotation>
  </xsd:attribute>
  <xsd:attributeGroup ref="documentSecurity"/>
</xsd:complexType>