Special Purpose Files
Identification and Documentation
  Table of Contents  v-16.01.01 - x10job01.htm 
  Introduction
  Format of the Excel Spreadsheet
  Record Layout of the List File
  Diagram, Convert an X10 List File
  CMD, Convert/Catalog an X10 List File
  JCL Members
  Delete a Previously Created X10 List
  Create a New Catalog Entry for the List File
  Summary
  Software Agreement and Disclaimer
  Downloads and Links
  Current Server or Internet Access
  Internet Access Required
  Glossary of Terms
  Comments or Feedback
  Company Overview
The SimoTime Home Page 

Table of Contents Previous Section Next Section Introduction

This document will describe how to create a list of the Special Purpose Files that are used by an application or group of applications. Once a list is created it will be used to programmatically create the entries in the Micro Focus catalog.

For this example we will use Microsoft Excel to create and maintain the list of the Special Purpose Files and their properties.


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-2024
SimoTime Technologies and Services
All Rights Reserved

Acronym Description
LONAP List of Names and Properties
CSV Comma Separated Values
FFL Fixed Field Length
  Glossary of Terms or Acronyms used in this Document

Table of Contents Previous Section Next Section Format of the Excel Spreadsheet

The following is the column structure for an Excel spreadsheet to be used as a starting point to populate the catalog.

* HTMGE
Column - Label Description
A - Level Number This should be a "1" for the primary file definition information. A zero (0) is used to define the row that is used for column headers.
B - DSN This is a text string with a maximum length of forty-four (44) characters. It is the fully-qualified MVS Data Set Name (DSN) or VSAM Cluster Name
C - DD Name This is a text string with a maximum length of eight (8) characters. It is the DD Name.
D - DSORG This is the Data Set Organization.
E - RECFM This is the Record Format.
F - lrecl-MIN This is a numeric string with a maximum length of five (5) digits. It is the minimum or average record length.
G - lrecl-MAX This is a numeric string with a maximum length of five (5) digits. It is the maximum record length.
H - KeyPos This is a numeric string with a maximum length of five (5) digits. It is the key starting position. The first position in a record is 1
I - KeyLen This is a numeric string with a maximum length of five (5) digits. It is for the length of the key.
J - VSAM Data Name This is a text string with a maximum length of forty-four (44) characters. It is the VSAM Data Name for KSDS and ESDS
K - VSAM Index Name This is a text string with a maximum length of forty-four (44) characters. It is the VSAM Index Name for KSDS
L - Override Job This is a text string with a maximum length of eight (8) characters. It is the JCL Member name that will be used to override the generated JCL that is used to create the catalog entry.
M - User Job 1 This is a text string with a maximum length of eight (8) characters. It is the JCL Member name for a job that will be submitted to the internal reader after the catalog creation process is complete.
N - User Job 2 This is a text string with a maximum length of eight (8) characters. It is the JCL Member name for a job that will be submitted to the internal reader after the previous steps are completed.
O - Extended S1 This is a text string with a maximum length of four (4) characters. The content varies.
If DSORG=PO then this field contains the extension of the PDSM that is used for a dynamic PDS.
P - Extended S2 This is a text string with a maximum length of four (4) characters. The content varies.
Q - Extended M1 This is a text string with a maximum length of sixteen (16) characters. The content varies, refer to Note-1
R - Extended M2 This is a text string with a maximum length of sixteen (16) characters. The content varies, refer to Note-1
S - Extended M3 This is a text string with a maximum length of sixteen (16) characters. The content varies, refer to Note-1
T - Extended M4 This is a text string with a maximum length of sixteen (16) characters. The content varies, refer to Note-1
U - Extended X1 This is a text string with a maximum length of 256 characters. It is the path to the directory that contains the Members for a Job Override, User Job 1 and/or User Job 2.
V - Extended X2 This is a text string with a maximum length of 256 characters. The content varies.
If DSORG=PO then this field contains the path to the directory that contains the PDS Members.
Note-1: The Extended M1 trhough M4 fields are sixteen (16) byte fields. The content varies.
If DSORG=GDG the following values are accepted:
 LIMIT(nnn) where nnn is the number of active generations
 SCRATCH or NOSCRATCH, SCRATCH will physically delete the generation, NOSCRATCH will uncatalog the latest generation
 NOEMPTY or EMPTY, This specifies, what action is to be taken when the GDG becomes full base on the number in the LIMIT.
  Format of an Excel Spread Sheet

Table of Contents Previous Section Next Section Record Layout of the List File

The following COBOL Copy File (LONAPFFL.cpy) shows the record layout for the Record Sequential File with a Fixed Field Format that is used for a list of names for the VSAM, KSDS's that are used by the application.

      *****************************************************************
      *               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 *
      *****************************************************************
      *

