Micro Focus Visual COBOL 9.0 for Visual Studio 2022

Significant Changes in Behavior or Usage

Visual Studio

New Customers: Where do I start?

New to Visual Studio

Where do I start: Developer Tasks

New to COBOL

Want to deploy an application

Upgrading from Net Express

Upgrading from Server Express

Upgrading to Visual COBOL

Licensing Changes

Resolving conflicts between reserved keywords and data item names

Importing Existing COBOL Code into Visual COBOL

Recompile all source code

Differences between Visual COBOL and Earlier Micro Focus Products

Overview of the Differences

Tips: Visual Studio IDE Equivalents to IDE Features in Net Express

Upgrading from Net Express to Visual COBOL

An introduction to the process of upgrading your COBOL applications

Compile at the Command Line Using Existing Build Scripts

Debugging Without a Project

Create a project and import source

Using Visual COBOL for Visual Studio

Change the Defaults to Replicate Your Existing Project Structure

Best Practice in Visual COBOL Development

Modernize Your Applications and Processes

Upgrading from Server Express

Differences between Visual COBOL and Net Express

Summary of Differences

Backward Compatibility with Earlier Micro Focus Products

Backward Compatibility with Previous Versions of Visual Studio

Compiling and Building Differences

Output File Formats

Character-Mode Dialog System

Compiler directives

Linking

Called Programs and Dependencies

File Handler

OpenESQL Assistant

SQL Compiler Directive Options

XML PARSE Statement

Run-time System Differences

Single-Threaded Run-Time System

Static-Linked Run-Time System

Visual COBOL Co-existing with Earlier Micro Focus Products

Restrictions and Unsupported Features

Host Compatibility Option (HCO)

INTLEVEL Support

NSAPI

Online Help System

OO Class and Method Wizards

Debugging Native Object-Oriented COBOL

Solo Web Server

SQL Option for DB2

Type Library Assistant

UNIX Publish

Run-Time Technology Differences

Editing and Debugging Differences

Data Tools

Mixed Language Debugging

Program Breakpoints

Remote Debugging

Source Pool View

Tips: Visual Studio IDE Equivalents to IDE Features in Net Express

Upgrading from ACUCOBOL-GT

Upgrading from RM/COBOL®

Visual COBOL Editions and Activating Licenses

To activate Visual COBOL Personal Edition

To buy and activate a full license

To obtain more licenses

Visual COBOL Tutorials Guide

Native COBOL Tutorials

Tutorial: Creating Your First Hello COBOL World Application

Tutorial: Configuring the Hello COBOL World Application

Tutorial: Debugging the Hello COBOL World Application

Tutorial: Creating a Native COBOL Application

Tutorial: Debugging COBOL Applications Remotely

Tutorial: Running Unit Tests in the IDE

Tutorial Getting Started

Creating a Unit Test Library Project

Running the Test

Running the Test Under Code Coverage

Enhancing the Test

Debugging the Failed Test

Fixing and Rerunning the Failed Test

Running the Enhanced Test Under Code Coverage

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 COBOL and WPF Clients

Run the WPF 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 COBOL and WPF Clients

Run the WPF Client

Tutorial: REST Web Service using CORS and AJAX

Set Up the ProgramCORS Project

Create the AccessBooks Service Interface

Define AccessBooks Operations

Set Up the ESCORS Enterprise Server Region

Deploy the AccessBooks Web service

Access the AccessBooks Web Service via an AJAX Request

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: Data File Editor

Import and Build the Sample Project

Start Data File Tools

View the Data File Unformatted

Create a Record Layout

View the Data File Formatted

Filter the Data File

Edit a Record

Create a New Data File

Create a New Record

Insert a Record

Delete a Record

Tutorial: Classic Data File Tools

Copy and Build the Visual Studio Solution

Convert a File

View a Data File Unformatted

Create a Record Layout File

Create the Default Record Layout

Create the Conditional Record Layouts

Save the Record Layout File

View a Data File Formatted

Access Information about a Record Layout File

View Files in Hexadecimal

Print a Data File

Edit Multiple Data Files

Create a New Data File

Convert a File's Character Set

View the EBCDIC File

Tutorial: Using the Callable File Handler

Tutorial

Create a Test 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

.NET COBOL Tutorials

Tutorial: Developing .NET COBOL Applications

Tutorial: Creating Windows Forms in COBOL

Tutorial: Developing Web Application Projects

Tutorial: Creating and Accessing WCF COBOL Services

Tutorial: Publishing Hello COBOL World to the Cloud

Tutorials: OpenESQL .NET Code

Tutorial: Prepare the SQL Server Environment

Set Up the BookDemo Database

Create an ADO.NET Connection to BookDemo

Tutorial: WCF COBOL Service using SQL

Set Up the SqlBookWCF Solution

Configure and Test the WCF Service Library

Add the SqlClientWCF Client Project

Configure and Run the SqlClientWCF Client

Tutorial: Object-Oriented WCF COBOL Service using SQL

Set Up the OOSqlBookWCF Solution

Configure and Test the OO WCF Service Library

Add the OOSqlClientWCF Client Project

Configure and Run the OOSqlClientWCF Client

Tutorial: Web Application using SQL

Set Up the SqlBookDemoWebApplication Solution

Code the Web Page

Build and Run the Web Application

Tutorial: Object-Oriented Web Application using SQL

Set Up the OOSqlBookDemoWebApplication Solution

Code the OO Web Page

Build and Run the OO Web Application

Tutorial: OpenESQL Assistant

Create the OESQLDemo SQL Server Database

Set Up the OESQLAsst Project

Set the OpenESQL Assistant Type COBOL Variable

Catalog a Connection using the ADO.NET Connection Editor

Define and Test a Query

Generate and Embed an SQL Program and Query

Generate and INCLUDE the EMP.cpy Copybook

Debug the SQL COBOL Application

Tutorials: SQL Server COBOL Stored Procedures

Tutorial: Prepare the SQL Server COBOL Environment

Enable SQL CLR Integration

Create the SQLCLR_Test Database

Catalog the SQLServerDB Connection

Set Up the SQLServerSP Database Project

Tutorial: Construct and Execute a SQL Server COBOL Stored Procedure

Construct a SQL Server COBOL Stored Procedure

Publish the LookupEMP Stored Procedure to SQL Server

Debug and Execute the LookupEMP Stored Procedure

Call the LookupEMP Stored Procedure from COBOL

Prepare to Debug LookupEMP in a Development Environment

Debug LookupEMP in a Development Environment

Tutorial: Generate a COBOL Wrapper for a SQL Server COBOL Stored Procedure

Technology Preview Features

EAP Features

