Micro Focus Enterprise Developer 8.0 for Eclipse (UNIX)

Features Added in Enterprise Developer 2.3 Update 2

PL/I Support

Terminal Emulation

Features Added in Enterprise Developer 2.3 Update 1

Features Added in Enterprise Developer 2.3

Features Added in Enterprise Developer 2.2 Update 2

Features Added in Enterprise Developer 2.2 Update 1

Features Added in Enterprise Developer 2.2

Features Added in Enterprise Developer 2.1 Update 1

Features Added in Enterprise Developer 2.1

Features Added in Enterprise Developer 2.0

Significant Changes in Behavior or Usage

New Customers: Where do I start?

New to Eclipse

Where do I start: Developer Tasks

Where do I start: Developing Mainframe Applications in Enterprise Developer

Developer: My Application Uses CICS

Developer: My Application Uses JCL

Developer: My Application Uses DB2

Developer: My Application Uses IMS

Developer: My Application Uses PL/I

Where do I start: Deploying Mainframe Applications to Enterprise Server

Deployer: Deploying a CICS Application

Deployer: Deploy a JCL Application

Deployer: Deploy and Debug a Mainframe Application with IMS Support

New to COBOL

New to PL/I

New to Micro Focus Enterprise Developer UNIX Components

Upgrading from Mainframe Express

Upgrading from Net Express

Upgrading from Server Express

Upgrading from Studio Enterprise Edition

Want to deploy an application

Upgrading to Enterprise Developer

Licensing Changes

Resolving conflicts between reserved keywords and data item names

Importing Existing COBOL Code into Enterprise Developer

Recompile all source code

Upgrading from Mainframe Express to Enterprise Developer

Advantages to upgrading to Enterprise Developer

Approaches to upgrading your applications

Considerations when upgrading to Enterprise Developer

How to upgrade an application created with Mainframe Express to Enterprise Developer

Further Information and Assistance

Mainframe Express Functionality That Works Differently in Enterprise Developer for Eclipse

Emulating workgroups in Eclipse

Upgrading from Studio Enterprise Edition (Windows)

Upgrading from Server Express and Studio Enterprise Edition (UNIX)

Advantages of Upgrading to Enterprise Developer

Upgrading Your COBOL Application

Compile Your Existing Programs without a Project

Create a Project and Import Your Sources

Best Practice in Development Using Eclipse

Modernize Your Applications and Processes

Differences between Enterprise Developer and Server Express and Mainframe Express

Summary of Differences

Backward Compatibility with Earlier Micro Focus Products

Compiling and Building Differences

Output File Formats

Compiler directives

Linking

Called Programs and Dependencies

File Handler

Makefile Conversion

SQL Compiler Directive Options

XML PARSE Statement

Run-time System Differences

Single-Threaded Run-Time System

Static-Linked Run-Time System

Setting the environment on UNIX

Enterprise Developer Co-existing with Earlier Micro Focus Products

Restrictions and Unsupported Features

Host Compatibility Option (HCO)

Run-Time Technology Differences

File Handling

Java and COBOL

Test Coverage

Editing and Debugging Differences

Interface Mapping Toolkit

Mixed Language Debugging

Program Breakpoints

Remote Debugging

Source Pool View

Tips: Eclipse IDE Equivalents to IDE Features in Earlier Products

Upgrading from ACUCOBOL-GT

Upgrading from RM/COBOL®

Overview of application development in Eclipse

Overview of Remote Mainframe Development

Enterprise Developer Tutorials Guide

Mainframe Tutorials

Tutorials: CICS

Tutorial: CICS Support

Set up the ACCT Project

Set up the ESACCT Enterprise Server Region

Run the ACCT Application

Debug the ACCT Application

Tutorial: Web-enabled CICS Acting as a Web Server

Set up the ACCTWEB Project

Set Up the ESACCTSV Enterprise Server Region

Run the ACCTWEB Application in TN3270 Mode

Run the ACCTWEB Application in a Web Browser

Debug the ACCT Transaction

Tutorial: Web-enabled CICS Acting as a Web Client

Set up the ACCTCLNT Project

Set Up the ESACCTCL Enterprise Server Region

Run the ACCTCLNT Application in TN3270 Mode

Debug the ACCT Transaction

Tutorials: CICS Web Services

Tutorial: CICS Web Service Provider from WSDL, Top-down Method

Set Up the Reverse Project

Generate Reverse Web Service Provider Components

Add Operation Logic to REVERSE.cbl

Set Up the CWSPROV Enterprise Server Region, WSDL

Test the Reverse Web Service Provider

Tutorial: CICS Web Service Requester from WSDL, Top-down Method

Set Up the InvokeReverse Project

Generate InvokeReverse Requester Components

Add Operation Logic to invkRev.cbl

Set Up the CWSREQ Enterprise Server Region

Test the InvokeReverse WebService Requester

Tutorial: CICS Web Service Provider from WSDL, Bottom-up Method

Set Up the LoanDemo Project

Generate loanPaym Web Service Components

Update the CWSPROV Enterprise Server Region

Test the LOANPAYM Web Service Provider

Tutorial: CICS Web Service Provider from JSON, Request-Response Top-down Method

Set Up the ReverseJSON Project

Generate the Reverse CICS Web Service Provider Components

Add Reverse Operation Logic

Set Up the JSONPROV Enterprise Server Region

Test the ReverseJSON Web Service Provider

Tutorial: CICS Web Service Requester from JSON, Linkable Interface Top-down Method

Set Up the InvokeReverseJSON Project

Generate InvokeReverseJSON Requester Components

Analyze the invkRevJ.cbl Program

Set Up the JSONREQ Enterprise Server Region

Test the invkRevJ Web Service Requester

Tutorial: CICS Web Service Provider from JSON, Request-Response Bottom-up Method

Set Up the LoanDemoJSON Project

Generate loanPaym Web Service Components

Update the JSONPROV Enterprise Server Region

Test the loanPaym Web Service Provider

Tutorial: CICS Web Service Provider from JSON, RESTful

Set Up the filmsREST Project

Generate filmsREST Web Service Components

Add Operation Logic to filmREST.cbl

Set Up the CWSREST Enterprise Server Region

Test the films Web Service Provider

Tutorials: Application Migration using HCO for PostgreSQL [3]

Tutorial: Create and Load the HCO_Test Database

Tutorial: Application Migration - Converting Labeled Duration Calculations

Analyze the LBLDURATION Project

Run the LBLDURATION Application

Tutorial: Application Migration - Adding Function Emulation

Create and Map User-defined Functions

Analyze the FunctionEmulation Project

Run the FunctionEmulation Application

Tutorials: HCO for SQL Server (HCOSS) [1]

Tutorials: Application Migration using HCOSS

Tutorial: Create the HCO_Test Database

Tutorial: Application Migration - Converting Labeled Duration Calculations

Analyze the LBLDURATION Project

Run the LBLDURATION Application

Tutorial: Application Migration - Adding Function Emulation

Create and Map User-defined Functions

Analyze the FunctionEmulation Project

Run the FunctionEmulation Application

Tutorials: IMS

Tutorial: IMS Support

Set Up the IMSSupport Project

Configure IMS

Set Up the IMSDEMO Enterprise Server Region

Run MFDEMO

Debug MFDEMO

Tutorial: JCL

Set Up the JCLDEMO Project

Set Up the ESJCL Enterprise Server Region

Run the ESJCL Job

Debug JCLDEMO

Tutorials: Open PL/I

Tutorial: Hello PL/I World

Set Up the HelloPLIWorld Project

Debug the Hello PL/I World Application

Tutorial: Developing a PL/I application using Eclipse

Set Up the PLIJCLdemo Project

Set Up the PLIDEMO Enterprise Server Instance

Prepare to Run the OPDEMO Application

Run the OPDEMO Application

Debug the OPDEMO Application

Native COBOL Tutorials

Tutorial: Creating a Native COBOL Application

Creating a Project

Adding Source Code and Building the Project

Create a build configuration

Running the Application

Launch a Debug Session

Tutorials: Interface Mapping Toolkit

Tutorial: SOAP Web Service

Set Up the ProgramSOAP Project

Create the MakeCheckAppt Service Interface

Define MakeCheckAppt Operations

Set Up the ESSOAP Enterprise Server Instance

Deploy the MakeCheckAppt Web Service

Generate a COBOL Client

Debug the COBOL Console Client

Tutorial: EJB Service Interface

Set Up the ProgramEJB Project

Create the AccessBooks Service Interface

Define AccessBooks Operations

Configure the ESDEMO Enterprise Server Instance

Deploy the AccessBooks Java Interface

Generate and Deploy a JSP Client

Run the JSP Client

Tutorial: REST Web Service

Set Up the ProgramREST Project

Create the MakeCheckAppt Service Interface

Define MakeCheckAppt Operations

Set Up the ESREST Enterprise Server Instance

Deploy the MakeCheckAppt Web Service

Generate a COBOL Client

Debug the COBOL Client

Tutorial: JSON RESTful Web Service using API Resources

Set Up the ProgramRESTAPI Project

Create the CarTracker Service Interface

Generate CarTracker Operations

Set Up the ESRSTAPI Enterprise Server Instance

Deploy the CarTracker Web Service

Generate the CarTrackerClientApp COBOL Client

Run the CarTrackerClientApp Client

Tutorial: Using the Callable File Handler

Tutorial

Create a Native COBOL Project

Set the Project Properties

Define the Operation Codes and FCD

Define the Filename Area

Define the Key Definition Block

Define the Record Area

Set up the FCD

Call the Callable File Handler and Check the File Status

Create, Write To, and Close an Indexed File

Read From and Rewrite To the File

Run the Application

Appendices

Appendix A - the source code

Tutorials: JSON Processing

Tutorial: Generating JSON output

Create a native COBOL project

Run the program and view the JSON output

Appendix A: The JSON GENERATE program

Tutorial: Parsing a JSON text string

Create a native COBOL project

Run the program and view the JSON input

Appendix A: The JSON PARSE program

Appendix B: JSON input file

JVM COBOL Tutorials

Tutorial: Creating a Basic JVM COBOL Application

Create a COBOL JVM Project

Create a Class and Build Your Project

Run the JVM Application

Debug the Application

Tutorial: Compiling a COBOL Program to JVM Byte Code

Customizing the COBOL Perspective

Configuring the COBOL JVM Project

Configuring the Java Project

Using the COBOL Program from Java

Running the Application

Tutorial: Packaging JVM COBOL

Customizing the COBOL perspective

Packaging the JVM COBOL output

Building the project

Copying the packaged output

Updating the Calc project to use the packaged JAR file

Running the application

Technology Preview Features

EAP Features

Enterprise Developer Editions and Activating Licenses

To buy and activate a full license

To obtain more licenses

Product Information

Supported Operating Systems and Third-party Software

Additional Software Requirements

AIX

Application Server JCA support for Enterprise Server

Application Servers for JVM COBOL

Browsers

Database Connectors for Visual COBOL

Database Management Systems (DBMSs)

Interface Mapping Toolkit (IMTK)

JCL

Mainframe Terminal Emulation

MFFTP Utility

Performance Availability Clusters (PACs)

Installation

Installing Enterprise Developer for Eclipse (UNIX)

Before Installing

Downloading the Product

System Requirements for Enterprise Developer for Eclipse (UNIX)

Hardware Requirements for Enterprise Developer for Eclipse

Operating Systems Supported

Software Requirements

Setting up the environment

Basic Installation

Installing the software

Starting the product

Advanced Installation Tasks

Installing in an Ubuntu WSL2 on Windows

Installing as an upgrade

Installation Options

Installing Without Superuser Credentials

Installing Enterprise Developer into other instances of Eclipse

RPM Installer

Using the RPM Installer

Other RPM Installer Options

Uninstalling Using the RPM Installer

Installing on Microsoft Terminal Server and Citrix

Customizing the Installation, the Workspace and the Projects

Enterprise Server Installation Options

Configuring SQL Option for DB2 (XDB) for Multi-User Environments

Creating a Private XDB Configuration File in a Multi-User Environment

Changing the Main XDB Server Configuration File

Changing the Private XDB Server Configuration Files in Batch

Configuring Other Components

After Installing

Configuring Enterprise Developer

Configuring the Environment for Developing RDBMS Applications on UNIX

Enabling SHIFT-JIS

Viewing the Product Help

Repairing

Uninstalling

Installing Enterprise Developer Development Hub

Before Installing

Downloading the Product

Operating Systems Supported

System Requirements

Hardware Requirements

Software Requirements

Basic Installation

Installing on UNIX

Advanced Installation Tasks

Installing as an Upgrade

UNIX Installation Options

RPM Installer

Using the RPM Installer

Other RPM Installer Options

Uninstalling Using the RPM Installer

Installing on Microsoft Terminal Server and Citrix

Customizing the Installation, the Workspace and the Projects

Enterprise Server Installation Options

Configuring SQL Option for DB2 (XDB) for Multi-User Environments

Creating a Private XDB Configuration File in a Multi-User Environment

Changing the Main XDB Server Configuration File

Changing the Private XDB Server Configuration Files in Batch

Configuring Other Components

After Installing

Setting up the product

Configuring the Remote System Explorer Support

Configuring the firewall

To configure the firewall settings

Managing Licenses

To start Micro Focus License Administration

Configuring Micro Focus License Administration

Installing licenses

If you have a license file

If you have an authorization code

Authorizing your product when you have an Internet connection

Authorizing your product when you don't have an Internet connection

Configuring your machine to use a central license server

Installing licenses silently

Viewing installed licenses

Uninstalling licenses

Removing licenses

Revoking licenses when you have an Internet connection

Revoking licenses when you do not have an Internet connection

Installing License Manager

Installing a local license server

Restarting SafeNet on Linux Using SystemD

Enable Automatic Restart of the AutoPass License Daemons on Linux Using SystemD

Installing a standalone network license server

Prerequisites for Integration with an AutoPass License Server

Trial licenses

Usage Logging

License Usage Logging with AutoPass License Server

Integrating with an AutoPass License Server

Configuring AutoPass License Server for Custom Reports

Working with Custom Reports

Create a Custom Report

Run a Custom Report

Licensing Error Messages

Initialization error - Initializing: Cannot communicate with licensing daemon

Error - Initializing: Cannot find initialization file

Error - Unable to manage licenses in license manager that is not running on localhost

Error [5]: Cannot talk to the license server on host "xxx.x.x.x". Server not running

Error authorizing... Remote request error - The authorization code is invalid

Error [26] - Request Denied due to clock tamper detection

Error[18]: No license code is available for feature (component)

Unable to authorize (cause)

Updates and Product Support

Micro Focus End User License Agreement

Additional License Authorizations for Visual COBOL & Enterprise software products

Known Issues and Restrictions

Application Server JCA Support

Application Workflow Manager

Issues with Audit Manager

Calling COBOL Programs from C

COBOL Programming

Boolean Data Items

CBL2XML Utility

Interface Mapping Toolkit

Enhanced ACCEPT/DISPLAY Syntax (Adis)

Filenames

IDXFORMAT 8 and 12 File Size Limits

Unsupported Features

XML Extensions

Compatibility

Coexisting with earlier Micro Focus products

MFA Server v9.00 Enterprise Developer 7.0

Containers

Data Access

COBSQL

HCO for DB2 LUW

File Handling

Limitations to MFDBFH

Remote Debugging - Known Issues

Debugging, Problem Determination and Diagnostic Tools

Debugging in Eclipse

Language Service

Issues with Reverse Debug and Live Recording

Test Coverage

Just-in-time debugging

Documentation Considerations

Issues with Enterprise Server

Eclipse IDE

Background Parsing

Building Applications

Eclipse Help Viewer

Eclipse Projects and Files

Editing Symbolically Linked Files

Restrictions in Refactoring

Standalone Files

WTP Tools

JVM COBOL Applications - Known Issues and Restrictions

Application Servers - Known Issues

COBOL JVM Projects - Known Issues

Java Virtual Machine - Known Issues

Using Java and JVM COBOL Together

Licensing

Mainframe Programming and Management

Issues with HCO for SQL Server (HCOSS)

Historical Statistics Facility (HSF)

IMS Support

JCL and VSE Support

Mainframe Call Generator

Issues with Mainframe Subsystem Support (MSS)

MFDS

PL/I Support

Run-time Behavior

Restrictions in the Micro Focus Unit Testing Framework

Remote Mainframe Development

Contacting Micro Focus

Further Information and Product Support

Information We Need

Contact information

Sample Programs

Demonstrations of Mainframe Subsystem Support

Demonstrations of COBOL

Using the Command Line Demonstrations

Command Line Demonstrations of COBOL for JVM

Command Line Demonstrations of Native COBOL

Command Line Demonstrations of COBOL used with SQL

