![]() |
File Properties Definitions, Retention and Management Information |
| When technology complements business | Copyright © 1987-2012 SimoTime Enterprises All Rights Reserved |
| The SimoTime Home Page |
This suite of programs will provide the capability of creating and managing a repository of file properties (FPMASTER) for Data Files, Partitioned Data Sets (PDS) and GDG Base definitions used by a mainframe application or group of applications. This capability and the information it provides is quite useful when supporting applications or migrating an application (source code, control information and data) from a Mainframe System to a Linux, UNIX or Windows (LUW) System using Micro Focus technologies.
The FPMASTER (or File Properties Repository) is a Micro Focus Key-Sequenced-Data Set. Two Programs are provided that provide the capability of importing or extracting information between the FPMASTER and a Microsoft Excel spreadsheet. A comma-separated-values (CSV) file is used as the exchange format between FPMASTER and Excel.
A batch interface to load or update the File Properties Repository is provided. This batch interface uses a record sequential file as input. The record structure is a Fixed Field Length (FFL) format. A COBOL copy file is provided for the record layout.
The scripts, programs, data sets and documentation for the File Properties Repository Management are provided in a single zipped file called FPMAST01.ZIP. This zipped file may be downloaded from the SimoTime Web site. This example illustrates the following functions.
| ||||||||||||
| Supplied Commands for the File Repository Management Tasks |
This suite of programs will work in a complementary manner with the following technologies available from SimoTime.
| ||||||||
| Complementry Technologies for File Repository Management |
This section describes the process for creating and populating a File Properties Repository using the information from Excel spread sheets as input to the process.
Refer to the Technical Details, Format of the Excel Spreadsheet for details of how to use Excel spreadsheets to capture information about the files used by an application. Once the information is captured save the spreadsheets as Comma Separated Values (or CSV) files. The location and name of the CSV files used in the example are as follows.
| ||||||||||||
| List of CSV Files used to Populate the File Properties Repository |
Run the following command to create a new File Properties Repository (FPMASTER.DAT).
C:\SIMOSAM1\DEVL\ADM1> FPDDEFE1
Run the following command to populate a new File Properties Repository (FPMASTER.DAT).
C:\SIMOSAM1\DEVL\ADM1> FPMIMPE1
The following COBOL copy file (FPMASTB1.CPY) shows the record layout for the file inventory data base.
*****************************************************************
* FPMASTB1.CPY - a COBOL Copy File *
* Copy File for a FPMASTER, the File Properties Repository. *
* This is a VSAM Keyed=Sequential-Data-Set or Key-Indexed File. *
* Copyright (C) 1987-2012 SimoTime Enterprises *
* All Rights Reserved *
* Provided by SimoTime Enterprises *
* Our e-mail address is: helpdesk@simotime.com *
* Also, visit our Web Site at http://www.simotime.com *
*****************************************************************
*
01 FPMASTER-REC.
05 FPMASTER-DATA-01.
10 FPMASTER-BASE-INFO.
15 FPMASTER-LEVEL-NBR PIC 9(2). COL-A
15 FPMASTER-DSN-NAME PIC X(54). COL-B
15 FPMASTER-DD-NAME PIC X(17). COL-C
10 FPMASTER-FILE-PROPERTIES.
15 FPMASTER-DCB-DSORG PIC X(4). COL-D
15 FPMASTER-DCB-RECFM PIC X(4). COL-E
15 FPMASTER-MIN-LRECL PIC 9(5). COL-F
15 FPMASTER-MAX-LRECL PIC 9(5). COL-G
15 FPMASTER-KEY-POS PIC 9(5). COL-H
15 FPMASTER-KEY-LEN PIC 9(5). COL-I
15 FPMASTER-VSAM-DAT PIC X(44). COL-J
15 FPMASTER-VSAM-IDX PIC X(44). COL-K
10 FPMASTER-JOB-INFO.
15 FPMASTER-JCL-OVR1 PIC X(8). COL-L
15 FPMASTER-JCL-USR1 PIC X(8). COL-M
15 FPMASTER-JCL-USR2 PIC X(8). COL-N
10 FPMASTER-EXTENDED-INFO.
15 FPMASTER-EXTEND-S1 PIC X(4). COL-O
15 FPMASTER-EXTEND-S2 PIC X(4). COL-P
15 FPMASTER-EXTEND-M1 PIC X(16). COL-Q
15 FPMASTER-EXTEND-M2 PIC X(16). COL-R
15 FPMASTER-EXTEND-M3 PIC X(16). COL-S
15 FPMASTER-EXTEND-M4 PIC X(16). COL-T
15 FPMASTER-EXTEND-X1 PIC X(256). COL-U
15 FPMASTER-EXTEND-X2 PIC X(256). COL-V
10 FILLER PIC X(227).
*
*** FPMASTB1 - End-of-Copy File - - - - - - - - - - - FPMASTB1 *
*****************************************************************
*
This section provides technical detail about the supporting scripts and programs used or called by the primary jobs.
A command file (ENV1BASE.CMD) is called from other command files to set commonly used environment variables. This provides a single point of definition. The following is a listing of the contents of the command file.
@echo OFF
rem * *******************************************************************
rem * ENV1BASE.CMD - a Windows Command File *
rem * This program is provided by SimoTime Enterprises *
rem * (C) Copyright 1987-2012 All Rights Reserved *
rem * Web Site URL: http://www.simotime.com *
rem * e-mail: helpdesk@simotime.com *
rem * *******************************************************************
rem *
rem * Text - Provide a single point to set common environment variables.
rem * Author - SimoTime Enterprises
rem * Date - January 24, 1996
rem *
rem * Set the commonly used environment variables. This is used to provide
rem * a single point for managing the commonly used environment variables.
rem *
set BaseLib1=c:\SimoSAM1\DEVL
set BaseLib8=c:\SimoSAM8
set SAM1ANIM=C:\SIMOSAM1\DEVL\SAM1SOL1\SAMBATG1\bin\x86\Debug
set BASEAPP=%BaseLib1%
set BASESYS=%BaseLib1%\SYS1
set BASECAT=%BaseLib1%\DATA
set SYSLOG=%BASESYS%\LOGS\SYSLOG_USER.DAT
set SYSOUT=%BASEAPP%\LOGS\SYSOUT_SIMSAM01.TXT
set SLZMSG=%BASEAPP%\LOGS\SLZMSG_USER.TXT
set PostNOTE=%BASEAPP%\LOGS\SYSOUT_SIMONOTE.TXT
set SimoNOTE=%BASEAPP%\LOGS\SYSOUT_SIMONOTE.TXT
set MIFOBASE="C:\Program Files (x86)\Micro Focus\Studio Enterprise Edition 6.0\Base"
set MIFOBIN=%MIFOBASE%\bin
rem *
set SimoLIBR=c:\SimoLIBR
set JESSERVERNAME=SIMOBATA
rem * set SIMOMODE=PAUSE
rem *
set MAINFRAME_FLOATING_POINT=true
set CobCpy=%BASEAPP%\CobCpy1;%BASEAPP%\CobCpy6;c:\SimoLIBR;%MIFOBASE%\SOURCE
set COBIDY=%BASEAPP%\COBIDY
rem * For large file support and record locking control of File Handler
set EXTFH=%BASESYS%\CONFIG\EXTFHBIG.CFG
rem * For Sort Resource Allocation and Performance
set SORTSPACE=1000000
set ES_ALLOC_OVERRIDE=%BASESYS%\CONFIG\CATMAPA1.cfg
set COBCONFIG_=%BASESYS%\CONFIG\diagnose.cfg
rem * Set environment for MFBSI (Micro Focus Batch Scheduling Interface)
set ES_EMP_EXIT_1=mfbsiemx
set MFBSI_DIR=%BASESYS%\LOGS\%ezServerName%
set MFBSIEOP_CMD=ENABLE
set MFBSIEOP_CSV=ENABLE
set MFBSIEOP_HTM=ENABLE
set MFBSIEOP_XML=ENABLE
rem * Set Behavior and Trace Flags for GETJOBDD
set JDDFLAGS=nnnWnnnn/nnnnnnnn
rem *
if "%SIMOPATH%" == "Y" goto JUMPPATH
set path=%MIFOBASE%;%MIFOBIN%;%PATH%;
set COBPATH=.;%BASEAPP%\LOADLIB;%BASESYS%\LOADLIB;C:\SimoLIBR
set LIBPATH=.;%BASEAPP%\LOADLIB;%BASESYS%\LOADLIB;C:\SimoLIBR
set TXDIR=%BASESYS%\LOADLIB;%MIFOBASE%
:JUMPPATH
set SIMOPATH=Y
set JobStatus=0000
call SimoNOTE "* Settings CmdName Env1BASE.CMD, Version 10.04.19"
call SimoNOTE "* BaseAPP is %BASEAPP%"
A command file (SIMONOTE.CMD) is called from other command files to display messages to the screen and write the message to a log file in a consistent manner. The following is a listing of the contents of the command file.
@echo OFF rem * ******************************************************************* rem * This program is provided by SimoTime Enterprises * rem * (C) Copyright 1987-2012 All Rights Reserved * rem * Web Site URL: http://www.simotime.com * rem * e-mail: helpdesk@simotime.com * rem * ******************************************************************* rem * rem * Text - Display message on screen and write to a log file. rem * Author - SimoTime Enterprises rem * rem * This script may be called from other scripts and expects a single rem * parameter enclosed in double quotes. The double quotes will be rem * removed. Before writing to the log file a date and time stamp rem * will be inserted in front of the message text. rem * rem * Note: The tilde (~) removes leading/trailing double-quotes. rem * if "%SimoNOTE%" == "" set SimoNOTE=c:\SimoLIBR\LOGS\SimoTime.LOG echo %date% %time% %~1>> %SimoNOTE% echo %~1
A directives file (ActiveMFAsc.DIR) containing the following directives was used to compile and test the programs used in this suite of programs. The file contains the following directives (or compiler options).
DIALECT"MF" CHARSET"ASCII" ASSIGN"EXTERNAL" IBMCOMP NOTRUNC RTNCODE-SIZE"2" ANIM NOQUERY DEFAULTBYTE"00" NOOPTIONAL-FILE outdd"SYSOUT 121 L" SHARE-OUTDD DATAMAP settings list() noform
This section provides a technical overview of the programs used to manage the FIle Properties Repository and a description of the programs and procedures that provide additional functionality.
The following is the column structure for an Excel spreadsheet to be used as a starting point to populate the catalog.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Format of an Excel Spread Sheet |
This section will focus on the Windows environment and the Command files (or scripts) that are used to create and manage the File Properties Repository.
This command (FPDDEFE1.CMD) will create (or Delete/Define) a new Micro Focus Keyed-Indexed file that will be used as the File Properties Repository.
@echo OFF
rem * *******************************************************************
rem * FPDDEFE1.CMD - a Windows Command File *
rem * This program is provided by SimoTime Enterprises *
rem * (C) Copyright 1987-2011 All Rights Reserved *
rem * Web Site URL: http://www.simotime.com *
rem * e-mail: helpdesk@simotime.com *
rem * *******************************************************************
rem * A procedure for a batch function to create a new FPMASTER.DAT
rem * file that will be used as the File Properties Repository. This
rem * process performs the same function as an IDCAMS, Delete/Define.
rem *
rem * This procedure calls the following Windows Command Files.
rem * 1. ezSetEnv.CMD - this provides a single point for setting commonly
rem * used environment variables.
rem * 2. SimoNOTE.CMD - this provides a consistent process for displaying
rem * messages to the screen and writing to a journal or
rem * log file.
rem * ************************************************************************
setlocal
set CmdName=FPDDEFE1
call ..\Env1BASE %CmdName%
rem *
call SimoNOTE "*******************************************************************%CmdName%.CMD"
call SimoNOTE "Starting JobName %CmdName%.CMD"
rem *
rem * Step 1 of 2, Prepare the Environment
rem * UPDFLAG-01 Update complete record
rem * UPDFLAG-02 Update the Base Fields (Key and File Names)
rem * UPDFLAG-03 Update the File Properties
rem * UPDFLAG-04 Update the JCL Scan Fields
rem * UPDFLAG-05 Update the User defined Fields
rem *
rem * 12345678
set UPDFLAGS=NYYYN
set FPRFFLD1=%BaseLib1%\Adm1\DATA\Wrk1\SIMOTIME.UTIL.FPNULLD1.DAT
set FPMASTER=%BaseLib1%\Adm1\DATA\UTIL\SIMOTIME.UTIL.FPMASTER.DAT
rem *
rem * The following will create a null sequnetial file for input. This will
rem * be used to force an end of file and create an empty FPMASTER.DAT file
rem * to be used as the File Properties Repository.
rem *
if not exist %FPRFFLD1% copy nul %FPRFFLD1%
rem *
rem * Step 2 of 2, Update or Add records to the Data FIle Data Base
rem *
rem * Read the Listing file, set the environment and append/update the
rem * records in the File Properties Repository. Since the input file
rem * is an empty file this will perform a Delete/Define for a new,
rem * File Properties Repository (or FPMASTER.DAT).
rem *
run FPLOADC1
if not "%ERRORLEVEL%" == "0" (call SimoNOTE "Error Level = %ERRORLEVEL% "
set JobStatus=0010)
if not "%JobStatus%" == "0000" goto :EojNOK
:EojAOK
call SimoNOTE "DataMake %FPMASTER%"
call SimoNOTE "Finished CmdName %CmdName%, Job Status is %JobStatus% "
goto :End
:EojNOK
call SimoNOTE "ABENDING CmdName %CmdName%, Job Status is %JobStatus% "
goto :End
:End
call SimoNOTE "FileInfo SYSOUT=%SYSOUT%"
call SimoNOTE "Finished JobName %CmdName%.CMD"
if not "%SimoGENS%" == "BATCH" pause
endlocal
This script (FPMIMPE1.CMD) will read an ASCII/Text file and use the information in the individual records to update the File Properties Repository. The ASCII/Text file is created by saving an Excel Spreadsheet as a Comma Separated Values (or CSV) file.
@echo OFF
rem * *******************************************************************
rem * FPMIMPE1.CMD - a Windows Command File *
rem * This program is provided by SimoTime Enterprises *
rem * (C) Copyright 1987-2011 All Rights Reserved *
rem * Web Site URL: http://www.simotime.com *
rem * e-mail: helpdesk@simotime.com *
rem * *******************************************************************
rem * This procedure will read an ASCII/Text file and use the information
rem * in the individual records to update the File Properties Repository.
rem * The ASCII/Text file is created by saving an Excel Spreadsheet as a
rem * Comma Separated Values (or CSV) file.
rem *
rem * This procedure calls the following Windows Command Files.
rem * 1. ezSetEnv.CMD - provides a single point for setting commonly
rem * used environment variables.
rem * 2. SimoNOTE.CMD - provides a consistent process for displaying
rem * messages to the screen and writing to a journal
rem * or log file.
rem * *******************************************************************
setlocal
set CmdName=FPMIMPE1
call ..\Env1BASE %CmdName%
rem *
call SimoNOTE "*******************************************************************%CmdName%.CMD"
call SimoNOTE "Starting JobName %CmdName%.CMD"
rem *
set FPMASTER=%BaseLib1%\Adm1\DATA\UTIL\SIMOTIME.UTIL.FPMASTER.DAT
rem *
rem * Read the CSV File, update the FPMASTER File (File Properties Repository).
set FPASCCSV=%BASECAT%\XLSS\LONAPPDS.CSV
call SimoNOTE "DataTake %FPASCCSV%"
run FPMIMPC1
if not "%ERRORLEVEL%" == "0" (call SimoNOTE "Error Level = %ERRORLEVEL% "
set JobStatus=0010)
if not "%JobStatus%" == "0000" goto :EojNOK
rem *
rem * Read the CSV File, update the FPMASTER File (File Properties Repository).
set FPASCCSV=%BaseLib1%\DATA\XLSS\LONAPGDG.CSV
call SimoNOTE "DataTake %FPASCCSV%"
run FPMIMPC1
if not "%ERRORLEVEL%" == "0" (call SimoNOTE "Error Level = %ERRORLEVEL% "
set JobStatus=0020)
if not "%JobStatus%" == "0000" goto :EojNOK
rem *
rem * Read the CSV File, update the FPMASTER File (File Properties Repository).
set FPASCCSV=%BaseLib1%\DATA\XLSS\LONAPSEQ.CSV
call SimoNOTE "DataTake %FPASCCSV%"
run FPMIMPC1
if not "%ERRORLEVEL%" == "0" (call SimoNOTE "Error Level = %ERRORLEVEL% "
set JobStatus=0030)
if not "%JobStatus%" == "0000" goto :EojNOK
rem *
rem * Read the CSV File, update the FPMASTER File (File Properties Repository).
set FPASCCSV=%BaseLib1%\DATA\XLSS\LONAPKSD.CSV
call SimoNOTE "DataTake %FPASCCSV%"
run FPMIMPC1
if not "%ERRORLEVEL%" == "0" (call SimoNOTE "Error Level = %ERRORLEVEL% "
set JobStatus=0040)
if not "%JobStatus%" == "0000" goto :EojNOK
rem *
rem * Read the CSV File, update the FPMASTER File (File Properties Repository).
set FPASCCSV=%BaseLib1%\DATA\XLSS\LONAPX10.CSV
call SimoNOTE "DataTake %FPASCCSV%"
run FPMIMPC1
if not "%ERRORLEVEL%" == "0" (call SimoNOTE "Error Level = %ERRORLEVEL% "
set JobStatus=0050)
if not "%JobStatus%" == "0000" goto :EojNOK
:EojAOK
call SimoNOTE "DataTake %FPASCCSV%"
call SimoNOTE "DataMake %FPMASTER%"
call SimoNOTE "Finished CmdName %CmdName%, Job Status is %JobStatus% "
goto :End
:EojNOK
call SimoNOTE "ABENDING CmdName %CmdName%, Job Status is %JobStatus% "
goto :End
:End
call SimoNOTE "FileInfo SYSOUT=%SYSOUT%"
call SimoNOTE "Finished JobName %CmdName%.CMD"
if not "%SimoGENS%" == "BATCH" pause
endlocal
This section describes the utility programs used to support the creation, management and use of the File Properties Repository.
This program (FPLOADC1.GNT) will read an ASCII/Text file and use the information in the individual records to populate the File Properties Repository. This program is intended to be used to do the initial load of the File Properties Repository.
The ASCII/Text file (or input file) is created by saving an Excel Spreadsheet as a Comma Separated Values (or CSV) file. Since this program opens the File Properties Repository file as output and if the input file is a nul file (i.e. empty file) this program will simply create (i.e. Delete/Define) a new File Properties Repository (FPMASTER.DAT).
This set of programs (FPMIMPC1.CBL and FPMIMPR1.CBL) will read an ASCII/Text file (with records in a Comma Separated Values format) and use the information in the individual records to populate the File Properties Repository (with records in a Fixed Field Length format). This set of programs is intended to be used to import data from an Excel spreadsheet into the File Properties Repository. The first program performs the file I/O and calls the second program to do the actual record format conversion.
The purpose of this suite of programs is to provide an example of how to create, manage and use a File Properties Repository. This capability and the information it provides is quite useful when supporting applications or migrating an application (source code, control information and data) from a Mainframe System to a Linux, UNIX or Windows System using Micro Focus technologies.
Permission to use, copy, modify and distribute this software, documentation or training material for any purpose requires a fee to be paid to SimoTime Enterprises. 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 Enterprises.
SimoTime Enterprises 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 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, documentation or training material.
This section includes links to documents with additional information that is beyond the scope and purpose of this document. The first sub-section requires an internet connection, the second sub-section references locally available documents.
The following links will require an internet connect.
You may download this suite of programs at http://www.simotime.com/sim4dzip.htm#fpmast01dzip.
A good place to start is The SimoTime Home Page for access to white papers, program examples and product information.
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 to interpret the results of accessing VSAM data sets and QSAM files.
Explore The Micro Focus Web Site for more information about products and services available from Micro Focus.
The following links should be accessible without an internet connection.
Explore The File Status Return Codes to interpret the results of accessing VSAM data sets and QSAM files.
Check out The SimoTime Glossary for a list of terms and definitions used in the documents provided by SimoTime.
This document was created and is maintained by SimoTime Enterprises.
If you have any questions, suggestions, comments or feedback please call or send an e-mail to: helpdesk@simotime.com
We appreciate hearing from you.
Founded in 1987, SimoTime Enterprises 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. 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 |
| File Properties, Definitions, Retention and Management Information |
| Copyright © 1987-2012 SimoTime Enterprises All Rights Reserved |
| When technology complements business |
| http://www.simotime.com |