Samples Browser

To start the Samples Browser

To build the Samples Browser demonstration

Demonstrations of .NET COBOL

Demonstrations of Native COBOL

Product Information

Supported Operating Systems and Third-party Software

Additional Software Requirements

.NET

.NET COBOL Applications

Application Server JCA support for Enterprise Server

COBOL on Microsoft Azure

Database Connectors for Visual COBOL

Database Management Systems (DBMSs)

Enterprise Common Web Administration (ESCWA)

Interface Mapping Toolkit (IMTK)

Legacy Enterprise Server Administration User Interface

Performance Availability Clusters (PACs)

Windows Forms

Installation

Before Installing

Downloading the Product

System Requirements

Hardware Requirements

Operating Systems Supported

Software Requirements

Product Co-Existence

Installation Restrictions and Requirements

Basic Installation

Installing

Advanced Installation Tasks

Visual COBOL Installation Options

Microsoft Package Dependencies

Installing into Several Editions of Visual Studio

Installing Visual COBOL in an Offline Environment

Installing from a Server

Windows Compatibility Mode

Installing on Microsoft Terminal Server and Citrix

Customizing the Installation 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

Starting the Product

Managing the Microsoft Build Tools and Windows SDK Packages

The Microsoft Build Tools and Windows SDK Configuration Utility

Viewing the Product Help

Repairing

Uninstalling

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

Installing a standalone network license server

Installing on Windows

Standard installation

Silent installation

Installing License Manager without Sentinel RMS or AutoPass

Installation

Silent installation

Setting up network licensing with COBOL server

Trial licenses

Subscription licenses

Usage Logging

License Usage Logging with AutoPass License Server

Prerequisites for Integration with an 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

Updates and Product Support

Micro Focus End User License Agreement

Backward Compatibility with Earlier Micro Focus Products

Backward Compatibility with Previous Versions of Visual Studio

Known Issues and Restrictions

64-bit-only Products

.NET

Application Server JCA Support

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

Code Analysis

Compatibility

Coexisting with earlier Micro Focus products

Installation

Containers

Data Access

Classic Data File Tools

Records with Alternate Keys

Debugging, Problem Determination and Diagnostic Tools

Debugging in Visual Studio

Test Coverage

Documentation

Enterprise Server

.NET COBOL Applications

ASP.NET

File Handler

Background Syntax Checking

Security Considerations

Printer Redirection

Web Reference Generation

XML Extensions

SSL and TLS

Visual Studio Integration

Building Applications in Visual Studio

Dialog System

Expanded Copybook View

Find All References

Fonts and Colors Dialog Box

Formatting COBOL Code

Importing Net Express Projects

IntelliSense Support for COBOL

Visual Studio Help Viewer

Visual Studio Team System

Windows Communication Foundation (WCF)

Contacting Micro Focus

Further Information and Customer Care

Information We Need

Contact information

The Micro Focus Community

Help on Help

Developing Applications in the IDE

Starting Visual COBOL

To start Visual Studio

To start Visual COBOL as an administrator

To start a Visual COBOL command prompt

To start a Visual COBOL command prompt as an administrator

Overview of Creating Applications

COBOL Development

Introduction to COBOL Development in Visual Studio

To install missing features from the IDE

Quick Tips on Editing, Building and Debugging

Document Your Types, Members, and Namespaces with Comments in the Code

Editing COBOL Applications

Projects Created with Earlier Visual COBOL Releases

Moving Existing Native COBOL Applications to Visual COBOL

Converting Additional Directives to Project Properties

Relink Applications

Working with Projects

Types of COBOL Project Templates

To add files to a COBOL project

To add a folder to the project's Copybook Paths

Exploring Your COBOL Projects and Solutions

Solution Explorer

Project Details Window

Object Browser

Expanded Copybook View

Viewing the Copybook Graph

Document Outline Window

Creating Projects from Existing Code

Converting Net Express Projects to Visual Studio Projects

To import a Net Express project into the Visual Studio IDE

Create Projects from Existing Code Wizard

To create a COBOL project from existing code

Creating a New Project From Files in an Existing Project

To create a new COBOL project from selected files in an existing project

Creating Projects from Standalone Files

Creating and Distributing Custom COBOL Project Templates

Editing COBOL Projects with Different Versions of Visual Studio (Project Round-Tripping)

Configuring Properties

Overview of COBOL Project Properties

Configuring Visual Studio

AutoCorrect

COBOL Debugging Options

Code Analysis Options

Code Analysis - Data Flow Analysis Options

Code Analysis - Program Flow Graph Options

Code Cleanup Options

Code Coverage General Options

Code Coverage - Report Content Options

Code Coverage - Results File Options

Data File Tools

Configuring IntelliSense for COBOL - Completion Lists

Configuring IntelliSense for COBOL - Insertion

Enterprise Server Configuration Options

Indentation - Environment Division

Formatting Options - Data Division

Formatting Options - Identification Division

Formatting Options for the Indentation in the Procedure Division

Line Numbering Options

Compiler Directives For COBOL Files

Text Editor Advanced Options

Text Editor Formatting Options

Text Editor General Options

Text Editor Snippets Options

General Project Options

Configuring the Profiler Reports

Quick Actions

Scroll Bars

Standalone editing

Standalone Editing - General Directives

Standalone Editing - Program Symbols

Text Casing Options

Text Editor Tabs Options

Text Editor Margins Options

Web Service Clients Options

Transferring Visual Studio Settings

Sharing Code Style Settings with an EditorConfig File

Project Properties

Application Properties for .NET COBOL

Application properties for native COBOL

COBOL Link Page

COBOL Properties

Micro Focus Code Analysis

Copybook Paths

Container Project Properties

Debug Properties

Enterprise Server Folder Properties

Enterprise Server Debug Folder Properties

Namespaces

Preprocessor Properties

SQL Properties

To set COBOL project properties

To specify file properties

To reset the file properties

To configure how the IDE determines the Compiler directives of files

To automatically determine and set directives on COBOL files

To add references to a .NET COBOL project

To set .NET COBOL project properties

Working with the Editor

COBOL Editor Features

Configuring the Editor

Configuring IntelliSense for COBOL - Completion Lists

Configuring IntelliSense for COBOL - Insertion

Configuring the COBOL Margins

Configuring the Indentation

Configuring the Ruler

Configuring Word Wrap with Smart Edit Mode

Customizing the Behavior of Home and End Keys

Customizing the Text Fonts and Colors

IntelliSense for Efficient Coding

Inserting Code Snippets

To insert a snippet in your code

Shortcuts for the COBOL Snippets

To create a custom COBOL snippet

CodeLens

