The CICS Connection
Sample Programs for CICS
  Table of Contents  v-24.01.01 - indexcic.htm 
  Introduction
  Purpose and Prerequisites
  CICS System Definitions and TransID's
  Configure a CICS Region
  Menu Interface using BMS Screens
  Primary Menu Screen
  Access to non-Relational Data
  Access to Relational Data Tables
  Utility Programs & Reference Material
  Advanced Functions
  Transactions and Programs
  Customer Master - a VSAM KSDS
  Inquire or Read Only (VSAM)
  File Update (VSAM)
  Hex-Dump of Records (VSAM)
  Hex-Patch of Records (VSAM)
  Customer Table - Relational Data Base
  Read, Update and Insert Rows
  Item Master - a VSAM KSDS
  Inquire or Read Only (VSAM)
  File Update (VSAM)
  Utility Programs & Reference Material
  View File Status Codes
  File Properties Repository
  Application Properties Repository
  Special Requirements
  Assembler, non-Executable Member
  Extract FCT Entries from DFHDRDAT
  Extract PCT Entries from DFHDRDAT
  Submit JCL to INTRDR from CICS
  Summary
  Software Agreement and Disclaimer
  Downloads and Links
  Current Server or Internet Access
  Internet Access Required
  Glossary of Terms
  Contact or Feedback
  Company Overview

Table of Contents Previous Section Next Section Introduction

The CICS Connection provides a suite of sample programs and documentation that show how to do practical tasks using CICS as the Transaction Manager. The CICS examples are written to compile and execute in the Micro Focus environment or an IBM Mainframe.


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

Table of Contents Previous Section Next Section Purpose and Prerequisites

This material is intended for individuals that are learning, creating or maintaining CICS application programs. The programs were created on an IBM Mainframe System and have been transferred, compiled and tested in Micro Focus Mainframe Express and Micro Focus Server, Enterprise Edition.

Table of Contents Previous Section Next Section CICS System Definitions and TransID's

A mainframe CICS system definition (CSD) file is a VSAM data set containing a resource definition entry for each resource defined to CICS (using CEDA or DFHCSDUP). A Micro Focus System Definitions file (DFHDRDAT) is included with this suite of sample programs.

Table of Contents Previous Section Next Section Configure a CICS Region

Refer to Configuring a CICS Region for Micro Focus Enterprise Server for additional information.

This link provides an example of  How to Configure a Micro Focus Server or Region  for processing CICS transactions.

Table of Contents Previous Section Next Section Menu Interface using BMS Screens

This group of COBOL programs and BMS screens present a main menu (or Primary Menu) to a 3270 device. The primary menu is a list of options that will link to sub-menu screens.

             
Main Menu sub-Menues Transaction Comment
MM01
MN1APP
Primary Menu with Links to sub-Menu Screens
   
   
   
   
OPT1
MN1FMS
Menu for Non-Relational Files and VSAM Data Sets
   
   
   
   
   
1 - CUI1
CU2INQ
Customer File Inquiry
   
   
   
   
   
2 - ITI1
IT2inq
Item File Inquiry
   
   
   
   
   
3 - CUU1
CU2UPD
Customer File Update
   
   
   
AMSQ
MN1SQL
Menu for Relational Data Base Processing
   
   
   
   
   
CQU1
CQ2UPD
Customer Table Read, Update or Insert a row
   
   
   
AMUP
MN1UTL
Menu for Utility Programs and Reference Material
   
   
   
   
   
1 - CUD1
CUDUMP
Hex-Dump of Customer File (VSAM)
   
   
   
   
   
3 - CUM1
CUMEND
Hex-Dump/Patch of Customer File (VSAM)
   
   
   
   
   
5 - FSC1
FILERC
File Status Codes
   
   
   
   
   
6 - FPU1
FP2UPD
File Properties Repository
   
   
   
   
   
7 - APU1
AP2UPD
Application Properties Repository
   
   
   
AF01
MN1ADV
Menu for Advanced Functions
   
   
   
   
   
1 - JRDR
CCSJCLC1
Submit a Batch Job to the Internal Reader
   
   
   
   
   
2 - WTL1
WTL128
Write a message to a Log File
   
   
   
   
   
3 - WT30
WAIT30
Submit a Long-Running Transaction (30 Secs)
   
   
   
   
   
4 - T2LD
T2LOAD
Load a Non-Executable Member
   
   
   
   
   
4 - DMPA
DMPUA101
Get Address List from Temporary Storage Queue
   
   
   
   
   
6 - UTX8
UTXCT8
User Transaction Control - Invoke
   
   
   
   
   
7 - UTX9
UTXCT9
User Transaction Control - Revoke
   
   
   
   
Sign Off
Sign Off, End of Session
 
The Online Menu System with Links to Data Management Programs and Reference Material

Table of Contents Previous Section Next Section Primary Menu Screen

This suite of programs provides an example of how to use BMS (Basic Mapping Support) and COBOL programs to present and process a sequence of "Menu-oriented" screens. The transaction identifier (or Tran ID) to display the main menu is "MM01" and the program name is "MN1APP".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Access to non-Relational Data