Command Line Demonstrations of COBOL used with Business Information Server (BIS)

Cheat Sheets

The Micro Focus Community

Help on Help

Developing Applications in the IDE

Starting Enterprise Developer

To start Enterprise Developer

Introduction to Eclipse

Eclipse basics

Using the windows and menus

The Eclipse Welcome Page

Views

COBOL Views

PL/I Views

Team Perspective Views

Perspectives

Menus and toolbars

Controlling views and editors

Navigation shortcuts

Creating your first 'Hello COBOL World' application

Creating your first Hello PL/I World application

Advanced details

The Eclipse resource system

Configuring projects

Inter-project dependencies

Dependency Paths

Including files and folders

Working sets

Configuring the 'Hello COBOL World' application

Development life cycle

Adding projects to your workspace

Adding existing source files into a project

Specifying compiler directives and project settings

Editing

Building

Running and debugging

Debug the 'Hello COBOL World' application

Debug the 'Hello PL/I World' application

Additional Eclipse functionality

Configuring Eclipse

Configuring AutoCorrect

Background Parsing

BMS Preferences

Builder Preferences

Code Analysis preferences

Directives Determination preferences

Content Assist

COBOL editor

COBOL code mining preferences

COBOL Formatter preferences

File extensions

Project Builder preferences

Smart Edit mode

Syntax coloring

Standalone Files preferences

Using Eclipse for COBOL Development

Overview of Creating COBOL applications in Eclipse

Tips and Tricks with the IDE

Perspectives and Projects for COBOL Development

Writing Code Efficiently in the COBOL Editor

Editing Assistance in the COBOL Editor

Using COBOL Code Templates

Formatting COBOL code

To format COBOL source code

Formatter profiles

Creating a formatting profile

COBOL Formatter preferences

Editing a formatting profile

Deleting a formatting profile

Clean Up profiles

Creating a clean up profile

Clean up preferences

Editing a clean up profile

Deleting a clean up profile

Editing and Previewing BMS Files

Importing and exporting profiles

Line Numbers (Renumber and Unnumber)

To specify line numbering options

To number or renumber lines in source code

To remove line numbers from source code

Searching using Micro Focus Search

Micro Focus Find/Replace

Viewing copybooks in context

Pre- and post-build processing events

Working with a large code base

Working with projects and a large code base

Accessing source code without a project

Optimizing the performance of the IDE

Configuring large projects

Large projects and remote development

Building applications in Eclipse

Building applications outside of Eclipse

Best practice when upgrading a legacy application

Steps to upgrading your application

Creating COBOL projects

Creating and importing COBOL projects

To create a COBOL project

To import an existing Eclipse project

Creating remote projects

To create a remote native COBOL project

To create a remote COBOL JVM project

To create a remote mainframe project

To create a remote COBOL copybook project

To change the connection details of a remote project

To convert a local COBOL project to a remote COBOL project

Creating service interface projects

To load projects into the Team Developer perspective

Creating and importing resources

To create a new file

To create a new file from a custom template

To import a file into a project

To import a copybooks into a virtual folder

To associate a file extension with COBOL

Extracting COBOL code to a copybook

To create a COBOL JVM Enum type

To create a COBOL JVM Delegate

To create a COBOL JVM Value type

Using source files from outside your project

To create project dependencies

Remove project dependencies

To link to copybooks or sources outside the project

To link to mainframe locations

Using custom project and file templates

To configure the IDE to use custom templates

To create a custom project template

To create a custom file template

To create a project or a file from a custom template

Identifying COBOL copybooks and programs

Configuring the project, build configuration, folder and file properties

Project Properties

Run-Time Configuration Properties

Build Configurations

Managing Build Configurations

Configuring Build Configuration Settings

Folder and File Properties

Viewing overridden settings

Setting the file properties using directive scanning

Building COBOL applications

Compiling COBOL Applications

Compiling COBOL code

Executable file formats

Compiling JVM COBOL

Building a project using Apache Ant

Setting Compiler directives for COBOL

Setting project-wide Compiler directives

Setting Compiler directives within a build configuration

Setting Compiler directives on folders or individual files

Setting Compiler directives from the command line

Setting Compiler directives in source code

Setting Compiler directives in a directives file

Configuring directive sets

Configuring directive set references

Creating an .mfdirset file

Using environment variables

Specifying environment variables for an application

Editing variables in the build environment

Removing variables in the build environment

Specifying environment variables in a run configuration

Copybook search order

Temporary files used when compiling native COBOL

Techniques for quicker compilation

Using preprocessors

SQL preprocessors

Additional preprocessors

Specifying an additional preprocessor

Editing an additional preprocessor

Specifying the order of execution for multiple preprocessors

Removing an additional preprocessor

Linking

Introduction to linking

Linking and linked file types

Linking and binding

Dynamic loading

Specifying non-default link options in the IDE

Cleaning a project

Tips: Building COBOL projects

Developing applications on remote machines

Remote host connections

To create a connection to a remote host

Securing a remote SSH connection

Remote connection troubleshooting

To diagnose client-side problems when connecting to a remote host

Client-side connection tests

To diagnose server-side problems when connecting to a remote host

Server-side connection tests

To create a connection to a remote UNIX host running behind a firewall

Remote server configuration

Configuring the firewall

To configure the firewall settings

To launch a server on the remote host using the daemon process

To launch a server on the remote host without a daemon process

To launch a server on the remote host using a Secure Shell daemon process

Working with file systems on remote machines

Using Remote System Explorer (RSE)

Remote System Explorer logging

Using NFS

To verify that NFS is running

To set up an NFS server

To set up an NFS client

Using Samba

Preparing files for deployment

Copy deployment files to a specific folder

Code coverage (native COBOL)

Enabling code coverage

Running an application with code coverage

Viewing the code coverage information

Code coverage HTML reports

Configuring the code coverage HTML reports

Code Analysis

Application Analysis Server References and Reports

To set up an Application Analysis Server connection

Getting Direct References

Execute a Single Code Search

Generating a Code Search Report

Using COBOL Source Information

Introduction to COBOL Source Information

To run a CSI query

CSI Query Results

CSI Queries

Data Items

Complex Data Item Queries

Qualified Names

Examples of Data Item Queries

Procedures (Paragraphs and Sections)

Called Subprograms

COBOL Verbs

Examples of COBOL Verb Queries

Special Queries

Debugging COBOL Applications

Debugging Scenarios

Starting the debugger automatically

Starting the debugger automatically using library routines

Starting the debugger automatically using just-in-time debugging

Debugging using a core dump

Preparing for a core dump

To enable a core dump using a library routine

To enable core dumps using run-time tunables

To debug a core dump

Debugging using a live recording

To create a live recording

To debug a live recording

Debugging using a remote machine

Remote debug of projects developed locally

Projects developed on a remote UNIX machine

Debugging applications that run on Ubuntu (ptrace restriction)

Debugging CICS channels and containers

CICS Channels View

To modify data in a container

Debugging mixed language applications

Debugging on Enterprise Server Scenarios

How debugging on Enterprise Server works

To prepare for debugging on Enterprise Server

To debug on Enterprise Server

To debug on a remote Enterprise Server

To debug using a temporary enterprise server

Error messages for Web services

Debugging Enterprise Server services and applications using a live recording

How it works

How Enterprise Server finds a match

To create a live recording with Enterprise Server dynamic debugging

Debugging outside of Eclipse

The Character Animator

Overview of Character Animator Functions

Working With Character Animator

The Character Animator Screen

Character Animator Screen Overview

The Information Line

Moving the Cursor and Text During Animation

Entering Text on Menus

Using the Character Animator Windows

Viewing Data

Key Functions for Updating Queried Data Items

Menus

Locate-declaration Menu

Query Menu

Functions

Function Descriptions

Cancel All Breakpoints

Cursor-position Reset

Detach from application

Scroll Up/Down (continuously)

Scroll Up/Down (one line)(Ctrl+<left-arrow>/<right-arrow>)

Thread-local Breakpoint

Run-time System Error Messages

Directives for Character Animator

Directive Descriptions

Cross-session Debugging

Using cobesdebug to Debug Services and Applications on Enterprise Server

How it works

How Enterprise Server finds a match

How to debug services and applications with Enterprise Server Dynamic Debugging

Overview of the debugging process

Preparing projects for debugging

Compiling for debug

Creating a debug configuration

COBOL Application, COBOL Attach to Process, and COBOL Wait for Application Attachment

COBOL Core Dump

COBOL Enterprise Server

COBOL Live Recording

COBOL JVM Application and COBOL JVM Remote Application

Preparing remote projects for debugging

Debugging features and techniques in Eclipse

Views in the Debug perspective

Using breakpoints and watchpoints

Setting conditional breakpoints and watchpoints

Reverse debugging

Debugging commands and options

Debugging in COBOL Copy view

Enabling Just-in-Time debugging

Enable Just-in-Time debugging in Eclipse

Code Refactoring

Rename Refactoring

Rename Refactoring JVM COBOL

Extracting COBOL code to a copybook

Extracting PL/I code to an include file

Running COBOL applications

Configuring the run-time behavior

To run a COBOL application on your local machine

To run an application on a remote machine

Working with Apache Maven

Maven for native COBOL projects

Configuring a native COBOL project for Maven

Configuring native unit testing projects for Maven

Example POM file

Maven for COBOL JVM projects

Create a Maven-based project

Adding Maven support to an existing project

Micro Focus-related Maven goals

Using Eclipse for PL/I development

PL/I Perspective and Projects

The PL/I Editor

Configuring the PL/I Editor

Word wrapping and indentation in Smart Edit Mode

Customizing the Behavior of Home, End, and Tab Keys

Configuring Which Preprocessor Statements are Ignored by the PL/I Parser

Configuring the Ruler in the PL/I Editor

Configuring Background Parsing in the PL/I Editor

Creating a PL/I project

Creating Remote PL/I Projects

To create a remote PL/I project

To create a remote mainframe PL/I project

To create a remote PL/I include project

To convert a PL/I local project to a PL/I remote project

Setting PL/I Project, File and Build Configuration Settings

Configuring PL/I project's properties

Configuring the Build Configuration of a PL/I Project

Configuring the Build Path for PL/I Projects

Setting Properties on PL/I Files

Indicating That a .pli File is a Source File

Extracting PL/I code to an include file

Compiling and building a PL/I project

Linking PL/I programs

Code Coverage (PL/I)

Enabling Code Coverage

Running an Application with Code Coverage

Viewing the Code Coverage Information (PL/I)

Debugging PL/I projects

PL/I debug configurations

PL/I Application

PL/I Attach to Process

PL/I Enterprise Server

PL/I Wait for Application Attachment

Debugging commands and options (PL/I)

Views in the debug perspective

Debugging projects developed on a remote UNIX machine

Using Breakpoints

How to

To debug a PL/I project

To set PL/I program breakpoints

To set PL/I condition breakpoints

To set PL/I signal breakpoints

To set PL/I data breakpoints

Troubleshooting

Debug session hangs (ES)

Debug session hangs

Remote debug session hangs

CTF tracing

Running a PL/I application

Using Enterprise Server from within the IDE

Specifying IDE configuration options for Enterprise Server

Enterprise Server templates

Managing enterprise servers from Server Explorer

To sign on to a Micro Focus directory server

To export an enterprise server

To import an enterprise server

To start, stop, or restart an enterprise server from the IDE

To display an enterprise server log inside the IDE

To connect to a remote enterprise server

To create a new enterprise server

To delete an enterprise server

To select an enterprise server to run an application on

To associate an enterprise server with a project

To configure a Fileshare server for an enterprise server[8]

To open the ESCWA UI from the IDE

To create an Enterprise Server Common Web Administration (ESCWA) connection

Managing CICS Resources

View a CICS resource

Create a CICS resource

Delete a CICS resource

Managing the JCL spool queues and catalog

To submit a JCL file

Catalog tasks

Display and filter the catalog

Create a catalog item

View the contents of a catalog item

Edit a data set from the catalog

Open a catalog file through a Fileshare server[8]

Duplicate a catalog item

Delete an item from the catalog

Spool queue tasks

Display job details

Hold or release a job in the queue

Update control information for a job

Delete a job from the queue

Filter the spool queue

Modern Development Practices

Using Enterprise Developer in Modern Application Development

Introduction to Modern Application Development

What is Modern Application Development?

Key Concepts in Modern Application Development

Steps Involved in Modern Application Development

Agile Methods

Introduction to Agile Methods

Agile Development Workflow

Agile Development and Micro Focus Development Tools

Continuous Integration

Introduction to Continuous Integration

Continuous Integration Workflow

Continuous Integration and Micro Focus Development Tools

Continuous Delivery

Introduction to Continuous Delivery

Continuous Delivery Workflow

Continuous Delivery and Micro Focus Development Tools

Continuous Improvement

Using Enterprise Developer with Jenkins

Scenarios for Using Jenkins

Terminology

Software Requirements

Installing and Configuring Jenkins

Advanced Configuration

Configuring Email Reporting

Using Sources from Source Control

Triggering Builds Automatically

Creating Environment Variables

Using Agents

Using Jenkins to Build COBOL Applications

Setting up the Environment

Making mfant.jar Available to Enable Building

Specifying the Location of Linked Folders

Examples

Example - Integrating Code Analysis

Example - Running MFUnit Tests

Best Practices When Using Jenkins

Using Jenkins With Source Control

Specifying any Environment Variables in a Project's Configuration

Creating Separate Projects for Building and Testing Your Code

Using Pipelines to Build Your Applications

Troubleshooting

Ant Error "Can't find mfant.jar" When Building COBOL Projects

COBOL Projects Don't Build

A Build Failure isn't Reported as a Failure

Using Enterprise Developer with Containers

Introduction to Containers

Benefits of Using Containers

Container Terminology

Getting Ready to Use Enterprise Developer with Containers

Installing Container Tools on Red Hat Enterprise Linux

Installing Docker on Linux

Key Concepts When Using Containers for COBOL Application Development

Create Different Images for Different Development Tasks

Overview of Creating Images to Use in the Development Process

Additional Information on Using Containers for COBOL Application Development

Building Images for COBOL Applications

Building a Base Image Containing Micro Focus Enterprise Developer UNIX Components

Building an Image Containing an Application to use with Micro Focus Enterprise Developer UNIX Components

Debugging and Running COBOL Applications in Containers

Debugging and Running Native COBOL Applications in Containers

Overview of Debugging and Running Native COBOL Applications in Containers

Different Ways of Building a Native COBOL Application in a Container

Using Character Animator to Debug Native COBOL Applications Running in Containers

How to work with native COBOL applications in containers

To add a Dockerfile to a native COBOL project

To specify project properties for containers

To specify container information in debug and run configurations

To specify the type of container to use

To debug or run a native COBOL application in a container

To prepare a containerized native COBOL application for debugging on Enterprise Server

To debug or run a containerized native COBOL application running on Enterprise Server

To debug or run a containerized native COBOL application running under Kubernetes

To build an image for deployment

Debugging and Running JVM COBOL Applications in Containers

Building a JVM COBOL Application that is to be Debugged in a Container

Running a Container that is to be Debugged

Finding the Details of a Container that is to be Debugged

Starting to Debug a JVM COBOL Application in a Container

Debugging and Running PL/I Applications in Containers

Container Demonstrations

Supplied Container Demonstrations

Using the Container Demonstrations

The Container Demonstration for the Enterprise Developer Base Image

Introduction to the Container Demonstration for the Enterprise Developer Base Image

Running the Container Demonstration for the Enterprise Developer Base Image

Files in the Container Demonstration for the Enterprise Developer Base Image

The CICS Container Demonstration

Introduction to the CICS Container Demonstration

Creating the Image for and Running the CICS Container Demonstration

Files in the CICS Container Demonstration

Programming

COBOL Programming

Calling COBOL Programs

Specifying the Program to Be Called

Naming a Program in its PROGRAM-ID Paragraph

Entry Point Mapping for COBOL Programs

Calling a Program Using an Implicit Program Name

Calling a Program Using an Explicit Program Name

Calling Entry Points in Subprograms

Calling Programs According to How They Are Linked

State of the Data when a Program is Called Again

Search Conventions Used for Calling Programs

Passing Parameters to a Called Program

Passing Return Codes Back to the Calling Program

Call Prototypes

About Call Prototypes

The ANY Keyword

Relaxed Type-checking

Using Type Definitions

Using the Library Routine Type Definitions and Call Prototypes

JVM COBOL Programming

Native COBOL Compared to JVM COBOL

Introduction to Object-Oriented Programming for COBOL Developers

Moving Native COBOL Applications to JVM COBOL

Why Move to JVM COBOL Code?

Considerations When Moving to JVM COBOL

Writing Multi-User Applications

Using Java Managed Beans to Manage and Monitor COBOL Applications

