XMLGEN Utility function


The XMLGEN utility creates XML documents from existing files using Assembler, COBOL or PL/I layout fields as the tag names. To select the XMLGEN utility, type the letter G in the OPTION field of the File-AID Extended Utilities menu, or as described in Selecting Screens. When you press Enter, the XMLGEN Data File screen is displayed as shown in XMLGEN Data File Specification Screen.

XML Data File Specification

The XMLGEN Data File screen, shown in the following figure, allows you to identify the data file information for File-AID to use to create the XML output.

XMLGEN Data File Specification Screen

image2021-6-24_9-44-4.png

Field Descriptions

Specify Input Dataset or zFS Path Information:

Dataset or path

Specify the dataset or path name. Use the naming conventions described in Specifying a data set name and Specifying a zFS Pathname. You can enter a pattern data set name in this field to display a list of data sets from which you can make a selection. A pattern dataset name or mask consists of explicit characters or a combination of explicit and pattern characters. See Pattern data set names for a complete description.

Enter the FILELIST primary command or blank out the Dataset name field to display the Last Referenced File List. For more information, see Last Referenced File List.

Member name

Specify the member name. You can leave this field blank or enter a pattern member name to display a list of members from which you can make a selection. A pattern member name or mask consists of explicit characters or a combination of explicit and pattern characters. See Pattern Member Names for a complete description. Pattern names cannot be entered in both the Input dataset name and Member name fields at the same time.

Volume serial

Specify the volume serial of the direct access device that contains the data set. This field is required only when the data set is uncataloged.

I/O exit name (Optional)

If the I/O exit option has been installed, this input area is provided. For more information, see Installing or your system programmer. I/O exit install options are:

NO

I/O exit name field is not presented.

YES

I/O exit name field is presented blank for entry of a site written I/O exit program name.

exitname

I/O exit name field is presented prefilled with the name of a site-written I/O exit program.

Specify Record Layout and XREF Information:

Record layout usage

Specify one of the following values:

S - Single record layout.

X - XREF (record layout cross reference). Specify when more than one record layout is needed for a single data set.

Record layout dataset

Specify the name of a data set that contains the Assembler, COBOL or PL/I record layout. This file is required when the Record layout usage field is S (single) or X (XREF).

You can enter a pattern dataset name in this field to display a list of data sets from which you can make a selection. A pattern dataset name or mask consists of explicit characters or a combination of explicit and pattern characters. See Pattern data set names for a complete description.

Member name

Specify the member name. You can leave this field blank or enter a pattern member name to display a list of members from which you can make a selection. A pattern member name or mask consists of explicit characters or a combination of explicit and pattern characters. See Pattern Member Names for a complete description. Pattern names cannot be entered in both the Dataset name and Member name fields at the same time.

XREF dataset name

Specify the name of a data set that contains the record layout cross reference (XREF) members to use with multiple record type data sets. For more information, see the section entitled Record Layout XREF Dataset in File-AID-data-set-types.

You can enter a pattern data set name in this field to display a list of data sets from which you can make a selection. A pattern dataset name or mask consists of explicit characters or a combination of explicit and pattern characters. For more information, see Pattern data set names.

Member name

Specify the member name. You can leave this field blank or enter a pattern member name to display a list of members from which you can make a selection. A pattern member name or mask consists of explicit characters or a combination of explicit and pattern characters. For more information, see Pattern Member Names. Pattern names cannot be entered in both the Dataset name and Member name fields at the same time.

Specify Selection Criteria Information:

Refer to Selection-Criteria-function for a complete description of selection criteria.

Selection criteria usage

Specify one of the following valid entries:

E - Use existing selection criteria. Enter a dataset name in the Selection dataset name field.

- Create temporary selection criteria. File-AID displays the Temporary Selection Criteria Menu. Temporary selection criteria is not automatically saved. To retain temporary selection criteria use the SAVE primary command on the Selection Criteria Menu screen.