This suite of programs provides an example of how to use BMS (Basic Mapping Support) and COBOL programs to access non-relational data files and/or VSAM Data Sets. The transaction identifier (or Tran ID) to display this sub-menu is "OPT1" and the program name is "MN1FMS".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Access to Relational Data Tables

This group of COBOL programs and BMS screens present a menu of options to a 3270 device. The list of options focus on various SQL tasks. The transaction identifier (or Tran ID) to display this sub-menu is "AMSQ" and the program name is "MN1SQL".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Utility Programs & Reference Material

The Utilities Menu is provided for programmers and support personnel that need addition information about the application programs or data files. The transaction identifier (or Tran ID) to display this sub-menu is "AMUP" and the program name is "MN1UTL".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Advanced Functions

The Advanced Functions Menu is provided for programmers and support personnel that need addition capability for tracing or monitoring points of interest in an application program. The transaction identifier (or Tran ID) to display this sub-menu is "AF01" and the program name is "MN1ADV".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Transactions and Programs

This section provides a brief description and links for the sample CICS transactions and programs. The source members provided by SimoTime are stored in Partitioned Data Sets (or a Source Management System) on the mainframe and a similar directory structure (or a Source Management System) on the Personal Computer using Windows.

             
 
 
 
 
 
 
Batch Job 1
 
 
 
 
 
 
 
Create a List of Programs
 
CVPLSTW2
Execute Batch Job Script
   
SYSUT1
 
 
CVPLISTC1
 
 
SYSUT2
Read LSEQ, Create RSEQ-ASC
   
SYSUT1
 
 
CVPLISTC2
 
 
SYSUT2
Extract Active Data Records
 
 
 
 
 
 
 
Batch Job 2
 
 
 
 
 
 
 
