Using XPCML

Using XPCML is similar to using PCML. The following steps serve as a general outline for the actions that you need to perform to use XPCML.

Use XPCML to describe the specification for the program call
Create a ProgramCallDocument object
Use ProgramCallDocument.callProgram() to run the program

Despite the similarities to using PCML, using XPCML offers enhanced functionality:

Have the parser automatically validate parameter values
Specify and pass values for program parameters
Retrieve the results of a program call to your iSeries™ server in XPCML
Transform an existing PCML document into the equivalent XPCML document
Extend the XPCML schema to define new simple and complex elements and attributes

For example, IBM^® Toolbox for Java™ enables you to extend the XPCML schema to create new parameter and data types. You can use this XPCML capability to condense your XPCML source files, which makes the files easier to read and code easier to use.

For more information about using XPCML, see the following pages:

Converting existing PCML to XPCML
The ProgramCallDocument class contains the transformPCMLToXPCML method that enables you to transform existing PCML documents to equivalent XPCML documents.
Using XPCML to call a program on your iSeries server
After you create your XPCML file, you need to create a ProgramCallDocument object that can use the XPCML specifications and data values to call a program on your iSeries server.
Obtaining program call results as XPCML
After you call a server program, you can use ProgramCallDocument.getValue methods to retrieve the Java objects that represent program parameter values.
Passing in parameter values as XPCML
You can set the values for program parameters in the XPCML source file and pass in the parameter values as XPCML.
Using condensed XPCML
Because XPCML is extensible, you can define new parameter types that extend those specified by the XPCML schema. Condensing XPCML extends the XPCML schema to create new data type definitions that simplify and improve the readability and usability of your XPCML documents.
Identifying parse errors in XPCML
When validating XPCML schema documents, a fully validating XML parser may generate warnings, non-fatal parse errors, and fatal parse errors.

Parent topic: Extensible Program Call Markup Language

Converting PCML to XPCML
Learn how to transform existing PCML documents to equivalent XPCML documents.

Using XPCML to call a program on your iSeries server
See how to create a ProgramCallDocument object that uses XPCML to call a program on your server.

Obtaining program call results as XPCML
Find out how to retrieve the results of your call to a server program as XPCML.

Passing in parameter values as XPCML
Learn about setting values for program parameters in XPCML and passing in those values. Examine different techniques for defining constant parameter values and data arrays.

Using condensed XPCML
See how condensing an XPCML document makes it easier to read and use. Find out about using condensed XPCML to create a ProgramCallDocument object and obtaining program call results as condensed XPCML.

Identifying parse errors in XPCML
Find out how to identify and log useful warnings and non-fatal parser errors that sometimes occur when parsing an XPCML document.