Special Purpose Files Manage with Micro Focus Environment |
The SimoTime Home Page |
Creating the catalog for a new Enterprise Server, Mainframe Sub-System environment is a critical task that needs to be implemented at the beginning of a project that requires the moving or migration of non-relational data files (this includes VSAM Data Sets). This quickly becomes a much larger task to replicate and adapt across various groups such as System Testing, Production and individual programmers doing development, unit testing and support. The process for creating and populating a catalog should be setup as a repeatable process from the beginning.
This document has been created as a reference for individuals that have a very good understanding of the Windows Operating System and have attended the basic training classes for Micro Focus Enterprise Server.
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
The purpose of this document is to focus on the task of populating a catalog with the entries for the Special Purpose files. The term "populate a catalog" is used to reference the process of creating a catalog entry in the Micro Focus Mainframe Sub-System environment.
Creating a catalog entry for the Special Purpose files can be as simple as submitting a job to a Micro Focus Server that is configured to support a Mainframe Sub-System and batch processing (or JES Server). Most of the effort is usually spent identifying the Special Purpose files (and their properties) required by the application being migrated.
The following provides an overview of the logic flow for the Management process for the Special Purpose files.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Note:1 The JCL member (MAKEESDS.JCL) that is submitted to the Internal Reader is a generated member. |
Identify, Define and Integrate Sequential Files into the JES Server Environment |
Before we can run (or submit) jobs it will be necessary to start a server that has been configured to run mainframe-oriented jobs (i.e. process JCL members).
The SYS1START command file calls the ENV1BASE command file to set commonly used environment variables. It then calls the SYS1BAKConsole command file to provide a backup of the previously created "console.log" file. It then starts the specified server based on the first parameter of the command line. The following is an example of the command line syntax. The first parameter is the name of the server to be started.
C:\SIMOSAM1\SYS1\LOADLIB> SYS1START ServerName
For the SimoTime JES Server use the following command.
C:\SIMOSAM1\SYS1\LOADLIB> SYS1START SIMOBATA
This link provides an example of How to Configure a Micro Focus Server for batch processing using JCL scripts.
The approach used in this example uses an Excel Spreadsheet to manage a list of Special Purpose files along with detailed information about each file. The preferred format for using Excel is the XLSS format. Once the list has been completed a separate copy should be saved as a CSV file. The CSV file will be used by subsequent steps in the creation of the catalog entries for the Special Purpose files.
The first task in this step will be to convert the ASCII/Text file with CSV records into a record sequential file with fixed field lengths and a fixed record length of 1,024 bytes. This new file can then be processed using standard, mainframe-oriented COBOL programs and JCL. The following command (CATX10E1.cmd) will do the file conversion.
@echo OFF rem * ******************************************************************* rem * CATX10E1.CMD - a Windows Command File * rem * This program is provided by SimoTime Technologies * rem * (C) Copyright 1987-2019 All Rights Reserved * rem * Web Site URL: http://www.simotime.com * rem * e-mail: helpdesk@simotime.com * rem * ******************************************************************* rem * rem * Text - Convert LONAPCSV to LONAPFFL for a Data Structures. rem * Author - SimoTime Technologies rem * Date - January 24, 1996 rem * rem * LONAP - an acronym for a List Of Names And Properties. rem * CSV - an acronym for Comma-Separated-Values. rem * FFL - an acronym for Fixed-Field-Length. rem * rem * The job will convert an LSEQ file of variable length records rem * to an RSEQ file of 1,024-byte fixed length records. The text rem * string in the individual records will be converted from a rem * Comma-Separated-Values (CSV) text string to a record structure rem * with a Fixed-Field-Length (FFL) format. rem * rem * ************ rem * * CATX10E1 * rem * ********cmd* rem * * rem * ************ ************ rem * * CATSEQJ9 *-----* LONAPFFL * DISP=DELETE rem * ********jcl* *******rseq* rem * * rem * ************ ************ ************ rem * * LONAPCSV *-----* LONAPTIO *-----* LONAPFFL * CSV to FFL rem * *******lcsv* ********cbl* *******rseq* rem * * rem * ************ ************ rem * * CATX10J1 *-----* LONAPFFL * DISP=CATLG rem * ********jcl* *******rseq* rem * * rem * ************ rem * * EOJ * rem * ************ rem * rem * rem * ******************************************************************* rem * Step 1 of 4, Preparation, Set the Environment... rem * set CmdName=CATX10E1 call ..\..\Env1BASE %CmdName% if "%SYSLOG%" == "" set syslog=c:\SimoLIBR\LOGS\SimoTime.LOG rem * call SimoNOTE "*******************************************************%CmdName%" call SimoNOTE "Starting CmdName %CmdName%" call SimoNOTE "StepInfo Map DD File Names to DSN File Names" set LONAPCSV=%BaseLib1%\DATA\XLSS\LONAPX10.CSV set LONAPFFL=%BASECAT%\APPL\SIMOTIME.UTIL.X10LIST1.DAT rem * rem * ******************************************************************* rem * Step 2 of 4, Delete a possible file from a previous execution. rem * Note: This step requires the SIMOBATA Server to be started. rem * call SimoNOTE "StepInfo Delete a possible file from a previous execution" call SYS1SCHEDULE %JESSERVERNAME% CATX10J9 if not "%ERRORLEVEL%" == "0" set JobStatus=0010 if not %JobStatus% == 0000 goto :EojNok rem * rem * ******************************************************************* rem * Step 3 of 3, Convert the Line Sequential File of CSV record format rem * to a Record Sequential file with Fixed-Field record format. rem * Note: This step will do a File Format conversion (i.e. Line rem * Sequential to Record Sequential) and a record content conversion rem * (i.e. CSV to Fixed-Field). rem * call SimoNOTE "StepInfo Execute the File Format and Record Content Conversion" run LONAPTIO if not "%ERRORLEVEL%" == "0" set JobStatus=0020 if not %JobStatus% == 0000 goto :EojNok call SimoNOTE "DataTake %LONAPCSV%" call SimoNOTE "DataMake %LONAPFFL%" rem * rem * ******************************************************************* rem * Step 3 of 3, Define a Catalog entry for SIMOTIME.UTIL.KSDLIST1 rem * in the Catalog for the SIMOBATA JES Server. rem * Note: This step requires the SIMOBATA Server to be started. rem * call SimoNOTE "StepInfo Define a Catalog entry for SIMOTIME.UTIL.X10LIST1" call SYS1SCHEDULE %JESSERVERNAME% CATX10J1 if not "%ERRORLEVEL%" == "0" set JobStatus=0030 if not %JobStatus% == 0000 goto :EojNok rem * if exist %LONAPFFL% goto :EojAok set JobStatus=0020 goto :EojNok :EojAok call SimoNOTE "Finished JobName %CmdName%, Job Status is %JobStatus%" goto :End :EojNok call SimoNOTE "ABENDING JobName %CmdName%, Job Status is %JobStatus%" :End if not "%1" == "NOPAUSE" PAUSE
Once the file conversion is complete the preceding command will submit the following job (CATX10J1.jcl) to create a catalog entry for the new file.
//CATX10J1 JOB SIMOTIME,CLASS=1,MSGCLASS=0,NOTIFY=CSIP1 //* ******************************************************************* //* This JCL Member is provided by SimoTime Technologies * //* (C) Copyright 1987-2016 All Rights Reserved * //* Web Site URL: http://www.simotime.com * //* e-mail: helpdesk@simotime.com * //* ******************************************************************* //* //* Text - Create a catalog entry for the X10LIST file. //* Author - SimoTime Technologies //* Date - January 24, 1996 //* //* //* ******************************************************************* //* Step 1 of 1, Create a Catalog Entry for the PDSLIST. This is a file //* with records of 1,024 bytes and Fixed Field Length. //* //CATENTRY EXEC PGM=IEFBR14 //X10LIST1 DD DSN=SIMOTIME.UTIL.X10LIST1,DISP=(NEW,CATLG,CATLG), // STORCLAS=MFI, // SPACE=(TRK,5), // DCB=(RECFM=FB,LRECL=1024,DSORG=PS) //*
The following copy file (LONAPFFL.cpy) describes the record layout for the format of the KSDS List file that contains fixed field lengths.
***************************************************************** * LONAPFFL.CPY - a COBOL Copy File * * Record Layout for the File Properties Repository * * The record stucture is a fixed length of 1,024 characters * * Copyright (C) 1987-2019 SimoTime Technologies * * All Rights Reserved * * Provided by SimoTime Technologies * * Our e-mail address is: helpdesk@simotime.com * * Also, visit our Web Site at http://www.simotime.com * ***************************************************************** * The information that is imported into this format originates * from an Excel spreadsheet. The spreadsheet is saved to an * ASCII/Text File with a Comma-Separated-Values (or CSV) record * structure. * * LONAP is an acronym for a List Of Names And Properties. * CSV is an acronym for Comma-Separated-Values. * FFL is an acronym for Fixed-Field-Length. * * A conversion program is used to convert the CSV File to a * Record Sequential File with the following Fixed Field format. * * The fields are all fixed length. * Numeric fields are right-adjusted with leading zeroes. * Alpha-numeric fields are left adjusted with trailing spaces. * * Positions 73-80 of the following statements are used to * identify the original columns used in the Excel spreadsheet. * 01 LONAPFFL-REC. Excel 05 LONAPFFL-LEVEL-CHR. 10 LONAPFFL-LEVEL-NBR PIC 9(2). col-A 05 LONAPFFL-FILE-INFO. 10 LONAPFFL-DSN PIC X(54). col-B 10 LONAPFFL-DD-NAME PIC X(17). col-C 10 LONAPFFL-DSORG PIC X(4). col-D 10 LONAPFFL-RECFM PIC X(4). col-E 10 LONAPFFL-LRECL-MIN PIC 9(5). col-F 10 LONAPFFL-LRECL-MAX PIC 9(5). col-G 10 LONAPFFL-KEYPOS PIC 9(5). col-H 10 LONAPFFL-KEYLEN PIC 9(5). col-I 10 LONAPFFL-VSAM-DAT PIC X(58). col-J 10 LONAPFFL-VSAM-IDX PIC X(58). col-K 05 LONAPFFL-JOB-EXEC. 10 LONAPFFL-JCL-OVR1 PIC X(8). col-L 10 LONAPFFL-JCL-USR1 PIC X(8). col-M 10 LONAPFFL-JCL-USR2 PIC X(8). col-N 05 LONAP-EXTENDED-GROUP. 10 LONAPFFL-EXTENDED-S1 PIC X(4). col-O 10 LONAPFFL-EXTENDED-S2 PIC X(4). col-P 10 LONAPFFL-EXTENDED-M1 PIC X(16). col-Q 10 LONAPFFL-EXTENDED-M2 PIC X(16). col-R 10 LONAPFFL-EXTENDED-M3 PIC X(16). col-S 10 LONAPFFL-EXTENDED-M4 PIC X(16). col-T 10 LONAPFFL-EXTENDED-X1 PIC X(256). col-U 10 LONAPFFL-EXTENDED-X2 PIC X(256). col-V 05 FILLER PIC X(199). * *** LONAPFFL - End-of-Copy File - - - - - - - - - - - LONAPFFL * ***************************************************************** *
This step will create the catalog entries defined in the list of names and properties for the Special Purpose files. This is accomplished by generating the JCL and submitting the generated JCL to the internal reader (INTRDR). The following command (CATX10E2.cmd) shows the syntax for submitting the job that does the actual creation of the catalog entries.
@echo OFF rem * ******************************************************************* rem * CATX10E2.CMD - a Windows Command File * rem * This program is provided by SimoTime Technologies * rem * (C) Copyright 1987-2019 All Rights Reserved * rem * Web Site URL: http://www.simotime.com * rem * e-mail: helpdesk@simotime.com * rem * ******************************************************************* rem * rem * Text - Read KSD List of Names, create catalog entries for KSD's. rem * Author - SimoTime Technologies rem * Date - January 24, 1996 rem * rem * LONAP - an acronym for a List Of Names And Properties. rem * CSV - an acronym for Comma-Separated-Values. rem * FFL - an acronym for Fixed-Field-Length. rem * rem * The job will read the file containing a list of PDS Names and rem * create a catalog entry for each record in the file. rem * rem * ************ rem * * CATX10E2 * rem * ********cmd* rem * * rem * ************ ************ ************ rem * * X10LIST1 *----- * CATX10J2 *-----* X10ENTRY * CATALOG ENTRIES rem * *******rseq* ********jcl* ********pds* rem * * rem * ************ rem * * EOJ * rem * ************ rem * rem * rem * ******************************************************************* rem * Step 1 of 4, Preparation, Set the Environment... rem * set CmdName=CATX10E2 call ..\..\Env1BASE %CmdName% if "%SYSLOG%" == "" set syslog=c:\SimoLIBR\LOGS\SimoTime.LOG rem * call SimoNOTE "*******************************************************%CmdName%" call SimoNOTE "Starting CmdName %CmdName%, Server is %JESSERVERNAME%" rem * call SimoNOTE "StepInfo Define Catalog entries using the X10LIST File" call SYS1SCHEDULE %JESSERVERNAME% CATX10J2 if not "%ERRORLEVEL%" == "0" set JobStatus=0030 if not %JobStatus% == 0000 goto :EojNok :EojAok call SimoNOTE "Finished JobName %CmdName%, Server is %JESSERVERNAME%, Job Status is %JobStatus% " goto :End :EojNok call SimoNOTE "ABENDING JobName %CmdName%, Server is %JESSERVERNAME%, Job Status is %JobStatus% " :End if not "%1" == "NOPAUSE" PAUSE
The following (CATX10J2.jcl) shows the content of the job that will be submitted.
//CATX10J2 JOB SIMOTIME,CLASS=1,MSGCLASS=0,NOTIFY=CSIP1 //* ******************************************************************* //* This JCL Member is provided by SimoTime Technologies * //* (C) Copyright 1987-2016 All Rights Reserved * //* Web Site URL: http://www.simotime.com * //* e-mail: helpdesk@simotime.com * //* ******************************************************************* //* //* Text - Read a file containing a list of KSDS definitions. //* Author - SimoTime Technologies //* Date - January 24, 1996 //* //* LONAP - an acronym for a List Of Names And Properties. //* CSV - an acronym for Comma-Separated-Values. //* FFL - an acronym for Fixed-Field-Length. //* //* The job will read a file with 1,024-byte records that contains //* data structure information. A catalog entry will be created based //* on the content of each record in the file. //* //* This set of programs will run on a mainframe under MVS or on a //* Personal Computer with Windows and Micro Focus Mainframe Express. //* //* ************ //* * CATX10J2 * //* ********jcl* //* * //* ************ //* * IEFBR14 * //* ********utl* //* * //* ************ ************ ************ //* * LONAPFFL *-----* MFCATPOP *-----* SUBTORDR * //* *******rseq* ********cbl* ********dat* //* * //* ************ //* * EOJ * //* ************ //* //* ******************************************************************* //* Step 1 of 2, Delete a previously created file. //* //PREPSTEP EXEC PGM=IEFBR14 //SUBTRACE DD DSN=SIMOTIME.UTIL.X10TRACE,DISP=(MOD,DELETE,DELETE), // STORCLAS=MFI, // SPACE=(TRK,5), // DCB=(RECFM=FB,LRECL=80,DSORG=PS) //* //* ******************************************************************* //* Step 2 of 2, Submit a job to the INTRDR based on record content... //* //CATENTRY EXEC PGM=MFCATPOP //STEPLIB DD DSN=SIMOTIME.DEMO.LOADLIB,DISP=SHR //LONAPFFL DD DSN=SIMOTIME.UTIL.X10LIST1,DISP=SHR //SUBTORDR DD SYSOUT=(,INTRDR) //SUBTRACE DD DSN=SIMOTIME.UTIL.X10TRACE,DISP=(NEW,CATLG,CATLG), // STORCLAS=MFI, // SPACE=(TRK,5), // DCB=(RECFM=FB,LRECL=80,DSORG=PS) //SYSOUT DD SYSOUT=* //
Use ES/Administration to review the results in the SPOOL file and Catalog.
Review the contents of the SUBTRACE file. For the sample program the Data Set Name is SIMOTIME.UTIL.X10TRACE. The following shows an example of the trace information that is included in the SUBTRACE file.
**SIMOTIME-SEPARATOR-Generated-JCL-for-VSAM,-ESDS------------SIMOTIME** //MAKEESDS JOB SIMOTIME,CLASS=1,MSGCLASS=0,USER=SIMOTIME,NOTIFY=CSIP1 //* ******************************************************************* //* Do Catalog Entry for SIMOTIME.ESDS.ESDSC128 //* Generated JCL Code, the file properties were user defined. //ESDEFINE EXEC PGM=IDCAMS //SYSPRINT DD SYSOUT=* //SYSIN DD * DEFINE CLUSTER( - NAME(SIMOTIME.ESDS.ESDSC128) - NONINDEXED - SHR (2 3) - CYL (9 9) - VOL(*)) - DATA( - NAME(SIMOTIME.ESDS.ESDSD128.DAT) - RECSZ(00128,00128) - CISZ(8192) - FREESPACE(0,0)) /* //* **SIMOTIME-SEPARATOR-Generated-JCL-for-VSAM,-ESDS------------SIMOTIME** //MAKEESDS JOB SIMOTIME,CLASS=1,MSGCLASS=0,USER=SIMOTIME,NOTIFY=CSIP1 //* ******************************************************************* //* Do Catalog Entry for SIMOTIME.ESDS.ESDSC350 //* Generated JCL Code, the file properties were user defined. //ESDEFINE EXEC PGM=IDCAMS //SYSPRINT DD SYSOUT=* //SYSIN DD * DEFINE CLUSTER( - NAME(SIMOTIME.ESDS.ESDSC350) - NONINDEXED - SHR (2 3) - CYL (9 9) - VOL(*)) - DATA( - NAME(SIMOTIME.ESDS.ESDSD350.DAT) - RECSZ(00350,00350) - CISZ(8192) - FREESPACE(0,0)) /* //* **SIMOTIME-SEPARATOR-Generated-JCL-for-VSAM,-ESDS------------SIMOTIME** //MAKEESDS JOB SIMOTIME,CLASS=1,MSGCLASS=0,USER=SIMOTIME,NOTIFY=CSIP1 //* ******************************************************************* //* Do Catalog Entry for SIMOTIME.ESDS.ESDSC01K //* Generated JCL Code, the file properties were user defined. //ESDEFINE EXEC PGM=IDCAMS //SYSPRINT DD SYSOUT=* //SYSIN DD * DEFINE CLUSTER( - NAME(SIMOTIME.ESDS.ESDSC01K) - NONINDEXED - SHR (2 3) - CYL (9 9) - VOL(*)) - DATA( - NAME(SIMOTIME.ESDS.ESDSD01K.DAT) - RECSZ(01024,01024) - CISZ(8192) - FREESPACE(0,0)) /* //*
The purpose of this document is to focus on the task of populating a catalog with the entries for the Special Purpose files. This document may be used 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 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.
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 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 |
Special Purpose Files, Management in a Micro Focus Environment |
Copyright © 1987-2025 SimoTime Technologies and Services All Rights Reserved |
When technology complements business |
http://www.simotime.com |