M - Modify existing selection criteria. Enter a dataset name in the Selection dataset name field.

Q - Quick selection criteria. File-AID displays the Unformatted Selection Criteria screen for you to enter selection criteria. Quick selection criteria is not automatically saved. Use the SAVE primary command to retain quick selection criteria.

N - (Default) None -- Do not use selection criteria.

Selection dataset name

Specify the name of the data set containing existing selection criteria for options E and M.

You can enter a pattern dataset name in this field to display a list of data sets from which you can make a selection. A pattern dataset name or mask consists of explicit characters or a combination of explicit and pattern characters. See Pattern data set names for a complete description.

Member name

Specify the member name. You can leave this field blank or enter a pattern member name to display a list of members from which you can make a selection. A pattern member name or mask consists of explicit characters or a combination of explicit and pattern characters. See Pattern Member Names for a complete description. Pattern names cannot be entered in both the Dataset name and Member name fields at the same time.

After you have completed the fields on the XMLGEN Data File Specification screen, press Enter to continue. Use the END (PF3) to return to the File-AID Extended Utilities Menu.

XMLGEN Processing Options

The XMLGEN Processing Options screen, shown in the following figure, allows you to define processing and output options for your XML document.

XMLGEN Processing Options Screen

File-AID ------------  XMLGEN - Processing Options ----------------------------
 COMMAND ===>                                                                   
                                                                               
 Specify Execution Options:                                                     
  Records to process       ===> ALL      (ALL or maximum number)               
  Invalid field action     ===> H        (H = Hex; D = Data; S = Skip)         
                                                                               
                                                                               
 Specify XML Output Information:                                                
  Dataset or path ===>                                                          
  Member name     ===>          (Blank or pattern for member list)              
  Disposition     ===> NEW      (NEW; SHR; MOD; OLD)                            
  Volume Serial   ===>          (If dataset is not cataloged)                   
                                                                               
                                                                               
  Use ENTER to continue, END to cancel  


Field Descriptions

Specify Execution Options

Records to Process

Specify the number of records from the input file to use when generating the XML document. Valid entries are ALL, or the numbers 0 - 99999. 0 is treated as "ALL".

Important

Excluded records and fields are not used when generating an XML document. If the file has segmented records defined with an XREF member, File-AID internally issues NEXT commands to format each segment of each record.

REDEFINES and FILLER fields are not used when generating an XML document. If you display only REDEFINES and/or FILLER fields, or the layout contains only these fields, XMLGEN terminates without generating an XML document.

Invalid field action

Specify how you want the XML document generator to process data fields that are invalid as defined by the record layout. Valid entries are:

H Hex. Data is displayed in a hex dump format.

D Data. Data is displayed exactly as it is in the file with no formatting.

S Skip. Data portion of the field is omitted.

Specify XML Output Information

Use this section of the screen to identify the data set into which you want to generate this XML document.

Dataset or path

Specify the dataset name or zFS pathname for the XML output.

Member name

If the data set is partitioned you may specify a member name. If the data set is partitioned and you do not specify a member, the PDS Processing Options (PPO) are displayed to enable you to generate a member list based on member names, ISPF statistics, and (optionally) selection criteria.

Disposition

The XML document data set disposition may be NEW, SHR, MOD, or OLD. Specify a a valid disposition:

NEW - Allocate online a new file.
SHR - Other users may access the data set.
MOD - Append data to the end of an existing file.
OLD - Overwrite an OLD file.

Volume serial

If the data set is not cataloged, enter the Volume serial number.

After you have completed the fields on the XMLGEN Processing Options screen, press Enter to continue. Use the END (PF3) to return to the XMLGEN Data File Specification screen.

XMLGEN JCL Specification

The XMLGEN JCL Specification screen, shown in the following figure, allows you to specify your JCL information and submit the job for processing.

XMLGEN JCL Specification Screen

