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




QDocs
Each inbound XML QDoc request results in an XML QDoc response. Each QDoc references the QAD Enterprise Applications session and version and the target QAD Enterprise Applications application program. A QDoc can contain one or more records for that calling program, but cannot call other programs in QAD Enterprise Applications. See QDoc Structure Reference for examples of QDoc files.
Most incoming QDoc requests are sent to QAD Enterprise Applications over a telnet session. The target calling program is launched and the data from the QDoc passed down field-by-field just as if a user were entering the data. If data is missing for a non-mandatory field, the session skips through the field, always matching data input with the correct field in the calling program interface.
To make this screen-driven entry possible, each QDoc has a matching XML schema and events documents stored on your QXI drive.
QDoc XML Schemas
Many standard XML schemas are shipped with QXtend. Depending on the QDoc syntax specification being used, the way in which schemas are used by QDocs differs. Refer to the appropriate section for the relevant QDoc schema syntax specification.
QDoc XML Schemas (1.1)
Each supported QDoc request and its QAD Enterprise Applications calling program is associated with an XML schema file. See QDoc Specifications and Standards for details.
The XML schema for a calling program such as Sales Order Maintenance (sosomt.p) contains all possible data entry fields in the calling program. It also includes the information required to start data iterations, which are repetitive entry sequences such as sales order lines. For information on schema exceptions, see QDoc Exceptions.
For example, the schema document for sosomt.p in QAD EE and QAD SE is named maintainSalesOrder-2008_2.xsd. and contains calling procedure as well as detailed field information.
Each QDoc response also has an XML schema file. It is named similarly to the request QDoc schema, but includes response in the name. For sosomt.p in QAD EE and QAD SE, the response schema file is named maintainSalesOrderResponse-2008_2.xsd. This file contains procedure information as well as a list of primary key fields for each iteration. You can edit the schema as required to filter out or add QAD Enterprise Applications field values that will be included in the response document.
For additional information on configuring response document contents, see QDoc Response Data.
QDoc XML Schemas (1.0)
Important: Schemas using the 1.0 specification are supported for backward compatibility only. Where possible, you should use the 1.1 schemas, since these are WSI-compliant.
In most cases, two XML schema files are associated with each supported QDoc request and its QAD Enterprise Applications calling program when using the 1.0 specification.
The XML schemas for Sales Order Maintenance (sosomt.p) contain all possible data entry fields in the calling program and information required for data iterations. For example, the schema documents for sosomt.p in eB2 are:
maintainSalesOrder-eB2_1.xsd
salesOrderType-eB2_1.xsd
The first file is the base schema file, and contains calling procedure information. The second file, the type file, contains the detailed field listing.
Two XML schema files are also provided for each QDoc response. They are named similarly to the request QDoc schemas, but include response in the name. For sosomt.p in eB2, the response schema files are:
maintainSalesOrderResponse-eB2_1.xsd
salesOrderResponseType-eB2_1.xsd
The first file is the base schema file, and contains calling procedure information. The second file, the type file, contains a list of primary key fields for each iteration. Editing the type file enables you to filter out or add QAD Enterprise Applications field values that will be included in the response document.
QDoc Events Documents
The QDoc—if using the user interface API—also needs information on how to navigate in an QAD Enterprise Applications screen. By default, the QDoc sends data and moves to the next field. However, it needs to know, given the field location, when to accept an iteration—as for multiple sales order lines within a single sales order—and when to allow a deletion. These screen actions are called events and are stored in a version-specific directory for each calling program in an events document named by default after the calling program. The default events document for sosomt.p is sosomt-ERP3_2.xml. The base events documents are also available on the QAD Web site. For information on event exceptions and errors, see Event Exceptions.
You can create additional events files to support multiple processing scenarios within the same calling program such as for implementations that use European Accounting for some, but not all, transactions. Multiple events files can also be used to test processing paths to improve performance.