Applying Code Style Preferences

Formatting COBOL code

To specify COBOL formatting options

To format COBOL source code

To format COBOL source code with Code Cleanup

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

Overriding the Members of an Inherited Class

Quick Actions for Efficient Coding

Editor Quick Action: Converting .NET Types to Portable COBOL Syntax

Editor Quick Action: Creating a Copybook from Selected Lines of Code

Editor Quick Action: Creating or Finding a Missing Copybook

Editor Quick Action: End of Scope Termination

Editor Quick Action: Extract to Section

Editor Quick Action: Generate Missing Section or Paragraph

Editor Quick Action: Implementing Unimplemented Interfaces

Editor Quick Action: Import a Namespace with $SET ILUSING

Editor Quick Action: Sort the ILUSING Statements

Editor Quick Action: Remove or Comment Out Dead Code

Editor Quick Action: Rename Refactoring

Editor Quick Action: Simplifying the Names of Types

Convert JSON Data to COBOL Classes

Working with Files

To associate file extensions with COBOL

To specify that a file extension is a copybook

Grouping Files in Solution Explorer

To toggle Virtual View

To create a custom virtual folder

To add files to a new virtual folder

To modify a virtual folder

To delete a virtual folder

Working in Open Folder Mode

Opening a Folder in Visual Studio

Specifying Compiler Directives for the Open Folder Mode

Compiling Files in Open Folder Mode

Debugging Files in Open Folder Mode

Using Source Control in Open Folder Mode

Moving to Projects From Open Folder Mode

Building COBOL applications

Tips on building COBOL

Build Configuration

Compiling COBOL Applications

Compiling COBOL code

Executable file formats

Setting Compiler directives for COBOL

Setting project-wide build properties and Compiler directives

Setting Compiler directives on individual files

Setting Compiler directives from the command line

Setting Compiler directives using a response file

Setting Compiler directives in source code

Setting Compiler directives in a directives file

Single file multi-program support in the IDE

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 native COBOL code

Overview of linking native COBOL applications and run-time systems

Shared run-time systems for running native COBOL applications

Dynamically binding run-time systems to your native COBOL applications

Program loading order and run-time system usage for native COBOL

Loading a dynamic link library built as native COBOL code

Application performance with dynamic binding for native COBOL

How To in the IDE

To build a COBOL project

To embed resources in a native COBOL application

To add an application configuration file

To add a resource script file to your native COBOL project

To edit a resource-definition script file for a native COBOL project

To set an entry point for a native COBOL project

To Set Compiler Directives on a COBOL File

To compile individual files

To link a native COBOL project to the run-time system

Code Analysis

Application Analysis Server References and Reports

To set up an Application Analysis Server connection

Getting Direct References

Analysis Query Window

Execute a Single Code Search

Generating a Code Search Report

Analysis Code Search Window

Analysis Services

Data Flow Analysis

Code Analysis - Data Flow Analysis Options

To run Data Flow Analysis

The Data Flow Analysis Tree and Graph

Program Flow Graph

Code Analysis - Program Flow Graph Options

To display a Program Flow Graph

Using the Program Flow Graph

Rule-Based Analysis

Micro Focus Code Analysis Window

Performing Code Analysis when Building a Project in the IDE

Performing Code Analysis on Demand

Performing Code Analysis from the Command Line

Including Code Analysis in a Continuous Integration Process

Configuring Rules and Rule Sets

Importing Rule Sets into the IDE

Importing Existing Code Analysis Reports

Using COBOL Source Information

Introduction to COBOL Source Information

To run a CSI query

Unreferenced Data

Undeclared Procedures

Copybook Structure

Program Statistics

Unexecuted Procedures

CSI Query Results

Micro Focus Code Analysis Window

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

Code Refactoring

Creating Copybooks from Selected Lines of Code

Refactoring Using Quick Actions

Extracting a section or paragraph from a COBOL program to a new program

Creating a program from a section or paragraph (COBOL)

Creating a program from computation (COBOL)

Creating a program from condition

Debugging COBOL Applications

Debugging Native COBOL 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

Debugging Using COBOL Watchpoints

Debugging Native COBOL Link Library Projects

Debugging Windows Services

Remote Debugging

Debugging .NET COBOL Scenarios

Debugging Asynchronous .NET COBOL Code

Debugging .NET COBOL Applications Remotely

Debugging on Enterprise Server Scenarios

Dynamic Debugging on Enterprise Server

Additional Debugging Features with Enterprise Server

Debugging Features and Techniques in Visual Studio

Tips on Debugging COBOL

How To

To attach to a running native COBOL process and debug

To attach to a native COBOL process running remotely

To configure the symbol path for native COBOL applications

To configure an enterprise server region to produce a core dump

To debug files without a project

To debug a native COBOL project that compiles to multiple executables

To debug using a core dump

To debug a multi-project solution

To debug a native COBOL program running remotely

To debug on Enterprise Server

To debug on a remote Enterprise Server

To debug using a temporary enterprise server

To enable a core dump using a library routine

To enable core dumps using run-time tunables

To enable just-in-time debugging

To launch a debug process using Wait for debuggable attachment

To prepare for debugging

To prepare for debugging on Enterprise Server

To set a COBOL watchpoint in native COBOL code

To set program breakpoints in native COBOL

To set up remote debugging for native COBOL applications

Reference

cblcored utility

cobdebugremote

cobdebugremote64

Running Applications (Native COBOL)

Configuring the Run-time Behavior for Native Applications

Application Configuration File

Run-time Configuration for Intermediate and Generated Code

To configure the run-time behavior for native applications

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 Coverage and Profiling (.NET COBOL)

COBOL Applications for Microsoft Azure

Introduction to COBOL on Microsoft Azure

Microsoft Azure System Requirements and Levels of Support

Tutorial: Publishing Hello COBOL World to the Cloud

Demonstration Programs for COBOL on Microsoft Azure

Preparing a COBOL Application for Microsoft Azure

Cloud Template and Skeleton Roles and Projects

Copying Data to Microsoft Azure

How to Create and Publish a COBOL Service for Microsoft Azure

To Create a COBOL Microsoft Azure Service and Roles

To Develop a COBOL Azure Service

To Configure a Service and Storage for Microsoft Azure

To transfer files to the Azure storage

To Debug a COBOL Microsoft Azure Service Locally

To Publish a COBOL Service to Microsoft Azure

To Run Visual Studio as Administrator

Using the Consolidated Tracing Facility on Microsoft Azure

Specifying Microsoft Azure-specific Emitters

BINSTORAGE Emitter Properties

TEXTSTORAGE Emitter Properties

Updating Microsoft Azure Role Configuration Files

