 |
|
| When technology complements business | COBOL for VSAM Access |
| Copyright © 1987-2008 SimoTime Enterprises, LLC All Rights Reserved | http://www.simotime.com |
|
|||||
|
This suite of programs provides an example of how a single mainline COBOL program accesses a VSAM data set. The COBOL program is written using COBOL/2 dialect but also works with COBOL for MVS, COBOL/370 and COBOL for 390. A JCL member is provided to run the job as an MVS or OS.390 batch job on an IBM mainframe or as a project with Micro Focus Mainframe Express (MFE) running on a PC with Windows.
This program may serve as a tutorial for programmers that are new to COBOL or VSAM and as a reference for experienced programmers.
This example illustrates the following functions.
| 1. | Describe how to read a VSAM, Keyed-Sequential-Data-Set (KSDS) in a single, COBOL program. |
| 2. | Describe how to display records to the console. |
| 3. | Describe how to display the file return code when an abnormal condition occurs. |
| 4. | Provide an example of mainframe JCL to run the job on the mainframe. |
| 5. | Provide an example of mainframe JCL to run the job on Windows using Micro Focus Mainframe Express (MFE). |
| 6. | Provide an example of a Window's CMD file to run the job on Windows using Micro Focus Net Express. |
| 7. | Maintain a single set of COBOL source code that will run on OS/390, Windows and UNIX. |
This suite of samples programs will run on the following platforms.
| 1. | Executes on an IBM Mainframe running MVS or OS/390. The COBOL program complies with ANSI/85 and runs with COBOL/2, COBOL for MVS and COBOL for OS/390. |
| 2. | Executes on Windows/2000, Windows/NT and Windows/XP using Micro Focus Mainframe Express (MFE). |
| 3. | Executes on Windows/2000, Windows/NT and Windows/XP using Micro Focus Net Express and the CMD file provided. |
| 4. | May be ported to run on the UNIX platforms supported by Micro Focus COBOL. |
The following is a flowchart of the job for executing the VSAM access program. The CBLVSMJ1 member (identified by the blue box) is unique to the mainframe and Micro Focus Mainframe Express (MFE). The CBLVSME1 member(identified by the red box) is unique to the Windows platform using Micro Focus Net Express. The CBLVSMC1 member (identified by the green box) is coded to the ANSI/85 COBOL standard and runs on an IBM Mainframe (with MVS or OS/390) or Windows (with Micro Focus COBOL).
|
|
Start the Job | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
|
|
|
|||||||||||||||||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
|
|
Read a VSAM, KSDS and display to console | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
End-of-Job | ||||||||||||||||||||||||||||||||||||||||||||||||||
The following is the Windows Command file (CBLVSME1.CMD) required to run as a MVS batch job on the PC. This process was tested on the PC with Micro Focus Net Express.
@echo OFF
echo * CblVsmE1 is Starting...
rem * *******************************************************************
rem * This program is provided by: *
rem * SimoTime Enterprises, LLC *
rem * (C) Copyright 1987-2006 All Rights Reserved *
rem * Web Site URL: http://www.simotime.com *
rem * e-mail: helpdesk@simotime.com *
rem * *******************************************************************
rem *
rem * Text - COBOL for VSAM, KSDS processing
rem * Author - SimoTime Enterprises
rem * Date - January 01, 1997
rem *
rem * This set of programs illustrates the use of COBOL programs
rem * to do VSAM, Keyed-Sequential-Data-Set I/O.
rem *
rem * The COBOL programs are compiled with the ASSIGN(EXTERNAL) and
rem * the CHARSET(EBCDIC) directives. This provides for external
rem * file mapping of the file names. The CHARSET(EBCDIC) allows for the
rem * processing of the EBCDIC data from the VSAM, KSDS
rem * This technique provides for the use of a single COBOL source
rem * program that will run on OS/390, Windows or Unix.
rem *
rem * This set of programs will run on a Personal Computer with Windows
rem * and Micro Focus Net Express.
rem *
rem * ************
rem * * CblVsmJ1 *
rem * ********jcl*
rem * *
rem * ************
rem * * SIMOEXEC *
rem * ********cbl*
rem * *
rem * *
rem * ************ ************ ************
rem * * VKSD0080 ******* CblVsmC1 ******* Console *
rem * ********dat* ********cbl* ********crt*
rem * *
rem * *
rem * ************
rem * * EOJ *
rem * ************
rem *
rem * *******************************************************************
rem * Step 1 of 2 Set the global environment variables...
rem *
set syslog=d:\simoNXE4\AN01\datawrk1\SYSLOGT1.TXT
SimoEXEC NOTE *******************************************************CblVsmE1
SimoEXEC NOTE Starting JobName CblVsmE1
rem * *******************************************************************
rem * Step 2 of 2 Execute the sample program....
rem *
set VKSD0080=d:\simoMFE1\mx01\datamast\VKSD0080.DAT
SimoEXEC EXEC CblVsmC1
rem *
SimoEXEC NOTE Finished JobName CblVsmE1
if not "%1" == "nopause" pause
The following is the mainframe JCL (CBLVSMJ1.JCL) required to run as an MVS batch job on the mainframe. This will also run on the PC with Micro Focus Mainframe Express. The coding technique is used with the expectation the JCL would be used as a stand alone procedure.
//CBLVSMJ1 JOB SIMOTIME,ACCOUNT,CLASS=1,MSGCLASS=0,NOTIFY=CSIP1, // COND=(0,LT) //* ******************************************************************* //* This program is provided by: * //* SimoTime Enterprises, LLC * //* (C) Copyright 1987-2006 All Rights Reserved * //* Web Site URL: http://www.simotime.com * //* e-mail: helpdesk@simotime.com * //* ******************************************************************* //* //* Text - COBOL for VSAM I/O //* Author - SimoTime Enterprises //* Date - January 01, 1997 //* //* This set of programs illustrates the use of a COBOL program //* to do VSAM sequential I/O. The purpose is to show the processing //* of a VSAM Keyed Sequential Data Set (KSDS). //* //* This set of programs will run on a mainframe under MVS or on a //* Personal Computer with Windows and Micro Focus Mainframe Express. //* //* ************ //* * CBLVSMJ1 * //* ********JCL* //* * //* * //* ************ ************ ************ //* * VKSD0080 *-----* CBLVSMC1 *-----* CONSOLE * //* ********DAT* ********CBL* ********DAT* //* * //* * //* ************ //* * EOJ * //* ************ //* //* ******************************************************************* //* Step 1 of 1 This is a single step job. //* ******************************************************************* //* //CBLVSMX1 EXEC PGM=CBLVSMC1 //STEPLIB DD DSN=SIMOTIME.DEMO.LOADLIB1,DISP=SHR //VKSD0080 DD DSN=SIMOTIME.DATA.VKSD0080,DISP=SHR //*
This program (CBLVSMC1.CBL) was written to be used as a teaching and learning aid. It is a simple program that reads a VSAM, Keyed-Sequential-Data-Set (KSDS) and displays the records. Notice the "Z-DISPLAY-IO-STATUS" routine to display the file status code.
IDENTIFICATION DIVISION.
PROGRAM-ID. CBLVSMC1.
AUTHOR. SIMOTIME ENTERPRISES.
*****************************************************************
* Copyright (C) 1987-2006 SimoTime Enterprises, LLC. *
* *
* All rights reserved. Unpublished, all rights reserved under *
* copyright law and international treaty. Use of a copyright *
* notice is precautionary only and does not imply publication *
* or disclosure. *
* *
* Permission to use, copy, modify and distribute this software *
* for any non-commercial purpose and without fee is hereby *
* granted, provided the SimoTime copyright notice appear on all *
* copies of the software. The SimoTime name or Logo may not be *
* used in any advertising or publicity pertaining to the use *
* of the software without the written permission of SimoTime *
* Enterprises. *
* *
* Permission to use, copy, modify and distribute this software *
* for any commercial purpose requires a fee to be paid to *
* SimoTime Enterprises. Once the fee is received by SimoTime *
* the latest version of the software will be delivered and a *
* license will be granted for use within an enterprise, *
* provided the SimoTime copyright notice appear on all copies *
* of the software. The SimoTime name or Logo may not be used *
* in any advertising or publicity pertaining to the use of the *
* software without the written permission of SimoTime *
* Enterprises. *
* *
* SimoTime Enterprises makes no warranty or representations *
* about the suitability of the software for any purpose. It is *
* provided "AS IS" without any express or implied warranty, *
* including the implied warranties of merchantability, fitness *
* for a particular purpose and non-infringement. SimoTime *
* Enterprises shall not be liable for any direct, indirect, *
* special or consequential damages resulting from the loss of *
* use, data or projects, whether in an action of contract or *
* tort, arising out of or in connection with the use or *
* performance of this software *
* *
* SimoTime Enterprises *
* 15 Carnoustie Drive *
* Novato, CA 94949-5849 *
* 415.883.6565 *
* *
* RESTRICTED RIGHTS LEGEND *
* Use, duplication, or disclosure by the Government is subject *
* to restrictions as set forth in subparagraph (c)(1)(ii) of *
* the Rights in Technical Data and Computer Software clause at *
* DFARS 52.227-7013 or subparagraphs (c)(1) and (2) of *
* Commercial Computer Software - Restricted Rights at 48 *
* CFR 52.227-19, as applicable. Contact SimoTime Enterprises, *
* 15 Carnoustie Drive, Novato, CA 94949-5849. *
* *
*****************************************************************
* This program is provided by SimoTime Enterprises *
* Our e-mail address is: helpdesk@simotime.com *
* Also, visit our Web Site at http://www.simotime.com *
*****************************************************************
*
*****************************************************************
* Source Member: CBLVSMC1.CBL
*****************************************************************
*
* CBLVSMC1 -This is an example of a single COBOL program that
* accesses a VSAM Keyed Sequential Data Set (KSDS).
*
* EXECUTION OR CALLING PROTOCOL
* -----------------------------
* Use standard mainframe JCL to EXECUTE or ANIMATE.
*
* DESCRIPTION
* -----------
* This program uses standard COBOL syntax to access a VSAM
* Keyed Sequential Data Set (KSDS).
*
* ************
* * CBLVSMJ1 *
* ********jcl*
* *
* *
* ************ ************ ************
* * VKSD0080 *-----* CBLVSMC1 *-----* CONSOLE *
* *******vsam* ********cbl* ******dsply*
*
*
* REQUIREMENTS
* ------------
* This program was originally written to conform to the IBM,
* COBOL II dialect but will work with COBOL for MVS or COBOL/390.
* This program may also be executed on the PC using Mainframe
* Express (MFE) from Micro Focus.
*
*****************************************************************
*
* MAINTENANCE
* -----------
* 1997/02/27 Simmons, Created program.
* 1997/02/27 Simmons, No changes to date.
* 1998/11/10 Simmons, Modified to conform to COBOL II.
* 1998/11/21 Simmons, Added code to display file status when an
* I/O error occurs.
*
*****************************************************************
*
ENVIRONMENT DIVISION.
INPUT-OUTPUT SECTION.
FILE-CONTROL.
SELECT VKSD0080-FILE
ASSIGN to VKSD0080
ORGANIZATION is INDEXED
ACCESS MODE is SEQUENTIAL
RECORD KEY is VKSD0080-KEY
FILE STATUS is VKSD0080-STATUS.
*
DATA DIVISION.
FILE SECTION.
FD VKSD0080-FILE.
01 VKSD0080-RECORD.
05 VKSD0080-KEY pic X(6).
05 VKSD0080-DATA pic X(74).
WORKING-STORAGE SECTION.
*****************************************************************
* Data-structure for Title and Copyright...
* ------------------------------------------------------------
01 SIM-TITLE.
05 T1 pic X(11) value '* CBLVSMC1 '.
05 T2 pic X(34) value 'Sample, COBOL for VSAM I/O '.
05 T3 pic X(10) value ' v04.01.23'.
05 T4 pic X(24) value ' http://www.simotime.com'.
01 SIM-COPYRIGHT.
05 C1 pic X(11) value '* CBLVSMC1 '.
05 C2 pic X(20) value 'Copyright 1987-2006 '.
05 C3 pic X(28) value ' SimoTime Enterprises, LLC '.
05 C4 pic X(20) value ' All Rights Reserved'.
01 SIM-THANKS-01.
05 C1 pic X(11) value '* CBLVSMC1 '.
05 C2 pic X(32) value 'Thank you for using this sample '.
05 C3 pic X(32) value 'by SimoTime Enterprises, LLC '.
05 C4 pic X(04) value ' '.
01 SIM-THANKS-02.
05 C1 pic X(11) value '* CBLVSMC1 '.
05 C2 pic X(32) value 'Please send comments or suggesti'.
05 C3 pic X(32) value 'ons to helpdesk@simotime.com '.
05 C4 pic X(04) value ' '.
*****************************************************************
01 VKSD0080-STATUS.
05 VKSD0080-STAT1 pic X.
05 VKSD0080-STAT2 pic X.
*****************************************************************
* The following buffers are used to create a four-byte numeric *
* file status code that may be displayed. *
*****************************************************************
01 IO-STATUS.
05 IO-STAT1 pic X.
05 IO-STAT2 pic X.
01 TWO-BYTES-BINARY pic 9(4) BINARY.
01 TWO-BYTES-ALPHA redefines TWO-BYTES-BINARY.
05 TWO-BYTES-LEFT pic X.
05 TWO-BYTES-RIGHT pic X.
01 IO-STATUS-04.
05 IO-STATUS-0401 pic 9 value 0.
05 IO-STATUS-0403 pic 999 value 0.
*****************************************************************
* Buffer used for posting messages to the console.
*****************************************************************
01 MESSAGE-BUFFER.
05 MESSAGE-HEADER pic X(11) value '* CBLVSMC1 '.
05 MESSAGE-TEXT.
10 MESSAGE-TEXT-1 pic X(68) value SPACES.
10 MESSAGE-TEXT-2 pic X(188) value SPACES.
01 APPL-RESULT pic S9(9) comp.
88 APPL-AOK value 0.
88 APPL-EOF value 16.
01 END-OF-FILE pic X(3) value 'NO '.
*****************************************************************
PROCEDURE DIVISION.
perform Z-POST-COPYRIGHT.
perform VKSD0080-OPEN.
perform until END-OF-FILE = 'YES'
if END-OF-FILE = 'NO '
perform VKSD0080-GET-NEXT
if END-OF-FILE = 'NO '
display VKSD0080-RECORD upon console
end-if
end-if
end-perform.
perform VKSD0080-CLOSE.
move 'NORMAL-END-OF-JOB...' to MESSAGE-TEXT
perform Z-DISPLAY-MESSAGE-TEXT
perform Z-THANK-YOU.
GOBACK.
*****************************************************************
* I/O routines to access a KSDS, VSAM Data Set... *
*****************************************************************
VKSD0080-GET-NEXT.
read VKSD0080-FILE.
if VKSD0080-STATUS = '00'
subtract APPL-RESULT from APPL-RESULT
else
if VKSD0080-STATUS = '10'
add 16 to ZERO giving APPL-RESULT
else
add 12 to ZERO giving APPL-RESULT
end-if
end-if
if APPL-AOK
CONTINUE
else
if APPL-EOF
move 'YES' to END-OF-FILE
else
move 'VKSD0080-FAILURE-GET-!!!' to MESSAGE-TEXT
perform Z-DISPLAY-MESSAGE-TEXT
move VKSD0080-STATUS to IO-STATUS
perform Z-DISPLAY-IO-STATUS
perform Z-ABEND-PROGRAM
end-if
end-if
exit.
*---------------------------------------------------------------*
VKSD0080-OPEN.
add 8 to ZERO giving APPL-RESULT.
open input VKSD0080-FILE
if VKSD0080-STATUS = '00'
subtract APPL-RESULT from APPL-RESULT
else
add 12 to ZERO giving APPL-RESULT
end-if
if APPL-AOK
CONTINUE
else
move 'VKSD0080-FAILURE-OPEN-!!!' to MESSAGE-TEXT
perform Z-DISPLAY-MESSAGE-TEXT
move VKSD0080-STATUS to IO-STATUS
perform Z-DISPLAY-IO-STATUS
perform Z-ABEND-PROGRAM
end-if
exit.
*---------------------------------------------------------------*
VKSD0080-CLOSE.
add 8 to ZERO giving APPL-RESULT.
close VKSD0080-FILE
if VKSD0080-STATUS = '00'
subtract APPL-RESULT from APPL-RESULT
else
add 12 to ZERO giving APPL-RESULT
end-if
if APPL-AOK
CONTINUE
else
move 'VKSD0080-FAILURE-CLOSE-!!!' to MESSAGE-TEXT
perform Z-DISPLAY-MESSAGE-TEXT
move VKSD0080-STATUS to IO-STATUS
perform Z-DISPLAY-IO-STATUS
perform Z-ABEND-PROGRAM
end-if
exit.
*****************************************************************
* The following Z-Routines perform administrative functions
* for this program.
*****************************************************************
Z-ABEND-PROGRAM.
if MESSAGE-TEXT not = SPACES
perform Z-DISPLAY-MESSAGE-TEXT
end-if
move 'PROGRAM IS ABENDING !!!' to MESSAGE-TEXT
perform Z-DISPLAY-MESSAGE-TEXT
add 12 to ZERO giving RETURN-CODE
GOBACK
exit.
*****************************************************************
* Display the file status bytes. This routine will display as *
* four digits. If the full two byte file status is numeric it *
* will display as 00nn. If the 1st byte is a numeric nine (9) *
* the second byte will be treated as a binary number and will *
* display as 9nnn. *
*****************************************************************
Z-DISPLAY-IO-STATUS.
if IO-STATUS not NUMERIC
or IO-STAT1 = '9'
move IO-STAT1 to IO-STATUS-04(1:1)
subtract TWO-BYTES-BINARY from TWO-BYTES-BINARY
move IO-STAT2 to TWO-BYTES-RIGHT
add TWO-BYTES-BINARY to ZERO giving IO-STATUS-0403
move 'File Status is: nnnn' to MESSAGE-TEXT
move IO-STATUS-04 to MESSAGE-TEXT(17:4)
perform Z-DISPLAY-MESSAGE-TEXT
else
move '0000' to IO-STATUS-04
move IO-STATUS to IO-STATUS-04(3:2)
move 'File Status is: nnnn' to MESSAGE-TEXT
move IO-STATUS-04 to MESSAGE-TEXT(17:4)
perform Z-DISPLAY-MESSAGE-TEXT
end-if
exit.
*****************************************************************
* Display CONSOLE messages... *
*****************************************************************
Z-DISPLAY-MESSAGE-TEXT.
if MESSAGE-TEXT-2 = SPACES
display MESSAGE-BUFFER(1:79) upon console
else
display MESSAGE-BUFFER upon console
end-if
move all SPACES to MESSAGE-TEXT
exit.
*****************************************************************
Z-POST-COPYRIGHT.
display SIM-TITLE upon console
display SIM-COPYRIGHT upon console
exit.
*****************************************************************
Z-THANK-YOU.
display SIM-THANKS-01 upon console
display SIM-THANKS-02 upon console
exit.
*****************************************************************
* This example is provided by SimoTime Enterprises *
* Our e-mail address is: helpdesk@simotime.com *
* Also, visit our Web Site at http://www.simotime.com *
*****************************************************************
The purpose of this document is to assist as a tutorial for new programmers or as a quick reference for experienced programmers. These sample programs are made available on an "as-is" basis and may be downloaded, copied and modified for specific situations as long as the copyright information is not removed or changed. As always, it is the programmer's responsibility to thoroughly test all programs.
Permission to use, copy, modify and distribute this software for any commercial purpose requires a fee to be paid to SimoTime Enterprises. Once the fee is received by SimoTime the latest version of the software will be delivered and a license will be granted for use within an enterprise, provided the SimoTime copyright notice appear on all copies of the software. The SimoTime name or Logo may not be used in any advertising or publicity pertaining to the use of the software without the written permission of SimoTime Enterprises.
Permission to use, copy, modify and distribute this software for a non-commercial purpose and without fee is hereby granted, provided the SimoTime copyright notice appear on all copies of the software. The SimoTime name or Logo may not be used in any advertising or publicity pertaining to the use of the software without the written permission of SimoTime Enterprises.
SimoTime Enterprises makes no warranty or representations about the suitability of the software for any purpose. It is provided "AS IS" without any express or implied warranty, including the implied warranties of merchantability, fitness for a particular purpose and non-infringement. SimoTime Enterprises shall not be liable for any direct, indirect, special or consequential damages resulting from the loss of use, data or projects, whether in an action of contract or tort, arising out of or in connection with the use or performance of this software.
If you have any questions, suggestions or comments please call or send an e-mail to: helpdesk@simotime.com
You may download this example at http://www.simotime.com/sim4dzip.htm#VSAMCOBOLAccess as a Z-Pack. The Z-Packs provide individual programming examples, documentation and test data files in a single package. The Z-Packs are usually in zip format to reduce the amount of time to download.
Please view the complete list of SimoTime Z-Pack Examples at http://www.simotime.com/sim4dzip.htm.
Note: You must be attached to the Internet to download a Z-Pack or view the list.
To create the VSAM data set used by this example refer to The VSAM Connection, Common Utility Programs section.
This document provides a quick summary of the VSAM File Status Key.
This link will provide a callable COBOL I/O routine to access a VSAM data set. The I/O routine will also display the file status codes when an I/O error occurs. The COBOL programs are written using the COBOL/2 dialect but also work with COBOL for MVS and COBOL/370.
Are you working with files on the mainframe and files downloaded to the PC? Then take a look at the Table of ASCII and EBCDIC values.
The SimoZAPS Utility Program runs on a Windows platform and has the capability of generating a COBOL program that will do the conversion of sequential and VSAM (KSDS) files between EBCDIC and ASCII. SimoZAPS can also read a sequential file in EBCDIC format and create an ASCII/CRLF file or VSAM Keyed Sequential Data Set in ASCII format. The conversion tables may be viewed or modified to meet unique requirements. The Hexcess function of SimoZAPS provides the capability of viewing, finding or patching the contents of a file in hexadecimal. The following is a list of a few conversion programs created by the GENERATE function of SimoZAPS.
| Program | Description |
| cble2a01 | Convert from an EBCDIC-Sequential file to an ASCII-Sequential file. This example includes a mainframe JCL member. |
| zap00101 | Convert from an EBCDIC-Sequential file to an ASCII-Text file. |
| zap00201 | Convert from an EBCDIC-Sequential file to an ASCII-Indexed file (Sequential-Add). |
| zap00301 | Convert from an EBCDIC-Sequential file to an ASCII-Sequential file. |
| zap00401 | Convert from an ASCII-Text file to an EBCDIC-Indexed file (Sequential-Add). |
| zap00501 | Convert from an ASCII-Text file to an EBCDIC-Indexed file (Random-Add). |
Check out The COBOL Connection in the SimoTime Library for more examples of mainframe COBOL techniques and sample code.
Check out The VSAM-QSAM Connection in the SimoTime Library for more examples of mainframe COBOL techniques and sample code.
This document provides a quick summary of the File Status Key for VSAM data sets and QSAM files. The File Status Key is a two character data item. The first character of the status key is known as status key 1; the second character is known as status key 2.
If you have any questions, suggestions or comments please call or send an e-mail to: helpdesk@simotime.com
Founded in 1987, SimoTime Enterprises is a privately owned, Limited Liability Corporation located in Novato, California. We specialize in the creation and deployment of business applications using new or existing technologies and services. We have a team of individuals that understand the broad range of technologies being used in today's environments. This includes the smallest thin client using the Internet and the very large mainframe systems. There is more to making the Internet work for your company's business than just having a nice looking WEB site. It is about combining the latest technologies and existing technologies with practical business experience. It's about the business of doing business and looking good in the process. Quite often, to reach larger markets or provide a higher level of service to existing customers it requires the newer Internet technologies to work in a complementary manner with existing corporate mainframe systems. Whether you want to use the Internet to expand into new market segments or as a delivery vehicle for existing business functions simply give us a call or check the web site at http://www.simotime.com
| Return-to-Top |
| Copyright © 1987-2008 SimoTime Enterprises, LLC All Rights Reserved |
| When technology complements business |
| http://www.simotime.com |