Enabling z/OS V1R12 XML functionality in z/OS V1R10 and z/OS V1R11

Functionality was added to z/OS XML System Services in z/OS® 1.12 that is available in z/OS 1.10 and z/OS 1.11 with APAR OA32251; PTFs UA59081 and UA59082. This APAR includes support for schema discovery, parsing of XML document fragments and restrict root support.

Schema discovery enhances the usability of the validating parser by allowing the caller to query the XML document schema locations detailed in the “schemaLocation” and “noNamespaceSchemaLocation” attributes, in addition to the root element namespace and local name. Following this, the caller will have the opportunity to load an OSR without having to reset the parse. See Obtaining information on schema locationsfor more information on schema discovery support.

Parsing of document fragments without obtaining and parsing an entire document is now supported when parsing in z/OS XML System Services with schema validation. . See Parsing XML document fragments with validationfor more information on fragment parsing.

Restrict root support allows an z/OS XML System Services caller to restrict the root name against a given root element name or a list of root element names when performing a validating parse. See Restricting the root element namefor more information on restrict root support.

To enable the support in z/OS 1.10 and z/OS 1.11 environments, the caller must complete the following steps:

Load GXLIMOD2, the alternate validating parser into memory for use by the application.
- The alternate parser, GXLIMOD2, contains support for the z/OS 1.12 XML System Services functions. To load the z/OS 1.12 version of the validating parser using the GXL1LOD(GXL4LOD) API, specify XEC_LOD_VPARSE_ALT for the function_code. See gxlpLoad — load a z/OS XML functionand GXL1LOD (GXL4LOD) — load a z/OS XML functionfor more information on loading a validating parser.
Parse with an OSR that supports the full z/OS 1.12 functionality.
- An OSR generated on a z/OS 1.12 system can be used on a z/OS 1.10 or z/OS 1.11 system with APAR OA32251 installed and GXLIMOD2 loaded. This OSR will fully support all the functions listed above.
- To generate an OSR on a z/OS 1.10 or z/OS 1.11 system that fully supports the z/OS 1.12 functionality listed above using the xsdosrg command, specify the –a option on the command. OSRs that were generated on z/OS 1.10 and z/OS 1.11 systems without the –a option can be used with the alternate parser, but will not fully support all the new functions listed above.
- To generate an OSR on a z/OS 1.10 or a z/OS 1.11 system that fully supports the z/OS 1.12 functionality listed above using the C interface, specify GXLHXEC_OSR_ALT for the feature_flags field on the gxluInitOSRG interface.
- To generate an OSR that supports the full z/OS 1.12 functionality using the Java™ interface, specify type=OSRINI_ALT on the newOSRGenerator method in the gxlOSRGenerator class, when generating an OSR.

The following is a list of examples:

C example of loading the alternate validating parser (GXLIMOD2)

int f_code = GXLHXEC_LOD_VPARSE_ALT;
int f_data = 0;
int lodRet = 0;
int lodRsn = 0;
/* load the alternalte parser */
                    
gxlpLoad(f_code,   
         f_data,   
         &lodRet,                
         &lodRsn);

xsdosrg example of generating a z/OS 1.12 functional level OSR
```
xsdosrg -a -o test.osr test.xsd
```

C example of generating a z/OS 1.12 functional level OSR

void * myOIMA = NULL;    /* OSR generator instance memory area */
long   myOIMALength = GXLHXEC_MIN_OIMA_SIZE; /* length of OIMA */
void * sysSvcWorkarea = NULL;
featureFlags = GXLHXEC_OSR_ALT; /* Alternate OSR requested     */
int localRC = 0;
int localRSN = 0;

myOIMA = malloc(GXLHXEC_MIN_OIMA_SIZE);
localRetVal = gxluInitOSRG(myOIMA,             
                           myOIMALength,     
                           featureFlags,     
                           sysSvcWorkarea,   
                           &localRC,                                           
                           &localRSN);

Java example of generating a z/OS 1.12 functional level OSR

/* When issuing newOSRGenerator, specify type = 
gxlOSRGenerator(gxlOSRGenerator.OSRINI_ALT) */

/* This will tell subsequent calls to generate an alternate osr */


myOSRGen = gxlOSRGenerator.newOSRGenerator(gxlOSRGenerator.OSRINI_ALT);