Adding References to Tracing-related .dll Files

Downloading Trace Information

Viewing Trace Information

Microsoft Information on Microsoft Azure and the Cloud

COBOL Applications for .NET

Introduction to Developing COBOL Applications for .NET

Introduction to .NET project files

Upgrading existing .NET COBOL project files

Comparing .NET and .NET Framework

Creating a .NET Project

To create a .NET project in the IDE

To package Micro Focus assemblies with a .NET application

Building a .NET Project

Debugging a .NET Project

To debug a .NET application running on Linux

To debug a .NET application with WSL

Publishing a .NET Project

Different Types of .NET Deployment

To publish a .NET project using the IDE

Building COBOL Applications for .NET Using the Command Line

Before Creating a .NET Project Using the Command Line

Installing the .NET Project Templates

Creating a .NET Project Using the Command Line

Building a .NET Project Using the Command Line

Running a .NET Project Using the Command Line

To publish a .NET project using the dotnet command line

To publish a .NET project using the msbuild command line

SQL Support for .NET Projects

Configuring a .NET Project for SQL Support

Supported .NET Core Providers

Sample SQL ADO Connection Strings for .NET

Working with a Large Code Base

Benefits of Using Visual Studio Projects

Accessing Source Code Without a Project

Configuring Visual Studio Projects

Optimizing the Performance of the IDE

Specifying Build Settings

Building Applications in the IDE

Building From the Command Line Using a Project File

Best Practice When Upgrading a Legacy Application

Steps to Upgrading Your Application

Using Enterprise Server from within the IDE

Specifying IDE configuration options for Enterprise Server

Enterprise Server templates

Managing Enterprise Server Regions from Server Explorer

To provide and manage the credentials of enterprise server regions

To view the available servers and their credentials

To export an enterprise server instance

To import an enterprise server

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

To filter the servers

To refresh the list of the available servers

To display an enterprise server log inside the IDE

To configure the run-time environment

To connect to a remote enterprise server

To create a new enterprise server

To delete an enterprise server

To open the ESCWA UI from the IDE

Using Solution Explorer with Enterprise Server

To create a new Enterprise Server for a project

Modern Development Practices

Using Visual COBOL 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 Visual COBOL 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

Examples

Example - Building COBOL Programs

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

Visual COBOL Build Tools for Windows

Introduction to Visual COBOL Build Tools for Windows

Prerequisites for Using Visual COBOL Build Tools for Windows

Licensing Considerations

Installing Visual COBOL Build Tools for Windows

Restrictions

Using Visual COBOL Build Tools for Windows

Starting a Visual COBOL Build Tools for Windows Command Prompt

Building Using Visual COBOL Build Tools for Windows

Compiling and Linking Using Visual COBOL Build Tools for Windows

Running Using Visual COBOL Build Tools for Windows

Debugging Using Visual COBOL Build Tools for Windows

Deploying Using Visual COBOL Build Tools for Windows

Using Visual COBOL Build Tools for Windows to Build .NET Projects

Using Visual COBOL with Containers

Introduction to Containers

Benefits of Using Containers

Container Terminology

Getting Ready to Use Visual COBOL with Containers

Installing Docker on Windows

Key Concepts When Using Containers for COBOL Application Development

Create Different Images for Different Development Tasks

Make Use of Visual COBOL Build Tools for Windows

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 Visual COBOL Build Tools for Windows

Building an Image Containing an Application to use with Visual COBOL Build Tools for Windows

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

How to work with native COBOL applications in containers

To add a Dockerfile to a native COBOL project

To debug or run a native COBOL application in a container

To build an image for deployment

Debugging and Running .NET COBOL Applications in Containers

Building a .NET 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 .NET COBOL Application in a Container

To start debugging a .NET COBOL application that is not yet running in a container

To start debugging a .NET COBOL application that is already running in a container

Debugging .NET COBOL Applications Running in Containers

Container Demonstrations

Supplied Container Demonstrations

Using the Container Demonstrations

The Container Demonstration for the Visual COBOL Base Image

Introduction to the Container Demonstration for the Visual COBOL Base Image

Running the Container Demonstration for the Visual COBOL Base Image

Files in the Container Demonstration for the Visual COBOL Base Image

The Hello World Container Demonstration

Introduction to the Hello World Container Demonstration

Running the Hello World Container Demonstration

Files in the Hello World 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

.NET Entry Point Mapping

Calling programs from .NET COBOL projects

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

.NET COBOL Programming

Native COBOL Compared to .NET COBOL

Introduction to Object-Oriented Programming for COBOL Developers

Moving Native COBOL Applications to .NET COBOL

Why Move to .NET COBOL Code?

Considerations When Moving to .NET COBOL

Writing Multi-User Applications

Accessing Procedural COBOL From .NET COBOL Code

Example of Using a .NET COBOL Wrapper Class

Example of Using the ILSMARTLINKAGE Compiler Directive

64-bit applications in the .NET environment

Multiple user COBOL applications in .NET

Background to multiple run units and .NET

Demonstration of a Multiple Run Units Application

Run the MultiRunUnits Demonstration

Walkthrough the MultiRunUnits Demonstration

Developing an application for multiple run units in .NET COBOL

Printing Performance for .NET Deployed COBOL Applications

Code Page Conflicts in .NET COBOL

Avoiding Code Page Conflicts in .NET COBOL

Example of Code Page Conflicts in .NET COBOL

Interoperability

Overview of Interoperability

Data Marshaling and Type Conversion for .NET COBOL Interoperation

Type Compatibility in Interoperation with Managed Code

Exposing COBOL Linkage Data as Managed Types

Type Mappings from Native COBOL to .NET COBOL Code

Write a Proxy or Edit the COBOL for .NET Interoperation?

Examples of Compatible Types for Native and .NET COBOL

Compatible Types Example in .NET COBOL Interoperation

Group Items Example in .NET COBOL Interoperation

Occurs Clause Example in .NET COBOL Interoperation

Calling a .NET Class from Native COBOL, Using CCW

Calling a Native COBOL COM Object, Using RCW

To call native COBOL as a COM Object

Platform Invoke and Calling Native COBOL

Calling Native Code Dynamically

PInvoke Example

Callable Attribute in .NET COBOL Interoperation

Web Application Development with COBOL

Building Service-Oriented Applications with WCF and COBOL

Exposing COBOL as Web Services

Java and COBOL Interoperability

Java and OO COBOL Interoperability

Java and OO COBOL Interoperability Options

Considerations

Linking to the Multi-threaded Run-time System

Setting Up the Environment for Java and COBOL

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

Micro Focus COBOL Java Class Library

Java and non-OO COBOL Interoperability

