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




Generate Docs
This option generates a QDoc schema and events file from the program information that has been mapped and saved in a .dat file. You can specify which standard to use for the generated schema. The available options change according to which schema standard is specified.
Note: If you intend to generate native APIs for configurable screens that have been customized using the .NET UI or ICT, see Generating Native APIs.
1
Arrow to Generate Docs and press spacebar.
2
Press Go to start the generation. The Generate Options frame displays.

Generate QDocs Pop-up
3
Fill in the information using the field descriptions below:
Adapter
Select the adapter you want to use.
UI API: Select this option to use the UI API.
SI API: Select this option to use the SI API to generate service interface APIs for configurable screens. Only QAD 2009 SE, QAD 2009 EE and later versions have SI API.
QDoc name
Enter the QDoc name as saved in the QGen .dat file; for example, SalesOrderEntry.
Note: If you select the SI API option and enter an invalid QDoc—that is, a non-SI API QDoc that has not been defined in the controllers.xml file—the system displays an error message.
Procedure Name
(1.1 schema standard and UI API only). Enter the name of the QAD Enterprise Applications program name plus a .p extension; for example, sosomt.p.
User
(1.1 schema standard and SI API only). Enter the name of the user for whom the customization is intended. If the field is left blank, the customization applies to all configurable screens that are associated with all roles.
4
Do either of the following:
To generate the schema and events to a file, select the File option. You must specify the results directory in which to store the generated schema and events files, the schema standard, and the schema version. Then select Generate QDocs to generate the files.
To publish the APIs directly to the QXI server, select the QXI Server option, then continue to step 5.
Note: QGen does not support publishing to QXI server if the Progress version is lower than 10.
5
Specify the standard to use for the generated schema. The 1.1 specification is the default standard. (This option does not display if the SI API option is selected.)
6
Specify the schema version to use; for example, eB2_3 for the third version of the file in the eB2 release. The default value is eB_1.
7
Select Generate QDocs. The Connect to QXI Server screen displays.

Connect to QXI Server
8
Complete the server connection fields.
Note: The information in this screen persists in memory until QGen is closed.
QXI Host
Specify the hostname of the QXI server.
QXI Port
Specify the port number used to access the QXI server.
QXI Webapp Name
Specify the name of the Web service used to connect to the QXI server.
SSL
Select the field to use Secure Socket Protocol https encryption on messages to the QXI server.
Note: If SSL is selected, then QXI Host must include domain name of the host.
Username
Specify the username login for the QXI server.
Password
Specify the password for the user.
9
Select Continue. The Select a Module screen displays.

Select a Module
10
Select the module to which you want to send the QDocs and then select Continue. The Select Receivers screen displays.

Select Receivers
11
Select the receiver to which you want to send the QDocs and then select Continue. If the upload of QDocs is successful, the Upload QDoc to QXI Successful message displays.

Upload Successful
12
Select OK to exit.