Micro Focus Visual COBOL 3.0 for Eclipse (Windows)
Welcome
Existing Customers: Upgrading from an Earlier Release
New Features
New Features in Visual COBOL 3.0
Features Added in Visual COBOL 2.3 Update 2
Features Added in Visual COBOL 2.3 Update 1
Features Added in Visual COBOL 2.3
Features Added in Visual COBOL 2.2 Update 2
Features Added in Visual COBOL 2.2 Update 1
Features Added in Visual COBOL 2.2
Features Added in Visual COBOL 2.1 Update 1
Features Added in Visual COBOL 2.1
Features Added in Visual COBOL 2.0
Significant Changes in Behavior or Usage
New Customers: Where do I start?
New to Eclipse
New to COBOL
Upgrading from Net Express
Upgrading from Server Express
Want to deploy an application
Upgrading to Visual COBOL for Eclipse
Licensing Changes
Resolving conflicts between reserved keywords and data item names
Importing Existing COBOL Code into Visual COBOL
Recompile all source code
Upgrading from Studio Enterprise Edition (Windows)
Upgrading from Server Express
Advantages of Upgrading to Visual COBOL
Upgrading Your COBOL Application
Compile Your Existing Programs without a Project
Create a Project and Import Your Sources
Best Practice in Development Using Eclipse
Modernize Your Applications and Processes
Differences between Visual COBOL and Net Express, Server Express
Summary of Differences
Backward Compatibility with Earlier Micro Focus Products
Compiling and Building Differences
Output File Formats
Compiler directives
Linking
Called Programs and Dependencies
File Handler
Makefile Conversion
OpenESQL Assistant
SQL Compiler Directive Options
XML PARSE Statement
Run-time System Differences
OpenESQL
Single-Threaded Run-Time System
Static-Linked Run-Time System
Setting the environment on UNIX
Visual COBOL Co-existing with Earlier Micro Focus Products
Restrictions and Unsupported Features
CBL2XML Utility
Character-Mode Dialog System
DBMS Preprocessors
Dialog System
Form Designer
FSView
GNT Analyzer
Host Compatibility Option (HCO)
INTLEVEL Support
NSAPI
Online Help System
OO Class and Method Wizards
OpenESQL
Solo Web Server
SQL Option for DB2
Type Library Assistant
UNIX Publish
Run-Time Technology Differences
COM Interop
File Handling
Java and COBOL
Test Coverage
Editing and Debugging Differences
Data Tools
Debugging Native Object-Oriented COBOL
Mixed Language Debugging
Program Breakpoints
Remote Debugging
Source Pool View
Tips: Eclipse IDE Equivalents to IDE Features in Net Express
Upgrading from ACUCOBOL-GT
Upgrading from RM/COBOLĀ®
Procedural COBOL Compared with Managed COBOL
Overview of application development in Eclipse
Visual COBOL Tutorials Guide
Getting Started
Native COBOL Tutorials
Tutorial: Creating a Native COBOL Application
Creating a Project
Adding Source Code and Building the Project
Create a build configuration
Running the Application
Launch a Debug Session
Tutorial: Running Unit Tests in the IDE
Create a Workspace
Importing the AirportDemo Sample
Creating a Unit Test Project
Creating a Test Fixture
Running the Test
Running the Test Under Code Coverage
Enhancing the Test
Debugging the Failed Test
Fixing and Rerunning the Failed Test
Tutorials: Interface Mapping Toolkit
Set Build and Interface Mapper Preferences
Tutorial: SOAP Service Interface
Prerequisite
Demonstration Application
Create a Project
Create a Service Interface
Define Service Interface Operations
Create and Configure ESSOAP
Deploy a Service Interface
Generate a COBOL Client
Run the MakeCheckAppt Web Service
Tutorial: EJB Service Interface
Prerequisites
Demonstration Application
Create a Project
Create a Service Interface
Define Service Interface Operations
Configure ESDEMO
Deploy a Service Interface
Generate and Deploy a JSP Client
Deploy the Resource Adapter to JBoss
Run the JSP Client
Tutorial: REST Service Interface
Prerequisite
Demonstration Application
Create a Project
Create a Service Interface
Define Service Interface Operations
Create and Configure ESREST
Deploy a Service Interface
Generate a COBOL Client
Run the MakeCheckAppt Web Service
Tutorials: OpenESQL Assistant
Tutorial: Create a SQL Server Database
Tutorial: Create and Configure an Eclipse Project
Tutorial: Set OpenESQL Assistant Configuration Options
Tutorial: Catalog a Connection
Tutorial: Build and Test a Query
Tutorial: Generate and Embed an SQL Program
Tutorial: Provide Additional Code
Tutorial: Debug the Application
Tutorial: Data File Editor
Import and Build 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
Managed COBOL Tutorials
Tutorial: Creating a Basic JVM COBOL Application
Create a COBOL JVM Project
Create a Class and Build Your Project
Run the JVM Application
Debug the Application
Tutorial: Deploying JVM COBOL to an Application Server
Run-time Considerations
Restrictions
Install and Configure an Application Server
Configuring JBoss
Configuring WebLogic
Configuring WebSphere
Tutorial: Deploying an Enterprise JavaBean Containing JVM COBOL to a JBoss Application Server
Tutorial Prerequisites
Copying the Tutorial Files
Creating the Workspace
Importing the Project Files
Stepping through the Projects
The COBOL Project - TemperatureConverter
The EJB Project - TemperatureConverterEJB
The Dynamic Web Project - TemperatureConverterPrj
Deploying the JVM COBOL Run-time System within the Application
Deploying the Application
Showing the Server Status
Running the Application
Debugging the Application
Tutorial: SQL - Deploying an Enterprise JavaBean Containing JVM COBOL to a JBoss Application Server
Install and Configure a JDBC Driver
Create and Load a SQL Server Database
Modify COBOL Source
Deploy the COBOL JVM Runtime
Run the JSP Application
Tutorial: Calling JVM COBOL programs as part of an Axis Web service
Introduction
Prerequisites
Create a Web Service Description Language document
About the Web service description
Create the WSDL document using the editor
Setting the service endpoint
Create the addBook operation with parameters
Create the BookDetail type
Create the BookReturn type
Add the rest of the operations
Binding information
Validate the WSDL
Create the JVM project
Create the wrapper project
Create the dynamic Web project
Create a new project
Generate the server-side code
Add the bridge code
Configure the project
Update the BookLegacySkeleton class
Using JBoss
Configure for deployment
Include the class files
Export the content
Run the application
Use the Web Service Explorer
Debug the Web service
Web Services Tutorials
Tutorial: Reusing Existing COBOL Programs in a Java Web Services Environment
Introduction
Tutorial Project Goals
Setting Up the Tutorial Environment
Installing Apache Tomcat
Installing JBoss Application Server
Installing the IBM WebSphere Plug-in
Installing the Oracle WebLogic Plug-in
Copying the Tutorial Files
Creating the COBOL Components
Creating the JVM COBOL Project
Creating the Copybook File
Creating the COBOL Program
Setting the COBOL Compiler Directives
Adding the Data File
Creating the Java Components
Understanding Run Units and Sessions
Creating the Dynamic Web Project
Creating a JSP View
Creating the Java Bean
Converting Status Codes to Exceptions
Creating a Session Management Class
Creating the Servlet
The Servlet Deployment Descriptor
Running and debugging
Summary
Tutorial: Reusing Existing SQL Programs in a Java Environment
Install and Configure a JDBC Driver
Create a SQL Server Database and Connection
Modify COBOL Source
Modify Java Source
Add and Modify XML
Run the JSP Application
Modifications for DB2 LUW
Modifications for Oracle
Procedural COBOL Compared with Managed COBOL
Technology Preview Features
Managing Licenses
To activate Visual COBOL Personal Edition
To request and activate a 30-day trial license for Visual COBOL
To buy and activate a full license
To obtain more licenses
Product Information
Installation
Installing Visual COBOL for Eclipse (Windows)
Before Installing
Downloading the Product
System Requirements for Visual COBOL for Eclipse (Windows)
Hardware Requirements
Operating Systems Supported
Software requirements
Additional Software Requirements on Windows
Product Co-Existence
Installation Restrictions and Requirements
Basic Installation
Installing on Windows
Advanced Installation Tasks
Installing as an Upgrade
Visual COBOL Installation Options
Installing into other instances of Eclipse
Installing on Microsoft Terminal Server and Citrix
Customizing the Installation, the Workspace and the Projects
Enterprise Server Installation Options
Configuring SQL Option for DB2 (XDB) for Multi-User Environments
Creating a Private XDB Configuration File in a Multi-User Environment
Changing the Main XDB Server Configuration File
Changing the Private XDB Server Configuration Files in Batch
Configuring Other Components
After Installing
Configuring Visual COBOL
Installing X Windows on Windows
Repairing on Windows
Uninstalling
Installing Visual COBOL for Eclipse (UNIX)
Before Installing
Downloading the Product
System Requirements for Visual COBOL for Eclipse (UNIX)
Hardware Requirements for Visual COBOL for Eclipse
Operating Systems Supported
Software Requirements
Additional Software Requirements on Linux and UNIX
UNIX and Linux Installer Issues
Basic Installation
Installing the software
Setting up the environment
Starting the product
Advanced Installation Tasks
Installing as an upgrade
Installation Options
Installing Visual COBOL into other instances of Eclipse
RPM Installer
Using the RPM Installer
Other RPM Installer Options
Uninstalling Using the RPM Installer
Installing on Microsoft Terminal Server and Citrix
Customizing the Installation, the Workspace and the Projects
Enterprise Server Installation Options
Configuring SQL Option for DB2 (XDB) for Multi-User Environments
Creating a Private XDB Configuration File in a Multi-User Environment
Changing the Main XDB Server Configuration File
Changing the Private XDB Server Configuration Files in Batch
Configuring Other Components
After Installing
Configuring Visual COBOL
Configuring the Environment for Developing RDBMS Applications on UNIX
Repairing
Uninstalling
Installing Visual COBOL Development Hub
Installing Visual COBOL Development Hub
Before Installing
Downloading the Product
UNIX and Linux Installer Issues
System Requirements
Hardware Requirements
Operating Systems Supported
Software Requirements
Additional Software Requirements on UNIX
Basic Installation
Installing on UNIX
Advanced Installation Tasks
Installing as an Upgrade
UNIX Installation Options
RPM Installer
Using the RPM Installer
Other RPM Installer Options
Uninstalling Using the RPM Installer
After Installing
Setting up the product
Configuring the Remote System Explorer Support
Repairing on UNIX
Uninstalling
Managing Licenses
Overview
To start 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 on UNIX and Linux
Installing License Manager without Sentinel RMS
Standard installation
Silent installation
Setting up network licensing with COBOL server
Trial licenses
Commuter licenses
To obtain a commuter license
To return a commuter license
Usage log
Licensing Error Messages
Initialization error - Initializing: Cannot communicate with licensing daemon
Error - Initalizing: Cannot find initialization file
Error - Unable to manage licenses in license manager that is not running on localhost
Error [5]: Cannot talk to the license server on host "xxx.x.x.x". Server not running
Error authorizing... Remote request error - The authorization code is invalid
Error [26] - Request Denied due to clock tamper detection
Error[18]: No license code is available for feature (component)
Unable to authorize (cause)
Updates and Product Support
Micro Focus End User License Agreement
Backward Compatibility with Earlier Micro Focus Products
Known Issues and Restrictions
Calling COBOL Programs from C
COBOL Programming
Boolean Data Items
CBL2XML Utility
Interface Mapping Toolkit
Enhanced ACCEPT/DISPLAY Syntax (Adis)
Filenames
IDXFORMAT 8 and 12 File Size Limits
Unsupported Features
XML Extensions
Compatibility
Coexisting with earlier Micro Focus products
Microsoft SQL Server Express Edition
Installation
Data Access
Classic Data File Tools
COBSQL
DB2
File Handling
MySQL
OpenESQL
Records with Alternate Keys
Documentation
Application Server JCA Support
JVM Code
JVM COBOL support
Adding Projects to a COBOL JVM Project's Java Build Path
Editing Remote JRE Settings
OpenESQL
Using Java and JVM COBOL Together
Problem Determination and Diagnostic Tools
Debugging in Eclipse
Development Remote Connection
Error markers
Language Service
Remote Debugging
Test Coverage
Just-in-time debugging
Eclipse IDE
Background Parsing
Building Applications
Code Analysis
Eclipse Help Viewer
Editing Symbolically Linked Files
Installation
Java Support
Leaking File Handles
Micro Focus Unit Testing Framework
Remote Development
Refactoring
Standalone Files
WTP Tools
Issues with Application Workflow Manager
Issues with Remote Mainframe Development
UNIX and Linux Installer Issues
Contacting Micro Focus
Further Information and Product Support
Information We Need
Contact information
Sample Programs
To start the Samples Browser
Demonstrations of COBOL
Using the Command Line Demonstrations
Command Line Demonstrations of COBOL for JVM
Command Line Demonstrations of Native COBOL
Command Line Demonstrations of COBOL used with SQL
Command Line Demonstrations of COBOL used with Business Information Server (BIS)
Cheat Sheets
The Micro Focus Community
Help on Help
Developing Applications in the IDE
To start Visual COBOL
To start Visual COBOL as an administrator
To start a Visual COBOL command prompt
To start a Visual COBOL command prompt as an administrator
Introduction to Eclipse
Eclipse Basics
Workspaces
IDE Preferences
Projects
Selecting a Project Template
Remote Projects
Using the Windows and Menus
The Eclipse Welcome Page
Views
COBOL Views
Team Perspective Views
Perspectives
Menus and Toolbars
Controlling Views and Editors
Navigation Shortcuts
Creating Your First Hello COBOL World Application
Advanced Details
The Eclipse Resource System
Resources
Linked Resources
Configuring Projects
Properties
Project Build Path
Build Precedence
Inter-Project Dependencies
Copybooks
Including Files and Folders
Working Sets
Configuring the Hello COBOL World Application
Development Life Cycle
Adding Projects to Your Workspace
Adding Existing Source Files into a Project
Specifying Compiler Directives and Project Settings
Editing
Building
Running and Debugging
Debug the Hello COBOL World Application
Additional Eclipse Functionality
Configuring Eclipse
Micro Focus Builder Preferences
Build Directives for Standalone Editing
File Extensions
Using Eclipse for COBOL Development
Overview of Creating COBOL applications in Eclipse
COBOL Perspectives and Projects
Writing Code Efficiently in the COBOL Editor
Configuring AutoCorrect
Customizing the Editor
Configuring Background Parsing
Configuring Syntax Coloring
Configuring Smart Edit Mode
Editing Assistance in the COBOL Editor
Configuring Content Assist for COBOL Programming
Inserting and Removing 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
Using COBOL Code Templates
Searching using Micro Focus Search
Managing Large Projects
Viewing Copybooks in Context
Extracting COBOL code to a copybook
Creating COBOL Projects
Creating and importing COBOL projects
To create a COBOL project
To import an existing Eclipse project
Creating service interface projects
Converting Net Express projects to Eclipse projects
Creating and importing resources
To create a new file
To create a new file from a custom template
To import a file into a project
To import a copybooks into a virtual folder
To associate a file extension with COBOL
Using source files from outside your project
To create project dependencies
To remove project dependencies
To link to copybooks or sources outside the project
To create a project or a file from a custom template
Using custom project and file templates
To create a custom project template
To create a custom file template
To configure the IDE to use custom templates
Indicating Whether a File is a Copybook or a COBOL Program
Configuring the Project, Build Configuration and File Properties
Project Properties
Build Paths
Build Settings
Build Directives for Standalone Editing
File Extensions
Run-Time Configuration Properties
File Properties
To set file properties using directive scanning
Developing applications on remote machines
Creating connections to remote hosts
To create a connection to a remote host
To diagnose client-side problems when connecting to a remote host
Client-side connection tests
To diagnose server-side problems when connecting to a remote host
Server-side connection tests
To create a connection to a remote UNIX host running behind a firewall
To launch a server on the remote host
To launch a server on the remote host using a daemon process
To launch a server on the remote host without a daemon process
To launch a server on the remote host using a Secure Shell daemon process
Working with file systems on remote machines
Using Remote System Explorer (RSE)
Remote System Explorer logging
Using NFS
To verify that NFS is running
To set up an NFS server
To set up an NFS client
Using Samba
Creating remote projects
To create a remote COBOL project
To create a remote COBOL copybook project
To change the connection type of a remote project
To convert a local COBOL project to a remote COBOL project
Building COBOL applications
Compiling COBOL Applications
Compiling COBOL code
Compiled File Types
Compiling JVM COBOL
To Build a Project Using Apache Ant
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 in a Response to a Prompt
Setting Compiler Directives in Source Code
Setting Compiler Directives in a Directives File
Using Environment Variables
To specify environment variables for an application
Editing variables in the build environment
Removing variables in the build environment
To specify environment variables in a run configuration
Order in Which Copybooks are Searched For
Temporary Files Used when Compiling Native COBOL
Techniques for Compiling Quickly
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 (Windows)
Overview of Linking Native COBOL Applications and Run-time Systems
Shared Run-time System for Running Native COBOL Applications
Dynamically Binding Run-time Systems to Your Native COBOL Applications
Order of Program Loading 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
Specifying non-default link options in the IDE
Linking (UNIX)
Introduction to Linking
Linking and Linked File Types
Linking and Binding
Dynamic Loading
Specifying non-default link options in the IDE
To clean a project
Tips: Building COBOL projects
To set Compiler directives on a COBOL file
Code Coverage (Native COBOL)
Enabling Code Coverage
Running an Application with Code Coverage
Viewing the Code Coverage Information
Code Coverage HTML Reports
Configuring the Code Coverage HTML Reports
Code Analysis
Micro Focus Code Analysis Window
Rule-Based Analysis
Performing Code Analysis when Building a Project
Performing Code Analysis Manually
Performing Code Analysis from the Command Line
Performing Code Analysis as Part of a CI Process
Configuring Rule Sets
Importing Rule Sets in the IDE
Importing Code Analysis Reports
COBOL Source Information
Introduction
To run a CSI query
CSI Query Results
Query Information
Data Items
Complex Data Item Queries
Qualified Names
Example Data Item Queries
Procedures Paragraphs and Sections
Called Subprograms
Finding COBOL Verbs
Examples of COBOL Verb Queries
Special Queries
CALL - Special Queries
COPY - Special Queries
DEADDATA - Special Queries
LABEL - Special Queries
TIMES - Special Queries
UNDECL - Special Queries
UNEXEC - Special Queries
UNREF - Special Queries
Wildcards
Debugging COBOL applications
Overview of the process of debugging
Preparing a Project for Debugging
Compile for Debugging
Creating a Debug Configuration
COBOL Application, COBOL Attach to Process, and COBOL Wait for Application Attachment
COBOL Core Dump
COBOL Live Recording (Technology Preview)
COBOL JVM Application and COBOL JVM Remote Application
Preparing Remote Projects for Debugging
Debugging Features and Techniques in Eclipse
Views in the Debug Perspective
Using Breakpoints and Watchpoints
Debugging Commands and Options
Debugging in COBOL Copy View
Debugging Scenarios
Starting the Debugger Automatically
Starting the Debugger automatically using library routines
Starting the debugger automatically using just-in-time debugging
Debugging Windows Services
Debugging Using a Core Dump
Preparing for a core dump
To create a core dump
To debug a core dump
Debugging Using a Remote Machine
Remote debug of projects developed locally
Projects developed on a remote UNIX machine
Debugging Mixed Language Applications
Debugging Applications and Services on Enterprise Server
How Debugging on Enterprise Server Works
To prepare for debugging on Enterprise Server
To debug on Enterprise Server
To debug on a remote Enterprise Server
Debugging using a temporary enterprise server
Error Messages for Web Services
Debugging with Character Animator
Overview of Character Animator Functions
Working With Character Animator
The Character Animator Screen
Character Animator Screen Overview
The Information Line
Moving the Cursor and Text During Animation
Entering Text on Menus
Using the Character Animator Windows
Viewing Data
Key Functions for Updating Queried Data Items
Obtaining Help
Menus
Animator Main Menu
Breakpoints Menu
Environment Menu
Go Menu
Locate-declaration Menu
Perform-level Menu
Query Menu
Query Data-name Menu
Reset-execution Menu
Text Menu
Functions
Function Access
Function Descriptions
0-9
Align
Alter Path
Breakpoints
Cancel All Breakpoints
Cancel Program Break
Child Data
Clear
Cursor-name Locate
Cursor-name Query
Cursor-position Reset
Detach from application
Do
Do At Breakpoint
Down-table
Enter
Enter-name Locate
Enter-name Query
Environment
Escape
Examine Breakpoints
Exchange
Exit Perform
Find String
Go
Hex
Hex/ASCII
Hide Monitors
If Breakpoint
Join Text
Look-up
Monitor
Monitor-off
Next Reset
On Count Breakpoint
Organize Monitors
Parent Data
Perform-level
Perform-view
Query
Query Data-name
Quit-perform
Refresh
Reset-execution
Same Level
Scroll Up/Down (continuously)
Scroll Up/Down (one line)(Ctrl+<left-arrow>/<right-arrow>)
Select Program Break
Set Breakpoint
Split Text
Start
Step
Step Perform
Text
This Program Break
Thread-local Breakpoint
Un-set Breakpoint
Up Table
View
View Programs
View Threads
Where
Word Left
Word Right
Zoom
Zoom Breakpoint
Run-time System Error Messages
Directives for Character Animator
Directive Descriptions
COBAIF
END
MIXEDLANGDEBUG
MULTITHREAD
RESEQ
ZEROSEQ
Using COBANIMOPT
Cross-session Debugging
Using cobesdebug to Debug Services and Applications on Enterprise Server
How it works
How Enterprise Server finds a match
How to debug services and applications with Enterprise Server Dynamic Debugging
Code Refactoring
Rename Refactoring
Extracting COBOL code to a copybook
Running COBOL Applications
Configuring the Run-Time Behavior
To run a COBOL application on your local machine
To run an application on a remote machine
Programming
COBOL Programming
Getting Started with COBOL
Calling COBOL Programs
Specifying the Program to Be Called
Naming a Program in its PROGRAM-ID Paragraph
Entry Point Mapping for COBOL Programs
Calling a Program Using an Implicit Program Name
Calling a Program Using an Explicit Program Name
Calling Entry Points in Subprograms
Calling Programs According to How They Are Linked
State of the Data when a Program is Called Again
Search Conventions Used for Calling Programs
Passing Parameters to a Called Program
Passing Return Codes Back to the Calling Program
Call Prototypes
About Call Prototypes
The ANY Keyword
Relaxed Type-checking
Using Type Definitions
Using the Library Routine Type Definitions and Call Prototypes
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
UTF-16 Byte Ordering
National Literals
National Hexadecimal Literals
National Data Items
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
Multithreading
Preserving State
File Handling
Releasing Resources
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
Deploying Java Service Interfaces
Deploying to 64-bit Platforms
Deploying to an Enterprise Server under UNIX
Service Interface Deployment Package
Clients
COBOL Console Client
JSP Client
How to
Manage IMTK Projects
To create a COBOL program-based service interface
To modify the CLASSPATH property for an EJB service interface
To set Interface Mapper preferences
To validate a service interface
Define Service Interfaces
To assign a value to a COBOL field
To create a COBOL program-based operation
To create a reusable field
To create an interface field
To edit field properties
To group interface or reusable fields
To map an interface field
To start the Interface Mapper
Deploy Service Interfaces to Enterprise Server
To add or remove application files to deploy
To associate an enterprise server with a project
To compile a service driver program on a remote UNIX machine
To generate and deploy a service interface from a project
To deploy to a remote enterprise server
To deploy a service interface using imtkmake
To generate clients
To install a deployment package using mfdepinst
To redeploy a service interface
To set deployment properties
Reference
imtkmake command
mfdepinst command
COBOL to Service Interface Data Type Matches
User Interface Reference
Service Interface Projects
Advanced Settings
Mapping Properties - General Tab
Mapping Properties - Deployment Server Tab
Mapping Properties - Application Files Tab
Mapping Properties - EJB Generation Tab
Mapping Properties - J2SE Generation Tab
Mapping Properties - Mapping Properties Tab
New Java Interface Wizard
New REST Web Service Wizard
New SOAP Web Service Wizard
Username/Password
Interface Mapper
COBOL Assignment
Field Properties
Group Properties
Mappings
Operation Properties - General tab
Operation Properties - HTTP tab
Operation Properties - User Exits tab
Operation Reorder
Mixed Language Programming
Ordering Parameters to Pass to Non-COBOL Programs
Removing Parameters from the Stack
Storage Representation of Parameters
Aligning Parameters on Word and Double Word Boundaries
Handling Return Codes in Mixed Language Applications
Call Conventions for Interfacing with Mixed Languages
Building a Mixed Language Application
Interfacing with Assembler Subprograms
Interfacing with Windows API Routines
Interfacing with C Programs
Passing Data between C and COBOL
Header-to-COPY Utility
Overview
Examples
Converting Header Files Using the H2cpy Utility
H2cpy command-line options
H2cpy Translations
Translating Names
Using the Headers Preprocessor
Translating Directives
Preprocessor Directives
Expanding Macros and Creating String Literals
Translating Conditional Directives
Translating Other Directives
Translating Statements
External Data Declarations
Example - Translating External Data Declarations
Type Definitions
Example - Translating Type Definitions
Structure, Union and Enumerator Declarations
Example - Translating Named Declarations
Example - Translating Unnamed Declarations
Example - Translating Enumerator Declarations
Function Prototype Declarations
Example - Translating Function Prototype Declarations
Example - Translating C Calling Conventions
Call Parameters
Example 1 - Parameter Passing in C and in COBOL
Example 2 - Parameter Passing in C and in COBOL
H2cpy Limitations
Overview - H2cpy Messages
Warning Messages
* Warning, other return already defined for: name
* Warning, float has been evaluated as zero
* Warning, expression buffer overflow - ignored
* Warning, macro too long, ignored: name
* Warning, macro has too many parameters
* Warning, macro parameters too long - ignored
* Warning, neither whitespace nor ( after #define. Ignoring the line.
*Warning, redefinition ignored for #define
* Warning, struct/union 4 bytes (or 8) and passed by value cannot be directly accessed from COBOL
Error Messages - Command Line Errors
Error, command line too long
Error, no input C header file given
Error, too many input filenames
Error, macro name already defined
Error, exceeded max number of include directories, max=14
Error, unknown C type: name
Error, no C type alignment value
Error, no C type size value
Error, no call convention value provided
Error, unknown environment (not 16 or 32)
Error, unknown option - flag
Error Messages - Invalid C Source
Error, type expected, found name: name
Error, type expected
Error, typedef found at inner level; check brackets
Unexpected token token
Error, type expected
Error, type expected, found name
Error, no unique typedef name!
Error, already declared this name
Error, undeclared enum name
Error, already defined name: name
Error, already defined struct/union as: name
Error, other params already defined for : name
Error, declaration buffer overflow
Error, no unique declarator name!
Error, no unique parameter name!
Error, invalid C code (missing token)
Error, too many digits for 4 bytes in name
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 an Assembler Subprogram
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
Installing on Windows or UNIX
Introducing XML Extensions
What is XML?
COBOL as XML
XML as COBOL
Getting started with XML Extensions
Overview
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 EXPORT FILE
XML EXPORT TEXT
XML IMPORT FILE
XML IMPORT TEXT
XML TEST WELLFORMED FILE
XML TEST WELLFORMED TEXT
XML TRANSFORM FILE
XML TRANSFORM TEXT
XML VALIDATE FILE
XML VALIDATE TEXT
Document management statements
XML COBOL FILE-NAME
XML FREE TEXT
XML GET TEXT
XML PUT TEXT
XML REMOVE FILE
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 DISABLE CACHE
XML ENABLE CACHE
XML FLUSH CACHE
XML GET FLAGS
XML TRACE
XML GET STATUS-TEXT
XML SET ENCODING
XML SET 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
UNIX character encoding
FILLER data items
Missing intermediate parent names
Unique element names
Unique identifier
Sparse COBOL records
Copybooks
Statement definitions
REPLACE statement considerations
Displaying status information
Application termination
Anonymous COBOL data structures
Limitations
Data items (data structures)
Edited data items
Wide and narrow characters
Data item definitions and size
Data naming
OCCURS restrictions
Reading, writing, and the Internet
Optimizations
OCCURS DEPENDING
Empty occurrences
Cached XML documents
Managed code considerations
Compilation options
New XML statement
XML statement restrictions
XML considerations
XML and character encoding
Document type definition support
XSLT stylesheet files
Handling space 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
Table1.xml
Table2.xml
Table3.xml
Table4.xml
Table5.xml
Table6.xml
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
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
Embedded HTML
Enabling CGI support
EXEC HTML statement
Substitution Markers
EHTML Preprocessor
EHTML Preprocessor Directives
AUTOFORMAT (AF)
CONFIRM
DEBUG (D)
DEBUGFILE
OUT
PREPROCESS (P)
STEPEXEC
STEPHTML
TRACE
WARN
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 Managed 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$CALLEDBY
C$CALLERR
C$CHDIR
C$COPY
C$DELETE
C$FILEINFO
C$GetLastFileOp
C$JUSTIFY
C$LIST-DIRECTORY
C$LOCKPID
C$MAKEDIR
C$MEMCPY (Dynamic Memory Routine)
C$MYFILE
C$NARG
C$PARAMSIZE
C$REGEXP
C$RERR
C$RERRNAME
C$RUN
C$SLEEP
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
Windowing Error Messages
Windowing Supplementary Information
Compatibility with DG Interactive COBOL
Introduction
Compatibility Directives
DG
Compatibility with DG Interactive COBOL
Overview
DG Interactive COBOL Source Programs
Enhancing your Converted Application
Compatibility with DG Interactive COBOL Source
The DG Directive
Reserved Words
DG International Character Set
DG File Status and other Exception Values
Calls
Linkage Section Access
Arithmetic of Group Level Items
Run-time Switches
Program Identification and Data-names
Reformatting a DG COBOL Source File
Reformatting Rules
Compatibility with RM/COBOL
Converting RM/COBOL Applications
Configuring Your Application for Eclipse
Create a native Visual COBOL project
Set the DIALECT RM Compiler Directive for the Project
Import your RM/COBOL Source Code
Customizing the Reserved Words List
Add Adis Support to the Project
Add the RM/COBOL Keyboard Configuration
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
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
C$Century
C$ConvertAnsiToOem
C$ConvertOemToAnsi
C$DARG
C$Delay
C$GetEnv
C$GetLastFileName
C$GetLastFileOp
C$GetNativeCharset
C$LogicalAnd
C$LogicalComplement
C$LogicalOr
C$LogicalXor
C$LogicalShiftLeft
C$LogicalShiftRight
C$NARG
C$OSLockInfo
C$SecureHash
C$SetEnv
C$RERR
DELETE
RENAME
SYSTEM
RM/COBOL File Handling
Configuring Access to RM/COBOL Indexed Data Files
File Limits
RM/COBOL File Status Codes
Debugging JVM COBOL Using RM/COBOL Indexed Files
Enabling CTF to Trace RM/COBOL Data Files
Data File Utilities
Indexed File Recovery (recover1) utility
Recovery command
Recovery command options
Recovery process description
The four phases of processing
Recovery support module version errors
Recovery example
Recovery program error messages
RM/Panels
Restrictions and Limitations
Converting RM/Panels Applications
Conversion Example: Using Eclipse
Creating an Eclipse Project for the RM/Panels Application
Set the Dialect RM Directive for the Project
Download the Tutorial Files
Import the RM/Panels Source Code
Configure Adis Support for RM/Panels
Configure the Supported Copybook Extensions
Configure the Library File for Run Time
Build and Run the Application
Writing Programs
Standard Runtime Function Basics
Setting Runtime Parameters
Executing Standard Runtime
Required Copy Files
Error Detection
Screen Handling
Individual Field Method
Entire Screen Method
Event Loop Method
Using Multiple Panels
Standard Runtime Functions
Configurable Keys
ACCEPT FIELD
CHANGE PANEL PALETTE
CHECK MENU OPTION
CLEAR ALL FIELDS
DISABLE ALL FIELDS
DISABLE FIELD FOR INPUT
DISABLE MENU OPTION
DISPLAY ALL FIELDS
DISPLAY FIELD
DISPLAY PANEL
ENABLE ALL FIELDS
ENABLE FIELD FOR INPUT
ENABLE MENU OPTION
EXECUTE EVENT
INITIALIZE ALL FIELDS
INITIALIZE FIELD
POPUP MENU
REMOVE PANEL
SET FIELD ATTRIBUTE
SET SCROLL BAR RANGE
SHOW FIELD ERROR
SHOW FIELD HELP
SHOW PANEL ERROR
SHOW PANEL HELP
UNCHECK MENU OPTION
VALIDATE ALL FIELDS
VALIDATE FIELD
Utility Functions
DELETE TEMPORARY FILE
END MODELESS OPERATION
END POLLING
HIDE MOUSE CURSOR
SET COLOR
SET MONOCHROME
SHOW MOUSE CURSOR
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 Runtime 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
OO COBOL Class Library Reference
Data Access
Database Access
Accessing Databases from COBOL
Database Access Features
Database Access Preprocessors
Developing SQL Applications
Embedded SQL
Host Variables
Simple Host Variables
Host Arrays
Indicator Variables
Indicator Arrays
COBOL to SQL Data Type Mapping
SQL TYPEs
Cursors
Declaring a Cursor
Opening a Cursor
Using a Cursor to Retrieve Data
Closing a Cursor
Positioned UPDATE and DELETE Statements
Using Cursors
Data Structures
SQL Communications Area (SQLCA)
Using the SQLCA
The SQLCODE Variable
The SQLSTATE Variable
The Warning Flags
The WHENEVER Statement
SQLERRM
SQLERRD
COBSQL
DB2 LUW
The SQL Descriptor Area (SQLDA)
COBSQL
Oracle
Sybase
Informix
OpenESQL
Using the SQLDA
The PREPARE and DESCRIBE Statements
The FETCH Statement
The OPEN or EXECUTE Statements
The DESCRIBE Statement
Dynamic SQL
Dynamic SQL Statement Types
Execute a Statement Once
Execute a Statement More Than Once
Select a Given List of Data
Select any Amount of Data
Preparing Dynamic SQL Statements
Place Holders
Physical Location of PREPARE Statement
Executing Dynamic SQL Statements
EXECUTE IMMEDIATE Statement
FREE Statement (COBSQL Informix)
Dynamic SQL Statements and Cursors
CALL Statements
Example
Compiling SQL Applications
Specifying an SQL Preprocessor and Compiler Directive Options
Compiling Multiple Program Modules
Creating Debug Files
OpenESQL
OpenESQL Preprocessor Options
Setting the OpenESQL Preprocessor and Compiler Directive Options
SQL Code Generation Options
Scope - OpenESQL SQL Compiler Directive Options
OpenESQL DBMAN Use Case Scenarios
OpenESQL Datetime Data Type Handling
OpenESQL Fixed-length Character Strings Handling
SQL Syntax Checking with OpenESQL
SQL(CHECK) and Schema Objects
SQL(CHECK) Command-line Options
SQL Statement Prefixes for SQL(CHECK)
OpenESQL Embedded SQL Cursor Behavior and Performance
Embedded SQL Cursors in Older Applications
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
Programming for OpenESQL
OpenESQL Assistant
Setting OpenESQL Assistant Options
Using 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
Creating Temporary Files
Embedding SQL into a program
Auxiliary Code
Generating EXEC SQL Auxiliary Code
Embedding Auxiliary Code
Stored Procedures
Generating a TSQL Stored Procedure Query
Testing a TSQL Stored Procedure Query
Embedding a TSQL Stored Procedure into a Program
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
XML Support
Using OpenESQL with Web and Application Servers
Thread Safety
Connection Management
Transactions
User Accounts, Schemas and Authentication
Transaction Wrapper Sample
JDBC
Demonstration Application
JDBC Process
JDBC Resources
JNDI DataSource Objects
Database Connections
Connect Using a JNDI DataSource Object
Connect Using a JDBC Connection String
Sharing Database Connections Between Java and COBOL
Using OpenESQL with JDBC
Compiling JDBC Applications from the Command Line
Configuring the JDBC Run-time Environment
JVM Host Variables in Managed Code
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
Connecting to a DB2 Database
DB2 Compiler Directive
Error Codes
Building Applications
Stand-alone DB2 Applications
Client DB2 Applications and Stored Procedures
Building DB2 Applications with Eclipse
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
Building COBSQL Applications with Eclipse
Using the CP Preprocessor to Expand Copybooks
National Locale Support (NLS)
Troubleshooting
Common Problem Areas
Oracle Considerations
Oracle 8 (and later) Directives for COBSQL
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 close a query
To close the OpenESQL Assistant
To connect to a data source
To connect to a different data source
To create a complete program in a temporary file
To create a table join
To create a temporary file
To create an SQL 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 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 an INSERT statement
To generate an UPDATE statement
To generate and embed auxiliary code
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 a temporary file
To view data source properties
JDBC
To create a JVM COBOL project for JDBC
To install and configure Simple-JNDI
To create a JNDI DataSource object
To add JDBC resources to the JVM Build Path
To create a user library for JDBC resources
To import a user library
To export a user library
Reference
OpenESQL
Embedded SQL Statements
BEGIN DECLARE SECTION
BEGIN TRAN
BIND CONNECTION
CALL
CLOSE
COMMIT
CONNECT
DECLARE CURSOR
DECLARE DATABASE
DECLARE STATEMENT
DELETE (Positioned)
DELETE (Searched)
DESCRIBE
DISCONNECT
END DECLARE SECTION
EXECSP
EXECUTE
EXECUTE IMMEDIATE
FETCH
GET CONNECTION
GET DIAGNOSTICS
GET HDBC
GET HENV
GET NEXT RESULT SET
INCLUDE
INSERT
INTO
OPEN
PERSIST
PREPARE
QUERY ODBC
QUERY ODBC - Column Query
QUERY ODBC - Data Type Query
QUERY ODBC - Table Query
RESET CONNECTION
ROLLBACK
SAVEPOINT
SELECT DISTINCT (using DECLARE CURSOR)
SELECT INTO
SET AUTOCOMMIT
SET CONCURRENCY
SET CONNECTION
SET host_variable
SET OPTION
SET SCROLLOPTION
SET TRACELEVEL
SET TRANSACTION ISOLATION
SYNCPOINT
UNBIND CONNECTION
UPDATE (Positioned)
UPDATE (Searched)
WHENEVER
SQL Compiler Directive Options
ACCESS
ALLOWNULLCHAR
ANSI92ENTRY
ARRAYCHECK
AUTOCOMMIT
AUTOFETCH
BEHAVIOR
Primitive Directives
DEF_CURSOR
IC_FH_ISOLATION
PF_RO_CURSOR
PF_UPD_CURSOR
RO_CURSOR
TRANSACTION
UPD_CONCURRENCY
UPD_CURSOR
BIND
CHECK
CHECKDUPCURSOR
CHECKSINGLETON
CLOSE_ON_COMMIT
CONCAT
CONNECTIONPOOL
CTRACE
CURSORCASE
DATE
DATEDELIM
DB
DBMAN
DECDEL
DESCRIBEDTCHAR
DESCRIBEDTREC
DESCRIBEVARCHAR49
DESCRIBEVARCHARPICX
DETECTDATE
ESQLVERSION
FIPSFLAG
GEN-CC2
GEN-CLASS-VAR
GEN-HV-FROM-GROUP
GEN-INIT-FLAG
GEN-SQLCA
HSFTRACE
IGNORE-NESTED
IGNORESCHEMAERRORS
INIT
ISOLATION
JIT
JNDI
JNDIENC
MARS
NIST
NOT
ODBCTRACE
ODBCV3
OPTIMIZECURSORS
OPTION (deprecated)
OPTPER
PARAMARRAY
PASS
PICXBINDING
PRE
PREFETCH
QUALFIX
RESULTARRAY
SAVE-RETURN-CODE
SPDISPLAY
STMTCACHE
TARGETDB
TESTSQLSTATE
THREAD
TIME
TIMEDELIM
TRACELEVEL
TSTAMPSEP
USECURLIB
USER-SQLDA
XAID
DBMAN Directive Settings
JDBC Driver Classes
JDBC URLs
Sample DataSource Object Files
SQL/COBOL Data Type Mappings
OpenESQL Messages
SQLSTATE Values
SQLCODE Values
OpenESQL Preprocessor Error Messages
COBES0002 token is badly defined.
COBES0003 Program contains more than one definition of token
COBES0004 Nested or multi-source programs not allowed.
COBES0005 An error occurred when processing the internal dictionary.
COBES0006 No DB engine could be found.
COBES0007 Source file name is invalid.
COBES0010 OESQL rejected an unspecified option.
COBES0022 The directive SQL(DBMAN=ODBC) is not supported under Personal Edition.
COBES0023 The SQL(DBMAN) directive option is not supported with native applications.
COBES0024 The SQL(DBMAN) directive option is not supported with JDBC applications.
COBES0100 SQL incompatible with MAINFRAME
COBES0101 Statement is too long.
COBES0102 Statement contains too many host variables.
COBES0103 token does not have a suitable definition to be used as a host variable.
COBES0104 Bad SQL data declaration.
COBES0105 Syntax error.
COBES0106 Filename too long.
COBES0107 File token not found.
COBES0108 token is not unique and should be qualified.
COBES0109 token is not a data item.
COBES0110 Statement contains more than one SQLDA.
COBES0111 token is not a table of null indicator variables.
COBES0112 variable should not be defined with an OCCURS clause.
COBES0113 token should not be a subordinate to an item defined with an OCCURS clause.
COBES0114 Statement only allowed in the Procedure Division.
COBES0115 Statement not allowed in the Procedure Division.
COBES0116 An error occurred when processing the trace file.
COBES0118 Mismatched DECLARE.
COBES0119 Host variable name is too long.
COBES0120 Internal error - dictionary handle is too big.
COB ES0121 Compiler directive SQL (token1=token2) is invalid or badly sequenced - all SQL statements ignored.
COBES0123 Invalid ILTARGET - cannot use ILTARGET(ANYCPU) - must specify ILTARGET(X86) or ILTARGET(X64).
COBES0124 Host or Indicator Variable varname should not be defined in EXEC SQL statement using a subscript.
COBES0125 variable should be defined with an OCCURS clause.
COBES0130 Host variable host-var.group-var is part of a group variable expansion that is not supported in this type of SQL statement.
COBES0201 BEHAVIOR directive not valid unless TARGETDB directive of DB2, ORACLE, or MSSQLSERVER set first.
COBES0202 BEHAVIOR directive not set.
COBES0203 PREFETCH and BEHAVIOR directives are mutually exclusive - cannot set both.
COBES0205 Cannot set directive PF_RO_CURSOR > 1 if RO_CURSOR directive is set to IC_FH.
COBES0206 Cannot set directive PF_RO_CURSOR > 1 if RO_CURSOR directive is set to FORWARD and TARGETDB is MSSQLSERVER.
COBES0207 Cannot set directive PF_UPD_CURSOR > 1 if UPD_CURSOR directive is set to FORWARD.
COBES0208 Cannot set UPD_CURSOR directive to DYNAMIC if TARGETDB directive is set to ORACLE.
COBES0209 Cannot set UPD_CURSOR directive to STATIC if TARGETDB directive is set to MSSQLSERVER.
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
User Interface Reference
OpenESQL Assistant
OpenESQL Assistant - Options
OpenESQL Assistant - Main Window
Select Type of Query to Create dialog box
Query tab
Results tab
Details tab
Search Criteria tab
Literal Value dialog box
Sort tab
Auxiliary Code tab
Data Source Properties dialog box
DB2
DB2 Compiler Directive Options
ACCESS
ACTION
ALEBRA
APREUSE
BIND
BINDDIR
BGP
BLOCK
CALL_RESOLUTION
CASE
CCSIDG
CCSIDM
CCSIDS
CHARSUB
COLLECTION
COMMIT
CONCAT
CONCURRENTACCESSRESOLUTION
CONNECT
COPY
CTRACE
DB
DBPROTOCOL
DEC
DECDEL
DEFERRED_PREPARE
DEGREE
DISCONNECT
DYNAMICRULES
ENCODING
EXPLAIN
EXPLSNAP
EXTENDEDINDICATOR
FEDERATED
FEDERATED_ASYNCHRONY
FOR
FORMAT
FUNCPATH
GENERIC
GEN-HV-FROM-GROUP
GEN-INIT-FLAG
GEN-SQLCA
HCO
HOSTVAR
HSFTRACE
IGNORE-NESTED
IMMEDIATE
IMMEDWRITE
INIT
INSERT
ISOLATION
KEEPDYNAMIC
LANGLEVEL
LEVEL
MSGAREA
MULTI-NESTED
NOT
OPTPROFILE
OPTHINT
OPTPER
OS400NAMING
OWNER
PASS
PRE
QUALFIX
QUALIFIER
QUALIFY-CALL
QUERYOPT
RELEASE
REOPT
REPLVER
RETAIN
SAVE-RETURN-CODE
SORTSEQ
SQLERROR
SQLFLAG
SQLRULES
SQLWARN
STATICREADONLY
STRDEL
SYNCPOINT
SYNTAX
TEMPORAL-HISTORY
TEXT
TRANSFORM-GROUP
UDB-VERSION
VALIDATE
VERSION
XAID
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
COBSQLTYPE, CSQLT
CSTART, CST
CSTOP, CSP
DEBUGFILE, DEB
DISPLAY, DIS
END-COBSQL, END-C, END
HSFTRACE
KEEPCBL
KEEPCOMP
MAKESYN
SQLBGP
SQLDEBUG
STOPCHK
TRACE
VERBOSE
XAID
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 managed code.
SQL Data Types
Integer Data Types
Tiny Integer
Small Integer
Integer
Big Integer
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
DATE
DATETIMEOFFSET
TIME
TIMESTAMP
TIMESTAMPOFFSET
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
PIC X VARYING
ROWID Data Type
SQL TYPEs
BINARY
BLOB
BLOB-FILE
BLOB-LOCATOR
CHAR
CHAR-VARYING
CLOB
CLOB-FILE
CLOB-LOCATOR
DATE
DATE-RECORD
DBCLOB
DBCLOB-FILE
DBCLOB-LOCATOR
LONG-VARBINARY
LONG-VARCHAR
ROWID
TIME
TIME-RECORD
TIMESTAMP
TIMESTAMP-RECORD
TIMESTAMP-OFFSET
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 or Shell 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
Opening a Data Set in Enterprise Server
Enterprise Server Error Messages
Insert a Record
Edit an Unformatted Record
Edit a Formatted Record
Layout and Field Validation
Fix Validation Warnings
Edit a Record Using Hexadecimal Values
Delete a record
Profile Files
Viewing and Filtering Data Files
View File Information
Filtering a Data File
Filter the Data File
Filter Operators
Navigate a Data File
Show the Contents of a Data File in Hexadecimal
Select the Encoding for a Data File
Order a Data File using Indexed Keys
Backing Up Data Files
Back up a data file
Using the Classic Record Layout Editor
Create a Structure File and Record Layouts
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
Rebuild
Overview
Command Line
Option Files
Redirection of Information
Rebuild Options
Reorganizing Indexed Files
Rebuilding a Corrupt Indexed File
Converting a File
Validating an Indexed File
Rebuild through Fileshare
Callable Rebuild
Rebuild Examples
Configurable Codesets
The Codecomp Utility
The Codeset Mapping File Format
Supported Country Codes
How to...
To customize character set conversion
To change the current character set for command-line utilities
To install a CCSID table
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
Introduction
XFD Directive Syntax
Line Continuation for Complex XFDs
Supported XFD Directives
Invalid Data
Illegal COBOL Data
Invalid Key Data
Invalid Data Other Than Keys
Invalid Database Data
Working with COBOL
Examples of Preparing and Compiling a Program
Example 1 - Compiling with just the CREATEXFD directive
Example 2 - Compiling with the WHEN XFD Directive
Example 3 - Using Additional XFD Directives
New and Existing Databases
Default Behavior
Accessing Existing Database Files
How Do I Match Existing Text Fields?
How Do I Match Existing Numeric Fields?
Field Names
Resolving Name Conflicts
File Handling Configuration
Configuring the File Handler
Run Time System Configuration
ACUFH Configuration Variables
Database Connectors for DB2
DB2 Concepts Overview
Transactions
Record-locking Issues in Transactions
Database Connectors and Record Locking
Client Configuration
Setting Up the User Environment
Designating the Host Data Source
Configuring the File Handler
Filename Translation
Decimal Points
ACUFH Configuration File Variables for DB2
Record and Table Locking
Limits and Ranges
Data Type Mapping
Run-Time System Errors
Common Questions and Answers
Database Connectors for Oracle
Oracle Concepts Overview
Transactions
Record Locking Issues in 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
Setting Up the User Environment
Configuring the File Handler
Setting Up the Search Path
Handling Transactions
Filename Translation
ACUFH Configuration File Variables for Oracle
Using the Database Table
Unsupported Features
Limits and Ranges
Data Type Mapping
Run-Time System Errors
Common Questions and Answers
Database Connectors for Microsoft SQL Server
Microsoft SQL Server Concepts Overview
Client Configuration
Installing the Server and Client Machine
Setting Up a User Login
Setting Up the User Environment
Configuring the File Handler for
Filename Translation
ACUFH Configuration File Variables for MSSQL
Using the Database Table
Table Locking
Stored Procedures
Developer- or Site-supplied Stored Procedures
Built-in Stored Procedures
Limits and Ranges
Supported Data Types for SQL Server
Run-Time System Errors
Common Questions and Answers
Performance and Troubleshooting
Performance Issues
Guidelines
Guideline 1 - Database Administrator
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_2000_CUTOFF configuration variable
4GL_8_DIGIT_CUTOFF configuration variable
4GL_COLUMN_CASE configuration variable
4GL_COMMIT_COUNT configuration variable
4GL_CONVERT_DATE_ZERO configuration variable
4GL_DB_MAP configuration variable
4GL_EXTRA_DB_COLS_OK configuration variable
4GL_FULL_DATA_TEST configuration variable
4GL_IGNORED_SUFFIX_LIST configuration variable
4GL_ILLEGAL_DATA configuration variable
4GL_JULIAN_BASE_DATE configuration variable
4GL_USEDIR_LEVEL configuration variable
4GL_WHERE_CONSTRAINT configuration variable
A_DB2_ALTERNATE_COMMIT_LOGIC configuration variable
A_DB2_CATALOG configuration variable
A_DB2_DATASOURCE configuration variable
A_DB2_ERROR_MAP_FILE configuration variable
A_DB2_ISOLATION_LEVEL configuration variable
A_DB2_LOCK_METHOD configuration variable
A_DB2_LOGIN configuration variable
A_DB2_PASSWD configuration variable
A_DB2_STRICT_EQUAL configuration variable
A_DB2_TABLE_TYPES configuration variable
A_DB2_USE_CATALOG configuration variable
A_DB2_USE_CHAR_FOR_BINARY configuration variable
A_DB2_USE_SQLCOLUMNS configuration variable
A_DB2_USE_SQLTABLES configuration variable
A_MSSQL_ADD_IDENTITY configuration variable
A_MSSQL_ADD_TIMESTAMP configuration variable
A_MSSQL_APPROLE_NAME configuration variable
A_MSSQL_APPROLE_PASSWD configuration variable
A_MSSQL_CURSOR_OPTION_1,2,3 configuration variables
A_MSSQL_DATABASE configuration variable
A_MSSQL_DEADLOCK_LOOPS configuration variable
A_MSSQL_DEFAULT_CONNECTION configuration variable
A_MSSQL_DEFAULT_OWNER configuration variable
A_MSSQL_FAST_ACCESS configuration variable
A_MSSQL_LIMIT_DROPDOWN configuration variable
A_MSSQL_LOCK_DB configuration variable
A_MSSQL_LOGIN configuration variable
A_MSSQL_MAX_CHARACTERS configuration variable
A_MSSQL_MAX_COLUMNS configuration variable
A_MSSQL_NO_23_ON_START configuration variable
A_MSSQL_NO_CACHED_READ configuration variable
A_MSSQL_NO_COUNT_CHECK configuration variable
A_MSSQL_NO_DBID configuration variable
A_MSSQL_NO_RECORD_LOCKS configuration variable
A_MSSQL_NO_TABLE_LOCKS configuration variable
A_MSSQL_NT_AUTHENTICATION configuration variable
A_MSSQL_PACKETSIZE configuration variable
A_MSSQL_PASSWD configuration variable
A_MSSQL_ROWCOUNT configuration variable
A_MSSQL_SELECT_KEY_ONLY configuration variable
A_MSSQL_SEPARATE_LOCK_CONN configuration variable
A_MSSQL_SKIP_ALTERNATE_KEYS configuration variable
A_MSSQL_TRANSLATE_TO_ANSI configuration variable
A_MSSQL_UNLOCK_ON_EXECUTE configuration variable
A_MSSQL_USE_DROPDOWN_QUERIES configuration variable
A_ORA_DATABASE configuration variable
A_ORA_HINTS configuration variable
A_ORA_MAX_FILE_CURSORS configuration variable
A_ORA_NLS_SORT configuration variable
A_ORA_WAIT_LOCK configuration variable
A_ORACLE_ERROR_FILE configuration variable
COMMIT_COUNT configuration variable
FILE_TRACE configuration variable
FILE TRACE FLUSH
ORA_LOGIN configuration variable
ORA_PASSWD configuration variable
USER_PATH (for Oracle) configuration variable
USER_PATH (for DB2) configuration variable
XFD_DIRECTORY configuration variable
XFD_MAP configuration variable
XFD_MAP_RESETS configuration variable
XFD_PREFIX configuration variable
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
COMMENT XFD directive
DATE XFD directive
FILE XFD directive
NAME XFD directive
NULL 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
Example of Data and Key Compression
External Files
Example External Files
File Handler
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 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
Example of Displaying File Status Codes
Example of Checking File Status Codes
Example of Extended File Status Codes
Indexed Files
Example of Indexed File Definition
Example of Primary Key Definition
Example of Alternate Key Definition
Example of Duplicate Key Definition
Example of Sparse Key Definition
Example of Indexed File Access Definition
Example of Creating Fixed-length Records
Example of Creating Variable Length Records
MFSORT
Example Mfsort Command Line
Example Mfsort Fields Instruction
Example Mfsort Key Instruction
Example Mfsort Instruction File
Rebuild
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
Example Relative File Definition
Sequential Files
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
Overview
Micro Focus File Handler
File Organizations
Overview
Sequential Files
Record Sequential Files
Line Sequential Files
Printer Sequential Files
Relative Files
Indexed Files
Primary Keys
Alternate Keys
Duplicate Keys
Sparse Keys
Indexed File Access
Fixed-length and Variable-length Records
File Headers
Filenames
Filename Conventions
Assigning Filenames
Static Filename Assignment
Dynamic Filename Assignment
External Filename Assignment
Library Names in Paths
Filename Mapping
Multiple Paths
Library Names
Assigning Device Names
Setting Up Pipes
Output Pipes
Input Pipes
Two-way Pipes
File Status
What is File Status?
Defining a File Status Data Item
File Status Conventions
ANSI'85 File Status
ANSI'74 File Status
File Status Conversions
Extended File Status Codes
Sharing Files
Sharing mode
Record Locking
Manual and Automatic Record Locking
Manual Record Locking
Automatic Record Locking
Single and Multiple Record Locking
Single Record Locking
Multiple Record Locking
Handling Record Locks
Releasing Record Locks
File Status Codes
File Handler Configuration
Configuration File
Configurable Behavior
Large Indexed Files
File Striping (deprecated)
Headers in Striped Files (deprecated)
Options (deprecated)
MAXSTRIPEDIGITS (deprecated)
MAXSTRIPEFILES (deprecated)
MAXSTRIPESIZE (deprecated)
STRIPE-X (deprecated)
STRIPENAMETYPE (deprecated)
STRIPING (deprecated)
Examples (deprecated)
Performance
File Handler and Sort APIs
Calling the File Handler
Overview
Data Structures
File Control Description (FCD)
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 Module
Compression Routines
Sort Module
Sort Utilities
Introduction
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
Input Data
Mfsort Command
Output
Workfile
Error Messages
Data and Key Compression
Data Compression
Key Compression
Compression of Trailing Nulls
Compression of Trailing Spaces
Compression of Leading Characters
Compression of Duplicate Keys
Example of Using Data and Key Compression
Compression Routines
Micro Focus Compression Routines
Calling a Micro Focus Compression Routine
User-supplied Compression Routines
Tracing File Operations
Introduction
Configuring Tracing and Logging
Dynamic Tracing
Using the FCD to Control Tracing
Using Library Routines to Control Tracing
Trace Player
Run the Trace Player from the Command Line
Examples
File Systems
32-bit file systems
64-bit file systems
File systems and FILEMAXSIZE
Fileshare Guide
Introduction
Overview
How Fileshare Works
Standard Operation
Fileshare Client
Specifying the Fileshare Server
As a Filename
In a Configuration File
Specifying the Communications Protocol
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
Using UNIX named pipes: ccinampu
Logging Fileshare Messages: CCI Trace
Using Multiple Protocols with Test Programs
Configuring the CCI Timeout
Database Integrity
Transaction Processing
Automatic Record Lock Timeout
Transaction Processing - Fileshare Client
Transaction Processing - Fileshare Server
Recovery Logging
Basic Recovery Logging
Advanced Recovery Logging
Enabling Advanced Recovery Logging
Fileshare Exit Procedure - fsexitproc.cbl
Viewing the Log Files
Fileshare Recovery
Basic Rollforward Recovery
Advanced Rollforward Recovery
Advanced Rollback Recovery
Database Sequence Numbering
Database Sequence Numbers - Fileshare Server
Database Backup and Recovery
Automatic Database Backup and Rollforward Recovery
Hot Backups
Running a Hot Backup
Database Reference File Maintenance
Recovery Log File Records
Disk Space Warning (/p)
Flushing the Log File (/lc)
Erasing a Log File Record (/e)
Example
Filename Record
Alternative Filename (/af)
Virtual File Handler (/ap)
Data and Key Compression (/k)
Disable Logging (/o l)
Disable Database Sequence Numbering (/o s)
Disable Transaction Processing (/o t)
Erasing a Filename Record
Examples
File String Record
Erasing a File String Record
Example
Backup Folder Record
Best Practices for Backup and Recovery
Best Practices Basic Logging
Best Practices Advanced Logging
Security
Password System
Fileshare Client
Fileshare Server
Writing Your Own FHRdrLngPwd Module
Logon Validation Module
File Access Validation Module
Password File Maintenance
User-ID Groups
Supervisor Mode
Advanced Operation
Running Fileshare as a Background Process
The NFILES Setting
Single User Mode
Filename Mapping
Fileshare Server
Data and Key Compression
Data and Key Compression - Fileshare Server
Virtual File Handler Interface
Fileshare Server
Monitoring Fileshare
Fileshare Manager
Fileshare Manager Configuration
Byte-stream I/O Calls
FS_LOCATE_FILE
FS_SPLIT_FILENAME and FS_JOIN_FILENAME
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-S to FS252-S
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
Using COBOL and Java Together
Java and COBOL Interoperability Options
Considerations
Setting Up the Environment for Java and COBOL
Java/COBOL Application Launcher
Using the Java/COBOL Application Launcher from the Command Line
Using the Java/COBOL Application Launcher from the Eclipse IDE
Compiling COBOL Programs that Call Java
Compiling COBOL Programs that Are Used from the CobolBean interface
Linking to the Multi-threaded Run-time System
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 OO COBOL
Overview of Calling Java from 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 OO COBOL from Java
Overview - Calling OO COBOL from Java
Before You Start
Writing a Java Class in 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
Overview
Java Data Type Conversion Rules
Java Typedefs
Using the Jarray Class
Adding Parameters Using ParameterList()
Using Structures
Creating Custom Records using com.microfocus.cobol.lang.CustomRecord Interface
JVM COBOL Interoperating with Java
Java Calling JVM COBOL
Example of Java Calling JVM COBOL
JVM COBOL Calling Java
Example of JVM COBOL Calling Java
JVM COBOL Passing Java Instances to Native Procedural COBOL
JVM COBOL Passing Java Instances to Native Object COBOL
Managed COBOL Programming
Managed COBOL Programming
Introduction to Object-Oriented Programming for COBOL Developers
Native COBOL compared with managed COBOL
Compiling and Calling JVM COBOL Applications as Part of a Package
Producing a Java Property File
Example 1: Locating the Java Property File on the CLASSPATH
Example 2: Locating the Java Property File Directly from COBOL
64-bit applications in the Java environment
Multiple user COBOL applications in Java
Background to multiple run units and Java
Developing an application for multiple run units in Java
Moving Native COBOL Applications to Managed COBOL
What is Managed Code?
Why Move to Managed Code?
Considerations When Moving to Managed Code
Writing Multi-User Applications
Using Java Managed Beans to Manage and Monitor COBOL Applications
Accessing Procedural COBOL From Managed Code
Example of Using a Managed COBOL Wrapper Class
Example of Using the ILSMARTLINKAGE Compiler Directive
Interoperability
Data Marshaling and Type Conversion for Managed Code Interoperation
Type Compatibility in Interoperation with Managed Code
Exposing COBOL Linkage Data as Managed Types
Type Mappings from Native COBOL to Managed Code
Write a Proxy or Edit the COBOL for Managed Interoperation?
JVM COBOL Interoperating with Native COBOL
Calling Native COBOL from JVM COBOL
Passing Parameter Modes for JVM COBOL Calling Native COBOL
Pointers from Native Code to JVM COBOL
Strings in JVM COBOL Interoperation
Arrays of Bytes in JVM COBOL Interoperation
Limitations in JVM COBOL Interoperability
Example of JVM COBOL Interoperation with Native Code
JVM COBOL Interoperating with Java
Java Calling JVM COBOL
Example of Java Calling JVM COBOL
JVM COBOL Calling Java
Example of JVM COBOL Calling Java
JVM COBOL Passing Java Instances to Native Procedural COBOL
JVM COBOL Passing Java Instances to Native Object COBOL
Mixed Language Programming
Storage Representation of Parameters
Handling Return Codes in Mixed Language Applications
Call Conventions for Interfacing with Mixed Languages
Avoiding data name conflicts
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
Introduction
Multi-threaded Program Attributes
Specifying No Multi-threading
Serial Programs
Reentrant Programs
Use of Data Attributes
Using Synchronization Primitives
Using a Mutex
Using a Monitor
Using a Semaphore
Using an Event
Writing Multi-threaded Applications
Overview
Run-time System for Multi-threaded Applications
Thread Safety
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 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
COMP-5 Performance
COMP-X Performance
COMP Performance
COMP-3 Performance
DISPLAY Performance
Aligning Data Items for Efficiency
Optimizing Arithmetic Statements
Optimizing IF Statements
Optimizing Decimal Point Alignment
Optimizing Exponential Operations
Initializing Data Items
Optimizing Data Manipulation and Reference Modification
Optimizing Data Structures
Optimizing Table Handling
Optimizing Conditional Statements
Optimizing Logical Operations
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
Example of Optimizing USAGE DISPLAY Subscripts
Optimizing Other Areas
Database Access
File Handling
Design Considerations
Optimizing File Selection
Optimizing Your Application Using the File Handler Configuration File
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
Overview
Terminology
Scenarios for Using Jenkins
Software Requirements
Installing and Configuring Jenkins
Advanced Configuration
Configuring Email Reporting
Using Sources from Source Control
Triggering Builds Automatically
Creating Environment Variables
Using Agents
Using Jenkins to Build COBOL Applications
Setting up the Environment
Making mfant.jar Available to Enable Building
Specifying the Location of Linked Folders
Examples
Example - 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
Problem Determination and Diagnostic Tools
Protection Violations
Overview - Protection Violations
What Are Protection Violations?
General Protection Violations
COBOL Protection Violations
Unflagged Protection Violations
Correcting Protection Violations
Errors in Non-COBOL Portions of an Application
Parameter Mismatches in a CALL Statement
Stack Overflow
Illegal Reference Modification
Illegal Values for Pointers
Subscript Out of Range
Incorrect Linking Options or Procedures
Debugging Techniques
Consolidated Tracing Facility
To enable CTF tracing
To enable CTF tracing of a web application
CTF Trace File Formats
CTF Viewer
Annotation Files for CTF Events
Bookmarks in the CTF viewer
To create and load a binary trace file into the CTF Viewer
To search in the CTF Viewer
To enable your annotation files in the CTF Viewer
CTF Perspective
Components Traced by CTF
mf.cci Properties
mf.idmr Properties
mf.mffh.fs Properties
mf.mffh.xfh Properties
mf.mffh.xsm Properties
mf.rts Properties
CTF Configuration File
mftrace.application
mftrace.comp.component-name#property
mftrace.dest
mftrace.dest.component-name
mftrace.emitter.emitter-name#property
mftrace.level
mftrace.level.component-name
mftrace.time
Example CTF Configuration Files
CTF Emitter List
BINFILE Emitter Properties
IDEDBG Emitter Properties
JAVALOGGER Emitter Properties
TEXTFILE Emitter Properties
WINEVENT Emitter Properties
CTF Tracing Examples
Profiler
Enabling Profiler
Configuring the Profiler Reports
Running Your Application with Profiler
Profiler Output
Time Spent in Called Programs
The Micro Focus Unit Testing Framework
Unit Testing from the Command Line
Writing Tests
Elements of a Test Fixture
Using Dynamic Metadata
Examples of using Metadata
Determining a Test Outcome
Examples - Writing Tests
Simple Test Case Example
Advanced Test Case Example
Compiling Tests
Running Tests
Configuring the Run-Time System Environment
Test Runner Syntax Options
Test Fixture Files
Example Test Fixture File
Example Ant Project
Examples
Viewing Test Results
Example - text file results
Example - junit results
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
Organizing your Workspace
Creating Tests
Create a Unit Test Project
Create a Native Test Fixture
Writing Tests
Elements of a Test Case
Unit Testing Code Templates
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
Application Workflow Manager
What is AWM?
Workflow Manager Modeling Guide
About This Guide
Who Should Read This Guide?
Preconditions
List of Abbreviations
Overview
Introduction to the Data Model
Function Package
Element Type
Linked Element Type
Container Element Type
Element List Structure
Filter Type
Property
Linked Properties
Action Descriptor
Tool Descriptor
Data Model Details
Action Descriptor
Relationship: Action Has Tool
Parameter Override
Table Structure
Table View ID
Linked Element List
Mass Processing Overview
Related Save-/Close Action
Key Binding
Application Options
Relationship: Application Options Have Specific Attributes
Relationship: Application Options have Application Actions
Element List Structure
Relationship: Element List Has Action
Relationship: Element List Has Column
Element Type
Relationship: Get All Properties Action
Relationship: Element Has Get Children Action
Relationship: Element Has Action
Relationship: Element Has Filter
Relationship: Element Has Property
Relationship: Element Has Text Decoration
Relationship: Text Decoration Has Decoration Value
Enabled/Visible Condition
File Descriptor
Relationship: File Descriptor Has Property
Relationship: File Descriptor Has Action
Filter Type
Relationship: Filter Has Action
Relationship: Filter Has Filter Criterion
Global Action
Global Action is an Editor Action
Global Action is a Workbench Action
ID Definition
ID Has Key Property
Icon
Property
Special Properties
Date Format
Property Dependent Values
Retrieve All Values
Tool Descriptor
Relationship: Tool Has Input Parameter
Relationship: Tool Has Output Parameter
Tool-defined Resource Operations
Variable References
Tree View Label Determination
Setting up the Application Workflow Model
The AWM Model Editor
Creating an AWM Model
Validating an AWM Model
Context Menu Actions in the AWM Model Editor
Modeling Function Package Features
Groups in the AWM Model Editor
Drag & Drop Support in the AWM Model Editor
Copy Model Objects within the Same AWM Model
Create Object Relationships within the Same AWM model
Copy Model Objects between Different AWM Models
Search Function in the AWM Model Editor
Setting up and Configuring AWM
Master Configuration
Local Master Configuration
Defining Default Configurations
Integrated Visual COBOL Projects Application
Customizing the Integrated Visual COBOL Project Model
Default Configurations File Location
Setting Java System Variables
Default Configurations File Syntax
Default AWM Systems
Default Configuration Extensibility
Function Packages
AWM Function Package
Tool Types for the AWM Function Package
Cleanup Edit Session
Clear Application File Cache
Clear Error Feedback Entries
Create Persistent File
Create Static Element List
Create Temporary File
Locate Persistent File
Merge Structured Files
Open Modeled Dialog
Relationship: Open Modeled Dialog Has Table Row Selection
Input Dialog
Dialog Tables
Input Dialog Mass Processing
Output Dialog
The "UI Category" Attribute
Validate Action
Process Error Feedback
Refresh Children
Return Property Value
Set Linked Properties
Transfer File
Validate Line Length
Validate Value
Icons for the AWM Function Package
Example Scenarios for the Usage of AWM Tool Types
Eclipse Function Package
Attributes for the Eclipse Function Package
Linked Element Types for the Eclipse Function Package
Eclipse Resource
Drag and Drop Handling for Linked Eclipse Resources
Linked Properties for the Eclipse Function Package
Tool Types for the Eclipse Function Package
Build Project
Check Resource Exists
Close Editor
Close Project
Command Handler
Compare Files
Copy Resource
Copy Resource To Clipboard
Create Resource
Delete Resource
Edit Local File
Get Eclipse Projects
Get File System Path
Get Local History
Get Resource Children
Get Workspace Path
Synchronize Eclipse Elements
Move Resource
Open Project
Open Wizard
Paste Resource From Clipboard
Refresh Resource
Rename Resource
Select Resource
Show Local History
Show Properties Dialog Box
Micro Focus Editor Function Package
Tool Types for the Micro Focus Editor Function Package
Reparse With Refresh
Micro Focus ED Icons Function Package
Micro Focus Project Function Package
Linked Properties for the Micro Focus Project Function Package
Linked Element Types for the Micro Focus Project Function Package
IMTK Category Resource
IMTK Service Resource
IMTK Operation Resource
Category Resource
Tool Types for the Micro Focus Project Function Package
Compile File
Get Dependent Elements
Get Dependent Programs
Get IMTK Files
Get IMTK Operations
Get Populated IMTK Categories
Invoke IMTK Operation Command
Invoke IMTK Service Command
New Project From Template
Open In Context
Details for the Micro Focus Project Function Package
Micro Focus Servers Function Package
Tool Types for the Micro Focus Servers Function Package
Start Server
Stop Server
Create Server
Clear Credentials
Delete Server
Operating System Function Package
Tool Types for the Operating System Function Package
Execute OS Command
Select Local OS Resource
Details for the Operating System Function Package
Mass processing in an OS command
SVN Function Package
Linked Properties for the SVN Function Package
Tool Types for the SVN Function Package
Add
Add Repository
Check Out With UI
Clean Up
Commit
Delete SVN Property
Discard Repository
Get Properties
Get Root Folders
Get SVN Property
GET Repositories
Get Repository Content
Get Repository Items
Get Working Copy Resources
Get Working Copies
Lock
Log
Remove
Revert
Set SVN property
Unlock
Update
Extending the AWM Meta Model
Missing Function Packages
Missing Function Package Features
AWM API Programming and Extension Points
Introduction
API Programming
AWM API packages
AWM API Usage Hints
Accessing AWM from a Custom Application
Using the API when Implementing an AWM Extension Point
Using the API for the Synchronization of AWM Elements
AWM API Usage Guide
AWM Extension Points
AWM Model Extension Point
System Provider Extension Point
Initializer Extension Point
Keyword Parser Extension Point
Conversion Rule Extension Point
Global Editor Action Extension Point
Error Feedback Extension Point
AWM Extension Point Usage Guide
Describing an AWM Extension
Describing Function Package Tools
Implementing a Defined Function Package Tool
Describing Function Package Linked Properties
Debugging an AWM Extension Point Extension
AWM Model Maintenance
Further Development and Maintenance
Maintaining the AWM Model
Changes to ID Definitions
Converting a Deprecated Model
Workflow Manager Troubleshooting
Troubleshooting
General Problem Determination
Determine the original exception
Clear the persistent cache in the workspace
Workspace out of sync
Application Workflow Manager Problem Determination
Modeled Action does not work
Element List is not created
Tree View is not expandable
Tree View Elements do not have a correct label
Edit Action (Simple Remote Edit or Browse) does not work properly
General Problem Solving Suggestions
Determine the original exception
Clear the persistent cache in the workspace
Workspace out of sync
Gathering information for Micro Focus SupportLine
C Functions for Calling COBOL
cobaddch
cobaddstr
cobaddstrc
cobcall
cobcallpp
cobcancel
cobclear
cobcols
cobcommandline
cobexit
cobfunc
cobget
cobgetch
cobgetenv
cobgetfuncaddr
cobinit
cobkeypad
coblines
coblongjmp
cobmove
cobpostsighandler
cobprintf
cobput
cobputenv
cobremovesighandler
cobrescanenv
cobscroll
cobsetjmp
cobtermmode
cobthreadtidy
cobtidy
SYSTEM
COBOL Language Reference
COBOL Language Supported and Copyrights
Notations
Part 1. Concepts
Introduction to the COBOL Language
The COBOL Language
Source Format
Fixed Format
Sequence Number
Indicator Area
Areas A and B
Sample Program
Free Format
Variable 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
Nonnumeric Literals
Numeric Literals
National Literals
Figurative Constant Values
Constant-names
Concatenation Expressions
Special Registers
Predefined Object Identifiers
PICTURE Character-Strings
Comment-entries
Formats and Rules
General Format
Syntax Rules
General Rules
Elements
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
PROCEDURE-POINTER Format
Uniqueness of Reference
Qualification
Subscripting
Indexing
Function-identifier
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
Reserved Words
External Repository
Call Prototypes
Files
File Connector
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 COBOL Concepts
Objects and Classes
Object References
Predefined Object References
Methods
Method Invocation
Conformance and Interfaces
Conformance for Object Orientation
Interfaces
Conformance between Interfaces
Conformance for Parameterized Classes and Parameterized Interfaces
Polymorphism
Class Inheritance
Interface Inheritance
Interface Implementation
Parameterized Classes
Parameterized Interfaces
Object Life Cycle
Life Cycle of Factory Objects
Life Cycle of Objects
Life Cycle of Parameterized Classes
Life Cycle of Parameterized Interfaces
Managed Code Concepts
Attributes, Custom Attributes
Delegates and Events
Enumerations and Enum types
Extension Methods in Managed COBOL
Nested Classes in Managed COBOL
Data Types in Managed COBOL
Specifying Type Names
Simplified Class Layout
Run Unit Communication
Common, Initial and Recursive Attributes
Sharing Data
Sharing File Connectors
Data Division
Overview
Automatic, Initial and Static
State of a Function, Method, Object or Program
State of a Function, Method or Program
Active State
Initial and Last-used States of Data
Initial State
Last-used State
Initial State of an Object
Global Names and Local Names
External and Internal Items
Procedure Division
Execution
Statements and Sentences
Conditional Statement
Conditional Sentence
COBOL System-Directing Statement
COBOL System-Directing Sentence
Compiler Directives
Imperative Statement
Imperative Sentence
Delimited Scope Statements
Categories of Statements
Reference Format
Reference Format Representation
Sequence Numbers
Continuation of Lines
Blank Lines
Pseudo-text
Division, Section and Paragraph Formats
Division Header
Section Header
Paragraph Header, Paragraph-name and Paragraph
Data Division Entries
Declaratives
Comment Lines
In-line Comments
Part 2. Program Definition
Compilation Group
Compilation Groups
End Markers
Identification Division
Identification Division - General Description
The Program-ID Paragraph
The Class-ID Paragraph
The Factory Paragraph
The Object Paragraph
The Method-ID Paragraph
The Interface-ID Paragraph
The Function-ID Paragraph
The Date-Compiled Paragraph
The Delegate-ID Paragraph
The Enum-ID Paragraph
The Iterator-ID Paragraph
The Operator-ID Paragraph
The Valuetype-ID Paragraph
Environment Division
General Description
Configuration Section
The Source-Computer Paragraph
The Object-Computer Paragraph
The Special-Names Paragraph
The Repository Paragraph
The Constraints Paragraph
The Class-Attributes Paragraph
The Assembly-Attributes Paragraph
Input-Output Section
The File-Control Paragraph
The File Control Entry
The I-O-Control Paragraph
Data Division
General Description
File Section
Working-Storage Section
Thread-Local-Storage Section
Object-Storage Section
Local-Storage Section
Linkage Section
Screen Section
File and Data Description
File Description Entry Skeleton
The BLOCK CONTAINS Clause
The CODE-SET Clause
The DATA RECORDS Clause
The EXTERNAL Clause
The GLOBAL Clause
The LABEL RECORDS Clause
The LINAGE Clause
The RECORD Clause
The THREAD-LOCAL Clause
The VALUE OF Clause
The RECORDING MODE Clause
Data Description Entry Skeleton
The ANY LENGTH Clause
The BLANK WHEN ZERO Clause
The ATTRIBUTE, CUSTOM-ATTRIBUTE Clause
The Data-name or FILLER Clause
The GROUP-USAGE Clause
The JUSTIFIED Clause
Level Number
The OCCURS Clause
The PICTURE Clause
The PROPERTY Clause
The REDEFINES Clause
The RENAMES Clause
The SIGN Clause
The SYNCHRONIZED Clause
The TYPEDEF Clause
The USAGE Clause
The VALUE Clause
Screen Section
Screen Section Entry Skeleton
The AUTO Clause
The BACKGROUND-COLOR Clause
The BELL Clause
The BLANK Clause
The BLANK WHEN ZERO Clause in the Screen Section
The BLINK Clause
The COLUMN Clause
The CONTROL Clause
The ERASE Clause
The FOREGROUND-COLOR Clause
The FROM Clause
The FULL Clause
The GRID Clause
The HIGHLIGHT Clause
The JUSTIFIED Clause in the Screen Section
The LEFTLINE Clause
The LINE Clause
The LOWLIGHT Clause
The OCCURS Clause in the Screen Section
The OVERLINE Clause
The PICTURE Clause in the Screen Section
The PROMPT Clause
The REQUIRED Clause
The REVERSE-VIDEO Clause
The SECURE Clause
The SIGN Clause in the Screen Section
The SIZE Clause
The TO Clause
The UNDERLINE Clause
The USAGE Clause in the Screen Section
The USING Clause
The VALUE Clause in the Screen Section
The ZERO-FILL Clause
Procedure Division
Procedure Division General Description
The PROCEDURE DIVISION Header
Arithmetic Expressions
Arithmetic Operators
Bitwise Operators
Permissible Combinations of Symbols
Formation and Evaluation Rules
Intermediate Results
Conditional Expressions
Simple Conditions
Relation Condition
Comparison of Numeric Operands (Relation Condition)
Comparison of Nonnumeric Operands (Relation Condition)
Comparisons Involving Index-Names and/or Index Data Items (Relation Condition)
Comparisons Involving Data Items with USAGE POINTER (Relation Condition)
Comparisons Involving Data Items with USAGE PROCEDURE-POINTER (Relation Condition)
Comparisons Involving Data Items with USAGE OBJECT (Relation Condition)
Class Condition
Condition-name Condition (Conditional Variable)
Switch-Status Condition
Sign Condition
Omitted-argument Condition
Instance-of Condition
Complex Condition
Negated Simple Condition
Combined and Negated Combined Condition
Abbreviated Combined Relation Conditions
Condition Evaluation Rules
Common Phrases
Arithmetic Statements
Overlapping Operands
Multiple Results in Arithmetic Statements
Incompatible Data
Signed Receiving Items
The ROUNDED Phrase
The ON SIZE ERROR Phrase and NOT ON SIZE ERROR Phrase
ON SIZE ERROR Phrase Not Specified
ON SIZE ERROR Phrase Specified
The NOT ON SIZE ERROR Phrase
The CORRESPONDING Phrase
File I/O Concepts
File Position Indicator
I-O Status
Status Key 1
Successful Completion
Successful Completion
AT END Condition with Unsuccessful Completion
INVALID KEY Condition with Unsuccessful Completion
Permanent Error Condition with Unsuccessful Completion
Logic Error Condition with Unsuccessful Completion
Run-Time System Error Message
Valid Combinations of Status Keys 1 And 2
The AT END Condition
The INVALID KEY Condition
Sharing Files on Multi-user Systems
Single Record Locking
Multiple Record Locking
Default Record Locking
Conformance for Parameters and Returning Items
Parameters
Group Items
Elementary Items
Elementary Items Passed by Reference
Elementary Items Passed by Content or by Value
Returning Items
Group Items
Elementary Items
Intrinsic Functions
Arguments
Function Types
Data Item Functions
Date Conversion Functions
Trigonometric Functions
Definitions of Functions
The ABS Function
The ACOS Function
The ANNUITY Function
The ASIN Function
The ATAN Function
The BOOLEAN-OF-INTEGER Statement
The CHAR Function
The CHAR-NATIONAL Function
The COS Function
The CURRENT-DATE Function
The DATE-OF-INTEGER Function
The DATE-TO-YYYYMMDD Function
The DAY-OF-INTEGER Function
The DAY-TO-YYYYDDD Function
The DISPLAY-OF Function
The E Function
The EXP Function
The EXP10 Function
The FACTORIAL Function
The FRACTION-PART Function
The INTEGER Function
The INTEGER-OF-BOOLEAN Statement
The INTEGER-OF-DATE Function
The INTEGER-OF-DAY Function
The INTEGER-PART Function
The LENGTH Function
The LENGTH-AN Function
The LOG Function
The LOG10 Function
The LOWER-CASE Function
The MAX Function
The MEAN Function
The MEDIAN Function
The MIDRANGE Function
The MIN Function
The MOD Function
The NATIONAL-OF Function
The NUMVAL Function
The NUMVAL-C Function
The ORD Function
The ORD-MAX Function
The ORD-MIN Function
The PI Function
The PRESENT-VALUE Function
The RANDOM Function
The RANGE Function
The REM Function
The REVERSE Function
The SIGN Function
The SIN Function
The SQRT Function
The STANDARD-DEVIATION Function
The SUM Function
The TAN Function
The ULENGTH Function
The UPOS Function
The USUBSTR Function
The USUPPLEMENTARY Function
The UVALID Function
The UWIDTH Function
The UPPER-CASE Function
The VARIANCE Function
The WHEN-COMPILED Function
The YEAR-TO-YYYY Function
Statements
The ACCEPT Statement
The ADD Statement
The ALLOCATE Statement
The ALTER Statement
The ATTACH Statement
The CALL Statement
The CANCEL Statement
The CHAIN Statement
The CLOSE Statement
The COMMIT Statement
The COMPUTE Statement
The CONTINUE Statement
The CREATE Collection Statement
The DECLARE Statement
The DELETE Statement
The DELETE FILE Statement
The DETACH Statement
The DISPLAY Statement
The DIVIDE Statement
The ENTER Statement
The ENTRY Statement
The EVALUATE Statement
The EXAMINE Statement
The EXEC(UTE) Statement
The EXHIBIT Statement
The EXIT Statement
The FREE Statement
The GOBACK Statement
The GO TO Statement
The IF Statement
The INITIALIZE Statement
The INSPECT Statement
The INVOKE Statement
The JSON GENERATE Statement
Appendix A - JSON GENERATE Source Items
Appendix B - JSON Output Text
Appendix C - Elementary Data Format Conversions
Appendix D - Trimming of Generated JSON Data
Appendix E - JSON Name Formation
The MERGE Statement
The MOVE Statement
The MULTIPLY Statement
The NEXT SENTENCE Statement
The NOTE Statement
The ON Statement
The OPEN Statement
The PERFORM Statement
The RAISE Statement
The READ Statement
The RELEASE Statement
The RESET Collection Statement
The RETURN Statement
The REWRITE Statement
The ROLLBACK Statement
The SEARCH Statement
The SERVICE Statement
The SET Statement
The SORT Statement
The START Statement
The STOP Statement
The STRING Statement
The SUBTRACT Statement
The SYNC Statement
The TRANSFORM Statement
The TRY Statement
The UNLOCK Statement
The UNSTRING Statement
The USE Statement
The WAIT Statement
The WRITE Statement
The XML GENERATE Statement
The XML PARSE Statement
Compiler-directing Statements
Source Text Manipulation
The COPY Statement
The REPLACE Statement
Editor Control
$REGION Statement
The BASIS Mechanism
The BASIS Statement
The DELETE Statement - BASIS Control
The INSERT Statement - BASIS Control
The ++INCLUDE and -INC Mechanisms
The -INC Statement
The ++INCLUDE Statement
Conditional Compilation
$DISPLAY Statement
$ELSE Statement
$END Statement
$IF Statement
The Listing Control Statements
The EJECT Statement
The SKIP1, SKIP2 and SKIP3 Statements
The TITLE Statement
Compiler Directives Specific to Your COBOL System
Examples
Call Prototypes
Calling and Setting a Procedure-Pointer
Call Returning a Dynamically Allocated Data Area from a Subprogram
Compilation Group
COPY (ANSI'68 or LANGLVL(1) Variation)
COPY (Partial Word Replacement)
CRT STATUS Clause of the SPECIAL-NAMES Paragraph
$IF Statement (Conditional Compilation)
INSPECT Statement (Tallying, Replacing, and Converting)
NEXT Phrase of CONSTANT-NAMES
SEARCH statement
SORT a File Using Input and Output Procedures
SORT Table Entries
Split Key
Typedef - User Defined USAGE or Structure
Part 3. Additional Topics
XML Syntax Extensions
XML File Status Codes
XML Preprocessor Restrictions
XML Syntax - CLOSE Statement
XML Syntax - COUNT IN Clause
XML Syntax - DELETE Statement
XML Syntax - IDENTIFIED BY Clause
XML Syntax - NAMESPACE clause
XML Syntax - PROCESSING-INSTRUCTION Clause
XML Syntax - OPEN Statement
XML Syntax - READ Statement
XML Syntax - REWRITE Statement
XML Syntax - SELECT Clause
XML Syntax - START Statement
XML Syntax - WRITE Statement
XML Syntax - XD File Description
Report Writer
Report Section
Report Structure
Vertical Spacing
Horizontal Spacing
Data Manipulation
Report Subdivisions
Physical Subdivision of a Report
Logical Subdivisions of a Report
Procedure Division Report Writer Statements
Language Concepts
Report File
Special Register PAGE-COUNTER
Special Register LINE-COUNTER
Special Register PRINT-SWITCH
Subscripting
Environment Division
Input-Output Section
The File-Control Paragraph
The I-O-Control Paragraph
Data Division
The File Description Entry (Report Writer)
The REPORT Clause
Report Section
The Report Description Entry
PAGE-COUNTER Rules
LINE-COUNTER Rules
The CODE Clause
The CONTROL Clause
The PAGE Clause
The Report Group Description Entry
Presentation Rules Tables
Organization
Line Number Clause Notation
Line Number Clause Sequence Substitutions
Saved Next Group Integer Description
Report Heading Group Presentation Rules
Page Heading Group Presentation Rules
Body Group Presentation Rules
Page Footing Presentation Rules
Report Footing Presentation Rules
The COLUMN NUMBER Clause (Report Writer)
Data-name (Report Writer)
The GROUP INDICATE Clause
Level-Number (Report Writer)
The LINE NUMBER Clause (Report Writer)
The NEXT GROUP Clause
The SIGN Clause (Report Writer)
The SOURCE Clause (Report Writer)
The SUM Clause (Report Writer)
The TYPE Clause
The USAGE Clause
The VALUE Clause (Report Writer)
Procedure Division
General Description
The CLOSE Statement
The GENERATE Statement
The INITIATE Statement
The OPEN Statement (Report Writer)
The SUPPRESS Statement
The TERMINATE Statement
The USE BEFORE REPORTING Statement
Debug Module
Standard ANSI COBOL Debug
Object-time Switch
COBOL Debug RTS Switch
Debugging Lines
Environment Division
The WITH DEBUGGING MODE Clause
Procedure Division
The READY TRACE Statement
The RESET TRACE Statement
The USE FOR DEBUGGING Statement
Segmentation
General Description of Segmentation
Organization
Program Segments
Fixed Portion
Independent Segments
Segmentation Classification
Segmentation Control
Structure of Program Segments
Segment-Numbers
The SEGMENT-LIMIT Clause
Restrictions on Program Flow
The ALTER Statement
The PERFORM Statement
The MERGE Statement
The SORT Statement
Double-Byte Character Set Support
DBCS Data
Roman Script in DBCS
Multivendor Integration Architecture Support
Source Programs
Language Extensions
Comments and Comment-entries
User-defined Words
Spaces
Data Items
DBCS Data Items
Mixed Data Items
Literals
DBCS Literals
Category of DBCS Literals
Mixed Literals
Figurative Constants
The "N" literal
Program Structure
The END PROGRAM Header (DBCS)
Identification Division
The PROGRAM-ID Paragraph (DBCS)
Environment Division
The SOURCE-COMPUTER Paragraph (DBCS)
The OBJECT-COMPUTER Paragraph (DBCS)
The SPECIAL-NAMES Paragraph (DBCS)
The FILE-CONTROL Paragraph (DBCS)
Data Division
The JUSTIFIED Clause (DBCS)
The PICTURE Clause (DBCS)
The REDEFINES Clause (DBCS)
The RENAMES Clause (DBCS)
The USAGE Clause (DBCS)
The VALUE Clause (DBCS)
Procedure Division
Conditional Expressions (DBCS)
Relation Conditions
Class Condition
Statements that Involve Moving Data
The ACCEPT Statement (DBCS)
The CALL Statement (DBCS)
The CANCEL Statement (DBCS)
The INITIALIZE Statement (DBCS)
The INSPECT Statement (DBCS)
The MOVE Statement (DBCS)
The SEARCH Statement (DBCS)
The STOP Statement (DBCS)
The STRING Statement (DBCS)
The UNSTRING Statement (DBCS)
Micro Focus Extensions for Double-Byte Character Support
Environment Division
The OBJECT-COMPUTER Paragraph
The SPECIAL-NAMES Paragraph
The FILE-CONTROL Paragraph
Data Division
The JUSTIFIED Clause
The PICTURE Clause (DBCS)
The USAGE Clause
The VALUE Clause
Procedure Division
Conditional Expressions
Condition-name
Relation Conditions
Class Condition
The ACCEPT Statement
The INITIALIZE Statement
The INSPECT Statement
The MOVE Statement
The SEARCH Statement
The STRING Statement
The UNSTRING Statement
Micro Focus OO COBOL Extensions
Directives
Class Definition
Class Extension
Class-body
Class-object
Object-program
Method
Method Interface Definition
Summary of Obsolete Language Elements
Additional Dialect Support
ACUCOBOL-GT Syntax Extensions
Program Structure
Identifiers
Numeric Literals
Nonnumeric Literals
Source Formats
Identification Division
PROGRAM-ID Paragraph
Environment Division
The File-Control Paragraph
Data Division
SYNCHRONIZED Clause
USAGE Clause
Procedure Division
Procedure Division Statements
ACCEPT FROM
ACCEPT FROM ENVIRONMENT
INSPECT
OPEN Statement
SET ENVIRONMENT
Data General Interactive COBOL V1.3 Syntax Support
Environment Division
Switch-Names
File-Name on Disk
The DATA SIZE Clause
The INDEX SIZE Clause
Duplicate Alternate Keys
Alternate Keys
I-O-Control Paragraph
Data Division
VALUE Clause
The Screen Section
Procedure Division
The CALL Statement
The COPY INDEXED Statement
The DISPLAY Statement
File Sharing Syntax
The OPEN Statement
The READ Statement
DOS/VS COBOL Support
Microsoft COBOL V1.0 and V2.0 Syntax Support
Special Registers LIN and COL
Environment Division
The Special-Names Paragraph
Data Division
The USAGE Clause
Procedure Division
The Position-Specification Phrase
The ACCEPT Statement
The DISPLAY Statement
The EXHIBIT Statement
Microsoft V2.0 Additional Syntax Support
Record LOCKING
OPEN LOCKING Statement
READ Statement (in Manual Mode)
START Statement
RM/COBOL Syntax Support
Environment Division
The ASSIGN Clause
The CODE-SET Clause
The ORGANIZATION Clause
The RECORD DELIMITER Clause
Data Division
Default Sign Representation
Empty Groups
The CONTROL Clause
The USAGE Clause
Procedure Division
Bound Checking
I-O Status Codes
Literals as Call Parameters
Locked Records
Non-standard Operations on Alphanumeric Data Items
OPEN and CLOSE on Sequential Files
Procedure Names
REWRITE on LINE SEQUENTIAL Files
Size Allocation for Index Data Items
The ACCEPT Statement
The DISPLAY Statement
The EXIT PROGRAM Statement
The PERFORM Statement
The STOP RUN Statement
Siemens BS2000 COBOL Syntax Support
Concepts
Indicator Area
Areas A and B
Special Registers
Nonnumeric Literals
Floating-point Literals
Function-Identifier
Representation of Numeric Items
The BINARY, COMPUTATIONAL and COMPUTATIONAL-5 phrases
File Concepts
Subscripts
Object Views
Identification Division
Identification Division Header
Identification Division Structure
The Class-ID Paragraph
The Factory Paragraph
The Interface-ID Paragraph
The Method-ID Paragraph (Siemens BS2000 COBOL)
The Object Paragraph
Environment Division
The Special-Names Paragraph
The File Control Entry
The Repository Paragraph
Data Division
The File Description Entry
The Sort-Merge File Description Entry
The Working-Storage Section
The DYNAMIC Clause
The OCCURS Clause
The PICTURE Clause
The REDEFINES Clause
The SYNCHRONIZED Clause
The USAGE Clause
The VALUE Clause
Procedure Division
Class Condition
Intrinsic Functions
The ADDR Function
The ACCEPT Statement
The CALL Statement
The CLOSE Statement
Record Sequential Files
Line Sequential Files
The DISPLAY Statement
The ENTRY Statement
The EVALUATE Statement
The EXIT PERFORM Statement
The GOBACK Statement
The INSPECT Statement
The INVOKE Statement
The MERGE Statement
The MOVE Statement
The OPEN Statement
The READ Statement
Relative and Indexed Files
The REWRITE Statement
The SEARCH Statement
The SET Statement
The SORT Statement
Sorting of Tables
Sorting Two-digit Years with a Century Window
The START Statement
Relative and Indexed Files
The STRING Statement
The USE Statement
The WRITE Statement
Sequential Files
Compiler Directing Statements
The COPY Statement
VS COBOL II Compatibility
Part 4: Appendices
Character Sets and Collating Sequences
ANSI File Status Summary
ANSI'74 File Status Codes
ANSI'85 File Status Codes
Reserved Words
Reserved Words Table
Context-sensitive Words Table
JSON-CODE Exception Codes
XML-CODE Exception Codes
Glossary
Command line reference
Setting Directives Outside the IDE
The Order in which Compiler Directives are Processed
System-wide Directives File, cobol.dir
$SET Statements in the Source Code
User Directives File
Compiling from the Command Line (Windows)
The cobol command
cobol Command Examples
Compiling Using Response Files Example
Compiler Prompts
Compiler Prompts Example
Filenames
Response Files
Error Codes Returned by the Compiler
Linking from the Command Line (Windows)
cbllink
cbllink Options
-d
-f[option]
-g
-isymbol
-k
-l
-mname
-oname
-roption[v]
-s
-udir_file
-v
-w
-xsymbol
-y
cbllink Examples
Compiling and Linking from the Command Line (UNIX)
Introduction to the cob command
cob (cob32 or cob64) Command
cob Options Syntax
cob Option Processing and Search Order
cobopt File
COBOPT Environment Variable
Creating Different Types of Files
Simple Default Linking
Resolving Unresolved References in System Executables
Creating Intermediate Code Files
Creating Generated Code Files
Callable Shared Objects
Creating Callable Shared Objects
Entry Points
Resolving Unresolved References in Callable Shared Objects
Advanced Uses
Self-Contained Callable Shared Objects
Creating Executables that Use Library Files
Creating Shared Libraries
Creating an Executable Run-time System (RTS)
Creating Executables that Use the Dynamic Loader
Creating Dynamically Loadable Files
cob Flags
Pass Option to Assembler (-A as_option)
Compile for Animation (-a)
Pass Syntax-check Phase Directive to the Compiler (-C directive)
Pass Option to the C Compiler (-CC cc_option)
Pass Option to the C++ Compiler (+CC cc_option)
Compile No Further Than Linkable Object Module (-c)
Dynamically Load Symbol (-d symb)
Set Initial Entry Point (-e epsym)
Create Information for Symbolic Debugger (-g)
Include Symbol in Executable File (-I symb)
Compile to Intermediate Code for Unlinked Environment (-i)
Compile to JVM Byte Code (-j)
Recognize COBOL Source File with Non-standard Filename Extensions (-k cobol-file)
Pass Option to System Linker Changing Search Algorithm and Maintaining Relative Ordering (-L dir)
Pass Option to System Linker After All Other Options Changing the Search Algorithm (+L dir)
Pass Option to System Linker Maintaining Relative Ordering (-l lib)
Pass Option to System Linker After All Other Options (+l lib)
Map Symbol to New Symbol (-m symb=newsym)
Pass Generate Phase Directive (-N directive)
Enable Optimization (-O)
Specify Output File-name (-o filename)
Produce Listing File (-P)
Pass Flag to C Compiler to Use Profiling Routines (-p)
Pass Option to System Linker (-Q ld_option or -Q,1 ld_option or -Q,2ld_option)
Create Multi-threading Program (-t)
Dynamically Load Unresolved Reference (-U)
Compile to Generated Code for Unlinked Environment (-u)
Report Version Number (-V)
Set Verbose Module (-v)
Control Error Level for cob Termination (-W err-level)
Exclude Symbol from the Executable Output File (-X symb)
Process to System Executable File (-x[,CC])
Produce a Shared Library for non-COBOL Applications (-Y[,CC])
Produce a Self-Contained Callable Shared Object for non-COBOL Applications (-y[,U][,CC])
Produce a Shared Library File for COBOL Applications (-Z[,CC])
Produce a Callable Shared Object for COBOL Applications (-z[,U][,CC])
Flags Reserved for Future Use
cob Error Messages
argument expected: option-name
cobol version number invalid - Call Technical Support
entry defined: entryname-1 conflicting "main" found in entrypoint-2
entry: entryname does not have "main" defined
I see no use for file-name
I see no work
invalid entry point name: entryname
options clash: option-names
cob Command Examples
Converting Header Files Using the H2cpy Utility
Service Interfaces
imtkmake command
mfdepinst command
Debugging from the Command Line
cobdebugremote/cobdebugremote32
cobdebugremote64
Running an Application from the Command Line
Command to Run a Linked System Executable Program
cobrun Command
cobrun Command Examples
Enhanced ACCEPT/DISPLAY Syntax
Overview
Accepting Elementary Data Items from Single Fields
Accepting Single Fields
Alphanumeric Fields
Numeric and Numeric-edited Fields
Fixed-format Data Entry
Free-format Data Entry
RM-style Data Entry
Displaying Elementary Data Items in Single Fields
Displayed Data Format - Examples
Displaying Single Fields
Control Sequences in Displayed Data
Displaying Highlighted Text
Accepting and Displaying Group Items
Accepting into Group Items
Displaying Group Items
MODE IS BLOCK Clause
Accepting and Displaying Screen Section Items
Positioning the Cursor for ACCEPT Statements
Accepting and Displaying Data on Large Screens
CONTROL Clause
Keyboard Handling Via Adis
Types of Adis Keys
Function Keys
Data Keys
Shift Keys
Lock Keys
Function Key Handling
The CRT STATUS Clause
Normal termination of an ACCEPT operation
Default User Function Keys
Enabling and Disabling User Function Keys
Detecting User Function Keys
Using the Compatibility Key List for Adis Keys
The User Function Keys and Validation Clauses
Using the Adis Keys
Key Mappings for Standard Adis Functions
Standard Adis Key Functions
Mapping the Adis Keys to the Functions
Special Mapping Functions in Adis
Key Mappings for Special Adis Functions
Changing Adis Key Mappings from a Program
Conflict With the x"B0" COBOL System Library Routine
Enabling and Disabling Adis Keys
Detecting Adis Function Keys
Defining a Key in Both the User and Adis Key Lists
Data Key Handling
Controlling the Data Keys
Detecting Data Keys Set Up to Act as Function Keys
Shift Key Handling
Determining Available Shift Keys
Detecting the Current State of the Shift Keys
Enabling or Disabling Shift Keys to Terminate an ACCEPT
Lock Key Handling
Determining Available Lock Keys
Detecting the Current State of the Lock Keys
Enabling or Disabling Lock Keys to Terminate an ACCEPT
Converting Accepted Characters to Uppercase
Configuring Enhanced ACCEPT and DISPLAY
Overview
Invoking the Adis Configuration Utility
Menus
The Adis Configuration Utility Main Menu
The Adis Key Control Menu
The Alter Accept/Display Options Menu
The Alter All Messages Menu
The Alter All ACCEPT/DISPLAY Options Menu
The Alter Configuration Menu
The Alter Crt-Under Highlighting Menu
The Alter Function Mappings Menu
The Alter Indicators Menu
The Alter Individual Messages Menu
The Alter Individual Options Menu
The Alter Message/Indicator Positions Menu
The Alter Messages Menu
The Alter Tab Stops Menu
The Choose Configuration Menu
The Delete Configuration Menu
The Enable/Disable Adis Keys Menu
The Load Configuration Menu
The Save Menu
Adiscf Functions
Keyboard Configuration Utility (Keybcf)
Overview
The Key Lists
cobkeymp Tables
Invoking the Keyboard Configuration Utility
Using the Keyboard Configuration Utility
Reviewing Existing Function Key Definitions
Altering Function Key Definitions
Saving Function Key Definitions
Exiting From the Keyboard Configuration Utility
Example of Using the Keyboard Configuration Utility
Standard Adis Key Functions
Special Mapping Functions in Adis
Profiler
Introduction to Profiler
Running or Invoking Profiler from the Command Line
Profiler Output
Time Spent in Called Programs
Directives for Profiler
Test Coverage (Native COBOL)
Overview - Test Coverage
Test Coverage Configuration File
Test Coverage Report Files
Format of a Test Coverage Report
Recompiling Programs
Reporting on Tagged Lines
Test Coverage Tag File
Test Coverage Utility Program (tcutil)
How To...
To use test coverage from the command line
To create test coverage reports
To report on tagged lines
Including Code Coverage in a Continuous Integration Process
Restrictions when Using Test Coverage
Troubleshooting Test Coverage
Test Coverage Error Messages
The cobutf8 Utility
Configuring the cobutf8 Configuration File
Running Your Application Through the cobutf8 Utility
Error Messages
Compiler Directives
Language Features
Language Features - Dialect
ACTUAL-PARAMS
ACU
ACU-COMMENT
ACUOPT
ACUSYNC
ACU-UNDERSCORE
ANS85
BS2000
COMS85
DBCHECK
DBCS
DBCSSOSI
DG
DIALECT
ACU DIALECT setting
ANS85 DIALECT setting
BS2000 DIALECT setting
BS2000-OFFLOAD DIALECT setting
COBOL370, COBOL371 and COBOL372 DIALECT settings
DOSVS DIALECT setting
ENTCOBOL DIALECT setting
ISO2002 DIALECT setting
MF DIALECT setting
MVS DIALECT setting
OS390 DIALECT setting
OSVS DIALECT setting
RM DIALECT setting
VSC21 and VSC22 DIALECT settings
VSC23 and VSC24 DIALECT settings
ENTCOBOL
FLAG
FLAGSTD
IBM-MS
ISO2002
JAPANESE
MF, MFLEVEL
MS
NATIONAL
NCHAR
NSYMBOL
OOCTRL
OSVS
PC1
RM
VSC2
XOPEN
Language Features - Mainframe Compatibility
APOST
AREACHECK
ARITH
CMPR2
DBCSSOSI
DIALECT
ACU DIALECT setting
ANS85 DIALECT setting
BS2000 DIALECT setting
BS2000-OFFLOAD DIALECT setting
COBOL370, COBOL371 and COBOL372 DIALECT settings
DOSVS DIALECT setting
ENTCOBOL DIALECT setting
ISO2002 DIALECT setting
MF DIALECT setting
MVS DIALECT setting
OS390 DIALECT setting
OSVS DIALECT setting
RM DIALECT setting
VSC21 and VSC22 DIALECT settings
VSC23 and VSC24 DIALECT settings
DISPSIGN
DPC-IN-SUBSCRIPT
IDENTIFIERLEN
LIBRARIAN
MAPNAME
NUMPROC
OLDCOPY
PANVALET
PROGID-COMMENT
QUOTE
RDW
TRUNCCALLNAME
TRUNCCOPY
TRUNCINC
Language Features - Multi-threading
REENTRANT
SERIAL
Language Features - Reserved Word Control
ADDRSV
ADDSYN
COBOL370
DOSVS
MAKESYN
MVS
OS390
OVERRIDE
REMOVE
SAA
Language Features - Speed
ALTER
FASTCALL
FASTLINK
FIXOPT
QUAL
QUALPROC
SEG
Language Features - Additional Features
CONSTANT
DB2
FCDREG
PREPROCESS, P
REWRITE-LS
SEQCHK
SOURCEFORMAT
LOCALSOURCEFORMAT
SQL
XMLPARSE
Compiler Control
Compiler Control - Compile/Link Files
CANCELLBR
CONVSPACE
COPYEXT
COPYLBR
COPYPATH
DATA-CONTEXT
EOF-1A
GNT
IDYSRCPATH (deprecated)
IGNOREEXEC
INT
INTLEVEL
JVMGEN
KEYCHECK
NULL-ESCAPE
OBJ
OSEXT
P64
PCOMP
PREPROCESS, P
PROGID-INT-NAME
PROTOTYPE
RDFPATH
REPOSITORY
SOURCETABSTOP
UNICODE
Compiler Control - Directives Control
COBOLDIR
CONFIRM
DIALECT
ACU DIALECT setting
ANS85 DIALECT setting
BS2000 DIALECT setting
BS2000-OFFLOAD DIALECT setting
COBOL370, COBOL371 and COBOL372 DIALECT settings
DOSVS DIALECT setting
ENTCOBOL DIALECT setting
ISO2002 DIALECT setting
MF DIALECT setting
MVS DIALECT setting
OS390 DIALECT setting
OSVS DIALECT setting
RM DIALECT setting
VSC21 and VSC22 DIALECT settings
VSC23 and VSC24 DIALECT settings
DIRECTIVES, DIR
DIRECTIVES-IN-COMMENTS
SETTING, SETTINGS
SHOW-DIR
USE
Compiler Control - Error and Flag Messages
BRIEF
CHANGE-MESSAGE
ERRFORMAT
ERRLIST
ERRQ
FLAG
FLAGAS
FLAGEUC
FLAGMIG
FLAGQ
FLAGSINEDIT
FLAGSTD
HIDE-MESSAGE
IMPLICITSCOPE
INFORETURN
MAX-ERROR
MOVE-LEN-CHECK
QUERY
RESTRICT-GOTO
STDERR
WARNING, WARNINGS
Compiler Control - Listing
COPYLIST
COPYLISTCOMMENT
DATAMAP
DATE
ERRLIST
FORM
LINE-COUNT
LIST
LISTPATH
LISTWIDTH, LW
MFCOMMENT
PREPLIST
PRINT
RAWLIST
REF
REFNO
RESEQ
SEQCHK
SETTING, SETTINGS
SHOW-DIR
SOURCEASM
TIME
VERBOSE
XREF
ZEROSEQ
Compiler Control - Screen
BELL
CONFIRM
ECHO
ECHOALL
SUPFF
Compiling for Debugging and Analysis
ANIM
COBIDY
COLLECTION
FLAGSINEDIT
PROFILE
TESTCOVER
TRACE
File Handling
ANS85
ASSIGN-PRINTER
ASSIGN
AUTOLOCK
CALLFH
CALL-RECOVERY
CALLSORT
COBFSTATCONV
DATACOMPRESS
DETECT-LOCK
FCDCAT
FDCLEAR
FILESHARE
FILETYPE
HOSTCONTZERO
HOSTFD
IDXFORMAT
IXNLSKEY
IXNUMKEY
KEYCHECK
KEYCOMPRESS
LOCKTYPE
OLDREADINTO
OPTIONAL-FILE
PRESERVECASE
PRINT-EXT
RDW
RECMODE
RETRYLOCK
REWRITE-LS
SEQUENTIAL
SORTTYPE
WRITELOCK, WRITE-LOCK
WRITETHROUGH, WRITETHRU
Managed COBOL Command Line Compiler Directives
Application Directives
DOTNET
ILASSEMBLY
ILGEN
ILMAIN
ILNAMESPACE
ILOUTPUT
Code Generation Directives
ILARRAYPROPERTY
ILCLR
ILCUTPREFIX
ILDOC
ILDYNCALL
ILEXPONENTIATION
ILNATIVE
ILOBJECTIFY (deprecated)
ILOPTIMIZEDATA
ILPARAMS
ILREF
ILSHOWPERFORMOVERLAP
ILSMARTLINKAGE
ILSMARTNEST
ILSMARTRESTRICT
ILSMARTSERIAL
ILSTATIC
ILTARGET
ILVERIFY
JVMDECIMAL
Reference, Resource and Namespace Directives
ILICON
ILNATIVERESOURCE
ILPINVOKE
ILREF
ILRESOURCE
ILSOURCE
ILSTACKSIZE
ILSUBSYSTEM
ILUSING
JVMCLASSPATH
Strong Naming Directives
ILDELAYSIGN
ILKEYFILE
ILKEYNAME
Identity, Information and Manifest Directives
ILCOMPANY
ILCOPYRIGHT