COBOL Calling Static Java Methods

Java Accessing COBOL Working Storage Items

Java Calling COBOL Programs

Building and Running Native COBOL that Interoperates with Java

Example 1 - COBOL Calling Java Static Method

Example 2 - Java Accessing COBOL Working Storage Items

Example 3 - Java Calling COBOL Programs

Example 4 - Java Calling COBOL and Accessing Working Storage Items

Mapping COBOL Items and Java Types

The genjava Utility

genjava Syntax Options

Implementation Differences Between Micro Focus COBOL and Enterprise COBOL

Limits and Restrictions

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

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

Generating Web Services and Clients from WSDL or JSON

Generated Web Service Components

Generated COBOL Client Components

Handling Variable Arrays in WSDL and JSON

Clients

Working with Clients

How to

Manage IMTK Projects

To configure the run-time environment

To create a project for COBOL program-based service interfaces

To create a COBOL program-based service interface

To import a COBOL program service interface

To modify the CLASSPATH property for an EJB service interface

To update service interfaces with source code changes

To set client generation options

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 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 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 build an ASP.NET client

To install a deployment package using mfdepinst

To redeploy a service interface

To set deployment properties

Generate Web Services from WSDL and JSON

To generate a Web service from WSDL

To generate a RESTful Web Service from JSON Schema or OpenAPI (Swagger)

To generate a RESTful Web Service from request-response JSON

Generate Clients

To generate client applications from a service interface file

To generate a COBOL console client from WSDL

To generate a COBOL console client from JSON Schema or OpenAPI (Swagger)

To generate a COBOL console client from request-response JSON Schemas

To generate a Web service client application project from WSDL or JSON

Reference

imtkmake command

mfdepinst command

COBOL to Service Interface Data Type Matches

User Interface Reference

Service Interface Projects

Add/Remove Items

Options - Service Interface

Properties - COBOL Program Service Interfaces

Interface Mapper

Operation Properties - General tab

Operation Properties - Path/HTTP tab

Operation Properties - User Exits tab

Operation Properties - API Resources tab

Operation Reorder

Generate Web Service dialog box

Runtime Environment Configuration

Runtime Environment Configuration - Deployment Characteristics tab

Runtime Environment Configuration - Program Execution tab

Runtime Environment Configuration - File Handling tab

Runtime Environment Configuration - Memory Management tab

Runtime Environment Configuration - COBOL Switches tab

Runtime Environment Configuration - Environment Variables tab

Mixed Language Programming with Native COBOL

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 Windows API Routines

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

H2cpy command-line options

Converting Header Files Using the H2cpy Utility

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 Calling a Win32 API Routine

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

Windows 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

.NET COBOL code considerations

Compilation options

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 Visual COBOL

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

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

DG Interactive COBOL Source Programs

Compatibility Directives

Compatibility with DG Interactive COBOL

Overview

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 Visual Studio

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 .NET 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 Visual Studio

Creating a Visual Studio Project for the RM/Panels Application

Set the DIALECT"RM" Compiler 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

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

User Interface Programming

Modernizing Dialog System Applications

Overview of Modernizing Dialog System Applications

Dialog System information and restrictions

Migrating a Dialog System Application to Visual COBOL

Enabling Microsoft's Visual Styles in Dialog System Applications

Changes to Existing Dialog System Applications that Use the Visual Styles

Modernizing a Dialog System Application

Samples of Modernizing Dialog System Applications

Sample: Windows Forms Replacing Dialog System Dialogs

Sample: Windows Forms Control as ActiveX for a Dialog System Application

Sample: WPF User Control in a Dialog System Application

Sample: .NET COBOL Dialog System Application

Sample: .NET COBOL Application and Windows Forms

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

OpenESQL Configuration Utility for Default SQL Cursor Behavior

Optimize for performance and mainframe compatibility

ANSI compliance

No change in default behavior and no optimization

Issue a warning at compile time

Issue an error at compile time

Database Connections

Managing Transactions

Setting OpenESQL Background Syntax Checking Options

Programming for OpenESQL

OpenESQL Assistant

Setting OpenESQL Assistant Options

Generating Code with MDCLGEN

Using OpenESQL Assistant

Starting the OpenESQL Assistant

Connecting to a data source

Building Queries

Generating initial query code

Selecting Columns

Specifying Aggregate Functions for Columns

Specifying Search Criteria

Specifying the Order in which Data is Retrieved

Creating a Table Join

Working with Queries

Display Column Details

Disconnect from a Data Source

Close a Query

Remove a Table from a SELECT Query

Changing a SELECT (cursor) query to do an Array FETCH

Testing Your SQL Queries

Embedding SQL into a program

Auxiliary Code

Generating EXEC SQL Auxiliary Code

Embedding Auxiliary Code

Generating EXEC ADO Auxiliary Code

Generated EXEC ADO Statements

Disconnected Model Statements

Connected Model Statements

EXEC ADO Wizards

Stored Procedures

Generating a TSQL Stored Procedure Query

Testing a TSQL Stored Procedure Query

Embedding a TSQL Stored Procedure into a Program

Generating a SQL CLR Stored Procedure Query

Testing a SQL CLR Stored Procedure Query

Working With OpenESQL Cursors and Result Sets

Working with Stored Procedures and Result Sets

Unicode Support in OpenESQL

OpenESQL Globalization Best Practices

Keywords

ODBC

Demonstration Applications

ODBC Drivers and Data Source Names

To start the ODBC Data Source Administrator

Using OpenESQL with ODBC

Managing Transactions

Positioned Update

SQL Error Mapping

XML Support

Using OpenESQL with Web and Application Servers

Thread Safety

Connection Management

Transactions

User Accounts, Schemas and Authentication

Transaction Wrapper Sample

ADO.NET

Demonstration Applications

ADO.NET Data Providers and Data Sources

ADO.NET Connection Editor

Connection Terminology

Cataloging an ADO.NET or ODBC Connection

Exporting and Importing Connections

Example Connection Settings

SqlClient Data Provider

DB2 ADO.NET

ADO.NET Connection Strings

Using OpenESQL with ADO.NET

Using Embedded EXEC ADO Statements

Disconnected Model Statements

Connected Model Statements

ADO.NET Cursor Statements

Sharing ADO.NET Objects Statements

Data Table Support in ADO.NET

.NET Host Variables in Managed Code

Disconnected and Offline DataSets

Compiling Native Applications as .NET COBOL Code

Migrating Pro*COBOL Applications to OpenESQL with ADO.NET

Stored Procedures with ADO.NET

XML Support

COBOL SQL Server Stored Procedures

Prerequisites for SQL CLR Integration