Generate Process Control Files (PCF's)
 
GENPCFW1
CMD, Execute Batch Job Script
   
SYSUT1
   
   
GENPCFC1
 
 
SYSUT2
Generate Multiple PCF's
   
SYSUT3
   
   
PCF Generation Parameters
 
 
 
 
 
 
 
Batch Job 3
 
 
 
 
 
 
 
Generate the COBOL Source Code
 
Job Script
Job Script name is ADM_GENRALL_CONVERTS.cmd
   
MBRSLIST
 
 
UTCONVPE
 
 
CBL_CODE
CBL_CODE is a COBOL Source Code member
 
 
 
 
 
 
 
Batch Job 4
 
 
 
 
 
 
 
Compile the Generated COBOL Members
 
CBUT2AE1
Execute IDCAMS Program using REPRO Function
   
MBRSLIST
 
 
COBOL
 
 
CBL_EXEC
CBL_EXEC is a COBOL Executable member
 
 
 
 
 
 
 
Batch Job 5
 
 
 
 
 
 
 
Execute the Convert Programs
 
CUREKAW1
User defined job script
   
CUSRE512
 
 
CUREKAC1
 
 
CUSRA512
EBC to ASC convert of Customer File
 
Processing Logic to Generate, Compile and Execute multiple Convert Programs

Table of Contents Previous Section Next Section Customer Master - a VSAM KSDS

The Customer Master File is a VSAM, KSDS with 512 byte records. The key starts in position 1 and is 12 bytes in length. The following sub-sections of this document describe some of the online transactions and associated programs available to view, update or add records in the Customer Master File.

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Inquire or Read Only (VSAM)

The Customer Master Inquiry Screen contains a prompt for a new Customer Number and the customer information from a previous request. Once a new customer number is entered the Customer Master File is accessed and the new information is displayed. The transaction identifier (or Tran ID) to view the customer master file is "CUI1" and the program name is "CU2INQ".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section File Update (VSAM)

The update program is a COBOL program that uses command level CICS. The screens are standard BMS screens. This program has the capability to read existing records, update existing records and write new records from/to the Customer Master File. The transaction identifier (or Tran ID) to update the customer master file is "CUU1" and the program name is "CU2UPD".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Hex-Dump of Records (VSAM)

The dump program (CUDUMP.CBL) is a COBOL program that uses command level CICS. The screens are standard BMS screens. This program is intended for use by support personnel and displays the record contents in hexadecimal format. A possible EBCDIC and ASCII display is also provided. The transaction identifier (or Tran ID) to hex-dump the customer master file is "CUD1" and the program name is "CUDUMP".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Hex-Patch of Records (VSAM)

The patch program (CUMEND.CBL) is a COBOL program that uses command level CICS. The screens are standard BMS screens. This program is intended for use by support personnel and displays the record contents in hexadecimal format. A possible EBCDIC and ASCII display is also provided. A user may choose to patch (or update) a record. The transaction identifier (or Tran ID) to update the customer master file is "CUM1" and the program name is "CUMEND".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Customer Table - Relational Data Base

This example uses a suite of COBOL programs and BMS map sets to execute programs that will provide data base inquiry or update functionality for the Customer Table. The programs use embedded EXEC SQL statements to access the Customer Table and display information 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.

Table of Contents Previous Section Next Section Read, Update and Insert Rows

The Customer Table Inquiry Screen contains a prompt for a new Customer Number and the customer information from a previous request. Once a new customer number is entered the Customer Data Base is accessed and the new information is displayed. The transaction identifier (or Tran ID) to update the customer table is "CQU1" and the program name is "CQ2UPD".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Item Master - a VSAM KSDS

The Item Master File is a VSAM, KSDS with 512 byte records. The key starts in position 1 and is 12 bytes in length. The following sub-sections of this document describe some of the online transactions and associated programs available to view, update or add records in the Item Master File.

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Inquire or Read Only (VSAM)

The Item Master Inquiry Screen contains a prompt for a new Item Number and the item information from a previous request. Once a new item number is entered the Item Master File is accessed and the new information is displayed. The transaction identifier (or Tran ID) to view the customer master file is "ITI1" and the program name is "IT2INQ".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section File Update (VSAM)

The update program is a COBOL program that uses command level CICS. The screens are standard BMS screens. This program has the capability to read existing records, update existing records and write new records from/to the Item Master File. The transaction identifier (or Tran ID) to update the customer master file is "ITU1" and the program name is "IT2UPD".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Utility Programs & Reference Material

The following set of programs are provided to assist programmers and support personnel that are involved with the maintenance and support of CICS applications and the associated data.

Table of Contents Previous Section Next Section View File Status Codes

This suite of programs prompts a user for a File Status return code and then provides a brief description of the cause of the return code. The transaction identifier (or Tran ID) to display a file status code is "FSC1" and the program name is "FILERC".

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

The preceding links provide a method for doing look-ups of file status codes from a CICS transaction. The following link provides access to an HTML document with the file status codes.

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

Table of Contents Previous Section Next Section File Properties Repository

This suite of programs provides access to the File Properties Repository. The repository is a VSAM, KSDS and the key is a fully qualifies MVS Data Set Name (DSN).

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Application Properties Repository

This suite of programs provides access to the Application Properties Repository. The repository is a VSAM, KSDS and the key is the member name. The member name may be the DD name or the filename with an extension.

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Special Requirements

This section will describe programs and techniques that may be considered a bit esoteric but are quite often in the critical path within an application.

Table of Contents Previous Section Next Section Assembler, non-Executable Member

In the CICS environment on the mainframe it was a common practice to use the EXEC CICS LOAD function to load a data table into memory. These data tables were typically created as mainframe assembler source members. The source members were then compiled and linked as non-Executable load members.

This example will describe how to  create a non-executable load member from Assembler Source Code  for the Micro Focus Studio and Server environments running in EBCDIC or ASCII.

Table of Contents Previous Section Next Section Extract FCT Entries from DFHDRDAT

The resource used by the Micro Focus Enterprise Server, Mainframe Subsystem Support (or ES/MSS) is stored in the resource definitions file (DFHDRDAT). This file is a Micro Focus Key-Sequenced-Data-Set. This utility program provides a batch access to get the FCT information and post this information into an ASCII/Text file.

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Extract PCT Entries from DFHDRDAT

The resource used by the Micro Focus Enterprise Server, Mainframe Subsystem Support (or ES/MSS) is stored in the resource definitions file (DFHDRDAT). This file is a Micro Focus Key-Sequenced-Data-Set. This utility program provides a batch access to get the PCT information and post this information into an ASCII/Text file.

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Submit JCL to INTRDR from CICS

This example uses a COBOL program running under CICS to submit a job (i.e. JCL) to the Internal Reader (or INTRDR). The program uses command level CICS statements (EXEC CICS SPOOL) to access the internal reader. The program will run on an IBM Mainframe System with CICS or a Microsoft Windows System with Micro Focus Server and the Mainframe Sub-System option.

Review the Documentation for this suite of program members. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

Table of Contents Previous Section Next Section Summary

The purpose of this document is to assist as a tutorial for new programmers or as a quick reference for experienced programmers that are interested in supporting an application that is dependent on the mainframe CICS architecture. Links to additional documents, programming examples and services are provided.

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

Link to Internet   Link to Server   Explore the COBOL Connection for more examples of COBOL programming techniques and sample code.

Link to Internet   Link to Server   Explore the JCL Connection for more examples of JCL functionality with programming techniques and sample code.

Link to Internet   Link to Server   Explore the SQL Connection for more examples of how to create, manipulate and delete Relational Data Bases. The COBOL programs are written to compile and execute on a Windows System with SQL Server and Micro Focus Enterprise Server or an IBM Mainframe System with DB2.

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 the Numbers Connection for additional information about the structure and processing of numeric data items (or numeric fields).

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

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
The CICS Connection, Sample Programs for CICS
Copyright © 1987-2025
SimoTime Technologies and Services
All Rights Reserved
When technology complements business
http://www.simotime.com