Printing Advantage CA-COBOL/XE CAT Views and PAINT Panels using OXFORMAT

Document ID : KB000055853
Last Modified Date : 14/02/2018
Show Technical Document Details

Advantage CA-COBOL/XE has a component format utility called OXFORMAT. This batch program allows you to print formatted listings of CAT views and PAINT panels.

OXFORMAT Control Cards

Input to OXFORMAT consists of two types of control cards: Global and Action.

Global: These control cards are used to set up process options. These options remain in effect until changed by another global card or until end of job.

LIBRARY =dataspace-name

The dataspace-name specifies the IOX data space in which the component(s) to be formatted for printing resides. A LIBRARY card can be coded at any point in the job stream, but the OXFORMAT utility considers only the most recent LIBRARY as the current. If a valid LIBRARY card is not coded before attempting to format a component, then an error message will be issued and the current action will be terminated.

Action: These control cards are used to select component(s) to be formatted and printed. Each action card is processed in order and has no effect on subsequent processing.

PANEL=name-rangeThis card causes the specified PAINT panel(s) to be formatted.
VIEW= name-rangeThis card causes the specified CAT view(s) to be formatted.

The name-range specifies the name of a specific component or a generic name. A generic name specifies a wildcard using "/" to include multiple components. The "/" character can be coded in place of one or more of the 8 characters in the name-range specification.

Examples:

PANEL=mypanel
VIEW=myview
will select only the PAINT panel named 'mypanel'
will select only the CAT view named 'myview'
PANEL=manyp///
PANEL=manyp/
will select all PAINT panels that start with 'manyp'.
will select all PAINT panels that are 6 characters or less and start with 'manyp'.
VIEW=////////will select all CAT views

Note: Multiple control statements can be specified in one execution to select multiple components.

OXFORMAT Parameters

Parameters can be passed via JCL to control error processing and/or establish initial values for certain global control cards. These initial control card values are overridden by any coded control card encountered.

The following parameter values can be coded:

ALLOW=nThis parameter sets the maximum allowable error severity level that the OXFORMAT utility will tolerate before terminating.

The values for n can be:

0: Any error will cause the job to be terminated.
4: The specified component was not found. This is the default value.
8: No errors will terminate the job.

LIBRARY=dataspace-name

SYSTRACEThis parameter is used as an aid in debugging. It causes internal OXFORMAT functions to be entered in the trace table that is printed along with the OXFORMAT dump.

Sample MVS JCL to execute OXFORMAT:

The following JCL will print all CAT views and PAINT panels that begin with "SAMP1". It will also terminate if any errors are encountered because ALLOW=0 is specified as a parameter.

//UFOXFOR  EXEC PGM=OXFORMAT,PARM='ALLOW=0'
//STEPLIB  DD DISP=SHR,DSN=your.cobolxe.loadlib
//USRIOXI  DD DISP=SHR,DSN=your.cobolxe.usrioxI 
//USRIOXR  DD DISP=SHR,DSN=your.cobolxe.usrioxR 
//SYSPRINT DD SYSOUT=* 
//SYSIN    DD * 
LIBRARY=USRIOX 
PANEL=SAMP1///
VIEW=SAMP1///
    /*

Sample VSE/ESA JCL to execute OXFORMAT:

The following JCL will print all CAT views and PAINT panels that begin with "SAMP2". It will also terminate if any errors are encountered because ALLOW=0 is specified as a parameter.

// JOB OXFORMAT                                                      
// DLBL product,'your.cobolxe.library',99/365,SD 
// EXTENT ,volid 
// LIBDEF PHASE,SEARCH=product.sublib
// DLBL USRIOXI,'your.cobolxe.usrioxi',,VSAM
// DLBL USRIOXR,'your.cobolxe.usrioxr',,VSAM                         
// EXEC OXFORMAT,SIZE=AUTO,PARM=?ALLOW=0? 
LIBRARY=USRIOX 
PANEL=SAMP2///
VIEW=SAMP2///
/*

Read More About It

For detailed information on the OXFORMAT utility, see the CA-UFO publication UFO Productivity Support Package User Guide.