SQL CLR Integration Process

SQL Server Database Project Template

Working with .NET COBOL Projects

Data Type Parameters in COBOL and SQL CLR Stored Procedures

Stored Procedure Definition (SPD) File

COBOL Wrapper Programs

Transaction Support for SQL CLR Stored Procedures

Issuing COBOL Calls from within SQL CLR Stored Procedures

Optimizing Read-only Cursor Performance for SQL CLR stored procedures

Working with SQL CLR Stored Procedures on a Remote SQL Server Machine

Post-deployment Script Requirements

COBOL Program Migration Support

DB2

Demonstration Applications

DB2 External Compiler Module

Compound SQL

User Defined Functions

Extensions to Embedded SQL Support

The INCLUDE Statement

The DECLARE Statement

Qualified Host Variables

Host Variable Groups and Indicator Arrays

The NOT Operator (¬)

The Concat Operator (|)

SQL Communications Area

Support for Object Oriented COBOL Syntax

Support for Nested COBOL Programs

Compiling

Setting the DB2 ECM Preprocessor and Compiler Directive Options

Setting DB2 Background Syntax Checking Options

Connecting to a DB2 Database

DB2 Compiler Directive

Error Codes

Binding

Linking

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

COBSQL

Setting the COBSQL Preprocessor and Compiler Directive Options

Building COBSQL Applications

Using the CP Preprocessor to Expand Copybooks

National Locale Support (NLS)

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)

OpenESQL Assistant

To add a column to a query

To add all columns in a table to a query

To add an XML data source

To add or update a SQL CLR Stored Procedure

To change a SELECT (cursor) query to do an array FETCH

To close a query

To close the OpenESQL Assistant

To connect to a data source

To connect to a different data source

To create a table join

To create an SQL query

To create a SQL CLR stored procedure query

To create a TSQL stored procedure query

To disconnect from a data source

To display column details

To embed an SQL query into a program

To generate a DCLGEN copybook

To generate a DELETE statement

To generate a SELECT (cursor) statement

To generate a SELECT (singleton) statement

To generate a SELECT DISTINCT (cursor) statement

To generate a SELECT DISTINCT (singleton) statement

To generate a DECLARE DATATABLE statement

To generate an INSERT statement

To generate an UPDATE statement

To generate and embed auxiliary code

To perform an aggregate function

To refresh the list of data sources

To remove a table from a SELECT query

To run a query

To set OpenESQL Assistant options

To sort returned data (an ORDER BY clause)

To specify search criteria (a WHERE clause)

To start the OpenESQL Assistant

To view data source properties

ADO.NET Connection Editor

To add a connection

To view provider details

To export connections

To import connections

To remove a connection

To start the ADO.NET Connection Editor as an administrator

To start the ADO.NET Connection Editor as a user

To test a connection

SQL Server COBOL Stored Procedures

To create a SQL Server database project

To add a project reference to a .Publish project

To create a SQL CLR stored procedure query

To generate a SQL CLR stored procedure

To add or update a SQL CLR Stored Procedure

To create a stored procedure definition (SPD) file

To add a post-deployment script

To set project properties to build verifiable code

To generate a COBOL wrapper for a SQL CLR stored procedure

Reference

EXEC SQL Statement

OpenESQL

Embedded SQL Statements

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

Embedded ADO Statements

SQL Compiler Directive Options

BEHAVIOR

Primitive Directives

DBMAN Directive Settings

SQL/COBOL Data Type Mappings

OpenESQL Date and Time Environment Variables

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.

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.

COBES0129 Unrecognized SQLDA in SQL statement - try compiling with SQL(USER-SQLDA=option) directive

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.

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.

DSNTIAR and DSNTIAC

esqlconfig command

MDCLGEN command-line tool

MFImportConn command

User Interface Reference

OpenESQL Assistant

OpenESQL Assistant - Options

OpenESQL Assistant - Main Window

Select Type of Query to Create dialog box

Literal Value dialog box

Sort tab

Auxiliary Code tab

Data Source Properties dialog box

ADO.NET Connection Editor

ADO.NET Connection Editor - Main Window

Settings Menu

Add an ADO.NET Connection wizard - start page

Name Your Connection page

.NET Data Providers page

OLE DB Data Providers page

ODBC System DSNs page

Provider Connection Details page

Add ADO.NET Connection Finished page

Export ADO.NET Connections - start page

Select Connections to Export page

Specify an Export File page

Export Connections Wizard Finished page

Import ADO.NET Connections - start page

Select a File to Import page

Select Connections to Import page

Import Connections Wizard Finished page

Provider Information

DB2

DB2 Compiler Directive Options

CONCURRENTACCESSRESOLUTION

DB2 Environment Variables

HCOBND environment variable (deprecated)

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

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.

COBSQL

PREPROCESS(cobsql)

COBOL Directives

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 .NET COBOL code.

CSQL-I-049: Unable to support the SOURCETABSTOP directive, defaulting to 8

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

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 Command Line Prompt

Launching Data File Editor from the Start Menu

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, Filtering and Printing 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 in the Data File Editor

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

File Conversion Utilities

DFCONV Batch File Conversion

Operation

Command Line Batch Interface

The DFCONV call batch interface

Using the Data File Converter

File Format and Data Conversion

EBCDIC to ANSI Conversion

Mainframe to PC Print Conversion

Indexed File Reorganization

Defining File Conversion with a Profile File

Specifying the Conversion Operation

Specifying the Input File Parameters

Output File Specifications

General Conversion Information

Data File Converter Error Messages

Data File Structure Command Line Utility

DFSTRCL Prerequisites and Restrictions

DFSTRCL Inputs

DFSTRCL Command Line Syntax

DFSTRCL Examples

Example 1

Example 2

Example 3

Classic Data File Tools

Configuring Classic Data File Tools

Data File Converter

Input File Specifications

Output File Specifications

Character Set Conversion

Record Layout Editor

Data File Editor

Configuring the Data File Editor

Creating Data Files

Data File Types

Data File Profiles

Key Definitions for Indexed Files

Opening a Data File

Loading and Saving Data Files

Determining File Organization

Determining Record Lengths

Applying Record Layouts

Navigating Data Files

Searching a Data File

Creating and Editing Data

Editing Data

Cutting, Copying, and Pasting Data

Adding Records

Deleting Records

Changing the Key in an Indexed File

Initializing Data Records and Fields

Printing from a Data File

How to

To start Classic Data File Tools

To set Classic Data File Tools options

Data File Converter

To convert a data file

To define or change file details

To define record keys for an indexed data file

To apply a record layout to a file conversion

Record Layout Editor

To create a debug information (.idy) file for layout file input

