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  |   On Demand  |   Home  |   qad.com




Acknowledgement Request
Here is the schema of the acknowledgement request:
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:schemas-qad-com:xml-services"
xmlns:prodata="urn:schemas-progress-com:xml-prodata:0001"
xmlns:qdoc="urn:schemas-qad-com:xml-services"
elementFormDefault="qualified"
targetNamespace="urn:schemas-qad-com:xml-services">
<xsd:element name="dsAcknowledgementRequest" prodata:datasetName="dsAcknowledgementRequest" prodata:prefix="qdoc" prodata:proDataSet="true">
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" maxOccurs="unbounded" name="AcknowledgementRequest" prodata:tableName="ttAcknowledgementRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" name="businessEventId" nillable="true" type="xsd:string" />
<xsd:element minOccurs="0" name="acknowledgementSeverity" nillable="true" type="xsd:string" />
<xsd:element minOccurs="0" maxOccurs="unbounded" name="AcknowledgementRequestDetail" prodata:tableName="ttAcknowledgementRequestDetail">
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" name="businessEventId" nillable="true" type="xsd:string" />
<xsd:element minOccurs="0" name="exceptionSeverity" nillable="true" type="xsd:string" />
<xsd:element minOccurs="0" name="exceptionNumber" nillable="true" type="xsd:string" />
<xsd:element minOccurs="0" name="exceptionContext" nillable="true" type="xsd:string" />
<xsd:element minOccurs="0" name="exceptionDescription" nillable="true" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:unique name="BusinessEventId" prodata:primaryIndex="true">
<xsd:selector xpath=".//qdoc:AcknowledgementRequest"/>
<xsd:field xpath="qdoc:businessEventId"/>
</xsd:unique>
<xsd:keyref name="relException" prodata:nested="true" refer="qdoc:BusinessEventId">
<xsd:selector xpath=".//qdoc:AcknowledgementRequestDetail"/>
<xsd:field xpath="qdoc:businessEventId"/>
</xsd:keyref>
</xsd:element>
</xsd:schema>
An acknowledgement request contains one dsAcknowledgementRequest element, which contains one or more AcknowledgementRequest elements.
Each AcknowledgementRequest element is for one subscriber message processing result, and it contains the following direct children:
One businessEventId element - its value should be the same as the businessEventId session context properties from the corresponding subscriber message request
One acknowledgementSeverity element - the severity of the acknowledgement that is mapped to corresponding subscriber message status as listed in the following table:

 
acknowledgementSeverity/ exceptionSeverity
Subscriber Message Status
Success
DLV
Warning
WRN
Error
APPERR
If there is one or more AcknowledgementRequestDetail child elements (see below) of the AcknowledgementRequest, the acknowledgementSeverity of the parent element should have a value that equals the highest value of the exceptionSeverity in the child elements. For example, if there are three AcknowledgementRequestDetail child elements, with exceptionSeverity as DLV, WRN, and APPERR respectively, the acknowledgementSeverity of the parent element should be APPERR.
No or multiple AcknowledgementRequestDetail elements - they provide details of the processing result and each of them contains the following direct children:
One businessEventId element - it must have the same value as the businessEventId of its parent
One exceptionSeverity element - its value could be one of the severity values (as shown in the above table)
One exceptionNumber element - the exception number
One exceptionContext element - the exception context
One exceptionDescription element - the exception message
For each warning/error for a subscriber message to be sent to QXtend, an AcknowledgementRequestDetail child element is created.
Here is a sample acknowledgement request:
<?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:QADQXO</wsa:To>
<wsa:MessageID>urn:services-qad-com::QADQXO</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>
<processMessageAcknowledgement>
<dsAcknowledgementRequest>
<AcknowledgementRequest>
<businessEventId>201101170004185664.00093</businessEventId>
<acknowledgementSeverity>error</acknowledgementSeverity>
<AcknowledgementRequestDetail>
<businessEventId>201101170004185664.00093</businessEventId>
<exceptionSeverity>warning</exceptionSeverity>
<exceptionNumber></exceptionNumber>
<exceptionContext>ItemApprovalProcess</exceptionContext>
<exceptionDescription>Approval crossed due date</exceptionDescription>
</AcknowledgementRequestDetail>
<AcknowledgementRequestDetail>
<businessEventId>201101170004185664.00093</businessEventId>
<exceptionSeverity>error</exceptionSeverity>
<exceptionNumber>BPM-301</exceptionNumber>
<exceptionContext>ItemValidateProcess</exceptionContext>
<exceptionDescription>Post message to BPEventQueue failed: java.rmi.RemoteException: Unrecoverable Exception:java.rmi.RemoteException:BizPulse has not been started at (Unknown Source) at com.savvion.ejb.bizpulse.manager.BizPulseManagerBean.postJMSMessage(Unknown Source) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:598) at org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:447) at java.lang.Thread.run(Thread.java:662)
</exceptionDescription>
</AcknowledgementRequestDetail>
</AcknowledgementRequest>
<AcknowledgementRequest>
<businessEventId>201204020000045224.00090</businessEventId>
<acknowledgementSeverity>warning</acknowledgementSeverity>
<AcknowledgementRequestDetail>
<businessEventId>201101170004185664.00090</businessEventId>
<exceptionSeverity>warning</exceptionSeverity>
<exceptionNumber></exceptionNumber>
<exceptionContext>SalesOrderCreditProcess</exceptionContext>
<exceptionDescription>Requires Acknowledgement flag not set for Subscriber SO-BPM Subscriber</exceptionDescription>
</AcknowledgementRequestDetail>
</AcknowledgementRequest>
</dsAcknowledgementRequest>
</processMessageAcknowledgement>
</soapenv:Body>
</soapenv:Envelope>