QXtend Inbound Overview
QXI is a component of the QAD QXtend interoperability framework. This framework provides a standardized data interface between QAD products, and between QAD products and external systems. The interface is a Web services-based, SOAP-compliant, XML framework, enabling complete platform-independent access to QAD Enterprise Applications business functionality. See Glossary for definitions of terms and abbreviations.
The framework consists of:
QXI, which imports SOAP-compliant XML QDocs from external applications into QAD Enterprise Applications and other QAD applications such as QAD Production Scheduler.
QAD QXtend Outbound (QXO), which exports user-configurable business objects as XML QDocs out of QAD products such as QAD Enterprise Applications.
QXI delivers inbound data to menu-level programs in QAD Enterprise Applications eB and above. The inbound data is in the form of XML data documents, called QDocs, delivered in a proprietary XML format. QXI also has security mechanisms in place to ensure that only authorized personnel can update data to menu-level programs. Prior to all data processing, the system checks whether the user has access rights to corresponding menus in QAD Enterprise Applications. If the user does not have access rights to the menu, an error is displayed. Basic QXI System Architecture
illustrates the QXI system architecture.
Basic QXI System Architecture
As shown in Basic QXI System Architecture
, incoming documents—called requests—can be generated directly from data capture tools such as barcode readers; mobile devices; other QAD products, QAD Production Scheduler, or QAD EDI ECommerce; and from any third-party application that can generate XML.
The data is formatted as SOAP-compliant XML documents using QDoc templates in XML schema format. These documents are fed directly to QXI. Alternatively, you can queue the documents using a number of queue management interfaces, including the QXI Queue Manager and the QAD Q/LinQ product. See QXtend Inbound with QAD Q/LinQ
for more details.
In addition, you can queue XML documents that do not meet QXI standards, and call the QXI transformation engine to apply custom XSLT style sheet transformations to the document. The transformation engine outputs a valid QDoc request. See QXI Transformation Engine
for more details.
QXI accepts the XML QDoc requests as Web service calls as shown in Server Internals
. Optionally, you can send the incoming QDocs through the QXI preprocessor to validate the incoming data, eliminating incorrect QDocs. You can also create postprocessing programs to validate response data. See QXtend Inbound Pre- and Postprocessors
For all QDocs, the QXI server validates the user ID and password from the SOAP envelope if you have configured it to do so. It then extracts the QAD Enterprise Applications data from the SOAP envelope, repackages the data in a transaction container, and then sends the data to an QAD Enterprise Applications session, called a receiver, through the UI adapter or service interface adapter.
When QAD Enterprise Applications receives the data from the UI adapter, it enters it through a telnet user session with a menu-level business function. The data is validated against all database, menu-level, and program validations, and all database triggers are fired.
Once the data has been input, the adapter generates a response document that is returned through QXI in the same transaction container that delivered the request. The response document provides a success or failure notification. The failure notification can contain warnings and errors. The response document can also contain data from QAD Enterprise Applications such as the primary data key value and additional error information, such as Java trace data or pre- or postprocessing errors.