To start the Record Layout Editor

To create a new record layout file

To load program information

To define record layouts

To define or edit a condition for a conditional layout

To edit an existing record layout file

To view layout information in the Layout Editor window

Data File Editor

To configure edit warnings

To create a data file

To define record keys for an indexed data file

To open a data file

To apply record layouts to a data file

To associate a record layout file with a data file

To view information

To select an alternate key

To search within a data file

To initialize a record

To initialize a field

To insert records

To cut, copy, and paste data

To undo a record edit

To append an ESDS record

To change a record length

To delete records

To print from a data file

To preview a data file

Reference

File Formats and Organizations

The Classic Data File Tools Command Line Utility

Using the Classic Data File Editor Command Line Utility

Command Line Examples

User Interface Reference

Data Tools Options dialog box

Data File Converter

Data File Convert dialog box

File Details dialog box

Key Information dialog box

Select Layout for Conversion dialog box

Record Layout Editor

Record Layout Editor window

New Record Layout wizard

Field Properties dialog box

Data File Editor

Data File Editor window

File Information dialog box

Create file dialog box

Key Information dialog box

Data File Editor dialog box

Print and Preview dialog boxes

Data File Find And Replace dialog box

Find on Current Key dialog box

Goto dialog box

Locate Field dialog box

Set record length dialog box

Rebuild

Redirection of Information

Command Line

Option Files

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 Visual COBOL

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

Line Continuation for Complex XFDs

XFD Directive Syntax

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

Stored Procedures

Developer- or Site-supplied Stored Procedures

Built-in Stored Procedures

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_EXTRA_DB_COLS_OK

4GL_FULL_DATA_TEST

4GL_IGNORED_SUFFIX_LIST

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_DB2_USE_SQLCOLUMNS

A_DB2_USE_SQLTABLES

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_ENCRYPT_CONNECTION

A_MSSQL_EXTRA_CONNECTION_INFO

A_MSSQL_FAILOVER_PARTNER

A_MSSQL_FAILOVER_PARTNER_SPN

A_MSSQL_FAST_ACCESS

A_MSSQL_GRANT_PERMISSIONS

A_MSSQL_GRANT_USERNAME

A_MSSQL_IDENTITY_TYPE

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_TRUST_SERVER_CERTIFICATE

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_MAX_COLUMNNAME_LEN

A_ODBC_MAX_TABLENAME_LEN

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 (no message associated with this error)

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

11 Stored procedures not found

12 A column of a key is of data type TEXT or IMAGE, which is illegal

12 DB2 library function returned an unexpected error

13 Illegal size or type of data for variable xxx

13 Internal error

14 More than one table with the same name

16 Trying to rename a table across databases

17 Cache error

18 Primary Key error

09/19 Table Size Error

20 (no message associated with this error)

21 (no message associated with this error)

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

Visual COBOL lock table missing

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

Stored Procedures

Sample XFD

sp_AcuInit stored procedure

sp_AcuRemoveUnusedLocks_1 stored procedure

sp_AcuTableReport_1 stored procedure

sp_AcuUserCount_1 stored procedure

sp_AcuZeroUserCount_1 stored procedure

tablename_delete stored procedure

tablename_insert stored procedure

tablename_read stored procedure

tablename_startnnn stored procedure

tablename_update stored procedure

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

Locking Files and Records

Example of Locking a File

Examples of Manual Record Locking

Examples of Automatic Record Locking

Examples of Single Record Locking

Examples of Multiple Record Locking

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

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

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

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

File systems and FILEMAXSIZE

File Systems

32-bit file systems

64-bit file systems

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

About CCISMEM

Using CCISMEM

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

Erasing a File String Record

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

Advanced Operation

Filename Mapping

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

Running Fileshare as a Windows Service

Fileshare Server Configuration

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

System Requirements

Types of Database

Database Permissions

Further Recommended Privilege and Role Permissions for Oracle Users

Method 1 - Using MFDBFH-specific roles

Method 2 - Proxy users

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 PostgreSQL Datastores Using Script Files

Using PostgreSQL

Configure Datastores for PostgreSQL

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 Db2 Datastores Using Script Files

Using Db2

Configure Datastores for Db2

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 Oracle Datastores Using Script Files

Using Oracle

Configuring Datastores for Oracle

Update the Configuration File for Oracle Datastores

Upload Files to an Oracle Datastore

Examples of the dbfhconfig Command Line Utility

The Database Configuration File

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

Accessing MFDBFH-Hosted Data from a Standalone COBOL Program

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

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

MFDBFH

MQSeries

Passing user credentials when connecting to an MQSeries queue manager

Multi-threaded Programming

Introduction to multi-threading

Multi-threading and the Operating System

Multi-threading and the Application

Multi-threading and the Command Line

Synchronizing Execution and Resolving Contention

Specifying No Multi-threading

Multi-threaded Program Attributes

Serial Programs

Reentrant Programs

Use of Data Attributes

Using Synchronization Primitives

Writing Multi-threaded Applications

Run-time System for Multi-threaded Applications

Considerations When Creating Reentrant Programs

Multi-threading Library Routines

Thread-control Routines

Thread-synchronization Routines

Routines for Handling Thread-specific Data

Initializing Applications

Manipulating Threads

Thread Handles

Creating and Terminating a Thread

Canceling a Thread

Suspending a Thread

Identifying a Thread

Threads in Other Languages

Canceling Called Programs

Optimizations and Programming Tips

Multi-threading in the .NET Framework

Multi-threading Compiler Directives

Directives for Serial and Reentrant Programs

Directives that Optimize Performance

Performance Programming

Benchmarking your Application

Troubleshooting Performance Issues

Optimizing COBOL Syntax

Optimizing Data Definitions

Speed of Processing of Different Data Types

Aligning Data Items for Efficiency

Optimizing IF Statements

Optimizing Decimal Point Alignment

Optimizing Data Structures

Optimizing Table Handling

Optimizing Conditional Statements

Optimizing PERFORM Statements

Optimizing CALL Statements

Optimizing Parameter Handling

Optimizing File Sorting

Aligning Bit Data Items

Compiler Directives for Optimizing Code

Examples

Example of Inefficient Use of the PERFORM Statement

Example of Optimized Subscripts to Table Elements

Optimizing Other Areas

Database Access

File Handling

Design Considerations

Optimizing File Selection

Optimizing Your Application Using the File Handler Configuration File

Problem Determination and Diagnostic Tools

The Micro Focus Unit Testing Framework

Unit Testing from the Command Line

Writing Tests

Elements of a Test Fixture

Data-Driven Unit Tests

Using Dynamic Metadata