Accessing Procedural COBOL From JVM COBOL Code

Example of Using a JVM COBOL Wrapper Class

Example of Using the ILSMARTLINKAGE Compiler Directive

Compiling and Calling JVM COBOL Applications as Part of a Package

Producing a Java Property File

Example 1: Locating the Java Property File on the CLASSPATH

Example 2: Locating the Java Property File Directly from COBOL

64-bit applications in the Java environment

Using a File Handler in JVM COBOL

Multiple user COBOL applications in Java

Background to multiple run units and Java

Developing an application for multiple run units in JVM COBOL

Interoperability

Data Marshaling and Type Conversion for JVM COBOL Interoperation

Type Compatibility in Interoperation with Managed Code

Exposing COBOL Linkage Data as Managed Types

Type Mappings from Native COBOL to JVM COBOL Code

Write a Proxy or Edit the COBOL for Java Interoperation?

JVM COBOL Interoperating with Native COBOL

Calling Native COBOL from JVM COBOL

Passing Parameter Modes for JVM COBOL Calling Native COBOL

Pointers from Native Code to JVM COBOL

Strings in JVM COBOL Interoperation

Arrays of Bytes in JVM COBOL Interoperation

Limitations in JVM COBOL Interoperability

Example of JVM COBOL Interoperation with Native Code

JVM COBOL Interoperating with Java

Java Calling JVM COBOL

Example of Java Calling JVM COBOL

JVM COBOL Calling Java

Example of JVM COBOL Calling Java

JVM COBOL Passing Java Instances to Native Procedural COBOL

JVM COBOL Passing Java Instances to Native Object COBOL

Exposing COBOL as Web Services

Using COBOL and Java Together

Java and COBOL Interoperability Options

Considerations

Linking to the Multi-threaded Run-time System

Setting Up the Environment for Java and COBOL

Java/COBOL Application Launcher

Using the Java/COBOL Application Launcher from the Command Line

Using the Java/COBOL Application Launcher from the Eclipse IDE

Compiling COBOL Programs that Call Java

Compiling COBOL Programs that Are Used from the CobolBean interface

Linking to the Multi-threaded Run-time System

Migrating Applications between JDK 8 and JDK 11

Deploying a Java Service Interface and Using Resource Adapters

JSP Client

Application Ear File

Client War File

EJB Jar File

Deployment Descriptors that Are Generated

Manifest Files

CustomRecord and Other Java Support

Calling the Generated EJB or Java Bean

Using Java Beans under J2SE

Overview of Using an Unmanaged Connection under J2SE

Using an Unmanaged Connection under J2SE

Writing a Simple CCI Program

Sample Program to Connect to a Resource Adapter

Sample Service

Sample Initialize Method

Sample Custom Record

Sample Calculator COBOL Program

Calling Procedural COBOL from Java

Overview - Calling Procedural COBOL from Java

Coding Your Java Program

Multi-threading Considerations

Loading a COBOL Program or Library

Using the cobcall() Methods

Examples of Calling COBOL from Java

Changing Data Members in a Java Object

Using CobolBean for Instance Data

Canceling a COBOL Program

Handling Strings from a Java Program

Pointer Class

mfjstring

CobolNational Class

Using Custom Records to Pass Group Items

Using JNI with COBOL

Example of Throwing an Exception

Calling Java from Native OO COBOL

Overview of Calling Java from Native OO COBOL

Before You Start

Declaring Java Classes

Instantiating Java Objects

Calling Java Methods

Accessing Java Variables

Handling Java Exceptions

Accessing Native Java Objects

Finalizing Java Objects

Calling Native OO COBOL from Java

Overview - Calling Native OO COBOL from Java

Before You Start

Writing a Java Class in Native OO COBOL

Importing the COBOL Support

The Wrapper Class

Adding and Removing Methods

Throwing Exceptions from COBOL

Using BY REFERENCE Parameters

Working with Java Programs

Java Data Types

Java Data Type Conversion Rules

Java Typedefs

Using the Jarray Class

Adding Parameters Using ParameterList()

Using Structures

Creating Custom Records using com.microfocus.cobol.lang.CustomRecord Interface

JVM COBOL Interoperating with Java

Java Calling JVM COBOL

Example of Java Calling JVM COBOL

JVM COBOL Calling Java

Example of JVM COBOL Calling Java

JVM COBOL Passing Java Instances to Native Procedural COBOL

JVM COBOL Passing Java Instances to Native Object COBOL

Internationalization Support

National Locale Support

Compiling Programs with NLS

Setting Up the National Locale Environment

Using the LANG Environment Variable

Running Your NLS Program

NLS Initialization

NLS Operations

String Comparisons

Class Condition Tests

SORT and MERGE Key Comparisons

Case Conversion

Collating Sequence Operations

Editing and De-editing Moves

Intrinsic Functions Numval and Numval-c

Using NLS Library Routines in Your Programs

Mixing Programs With and Without NLS

Message Files

Format of a Message File

Example Error Message File

Compiling and Deploying a Message File

Unicode Support

National Literals

National Hexadecimal Literals

National Data Items

UTF-8 Data

UTF-16 Byte Ordering

Preparing Applications for Enterprise Server

The Application Container

Short-running Requests

Long-running Requests

Resource Management

Application-managed Services

Container-managed Services

Restrictions on the COBOL application

User Interaction for COBOL Program Services

Run-time Errors and Completion

Object-oriented COBOL

Interface Mapping Toolkit (IMTK)

Managing IMTK Projects

Defining Service Interfaces

Interface Mapper

Operations

JSON (RESTful) Operations

Body, Path, and Query Fields

Deploying Service Interfaces

Deployment Configuration Requirements

Service Interface Deployment Methods

Security Considerations for Service Interface Deployment

Deploying Java Service Interfaces

Deploying to 64-bit Platforms

Deploying to an Enterprise Server under UNIX

Service Interface Deployment Package

Clients

COBOL Console Client

JSP Client

How to

Manage IMTK Projects

To configure the run-time environment

To create a COBOL program-based service interface

To modify the CLASSPATH property for an EJB service interface

To update service interfaces with source code changes

To set Interface Mapper preferences

To validate a service interface

Define Service Interfaces

To assign a value to a COBOL field

To create a COBOL program-based operation

To create a reusable field

To create an interface field

To edit field properties

To edit operation properties

To generate new API resource operations

To group interface or reusable fields

To map an interface field

To start the Interface Mapper

Deploy Service Interfaces to Enterprise Server

To add or remove application files to deploy

To associate an enterprise server with a project

To compile a service driver program on a remote UNIX machine

To generate and deploy a service interface from a project

To delete a deployed service

To deploy to a remote enterprise server

To deploy a service interface using imtkmake

To generate client applications from a service interface file

To install a deployment package using mfdepinst

To redeploy a service interface

To set deployment properties

Reference

imtkmake command

mfdepinst command

COBOL to Service Interface Data Type Matches

User Interface Reference

Service Interface Projects

Advanced Settings

Properties - General Tab

Properties - Deployment Server Tab

Properties - Application Files Tab

Properties - EJB Generation Tab

Properties - J2SE Generation Tab

Properties - Exit Point Handler Tab

New Java Interface Wizard

New REST Web Service Wizard

New SOAP Web Service Wizard

Interface Mapper

Operation Properties - General tab

Operation Properties - HTTP tab

Operation Properties - User Exits tab

Operation Reorder

New API Resources

Mixed Language Programming

Ordering Parameters to Pass to Non-COBOL Programs

Removing Parameters from the Stack

Storage Representation of Parameters

Aligning Parameters on Word and Double Word Boundaries

Handling Return Codes in Mixed Language Applications

Call Conventions for Interfacing with Mixed Languages

Building a Mixed Language Application

Interfacing with C Programs

Avoiding data name conflicts

Calling a COBOL Entry Point Directly

Passing Data between C and COBOL

Header-to-COPY Utility

Overview

Examples

Converting Header Files Using the H2cpy Utility

H2cpy command-line options

H2cpy Translations

Translating Names

Using the Headers Preprocessor

Translating Directives

Preprocessor Directives

Expanding Macros and Creating String Literals

Translating Conditional Directives

Translating Other Directives

Translating Statements

External Data Declarations

Example - Translating External Data Declarations

Type Definitions

Example - Translating Type Definitions

Structure, Union and Enumerator Declarations

Example - Translating Named Declarations

Example - Translating Unnamed Declarations

Example - Translating Enumerator Declarations

Function Prototype Declarations

Example - Translating Function Prototype Declarations

Example - Translating C Calling Conventions

Call Parameters

Example 1 - Parameter Passing in C and in COBOL

Example 2 - Parameter Passing in C and in COBOL

H2cpy Limitations

Overview - H2cpy Messages

Warning Messages

* Warning, other return already defined for: name

* Warning, float has been evaluated as zero

* Warning, expression buffer overflow - ignored

* Warning, macro too long, ignored: name

* Warning, macro has too many parameters

* Warning, macro parameters too long - ignored

