In order to bring you the best possible user experience, this site uses Javascript. If you are seeing this message, it is likely that the Javascript option in your browser is disabled. For optimal viewing of this site, please ensure that Javascript is enabled for your browser.
Login  |   Cloud ERP  |   Home  |   qad.com



  •     QAD Glossary

  • QDoc Envelope Examples
    The following examples illustrates QDoc envelopes for both the 1.1 and 1.0 syntax specifications.
    Envelope Example (1.1)
    <!-- Here is an inbound QDoc 1.1 request message envelope. -->
    <?xml version="1.0" encoding="UTF-8"?>
    <soapenv:Envelope xmlns="urn:schemas-qad-com:xml-services" xmlns:qcom="urn:schemas-qad-com:xml-services:common" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">
    <soapenv:Header>
    <wsa:Action />
    <wsa:To>urn:services-qad-com:eb21sp6</wsa:To>
    <wsa:MessageID>urn:services-qad-com::eb21sp6</wsa:MessageID>
    <wsa:ReferenceParameters>
    <qcom:suppressResponseDetail>true</qcom:suppressResponseDetail>
    </wsa:ReferenceParameters>
    <wsa:ReplyTo>
    <wsa:Address>urn:services-qad-com:</wsa:Address>
    </wsa:ReplyTo>
    </soapenv:Header>
    <soapenv:Body>
    <!-- The QDoc goes here -->
    <maintainSalesOrder>
    ...
    </maintainSalesOrder>
    </soapenv:Body>
    </soapenv:Envelope>
    Envelope Example (1.0)
    <!-- Here is an inbound QDoc 1.0 request message envelope. -->
    <env:Envelope xmlns:env="http://www.w3.org/2002/12/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <env:Header>
    <!-- SOAP 'mustUnderstand' and 'role' attributes are ignored but may be present -->
    <QDoc xmlns="http://www.qad.com/qdoc/common" env:mustUnderstand="0" env:actor="http://schemas.xmlsoap.org/soap/actor/next">
    <senderId>http://www.acme.com/site1?sender=site1</senderId>
    <receiverId>http://www.acme.com/site2?connection=queue1&amp;receiver=db2</receiverId>
    <senderDocumentId>eq200000</senderDocumentId>
    <requestor id="user" password="apasswd" type="mfgpro"/>
    <!-- descriptor may be omitted if Q/LinQ is set up to expect QDocs -->
    <documentStandard>QDoc</documentStandard>
    <documentType> maintainSalesOrder</documentType>
    <documentVersion/>
    <confirmationLevel>all</confirmationLevel>
    <dateTimeCreated>2002-07-10T09:00:00-0800</dateTimeCreated>
    <senderDocumentRef>eqso5678</senderDocumentRef>
    <senderDocumentRef>1</senderDocumentRef>
    </QDoc>
    </env:Header>
    <env:Body>
    <!-- The QDoc goes here -->
    <maintainSalesOrder …>
    ...
    </maintainSalesOrder>
    </env:Body>
    </env:Envelope>
    XML Schema for Envelope Header
    Following is the unannotated XML 1.0 schema describing the syntax of the header block of the QDoc document envelope. It makes no distinction between export and import, so that exported Q/LinQ documents can be reprocessed as import documents with no XML syntax errors. The elements and attributes are defined in an envelope-specific namespace rather than the primary product-specific QDoc namespaces.
    Note: In the QDoc 1.1 specification there is no common schema; instead, each QDoc has its own schema. For details of changes to the XML schema in the 1.1 specification see QDoc Schema 1.1.
     
    <?xml version="1.0" encoding="UTF-8"?>
    <schema targetNamespace="http://www.qad.com/qdoc/common" xmlns:qcom="http://www.qad.com/qdoc/common" xmlns="http://www.w3.org/2001/
    XMLSchema" xmlns:soapenv="http://www.w3.org/2002/12/soap-envelope" xmlns:enc="http://www.w3.org/2002/12/soap-encoding" elementFormDefault="qualified" xml:lang="EN">
    <import namespace="http://www.w3.org/2002/12/soap-envelope" SchemaLocation="soap-envelope.xsd"/>
    <complexType name="QdocEnvelopeType">
    <sequence>
    <element name="senderId" type="anyURI"/>
    <element name="senderRef" type="string" minOccurs="0"/>
    <element name="receiverId" type="anyURI"/>
    <element name="receiverRef" type="string" minOccurs="0"/>
    <element name="senderDocumentId" type="string"/>
    <element name="documentStandard" type="string"/>
    <element name="documentType" type="string"/>
    <element name="documentVersion" type="string"/>
    <element name="confirmationLevel" default="none" minOccurs="0">
    <simpleType>
    <restriction base="string">
    <enumeration value="none"/>
    <enumeration value="error"/>
    <enumeration value="all"/>
    </restriction>
    </simpleType>
    </element>
    <element name="dateTimeCreated" type="dateTime" minOccurs="0"/>
    <element name="senderDocumentRef" type="string" minOccurs="0" maxOccurs="unbounded"/>
    <element name="receiverDocumentRef" type="string" minOccurs="0" maxOccurs="unbounded"/>
    <element name="requestor" minOccurs="0" maxOccurs="unbounded">
    <complexType>
    <attributeGroup ref="qcom:requestorAttributes"/>
    </complexType>
    </element>
    <any minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
    <attribute ref="soapenv:encodingStyle"/>
    <attribute ref="soapenv:role"/>
    <attribute ref="soapenv:mustUnderstand"/>
    <anyAttribute/>
    </complexType>
    <element name="qdoc" type="qcom:QdocEnvelopeType"/>
    <attributeGroup name="requestorAttributes">
    <attribute name="id" type="string" use="optional"/>
    <attribute name="type" type="string" use="optional"/>
    <attribute name="password" type="string" use="optional"/>
    </attributeGroup>
    <attributeGroup name="commonAttributes">
    <attribute name="version" type="string" use="required"/>
    <attribute name="scopeTransaction" type="boolean" use="optional"/>
    <attribute name="logTransaction" type="boolean" use="optional"/>
    <attribute name="transactionId" type="string" use="optional"/>
    <attribute name="suppressResponseDetail" type="boolean" use="optional"/>
    <attribute ref="xml:lang"/>
    </attributeGroup>
    <attributeGroup name="arrayEntryAttributes">
    <attribute name="index" type="positiveInteger" use="required"/>
    <attribute name="skip" type="boolean"/>
    </attributeGroup>
    <complexType name="EntryString">
    <simpleContent>
    <extension base="string">
    <attributeGroup ref="qcom:arrayEntryAttributes"/>
    </extension>
    </simpleContent>
    </complexType>
    <complexType name="EntryInteger">
    <simpleContent>
    <extension base="integer">
    <attributeGroup ref="qcom:arrayEntryAttributes"/>
    </extension>
    </simpleContent>
    </complexType>
    <complexType name="EntryDecimal">
    <simpleContent>
    <extension base="decimal">
    <attributeGroup ref="qcom:arrayEntryAttributes"/>
    </extension>
    </simpleContent>
    </complexType>
    <complexType name="EntryDate">
    <simpleContent>
    <extension base="date">
    <attributeGroup ref="qcom:arrayEntryAttributes"/>
    </extension>
    </simpleContent>
    </complexType>
    <complexType name="ExceptionType">
    <sequence>
    <element name="number" type="string"/>
    <element name="description" type="string"/>
    <element name="severity" default="error" minOccurs="0">
    <simpleType>
    <restriction base="string">
    <enumeration value="informational"/>
    <enumeration value="warning"/>
    <enumeration value="error"/>
    </restriction>
    </simpleType>
    </element>
    <element name="field" type="string" minOccurs="0"/>
    <element name="context" type="string" minOccurs="0"/>
    <element name="trace" type="string" minOccurs="0"/>
    </sequence>
    </complexType>
    <simpleType name="ReturnValueType">
    <restriction base="string">
    <enumeration value="success"/>
    <enumeration value="warning"/>
    <enumeration value="error"/>
    </restriction>
    </simpleType>
    <complexType name="QdocConfirmationType">
    <sequence>
    <element name="originalDocumentRef" type="qcom:QdocEnvelopeType"/>
    <element name="processingStage">
    <simpleType>
    <restriction base="string">
    <enumeration value="received"/>
    <enumeration value="accepted"/>
    <enumeration value="processed"/>
    </restriction>
    </simpleType>
    </element>
    <element name="processingOutcome">
    <simpleType>
    <restriction base="string">
    <enumeration value="error"/>
    <enumeration value="warning"/>
    <enumeration value="success"/>
    </restriction>
    </simpleType>
    </element>
    <element name="exception" type="qcom:ExceptionType" minOccurs="0" maxOccurs="unbounded"/>
    <element name="processingResults" minOccurs="0">
    <complexType>
    <sequence>
    <any processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
    </complexType>
    </element>
    </sequence>
    <attributeGroup ref="qcom:commonAttributes"/>
    </complexType>
    </schema>