Version 9.5 SP1
 —  Software AG IDL Extractor for XML Schema  —

Using the Software AG IDL Extractor for XML Schema

Warning:
If you modify the imported IDL file, do this only in the XML Mapping Editor to ensure the correct dependencies between the IDL and the related XMM file.

Step 1: Start the IDL Extractor for XML Schema

Start the IDL Extractor for XML Schema as any other eclipse New wizard:

graphics/using_start.png

Top of page

Step 2: Select a Source

Depending on the location of the XML Schema to analyze, choose File or URL:

graphics/using_selectSource.png

Top of page

Step 3a: Specify XML File

If you selected the XML Schema source file before you started the wizard, the file location is already present. Enter or browse for the XML Schema source file. Continue with Step 4: Specify Output Files.

For the direction OUT - that is, the reply from the server - an optional XML Schema file can be specified to extract the parameters of the interface. If no additional XML Schema file is given, parameters for direction IN and OUT are the same and extracted from the same input XML Schema file. The resulting Software AG IDL File contains all the parameters of the interface as IDL parameters (see parameter-data-definition) with its direction (see attribute-list).

graphics/using_specifyXml.png

Top of page

Step 3b: Specify XML File URL

Enter the URL for the XML Schema source file. You can specify an optional XML Schema file for the IDL direction OUT. See Step 3a: Specify XML File for more information.

graphics/using_specifyXmlUrl.png

Top of page

Step 4: Specify Output Files

graphics/using_specifyOutputFiles.png

Select the Container where the IDL file will be stored. Enter the name of the new IDL file and the related XML mapping file.

Top of page

Step 5: Specify Options for Target Programming Language

The Options for Target Programming Language page allows you to specify transformation rules for variable-length fields and unbounded arrays. This is required if you later use the COBOL Wrapper or PL/I Wrapper with the extracted IDL – otherwise COBOL or PL/I wrapping is not possible. If you later use the Natural Wrapper, transformation rules are optional. If they are used, the interface from a Natural point of view is more legacy-like, easier to use but with restrictions.

graphics/using_specifyOptions.png

With the transformation rules, you define default (maximum) lengths and sizes depending on the originating data types on the XML side. If you need different (maximum) lengths and sizes for fields with the same data type, use the XML Mapping Editor. See Using the XML Mapping Editor

Warning:
If you modify the imported IDL file, do this only in the XML Mapping Editor to ensure the correct dependencies between the IDL and the related XMM file.

Depending on the target programming language of your scenario, the available/possible transformation rules differ. Use the combo-box and choose the target programming language:

COBOL

For generation of clients and servers with the COBOL Wrapper.

Variable-length fields and unbounded arrays with unlimited number of elements are not directly supported by COBOL. There are two possibilities to specify options:

Natural

For generation of clients and servers with the Natural Wrapper.

Variable-length fields and unbounded arrays with unlimited number of elements are directly supported by Natural. As an alternative, EntireX also provides the possibility to transform to a more legacy-like interface with fixed length.

PL/I Client

For generation of clients with the PL/I Wrapper. The following possibilities exist in scenarios with PL/I clients:

PL/I Server

For generation of servers with the PL/I Wrapper. The following possibilities exist in scenarios with PL/I servers:

Other

If you later use wrappers other than the COBOL Wrapper, Natural Wrapper or PL/I Wrapper, no transformation rules are required. Variable-length fields and unbounded arrays are extracted as is; there are no restrictions regarding data length that can be transferred in variable-length fields and the number of elements that can be transferred in unbounded arrays.

Press Finish to start extraction.

Top of page

Extraction Result

When the operation is completed, the IDL file is opened with the Software AG IDL Editor.

If the XML Schema source files to extract from contain parameters that cannot be mapped to IDL parameters, an IDL file with incorrect IDL syntax is created. The unsupported parameters lead to IDL parameters of data type Error, which is not supported. In the Problems View you get a marker for the first error in the IDL file.

Top of page