Status Codes for File and VSAM Access  Look-up a File Status Code using CICS

Introduction
(Next) (Previous) (Table-of-Contents)

This example uses a a suite of COBOL programs and BMS mapsets to display a screen to prompt a user for a file status code. When the user enters the code a brief discription of what caused the condition will be displayed. 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 Microsoft Windows System with Micro Focus Server for Mainframe Migration.

Display of Return Codes
(Next) (Previous) (Table-of-Contents)

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
(Next) (Previous) (Table-of-Contents)

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-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  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
(Next) (Previous) (Table-of-Contents)

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 documents and the links to other documents are intended to provide a choice of alternatives.

Software Agreement and Disclaimer
(Next) (Previous) (Table-of-Contents)

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.

Downloads and Links to Similar Pages
(Next) (Previous) (Table-of-Contents)

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.

Note:  A SimoTime License is required for the items to be made available on a local server.

Downloads and Links, Internet Access Required
(Next) (Previous) (Table-of-Contents)

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.

Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

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.

Downloads and Links, Local Access
(Next) (Previous) (Table-of-Contents)

The following links may be accessible without an internet connection.

Check out The CICS Connection for more examples of mainframe CICS coding techniques and sample code.

Explore The File Status Return Codes to interpret the results of accessing VSAM data sets and QSAM files.

Glossary of Terms
(Next) (Previous) (Table-of-Contents)

Check out  The SimoTime Glossary  for a list of terms and definitions used in the documents provided by SimoTime.

Comments, Suggestions or Feedback
(Next) (Previous) (Table-of-Contents)

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.

Company Overview
(Next) (Previous) (Table-of-Contents)

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