Table of Contents Previous Section Next Section Diagram, Convert an X10 List File

From within Excel save the List of Names and Properties for the Special Purpose Files to a CSV file. Execute the command (CATX10E1.CMD) to convert the Line Sequential file with comma separated values to a Record Sequential file with fixed field lengths.

The following shows the process flow of the CATX10E1.CMD member.

             
CATX10E1
   
CATX10J9
jcl
 
 
LONAPFFL
rseq/FFL
Submit a Job to delete previous X10LIST File
   
LONAPCSV
lseq/CSV
 
 
LONAPTIO
 
 
LONAPFFL
rseq/FFL
Create new X10LIST1 file with Fixed-Field-Length format
   
CATX10J1
jcl
 
 
LONAPFFL
rseq/FFL
Submit a Job to Create a Catalog Entry
   
EOJ
This is End-of-Job
 
Note-1: LCSV - this term is used to refer to a line sequential file with a Comma-Separated-Values (or CSV) format used for the record structure.
Note-1: RFFL - this term is used to refer to a record sequential file with a Fixed-Field-Length (or FFL) format used for the record structure.
Special Purpose Files, convert the List of Names and Properties file from LCSV to RFFL

Table of Contents Previous Section Next Section CMD, Convert/Catalog an X10 List File

The X10 List File is a list of names and properties for the Special Purpose Files that need a catalog entry to be created. The following member (CATX10E1.cmd) is the command to convert the X10 List File from a Line Sequential file with a record format of Comma-Separated-Values (CSV) to a Record Sequential file with a record format of Fixed-Field-Lengths (FFL). As the last step the command will submit a job to the Micro Focus Server to make a catalog entry for the X10 List File.

@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

Table of Contents Previous Section Next Section JCL Members

Two JCL Members are supplied with this part of the process to make catalog entries for VSAM, KSDS's. The following sections describe the JCL Members and their function.

Table of Contents Previous Section Next Section Delete a Previously Created X10 List

If an X10 List File was created in a previous execution then it must be deleted before we can add a new X10 List file and the associated catalog entry. This job (CATX10J9.jcl) will delete the X10 List file.

//CATX10J9 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   - Delete a previously created KSDLIST file.
//* Author - SimoTime Technologies
//* Date   - January 24, 1996
//*
//*
//* *******************************************************************
//* Step 1 of 1, Delete a previously created file.
//*
//TOSSFILE EXEC PGM=IEFBR14
//X10LIST1 DD  DSN=SIMOTIME.UTIL.X10LIST1,DISP=(MOD,DELETE,DELETE),
//             STORCLAS=MFI,
//             SPACE=(TRK,5),
//             DCB=(RECFM=FB,LRECL=1024,DSORG=PS)
//*

Table of Contents Previous Section Next Section Create a New Catalog Entry for the List File

This job (CATX10J1.jcl) will add a catalog entry for the List file containing the Special Purpose File names. The job executes the IEFBR14 program and uses a DD statement to create the catalog entry.

//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)
//*

Table of Contents Previous Section Next Section Summary

This document will describe how to create a list of the Special Purpose Files that are used by an application or group of applications. 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.

Table of Contents Previous Section Next Section 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.

Table of Contents Previous Section Next Section Downloads and Links

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.

Table of Contents Previous Section Next Section Current Server or Internet Access

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 Link to Internet 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 Link to Server icon.

Link to Internet   Link to Server   Explore How to Create Catalog Entries for User Data Structures. This suite of scripts and documentation is for a Micro Focus Enterprise Server running on a Windows System and includes a description and demonstration of how to define and access a VSAM Entry-Sequenced-Data-Set (or ESDS).

Link to Internet   Link to Server   Explore the non-Relational Data Connection for more examples of accessing methodologies and coding techniques for Data Files and VSAM Data Sets.

Link to Internet   Link to Server   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.

Link to Internet   Link to 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.

Link to Internet   Link to Server   Explore The File Status Return Codes that are used to interpret the results of accessing VSAM data sets and/or QSAM files.

Table of Contents Previous Section Next Section Internet Access Required

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.

Table of Contents Previous Section Next Section Glossary of Terms

Link to Internet   Link to Server   Explore the Glossary of Terms for a list of terms and definitions used in this suite of documents and white papers.

Table of Contents Previous Section Next Section Comments or Feedback

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.

Table of Contents Previous Section Next Section Company Overview

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, Identification and Documentation
Copyright © 1987-2024
SimoTime Technologies and Services
All Rights Reserved
When technology complements business
http://www.simotime.com