File and VSAM Access CICS, Look-up a File Status Code

Introduction

This example uses a suite of COBOL programs and BMS map sets to display a screen to prompt a user for a file status code. When the user enters the code a brief description of what caused the condition will be displayed. The transaction identifier (or Tran ID) for this menu option is "FSC1" and the program is "FILERC".

The programs use command level CICS statements to access the VSAM File with status codes and descriptions. The information is displayed to a 3270 terminal or terminal emulator. The programs run on an IBM Mainframe System with CICS or a Linux, UNIX or Windows System with 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

Display of Return Codes

To display the File Status screen a COBOL program and a BMS screen is used. The File Status Screen contains a prompt for a new File Status Code and the file status information from a previous request.

 FILERC1             Data Files and VSAM Data Sets                2007/11/11 
 STOA              File Status Codes - Inquiry Option            20:30:00:00

   Next File Status Code: 35__                (or extended hex value): __


     Code      Description




                PF3-Menu                                            PF12=Esc

Once a new File Status Code is entered the Repository of File Status Codes is accessed and the new status information is displayed.

 FILERC1             Data Files and VSAM Data Sets                2007/11/11 
 STOA              File Status Codes - Inquiry Option            20:30:00:00

   Next File Status Code: 0035                (or extended hex value): __


     Code      Description
     0035      OPEN failure, specified file not found



                PF3-Menu                                            PF12=Esc

Various EXEC CICS commands are used to access the repository of file status codes and re-display the screen.

Repository of File Return Codes

The Repository of File Status Codes is a VSAM, Key Sequenced Data Structure (or KSDS). It has a record length of 80 bytes with a 4 byte key starting in position 1 of the record. The following copy file (FILERCB1.cpy) shows the record structure.

      *****************************************************************
      *               FILERCB1.CPY - a COBOL Copy File                *
      *        Record Structure for the File of Status Codes          *
      * This is a VSAM Keyed-Sequential-Data-Set or Key-Indexed File. *
      *         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       *
      *****************************************************************
      *
       01  MSGXKSDS-REC.
           05  MSGXKSDS-DATA-01.
               10  MSGXKSDS-KEY         PIC X(4).
               10  MSGXKSDS-DATA        PIC X(54).
               10  FILLER               PIC X(22).
      *
      ***  FILERCB1 - End-of-Copy File - - - - - - - - - - - FILERCB1 *
      *****************************************************************
      *

Summary

The purpose of this suite of program is to provide examples that use command level CICS in COBOL programs to access VSAM, Key-Sequenced-Data-Sets (KSDS) and display the information using standard BMS screen definitions to a 3270 terminal or terminal emulator. Also, 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.

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.

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 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 CICS Connection for more examples of mainframe CICS coding techniques and sample code.

    Explore the COBOL Connection for more examples of COBOL programming techniques and sample code.

    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.

Internet Access Required

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.

Glossary of Terms

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

Contact 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.

We appreciate hearing from you.

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