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

  • Generating WSDLs for a Receiver/API
    You can generate a WSDL for an API—or set of APIs—for a given receiver/API combination for APIs that use the 1.1 syntax specification. For each API selected, one WSDL is generated along with the associated request schema and response schema.
    When you generate WSDL for a set of APIs, the WSDLs are returned as a compressed archive in a QdocWebService.zip file bundled with the associated .xsd files. The .zip file can be saved to a user-defined location on the client. When you generate a WSDL for a single API, the resultant compressed .zip file uses the same name as the API name.
    A sample empty Qdoc is available for each API in WSDL generation.
    1
    In the Configuration Manager, choose Receivers|<application>, where <application> is eB, eB2, eB2.1, QADSE, or QADEE. Other products also might display on this menu. The currently available receivers for that version display. See QDoc Schemas.
    2
    Select the receiver to generate a WSDL for by selecting its check box and then click Modify.
    3
    Choose the appropriate Suspend option if QXI is active. Click Submit.
    4
    The Modify <application> Receiver dialog displays, which allows you to change description, authentication, and licensed domains attributes. Make any required changes and then click Next.
    5
    A list displays of the standard and custom APIs that are currently supported by the receiver.
    6
    Select the APIs for which you want to generate a WSDL. You can select any combination of standard APIs, custom APIs, or both.
    Note: If you select a standard QDoc and a custom QDoc with identical name during WSDL generation, QXI generates a WSDL file and a sample QDoc from the custom QDoc, and writes an error message in an exclusion file explaining the situation.
    7
    Click Generate WSDL. Note the following:
    If no API is selected, a warning message appears when you click Generate WSDL. Exit the message box and select an API.
    If you select only one API, you are presented with three options:
    Backward compatible: Specify whether or not to generate a backward-compatible WSDL that can be used with an older version of an API
    Separate schema file: Choose whether or not to embed selected schemas into WSDL files or create separate schema files
    Use SOAP headers: Choose whether or not to include the SOAP header in the WSDL file. Select this option for most implementation scenarios; clear this option only when you are configuring QXI to process QDoc requests without SOAP headers from non-SOAP-compatible external applications such as QAD Business Process Management (BPM).

    WSDL Generation Options for a Single API
    If you select multiple APIs, you are presented with an additional option, Use Single WSDL, to choose whether to combine all the APIs in a single WSDL file or generate separate files for each API. The Backward Compatible option is only enabled when you choose not to combine them in a single WSDL file.

    WSDL Generation Options for Multiple APIs
    8
    The WSDL is generated and a File Download box displays.

    File Download
    9
    Navigate to where you want to download the file and click Save. The .zip file is saved to the selected location.
    The .zip file contains the following files:
    QdocWebService.wsdl - If combining multiple WSDLs, this file contains all selected API operations.
    [ API Name ]-[ API version ].wsdl - If not combining all WSDLs or if just selecting one API, the file contains a WSDL file for every API.
    [ API Name ]-[ API version ].xsd - This file contains as many request schema files as there were API operations that were not excluded. These are refactored schemas, not those stored on the QXI server, so that they all work when imported into the same XML namespace.
    [ API Name ]Response-[ API Version ].xsd - As many response schema files as there are request schemas with a corresponding response schema. The WSDL will specify that the response schema is the same as the request schema, if no response schema can be found.
    exclusions.txt - A text file containing a list of all the selected APIs that were not included in the WSDL and the reason they were not included. Reasons for exclusion may include the following:
    The API is not for QDoc version 1.1.
    A request schema file could not be found.
    A different version of an API of the same name has already been added (WSDLs can only have one operation with a given name). The first operation that was added will be included.
    An error occurred when trying to add an operation for the API to the WSDL.
    A schema did not validate for the reason given.
    [ API Name ]-[ API version ]-Sample.xml - This is a sample QDoc file.