|
Variable Length Records ZOS File Transfer and File Convert |
![]() |
| The SimoTime Home Page |
The objective of this suite of programs is to provide a solution for using FTP or Shared Network Disk to transfer a mainframe sequential file with variable length records to a Linux, UNIX or Windows System. Batch Job Scripts are provided to compile and execute the programs and review the results. The jobs have been tested on a Microsoft Windows/7 System using Command Files and Micro Focus COBOL technologies. The jobs have been tested on a Linux System (Ubuntu 16.04 LTS) using Bash Shell Scripts and GnuCOBOL.
The technique used will not require a file conversion on the ZOS Mainframe System. The sequential file with variable length records is transferred from the Mainframe System to the Linux, UNIX or Windows System using File Transfer Protocol (FTP) and BINARY Mode. The transfer is requested from the Linux, UNIX or Windows System using an FTP Client.
This suite of programs covers both the transfer and file format conversion of sequential files with variable length records. Other documents are available that will focus on file processing using standard COBOL with SELECT and FD definitions. Also, HTML documentation for Mainframe File Transfer using FTP commands is available.
This example makes a call to COBOL subroutines that are part of the SIMOMODS series of programs that are available from SimoTime.
Refer to the Download and Links section of this document for links to additional documents that discuss this topic.
Note: The called subroutines use COBOL functionality that is unique to Micro Focus or GnuCOBOL. Therefore, a non-mainframe dialect is required when compiling the subroutines. The COBOL programs have been tested with Micro Focus COBOL and GnuCOBOL using ASCII-encoding and a non-mainframe dialect.
We have made a significant effort to ensure the documents and software technologies are correct and accurate. We reserve the right to make changes without notice at any time. The function delivered in this version is based upon the enhancement requests from a specific group of users. The intent is to provide changes as the need arises and in a timeframe that is dependent upon the availability of resources.
Copyright © 1987-2025
SimoTime Technologies and Services
All Rights Reserved
This example illustrates the following functions.
| ||||||
| The Transfer and Conversion Process of Files with Variable Length Records |
A mainframe formatted sequential file with variable length records is the input to this suite of programs. The input file is transferred from the Mainframe system using the File Transfer Protocol (FTP) and BINARY mode. After the file is transferred from the Mainframe system to a Linux, UNIX or Windows system the file will be processed using COBOL programs.
The input file is a binary image of the mainframe file and the file types supported by this suite of sample programs are as follows.
| Type | Description | ||||||||||||||||||
| V | Variable, if not specified the default value is 'V". The four bytes preceding the logical record is the Record Descriptor Word. The content is as follows.
|
||||||||||||||||||
| VB | Variable Blocked The four bytes preceding the logical record (Descriptor Word) are as follows.
|
||||||||||||||||||
| VBS | Variable Blocked Spanned The four bytes preceding the logical record is the Segment Descriptor Word. The content is as follows.
|
The format of the output file is the user’s choice. This suite of jobs includes a Windows Command File that will create a Micro Focus file formatted with variable length records and a Bash Script that will create a GnuCOBOL file formatted with Variable length records.
Once the output file is created it may be processed with a COBOL program using standard COBOL coding techniques. At this stage of the process the record content is a mirror image of what was transferred from the Mainframe System. The records are text strings of EBCDIC-encoded data.
Refer to the Map File Names section of this document for additional information about setting environment variables to map program file names to physical file names.
This suite of samples programs will run on the following platforms.
| ||||||
| Programming Requirements for the File Transfer and Convert Software |
This suite of three COBOL programs will read a mainframe formatted sequential file with variable length records.
Color Associations: The The following described each of the programs in more detail.
|
| Variable | Description | ||||||||||||||||||||||||||||||||||||||||||
| INITREC1 | Must be "A" or "E" to initialize the record area with x"20" or x"40". If not specified the default value is "E". | ||||||||||||||||||||||||||||||||||||||||||
| EXTFH | Points to the EXTFH.CFG file if used. This is an optional environment variable | ||||||||||||||||||||||||||||||||||||||||||
| BSIOFMT1 | Identifies the format of the input file. The following are the options for this environment variable.
Note 1: For a mainframe file with variable length, unblocked records each record is preceded by a four byte descriptor word. The first two bytes is a two byte binary value for the record length followed by two bytes of Low Values. By using VO the reasonability check will be bypassed. Note 2: For a mainframe file with variable length, blocked records each record is preceded by a four byte descriptor word. The first two bytes is a two byte binary value for the record length. The second part is a two byte Block Descriptor Word (BDW). By using VBO the reasonability check will be bypassed. Note 3: For a mainframe file with variable length, blocked, spanned record segments each record is preceded by a four byte Segment Descriptor Word. The first two bytes is a two byte binary value for the record segment length. The third byte is a segment control code and the fourth byte is a low value or binary 00. |
The following are the environment variables used to map the file names used by the programs to the actual file names used on the external storage media or hard disk.
| ||||||
| Programming Requirements for the File Transfer and Convert Software |
A sequential data file with variable length records that is a mirror image of a mainframe formatted file must be converted to a Micro Focus or GnuCOBOL formatted file with variable length records. The file that is a mainframe image cannot be accessed at the record level from a COBOL program using the standard SELECT and FD syntax. Therefore, the byte-stream I/O capabilities provided by Micro Focus or GnuCOBOL will be used to read this file.
The following program (VRECEXC1.cbl) will read the mainframe file by calling the SIMOVREC.CBL program. SIMOVREC.CBL will call SIMOBSIO.CBL to read text strings from the mainframe file and build logical records to pass back to the following program. The following program will then use standard COBOL coding techniques to write the records to a Micro Focus or GnuCOBOL formatted file.
IDENTIFICATION DIVISION.
PROGRAM-ID. VRECEXC1.
AUTHOR. SIMOTIME TECHNOLOGIES.
*****************************************************************
* Copyright (C) 1987-2019 SimoTime Technologies. *
* *
* 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 *
* Technologies. *
* *
* Permission to use, copy, modify and distribute this software *
* for any commercial purpose requires a fee to be paid to *
* SimoTime Technologies. 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 *
* Technologies. *
* *
* SimoTime Technologies makes no warranty or representations *
* about the suitability of the software for any purpose. It is *
* provided "AS IS" without any expressed or implied warranty, *
* including the implied warranties of merchantability, fitness *
* for a particular purpose and non-infringement. SimoTime *
* Technologies 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 Technologies *
* 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 Technologies, *
* 15 Carnoustie Drive, Novato, CA 94949-5849. *
* *
*****************************************************************
* This program is provided by SimoTime Technologies *
* Our e-mail address is: helpdesk@simotime.com *
* Also, visit our Web Site at http://www.simotime.com *
*****************************************************************
*
*****************************************************************
* Source Member: VRECEXC1.CBL
* Copy Files: PASSRTN1.CPY
* ASCEBCB1.CPY
* Calls to: SIMOVREC
* SIMOBSIO
*****************************************************************
*
* ************
* * VRECEXE1 *
* ********cmd*
* *
* ************
* * if exist *
* ********stmt*
* *
* ************ ************ ************
* * BSIODSN1 *-----* VRECEXC1 *-----* SQEDDV01 *
* ********dat* ********cbl* ********dat*
* * *
* * * ************
* * *--call-* SIMOVREC *
* * ********cbl*
* * *
* * * ************
* * *--call-* SIMOBSIO *
* * ********cbl*
* ************
* * EOJ *
* ************
*
*****************************************************************
ENVIRONMENT DIVISION.
INPUT-OUTPUT SECTION.
FILE-CONTROL.
SELECT SQEDDV01-FILE ASSIGN to SQEDDV01
ORGANIZATION is SEQUENTIAL
ACCESS MODE is SEQUENTIAL
FILE STATUS is SQEDDV01-STATUS.
*****************************************************************
DATA DIVISION.
FILE SECTION.
FD SQEDDV01-FILE
DATA RECORD is SQEDDV01-RECORD
RECORDING MODE is V
* ------------------------------------------------------------
* The following may need to be changed to match actual file.
RECORD is VARYING in SIZE from 4 to 32760
depending on SQEDDV01-LREC.
01 SQEDDV01-RECORD.
05 SQEDDV01-DATA-01 pic X(32760).
* The preceding may need to be changed to match actual file.
* ------------------------------------------------------------
WORKING-STORAGE SECTION.
01 SIM-TITLE.
05 T1 pic X(11) value '* VRECEXC1 '.
05 T2 pic X(34) value 'Variable Record Routine v01.00.00 '.
05 T3 pic X(10) value ' v06.10.23'.
05 T4 pic X(24) value ' http://www.simotime.com'.
01 SIM-COPYRIGHT.
05 C1 pic X(11) value '* VRECEXC1 '.
05 C2 pic X(20) value 'Copyright 1987-2019 '.
05 C3 pic X(28) value ' SimoTime Technologies '.
05 C4 pic X(20) value ' All Rights Reserved'.
01 SIM-THANKS-01.
05 C1 pic X(11) value '* VRECEXC1 '.
05 C2 pic X(32) value 'Thank you for using this program'.
05 C3 pic X(32) value ' provided from SimoTime Technolo'.
05 C4 pic X(04) value 'gies'.
01 SIM-THANKS-02.
05 C1 pic X(11) value '* VRECEXC1 '.
05 C2 pic X(32) value 'Please send all inquires or sugg'.
05 C3 pic X(32) value 'estions to the helpdesk@simotime'.
05 C4 pic X(04) value '.com'.
01 MESSAGE-BUFFER.
05 MESSAGE-HEADER pic X(11) value '* VRECEXC1 '.
05 MESSAGE-TEXT.
10 MESSAGE-TEXT-1 pic X(68) value SPACES.
10 MESSAGE-TEXT-2 pic X(188) value SPACES.
01 SQEDDV01-STATUS.
05 SQEDDV01-STATUS-L pic X.
05 SQEDDV01-STATUS-R pic X.
01 SQEDDV01-EOF pic X value 'N'.
01 SQEDDV01-OPEN-FLAG pic X value 'C'.
01 IO-STATUS.
05 IO-STAT1 pic X.
05 IO-STAT2 pic X.
01 TWO-BYTES.
05 TWO-BYTES-LEFT pic X.
05 TWO-BYTES-RIGHT pic X.
01 TWO-BYTES-BINARY redefines TWO-BYTES pic 9(4) comp.
01 APPL-RESULT pic S9(9) comp.
88 APPL-AOK value 0.
88 APPL-EOF value 16.
01 SQEDDV01-LREC pic 9(5) comp value 0.
01 SQEDDV01-LREC-ALPHA redefines SQEDDV01-LREC.
05 VREC-LEN-1 pic X(2).
05 VREC-LEN-2 pic X(2).
01 SQEDDV01-LBLK pic 9(5) comp value 0.
01 SQEDDV01-LBLK-ALPHA redefines SQEDDV01-LBLK.
05 VBLK-LEN-1 pic X(2).
05 VBLK-LEN-2 pic X(2).
01 RECORD-LENGTH-DISPLAY.
05 filler pic X(15) value 'Record length: '.
05 RECORD-LENGTH-VALUE pic 9(5) value 0.
01 RECORD-MIN-DISPLAY.
05 filler pic X(15) value 'Record MIN is: '.
05 RECORD-MIN-VALUE pic 9(4) value 0.
01 RECORD-MAX-DISPLAY.
05 filler pic X(15) value 'Record MAX is: '.
05 RECORD-MAX-VALUE pic 9(4) value 0.
01 BSIOREAD-TOTAL.
05 filler pic X(18) value 'BSIOREAD count is '.
05 BSIOREAD-COUNT pic 9(7) value 0.
01 BSIOBLOK-TOTAL.
05 filler pic X(18) value 'BSIOBLOK count is '.
05 BSIOBLOK-COUNT pic 9(7) value 0.
01 SQEDDV01-TOTAL.
05 filler pic X(18) value 'SQEDDV01 count is '.
05 SQEDDV01-COUNT pic 9(7) value 0.
COPY PASSVREC.
*01 PASSVREC-AREA.
* 05 VREC-REQUEST pic X(8) value 'GET '.
* 05 VREC-RESPOND pic 9(4) value 0.
* 05 VREC-LENGTH pic 9(5) value 0.
* 05 VREC-BUFFER pic X(32760) value SPACES.
*****************************************************************
PROCEDURE DIVISION.
perform GET-STARTED
perform SQEDDV01-OPEN
add 80 to ZERO giving SQEDDV01-LREC
perform until VREC-RESPOND not = ZERO
call 'SIMOVREC' using PASSVREC-AREA
if VREC-RESPOND = ZERO
add VREC-LENGTH to ZERO giving SQEDDV01-LREC
move VREC-BUFFER to SQEDDV01-RECORD
perform SQEDDV01-WRITE
end-if
end-perform
perform SQEDDV01-CLOSE
perform Z-THANK-YOU.
GOBACK.
*****************************************************************
GET-STARTED.
perform Z-POST-COPYRIGHT
move 'GET ' to VREC-REQUEST
move ZERO to VREC-RESPOND
move ZERO to VREC-LENGTH
move SPACES to VREC-BUFFER
exit.
*****************************************************************
* I/O ROUTINES FOR SQEDDV01... *
*****************************************************************
SQEDDV01-WRITE.
if SQEDDV01-OPEN-FLAG = 'C'
perform SQEDDV01-OPEN
end-if
write SQEDDV01-RECORD
if SQEDDV01-STATUS = '00'
subtract APPL-RESULT from APPL-RESULT
else
if SQEDDV01-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
move 'SQEDDV01-Failure-WRITE...' to MESSAGE-TEXT
perform Z-DISPLAY-CONSOLE-MESSAGE
move SQEDDV01-STATUS to IO-STATUS
perform Z-DISPLAY-IO-STATUS
perform Z-ABEND-PROGRAM
end-if
exit.
*---------------------------------------------------------------*
SQEDDV01-OPEN.
add 8 to ZERO giving APPL-RESULT.
open output SQEDDV01-FILE
if SQEDDV01-STATUS = '00'
subtract APPL-RESULT from APPL-RESULT
move 'O' to SQEDDV01-OPEN-FLAG
else
add 12 to ZERO giving APPL-RESULT
end-if
if APPL-AOK
CONTINUE
else
move 'SQEDDV01-Failure-OPEN...' to MESSAGE-TEXT
perform Z-DISPLAY-CONSOLE-MESSAGE
move SQEDDV01-STATUS to IO-STATUS
perform Z-DISPLAY-IO-STATUS
perform Z-ABEND-PROGRAM
end-if
exit.
*---------------------------------------------------------------*
SQEDDV01-CLOSE.
add 8 to ZERO giving APPL-RESULT.
close SQEDDV01-FILE
if SQEDDV01-STATUS = '00'
subtract APPL-RESULT from APPL-RESULT
move 'C' to SQEDDV01-OPEN-FLAG
else
add 12 to ZERO giving APPL-RESULT
end-if
if APPL-AOK
CONTINUE
else
move 'SQEDDV01-Failure-CLOSE...' to MESSAGE-TEXT
perform Z-DISPLAY-CONSOLE-MESSAGE
move SQEDDV01-STATUS to IO-STATUS
perform Z-DISPLAY-IO-STATUS
perform Z-ABEND-PROGRAM
end-if
exit.
*****************************************************************
* The following Z-Routines perform administrative tasks *
* for this program. *
*****************************************************************
* ABEND the program, post a message to the console and issue *
* a STOP RUN. *
*****************************************************************
Z-ABEND-PROGRAM.
if MESSAGE-TEXT not = SPACES
perform Z-DISPLAY-CONSOLE-MESSAGE
end-if
move 'PROGRAM-IS-ABENDING...' to MESSAGE-TEXT
perform Z-DISPLAY-CONSOLE-MESSAGE
add 12 to ZERO giving RETURN-CODE
STOP RUN.
* exit.
*****************************************************************
* Display CONSOLE messages... *
*****************************************************************
Z-DISPLAY-CONSOLE-MESSAGE.
if MESSAGE-TEXT-2 = SPACES
display MESSAGE-BUFFER(1:79)
else
display MESSAGE-BUFFER
end-if
move all SPACES to MESSAGE-TEXT
exit.
*****************************************************************
* Display the file status bytes. This routine will display as *
* two digits if the full two byte file status is numeric. If *
* second byte is non-numeric then it will be treated as a *
* binary number. *
*****************************************************************
Z-DISPLAY-IO-STATUS.
if IO-STATUS not NUMERIC
or IO-STAT1 = '9'
subtract TWO-BYTES-BINARY from TWO-BYTES-BINARY
move IO-STAT2 to TWO-BYTES-RIGHT
display '* VRECEXC1 File-Status-' IO-STAT1 '/'
TWO-BYTES-BINARY
else
display '* VRECEXC1 File-Status-' IO-STATUS
end-if
exit.
*****************************************************************
Z-POST-COPYRIGHT.
display SIM-TITLE
display SIM-COPYRIGHT
exit.
*****************************************************************
Z-THANK-YOU.
display SIM-THANKS-01
display SIM-THANKS-02
exit.
*****************************************************************
* This example is provided by SimoTime Technologies *
* 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 show how to transfer a file from a mainframe using File Transfer Protocol (FTP). The mainframe file is an EBCDIC-encoded, sequential file with variable length records. Once the file is transferred the file format will be converted to a Micro Focus formatted file with variable length records. The content of the records will remain EBCDIC encoded. This document may be used to assist as a tutorial for new programmers or as a quick reference for experienced programmers.
In the world of programming there are many ways to solve a problem. This documentation and software were developed and tested on systems that are configured for a SIMOTIME environment based on the hardware, operating systems, user requirements and security requirements. Therefore, adjustments may be needed to execute the jobs and programs when transferred to a system of a different architecture or configuration.
SIMOTIME Services has experience in moving or sharing data or application processing across a variety of systems. For additional information about SIMOTIME Services or Technologies please contact us using the information in the Contact or Feedback section of this document.
Software Agreement and Disclaimer
Permission to use, copy, modify and distribute this software, documentation or training material for any purpose requires a fee to be paid to SimoTime Technologies. Once the fee is received by SimoTime the latest version of the software, documentation or training material 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 Technologies.
SimoTime Technologies makes no warranty or representations about the suitability of the software, documentation or learning material for any purpose. It is provided "AS IS" without any expressed or implied warranty, including the implied warranties of merchantability, fitness for a particular purpose and non-infringement. SimoTime Technologies 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, documentation or training material.
This section includes links to documents with additional information that are beyond the scope and purpose of this document. The first group of documents may be available from a local system or via an Internet connection, the second group of documents will require an Internet connection.
Note: A SimoTime License is required for the items to be made available on a local system or server.
The following links may be to the current server or to the Internet.
Note: The latest versions of the SimoTime Documents and Program Suites are available on the Internet and may be accessed using the
icon. If a user has a SimoTime Enterprise License the Documents and Program Suites may be available on a local server and accessed using the
icon.
Explore the non-Relational Data Connection for more examples of accessing methodologies and coding techniques for Data Files and VSAM Data Sets.
Explore An Enterprise System Model that describes and demonstrates how Applications that were running on a Mainframe System and non-relational data that was located on the Mainframe System were copied and deployed in a Microsoft Windows environment with Micro Focus Enterprise Server.
Explore the alternatives for transferring data files between systems. This link provides access to a repository of information that includes the transferring and/or sharing of data between Mainframe (ZOS or VSE), Linux, UNIX and Windows Systems.
Explore The ASCII and EBCDIC Translation Tables. These tables are provided for individuals that need to better understand the bit structures and differences of the encoding formats.
Explore The File Status Return Codes that are used to interpret the results of accessing VSAM data sets and/or QSAM files.
The following links will require an Internet connect.
This suite of programs and documentation is available to download for review and evaluation purposes. Other uses will require a SimoTime Software License. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.
A good place to start is The SimoTime Home Page for access to white papers, program examples and product information. This link requires an Internet Connection
Explore The Micro Focus Web Site for more information about products (including Micro Focus COBOL) and services available from Micro Focus. This link requires an Internet Connection.
Explore the GnuCOBOL Technologies available from SourceForge. SourceForge is an Open Source community resource dedicated to helping open source projects be as successful as possible. GnuCOBOL (formerly OpenCOBOL) is a COBOL compiler with run time support. The compiler (cobc) translates COBOL source to executable using intermediate C, designated C compiler and linker. This link will require an Internet Connection.
Explore the Glossary of Terms for a list of terms and definitions used in this suite of documents and white papers.
This document was created and is maintained by SimoTime Technologies. If you have any questions, suggestions, comments or feedback please use the following contact information.
| 1. | Send an e-mail to our helpdesk. |
| 1.1. | helpdesk@simotime.com. |
| 2. | Our telephone numbers are as follows. |
| 2.1. | 1 415 763-9430 office-helpdesk |
| 2.2. | 1 415 827-7045 mobile |
We appreciate hearing from you.
SimoTime Technologies was founded in 1987 and is a privately owned company. 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. Our customers include small businesses using Internet technologies to corporations using very large mainframe systems.
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. We specialize in preparing applications and the associated data that are currently residing on a single platform to be distributed across a variety of platforms.
Preparing the application programs will require the transfer of source members that will be compiled and deployed on the target platform. The data will need to be transferred between the systems and may need to be converted and validated at various stages within the process. SimoTime has the technology, services and experience to assist in the application and data management tasks involved with doing business in a multi-system environment.
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 |
| Files with Variable Length Records, File Transfer and File Convert |
| Copyright © 1987-2025 SimoTime Technologies and Services All Rights Reserved |
| When technology complements business |
| http://www.simotime.com |