File-AID ---------------- XMLGEN - JCL Specification  -------------------------
 COMMAND ===>                                                                   
                                                                               
 JCL Information for Batch Processing:                                          
                                                                               
  Sysout class    ===> R                                                        
                                                                               
 JOB Statement Information:                                                     
  ===> //USERID9C JOB ('OFABAS8.8.0DEV',81,),'MACHLAY',                         
  ===> //        CLASS=U,MSGCLASS=R,NOTIFY=USERID9                             
  ===>                                                                          
  ===>                                                                          
                                                                               
                                                                               
                                                                               
                                                                               
 Use JCL command to edit generated JCL                                          
 Use SUBMIT command to submit batch job                                         
 Use END to return to main XMLGEN panel without submitting job    

Field Descriptions

On the JCL Specification screen you can enter the following commands:

JCL

File-AID generates the JCL to process the job and displays it on an edit screen, as shown in Generated JCL Edit Screen.

SUBMIT

Submits the batch job.

CANCEL

Terminates the function.

The Generated JCL Edit screen, shown in Generated JCL Edit Screen, is displayed by entering the JCL primary command on the XMLGEN - JCL Specification screen.

Unicode Data

Use the CCSID parameter when generating XML with Unicode data to specify the code page to be used. Manually add the parameter to the JCL to override the default CCSID, for example:

    $$DD01 XMLGEN INVALID=HEX,OUT=0,LAYOUT=NATL,CCSID=0500
Generated JCL Edit Screen

File  Edit  Confirm  Menu  Utilities  Compilers  Test  Help                  
 -------------------------------------------------------------------------------
 EDIT       SYS01039.T132506.RA000.USERID9.R0121547         Columns 00001 00072
 Command ===>                                                  Scroll ===> PAGE
 ****** ***************************** Top of Data ******************************
 000001 //USERID9C JOB ('OFABAS8.9.0DEV',81,),'USER',                        
 000002 //        CLASS=U,MSGCLASS=R,NOTIFY=USERID9                             
 000003 //*  YOU ARE VIEWING JCL THAT FILE-AID 23.1 HAS GENERATED TO            
 000004 //*  PERFORM THE REQUIRED FUNCTION.                                     
 000005 //*                                                                     
 000006 //*  YOU CAN CHANGE THIS JCL IF DESIRED AND USE THE SUBMIT PRIMARY      
 000007 //*  COMMAND TO SUBMIT THE JOB. THE CREATE OR REPLACE PRIMARY COMMAND   
 000008 //*  CAN BE USED TO KEEP THIS JOBSTREAM FOR FUTURE USE.                 
 000009 //*                                                                     
 000010 //*  USE THE END COMMAND TO EXIT WITHOUT SUBMITTING THE JOB.            
 000011 //*                                                                    
 000012 //JS10     EXEC PGM=FILEAID,REGION=8M                                  
 000013 //STEPLIB  DD  DISP=SHR,DSN=hlq.CXVJLOAD         
 000014 //         DD  DISP=SHR,DSN=hlq.SXVJLOAD         
 000015 //SYSPRINT DD  SYSOUT=R                                                 
 000016 //SYSLIST  DD  SYSOUT=R                                                 
 000017 //DD01     DD  DSN=FASAMP.EMPLOYEE,                                     
 000018 //             DISP=SHR                                                 
 000019 //DD01O    DD  DSN=USERID9.FASAMP.NEWXML,                               
 000020 //             DISP=OLD                                                 
 000021 //DD01RL   DD  DSN=USERID9.FASAMP.LAYOUTS,                              
 000022 //             DISP=SHR                                                
 000023 //SYSIN    DD  *                                                        
 000024 $$DD01 XMLGEN  INVALID=HEX,OUT=0,LAYOUT=EMPLOYEE                        
 000025 /*                                                                      
 000026 //

You can edit the generated JCL, submit it with the SUBMIT primary command, and save it by using the CREATE or REPLACE primary commands.

Related topics

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*