Examples of using Metadata

MFUPP Preprocessor

MFUPP Directives

Inserting Test Code into Source Code

Mocking and Stubbing Source Code

Mocking and Stubbing Programs Containing EXEC Statements

Warnings and Restrictions

Examples of Using the MFUPP Preprocessor

Using MFUPP to Insert Test Code Into a Program

Appendix - Using the MFUPP Preprocessor

Using MFUPP to Mock and Stub a Program

Appendix - Mocking and Stubbing

Determining a Test Outcome

Examples - Writing Tests

Simple Test Case Example

Advanced Test Case Example

Data-Driven Test Case Examples

A Simple Data-Driven Test Example

Appendix - Simple Data-Driven Test Case Example

An Advanced Data-Driven Test Case Example

Appendix - Advanced Data-Driven Test Case Example

Compiling Tests

Running Tests

Configuring the Run-Time System Environment

Test Runner Syntax Options

Test Runner Error Codes

Using Color in Test Reports

Test Results Color Coding

Test Fixture Files

Example Test Fixture File

Example Ant Project

Unit Testing Support for .NET 6

Install the Unit Testing Templates

Using the dotnet Command Line Utility to Manage Unit Testing Projects

Appendix - dotnet arguments

Example - text file results

Viewing Test Results

Example - Microsoft Visual Studio Test Results File

Example - test results NUnit format

Using the Results in Silk Central

Using the Results on a Jenkins CI Server

Dealing with Errors in Your Tests

Unit Testing in the IDE

Best Practice for Organizing Projects

Creating Unit Test Projects and Tests

Types of Unit Test

Program Unit Tests

Data-Driven Unit Tests

Self-Contained Unit Tests

Create a Unit Test Project and Test Program for Existing Code

Project Configuration for Program Tests

Project Configuration for Data-Driven Program Tests

Project Configuration for Self-Contained Unit Tests

Create a Unit Test Project

Add a Test Program

Writing Tests

Elements of a Test Case

Unit Testing Code Snippets

Determining a Test Outcome

Test Output Examples

Example - Creating a Test Case

Running Tests in the IDE

Running Unit Tests

Debugging Test Cases

Micro Focus Unit Testing Framework

Programming Tips

Accessing Data on the Command Line from COBOL

Accessing Environment Variables from COBOL

Manipulating Data with Reference Modification and STRING

Writing Recursive Routines

Coding an Intrinsic Function

Manipulating Bits

Examples

Example of Recursion

Example of Recursive Routines

Example of Intrinsic Functions

Example of Bit Manipulation

General Reference

C Functions for Calling COBOL

COBOL Language Reference

COBOL Language Supported and Copyrights

Notations

Part 1. Concepts

Introduction to the COBOL Language

The COBOL Language

Source Format

Fixed Format

Concepts of the COBOL Language

Character Set

Language Structure

Separators

Character-strings

COBOL Words

Scope of Names

Conventions for Program-names

Conventions for Condition-names, Data-names, File-names, Record-names, Report-names and Typedef-names

Conventions for Index-names

Conventions for Class-names (for Object Orientation) and Interface-names

Conventions for Method-names

Conventions for Function-prototype-names

Conventions for Program-prototype-names

Literals

Figurative Constant Values

Constant-names

Concatenation Expressions

Special Registers

Predefined Object Identifiers

PICTURE Character-Strings

Formats and Rules

Concept of Computer-independent Data Description

Concept of Levels

Level-Numbers

Class and Category of Data

Algebraic Signs

Standard Alignment Rules

Item Alignment for Increased Object-code Efficiency

Selection of Character Representation and Radix

DISPLAY Format

COMPUTATIONAL, BINARY, or COMPUTATIONAL-4 Format

Computer Memory Natural Boundaries

Synchronization

Implicit Synchronization

Example of Implicit FILLER Assignments

Truncation

Example of Truncation

COMPUTATIONAL-1, COMPUTATIONAL-2,FLOAT-SHORT and FLOAT-LONG Formats

COMPUTATIONAL-3 or PACKED-DECIMAL Format

COMPUTATIONAL-X and COMPUTATIONAL-5 Formats

POINTER Format

POINTER-32 Format

PROCEDURE-POINTER Format

Uniqueness of Reference

Reference Modification

Identifier

Condition-name

Object property

Inline method invocation

Object-view

Data-address-identifier

Type of identifier

Program-address-identifier

Explicit and Implicit Specifications

Explicit and Implicit Procedure Division References

Explicit and Implicit Transfers of Control

Explicit and Implicit Attributes

Explicit and Implicit Scope Terminators

Language Fundamentals

Optional Division, Section and Paragraph Headings

Files

Sequential Input/Output

Record Sequential Input/Output

Line Sequential Input/Output

Organization of Line and Record Sequential Files

Access Mode

Relative Input/Output

Organization of Relative Files

Access Mode

Indexed Input/Output

Organization of Indexed Files

Access Mode

Sharing Mode

Object-oriented Concepts for Native COBOL

Objects and Classes (OO Concepts for Native COBOL)

Object References (OO Concepts for Native COBOL)

Predefined Object References (OO Concepts for Native COBOL)

Methods (OO Concepts for Native COBOL)

Method Invocation (OO Concepts for Native COBOL)

Conformance and Interfaces (OO Concepts for Native COBOL)

Conformance for Object Orientation in Native COBOL

Interfaces (OO Concepts for Native COBOL)

Conformance between Interfaces (OO Concepts for Native COBOL)

Conformance for Parameterized Classes and Parameterized Interfaces (Native COBOL)

Polymorphism (OO Concepts for Native COBOL)

Class Inheritance (OO Concepts for Native COBOL)

Interface Inheritance (OO Concepts for Native COBOL)

Interface Implementation (OO Concepts for Native COBOL)

Parameterized Classes (OO Concepts for Native COBOL)

Parameterized Interfaces (OO Concepts for Native COBOL)

Object Life Cycle (OO Concepts for Native COBOL)

Life Cycle of Factory Objects (OO Concepts for Native COBOL)

Life Cycle of Objects (OO Concepts for Native COBOL)

Life Cycle of Parameterized Classes (OO Concepts for Native COBOL)

Life Cycle of Parameterized Interfaces (OO Concepts for Native COBOL)

Object-Oriented Concepts for .NET COBOL

Attributes, Custom Attributes

Delegates and Events

Enumerations and Enum types

Extension Methods in .NET COBOL

Nested Classes in .NET COBOL

Data Types in .NET COBOL

Specifying Type Names

Simplified Class Layout

Run Unit Communication

Common, Initial and Recursive Attributes

Sharing Data

Sharing File Connectors

Data Division