* Warning, neither whitespace nor ( after #define. Ignoring the line.

*Warning, redefinition ignored for #define

* Warning, struct/union 4 bytes (or 8) and passed by value cannot be directly accessed from COBOL

Error Messages - Command Line Errors

Error, command line too long

Error, no input C header file given

Error, too many input filenames

Error, macro name already defined

Error, exceeded max number of include directories, max=14

Error, unknown C type: name

Error, no C type alignment value

Error, no C type size value

Error, no call convention value provided

Error, unknown environment (not 16 or 32)

Error, unknown option - flag

Error Messages - Invalid C Source

Error, type expected, found name: name

Error, type expected

Error, typedef found at inner level; check brackets

Unexpected token token

Error, type expected

Error, type expected, found name

Error, no unique typedef name!

Error, already declared this name

Error, undeclared enum name

Error, already defined name: name

Error, already defined struct/union as: name

Error, other params already defined for : name

Error, declaration buffer overflow

Error, no unique declarator name!

Error, no unique parameter name!

Error, invalid C code (missing token)

Error, too many digits for 4 bytes in name

Calling COBOL Programs from C

Error Messages when Calling Non-COBOL Programs

Signal Handling

Signal Handling Overview

Posting Signal Handlers

Writing Signal Handlers

More than One Handler for the Same Signal

Converting Signal Handlers Written for the signal() Function

Third Party Software that Uses Signals

Examples of Mixed Language Programming

Example of Calling C functions from COBOL

Example of Posting a Signal Handler

Using COBOL and XML together

XML Extensions

Installation and introduction

Before you start

System requirements

XML Extensions components

Development components

Deployment components

Installing XML Extensions

Introducing XML Extensions

What is XML?

COBOL as XML

XML as COBOL

Getting started with XML Extensions

XMLGEN Compiler directive

Model files

Typical development process example

Design the COBOL data structure and program logic

Compile the program

Execute the program

Making a program skeleton

Making a program that exports an XML document

Populating the XML document with data values

Deploy the application

How XML Extensions locates files

XML Extensions statements reference

Memory management with XML Extensions

Searching for files

Document processing statements

XML TEST WELLFORMED-FILE

XML TEST WELLFORMED-TEXT

Document management statements

XML RESOLVE DOCUMENT-NAME

XML RESOLVE SCHEMA-FILE

XML RESOLVE STYLESHEET-FILE

XML RESOLVE MODEL-NAME

Directory management statements

XML FIND FILE

XML GET UNIQUEID

State management statements

XML INITIALIZE

XML TERMINATE

XML DISABLE ALL-OCCURRENCES

XML ENABLE ALL-OCCURRENCES

XML DISABLE ATTRIBUTES

XML ENABLE ATTRIBUTES

XML GET WHITESPACE-FLAGS

XML SET WHITESPACE-FLAGS

XML SET XSL-PARAMETERS

XML SET XSL-PARAMETERS-NEW

XML CLEAR XSL-PARAMETERS

COBOL considerations

File management

File naming conventions

External XSLT Stylesheet File Naming External XSLT stylesheet file naming conventions

Other input file naming conventions

Other output file naming conventions

Data conventions

Data representation

COBOL and character encoding

MF_XMLEXT_LOCAL_ENCODING environment variable

UNIX character encoding

FILLER data items

Missing intermediate parent names

Unique element names

Unique identifier

Sparse COBOL records

Copybooks

Statement definitions

REPLACE statement considerations

Displaying status information

Application termination

Anonymous COBOL data structures

Limitations

Data items (data structures)

Edited data items

Wide and narrow characters

Data item definitions and size

Data naming

OCCURS restrictions

Reading, writing, and the Internet

Optimizations

OCCURS DEPENDING

Empty occurrences

Cached XML documents

JVM COBOL code considerations

New XML statement

XML statement restrictions

XML considerations

XML and character encoding

Document type definition support

XSLT stylesheet files

Handling spaces and whitespace in XML

Schema files

Appendix A XML Extensions examples

Example 1 Import file and export file

Development for example 1

Batch file for example 1

Program description for example 1

Data item for example 1

Other definitions for example 1

Program structure for example 1

Execution results for example 1

Example 2 Export file and import file with XSLT stylesheets

Development for example 2

Batch file for example 2

Program description for example 2

Data item for example 2

Other definitions for example 2

Program structure for example 2

Execution results for example 2

Example 3 Export file and import file with OCCURS DEPENDING

Development for example 3

Batch file for example 3

Program description for example 3

Data item for example 3

Other definitions for example 3

Program structure for example 3

Execution results for example 3

Example 4 Export file and import file with sparse arrays

Development for example 4

Batch file for example 4

Program description for example 4

Data item for example 4

Other definitions for example 4

Program structure for example 4

Execution results for example 4

Example 5 Export and import text

Development for example 5

Batch file for example 5

Program description for example 5

Data item for example 5

Other definitions for example 5

Program structure for example 5

Execution results for example 5

Example 6 Export file and import file with directory polling

Development for example 6

Batch file for example 6

Program description for example 6

Data item for example 6

Other definitions for example 6

Program structure for example 6

Execution results for example 6

Example 7 Export file, test well-formed file, and validate file

Development for example 7

Batch file for example 7

Program description for example 7

Data item for example 7

Other definitions for example 7

Program structure for example 7

Execution results for example 7

Example 8 Export text, test well-formed text, and validate text

Development for example 8

Batch file for example 8

Program description for example 8

Data item for example 8

Other definitions for example 8

Program structure for example 8

Execution results for example 8

Example 9 Export file, transform file, and import file

Development for example 9

Batch file for example 9

Program description for example 9

Data item for example 9

Other definitions for example 9

Program structure for example 9

Execution results for example 9

Example 10 Diagnostic messages

Development for example 10

Batch file for example 10

Program description for example 10

Data item for example 10

Other definitions for example 10

Program structure for example 10

Execution results for example 10

Example 11 Import file with missing intermediate parent names

Development for example 11

Batch file for example 11

Program description for example 11

Data item for example 11

Other definitions for example 11

Program structure for example 11

Execution results for example 11

Example batch files

Cleanup.bat

Example.bat

Examples.bat

Appendix B: XML Extensions sample application programs

Appendix C: XML Extensions error messages

Summary of error messages in XML Extensions

XML Syntax Extensions

XML Implementation

Syntax for Handling XML in COBOL

SELECT Paragraph

XML Description Paragraph (XD)

IDENTIFIED BY and IS ATTRIBUTE Clauses

PROCESSING-INSTRUCTION Clause

COUNT IN Clause

NAMESPACE Clause

COBOL Verbs

Compiling XML-enabled COBOL

Building XML-enabled COBOL from Enterprise Developer

Compiling XML-enabled COBOL from the Command Line

Generating COBOL Structures with XML Syntax from the Command Line

CBL2XML Utility

Generating a Copybook and Schema

Generating XML-enhanced COBOL from an XML Schema

Mapping COBOL Data to XML Elements

Accessing an XML-enabled Record

Validate an XML Document

XML PARSE

Special Registers

User Routine

Glossary of terms

64-bit Native COBOL Programming

Compiling Native COBOL Programs for 64-bit

Transitioning Native COBOL Programs to 64-bit

Programs Using Pointers

Programs with a Directly Coded File Control Description

Programs Migrating from the Mainframe

Single Sourcing and Compiling Native COBOL Programs for 64-Bit

Single Sourcing and Dual FCD Support in Native COBOL Programs

Embedded HTML

EHTML Preprocessor Directives

Deploying a CGI Application with Embedded HTML

Debugging a CGI Application

Compatibility

Compatibility with ACUCOBOL-GT

Converting ACUCOBOL-GT Applications

Enabling ACUCOBOL-GT Compatibility

Compiler Directives for ACUCOBOL-GT Compatibility

Compiler Option Support

Setting Compiler Options

Supported ACUCOBOL-GT Compiler Options

Standard Options

Native Object Code Options

Listing Options

Internal Table Options

Compatibility Options

Source Options

Reserved Word Options

Data Storage Options

Truncation Options

Video Options

Warning and Error Options

Debugging Options

Miscellaneous Options

32- and 64-Bit Code Generation

ACUCOBOL-GT Conversion Issues

Complementary ACUCOBOL-GT Technologies

Configuration Files and Configuration Variables

Multi-threading Implementation

Screen Descriptions

Truncation Options in JVM COBOL Code

Unsupported Library Routines

Using Pipes to Assign Filenames When Using the Vision File Handler

ACUCOBOL-GT File Handling

Configuring Access to Vision Files

File Limits

Vision Related Utilities

Converting Vision Files

Configuring Access to Data Files Through AcuServer

ACUCOBOL-GT Library Routines

C$MEMCPY (Dynamic Memory Routine)

C$TOUPPER and C$TOLOWER

I$IO

M$ALLOC (Dynamic Memory Routine)

M$COPY (Dynamic Memory Routine)

M$FILL (Dynamic Memory Routine)

M$FREE (Dynamic Memory Routine)

M$GET (Dynamic Memory Routine)

M$PUT (Dynamic Memory Routine)

RENAME

WIN$VERSION

ACUCOBOL-GT Windowing Syntax

Windowing Syntax Summary

Enabling Windowing Support

Windowing Support Syntax

The ACCEPT Statement

The CLOSE WINDOW Statement

The DISPLAY Statement

Windowing Restrictions

ACUCOBOL-GT Windowing Error Messages

Windowing Supplementary Information

Compatibility with DG Interactive COBOL

Introduction

Compatibility Directives

Compatibility with DG Interactive COBOL

Overview

DG Interactive COBOL Source Programs

Enhancing your Converted Application

Compatibility with DG Interactive COBOL Source

The DG Directive

Reserved Words

DG International Character Set

DG File Status and other Exception Values

Calls

Linkage Section Access

Arithmetic of Group Level Items

Run-time Switches

Program Identification and Data-names

Reformatting a DG COBOL Source File

Reformatting Rules

Compatibility with RM/COBOL

Converting RM/COBOL Applications

Configuring Your Application for Eclipse

Create a native Visual COBOL project

Set the DIALECT RM Compiler Directive for the Project

Import your RM/COBOL Source Code

Add Adis Support to the Project

Build and Run the Project

Appendices

Appendix A - RM/COBOL Source File

Appendix B - ADISCTRL Settings for RM2VCOB

Appendix C - Adis Key Mappings for RM2VCOB

Appendix D - Adis Key Function Mapping for RM2VCOB

Compiler Directives for RM/COBOL Compatibility

Compiling RM/COBOL Programs Without DIALECT"RM"

RM/COBOL Data Types

RM/COBOL Conversion Issues

Producing Executable Code

Perform Statements

ACCEPT FROM CENTURY-DATE and FROM CENTURY-DAY

CURSOR phrase not available in ACCEPT statement

Nested COPY statements with REPLACING phrase

Duplicate Paragraph-names

Figurative Constants and the USING Phrase

File Not Found Errors

Indexed File Error on Open

LIKE Relational-operator Not Available

Linkage Section in Main Program

Nested OCCURS DEPENDING Clauses

Numbering of Segments

Program Identification and Data Names

REMARKS Paragraph

Reserved Words

SAME AS Clause Not Available When Defining Data Structures

Source Code in Columns 73 to 80

START WHILE LIKE Not Available

Undeclared Data Items in Clauses

User-names Longer than 127 Bytes are Truncated

Using Relative Path Names

Running the Code

Table Bound Checking

ACCEPT Fields at the Edge of the Screen

C$CARG Not Supported

Display of Input Data in Concealed ACCEPT Fields

Embedded Control Sequences in DISPLAY Statements

End of File Notification

The EXCEPTION STATUS Clause

File Status Codes

Field Wrap-Around

File and Record Locking

Initialization of Working Storage

Numeric Fields Containing Illegal Characters When Using a DEPENDING ON Phrase of an OCCURS Clause

ON SIZE ERROR Phrase

Open EXTEND of Nonexistent File

Printer Output is Written to Disk

Screen Column Number Specification

Trailing Blanks in Line Sequential Files

Undefined Results of MOVE and Arithmetic Operations

Using the Correct Calling Convention

RM/COBOL Library Routines

RM/COBOL File Handling

Configuring Access to RM/COBOL Indexed Data Files

File Limits

RM/COBOL File Status Codes

Debugging JVM COBOL Using RM/COBOL Indexed Files

Enabling CTF to Trace RM/COBOL Data Files

Data File Utilities

Indexed File Recovery (recover1) utility

Recovery command

Recovery command options

Recovery process description

The four phases of processing

Recovery support module version errors

Recovery example

Recovery program error messages

RM/Panels

Restrictions and Limitations

Converting RM/Panels Applications

Conversion Example: Using Eclipse

Creating an Eclipse Project for the RM/Panels Application

Set the Dialect RM Directive for the Project

Download the Tutorial Files

Import the RM/Panels Source Code

Configure Adis Support for RM/Panels

Configure the Supported Copybook Extensions

Configure the Library File for Run Time

Build and Run the Application

Writing Programs

Standard Run-Time Function Basics

Setting Run-Time Parameters

Executing Standard Run-Time Functions

Required Copy Files

Error Detection

Screen Handling

Individual Field Method

Entire Screen Method

Event Loop Method

Using Multiple Panels

Standard Run-Time Functions

DISABLE FIELD FOR INPUT

ENABLE FIELD FOR INPUT

ENABLE MENU OPTION

EXECUTE EVENT

INITIALIZE ALL FIELDS

Utility Functions

DELETE TEMPORARY FILE

END MODELESS OPERATION

START MODELESS OPERATION

START POLLING

Appendix A: Master Copy File RMPANELS.WS

Contents of RMPANELS WS

RMPANELS WS Field Definitions

Appendix B Standard Utility, and Extended Run-time Functions and Parameters

Compatibility with XML Extensions

Additional Parameter Required with XML Extensions Processing Statements

COBOL programs using BIS

Conflicts Between Model File-names and XML Data Files

Creating an XML Model File

Displaying the Status of XML Extensions Statements

Importing and Exporting Ambiguous Data-names

Invalid Characters in Condition Names

Restricted data items with XML Extensions

Unable to Use Data Items Declared in Nested Programs

User-names Longer than 127 Bytes are Truncated

Using the Correct Calling Convention

Native OO COBOL Class Library Reference

Data Access

Database Access

Accessing Databases from COBOL

Database Access Features

Database Access Preprocessors

Developing SQL Applications

Embedded SQL

Host Variables

Simple Host Variables

Host Arrays

Indicator Variables

Indicator Arrays

COBOL to SQL Data Type Mapping

SQL TYPEs

Cursors

Declaring a Cursor

Opening a Cursor

Using a Cursor to Retrieve Data

Closing a Cursor

Positioned UPDATE and DELETE Statements

Using Cursors

Data Structures

SQL Communications Area (SQLCA)

Using the SQLCA

The SQLCODE Variable

The SQLSTATE Variable

SQLWARN Flags

The WHENEVER Statement

SQLERRM

SQLERRD

COBSQL

DB2 LUW

The SQL Descriptor Area (SQLDA)

COBSQL

Using the SQLDA

The PREPARE and DESCRIBE Statements

The FETCH Statement

The OPEN or EXECUTE Statements

The DESCRIBE Statement

Dynamic SQL

Dynamic SQL Statement Types

Execute a Statement Once

Execute a Statement More Than Once

Select a Given List of Data

Select any Amount of Data

Preparing Dynamic SQL Statements

Place Holders

Physical Location of PREPARE Statement

Executing Dynamic SQL Statements

EXECUTE IMMEDIATE Statement

FREE Statement (COBSQL Informix)

Dynamic SQL Statements and Cursors

CALL Statements

Example

Compiling SQL Applications

Specifying an SQL Preprocessor and Compiler Directive Options

Compiling Multiple Program Modules

Creating Debug Files

OpenESQL

OpenESQL Preprocessor Options

Setting the OpenESQL Preprocessor and Compiler Directive Options

SQL Code Generation Options

Scope - OpenESQL SQL Compiler Directive Options

OpenESQL DBMAN Use Case Scenarios

OpenESQL Datetime Data Type Handling

OpenESQL Fixed-length Character Strings Handling

SQL Syntax Checking with OpenESQL

SQL(CHECK) and Schema Objects

SQL(CHECK) Command-line Options

SQL Statement Prefixes for SQL(CHECK)

OpenESQL Embedded SQL Cursor Behavior and Performance

Embedded SQL Cursors in Older Applications

Database Connections

Managing Transactions

Programming for OpenESQL

Working With OpenESQL Cursors and Result Sets

Working with Stored Procedures and Result Sets

Unicode Support in OpenESQL

OpenESQL Globalization Best Practices

Keywords

ODBC

ODBC Drivers and Data Source Names

Using OpenESQL with ODBC

Managing Transactions

JDBC

JNDI DataSource Objects

Database Connections

Connect Using a JNDI DataSource Object

Connect Using a JDBC Connection String

Sharing Database Connections Between Java and COBOL

Using OpenESQL with JDBC

Compiling JDBC Applications from the Command Line

Configuring the JDBC Run-time Environment

JVM Host Variables in Managed Code

COBSQL

Setting the COBSQL Preprocessor and Compiler Directive Options

Building COBSQL Applications with Eclipse

Using the CP Preprocessor to Expand Copybooks

Troubleshooting

Common Problem Areas

Oracle Considerations

Migration and Development

Oracle 8 and Micro Focus COBOL

Sybase Considerations

Informix Considerations

How to

OpenESQL Configuration Utility

To start the OpenESQL Configuration utility

To set a default for SQL(BEHAVIOR)

JDBC

To create a JVM COBOL project for JDBC

To install and configure Simple-JNDI

To create a JNDI DataSource object

To add JDBC resources to the JVM Build Path

To create a user library for JDBC resources

To import a user library

To export a user library

Reference

EXEC SQL Statement

OpenESQL

Embedded SQL Statements

ALLOCATE CURSOR

ASSOCIATE LOCATORS

BEGIN DECLARE SECTION

QUERY ODBC

QUERY ODBC - Column Query

QUERY ODBC - Data Type Query

QUERY ODBC - Table Query

RESET CONNECTION

ROLLBACK

SAVEPOINT, SAVE TRANSACTION, RELEASE [TO] SAVEPOINT

SELECT DISTINCT (using DECLARE CURSOR)

SET TRANSACTION ISOLATION

SQL Compiler Directive Options

BEHAVIOR

Primitive Directives

DBMAN Directive Settings

JDBC Driver Classes

JDBC URLs

Sample DataSource Object Files

SQL/COBOL Data Type Mappings

MF_ERRORMAP_PATH

OpenESQL Messages

SQLSTATE Values

SQLCODE Values

OpenESQL Preprocessor Error Messages

COBES0002 token is badly defined.

COBES0003 Program contains more than one definition of token

COBES0004 Nested or multi-source programs not allowed.

COBES0005 An error occurred when processing the internal dictionary.

COBES0006 No DB engine could be found.

COBES0007 Source file name is invalid.

COBES0010 OESQL rejected an unspecified option.

COBES0022 The directive SQL(DBMAN=ODBC) is not supported under Personal Edition.

COBES0023 The SQL(DBMAN) directive option is not supported with native applications.

COBES0024 The SQL(DBMAN) directive option is not supported with JDBC applications.

COBES0100 SQL incompatible with MAINFRAME

COBES0101 Statement is too long.

COBES0102 Statement contains too many host variables.

COBES0103 token does not have a suitable definition to be used as a host variable.

COBES0104 Bad SQL data declaration.

COBES0105 Syntax error.

COBES0106 Filename too long.

COBES0107 File token not found.

COBES0108 token is not unique and should be qualified.

COBES0109 token is not a data item.

COBES0110 Statement contains more than one SQLDA.

COBES0111 token is not a table of null indicator variables.

COBES0112 variable should not be defined with an OCCURS clause.

COBES0113 token should not be a subordinate to an item defined with an OCCURS clause.

COBES0114 Statement only allowed in the Procedure Division.

COBES0115 Statement not allowed in the Procedure Division.

COBES0116 An error occurred when processing the trace file.

COBES0118 Mismatched DECLARE.

COBES0119 Host variable name is too long.

COBES0120 Internal error - dictionary handle is too big.

COBES0121 Compiler directive SQL (token1=token2) is invalid or badly sequenced - all SQL statements ignored.

COBES0123 Invalid ILTARGET - cannot use ILTARGET(ANYCPU) - must specify ILTARGET(X86) or ILTARGET(X64).

COBES0124 Host or Indicator Variable varname should not be defined in EXEC SQL statement using a subscript.

COBES0125 variable should be defined with an OCCURS clause.

COBES0130 Host variable host-var.group-var is part of a group variable expansion that is not supported in this type of SQL statement.

COBES0201 BEHAVIOR directive not valid unless TARGETDB directive of DB2, ORACLE, or MSSQLSERVER set first.

COBES0202 BEHAVIOR directive not set.

COBES0203 PREFETCH and BEHAVIOR directives are mutually exclusive - cannot set both.

COBES0205 Cannot set directive PF_RO_CURSOR > 1 if RO_CURSOR directive is set to IC_FH.

COBES0206 Cannot set directive PF_RO_CURSOR > 1 if RO_CURSOR directive is set to FORWARD and TARGETDB is MSSQLSERVER.

COBES0207 Cannot set directive PF_UPD_CURSOR > 1 if UPD_CURSOR directive is set to FORWARD.

COBES0208 Cannot set UPD_CURSOR directive to DYNAMIC if TARGETDB directive is set to ORACLE.

COBES0209 Cannot set UPD_CURSOR directive to STATIC if TARGETDB directive is set to MSSQLSERVER.

COBES0211 DBRMLIB name is too long, max 44 characters.

COBES0212 Simple name in DBRMLIB name is too long, max 8 characters.

COBES0213 Simple name in DBRMLIB name starts with invalid character.

COBES0214 Invalid character in DBRMLIB name.

COBES0215 MEMBER name is too long, max 8 characters.

COBES0216 MEMBER name cannot begin with a numeric digit.

COBES0217 Invalid character in MEMBER name.

COBES0218 MEMBER directive not valid unless DBRMLIB directive set.

COBES0219 VERSION directive not valid unless DBRMLIB directive set.

COBES0220 VERSION is too long, max 64 characters.

COBES0221 Invalid character in VERSION.

COBES0222 Invalid Framework target - SQL applications must be built to target the 4.0 .NET Framework.

COBES0223 TARGETDB directive not set.

COBES0900 An internal error occurred.

COBES0901 This error prevents SQL processing from continuing - further EXEC SQL statements will be ignored.

COBES1000W Use of EXEC SQL INCLUDE SQLCA END-EXEC

COBES1002 Statement is not in area B.

COBES1004 token directive is not supported and has been ignored.

COBSQL

COBSQL Compiler Directive Options

END-COBSQL, END-C, END

COBSQL Messages

CSQL-I-001 to CSQL-E-023

CSQL-I-001: COBSQL has finished returning to the Checker

CSQL-I-003: COBSQLTYPE is incorrect defaulting to Oracle

CSQL-I-004: Accepted COBSQL-directive

CSQL-I-005: Passing precompiler-directive

CSQL-I-006: Rejected COBSQL-directive

CSQL-F-007: COBSQL/Checker incompatible -- Terminating

CSQL-I-008: Invoking integrated-preprocessor Preprocessor

CSQL-F-009: Irrecoverable error in integrated-preprocessor -- Terminating

CSQL-F-010: Irrecoverable error writing STK record

CSQL-F-011: Environment unsupported by COBSQL/Informix

CSQL-F-012: INFORMIXDIR must be set for Informix Support

CSQL-F-013: Unable to access: filename

CSQL-F-015: DOS Exec error Return Code is return-code

CSQL-F-016: UNIX Exec error Return Code is Return-Code

CSQL-I-017: Creating filename

CSQL-I-018: Invoking precompiler Precompiler/Translator

CSQL-F-019: Irrecoverable error Opening STK file

CSQL-I-020: Processing output of precompiler Precompiler

CSQL-F-021: Precompiler did not complete -- Terminating

CSQL-F-022: Irrecoverable error Reopening ORG file

CSQL-E-023: File Status file-status

CSQL-E-024 to CSQL-F-050

CSQL-E-024: Encountered an I/O on file filename

CSQL-F-025: Unable to Create virtual-heap

CSQL-F-026: Premature end of expanded source.

CSQL-I-027: Detected Working Section, now processing it

CSQL-I-028: Now processing through Procedure Division

CSQL-I-029: Found an EXEC SQL Statement, processing it

CSQL-E-036: Unable to open the precompiler file: filename

CSQL-F-037: Wrong Version of COBOL used, please upgrade

CSQL-I-038: The following directive is now Obsolete: COBSQL-directive

CSQL-I-039: The ORG & the CBL files were out of synch

CSQL-W-040: Pro*COBOL commented out the following line: source-line

CSQL-F-041: Cannot read the COBOL runtime switches

CSQL-F-042: Cannot set the COBOL runtime switches

CSQL-F-046: Command line is too large. Maximum length is 1140 characters

CSQL-F-047: Cobsql cannot be used with the SOURCEFORMAT directive.

CSQL-F-048: Cobsql is not supported for use with JVM COBOL code.

SQL Data Types

Integer Data Types

Character Data Types

Fixed-length Character Strings

Variable-length Character Strings

Large Character Strings (CLOB)

Unicode Character Strings

Unicode Variable-length Character Strings

Unicode Large Character Strings (DBCLOB)

DBCS Character Strings

DBCS Variable-length Character Strings

DBCS Large Character Strings

XML Data Type

Numeric Data Types

Approximate Numeric Data Types

Exact Numeric Data Types

Unicode Numeric Data Types

Binary Data Types

Fixed-length Binary Strings

Variable-length Binary Strings

Large Binary Strings (BLOB)

Date and Time Data Types

Locator Data Types

BLOB-LOCATOR Data Type

CLOB-LOCATOR Data Type

DBCLOB-LOCATOR Data Type

RESULT-SET-LOCATOR Data Type

File Data Types

BLOB-FILE Data Type

CLOB-FILE Data Type

DBCLOB-FILE Data Type

Miscellaneous Data Types

SQL TYPEs

TIMESTAMP-OFFSET-RECORD

VARBINARY

XML

Data Structures

The SQLCA Data Structure

The SQLDA Data Structure

Keywords

Data Files

Data File Tools

Data File Editor

Current Restrictions

Accessing Data File Editor

Launching Data File Editor from a Shell Prompt

Preferences

Set the Editor Preferences

Using the Data File Editor

Creating Data Files

Create a Non-indexed Data File

Create an Indexed Data File

Editing Data Files

Working with Data Sets in Enterprise Server

Open an Enterprise Server Data Set through ESMAC

Open an Enterprise Server Data Set through ESCWA

Error Messages When Using Data File Editor with Enterprise Server

Working with Data Files in a Database

Open a File Through MFDBFH

Insert a Record

Edit an Unformatted Record

Edit a Formatted Record

Duplicate a Record

Layout and Field Validation

Fix Validation Warnings

Edit a Record Using Hexadecimal Values

Delete a Record

Profile Files

Working with Different Character Sets

Viewing and Filtering Data Files

View File Information

Filtering a Data File

Filter the Data File

Filter the Data File (Deprecated)

Filter Data Types

Filter Operators

Load and Unload a Structure File

Navigate a Data File

Show the Contents of a Data File in Hexadecimal

Find and Replace Information in a Data File

Select the Encoding for a Data File

Order a Data File using Indexed Keys

Comparing Data Files

Compare Two Data Files

Viewing Merged Spool Files

Open a Merged Spool File

Backing Up Data Files

Back up a data file

Using the Structure File Editor

Creating Structure Files and Layouts

Create a Structure File

Editing Structure Files and Layouts

Edit a Structure File

Data File Structure Command Line Utility

DFSTRCL Prerequisites and Restrictions

DFSTRCL Inputs

DFSTRCL Command Line Syntax

DFSTRCL Examples

Rebuild

Command Line

Redirection of Information

Rebuild Options

Reorganizing Indexed Files

Rebuilding a Corrupt Indexed File

Converting a File

Validating an Indexed File

Rebuild through Fileshare

Callable Rebuild

Rebuild Examples

Data Modernization

Database Connectors for Enterprise Developer

Database Connectors User's Guide

Database Connectors Overview

Relational Database Management Systems Support

Accessing Data

Database Concepts

How Database Connectors Works

What Is a Transparent Interface?

XFDs and Mapping

Summary

Getting Started

Licensing

The Demonstration Program

XFDs

XFD Files

How XFDs are Formed

Defaults Used in XFD Files

KEY IS Phrase

REDEFINES Clause

Summary of XFD Fields

Identical Field Names

Long Field Names

Naming the XFD File

Forming the Final XFD Name

Mapping Other Files to an XFD

Using XFD Directives

Introduction

XFD Directive Syntax

Line Continuation for Complex XFDs

Supported XFD Directives

Invalid Data

Illegal COBOL Data

Invalid Key Data

Invalid Data Other Than Keys

Invalid Database Data

Working with COBOL

Examples of Preparing and Compiling a Program

Example 1 - Compiling with just the CREATEXFD directive

Example 2 - Compiling with the WHEN XFD Directive

Example 3 - Using Additional XFD Directives

New and Existing Databases

Default Behavior

Accessing Existing Database Files

How Do I Match Existing Text Fields?

How Do I Match Existing Numeric Fields?

Field Names

Resolving Name Conflicts

File Handling Configuration

Configuring the File Handler

Run Time System Configuration

ACUFH Configuration Variables

Database Connectors for DB2

DB2 Concepts Overview

Transactions

Record-locking Issues in Transactions

Database Connectors and Record Locking

Client Configuration

Designating the Host Data Source

Configuring the File Handler

ACUFH Configuration File Variables for DB2

Decimal Points

Record and Table Locking

Data Type Mapping

Run-Time System Errors

Microsoft SQL Server Concepts Overview

Database Connectors for Microsoft SQL Server

Client Configuration

Installing the Server and Client Machine

Setting Up a User Login

Configuring the File Handler for

ACUFH Configuration File Variables for MSSQL

Using the Database Table

Table Locking

Supported Data Types for SQL Server

Run-Time System Errors

Database Connectors for ODBC

ODBC Concepts

Client Configuration

ODBC Installation

Supported Drivers

Setting Up Data Sources

Designating the Host File System

Designating the Host Data Source

Configuring the File Handler for ODBC

ACUFH Configuration File Variables for ODBC

Decimal Points

Mixed-case SQL Identifiers

Record and Table Locking

Driver Requirements

Data Type Mapping

Run-time System Errors

Record Locking Issues in Transactions

Database Connectors for Oracle

Oracle Concepts Overview

Transactions

Database Connectors and Record Locking

The open_cursors Parameter

Table Ownership

Security

Client Configuration

Oracle's Instant Client

Checking System Parameters

Setting Up a User Account

Configuring the File Handler

Setting Up the Search Path

Handling Transactions

ACUFH Configuration File Variables for Oracle

Using the Database Table

Unsupported Features

Data Type Mapping

Run-Time System Errors

Guideline 1 - Database Administrator

Performance and Troubleshooting

Performance Issues

Guidelines

Guideline 2 - Understand COBOL Operations and Database Operations

Guideline 3 - Program and Database Interaction

Guideline 4 - Plan for Growth

The WHERE Constraint

Troubleshooting

Setting External Variables

Compiler Errors

Run-Time System Errors

Using the FILE_TRACE ACUFH Configuration Variable

Questions and Answers

Database Connectors Tasks

To Configure a Login

To create an error map

To enable tracing for Database Connectors connections

To install Database Connectors for Microsoft SQL Server

To prepare your program for execution using Database Connectors

To set the system parameters

To Set Up a Service Name for an Oracle Database

To Set Up The DB2 User Environment

To compile and run the demo program

To Test the Installation of Oracle's Instant Client

To use the WHERE constraint from COBOL

Database Connectors Reference

Configuration Variables

4GL_CONVERT_DATE_ZERO

4GL_DB_MAP

4GL_FULL_DATA_TEST

4GL_IGNORED_SUFFIX_LIST

4GL_ILLEGAL_DATA

4GL_JULIAN_BASE_DATE

4GL_WHERE_CONSTRAINT

A_DB2_ALTERNATE_COMMIT_LOGIC

A_DB2_CATALOG

A_DB2_COMMIT_ON_BEGIN

A_DB2_DATASOURCE

A_DB2_ERROR_MAP_FILE

A_DB2_ISOLATION_LEVEL

A_DB2_USE_CHAR_FOR_BINARY

A_MSSQL_ADD_IDENTITY

A_MSSQL_ADD_TIMESTAMP

A_MSSQL_APPROLE_NAME

A_MSSQL_APPROLE_PASSWD

A_MSSQL_CREATE_UNICODE_COLUMNS

A_MSSQL_CURSOR_OPTION_1,2,3

A_MSSQL_DATABASE

A_MSSQL_DEADLOCK_LOOPS

A_MSSQL_DEFAULT_CONNECTION

A_MSSQL_DEFAULT_OWNER

A_MSSQL_DO_NOT_TRANSLATE_CHAR

A_MSSQL_FAILOVER_PARTNER

A_MSSQL_FAILOVER_PARTNER_SPN

A_MSSQL_FAST_ACCESS

A_MSSQL_IGNORE_GUID_COLUMNS

A_MSSQL_LIMIT_DROPDOWN

A_MSSQL_LOCK_DB

A_MSSQL_LOGIN

A_MSSQL_MAX_BINARY_LENGTH

A_MSSQL_MAX_CHAR_LENGTH

A_MSSQL_MAX_CHARACTERS

A_MSSQL_MAX_COLUMNS

A_MSSQL_MULTI_SUBNET_FAILOVER

A_MSSQL_NATIVE_LOCK_TIMEOUT

A_MSSQL_NO_23_ON_START

A_MSSQL_NO_CACHED_READ

A_MSSQL_NO_COUNT_CHECK

A_MSSQL_NO_DBID

A_MSSQL_NO_RECORD_LOCKS

A_MSSQL_NO_TABLE_LOCKS

A_MSSQL_ODBC_DRIVER_NAME

A_MSSQL_PACKETSIZE

A_MSSQL_PASSWD

A_MSSQL_ROWCOUNT

A_MSSQL_SELECT_KEY_ONLY

A_MSSQL_SEPARATE_LOCK_CONN

A_MSSQL_SERVER_SPN

A_MSSQL_SKIP_ALTERNATE_KEYS

A_MSSQL_STRIP_PATH_INFO

A_MSSQL_TRANSACTION_LEVEL

A_MSSQL_TRANSLATE_TO_ANSI

A_MSSQL_UNLOCK_ON_EXECUTE

A_MSSQL_UPDATE_PRIMARY_COLS

A_MSSQL_USE_DROPDOWN_QUERIES

A_ODBC_ALTERNATE_COMMIT_LOGIC

A_ODBC_CATALOG

A_ODBC_COMMIT_ON_BEGIN

A_ODBC_DATASOURCE

A_ODBC_ERROR_MAP_FILE

A_ODBC_ISOLATION_LEVEL

A_ODBC_LOCK_METHOD

A_ODBC_LOGIN

A_ODBC_NO_NULL_COLUMNS

A_ODBC_PASSWD

A_ODBC_PRINT_LOG

A_ODBC_QUOTE_IDENTIFIERS

A_ODBC_STRICT_EQUAL

A_ODBC_TABLE_TYPES

A_ODBC_UNSIGNED_TINYINT

A_ODBC_USE_CATALOG

A_ODBC_USE_CHAR_FOR_BINARY

A_ODBC_USE_SPACE_IN_DATES

A_ODBC_USE_SQLCOLUMNS

A_ODBC_USE_SQLTABLES

A_ORA_DATABASE

A_ORA_HINTS

A_ORA_KEEP_START_CURSOR

A_ORA_LIMIT_DROPDOWN

A_ORA_MAX_FILE_CURSORS

USER_PATH (for Oracle)

Database Connectors Error Messages

Run Time - File Status Errors

01 Read error on dictionary file

02 Corrupt dictionary file

04 Open error

04 Too many fields in the key

05 Too many fields in the key (more than 16 for Oracle)

12 DB2 library function returned an unexpected error

13 Illegal size or type of data for variable xxx

14 More than one table with the same name

1001 Invalid Cursor

22007 Invalid Character value for Cast Specification

Compiler Errors

Bad picture for DATE: keyname

Data missing from key segment keyname

Directive word too long: keyname

Field xxx causes duplicate database data

GROUP expected after USE

Missing '=' in XFD directive

Missing field name after WHEN

Value should be a literal: xxx

Value should be a name: xxx

Value should be numeric: xxx

Variable file name requires FILE directive

WHEN variable xxx not found in record

xxx not unique in first 30 characters

xxx: unknown XFD directive

XFD Directives

ALPHA XFD directive

BINARY XFD directive

COBOL-TRIGGER XFD directive

IDENTITY-COLUMN XFD directive

COMMENT XFD directive

NUMERIC XFD directive

SECONDARY_TABLE XFD directive

USE GROUP XFD directive

VAR_LENGTH XFD directive

WHEN XFD directive

WHEN Complex Expressions

XSL XFD directive

Compiler Directives Affecting XFD Creation

CREATEXFD XFD directive

File Handling

File Handling Examples

Data and Key Compression Example

External Files Example

File Handler Examples

Example Configuration File

Example of Creating a New Index File

Example of Accessing the FCD

Example of Setting Up the Record Area

Example of Setting up the Filename Area

File Names Examples

Examples of static filename assignment

Example of dynamic filename assignment

Example of external filename assignment

Examples of device name assignment

Example of Forced Filename Mapping

Example of Connecting a File to Standard Output

Example of Connecting a File to Standard Input

Example of Setting up a Two-way Pipe

Example of using the External File Mapper

Example of Specifying a Fileshare Client User ID and Password

Example Fileshare Client Configuration File

File Status Examples

Example of Displaying File Status Codes

Example of Checking File Status Codes

Example of Extended File Status Codes

Indexed File Examples

Example of Indexed File Definition

Example of Primary Key Definition

Example of Alternate Key Definition

Example of Duplicate Key Definition

Example of Sparse Key Definition

Example of Indexed File Access Definition

Example of Creating Fixed-length Records

Example of Creating Variable Length Records

MFSORT Examples

Example Mfsort Command Line

Example Mfsort Fields Instruction

Example Mfsort Key Instruction

Example Mfsort Instruction File

Rebuild Examples

Example of Reorganizing an Indexed File

Example of recovering a corrupt indexed file

Example of using Rebuild to convert a file

Example of validating the structure of an indexed file

Example of a Rebuild options file

Example of calling Rebuild from a COBOL program

Relative File Definition Example

Sequential File Examples

Example Record Sequential File Definition - Fixed-length Records

Example Record Sequential File Definition - Variable Length Records

Example Line Sequential File Definition

Example Printer Sequential File Definition

File Handling Guide

Introduction

Micro Focus File Handler

File Organizations

Fixed-length and Variable-length Records

Sequential Files

Record Sequential Files

Line Sequential Files

Printer Sequential Files

Indexed Files

File Headers

File names

Filename Conventions

Assigning Filenames

Static Filename Assignment

Dynamic Filename Assignment

External Filename Assignment

Library Names in Paths

Filename Mapping

Multiple Paths

Library Names

Assigning Device Names

Setting Up Pipes

Output Pipes

Input Pipes

Two-way Pipes

External File Mapper (Mfextmap)

Mapper File Structure

Mapper File Location

Activating the External File Mapper

Disabling The External File Mapper

File Status

What is File Status?

Defining a File Status Data Item

File Status Conventions

ANSI'85 File Status

ANSI'74 File Status

File Status Conversions

Extended File Status Codes

Sharing Files

Sharing mode

Record Locking

Manual and Automatic Record Locking

Manual Record Locking

Automatic Record Locking

Single and Multiple Record Locking

Single Record Locking

Multiple Record Locking

Handling Record Locks

Releasing Record Locks

File Status Codes

File Handler Configuration

Configuration File

Configurable Behavior

Large Indexed Files

File Striping (deprecated)

Headers in Striped Files (deprecated)

Options (deprecated)

MAXSTRIPEDIGITS (deprecated)

MAXSTRIPEFILES (deprecated)

MAXSTRIPESIZE (deprecated)

STRIPE-X (deprecated)

STRIPENAMETYPE (deprecated)

STRIPING (deprecated)

Examples (deprecated)

Performance

File Handler and Sort APIs

Calling the File Handler

File Control Description (FCD)

Data Structures

Record Area

Filename Area

Key Definition Block

Global Information Area

Key Definition Area

Component Definition Area

Accessing the FCD

Operation Codes

Relative Byte Addressing

Read a Record

Rewrite a Record

Delete a Record

Creating Your Own File Handler

Dynamic Redirection to a Custom File Handler

Redirection Using Configurable DYNREDIR

Specifying a List of Custom File Handlers

Specifying Configurable Custom File Handlers

Writing a Custom File Handler

Restrictions

Creating a New Index File

Sort Utilities

DFSORT and ICETOOL Emulation

DFSORT EXEC PARM Options Emulation

PARM

DFSORT Program Control Emulation

ICETOOL Emulation

SYNCSORT Emulation

SYNCSORT EXEC PARM Options Emulation

PARM

SYNCSORT Program Control Emulation

Invoking Mfsort

Instructions

FIELDS Instruction

Field Types

Defining Input and Output Files

RECORD Instruction

ORG Instruction

KEY Instruction

Creating a Statistics Report

Example Commands

Sorting Using More Than One File

Character Sort in Ascending Order

Numeric Sort in Descending Order

Omitting Records

Single File Sort Using INCLUDE and a Sub-string Comparison

Single File Sort Using Environment Variables

Transforming Records Using OUTREC

Sort Using OUTFIL for Complex Reporting

Data and Key Compression

Data Compression

Key Compression

Compression of Trailing Nulls

Compression of Trailing Spaces

Compression of Leading Characters

Compression of Duplicate Keys

Example of Using Data and Key Compression

Compression Routines

Micro Focus Compression Routines

Calling a Micro Focus Compression Routine

User-supplied Compression Routines

Tracing File Operations

Introduction

Configuring Tracing and Logging

Dynamic Tracing

Using the FCD to Control Tracing

Using Library Routines to Control Tracing

Trace Player

Run the Trace Player from the Command Line

Examples

File Systems

32-bit file systems

64-bit file systems

File systems and FILEMAXSIZE

Fileshare Guide

Introduction

Specifying the Communications Protocol

How Fileshare Works

Standard Operation

Fileshare Client

Specifying the Fileshare Server

As a Filename

In a Configuration File

Configuring Your Fileshare Client

Fileshare Client Configuration Options

Example Client Configuration File

Using the File Handling Redirector Module

FHREDIR Return Codes

Fileshare Server

Configuring the Fileshare Server

Specifying a Fileshare Server Name

Specifying the Communications Protocol

Fileshare Server Configuration Options

Example Server Configuration File

Starting the Fileshare Server

Stopping the Fileshare Server

Configuring CCI Communications for Fileshare

About Fileshare Communications

Specifying the Communications Protocol

Using CCITCP

Logging Fileshare Messages: CCI Trace

Using Multiple Protocols with Test Programs

Configuring the CCI Timeout

Database Integrity

Transaction Processing

Automatic Record Lock Timeout

Transaction Processing - Fileshare Client

Transaction Processing - Fileshare Server

Recovery Logging

Basic Recovery Logging

Advanced Recovery Logging

Enabling Advanced Recovery Logging

Fileshare Exit Procedure - fsexitproc.cbl

Viewing the Log Files

Fileshare Recovery

Basic Rollforward Recovery

Advanced Rollforward Recovery

Advanced Rollback Recovery

Database Sequence Numbering

Database Sequence Numbers - Fileshare Server

Database Backup and Recovery

Automatic Database Backup and Rollforward Recovery

Hot Backups

Running a Hot Backup

Database Reference File Maintenance

Recovery Log File Records

Disk Space Warning (/p)

Flushing the Log File (/lc)

Erasing a Log File Record (/e)

Example

Filename Record

Alternative Filename (/af)

Virtual File Handler (/ap)

Data and Key Compression (/k)

Disable Logging (/o l)

Disable Database Sequence Numbering (/o s)

Disable Transaction Processing (/o t)

Erasing a Filename Record

Examples

File String Record

Erasing a File String Record

Example

Backup Folder Record

Best Practices for Backup and Recovery

Best Practices Basic Logging

Best Practices Advanced Logging

Security

Password System

Fileshare Client

Fileshare Server

Writing Your Own FHRdrLngPwd Module

Logon Validation Module

File Access Validation Module

Password File Maintenance

User-ID Groups

Supervisor Mode

Advanced Operation

Running Fileshare as a Background Process

The NFILES Setting

Single User Mode

Filename Mapping

Fileshare Server

Data and Key Compression

Data and Key Compression - Fileshare Server

Virtual File Handler Interface

Fileshare Server

Monitoring Fileshare

Fileshare Manager

Fileshare Manager Configuration

Byte-stream I/O Calls

FS_LOCATE_FILE

FS_SPLIT_FILENAME and FS_JOIN_FILENAME

Performance Considerations

Fileshare Performance on UNIX

Large File Support with Fileshare

Error Handling

Fileshare Extended Status Codes

Communications Errors

Transaction Processing Errors

Fileshare Server Messages

Messages from FS001-S to FS050-W

FS001-S The parameter "text " is not recognized as a valid parameter.

FS004-S The parameter "text " specifies a time-out value that is invalid.

FS005-S The parameter "text " is too long or invalid.

FS006-S The parameter "text " has already been specified.

FS007-S Invalid parameter combination.

FS008-S Communications Initialization Failure.

FS009-S The required communications module cannot be found.

FS011-W Communications send failure.

FS012-W Communications disconnect failure.

FS013-W Communications receive error.

FS014-W Communications data length not as expected.

FS015-W Request from unknown user - request rejected.

FS016-S The parameter "text " is invalid.

FS017-S Unable to open the file : filename.

FS018-S Log file corrupt - unrecognizable record in file.

FS019-S Log file corrupt - can't read header.

FS020-S The log file does not match the database sequence numbers - recovery aborted.

FS021-S There is no log filename specified in the database reference file.

FS022-S The log filename given cannot be found in the database reference file.

FS024-S Failed to open log file : filename.

FS025-S Write failure to the log file, Fileshare Server is closing down.

FS026-W Failed to close the log file.

FS027-S A second log file parameter has been found.

FS028-W The log file shows the last session was not shut down successfully.

FS029-S The log filename is already specified in the database reference file.

FS030-S Insufficient disk space to continue logging to log file.

FS031-I Record lock time-out failure on user : user.

FS034-S A filename or log file parameter must be specified.

FS035-S A database reference file must be specified.

FS037-I The file filename does not have a file header record. Sequence checking is switched off for this file.

FS038-S A matching sequence number not found in filename.

FS039-S Improperly closed file - filename.

FS040-S Unable to read the file header record in the file filename.

FS041-S Unable to update the sequence number in the file filename.

FS042-S Unable to open the database reference file: filename.

FS043-S The database reference file contains an invalid entry.

FS044-S Error reading the database reference file.

FS045-W Duplicate filename specified in the database reference file.

FS050-W A log file is not specified in the database reference file.

Messages from FS051-W to FS099-W

FS051-W Failure to allocate a larger buffer, the I-O request failed.

FS052-S Failure to allocate required memory. The Fileshare Server is closing down.

FS055-S The parameter "text " specifies a configuration file that does not exist.

FS056-S The parameter "text " specifies a data compression value that is not within the range 0-255.

FS057-S The parameter "text " specifies a key compression value that is not within the range 0-7.

FS058-S Failure to allocate memory for the decompression of the log file.

FS059-S Failure to allocate the memory required for processing the database reference file.

FS062-S Failure creating the password file filename.

FS063-S Failure opening the password file filename.

FS064-S Failure reading the password file filename.

FS065-S The password file is not of a recognized format.

FS066-S The specified user name already exists in the password file.

FS068-I The password file is now empty and has been deleted.

FS069-S The specified entry could not be found in the password file.

FS070-S Failure writing to the password file.

FS071-W Unable to load the module FHXSCOMP to decompress the data area.

FS072-S The parameter "text " contains a wild card which is not allowed with this parameter.

FS073-S Failure to allocate memory to process the password file.

FS074-S The Fileshare Server (NLM) failed to log on to NetWare with the login id specified.

FS075-W Unable to load the module FSSECLOG - LOGON has been denied.

FS076-W Unable to load the module FSSECOPN - OPEN has been denied.

FS077-S A Fileshare Server of the same name has already been defined - the Fileshare Server is closing down.

FS078-S No password file has been specified for the use of background mode.

FS079-S A supervisor password entry must exist for the use of background mode.

FS080-S No password file has been specified for the use of the synchronous communications mode.

FS081-S A supervisor password must be specified in the password file for the synchronous communications mode.

FS082-S The Netbios communications protocol is not responding. Ensure the requester software is loaded and functional.

FS083-S Incompatible CCIIPX.NLM version.

FS084-I Fileshare Server is starting.

FS085-I Fileshare Server is active.

FS086-I Fileshare Server is closing down.

FS087-I Fileshare Server has closed down.

FS089-I Database Reference File Maintenance Utility.

FS090-I Database Reference File installation completed successfully.

FS091-I Rollforward Recovery Utility

FS092-I Rollforward Recovery has completed.

FS094-I Password File Maintenance Utility.

FS096-I Password File installation has completed.

FS097-I Are you sure that you wish to close down the Fileshare Server ? (Y/N)

FS099-W File I/O status was not as expected. Returned status: status Expected status: status Action code: text File: filename.

Messages from FS101-I to FS149-I

FS101-I text -- parameter has been accepted.

FS103-I The log filename has been added to the database reference file.

FS104-I The log file cannot be found, creating a new recovery log file.

FS105-W The disk free space for the log file is below acceptable limits.

FS106-I filename - added to database reference file.

FS107-I filename - removed from the database reference file.

FS108-I Processing the files specified in the database reference file.

FS109-W The file filename does not exist.

FS110-I filename - OK.

FS111-W Files are still open. Continue to close down the Fileshare Server (Y/N) ?

FS114-W Waiting for the old log file to be removed.

FS118-I The database sequence number matches the sequence number in the log file, no recovery is needed.

FS122-I Communications too busy on CCI SEND - retrying.

FS123-I Communications too busy on CCI RECEIVE - retrying.

FS124-I Checking the validity of the log file, please wait.

FS125-I Recovery possible to last valid recovery log file record.

FS126-I Performing recovery, please wait.

FS127-S Invalid name mapping command.

FS128-W Fileshare Server closedown invoked by Stop Run processing.

FS129-I The Fileshare Server is still active.

FS130-I Reading database reference file, please wait.

FS131-W Invalid communications mode - parameter ignored.

FS132-I The Fileshare Server is running with the following communication protocol(s):

FS133-I Processing the password file, please wait.

FS134-I The password file cannot be found - creating a new password file.

FS135-I Fileshare Server security is active.

FS136-I Fileshare Server security is not active.

FS138-W The log file has been backed up and a new one has been created.

FS139-I A matching date and time entry has been found in the log file.

FS140-I No matching date and time entry has been found in the log file.

FS142-W The Operating System does not permit the log file to be flushed to disk.

FS143-W The Operating System does not allow free disk space information to be obtained.

FS144-W More than one communications protocol has been specified - synchronous communications mode not active.

FS145-W Fileshare Client disconnected, cannot contact user: text.

FS146-W Unexpected action code, action-code - discarded.

FS147-I A duplicate network message was received and discarded.

FS148-I CCI return-code (function func) = code.

FS149-I CCI SEND not complete, status will be checked later.

Messages from FS151-I to FS200-W

FS151-I CCI message size received = text. Indicated send message size = text

FS153-I The Fileshare Server name has been reregistered on the network.

FS154-I Please enter the FSVIEW supervisor password to enable the use of CCI Trace.

FS155-I Password accepted - CCI Trace is enabled. Do you want CCI Trace active immediately? (Y/N)

FS156-W Incorrect password - CCI Trace is disabled.

FS158-I CCI Trace activated.

FS159-I CCI Trace switched off.

FS160-I Fileshare trace activated.

FS161-I Fileshare trace switched off.

FS163-I Input useropcode [filename-1] [ filename-2].

FS170-I Input- Logon.

FS171-I Input- Logoff user.

FS172-I Input- Find File userfilename.

FS173-I Output- userstatus.

FS176-W There is no backup directory specified in the database reference file.

FS177-S The backup directory specified cannot be found in the database reference file.

FS178-I The backup directory has been added to the database reference file.

FS179-S A backup directory is already specified in the database reference file.

FS180-W The log filename specified has an extension. The name of the log file has been changed to "filename".

FS182-W Output- Access Denied

FS188-W Fileshare Server database reference file installation completed with errors.

FS189-W The backup directory does not exist.

FS190-W The backup directory specifies the name of an existing file.

FS191-W An error occurred accessing the backup directory.

FS192-S More than one log file exists in the log file directory.

FS193-S Unable to open the log file.

FS194-I The log file "filename-1" has been backed up successfully to "filename-2".

FS195-I The Fileshare Server is using the log file "filename".

FS196-W Unable to create the log file "filename".

FS197-S Unable to create the log file "filename".

FS198-W The attempt to backup the log file failed because the backup file "filename" already exists.

FS199-S The attempt to backup the log file failed because the backup file "filename" already exists.

FS200-W The attempt to backup the log file to "filename" failed.

Messages from FS201 to FS300

FS201-S The attempt to backup the log file to "filename" failed.

FS202-I The Fileshare Server will continue logging to the log file "filename".

FS203-I The Fileshare Server is appending to the log file "filename".

FS204-W The Fileshare Server is unable to log to the log file "filename". Rollforward recovery logging is disabled.

FS205-W Unable to remove the old recovery log file "filename".

FS206-S There is more than one starter log file. The Recovery Utility is unable to determine which one to use.

FS207-I There is no starter log file in the log file directory.

FS208-S There is no starter log file in the backup directory.

FS209-I A starter log file has been located in the backup directory.

FS210-S There is more than one starter log file in the backup directory.

FS211-S An error occurred checking the header on the log file "filename".

FS212-I The Rollforward Recovery Utility is processing the log file "filename".

FS213-W Unable to locate the continuation log file "filename" in the log file directory.

FS214-I Searching for a backed up log file in the log file directory.

FS215-I Searching for a backed up log file in the backup directory.

FS216-I No backed up starter log file can be found in the log file directory.

FS217-I No backed up starter log file can be found in the backup directory.

FS218-I No backed up continuation log file can be found in the log file directory.

FS219-I No backed up continuation log file can be found in the backup directory.

FS220-I A backed up starter log file has been found in the log file directory.

FS221-I A backed up starter log file has been found in the backup directory.

FS222-I A backed up continuation log file has been found in the log file directory.

FS223-I A backed up continuation log file has been found in the backup directory.

FS224-S The log file directory contains more than one backed up starter log file.

FS225-S The backup directory contains more than one backed up starter log file.

FS227-W Failure to set Fileshare Server's access rights.

FS228-I CCI SEND status checked.

FS229-I Unrecognized CCI session ID - could not disconnect user.

FS230-I User : user-IDuser-name

FS231-S The parameter "nnn" is not numeric.

FS232-I Date : date.

FS233-W Unable to set the maximum amount of dynamic memory to the limit specified

FS234-W The parameter "text " specifies a memory limit below the minimum of 6 Mbytes allowed.

FS235-W Failure to allocate memory for incomplete CCI SEND processing.

FS236-I The log file name has been removed from the database reference file.

FS237-S The next log file to use filename already exists, unable to back up current log file.

FS237-W The next log file to use filename already exists, unable to back up current log file.

FS238-I Terminating communications with this user.

FS239-I Output - user Record locked. Retry operation.

FS240-I Output - user File locked. Retry operation.

FS241-I Output - user Insufficient log file disk space. Retry operation.

FS243-S Failure backing up the file filename1 to filename2.

FS244-S Failure restoring the backed up file filename1 to filename2.

FS245-S Failure deleting the log file filename.

FS246-I Backing up database files to directory backup directory. Please wait.

FS247-I Restoring database files from directory backup directory. Please wait.

FS248-I Commencing automatic Fileshare Recovery.

FS249-I Restarting Fileshare Server.

FS250-I Deleting all unwanted log files.

FS251-S Logging must be activated for all files when specifying a backup directory.

FS252-S Failure deleting the file filename.

Messages from FS301 - FS400

FS302-S Unable to continue - A log file already exists

Micro Focus Native Database File Handling and Enterprise Server Region Database Management

System Requirements

Types of Database

Database Permissions

Configuration Requirements

Using Microsoft SQL Server

Configure Datastores for Microsoft SQL Server

Create Microsoft SQL Server Datastores Using Script Files

Update the Configuration File for Microsoft SQL Server Datastores

Windows: Create Datastore Data Sources for Microsoft SQL Server

UNIX: Create Datastore Data Sources for Microsoft SQL Server

Upload Files to a Microsoft SQL Server Datastore

Create Microsoft SQL Server Region and a Cross-Region Database Using Script Files

Configure Region and Cross-Region Databases in Microsoft SQL Server

Update the Configuration File for Microsoft SQL Server Region and Cross-Region Databases

Windows: Create Region and Cross-Region Data Sources for Microsoft SQL

UNIX: Create Region and Cross-Region Data Sources for Microsoft SQL

Configure a Region or Cross-Region Database in Enterprise Server

Using Microsoft Azure

Configure Datastores for Microsoft Azure

Create Azure Datastores Using Script Files

Update the Configuration File for Azure Datastores

Windows: Create Datastore Data Sources for Azure

UNIX: Create Datastore Data Sources for Azure

Upload Files to an Azure Datastore

Create Azure Region and Cross-Region Databases Using Script Files

Configure Region and Cross-Region Databases in Microsoft Azure

Update the Configuration File for Azure Region and Cross-Region Databases

Windows: Create Region and Cross-Region Data Sources for Azure

UNIX: Create Region and Cross-Region Data Sources for Azure

Configure a Region or Cross-Region Database in Enterprise Server

Using PostgreSQL

Configure Datastores for PostgreSQL

Create PostgreSQL Datastores Using Script Files

Update the Configuration File for PostgreSQL Datastores

Windows: Create Datastore Data Sources for PostgreSQL

UNIX: Create Datastore Data Sources for PostgreSQL

Upload Files to a PostgreSQL Datastore

Create PostgreSQL Region and a Cross-Region Database Using Script Files

Configure Region and Cross-Region Databases in PostgreSQL

Update the Configuration File for PostgreSQL Region and Cross-Region Databases

Windows: Create Region and Cross-Region Data Sources for PostgreSQL

UNIX: Create Region and Cross-Region Data Sources for PostgreSQL

Configure PostgreSQL Region or Cross-Region Database in Enterprise Server

Using Db2

Configure Datastores for Db2

Create Db2 Datastores Using Script Files

Update the Configuration File for Db2 Datastores

Windows: Create Datastore Data Sources for Db2

UNIX: Create Datastore Data Sources for Db2

Upload Files to a Db2 Datastore

Create Db2 Region and Cross-Region Databases Using Script Files

Configure Region and Cross-Region Databases in Db2

Update the Configuration File for Db2 Region and Cross-Region Databases

Windows: Create Region and Cross-Region Data Sources for Db2

UNIX: Create Region and Cross-Region Data Sources for Db2

Configure a Region or Cross-Region Database in Enterprise Server

Using Oracle

Configuring Datastores for Oracle

Create Oracle Datastores Using Script Files

Update the Configuration File for Oracle Datastores

Upload Files to an Oracle Datastore

Create Oracle Region and Cross-Region Databases Using Script Files

Configuring Region and Cross-Region Databases Oracle

Update the Configuration File for Oracle Region and Cross-Region Databases

Configure a Region or Cross-Region Database in Enterprise Server

Configuring CICS Applications for Native Database File Handling

Configuring the JCL Environment for Native Database File Handling

Moving a Catalog to a Database

Scanning an Existing Catalog

Deploying a Catalog to a Database

The mfdbcatc Utility

The Database Configuration File

The dbfhconfig Command Line Utility

Examples of the dbfhconfig Command Line Utility

Database Provider-specific Options

Configure a Secrets Vault for the Micro Focus Database File Handler

Database Connections

Database Connection Strings

Using a Single Database

Sharing Database Connections

Database Connection Lifetime

Specifying the Cross-region Heartbeat Interval

Datastore Management

The dbfhdeploy Command Line Utility

The Datastore URL

Database Management and Recovery

The dbfhadmin Command Line Utility

Examples of the dbfhadmin Command Line Utility

dbfhadmin Return Codes

File View Generation

The dbfhview Command Line Utility

Examples of the dbfhview Command Line Utility

Installing Database Server Functions

Installing Functions for Db2

Installing Functions for Microsoft SQL Server and Microsoft Azure

Installing Functions for PostgreSQL

Resource Locking

Record Locking Strategies

Summary of Differences Between Locking Strategies

Record Locking Scenarios

MFDBFH Error Messages

ADM - DBFHADMIN Messages

ADM0000 - ADM0019

ADM0001E Cannot specify both -list and -recover with -casprocess

ADM0002E Must specify either -list or -recover with -casprocess

ADM0003E Must specify -usedb:<instance> with -casprocess -recover/-list

ADM0004E Must specify -host:<name> with -casprocess -recover

ADM0005E Database server instance 'server-name' is not configured

ADM0006E Cross-region database for database server instance 'server-name' is not configured

ADM0007S An error occurred while reading process records from the cross-region database: exception-message

ADM0008I There are no registered process records for host 'host-name'

ADM0009I There are no registered process records

ADM0010E Cannot specify -pid:<process-id> with -casprocess -list

ADM0011I There are no processes to recover

ADM0012I Recovered process: host='host-name', region = 'region-name', PID=process-id, TID=thread-id

ADM0013S An error occurred while attempting to recover processes: exception-message

ADM0014E Cannot specify both -list and -recover with -openfiles

ADM0015E Must specify either -list or -recover with -openfiles

ADM0016E Must specify -datastore:<url> with -openfiles -recover/-list

ADM0017E Must specify -host:<name> with -openfiles -recover

ADM0018E Cannot specify -pid:<process-id> with -openfiles -list

ADM0019E Invalid datastore URL specified

ADM0020 - ADM0039

ADM0020E Datastore 'datastore-url' is not configured

ADM0021S An error occurred while reading open file handle records: exception-message

ADM0022I There are no open files

ADM0023I There are no files to close

ADM0024I Closed file: host='host-name', file name='file-name', folder='folder-name'

ADM0025E Can only specify one of -casprocess, -createdb, -diags, -keytypes, -openfiles, region, -script, upgrade, or -verify

ADM0026E Can only specify one of -add, -delete, -export, -import or -list with -keytypes

ADM0027E Must specify one of -add, -delete, -export, -import or -list with -keytypes

ADM0028E Must specify -file:<URL> with -add or -delete

ADM0029E Must specify -datastore:<url> with -keytypes -export/-import/-list/-upgrade

ADM0030E Invalid file URL specified

ADM0031S An error occurred while adding/updating a key type definition record: exception-message

ADM0032E Invalid key type 'key-type' specified

ADM0033I The operation completed successfully

ADM0034W Did not replace key types for file 'file-name' in folder 'folder-name'

ADM0035I There are no key type definitions

ADM0036S An error occurred while reading key type definition records: exception-message

ADM0037E Must specify -types:<key-types> with -add

ADM0038S An error occurred while exporting key type definition records: exception-message

ADM0039S An error occurred while importing key type definition record for file 'file-name' in folder 'folder-name': exception-message

ADM0040 - ADM0059

ADM0040I number-key-types key types definitions were imported

ADM0041E Must specify both -provider and -type with -script

ADM0042E Must specify a type of crossregion, datastore or region with -type:<script-type>

ADM0043E Must specify a provider of 'az', 'db2', 'pg 'or 'ss' with -provider:<db-type>

ADM0044E Must specify -name:<object-name> with -type:datastore or -type:region

ADM0045I Creating SQL script file 'file-name'

ADM0046E Must specify -file, -provider and -type with -createdb

ADM0047E -ebcdic can only be specified with -createdb -provider:db2 -type:datastore

ADM0048E An error occurred attempting to process file 'file-name'

ADM0049E 'create-database-command' statement not found

ADM0050I Creating database 'database-name'

ADM0051E Database 'database-name' already exists

ADM0052E Error attempting to create database 'database-name' (error-code)

ADM0053E -collation can only be specified with -createdb -provider:db2

ADM0054E Must specify -user:<user-name> with -createdb -provider:postgresql

ADM0055E Must specify -usedb:<instance> with -createdb -provider:sqlserver

ADM0056E Must specify -password<pwd> with -createdb -provider:az|ss -user:<user-name>

ADM0059E Cannot specify both -db:<db-name> and -existdb:<db-name> with -script

ADM0060 - ADM0079

ADM0060I Updating existing database 'database-name'

ADM0061E Can only specify one of -list, -recover, or -status with -region

ADM0062E Must specify -usedb:<instance> with -region -recover/-list/-status

ADM0063I No regions exist

ADM0064S An error occurred while reading ENQ requests for the region-name region: exception-message

ADM0065E Region 'region-name' is not configured

ADM0066I No resource locks exist

ADM0067I Recovered resource lock: QNAME='resource-qname', RNAME = 'resource-rname'

ADM0068S An error occurred while attempting to recover resource locks

ADM0069E db-api-type error: 'odbc-oci-error-message'

ADM0070E -existdb:<db-name> must be specified with -script -provider:ora

ADM0071E -existdb:<db-name> can only be specified with -script -provider:ora

ADM0072E Must specify a type of crossregion, datastore, datastore_funcs or region with -type:<script-type>

ADM0073I Datastore 'datastore-url' does not need to be upgraded

ADM0074E Error creating SQL script file 'file-name' (file-status)

ADM0075E Invalid port number specified. Must be in the range 0-65535

ADM0076E Cannot specify both -list and -recover with -verify

ADM0077E Must specify either -list or -recover with -verify

ADM0078E Must specify -datastore:<url> or -usedb:<instance> with -verify -recover/-list

ADM0079S An error occurred while verifying the integrity of the datastore: exception-message

ADM0080 - ADM0099

ADM0080I Datastore 'datastore-url' has been successfully verified

ADM0081I Removed orphaned record locks: file name='file-name', folder='folder-name', count=record-locks-count

ADM0082I Removed orphaned record locks: sequential files, count=record-locks-count

ADM0083I Datastore 'datastore-url' has been successfully verified, and no recovery required

ADM0084E Must specify -name:<region-name> with -region -status

ADM0085S An error occurred while processing the status of region region-name: exception-message

ADM0088E Must specify -usedb:<instance> with -diags

ADM0089E Must specify -name:<region-name> with -diags

ADM0090S An error occurred while generating diagnostics for the region-name region: exception-message

ADM0091I Diagnostics for region 'region-name' written to file 'file-name'

ADM0092E Cannot specify both -datastore:<url> or -usedb:<instance> with -verify

ADM0093E Must specify -name:<region-name> with -verify -usedb:<instance>

ADM0094S An error occurred while verifying the integrity of the region: exception-message

ADM0095I Region 'region-name' has been successfully verified

ADM0096I Region 'region-name' has been successfully verified, and no recovery required

ADM0097I Removed orphaned resource lock and/or associated records: orphaned-record-count

ADM0098I Restored CSA record

ADM0099W Unable to recover processes for region 'region-name' - not configured

ADM0100 - ADM0119

ADM0100E Detected orphaned records in Cross-region/Region database. Run dbfhadmin -verify to validate. No recovery done

ADM0101E RC='return-code' from region/cross-region database verification. Cannot perform recovery. Contact Technical Support

ADM0102E Cannot access DB: 'Region name'. Check configuration and try again

ADM0106S An error occurred while generating diagnostics for the blob-name datastore blob: exception-message

ADM0107I Diagnostics for region 'region-name' & for DataStore 'datastore-name' written to file 'file-name'

CFG - MFDBFH Configuration Messages

CFG0000 - CFG0019

CFG0001E Unrecognized command-line option 'command-line-option'

CFG0002I Build svn-tag, svn-revision

CFG0003E Can only specify one of -add, -delete, -list, -novault, -update, or -vault

CFG0004I The operation completed successfully

CFG00040 - CFG00059

CFG00049E Error running OS command. Check the executable is on PATH: os-command-line

CFG0000 - CFG0019

CFG0005E Must specify -server:<name> with -update

CFG0006E Error attempting to back up 'file-name'

CFG0007S An error occurred while writing configuration file 'configuration-file-name': exception-message

CFG0008I Configuration written to file 'configuration-file-name'

CFG0009E Must specify -server:<name> with -add

CFG0010E Must specify -provider:<db-type> with -add -server:<name>

CFG0011E Must specify a provider of 'az', 'db2', 'pg' or 'ss' with -provider:<db-type>

CFG0012E Server 'server-name' already exists

CFG0013E Must specify -type:<dsn-type> with -add -dsn:<name>

CFG0014E Must specify a type of 'crossregion', 'database', 'datastore' or 'region' with -type:<dsn-type>

CFG0015E Must specify -name:<name> with -add -dsn:<name> -type:datastore|database|region

CFG0016E Server 'server-name' does not exist

CFG0017E Dsn 'dsn-name' already exists

CFG0018E Invalid -optio options specified

CFG0019E Invalid -bitism options specified

CFG0020 - CFG0039

CFG0020E Invalid -feature options specified

CFG0021E Must specify both -user:<user-name> and -password<pwd>

CFG0022E Cannot specify -user:<user-name> or -password<pwd> with -connect:<string>

CFG0024E Cannot specify -type:<dsn-type> with -update -dsn:<name>

CFG0025E Configuration file 'configuration-file-name' does not exist

CFG0026E Dsn 'dsn-name' does not exist

CFG0027E An empty -name:<name> value cannot be specified

CFG0028E Cannot specify -provider:<db-type> with -update -server:<name>

CFG0029E Must specify -server:<name> with -delete

CFG0030I No servers exist

CFG0031I No dsns exist

CFG0032S An error occurred while parsing 'configuration-file-name' (line line-number, column column-number): exception-message

CFG0033E command-line-option1 cannot be specified with command-line-option2

CFG0034W Secret not found in vault for attribute 'att-name': Server=server-name; Dsn=dsn-name

CFG0035E Error attempting to read secret from the vault for attribute 'attr-name' (RC=return-code): Server=server-name; Dsn=dsn-name

CFG0036E Error attempting to write secret to the vault for attribute 'attr-name' (RC=return-code): Server=server-name; Dsn=dsn-name

CFG0037E Error attempting to delete secret from the vault for attribute 'attr-name' (RC=return-code): Server=server-name; Dsn=dsn-name

CFG0038E Must specify one of -add, -delete, -list, -novault, -update, or -vault

CFG0039I Processing command response file 'file-name'

CFG0040 - CFG0059

CFG0040E Command response file 'file-name' does not exist

CFG0041E Error reading command response file 'file-name'

CFG0042I Commands processed = number-of-commands; warnings = number-of-warnings; errors = number-of-errors;

CFG0043E Invalid command-line-option value specified. Must be zero or positive

CFG0044E Invalid -connopts options specified

CFG0045E Invalid -dbopts options specified

CFG0046E Error running OS command. Check the executable is on PATH: os-command-line

CFG0047E Server 'server-name' does not exist, please make sure to use an existing server for adding a program

CFG0048E Dsn 'dsn-name' does not exists, please make sure to use an existing dsn for adding a program

CFG0049E Program 'dsn-name' already exists

CFG0050E Programs node does not exist

CFG0051E Program node does not exist

CFG0052E There is a program already present

CFG0053E Must specify -dsn:<name> with -add -program:<name>

CFG0054E Must specify -dsn:<name> with -update -program:<name>

CFG0055E Must specify -dsn:<name> with -delete -program:<name>

DBFH - MFDBFH General Messages

DBFH00000 - DBFH00019

DBFH00001I Created database 'database-name'

DBFH00002W Service Broker is not enabled for database 'database-name'

DBFH00003S An error occurred while setting up the cross-region database: exception-message

DBFH00004I Cold start of region 'region-database-name' starting

DBFH00005I database-vendor-name instance created using 'database-version'

DBFH00006I Using datasource 'database-datasource'

DBFH00007I Using database 'region-database-name'

DBFH00008I Successfully cold started region 'region-database-name'

DBFH00009S An error occurred while cold starting the 'region-database-name' region: exception-message

DBFH00010S An error occurred while warm starting the 'region-database-name' region: exception-message

DBFH00011I Shutdown of region 'region-database-name' starting

DBFH00012I Successfully shutdown region 'region-database-name'

DBFH00013S An error occurred while shutting down the 'region-database-name' region: exception-message

DBFH00014I Warm start of region 'region-database-name' starting

DBFH00015I Successfully warm started region 'region-database-name'

DBFH00016S An error occurred while parsing 'configuration-file-name' (line line-number, column column-number): exception-message

DBFH00017W An XA connection has not been registered to allow I/O operations for 'file-url' to occur

DBFH00018I Using configuration file: 'configuration-file-name'

DBFH00019I Using SQL script file folder: 'script-file-folder-name'

DBFH00020 - DBFH00039

DBFH00020S Failed to load 'odbc-oci-db2-api-load-library'

DBFH00021I Successfully registered XA connection 'xa-connection-name' for datastore 'datastore-url'

DBFH00022I Successfully de-registered XA connection 'xa-connection-name' for datastore 'datastore-url'

DBFH00023I Build svn-tag, svn-revision

DBFH00024S Failed to load Secrets/Vault API

DBFH00025W Failed to read secret from the vault for attribute 'attr-name' (RC=return-code): Server=server-name; Dsn=dsn-name

DBFH00026E db-api-type error: 'odbc-oci-error-message'

DBFH00027E I/O error: io-error-message

DBFH00028W Configuration file 'configuration-file-name' does not exist

DBFH00029W SQL script file folder 'script-file-folder-name' does not exist

DBFH00030E Required stored procedure 'stored-procedure-name' does not exist

DBFH00031W The region must be cold started

DBFH00032S MFDBFH requires the multi-threaded COBOL run-time system

DBFH00033S SQL script file 'sql-script-file-name' does not exist

DBFH00034S MFDBFH failed to upgrade the datastore. Manual upgrade required. Use 'dbfhadmin -upgrade -datastore datastore-url' to generate an upgrade script and run the script as a user with sysadmin privileges

DBFH00035W Record lock strategy changed for file 'sql-url' Already opened by PID process-id on host 'host-name' with 'existing-record-lock-strategy'. Requested 'requested-record-lock-strategy'

DBFH00036E Cannot cold start region database 'region-database-name' Already started by 'program-name (PID process-id)' on host 'host-name'

DBFH00037E Cannot warm start region database 'region-database-name' Already started by 'program-name (PID process-id)' on host 'host-name'

DBFH00038E Cannot stop region database 'region-database-name'. Not started

DBFH00039W Force cold start of region database 'region-database-name' Already started by 'program-name (PID process-id)' on host 'host-name'

DBFH00040 - DBFH00059

DBFH00040W Force warm start of region database 'region-database-name' Already started by 'program-name (PID process-id)' on host 'host-name'

DBFH00041W Connected database name 'connected-database-name' and configured database name 'configured-database-name' are different (dsn entry ='dsn-entry-name')

DBFH00042S Failed to load configuration entry API

DBFH00043W A heartbeat interval of heartbeat-interval seconds has been configured. This may cause unwanted delays to region recovery

DBFH00044S An error occurred while verifying the integrity of region resources in the cross-region database: exception-message

DBFH00045W Removed orphaned resource lock and/or associated records: orphaned-record-count

DBFH00046S An error occurred while recovering region resources in the cross-region database: exception-message

DBFH00047W Removed orphaned record locks: orphaned-record-lock-count (datastore-url)

DBFH00048W Auto-closed closed-files-count files in datastore datastore-url

DBFH00050E Error connecting to database during region recovery processing

DBFH0080 - DBFH0099

DBFH0086W Force stopped region database 'region-database-name' Previously started by 'program-name (PID process-id)' on host 'host-name'

DBFH0087I Region database 'region-database-name' is already stopped

DEP - DBFHDEPLOY Messages

DEP0000 - DEP0019

DEP0001E Invalid data file URL for a create or list operation. The URL must be of the form: sql://host[/instance]/datastore[?folder=folder-spec]

DEP0002E Invalid data file URL for an add, delete, extract, or keys operation. The URL must be of the form: sql://host[/instance]/datastore/filename[?folder=folder-spec]

DEP0003E This action requires a full URL, including a file name

DEP0004E Datastore 'datastore-name' is not configured

DEP0005E Datastore 'datastore-name' does not exist

DEP0006E An error occurred attempting to connect to datastore 'datastore-name': exception-message

DEP0007I The operation completed successfully

DEP0008E Unable to perform the requested operation

DEP0009E File 'file-name' not found

DEP0010I Uploading 'disk-file-name' to 'database-file-url'

DEP0011E Upload failed with file status file-status

DEP0012E Datastore 'datastore-name' already exists

DEP0013E Delete failed with file status file-status

DEP0014E File 'database-file-url' not found in datastore

DEP0015I Downloading 'database-file-URL' from 'disk-file-name'

DEP0016E Download failed with file status file-status

DEP0017E Upgrade failed with file status file-status

DEP0018E List failed with file status file-status

DEP0019I No files/folders

DEP0020 - DEP0039

DEP0020I 1 file/folder

DEP0021I number-files/folders files/folders

DEP0022E Database server instance 'server-name' is not configured

DEP0023E Folder 'database-folder-url' not found in datastore

DEP0024I Deleted 'database-file/folder-URL'

DEP0025E Failed to delete 'database-file/folder-url' (file-status)

DEP0026I Files deleted: number-files-deleted; Sub-folders deleted: number-sub-folders-deleted

DEP0027I Files deleted: number-files-deleted

DEP0028I Processing command response file 'file-name'

DEP0029E Command response file 'file-name' does not exist

DEP0030E Error reading command response file 'file-name'

DEP0031I Commands processed = number-of-commands; warnings = number-of-warnings; errors = number-of-errors;

DEP0032E db-api-type error: 'odbc-oci-error-message'

DEP0033E I/O error: io-error-message

DEP0034E The 'keys' action requires either 'list', or '<key-id>:<key-op>'

DEP0035E The 'keys' action '<key-id>:<key-op>' is invalid

DEP0036E 'database-file-url' does not have any keys

DEP0037E Unable to update the primary key

DEP0038E 'database-file-url' only has number-of-keys alternate keys defined

DEP0039E Retrieving duplicate record counts failed with file status file-status

DEP0040 - DEP0059

DEP0040E Updating the key definition failed with file status file-status

DEP0100 - DEP0119

DEP0103E Datastore 'datastore-name' does not exist

DEP0104E An error occurred attempting to connect to datastore 'datastore-name': exception-message

DEP0105E Datastore 'datastore-name' is not configured

VGN - DBFHVIEW Messages

VGN0000 - VGN0019

VGN0001E Unrecognized command-line option 'Command-line option'

VGN0002I The operation completed successfully

VGN0003E Must specify -struct:<file-name> with -create

VGN0004E Must specify -file:<file-url> with -create, or -delete

VGN0005E Must specify -name:<view-name> with -create, or -delete

VGN0006E Must specify -create, -delete, or -list

VGN0007E Command response file 'file-name' does not exist

VGN0008E Error reading command response file 'file-name'

VGN0009I Processing command response file 'file-name'

VGN0010I Commands processed = number-of-commands; warnings = number-of-warnings; errors = number-of-errors;

VGN0011E Can only specify one of -create, -delete, or -list

VGN0012E Can only specify one of -file or -struct with -list

VGN0013E Must specify one of -file or -struct with -list

VGN0014E Error processing structure file (file-name)

VGN0015I No structure definitions exist

VGN0016E Requested structure definition does not exist

VGN0017I Using structure definition 'structure-definition-name'

VGN0018E Invalid file URL specified

VGN0019E Datastore 'datastore-url' is not configured

VGN0020 - VGN0039

VGN0020E Error creating SQL script file (file-name)

VGN0021I Definition for view 'view-name' written to SQL script file 'file-name'

VGN0022I View 'view-name' installed in datastore 'datastore-name'

VGN0023E File 'file-name' not found

VGN0024E Create failed with file status file-status

VGN0025E List failed with file status file-status

VGN0026I No views exist

VGN0027E Delete failed with file status file-status

VGN0028W File 'file-name' does not have associated view 'view-name'

VGN0029E db-api-type error: 'odbc-oci-error-message'

VGN0030W Function 'function-name' not found. Default column type defined for 'field-name'

VGN0031W Function 'function-name' found, but DbfhFuncDB2 not installed. Default column type defined for 'field-name'

VGN0032W Maximum DECIMAL precision supported by Db2 is 31. Generating 'field-name' as VARCHAR

VGN0033E I/O error: io-error-message

Limitations to MFDBFH

MQSeries

Passing user credentials when connecting to an MQSeries queue manager

Mainframe Programming

Mainframe Subsystem Support Developer Introduction

What is Mainframe Subsystem Support?

Migrating the Application

About CICS applications

Editing and Previewing BMS Files

Invoking CICS Programs Externally

IBM CICS Transaction Gateway

Micro Focus External Call Interface

CICS Application Programming Interface (API)

File and Database Support

CICS ECM Preprocessor

About IMS applications

About JCL applications

Configuring Enterprise Server to Run the Application

CICS, IMS and JCL Resources

Data Conversion

CICS Intersystem Communication

Terminal Emulation

Choosing a TN3270 Mainframe Display

Terminal Emulation with Micro Focus Host Access for the Cloud

Configuring the HACloud Session Server

Starting the HACloud Session Server

Running an HACloud TN3270 session

Terminal Emulation with Micro Focus Rumba

Embedded Rumba Mainframe Display View

Connecting to the host

Disconnecting from the host

Connecting to secure servers

Importing and exporting connections

Running Applications in a TN3270 Mainframe Display

Launching the Display to Run Applications

Connecting the Display to an Enterprise Server Region

Debugging using a TN3270 Mainframe Display

Launching the TN3270 Mainframe Display to Debug Applications

Connecting the Display to an Enterprise Server when Debugging Applications

Debugging Using the Embedded Rumba Mainframe Display View

Debugging using the HACloud TN3270 emulator

Debugging using Other TN3270 Emulators

CICS Support

Mainframe-style Pointers

AMODE and Non-AMODE Compiled Programs

Forcing a Program to be Reloaded

Accessing Large VSAM Files

Abend Codes in CICS Transactions

Using the SET Option of the BMS-related SEND Functions

Converting a Fake TIOA Address to a Real TIOA Address

Restrictions on Using DFHMFSET

Examples

OS/VS COBOL Example

VS COBOL II Example

Developing Exit Programs

Introduction to Developing Exit Points

Global and Task-related Exit Programs

User Exit Examples

Task-related User Exit Example

Global User Exit Example

Security Exit Programs

Interface

Error Conditions

CICS Web Services

Configuration Requirements for CICS Web Services

CCSID Conversion Tables

CICS Web Service Types and Methods

CWS Security

New CICS Web Service Wizard

Validating Your Enterprise Server Instance Configuration

Troubleshooting

How to

To specify a CCSID table in the CICS SIT

To specify the corresponding ASCII CCSID for an EBCDIC CCSID

To create a CICS Web Service provider using the bottom-up method, WSDL

To create a CICS Web Service provider from WSDL using the top-down method

To create CICS Web service requester from WSDL using the top-down method

To create a CICS Web service requester and provider from WSDL using the top-down method

To create a CICS Web Service provider using the bottom-up method, JSON

To create a CICS Web Service provider from JSON using the top-down method

To create a CICS Web Service requester using the bottom-up method, JSON

To create CICS Web service requester from JSON using the top-down method

To generate new output files for a CICS Web service

To set preferences for CICS Web Services

To validate an associated enterprise server region for a CICS Web service

Reference

Command line reference

User Interface reference

CICS Web Services

New CICS Web Service Wizard Start page

New CICS Web Service (Bottom Up) pages 1 and 2

New CICS Web Service Provider page

New CICS Web Service Requester page

New CICS Web Service Requester and Provider page

CICS Bundle Resource

CICS PCT Resource

CICS Pipeline Resource

CICS Resources

CICS TCPIPSv Resource

CICS URIMap Resource

CICS Web Service Provider (Bottom-Up, Request-Response)

CICS Web Service Provider (Top-Down, Request-Response)

CICS Web Service Provider (Top-down, RESTful)

CICS Web Service Requestor (Bottom-Up, Linkable Interface)

CICS Web Service Requestor (Top-Down, Linkable Interface)

Validate Region Result

HCO for DB2 LUW

Host Variable Groups and Indicator Arrays

DB2 External Compiler Module

Compound SQL

Extensions to Embedded SQL Support

The INCLUDE Statement

The DECLARE Statement

Qualified Host Variables

The NOT Operator (¬)

The Concat Operator (|)

SQL Communications Area

Support for Object Oriented COBOL Syntax

Support for Nested COBOL Programs and PL/I External Routines

Compiling

DB2 ECM Preprocessor

Setting the DB2 ECM Preprocessor and Compiler Directive Options

DB2 Compiler Directive

Error Codes

Building Applications

Stand-alone DB2 Applications

Client DB2 Applications and Stored Procedures

Building DB2 Applications with Eclipse

Binding

COBOL DB2 Stored Procedures

Working with Stored Procedures

Writing and Preparing Stored Procedures

Preparing Stored Procedures

How an Application Works With a Stored Procedure

Writing and Preparing Applications to Use Stored Procedures

Executing the SQL Statement CALL

Parameter Conventions

Using Indicator Variables to Speed Processing

Declaring Data Types for Passed Parameters

Limitations

Defining Stored Procedures under DB2 LUW

Compiling and Linking Stored Procedures under DB2 LUW

Testing Stored Procedures under DB2 LUW

Host Compatibility Option (HCO)

Creating a DB2 LUW Database for HCO

HCO Tools

BindAll Packages Tool

Product Specifications

HCO Functions

DDL DB2 for z/OS Syntax Supported

Functions Processed Unchanged

Functions Changed to Comments

Functions That May Be Modified

DB2 LUW Syntax DDL

Features Supported by DB2 LUW

Column Functions and Scalars

Special Registers

Features Not Supported by DB2 LUW

Special Registers

Other Functions

Compiling and Run Time

Compiling DB2 Programs with HCO

DDL Processing

Invoking the DB2 ECM

Error Messages When Compiling Program

Run-time Services

MFHCOCDS Tool

How to

To process SQL DDL statements

To set HCO for DB2 LUW options

Reference

DB2 Compiler Directive Options

CONCURRENTACCESSRESOLUTION

DB2 Environment Variables

HCOBND environment variable (deprecated)

DB2 ECM Error Messages

COBDB0002 - COBDB0013

COBDB0002 token is badly defined.

COBDB0003 Program contains more than one definition of field-name

COBDB0004 Nested or multi-source programs not allowed.

COBDB0005 An error occurred when processing the internal dictionary.

COBDB0006 Required DB software token could not be found.

COBDB0007 Source file name is invalid.

COBDB0008 MF DB2 Connect program missing or invalid.

COBDB0009 MF DB2 Connect program reported error condition token.

COBDB0010 DB2 rejected an unspecified option.

COBDB0011 No database name was specified.

COBDB0012 Functionality only supported in 32-bit mode

COBDB0013 Invalid directive token. IBM supports only precompiled code running as native code.

COBDB0100 - COBDB0115

COBDB0100 SQL error description

COBDB0101 Statement is too long.

COBDB0102 Statement contains too many host variables.

COBDB0103 host-var definition does not match the column type associated with it.

COBDB0104 Bad SQL data declaration.

COBDB0105 Syntax error.

COBDB0106 Filename too long.

COBDB0107 File filename not found.

COBDB0108 host-var is non-unique and should be qualified.

COBDB0109 host-var is not a data item.

COBDB0110 Statement contains more than one SQLDA.

COBDB0111 token is not a table of null indicator variables.

COBDB0112 host-var should not be defined with an OCCURS clause.

COBDB0113 host-var should not be a subordinate to an item defined with an OCCURS clause.

COBDB0114 Statement only allowed in the Procedure Division.

COBDB0115 Statement not allowed in the PROCEDURE DIVISION.

COBDB0116 - COBDB0137

COBDB0116 An error occurred when processing the trace file.

COBDB0117 Invalid format of compound SQL statement.

COBDB0118 Mismatched DECLARE.

COBDB0119 Host variable name is too long.

COBDB0120 Internal error - dictionary handle is too big.

COBDB0121 Package name is too long.

COBDB0122 Nested INCLUDEs not supported

COBDB0127 Parentheses are illegal in the INTO clause.

COBDB0131 SQLCA or SQLCODE not found.

COBDB0137 Indicator variable ind-var is not SMALLINT type.

COBDB0501 - COBDB0503

COBDB0501 Found variable expected END-EXEC in nested include.

COBDB0502 Found variable expected INCLUDE in nested EXEC SQL statement.

COBDB0503 Found variable expected SQL in nested EXEC statement.

COBDB0900 - COBDB1004

COBDB0900 An internal error occurred.

COBDB0901 SQL processing cannot continue.

COBDB0902 An internal error occurred.

COBDB1000 Use of EXEC SQL INCLUDE SQLCA END-EXEC.

COBDB1001 MF DB2 Connect program produced the warning token.

COBDB1002 Statement is not in area B.

COBDB1004 INVALID SQL STATEMENT - statement ignored.

HCO Tools

Command Line Reference

cobmfhco create command

cobmfhco ddl command

cobmfhco dclgen command

cobmfhco import command

cobmfhco export command

cobmfhco bindall command

User Interface reference

HCO for DB2 LUW Options

HCO for PostgreSQL (HCOPG)[3]

Before Using HCO for PostgreSQL

HCOPG Datetime Data Type Handling

Managing Connections

DB2 to PostgreSQL Conversion

HCOPG Conversion Rules

SQL Code Generation Options

NULL Byte Support in PostgreSQL Character Columns[7]

SQL Statement Prefixes for DIALECT Directive

Datetime arithmetic in HCOPG

Application Progression from DB2 to PostgreSQL

Building Applications

Scope - HCOPG SQL Compiler Directive Options

How to

To customize SQL name mappings

To customize SQLCode mappings

To install CCSID tables for HCOPG[7]

Reference

SQL Compiler Directive Options - HCOPG

DBMAN Directive Settings - HCOPG

HCO for SQL Server (HCOSS)[1]