Caliber
Installation Help
Introduction
Borland Support
Installing Server Components
Installing Caliber Data Server
Installing both Client and Server
Installing the Server Alone
Installing Caliber and a 64-bit Versant DB on a 64-bit Server
Installing MPX Services
Configuring MPX Services
Reconnecting MPX Services
Restarting the MPX Server
Installing LDAP User Import
Installing Caliber for Microsoft Team Foundation Server
Silent Installation of Caliber on Visual Studio Team Foundation Server
Installing Caliber for Web
Installing Caliber Author and Components
Installing Caliber Author
Installing Typical or Full Caliber Author
Custom Installation
Silent Install of Caliber Author
Installing Caliber Plug-in for Eclipse Client
Installing Caliber Plug-in for Microsoft Visual Studio 2005
Installing Caliber Plug-in for Microsoft Visual Studio 2008
Installing the Caliber Plug-in for Microsoft Visual Studio 2010
Installing the Caliber Plug-in for Visual Studio Team System
Silent installation of Caliber for Visual Studio Team System
Installing Caliber SDK
Installing Only Caliber Author
Installing Caliber Visualize
Introduction to Caliber Visualize
Upgrading from a Previous Release of TeamDefine or CaliberRDM
Installing Caliber Visualize Overview
Installing Caliber Visualize
Starting or Stopping the Service
Changing the Default Server TCP/IP Port Numbers
Enabling SSL Communication
Installing and Integrating with Caliber Overview
Requirements for the Caliber Integration
Installing and Integrating with Caliber
Configuring the Appearance of Assets in Caliber Visualize
Changing the Caliber Data Server Settings
Uninstalling
Logging on to
Logging On with the Default User Account
Logging on as a Administrator for the First Time
Application Startup Troubleshooting Guide
Installing Caliber Review
Performing an Upgrade
Data Server Upgrade
Upgrading Data Server from 11.0 to 11.1
Upgrading Server Components from 10.1 or Earlier
Manually Upgrading Server Components
Important information for HP Quality Center customers
Upgrading Client Components
Upgrading Caliber for Microsoft Visual Studio Team System
Information for Datamart Users
Upgrading from CaliberRDM to Caliber Visualize
Program Maintenance
Caliber Help
Welcome to Caliber
Getting Started
Requirements Management
Agile Requirements
Overview
Caliber Administrator
Tour of the Caliber User Interface
Product Integrations
StarTeam Toolbar
Toolbar
User Connections Monitor
Extending Functionality
Web Client and Web Viewer
Administrative Procedures
Managing the Borland License Server
End-User Procedures
Logging on to Caliber
Logging onto Web Client
Logging onto Web Viewer
Logging onto Administrator
Changing Password
Changing Your Password
Creating Custom Tools
Adding Words in Custom Dictionary
Invoking Spell Checker
Find in Tree
Customizing Quick Access
Adding StarTeam Toolbar Window
Generating URL for a requirement
Options Dialog Box Tabs
General Tab
Hide Tab
Appearance Tab
Communication Tab
Clipboard Tab
Wizards Tab
Spelling Tab
Cache Tab
Disk Cache Tab
Custom Tools Tab
Administrating Servers
Creating Administrators
Managing the Borland License Server
Enabling LDAP
Generating Logs for Clients
Generating Logs for Data Server
Relocating a Server
Setting up Data Server
Importing Project Information
Database Administration
Scheduling a Daily Database Backup
Backing up Database
Changing the Database Owner
Creating a New Database Using DB Manager
Restoring a Database
Database Manager Commands
Command Switches
Administrating Projects
Administrators
Administrative tasks
Projects
Vendor Add-in module
Assigning Groups Project admin to a Project
Assigning Project Administrator
Creating a Requirement Type
Creating Security Profiles
Defining Projects
Specifying Project Access Rights
Setting Requirement Types
Enabling Email Notifications
Enabling Traceability to External Objects
Changing Caliber Visualize Server URL
Defining the Requirement Type
Setting Requirement Types Within a Project
Deleting Custom Tabs
Enabling Automatic Notification
Enabling Move Requirement
Enabling Other Integrations
Enabling Shared Requirements
Find in Tree
Logging on to Caliber
Modifying Projects
Mapping Requirements
Modifying a Requirement Type
Modifying a User-Defined Attribute
Modifying User Lists within a Project
Setting Security in a Project
Setting the User Password
Setting Up Automatic Notification
Unmapping Requirements
Requirement Types
Assigning User-Defined Attributes to a Requirement Type
Creating a Custom Tab
Changing Custom Tab Icons
Creating a Requirement Type
Defining the Requirement Type
Deleting Custom Tabs
Deleting a Requirement Type
Modifying a Requirement Type
Setting Requirement Types Within a Project
Setting the Default Security Access for a Requirement Type
Access Levels
Administrative Reports
Attributes
Arranging User-Defined Attribute in Order
Assigning Attribute Values
Assigning User-Defined Attributes to a Requirement Type
Creating User-Defined Attribute
Deleting User-Defined Attribute
Modifying a User-Defined Attribute
Command Switches
Discussions
Enabling Discussion Notification
Posting Discussion Messages
Reading a message
Replying to Discussion Messages
Viewing the Unread Discussion List
Document Factory
Creating a Document Using Document Factory
Document Factory Syntax
Semantics and Structure
Multiple Project Reports
Document Factory Commands
Keywords
Global Keywords
Specific Keywords
Operators
Compare Operators
LIKE Operator Wildcards
Logical Operators
Mathematical Operators
Using Filters within Document Factory
Creating Tables in Document Factory
Printing Glossary Terms in the Table
Printing Requirement History in a Table
Printing Requirement Discussions in a Table
Printing Lists (References Responsibilities and UDA) in a table
Printing Traces in a Table
Embedding a Table
Printing Requirements for Multiple Projects
Importing the Certificate File
Creating the commandline.ini file
Running Document Factory from the command line
Users
Export Directory Structure
Import Directory Structure
Enabling Shared and Mapped Requirements
Export Tables
Licensing
Security
Security Profiles
Creating a Security Profile
Deleting Security Profiles
Modifying Security Profiles
Setting the Default Security Access for a Requirement Type
Vendor Add-in module
Web Access
Using Caliber to Manage Requirements
Requirements
Requirement Descriptions
Spelling Checker Options
Requirement Views
Adding Hyperlinks to Requirement Descriptions
Editing a Hyperlink
Adding Pictures to Requirement Descriptions
Adding Tables to Requirement Descriptions
Assigning Attribute Values
Assigning Responsible Users
Changing the Requirement Order
Changing Requirement Order with Drag and Drop
Comparing Requirements
Comparing Requirements to Different Versions
Copying Requirements
Creating Requirements
Defining Requirements
Specifying Requirement Validation Criteria
Deleting Requirements
Hierarchical Numbers
Displaying the requirement hierarchical numbers
Inplace Visualizations
Editing and Deleting Traces
Enabling Move Requirement
Enabling Shared and Mapped Requirements
Shared Requirements
Enabling Shared Requirements
Mapped Requirements Diagram
Mapping Requirements
Unmapping Requirements
Formatting Fonts
Changing Internet Settings to Change Fonts
Formatting Requirement texts
Generating URL for a requirement
Import Using Data from a Typical Export
Importing Requirements from Microsoft Word
Linking a Reference Document
Modifying Requirements
Receiving Requirement Change Notifications (Registered Interest)
Searching Requirements
Searching Requirements Containing Matching Text Strings
Using Web to manage requirements
Using Web View
Requirement Grid
Opening the Requirement Grid from Author
Open Requirement Grid from Web Client
Viewing All Requirements in This Baseline
Opening Previously Saved Grid
Searching for Specific Data
Creating a Report from the Requirement Grid
Creating Document Factory Reports from the Requirements Grid
Filtering the Requirement Grid
Go To Requirement
Modifying Requirement Responsibility on the Grid
Modifying the Grid View
Printing the Grid View
Saving the Grid View
Sorting Requirements
Filtering Columns in the Requirement Grid
Requirement History
Viewing Requirement History Record
Viewing Change Details
Requirement References
Creating a Requirement from a Document
Creating Document References
Deleting a Document Reference
Modifying a Referenced Document
Setting a Document Reference as the Key Reference
Viewing Document References
Creating Web Reference
Linking Text Within Reference
Reports
Customized Requirement Reports
Creating a Report from the Requirement Grid
Creating Document Factory Reports from the Requirements Grid
Creating Administrative Reports
Creating Usage Reports
Creating Baseline Signature Reports
Creating Document Factory Reports
Creating Reports on Subsets of Requirements
Creating Reports Using Document Factory Filters
Creating the commandline.ini file
Running Document Factory from the command line
Creating Requirement Reports
Viewing Detail Report for an Individual Requirement
Creating Status Report
Creating Responsibility Report
Drag and Drop File Creation
Agile Requirements
Delivery Status
Configuring StarTeam Agile with Caliber
Configuring Rally integration with Caliber
Team Foundation Server Integration
Tracing requirements to items
Creating user stories from requirements
Removing user story link from requirement
Viewing Delivery Status
Traceability
Traceability Diagram
The Traceability Matrix
Opening the Traceability Matrix
Creating a trace between requirements from the Traceability Matrix
Modifying Trace Links in the Traceability Matrix
Viewing traceability between many requirements using the Traceability Matrix
Filtering Traceability Matrix
Printing Traceability Matrix
Configuring HP Quality Center integration with Caliber
Creating Traces Between Requirements and Quality Center Test Cases
Enabling traceability to external objects
Configuring Silk Central Test Manager with Caliber
Logging into SCTM 2008
Enabling integration between SCTM and Caliber
Enabling traceability to SCTM
Creating traces between SCTM test definitions and Caliber requirements
Synchronizing requirements between SCTM and Caliber
Managing Caliber baselines in SCTM projects
Creating traces between Caliber requirements and SCTM (2006 2007) test plans
Connecting to a Team Foundation Server
Adding a Microsoft Team Foundation Server to the drop-down list
Creating Traces Between Requirements and Visual Studio Team System artifacts
Viewing Microsoft Visual Studio Team System Test Results
Viewing Test Results after a Trace is Created
StarTeam Integration Configuration
Creating Traces Between Requirements and StarTeam artifacts
Enabling traceability to external objects
Creating Traceability Filters
Edit or Deleting filters
Copying a filter
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
Editing or modifying traces to or from Borland Together designs
Deleting a Traceability Link
Deleting the traceability link using Traceability Modification dialog box
Editing and Deleting Traces
Enabling Project Traceability to Software Artifacts
Modifying Traces on the Traceability Tab
Viewing Traceability
Traceability Reports
Glossaries
Glossary View
Assigning Glossaries
Creating a Glossary
Creating Glossary Terms
Modifying Glossary Terms
Deleting Glossary Terms
Exporting Glossaries
Importing Glossaries
Modifying Glossaries
Deleting a Glossary
Reusing Glossaries
Baselines
Baseline Support for SCTM Integration
Comparing Baselines
Creating and Defining Baselines
Importing Signature Meanings
Initializing Baselines after Creating Baselines
Creating Baseline Administrator
Creating Baseline Signature Reports
Creating Baselines in Administrator
Importing Signature Meanings
Initializing a Baseline
Locking Baselines
Modifying Baselines
Electronic Signature for Baselines
Signing a Baseline
Tracking Changes between Baselines
Deleting Baselines
Export
Export Data for Import to a Server
Exporting data for import to another application
Selecting Object Field
Exporting Requirements to CSV Files
Publishing Requirements to StarTeam
Specifying Caliber Properties
Selecting Caliber Requirements
Specifying StarTeam Properties
Mapping Caliber Properties to StarTeam Properties
Saving Configuration Property Settings
Publishing Requirements to StarTeam
Opening Publisher to StarTeam
Export of Special Characters
Export Tables
RM Export Object Formats
Project Field Format
Requirement Field Format
Requirement Type Field Format
User Field Format
UDA Field Format
Group Field Format
Import
Import Using Data from a Typical Export
Import Using Data from an Export Containing Visualize Objects
Importing Requirements from Microsoft Word
Performing an Advanced Import
Validation
Defining Validation Procedure
Specifying Requirement Validation Criteria
Messages
Caliber Visualize Help
Welcome to Caliber Visualize
Getting Started
Accessing and Exiting
Logging on as a Administrator for the First Time
Logging On with the Default User Account
Logging On to
Logging Off and Exiting
Introducing Caliber Visualize
What is Caliber Visualize
Benefits of Caliber Visualize
What You Can Do with Caliber Visualize
Visualizations
Scenarios
Simulations
Test Case Insight
Custom Reports
Managing Project Changes
Tour of the User Interface
Workspace
Workspace Menu Bar
Start Page
Project View
Project Explorer
Project Asset Tabs
Project Scenarios Tab
Scenario Designer
Storyboard Viewer
Project Simulations Tab
Simulation Designer
Screen Editor
Business Data Tab
Table Designer
Images Tab
Project Templates Tab
Template Editor
Project Actors Tab
Details Window
Project View Right-Click Menus
Scenarios Right-Click Menus
Simulations Right-Click Menus
Data Right-Click Menus
Images Right-Click Menus
Templates Right-Click Menus
Actors Right-Click Menus
Admin Console
Sample Project
Tutorial
Tutorial Objective
Step 1 - Enable a Project
Step 2 - Create a Scenario
Step 3 - Add Swimlanes to a Scenario
Step 4 - Running A Scenario Storyboard
Step 5 - Adding Discussions to a Scenario Storyboard
Step 6 - Create a Simulation
Step 7 - Add the Login Screen to the Simulation Diagram
Step 8 - Add the Welcome Screen to the Simulation Diagram
Step 9 - Create the Customer Maintenance Simulation
Step 10 - Run the Simulation
Step 11 - Add Discussions to the Simulation
Step 12 - Trace a Visualization to and from a Requirement
Projects
Enabling a Project
Opening a Project
Managing Projects
Duplicating a New Project
Configuring a Project
Allowing Access to a Simulation
Locking and Unlocking a Project
Exporting a Project
Importing a Project
Using Pulse to View Project Updates
Using Copy and Paste for Visualizations
Using Cut Copy and Paste for Requirements
Undoing Changes in Visualizations
Finding Project Assets
Visualizations
Scenarios
Creating a New Scenario
Renaming a Scenario
Deleting a Scenario
Selecting Multiple Objects in a Scenario
Scenario Diagram Overview
Creating and Configuring Steps
Creating a Step in a Scenario Diagram
Configuring a Step in a Scenario
Adding a Resource a Step in the Diagram
Creating and Configuring Decisions
Creating a Decision Step in a Scenario Diagram
Configuring a Decision Step in a Scenario
Assigning an Actor with a Decision in a Scenario
Assigning a Resource to a Decision Step
Linking Scenarios and Simulations
Creating an Invoke Step to Connect to Other Scenarios
Linking a Simulation to a Scenario Step
Creating a Rich Text Area in a Scenario Diagram
Working with Actors
Creating an Actor
Configuring an Actor
Configuring the Color for an Actor
Assigning an Actor to a Step in a Scenario
Working with Swimlanes
Creating Swimlanes
Adding a Swimlane to Existing Swimlanes
Configuring Swimlanes
Deleting a Swimlane
Deleting a Swimlane Container and All Associated Swimlanes
Using a Grid and Connector Lines in Diagrams
Setting the Designer Grid Options
Setting the Default Connector Line Shape
Connecting Steps
Labeling Connectors in a Diagram
Changing the Active Connector Line Shape and Style
Moving a Connector Line
Deleting a Connector Line
Exporting a Scenario Diagram as an Image
Running a Scenario Storyboard
Running a Scenario Storyboard from the Scenario Designer
Simulations
Creating a Simulation
Renaming a Simulation
Deleting a Simulation
Setting the Default Simulation
Simulation Diagram Overview
Using Screen Actions
Creating a Screen Action
Creating a New Screen Action from a Template
Applying a Template to a Screen Action
Customizing Screen Action HTML
Importing HTML into the HTML Override Page
Undoing Changes in Visualizations
Working with the Screen Editor
Opening the Screen Editor
Creating a Screen Object with Drag and Drop
Setting the Screen Editor Grid Options
Setting Properties for a Screen Object
Selecting and Moving a Group of Screen Objects
Resizing a Screen Object in the Screen Editor
Arranging the Order of Screen Objects
Exporting a Screen Action as an Image
Working with Rich Text
Creating a Rich Text Object
Editing a Rich Text Object
Setting Rich Text Properties
Working with Text
Creating a Text Box
Setting Text Box General Properties
Setting Text Box Category Properties
Working with Buttons
Creating a Button
Creating a Pop-up Window Button
Setting Button Properties
Changing the Image of a Button
Working with Images
Creating an Image
Setting Image Properties
Creating a Link for an Image
Deleting a Link from an Image
Resizing an Image in a Screen Action
Working with Text Links
Creating and Configuring a Text Link
Setting New Text Link Properties
Setting Text Link Font and Label Properties
Working with List Boxes
Creating a List Box
Setting List Box Properties
Working with Multiple Select List Boxes
Creating a Multiple-Select List Box
Setting Multiple-select List Box Properties
Working with Check Boxes
Creating a Check Box
Setting Check Box Properties
Working with Rectangles
Creating a Rectangle
Setting Rectangle Properties
Creating a Link for a Rectangle
Deleting a Link from a Rectangle
Working with Calendars
Creating a Calendar
Working with Script Widgets
Creating a Script Widget
Using the Form Builder
Using Decision Actions
Creating a Decision Action
Configuring a Decision Action
Using Logic
Creating a Logic Action
Configuring a Logic Action
Customizing Logic Action JavaScript
Importing JavaScript into the JavaScript Override Page
Using Redirects
Creating a Redirect Action
Configuring a Redirect in a Simulation
Setting a Destination for a Redirect
Creating a Rich Text Area in a Simulation Diagram
Using a Grid and Connector Lines in Diagrams
Setting the Designer Grid Options
Setting the Default Connector Line Shape
Connecting Steps
Labeling Connectors in a Diagram
Changing the Active Connector Line Shape and Style
Moving a Connector Line
Deleting a Connector Line
Exporting a Simulation Diagram as an Image
Viewing a Simulation in a Web Browser
Running a Simulation from the Details Window
Running the Default Simulation
Running a Simulation from the Simulation Diagram
Requesting a Simulation Review
Allowing Access to a Simulation
Sending a Simulation Link to a Reviewer
Restricting Access to a Project Simulation
Enhancing a Basic Simulation
Using Templates
Creating a Template
Applying a Template to a Screen Action
Applying a Template to a Screen Action with Drag and Drop
Creating a New Screen Action from a Template
Exporting a Template as an Image
Working with the Template Editor
Opening the Template Editor
Creating a Template Object with Drag and Drop
Setting Properties for a Template Object
Selecting and Moving a Group of Template Objects
Resizing a Template Object in the Template Editor
Arranging the Order of Template Objects
Setting the Template Editor Grid Options
Working with Data Tables
Creating a Data Table
Adding a Row to a Data Table
Deleting a Row from a Data Table
Adding a Column to a Data Table
Deleting a Column from a Data Table
Changing Column Order in a Data Table
Refreshing a Data Table
Using a Data Table in a Screen Action
Importing Data from a Spreadsheet
Creating a Data Table from an Imported CSV File
Using the Logic Editor with Data Tables
Assigning a Variable to a Logic Action
Configuring Logic Action to Select Data
Configuring Logic Action to Insert Data
Configuring Logic Action to Update Data
Configuring Logic Action to Delete Data
Using Variables
Creating a Variable Object for a Screen Action
Creating a Variable for a Logic Action
Assigning a Variable to a Logic Action
Using Images
Importing and Adding New Images to a Project
Deleting an Image from a Project
Configuring an Image
Previewing an Image
Viewing an Image and Providing Feedback
Renaming an Image
Adding an Image to a Screen Action
Deleting an Image from a Screen Action
Resizing an Image in a Screen Action
Exporting a Screen Action as an Image
Exporting a Scenario Diagram as an Image
Exporting a Simulation Diagram as an Image
Exporting a Template as an Image
Starting a Discussion
Viewing and Adding to Discussions in the Details Window
Commenting on Submitted Discussions in the Details Window
Reviewing a Simulation and Creating Discussions
Creating Discussions from a Storyboard
Viewing and Hiding Replies to Discussions
Creating a Note
Viewing and Adding Notes in the Details Window
Test Case Insight
Working with Test Cases
Generating and Viewing a Test Case
Exporting a Test Case
Test Case Structure
Using Magnitude in
Using Magnitude at the Project Level
Using Magnitude with Scenarios
Using Magnitude with Simulations
Changing a Default Magnitude Value
Magnitude Default Values
Custom Reports
Creating a Report
Including Images in a Report
For Reviewers Displaying Assets From Reports
Opening a Scenario Diagram from a Report
Opening a Storyboard from a Report
Opening a Simulation from a Report
Opening a Simulation Diagram from a Report
Viewing a Template from a Report for Reviewers
For Users Opening Assets From a Report
Opening a Scenario Diagram from a Report
Opening a Storyboard from a Report
Opening a Simulation from a Report
Opening a Simulation Diagram from a Report
Opening a Template from a Report
Administering
Logging On with the Administrator Account
Logging On with the Administrator Account
Changing the Administrator Password
Managing the System
Accessing System Options
Modifying General Options
Accessing Database Information
Accessing Error Logs
Parking a Project
Unparking a Project
Working with User Accounts and Workspaces
Managing Locks
Overriding a Lock
Enabling SSL Communication
Caliber Integration
Administering the - Caliber Integration
Requirements for the Caliber Integration
Changing the Caliber Data Server Settings
Caliber Security Model
Authenticating Users
Managing Users and Groups with Caliber and
Managing Profiles for Caliber Users
Setting Up Your Profile for Caliber Users
Working with Integrated - Caliber Projects
Creating an Integrated - Caliber Project
Integrating with an Existing Caliber Project
Deleting an Integrated - Caliber Project
Importing an Integrated - Caliber Project
Viewing and Working with Visualization Assets in Caliber
Requirements Types
Formatting and Rich Text
Opening a Visualization in Caliber
Creating Custom Caliber Reports
Adding Notes to an Integrated Project
Viewing Traces
Modifying Requirement Traces
SilkCentral Test Manager Integration
Configuring the SilkCentral Test Manager Integration
Viewing SilkCentral Test Manager Quality Metrics
Creating a Quality Traceability Report
Quality Insight Dialog Box
Customer Support
Installation Help
Introduction
Borland Support
Installing Server Components
Installing Caliber Data Server
Installing both Client and Server
Installing the Server Alone
Installing Caliber and a 64-bit Versant DB on a 64-bit Server
Installing MPX Services
Configuring MPX Services
Reconnecting MPX Services
Restarting the MPX Server
Installing LDAP User Import
Installing Caliber for Microsoft Team Foundation Server
Silent Installation of Caliber on Visual Studio Team Foundation Server
Installing Caliber for Web
Installing Caliber Author and Components
Installing Caliber Author
Installing Typical or Full Caliber Author
Custom Installation
Silent Install of Caliber Author
Installing Caliber Plug-in for Eclipse Client
Installing Caliber Plug-in for Microsoft Visual Studio 2005
Installing Caliber Plug-in for Microsoft Visual Studio 2008
Installing the Caliber Plug-in for Microsoft Visual Studio 2010
Installing the Caliber Plug-in for Visual Studio Team System
Silent installation of Caliber for Visual Studio Team System
Installing Caliber SDK
Installing Only Caliber Author
Installing Caliber Visualize
Introduction to Caliber Visualize
Upgrading from a Previous Release of TeamDefine or CaliberRDM
Installing Caliber Visualize Overview
Installing Caliber Visualize
Starting or Stopping the Service
Changing the Default Server TCP/IP Port Numbers
Enabling SSL Communication
Installing and Integrating with Caliber Overview
Requirements for the Caliber Integration
Installing and Integrating with Caliber
Configuring the Appearance of Assets in Caliber Visualize
Changing the Caliber Data Server Settings
Uninstalling
Logging on to
Logging On with the Default User Account
Logging on as a Administrator for the First Time
Application Startup Troubleshooting Guide
Installing Caliber Review
Performing an Upgrade
Data Server Upgrade
Upgrading Data Server from 11.0 to 11.1
Upgrading Server Components from 10.1 or Earlier
Manually Upgrading Server Components
Important information for HP Quality Center customers
Upgrading Client Components
Upgrading Caliber for Microsoft Visual Studio Team System
Information for Datamart Users
Upgrading from CaliberRDM to Caliber Visualize
Program Maintenance
Caliber Help
Welcome to Caliber
Getting Started
Requirements Management
Agile Requirements
Overview
Caliber Administrator
Tour of the Caliber User Interface
Product Integrations
StarTeam Toolbar
Toolbar
User Connections Monitor
Extending Functionality
Web Client and Web Viewer
Administrative Procedures
Managing the Borland License Server
End-User Procedures
Logging on to Caliber
Logging onto Web Client
Logging onto Web Viewer
Logging onto Administrator
Changing Password
Changing Your Password
Creating Custom Tools
Adding Words in Custom Dictionary
Invoking Spell Checker
Find in Tree
Customizing Quick Access
Adding StarTeam Toolbar Window
Generating URL for a requirement
Options Dialog Box Tabs
General Tab
Hide Tab
Appearance Tab
Communication Tab
Clipboard Tab
Wizards Tab
Spelling Tab
Cache Tab
Disk Cache Tab
Custom Tools Tab
Administrating Servers
Creating Administrators
Managing the Borland License Server
Enabling LDAP
Generating Logs for Clients
Generating Logs for Data Server
Relocating a Server
Setting up Data Server
Importing Project Information
Database Administration
Scheduling a Daily Database Backup
Backing up Database
Changing the Database Owner
Creating a New Database Using DB Manager
Restoring a Database
Database Manager Commands
Command Switches
Administrating Projects
Administrators
Administrative tasks
Projects
Vendor Add-in module
Assigning Groups Project admin to a Project
Assigning Project Administrator
Creating a Requirement Type
Creating Security Profiles
Defining Projects
Specifying Project Access Rights
Setting Requirement Types
Enabling Email Notifications
Enabling Traceability to External Objects
Changing Caliber Visualize Server URL
Defining the Requirement Type
Setting Requirement Types Within a Project
Deleting Custom Tabs
Enabling Automatic Notification
Enabling Move Requirement
Enabling Other Integrations
Enabling Shared Requirements
Find in Tree
Logging on to Caliber
Modifying Projects
Mapping Requirements
Modifying a Requirement Type
Modifying a User-Defined Attribute
Modifying User Lists within a Project
Setting Security in a Project
Setting the User Password
Setting Up Automatic Notification
Unmapping Requirements
Requirement Types
Assigning User-Defined Attributes to a Requirement Type
Creating a Custom Tab
Changing Custom Tab Icons
Creating a Requirement Type
Defining the Requirement Type
Deleting Custom Tabs
Deleting a Requirement Type
Modifying a Requirement Type
Setting Requirement Types Within a Project
Setting the Default Security Access for a Requirement Type
Access Levels
Administrative Reports
Attributes
Arranging User-Defined Attribute in Order
Assigning Attribute Values
Assigning User-Defined Attributes to a Requirement Type
Creating User-Defined Attribute
Deleting User-Defined Attribute
Modifying a User-Defined Attribute
Command Switches
Discussions
Enabling Discussion Notification
Posting Discussion Messages
Reading a message
Replying to Discussion Messages
Viewing the Unread Discussion List
Document Factory
Creating a Document Using Document Factory
Document Factory Syntax
Semantics and Structure
Multiple Project Reports
Document Factory Commands
Keywords
Global Keywords
Specific Keywords
Operators
Compare Operators
LIKE Operator Wildcards
Logical Operators
Mathematical Operators
Using Filters within Document Factory
Creating Tables in Document Factory
Printing Glossary Terms in the Table
Printing Requirement History in a Table
Printing Requirement Discussions in a Table
Printing Lists (References Responsibilities and UDA) in a table
Printing Traces in a Table
Embedding a Table
Printing Requirements for Multiple Projects
Importing the Certificate File
Creating the commandline.ini file
Running Document Factory from the command line
Users
Export Directory Structure
Import Directory Structure
Enabling Shared and Mapped Requirements
Export Tables
Licensing
Security
Security Profiles
Creating a Security Profile
Deleting Security Profiles
Modifying Security Profiles
Setting the Default Security Access for a Requirement Type
Vendor Add-in module
Web Access
Using Caliber to Manage Requirements
Requirements
Requirement Descriptions
Spelling Checker Options
Requirement Views
Adding Hyperlinks to Requirement Descriptions
Editing a Hyperlink
Adding Pictures to Requirement Descriptions
Adding Tables to Requirement Descriptions
Assigning Attribute Values
Assigning Responsible Users
Changing the Requirement Order
Changing Requirement Order with Drag and Drop
Comparing Requirements
Comparing Requirements to Different Versions
Copying Requirements
Creating Requirements
Defining Requirements
Specifying Requirement Validation Criteria
Deleting Requirements
Hierarchical Numbers
Displaying the requirement hierarchical numbers
Inplace Visualizations
Editing and Deleting Traces
Enabling Move Requirement
Enabling Shared and Mapped Requirements
Shared Requirements
Enabling Shared Requirements
Mapped Requirements Diagram
Mapping Requirements
Unmapping Requirements
Formatting Fonts
Changing Internet Settings to Change Fonts
Formatting Requirement texts
Generating URL for a requirement
Import Using Data from a Typical Export
Importing Requirements from Microsoft Word
Linking a Reference Document
Modifying Requirements
Receiving Requirement Change Notifications (Registered Interest)
Searching Requirements
Searching Requirements Containing Matching Text Strings
Using Web to manage requirements
Using Web View
Requirement Grid
Opening the Requirement Grid from Author
Open Requirement Grid from Web Client
Viewing All Requirements in This Baseline
Opening Previously Saved Grid
Searching for Specific Data
Creating a Report from the Requirement Grid
Creating Document Factory Reports from the Requirements Grid
Filtering the Requirement Grid
Go To Requirement
Modifying Requirement Responsibility on the Grid
Modifying the Grid View
Printing the Grid View
Saving the Grid View
Sorting Requirements
Filtering Columns in the Requirement Grid
Requirement History
Viewing Requirement History Record
Viewing Change Details
Requirement References
Creating a Requirement from a Document
Creating Document References
Deleting a Document Reference
Modifying a Referenced Document
Setting a Document Reference as the Key Reference
Viewing Document References
Creating Web Reference
Linking Text Within Reference
Reports
Customized Requirement Reports
Creating a Report from the Requirement Grid
Creating Document Factory Reports from the Requirements Grid
Creating Administrative Reports
Creating Usage Reports
Creating Baseline Signature Reports
Creating Document Factory Reports
Creating Reports on Subsets of Requirements
Creating Reports Using Document Factory Filters
Creating the commandline.ini file
Running Document Factory from the command line
Creating Requirement Reports
Viewing Detail Report for an Individual Requirement
Creating Status Report
Creating Responsibility Report
Drag and Drop File Creation
Agile Requirements
Delivery Status
Configuring StarTeam Agile with Caliber
Configuring Rally integration with Caliber
Team Foundation Server Integration
Tracing requirements to items
Creating user stories from requirements
Removing user story link from requirement
Viewing Delivery Status
Traceability
Traceability Diagram
The Traceability Matrix
Opening the Traceability Matrix
Creating a trace between requirements from the Traceability Matrix
Modifying Trace Links in the Traceability Matrix
Viewing traceability between many requirements using the Traceability Matrix
Filtering Traceability Matrix
Printing Traceability Matrix
Configuring HP Quality Center integration with Caliber
Creating Traces Between Requirements and Quality Center Test Cases
Enabling traceability to external objects
Configuring Silk Central Test Manager with Caliber
Logging into SCTM 2008
Enabling integration between SCTM and Caliber
Enabling traceability to SCTM
Creating traces between SCTM test definitions and Caliber requirements
Synchronizing requirements between SCTM and Caliber
Managing Caliber baselines in SCTM projects
Creating traces between Caliber requirements and SCTM (2006 2007) test plans
Connecting to a Team Foundation Server
Adding a Microsoft Team Foundation Server to the drop-down list
Creating Traces Between Requirements and Visual Studio Team System artifacts
Viewing Microsoft Visual Studio Team System Test Results
Viewing Test Results after a Trace is Created
StarTeam Integration Configuration
Creating Traces Between Requirements and StarTeam artifacts
Enabling traceability to external objects
Creating Traceability Filters
Edit or Deleting filters
Copying a filter
Creating Traces Between Requirements
Creating Traces Between Requirements and Software Artifacts
Editing or modifying traces to or from Borland Together designs
Deleting a Traceability Link
Deleting the traceability link using Traceability Modification dialog box
Editing and Deleting Traces
Enabling Project Traceability to Software Artifacts
Modifying Traces on the Traceability Tab
Viewing Traceability
Traceability Reports
Glossaries
Glossary View
Assigning Glossaries
Creating a Glossary
Creating Glossary Terms
Modifying Glossary Terms
Deleting Glossary Terms
Exporting Glossaries
Importing Glossaries
Modifying Glossaries
Deleting a Glossary
Reusing Glossaries
Baselines
Baseline Support for SCTM Integration
Comparing Baselines
Creating and Defining Baselines
Importing Signature Meanings
Initializing Baselines after Creating Baselines
Creating Baseline Administrator
Creating Baseline Signature Reports
Creating Baselines in Administrator
Importing Signature Meanings
Initializing a Baseline
Locking Baselines
Modifying Baselines
Electronic Signature for Baselines
Signing a Baseline
Tracking Changes between Baselines
Deleting Baselines
Export
Export Data for Import to a Server
Exporting data for import to another application
Selecting Object Field
Exporting Requirements to CSV Files
Publishing Requirements to StarTeam
Specifying Caliber Properties
Selecting Caliber Requirements
Specifying StarTeam Properties
Mapping Caliber Properties to StarTeam Properties
Saving Configuration Property Settings
Publishing Requirements to StarTeam
Opening Publisher to StarTeam
Export of Special Characters
Export Tables
RM Export Object Formats
Project Field Format
Requirement Field Format
Requirement Type Field Format
User Field Format
UDA Field Format
Group Field Format
Import
Import Using Data from a Typical Export
Import Using Data from an Export Containing Visualize Objects
Importing Requirements from Microsoft Word
Performing an Advanced Import
Validation
Defining Validation Procedure
Specifying Requirement Validation Criteria
Messages
Caliber Visualize Help
Welcome to Caliber Visualize
Getting Started
Accessing and Exiting
Logging on as a Administrator for the First Time
Logging On with the Default User Account
Logging On to
Logging Off and Exiting
Introducing Caliber Visualize
What is Caliber Visualize
Benefits of Caliber Visualize
What You Can Do with Caliber Visualize
Visualizations
Scenarios
Simulations
Test Case Insight
Custom Reports
Managing Project Changes
Tour of the User Interface
Workspace
Workspace Menu Bar
Start Page
Project View
Project Explorer
Project Asset Tabs
Project Scenarios Tab
Scenario Designer
Storyboard Viewer
Project Simulations Tab
Simulation Designer
Screen Editor
Business Data Tab
Table Designer
Images Tab
Project Templates Tab
Template Editor
Project Actors Tab
Details Window
Project View Right-Click Menus
Scenarios Right-Click Menus
Simulations Right-Click Menus
Data Right-Click Menus
Images Right-Click Menus
Templates Right-Click Menus
Actors Right-Click Menus
Admin Console
Sample Project
Tutorial
Tutorial Objective
Step 1 - Enable a Project
Step 2 - Create a Scenario
Step 3 - Add Swimlanes to a Scenario
Step 4 - Running A Scenario Storyboard
Step 5 - Adding Discussions to a Scenario Storyboard
Step 6 - Create a Simulation
Step 7 - Add the Login Screen to the Simulation Diagram
Step 8 - Add the Welcome Screen to the Simulation Diagram
Step 9 - Create the Customer Maintenance Simulation
Step 10 - Run the Simulation
Step 11 - Add Discussions to the Simulation
Step 12 - Trace a Visualization to and from a Requirement
Projects
Enabling a Project
Opening a Project
Managing Projects
Duplicating a New Project
Configuring a Project
Allowing Access to a Simulation
Locking and Unlocking a Project
Exporting a Project
Importing a Project
Using Pulse to View Project Updates
Using Copy and Paste for Visualizations
Using Cut Copy and Paste for Requirements
Undoing Changes in Visualizations
Finding Project Assets
Visualizations
Scenarios
Creating a New Scenario
Renaming a Scenario
Deleting a Scenario
Selecting Multiple Objects in a Scenario
Scenario Diagram Overview
Creating and Configuring Steps
Creating a Step in a Scenario Diagram
Configuring a Step in a Scenario
Adding a Resource a Step in the Diagram
Creating and Configuring Decisions
Creating a Decision Step in a Scenario Diagram
Configuring a Decision Step in a Scenario
Assigning an Actor with a Decision in a Scenario
Assigning a Resource to a Decision Step
Linking Scenarios and Simulations
Creating an Invoke Step to Connect to Other Scenarios
Linking a Simulation to a Scenario Step
Creating a Rich Text Area in a Scenario Diagram
Working with Actors
Creating an Actor
Configuring an Actor
Configuring the Color for an Actor
Assigning an Actor to a Step in a Scenario
Working with Swimlanes
Creating Swimlanes
Adding a Swimlane to Existing Swimlanes
Configuring Swimlanes
Deleting a Swimlane
Deleting a Swimlane Container and All Associated Swimlanes
Using a Grid and Connector Lines in Diagrams
Setting the Designer Grid Options
Setting the Default Connector Line Shape
Connecting Steps
Labeling Connectors in a Diagram
Changing the Active Connector Line Shape and Style
Moving a Connector Line
Deleting a Connector Line
Exporting a Scenario Diagram as an Image
Running a Scenario Storyboard
Running a Scenario Storyboard from the Scenario Designer
Simulations
Creating a Simulation
Renaming a Simulation
Deleting a Simulation
Setting the Default Simulation
Simulation Diagram Overview
Using Screen Actions
Creating a Screen Action
Creating a New Screen Action from a Template
Applying a Template to a Screen Action
Customizing Screen Action HTML
Importing HTML into the HTML Override Page
Undoing Changes in Visualizations
Working with the Screen Editor
Opening the Screen Editor
Creating a Screen Object with Drag and Drop
Setting the Screen Editor Grid Options
Setting Properties for a Screen Object
Selecting and Moving a Group of Screen Objects
Resizing a Screen Object in the Screen Editor
Arranging the Order of Screen Objects
Exporting a Screen Action as an Image
Working with Rich Text
Creating a Rich Text Object
Editing a Rich Text Object
Setting Rich Text Properties
Working with Text
Creating a Text Box
Setting Text Box General Properties
Setting Text Box Category Properties
Working with Buttons
Creating a Button
Creating a Pop-up Window Button
Setting Button Properties
Changing the Image of a Button
Working with Images
Creating an Image
Setting Image Properties
Creating a Link for an Image
Deleting a Link from an Image
Resizing an Image in a Screen Action
Working with Text Links
Creating and Configuring a Text Link
Setting New Text Link Properties
Setting Text Link Font and Label Properties
Working with List Boxes
Creating a List Box
Setting List Box Properties
Working with Multiple Select List Boxes
Creating a Multiple-Select List Box
Setting Multiple-select List Box Properties
Working with Check Boxes
Creating a Check Box
Setting Check Box Properties
Working with Rectangles
Creating a Rectangle
Setting Rectangle Properties
Creating a Link for a Rectangle
Deleting a Link from a Rectangle
Working with Calendars
Creating a Calendar
Working with Script Widgets
Creating a Script Widget
Using the Form Builder
Using Decision Actions
Creating a Decision Action
Configuring a Decision Action
Using Logic
Creating a Logic Action
Configuring a Logic Action
Customizing Logic Action JavaScript
Importing JavaScript into the JavaScript Override Page
Using Redirects
Creating a Redirect Action
Configuring a Redirect in a Simulation
Setting a Destination for a Redirect
Creating a Rich Text Area in a Simulation Diagram
Using a Grid and Connector Lines in Diagrams
Setting the Designer Grid Options
Setting the Default Connector Line Shape
Connecting Steps
Labeling Connectors in a Diagram
Changing the Active Connector Line Shape and Style
Moving a Connector Line
Deleting a Connector Line
Exporting a Simulation Diagram as an Image
Viewing a Simulation in a Web Browser
Running a Simulation from the Details Window
Running the Default Simulation
Running a Simulation from the Simulation Diagram
Requesting a Simulation Review
Allowing Access to a Simulation
Sending a Simulation Link to a Reviewer
Restricting Access to a Project Simulation
Enhancing a Basic Simulation
Using Templates
Creating a Template
Applying a Template to a Screen Action
Applying a Template to a Screen Action with Drag and Drop
Creating a New Screen Action from a Template
Exporting a Template as an Image
Working with the Template Editor
Opening the Template Editor
Creating a Template Object with Drag and Drop
Setting Properties for a Template Object
Selecting and Moving a Group of Template Objects
Resizing a Template Object in the Template Editor
Arranging the Order of Template Objects
Setting the Template Editor Grid Options
Working with Data Tables
Creating a Data Table
Adding a Row to a Data Table
Deleting a Row from a Data Table
Adding a Column to a Data Table
Deleting a Column from a Data Table
Changing Column Order in a Data Table
Refreshing a Data Table
Using a Data Table in a Screen Action
Importing Data from a Spreadsheet
Creating a Data Table from an Imported CSV File
Using the Logic Editor with Data Tables
Assigning a Variable to a Logic Action
Configuring Logic Action to Select Data
Configuring Logic Action to Insert Data
Configuring Logic Action to Update Data
Configuring Logic Action to Delete Data
Using Variables
Creating a Variable Object for a Screen Action
Creating a Variable for a Logic Action
Assigning a Variable to a Logic Action
Using Images
Importing and Adding New Images to a Project
Deleting an Image from a Project
Configuring an Image
Previewing an Image
Viewing an Image and Providing Feedback
Renaming an Image
Adding an Image to a Screen Action
Deleting an Image from a Screen Action
Resizing an Image in a Screen Action
Exporting a Screen Action as an Image
Exporting a Scenario Diagram as an Image
Exporting a Simulation Diagram as an Image
Exporting a Template as an Image
Starting a Discussion
Viewing and Adding to Discussions in the Details Window
Commenting on Submitted Discussions in the Details Window
Reviewing a Simulation and Creating Discussions
Creating Discussions from a Storyboard
Viewing and Hiding Replies to Discussions
Creating a Note
Viewing and Adding Notes in the Details Window
Test Case Insight
Working with Test Cases
Generating and Viewing a Test Case
Exporting a Test Case
Test Case Structure
Using Magnitude in
Using Magnitude at the Project Level
Using Magnitude with Scenarios
Using Magnitude with Simulations
Changing a Default Magnitude Value
Magnitude Default Values
Custom Reports
Creating a Report
Including Images in a Report
For Reviewers Displaying Assets From Reports
Opening a Scenario Diagram from a Report
Opening a Storyboard from a Report
Opening a Simulation from a Report
Opening a Simulation Diagram from a Report
Viewing a Template from a Report for Reviewers
For Users Opening Assets From a Report
Opening a Scenario Diagram from a Report
Opening a Storyboard from a Report
Opening a Simulation from a Report
Opening a Simulation Diagram from a Report
Opening a Template from a Report
Administering
Logging On with the Administrator Account
Logging On with the Administrator Account
Changing the Administrator Password
Managing the System
Accessing System Options
Modifying General Options
Accessing Database Information
Accessing Error Logs
Parking a Project
Unparking a Project
Working with User Accounts and Workspaces
Managing Locks
Overriding a Lock
Enabling SSL Communication
Caliber Integration
Administering the - Caliber Integration
Requirements for the Caliber Integration
Changing the Caliber Data Server Settings
Caliber Security Model
Authenticating Users
Managing Users and Groups with Caliber and
Managing Profiles for Caliber Users
Setting Up Your Profile for Caliber Users
Working with Integrated - Caliber Projects
Creating an Integrated - Caliber Project
Integrating with an Existing Caliber Project
Deleting an Integrated - Caliber Project
Importing an Integrated - Caliber Project
Viewing and Working with Visualization Assets in Caliber
Requirements Types
Formatting and Rich Text
Opening a Visualization in Caliber
Creating Custom Caliber Reports
Adding Notes to an Integrated Project
Viewing Traces
Modifying Requirement Traces
SilkCentral Test Manager Integration
Configuring the SilkCentral Test Manager Integration
Viewing SilkCentral Test Manager Quality Metrics
Creating a Quality Traceability Report
Quality Insight Dialog Box
Customer Support
Enterprise
Micro Focus Enterprise Developer 2.1 Update 1 for Eclipse
Welcome
The Micro Focus Community
Overview of application development in Eclipse
Tour of the Eclipse IDE for Enterprise Developer
Remote mainframe development and workflow modeling
Enterprise Developer Editions and Licenses
To activate Enterprise Developer Personal Edition
To request and activate a 30-days trial license for Enterprise Developer
To buy and activate a full unlimited license
New Features
New features in Enterprise Developer 2.1 Update 1
Features Added in Enterprise Developer 2.1
Features Added in Enterprise Developer 2.0
Enterprise Developer tutorials
Product Information
Installing Enterprise Developer
System Requirements
Hardware requirements
Operating Systems Supported
Software Requirements
Installing Enterprise Developer for Eclipse
Installation restrictions and requirements
Downloading the Product
Installing
Installing Silently on Windows
Installing into different Eclipse packages
Installing Micro Focus Enterprise Developer UNIX Components
Downloading the Product
Installing
UNIX Installer Issues
Configuring the Remote System Explorer Support
Repairing
Installing Mainframe Access Server
Installing the mainframe components
After Installing
Installing X Windows on Windows
Repairing
Uninstalling
Updates and Product Support
Micro Focus End User License Agreement
Third Party Software
Database Access Support with Native COBOL
Database Access under Enterprise Server
Java Development Kit (JDK)
Java 2 Enterprise Edition (J2EE) Support
Known Errors in J2EE Third Party Software
Restrictions on UNIX and Linux in Third Party Software
Known Errors and Restrictions
COBOL Programming
Arithmetic Calculation
Boolean Data Items
CBL2XML Utility
Enhanced ACCEPT/DISPLAY Syntax (Adis)
Filenames
IDXFORMAT 8 File Size Limits
Managed COBOL: the REDEFINE clause of the PROPERTY keyword
Unsupported Features
XML Extensions
XML Support and Syntax Extensions
Compatibility
Co-existing with Earlier Micro Focus Products
ACUCOBOL Windowing Syntax
Micro Focus Vision
Installation
Data Access
COBSQL
DB2
File Handling
Records with Alternate Keys
OpenESQL
Java EE App Server Support
JVM Code
JVM COBOL support
Adding Projects to a COBOL JVM Project's Java Build Path
Compiling JVM COBOL Applications
Consolidated Tracing Facility and COBOL JVM Applications
Editing Remote JRE Settings
Interface Mapping Toolkit
Using Java and COBOL Together
Mainframe Programming and Management
Assembler Emulation
CICS Web Interface
CodeWatch
DOCUMENT APIs
General Open PL/I Issues
Historical Statistics Facility (HSF)
IMS MFS Displays
Installing Mainframe Access Server
JCL Utilities
Mainframe Subsystem Support (MSS)
PL/I Syntax
Run-time Behavior
User ID and password constraints in Enterprise Server
Problem Determination and Diagnostic Tools
Consolidated Tracing Facility and COBOL JVM Applications
Debugging in Eclipse
Error Markers
Language Service
Remote Debugging
Test Coverage
Just-in-time debugging
Eclipse IDE
New project wizard error
Background Parsing
Leaking File Handles
Remote Development using Remote System Explorer
Mainframe in the Eclipse IDE
UNIX Installer Issues
Contacting Micro Focus
Further Information and Product Support
Information We Need
Contact information
Getting Started
Mainframe Tutorials
Getting Started with Micro Focus Enterprise Developer for Eclipse
Starting the Eclipse Integrated Development Environment
Importing the BankDemo project and adding the source files
Editing Source Files
Compiling the Source Code
Unit Testing the Batch Application
Unit Testing the Online Application
Debugging the Batch Application
Debugging the Online Application
Tutorial: Remote mainframe development
Installing the BankDemo Application
Installing the application on the mainframe
Customizing the application on the mainframe
Validating the Installation
Running the BankDemo Application
Creating a Filter to View Jobs
Creating a Filter to View Datasets
Submitting a Job from the MVS Explorer
Opening a Mainframe Application
Displaying and Editing COBOL Code from the Mainframe
Checking the syntax remotely (COBOL)
Checking the syntax remotely (Assembler)
Transferring a source member to a local workspace
Tutorials: CICS
Tutorial: CICS
Introduction
Create a Project
Create a Build Configuration
Specify Project Properties
Import the Files From the Demonstration Program
Configure Enterprise Server/MSS
Set Up and Run the ACCT Application
Debug the CICS Application
Tutorial: Web-Enabled CICS Acting as a Web Server
Introduction
Create Project and Configure Server
Create a Project
Create a build configuration
Specify project properties
Import Files from the Demonstration Program
Create an Enterprise Server
Configure the Enterprise Server
Create and Upgrade the CICS Resource Definition File
Start the ACCTWEB Server
Set Up the ACCTWEB Application
Initialize the VSAM File
Add Records to the VSAM File
Add Records
Run the ACCTWEB Application
Debug the Application
Configure Enterprise Server for Dynamic Debugging
Associate the Project with the Target Enterprise Server
Create a Debug Configuration for Your Project
Debug ACCTWEB
Tutorial: Web-Enabled CICS Acting as a Web Client
Introduction
Configure Enterprise Server for a Web-Enabled Application
Create a Project
Create a Build Configuration
Specify Project Properties
Import the Web Client Demo Program Files
Create an Enterprise Server
Configure the Enterprise Server
Create and Upgrade the CICS Resource Definition File
Start the ACCTCLNT Server
Set Up and Run the ACCTCLNT Application
Debug the Application
Configure Enterprise Server for Dynamic Debugging
Associate the Project with the Target Enterprise Server
Create a Debug Configuration for Your Project
Debug ACCTCLNT
Native COBOL Tutorials
Tutorial - Creating COBOL Applications in Eclipse
Create a Local COBOL Project
Create a File and Build Your Project
Run your Application
Create a build configuration
Launch a Debug Session
Managed COBOL Tutorials
Tutorial - Creating COBOL JVM Applications in Eclipse
Create a COBOL JVM Project
Create a Class and Build Your Project
Run your JVM Application
Launch a debug session
Tutorial - Creating a JSP web application
Set up the environment
Create a Dynamic Web Project
Create a COBOL JVM project
Add a reference to the Tomcat servlet API .jar file
Add an Ant file
Add a basic servlet to the project
Build and run the servlet
Create the book-rec.cpy copybook file
Create a COBOL program
Create a properties file for passing in the book filename
Create a JVM version of book-rec.cpy
Create the BookException class
Create the BookWrapper class
Edit the BookServlet class
Create the book-error-codes.cpy copybook
Deliver and deploy the application
Procedural COBOL Compared with Managed COBOL
Tutorial: Developing a PL/I application using Eclipse
Eclipse PL/I tutorial overview
Create a project
Create a PL/I source file, opdemo.pli
Create a build configuration
Create a PL/I source file, opdemo2.pli
Create a JCL file
Configure an enterprise server to run PLI programs under JCL
Configure an MSS-enabled enterprise server
Enable JES
Configure program paths
Add an initiator
Start the enterprise server
Associate your project with the enterprise server
Submit and run a JCL job
View the spool queues
View the catalog
Debug the program using CodeWatch
Configure the enterprise server for debugging
Edit the PLIDEBUG.DAT file
Start debugging
Debug using the CodeWatch GUI
Debug using the Command window
Sample Programs
Demonstrations of Mainframe Subsystem Support
Demonstrations of Visual 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
Upgrading to Enterprise Developer for Eclipse
Licensing Changes
Resolving Conflicts Between Reserved Keywords and Data Item Names
Importing and Scanning Existing COBOL Code
Recompile All Source Code
Upgrading from Net Express, Mainframe Express and 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
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
Enterprise Developer Co-existing with Earlier Micro Focus Products
Restrictions and Unsupported Features
CBL2XML Utility
COBOL Services as Java and Web Services
CSBIND
DBMS Preprocessors
FSView
GNT Analyzer
Host Compatibility Option (HCO)
INTLEVEL Support
NSAPI
Online Help System
OpenESQL
Secure Sockets Layer (SSL)
SQL Option for DB2
TX Series
Run-Time Technology Differences
File Handling
Test Coverage
Editing and Debugging Differences
Program Breakpoints
Remote Debugging
Source Pool View
Tips: Eclipse IDE Equivalents to IDE Features in Earlier Products
Upgrading from ACUCOBOL-GT
Upgrading from RM/COBOL®
Native COBOL compared with managed COBOL
Customer Feedback
Help on Help
Developing Applications in the IDE
Using Eclipse for COBOL Development
To create a COBOL application in Eclipse
COBOL Perspectives and Projects
The COBOL Editor
Searching for Files Using COBOL File Search
Viewing Copybooks in the Required Context
Creating COBOL Projects
Creating and importing COBOL projects
Project and file properties and configurations
Developing Applications on Remote Machines
To create and configure a connection to a remote machine
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
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
To convert a COBOL local project to a COBOL remote project
Converting Net Express Projects to Eclipse Projects
Creating and Importing Resources
Using Source Files From Outside Your Project
To create project dependencies
To remove project dependencies
To link to copybooks or sources outside the 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
To set properties and compiler directives on a single file
To set project-wide build properties and compiler directives
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
Order in which copybooks are searched for
Temporary Files Used when Compiling Native COBOL
Techniques for Compiling Quickly
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
Linking (UNIX)
Introduction to Linking
Linking and Linked File Types
Linking and Binding
Dynamic Loading
To clean a project
Tips: Building COBOL Projects
To set Compiler directives on a COBOL file
Debugging COBOL Applications
Debugging in Eclipse
To debug a COBOL program
Debugging COBOL Projects Using a Remote Machine
To create a debug configuration
Debugging in COBOL Copy View
Starting the Debugger Automatically Using Library Routines
Starting the debugger automatically using just-in-time debugging
Debugging Using a Core Dump
Debugging Mixed Language Applications
Debugging mainframe applications and services on Enterprise Server
How Debugging on Enterprise Server Works
To prepare for debugging on enterprise server
To debug on 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
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
Running COBOL applications
To run a COBOL application on your local machine
To run an application on a remote machine
Using Eclipse for PL/I development
Creating a PL/I project
Configuring PL/I projects
Compiling and building a PL/I project
Linking PL/I programs
Debugging a PL/I project
Running a PL/I project
Running Mainframe Applications on Enterprise Server
Server Explorer
To connect to a remote enterprise server
To access Enterprise Server Administration
To start, stop, or restart an enterprise server region from the IDE
To associate an enterprise server region with a Mainframe Subsystem Application
To submit a JCL file
To show the spool and the catalog
Test Coverage
Overview - Test Coverage
Report Files Created
Recompiling Programs
Restrictions when Using Test Coverage
Test Coverage Configuration File
Format of a Test Coverage Report
Reporting on Tagged Lines
Test Coverage Tag File
Troubleshooting Test Coverage
Test Coverage Error Messages
How To...
To create test coverage reports
To use test coverage from the command line
To report on tagged lines
Programming
COBOL Programming
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
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
Unicode Support
UTF-16 Byte Ordering
National Literals
National Hexadecimal Literals
National Data Items
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
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
XML Input/Output
Using XML and COBOL Together
COBOL and XML
XML Implementation
XML PARSE
Special Registers
User Routine
XML in Brief
XML Schemas
XML Instance Documents
XML Syntax Extensions
Syntax for Handling XML in COBOL
SELECT Paragraph
XML Description Paragraph (XD)
IDENTIFIED BY and IS ATTRIBUTE Clauses
PROCESSING-INSTRUCTION Clause
COUNT IN Clause
NAMESPACE Clause
COBOL Verbs
Compiling XML-enabled COBOL
Building XML-enabled COBOL from Enterprise Developer
Compiling XML-enabled COBOL from the Command Line
Generating COBOL Structures with XML Syntax
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
Creating 64-bit Native COBOL Programs
Overview of Creating 64-bit Native COBOL Programs
Creating 64-bit Programs from 32-bit Programs
Compiling Programs for 64-Bit
Pointers and Compiling Programs for 64-Bit
Single Sourcing and Compiling Programs for 64-Bit
Library Routine Prototypes and Compiling Programs for 64-Bit
File and FCD Handling and 64-bit Programs
Single Sourcing and Dual FCD Support in 64-Bit Programs
The cobmode Utility
Setting the Effective Working Mode
Displaying the Effective Working Mode
Scan64
Introduction to Scan64
Preparing to Use Scan64
Starting Scan64
Examples of Using Scan64
Modification of Pointers by Implicit Redefinition
Possible Pointer Modification Via CALL Statements and Prototypes
Explicit and Implicit Definitions of Pointers in Call Prototypes
Constant and Variable Indexing
Constant and Variable Reference Modification
Scan64 Error Messages
SCAN64: Old int code with D4 operations not supported
SCAN64: Old int code with D7 operations not supported
SCAN64: Cobol COMMS not checked
SCAN64: File records are not checked
SCAN64: Adis accept/display not checked
Calling COBOL Programs
Specifying the Program to Be Called
Naming a Program in its PROGRAM-ID Paragraph
Entry Point Mapping for COBOL Programs
.NET Entry Point Mapping
Calling 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
UNIX Program Development Guide
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
Unsupported Features
Configuration Files and Configuration Variables
Screen Descriptions
Truncation Options in Managed Code
Using Pipes to Assign Filenames When Using the Vision File Handler
Using Vision Indexed Files
Configuring Access to Vision Files
Vision Related Utilities
ACUCOBOL-GT Library Routines
C$CALLEDBY
C$CALLERR
C$CHDIR
C$COPY
C$DELETE
C$FILEINFO
C$GetLastFileOp
C$LIST-DIRECTORY
C$MAKEDIR
C$MEMCPY (Dynamic Memory Routine)
C$MYFILE
C$NARG
C$PARAMSIZE
C$RERR
C$RERRNAME
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
Compiler Directives for RM/COBOL Compatibility
Converting RM/COBOL Data Types
Types of Data
COMPUTATIONAL (COMP) Data Types
COMPUTATIONAL-1 (COMP-1) Data Types
PICTURE Character-strings
COMPUTATIONAL-6 (COMP-6) Data Types
COMP/COMPUTATIONAL Data
COMP-3/COMPUTATIONAL-3 Data
COMP-6/COMPUTATIONAL-6 Data
DISPLAY Data
RM/COBOL Conversion Issues
Producing Executable Code
Perform Statements
ACCEPT FROM CENTURY-DATE and FROM CENTURY-DAY
Nested COPY statements with REPLACING phrase
Duplicate Paragraph-names
Empty Groups
Figurative Constants and the USING Phrase
File Not Found Errors
Indexed File Error on Open
Linkage Section in Main Program
Library Routines
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
Undeclared Data Items in Clauses
User-names Longer than 127 Bytes are Truncated
Running the Code
Table Bound Checking
ACCEPT Fields at the Edge of the Screen
COMPUTATIONAL-1 Data Items with a PICTURE other than S9(4)
Display of Input Data in Concealed ACCEPT Fields
Embedded Control Sequences in DISPLAY Statements
End of File Notification
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
Redefinition of COMP or COMP6 Data Items
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$SetEnv
C$RERR
DELETE
RENAME
SYSTEM
RM/COBOL File Handling
Configuring Access to RM/COBOL Indexed Data Files
RM/COBOL File Status Codes
Enabling CTF to Trace RM/COBOL Data Files
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
Java and COBOL
Using Java and COBOL Together
Overview
Setting Up the Environment for Java and COBOL
Compiling COBOL Programs that Call Java
Compiling COBOL Programs that Are Used from the CobolBean interface
Java/COBOL Application Launcher
Using the Java/COBOL Application Launcher from the Command Line
Using the Java/COBOL Application Launcher from the Eclipse IDE
Linking to the Multi-threaded Run-time System
Deploying a Java Service Interface and Using Resource Adapters
EJB and Client Generation
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
OO COBOL Class Library Reference
Data Access
Database Access
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 a Preprocessor
Compiling Multiple Program Modules
Creating Debug Files
OpenESQL
Scope - OpenESQL SQL Compiler Directive Options
OpenESQL DBMAN Use Case Scenarios
Database Connections
Programming for OpenESQL
Working With OpenESQL Cursors and Result Sets
Working With OpenESQL Stored Procedures and Result Sets
Unicode Support in OpenESQL
Keywords
ODBC
Demonstration Applications
ODBC Drivers and Data Source Names
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
JDBC Drivers and Data Sources
Database Connections
Simple-JNDI
Using OpenESQL with JDBC
Project Dependencies for Eclipse JVM COBOL Projects
Compiling JDBC Applications from the Command Line
JVM Host Variables in Managed Code
COBOL Program Migration Support
COBSQL
Preparation
Using COBSQL
Specifying Directives
COBOL Directives
Building COBSQL Applications
Building COBSQL Applications with Eclipse
Using the CP Preprocessor to Expand Copybooks
National Locale Support (NLS)
Examples
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...
JDBC
To create a JVM COBOL project for JDBC
To create a user library for JDBC dependencies
To add Simple-JNDI to a user library
To import a user library
To export a user library
Reference
OpenESQL
Embedded SQL Statements
ALLOCATE CURSOR
ASSOCIATE LOCATORS
BEGIN DECLARE SECTION
BEGIN TRAN
CALL
CLOSE
COMMIT
CONNECT
DECLARE CURSOR
DECLARE DATABASE
DELETE (Positioned)
DELETE (Searched)
DESCRIBE
DISCONNECT
END DECLARE SECTION
EXECSP
EXECUTE
EXECUTE IMMEDIATE
FETCH
GET HDBC
GET HENV
GET NEXT RESULT SET
INCLUDE
INSERT
OPEN
PERSIST
PREPARE
QUERY ODBC
QUERY ODBC - Column Query
QUERY ODBC - Data Type Query
QUERY ODBC - Table Query
RESET CONNECTION
ROLLBACK
SELECT DISTINCT (using DECLARE CURSOR)
SELECT INTO
SET AUTOCOMMIT
SET CONCURRENCY
SET CONNECTION
SET OPTION
SET SCROLLOPTION
SET TRACELEVEL
SET TRANSACTION ISOLATION
SYNCPOINT
UPDATE (Positioned)
UPDATE (Searched)
WHENEVER
SQL Compiler Directive Options
ALLOWNULLCHAR
ANSI92ENTRY
AUTOCOMMIT
AUTOFETCH
BEHAVIOR
Primitive Directives
DEF_CURSOR
IC_FH_ISOLATION
PF_RO_CURSOR
PF_UPD_CURSOR
RO_CURSOR
TRANSACTION
UPD_CONCURRENCY
UPD_CURSOR
CHECK
CHECKDUPCURSOR
CHECKSINGLETON
CONCAT
CONNECTIONPOOL
CTRACE
CURSORCASE
DATE
DATEDELIM
DB
DBMAN
DECDEL
DETECTDATE
ESQLVERSION
FIPSFLAG
GEN-CC2
GEN-CLASS-VAR
GEN-INIT-FLAG
HSFTRACE
IGNORE-NESTED
INIT
ISOLATION
JIT
JNDI
JNDIENC
MARS
NIST
NOT
ODBCTRACE
ODBCV3
OPTION
PARAMARRAY
PASS
PRE
PREFETCH
QUALFIX
RESULTARRAY
STMTCACHE
TARGETDB
TESTSQLSTATE
THREAD
TIME
TIMEDELIM
TRACELEVEL
TSTAMPSEP
USECURLIB
DBMAN Directive Settings
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 token 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.
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).
COBES0201 BEHAVIOR directive not valid unless TARGETDB directive of DB2, ORACLE, or MSSQLSERVER set first.
COBES0202 BEHAVIOR directive not set.
COBES0203 PREFETCH and BEHAVIOR directives are mutually exclusive - cannot set both.
COBES0205 Cannot set directive PF_RO_CURSOR > 1 if RO_CURSOR directive is set to IC_FH.
COBES0206 Cannot set directive PF_RO_CURSOR > 1 if RO_CURSOR directive is set to FORWARD and TARGETDB is MSSQLSERVER.
COBES0207 Cannot set directive PF_UPD_CURSOR > 1 if UPD_CURSOR directive is set to FORWARD.
COBES0208 Cannot set UPD_CURSOR directive to DYNAMIC if TARGETDB directive is set to ORACLE.
COBES0209 Cannot set UPD_CURSOR directive to STATIC if TARGETDB directive is set to MSSQLSERVER.
COBES0211 DBRMLIB name is too long, max 44 characters.
COBES0212 Simple name in DBRMLIB name is too long, max 8 characters.
COBES0213 Simple name in DBRMLIB name starts with invalid character.
COBES0214 Invalid character in DBRMLIB name.
COBES0215 MEMBER name is too long, max 8 characters.
COBES0216 MEMBER name cannot begin with a numeric digit.
COBES0217 Invalid character in MEMBER name.
COBES0218 MEMBER directive not valid unless DBRMLIB directive set.
COBES0219 VERSION directive not valid unless DBRMLIB directive set.
COBES0220 VERSION is too long, max 64 characters.
COBES0221 Invalid character in VERSION.
COBES0222 Invalid Framework target - SQL applications must be built to target the 4.0 .NET Framework.
COBES0223 TARGETDB directive not set.
COBES0900 An internal error occurred.
COBES0901 This error prevents SQL processing from continuing - further EXEC SQL statements will be ignored.
COBES1000W Use of EXEC SQL INCLUDE SQLCA END-EXEC
COBES1002 Statement is not in area B.
COBES1004 token directive is not supported and has been ignored.
DSNTIAR and DSNTIAC
esqlconfig command
COBSQL
COBSQL Compiler Directive Options
COBSQLTYPE
CSTART
CSTOP
DEBUGFILE
DISPLAY
END-COBSQL
HSFTRACE
KEEPCBL
MAKESYN
SQLDEBUG
TRACE
VERBOSE
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-046
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)
XML
Numeric Data Types
Approximate Numeric Data Types
Exact 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 File
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
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
JVM COBOL File Handler
Configure the JVM COBOL File Handler
Limitations of Using the JVM COBOL 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
External File Mapper (Mfextmap)
Mapper File Structure
Mapper File Location
Activating the External File Mapper
Disabling The External File Mapper
File Status
What is File Status?
Defining a File Status Data Item
File Status Conventions
ANSI'85 File Status
ANSI'74 File Status
File Status Conversions
Extended File Status Codes
Sharing Files
Sharing mode
Record Locking
Manual and Automatic Record Locking
Manual Record Locking
Automatic Record Locking
Single and Multiple Record Locking
Single Record Locking
Multiple Record Locking
Handling Record Locks
Releasing Record Locks
File Status Codes
File Handler Configuration
Configuration File
Configurable Behavior
Large Indexed Files
File Striping
Headers in Striped Files
Options
MAXSTRIPEDIGITS
MAXSTRIPEFILES
MAXSTRIPESIZE
STRIPE-X
STRIPENAMETYPE
STRIPING
Examples
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
DFSORT and ICETOOL Emulation
DFSORT EXEC PARM Options Emulation
PARM
DFSORT Program Control Emulation
ALTSEQ
DEBUG
END
INCLUDE
INREC
MERGE
MODS
OMIT
OPTION
OUTFIL
OUTREC
RECORD
SORT
SUM
ICETOOL Emulation
COPY
COUNT
DISPLAY
OCCUR
RANGE
SELECT
SORT
STATS
UNIQUE
SYNCSORT Emulation
SYNCSORT EXEC PARM Options Emulation
PARM
SYNCSORT Program Control Emulation
ALTSEQ
DEBUG
END
INCLUDE
INREC
MERGE
MODS
OMIT
OPTION
OUTFIL
OUTREC
RECORD
SORT
SUM
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
Working with Data Files
Data Files Tools Utility
Tutorials and Demonstrations
Using Data File Tools
Overview of Working with Data Files
Introduction
Configuring the Data File Tools
Maintaining and Creating Data Files
Overview
Preparation
Convert a File
View a Data File Unformatted
Create a Record Layout File
Create the Default Record Layout
Create the Conditional Record Layouts
Save the Record Layout File
View a Data File Formatted
Look Up Information about a Record Layout File
View Files in Hexadecimal
Print a Data File
Edit Multiple Data Files
Create a New Data File
Convert a File's Character Set
View the EBCDIC File
Working with Record Layouts
Opening the Record Layout Editor
To create a record layout file
To edit a record layout file
To load a Data Division
Creating and Removing Record Layouts
To create record layouts
To add a test field to a conditional record layout
To edit the properties set up for a test field
To remove a record layout
Viewing and Navigating the Record Layout Editor Window
To switch the Header Information and COBOL Header bars on and off
To view the properties set up for a test field
To view all the tests defined for a conditional record layout
To look at the state of a record layout
Loading and Associating Record Layouts
To apply a record layout to a data file
To associate a record layout file with a mainframe-style data file
To view the record layout file associated with a data file
Working with IMS Databases
Viewing Data
To browse an IMS database
To exclude segments when browsing an IMS database
To change the size of the browse window
To expand a segment type in the Database Tree
To compress a segment type in the Database Tree
Finding your Current Position
To find your current position in the database
Searching the Database
To search an IMS database for a string
Making DL/I Calls
To make a DL/I call
To define an unqualified SSA
To define a qualified SSA
To add an SSA qualification statement
To edit an SSA qualification statement
To remove an SSA qualification statement
Using Bookmarks
To bookmark a segment occurrence
To go to a bookmarked segment occurrence
To delete a bookmark
To save your bookmarks in a file
To retrieve your bookmarks from a file
Editing Data
Navigating the IMS Database Editor window
To edit formatted field data
To edit unformatted segment data
To edit unformatted field data
Switching warnings on and off
To turn the Delete warning message on or off for future sessions
To turn the Delete warning message off for the current edit session
To turn the Update warning message on or off for future sessions
To turn the Update warning message off for the current edit session
Undoing Edits
To undo segment edits
To undo field edits
Changing Segment Occurrences
To add the first child
To add a twin segment occurrence
To remove a segment occurrence
To modify a segment occurrence
Change the length of a segment occurrence
Initializing Data
To initialize a field
To initialize a segment occurrence
To initialize and specify a different layout
To initialize and format data with padding bytes
Working with Segment Layouts
Opening the Segment Layout Editor
To create a segment layout file
To edit a segment layout file
To load a Data Division
Creating and Removing Segment Layouts
To create a segment layout
To create a test field for a conditional segment layout
To edit the properties set up for a test field
To remove a segment layout
Viewing and Navigating the Segment Layout Editor Window
To switch the Header Information Bar on and off
To switch the COBOL Header Bar on and off
To view the properties set up for a test field
To view all the tests defined for a conditional segment layout
To look at the state of a segment layout
Data File Tools Reference
Data File Convert
Overview
Opening the Data File Converter
Specifying the Input File
Specifying the Output File
Changing the Record Length
Converting between EBCDIC and ANSI
Data File Editor
Overview
The Data File Editor Window
Left-Hand Pane
Right-Hand Pane
The Data File Toolbar
The Data File Status Bar
Configuring the Data File Editor
Switching Off Warning Prompts
Obtaining Back Ups
Opening Data Files as Read-Only
Editing in Insert or Overtype Mode
Creating a Data File
File and Record Formats
File Headers
IDXFORMAT(8) Data Files
Defining Keys for Indexed Files
Opening a Data File
File Headers
Identifying a File Type
Identifying a Record Length
Obtaining Information about a Data File
Navigating a Data File
Navigating Sequential Files
Navigating Non-Sequential Files
Changing the Key in an Indexed File
Editing a Data File
Editing Data in the Left-Hand Pane
Editing Data in the Right-Hand Pane
Initializing Data
Restoring Data
Adding and Deleting Records
Adding Records to a Sequential File
Adding Records to a Relative File
Adding Records to an Indexed File
Adding Records to a VSAM ES File
Deleting Records
Cutting, Copying and Pasting Data
Searching a Data File
Printing a Data File
Printing Records from the Left-Hand Pane
Printing Field Data from the Right-hand Pane
Using Record Layouts with Data Files
Overview
Types of Record Layout
Creating Record Layouts
Layout Names
Opening the Record Layout Editor
The Record Layout Editor Window
Left-hand Pane
COBOL Header Bar
Data Division View
Right-hand Pane
Header Information Bar
Record Layout View
Setting up a Test Condition
Converting Between EBCDIC and ANSI
Record Layout Files
Saving Record Layouts
Editing a Record Layout File
Retrieving Record Layouts
IMS Database Editor
Overview
Opening the IMS Database Editor
The IMS Database Editor Window
Left-hand Pane
Database Tree
SSA List
Segment Data
Right-hand Pane
Layout Status Bar
Field Layout View
Field Data
The IMS Database Editor Status Bar
Configuring the IMS Database Editor
Switching Off Warning Prompts
Changing the Size of the Browse Window
Navigating a Database
Retrieving Data Through DL/I Calls
Using SSAs to Retrieve Data
Searching the Database for a String
Using Bookmarks to Mark Segment Occurrences
Browsing Through Segment Occurrences
Editing Data
Changing Segment Occurrences
Adding a New Segment Occurrence
Initializing Segment Occurrences
Changing the Segment Length
Frequently Asked Questions
Empty Right-hand Pane
Q?: Why is the right-hand pane of the IMS Database Editor window empty?
Lost Current Segment Arrow
Q?: Why is the Current Segment Arrow not showing in the Database Tree?
Unable to Add Text
Q?: Why is the IMS Database Editor ignoring the text that I type in?
Using Segment Layouts with IMS Databases
Overview
Types of Segment Layout
Creating Segment Layouts
Layout-names
The Segment Layout Editor Window
Left-hand Pane
COBOL Header Bar
Data Division View
Right-hand Pane
Header Information Bar
Segment Layout View
Setting up a Test Condition
Saving a Segment Layout File
Frequently Asked Questions
Cannot Load a Data Division
Why does the Segment Layout Editor display the message "The IMS interface will not allow processing of the DBD resources at this time" when I attempt to load a Data Division?
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
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
Specifying the Output File
General Conversion Information
Data File Converter Error Messages
VRECGEN
Installing VRECGEN
Running VRECGEN
VRECGEN2
Installing VRECGEN2
Running VRECGEN2
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
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 Messsages: 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
Rollforward Recovery Logging
Rollforward Recovery Logging - Fileshare Server
Rollforward Recovery Utility
Database Sequence Numbering
Database Sequence Numbers - Fileshare Server
Automatic Database Backup and Rollforward Recovery
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
Security
Password System
Fileshare Client
Fileshare Server
Writing Your Own FHRdrPwd Module
Logon Validation Module
File Access Validation Module
Password File Maintenance
User-ID Groups
Supervisor Mode
Advanced Operation
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
Linking Fileshare Manager Applications
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
Fileshare on UNIX
Running Fileshare as a Background Process
The NFILES Setting
Error Handling
COBOL Run-time Errors
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.
Mainframe Programming
Mainframe Subsystem Support Developer Introduction
What is Mainframe Subsystem Support?
Migrating the Application
About CICS applications
Micro Focus BMS Painter
IBM External Call Interface (ECI) and External Presentation Interface (EPI)
CICS Application Programming Interface (API)
File and Database Support
CICS ECM Preprocessor
About IMS applications
About JCL applications
Configuring Enterprise Server to Run the Application
CICS, IMS and JCL Resources
Data Conversion
CICS Intersystem Communication
Terminal Emulation
Assembler Support
Assembler Support Overview
About Developing Assembler Applications
About Creating Editing and Navigating Source Code
About the MF370CTL.CFG configuration file
Configuring Assembler Project File Locations
Using the Configuration File to Set Locations
Example: Using MF370CTL.CFG to Set Locations
Using a Command File to Configure Locations
Example: Using a Command File to Set Locations
Component Location Environment Variables
Compiling and Linking Assembler Modules
About Compiling and Linking Assembler Modules
Setting Compiler Directives
Compiling Assembler Copybooks and Macros Containing EXEC CICS Statements
Linking Modules
Program Structures and Static Linking
Single Assembler Module
Multiple Assembler Modules with Calls Using External Names
Multiple Assembler Modules with Calls Using Entry Points
Dynamic Linking
Mixing Static and Dynamic Linking
Assembler Modules that call COBOL Modules
Link File INCLUDE Commands
Other Link File Commands
Entry Point Mapping
Configuring Runtime Memory Requirements
About Memory Requirements
Setting Addressing Mode and Residency Mode
Configuring the Default SQA Memory Size
Reserving Memory for Execution
Setting the Run Time Virtual Memory Environment
Example: Runtime Virtual Memory Configuration
Run Time Memory Environment Variables
Configuring a Program's Memory Requirements
Program Only Uses Memory Below the Line
Program Only Uses Memory Above the Line
Program Uses Memory Below and Above the Line
Setting Residency Mode
Using Subpools
File Handling
Introduction to File Handling
Using QSAM for File Handling
Using BSAM for File Handling
Using VSAM for File Handling
Using the Generalized Trace Facility
Generalized Trace Facility Introduction
Turning GTF on and Specifying Options
The Trace File
Types of Trace
Default Trace
Detailed Trace
File Input/Output Trace
Memory Allocation Trace
Program Interruption Information
CICS support
Mainframe-style Pointers
AMODE and Non-AMODE Compiled Programs
Forcing a Program to be Reloaded
Accessing Large VSAM Files
Abends in Transaction Programs
ASSA
EXIF
FUNC
IRST
LANG
MATP
MBLL
MCOM
MUSR
RECU
Using the SET Option of the BMS-related SEND Functions
Converting a Fake TIOA Address to a Real TIOA Address
Restrictions on Using DFHMFSET
Examples
OS/VS COBOL Example
VS COBOL II Example
Developing Exit Programs
Introduction to Developing Exit Points
Global and Task-related Exit Programs
Security Exit Programs
Interface
Error Conditions
IMS Support
Developing IMS Applications
Sample Files
Generating DBDs
Generating PSBs
Generating MFSs
Loading Databases
Converting Segments from EBCDIC to ANSI
Exit Routines
Input Message Segment and Field Exits
Coding Requirements
Run-time Requirements
Run-time Behavior
Examples
Troubleshooting
Data Capture Exits
Enabling
Coding Requirements
Run-time Behavior
Running an IMS Transaction
Performing a Cold Start
IMS flags
IMSDBU Utility
MFIMSDBU API
IMSDBU Main Features
High Performance
IMS/ESA Extract
Load and Unload Exits
Reports, Statistics and Logs
Simplified Logical Loading
Specialized and Generic Load Inputs
Using IMSDBU with Fileshare Databases
Fast Path MSDBs
Migrating from DBUTIL
IMSDBU Automation
IMSDBU Functions
The Add Function
The Add Function's Inputs and Outputs
Adding Segments to Logically Related Databases
The Delete Function
The Load Function
The Load Function's Inputs and Outputs
Loading Logically Related Databases
The Makelist Function
Building the Logical List for Makelist
The Makelist Function's Inputs and Outputs
The PtrUpdate Function
Adjusting for Missing Segments
The PtrUpdate Function's Inputs and Outputs
The Reorganize Function
Reorganize Processing Details
The Reorganize Function's Inputs and Outputs
Reorganize Failure Recovery
The Runlist Function
The Runlist Function's Inputs and Outputs
Restarting a Failed Runlist Operation
The Unload Function
The Unload Function's Inputs and Outputs
The Useq Function
The Useq Function's Inputs and Outputs
The Zeroload Function
The Zeroload Function's Inputs and Outputs
Zeroload Database Names
JCL support
Enterprise Server Integration with the IDE
Introduction
Using the Project-based Facilities
Remote Job Execution
JCL development
Introduction
JCL Jobstreams
MVS JCL Support
MVS JCL Features
MVS JCL Statements
VSE JCL Support
Restrictions
VSE JCL and POWER Statements
POWER Statements
VSE JCL Configuration Files
Structure of a VSE JCL Configuration File
Specifying the Location of the VSE JCL Configuration File
Example VSE JCL Configuration File
Special Characters in JCL Program-names
Character Sets
Data Sets
Application Programs
Allocating Data Sets
Passing Parameters
Printer Exit Modules
Writing a Printer Exit
Accessing OUTPUT Statement Information
How the Exit is Called
Using the Exit
ACCEPT and DISPLAY Handling
ASCII/EBCDIC
Enabling JOBLIB DD and STEPLIB DD Processing
Output Limitation Support
Files and Data Sets
Catalog Files
Data Set Files
Using Fileshare to Access Data Files
Specifying Fileshare Locations in the Catalog
Specifying Fileshare Locations in SELECT Clauses
Specifying Fileshare Locations in the Fileshare Client Configuration File
Partitioned Data Sets (PDSs)
Procedure Libraries
Dynamic PDSs
Creating a Dynamic PDS with JCL
Spool Files
Advanced Data Set Information
Data Set Organizations
Record Formats
Logical Record Length
Mapping to Physical File Formats
Support for Generation Data Groups
Creating Generation Data Groups
Generation Data Group Restrictions
Utility Programs
Emulations of Mainframe Utilities
Sort/Merge Operations (MFJSORT)
JCL Statements
EXEC Statement
DD Statements
Program Control Statements
Exits
SYNCSORT Emulation
Executing Dynamic SQL statements (MFDSNTEP)
JCL Statements
DD Statements
Unloading XDB Database Table Rows (MFDB2UNL)
JCL Statements
DD Statements
Loading XDB Database Table Rows (MFDB2LOA)
JCL Statements
DD Statements
VSAM Access Method Services (MFJAMS)
Working with Empty Data Sets
File Structure
JCL Statements
EXEC Statement
DD Statements
Commands
ALTER
DEFINE ALTERNATEINDEX
DEFINE CLUSTER
DEFINE PATH
DELETE
LISTCAT
PRINT
REPRO
SET
VERIFY
Comparing Data Sets (MFJMATCH - IEBCOMPR)
JCL Statements
EXEC Statement
DD Statements
Control Statements
Copying and Merging Partitioned Data Sets (MFJCOPY)
JCL Statements
EXEC Statement
DD Statements
Control Statements
Copying Sequential Data Sets (MFJGENER and ICEGENER)
JCL Statements
EXEC Statement
DD Statements
Control Statements
Creating or Modifying Data Sets (MFJUPDTE)
JCL Statements
EXEC Statement
DD Statements
Control Statements
Dummy Program (MFJBR14)
JCL Statements
EXEC Statement
Executing TSO Commands in Batch Mode (IDAEFT01)
JCL Statements
EXEC Statement
DD Statements
Running REXX Execs in MVS Batch Mode (MFIRXJCL)
JCL Statements
EXEC Statement
DD Statements
TSO Support in Enterprise Server
TSO Commands and Micro Focus Extensions
ALLOCATE
ATTRIB
CALL
DELETE
DSN
EXEC
FREE
LISTALC
LISTCAT
LOGOFF
PROFILE
RELATE
REXX
SUBMIT
TIME
Generating Test Data (MFJDG)
JCL Statements
EXEC Statement
DD Statements
Control Statements
Micro Focus Utilities
Comparing Data Sets (MFJMATCH)
JCL Statements
EXEC Statement
DD Statements
Program Control Statements
Writing Your Own Utility Programs
MVS Emulation
MVS Control Blocks
Low-memory Address Emulation in Assembler and COBOL
Control Blocks Supported
Accessing MVS Control Blocks from COBOL Programs
MVS External Writer
DB2 Call Attach Facility
Micro Focus Batch Scheduler Integration
Introduction
MFBSI Architecture
Supported Platforms
Prerequisites
Components
MFBSIJCL
MFBSIEMX
Configuring the Server
The MFBSI Configuration File
MFBSIJCL Submit Process
MFBSIJCL Command Line Parameters
MFBSIJCL Return Codes
Job Restart
Job Restart Usage
Sending Alerts to the Scheduler
MFBSIALR interface
JCL Parameter Substitution
JCL Parameters Substitution Usage
System Parameters
Enabling Control-M AutoEdit Use
Variables Substitution
Date System Variables
Resolving Original Scheduling (%%O and %%$O) System Date Variables
%%IF, %%ELSE, and %%ENDIF
%%SET
%%GLOBAL and %%LIBSYM
%%INCLIB and %%INCMEM
%%GOTO and %%LABEL
Displaying the Symbols Pool in JCL Command Lines
Error Handling
User Exit Before Submission to Enterprise Server/JCL
MFBSIJCL Termination User Exit
Additional Notes
User or System ABEND Handling
Enabling CTF Tracing for MFBSIEMX
Troubleshooting
To Display Configuration Information and Region State
To Display MFBSI Return Codes
Using JCL User Exits
Introduction
Background Information
MSS Processes
User Exit Invocation, Rules, and Guidelines
JCL/TSO Events and Actions
Event-after-PGM-call
Event-before-PGM-call
Event-CALL-ended
Event-CALL-ready
Event-CALL-started
Event-job-ended
Event-job-flushed
Event-job-JCL-error
Event-job-ready
Event-job-concluded
Event-job-started
Event-RUN-ended
Event-RUN-ready
Event-RUN-started
Event-step-bypassed
Event-step-ended
Event-step-ready
Event-step-started
Event-TSO-ended
Event-TSO-started
Event Scenarios
JCL Scenarios
TSO in Batch (IKJEFTxx JCL) Scenarios
Event Logging
User Exit Interface Block (mfjdxit.cpy)
Using JCL Subsystem Exits
Introduction
SUBSYS with DD Statements and SVC 99 Text Units
SUBSYS processing
Subsystem Exit Invocation, Rules, and Guidelines
Events and Actions
Interaction with the Enterprise Server Printer Exit
Subsystem Exit Interface Block (mfjdsxit.cpy)
Subsystem Exit for OODA Subsystem (mfjyooda.cbl)
JCL (subsys1b.jcl)
REXX Support
Introduction
JCL Environment
Passing Parameters
Including Host Commands
Debugging an Exec
Specifying Record Length for Zero-length Line Sequential Files
Specifying Alternative Characters for the OR, NOT and CONCAT Operators
Examples:
Restrictions
Submitting JCL from CICS
Submitting JCL via the Internal Reader
Create a CICS Resource Group and a DCT entry
Create a CICS Application
Create a TN3270 Listener
Run the Application
Submitting JCL via SSTM and the CICS Spooling Facility
Activate SSTM for your Enterprise Server region
Create a CICS application
Create a TN3270 Listener
Run the Application
JCL API
Definition of MFJZABND API Call
Definition of MFJZLOG API Call
Definition of MFJZS099 API Call
MFJZLPSA
Using DYNamic ALLOCation (DYNALLOC - SVC99) Functions - MFJZS099
Mainframe Emulation
Compatibility with the Mainframe Environment
Mainframe Pointers
AMODE Compiler Directive
Accessing Data in a Canceled Program
Entry Point Mapping for COBOL Programs
Creating an Entry Name Map File
Making Entry Name Map Files Available to the Run-time System
Creating an Alias
Example 1
Example 2
Using SMS Data Classes
Using the SMS DATACLAS update utility
Setting up the environment
SMS DATACLAS functions
SMS DATACLAS Properties and values
Using the SMS DATACLAS update utility with input from SYSIN
Using the SMS DATACLAS update utility with input from SYSUT1
Using DATACLAS output
IBM Hexadecimal Format Floating Point Data
Using Different Floating Point Formats
Compiling
Running
The MAINFRAME_FLOATING_POINT Environment Variable
Syntax
Parameters
Comments
Editing Data Files
Range
Assembler Programs
MFASM
Using the Generalized Trace Facility
Diagnosing Abends
Language Environment (LE) Support
Enable Language Environment (LE) Support
LE Callable Services
Bit Manipulation Services
Condition-Handling Services
Date and Time Services
Dynamic-Storage Services
Dynamic File Allocation Services
General Services
Initialization and Termination Services
Locale Services
Math Services
Message-Handling Services
National Locale Support Services
LE Run-Time Options
Supported LE Run-time Options
Unsupported LE Run-time Options
Specifying LE Run-time Options
LE Error Conditions
LE Run-Time Options Error Messages
MFX9999I The run-time option option is not supported in this release
CEE3601I The string string was found where a delimiter was expected following a quoted suboption for the run-time option option
CEE3602I An end quote delimiter did not occur before the end of the run-time option string
CEE3603I The character character is not a valid run-time option delimiter
CEE3605I The string string was found where a delimiter was expected following the suboptions for the run-time option option
CEE3606I The string string was too long and was ignored
CEE3607I The end of the suboption string did not contain a right parenthesis
CEE3608I The following messages pertain to the invocation command run-time options
CEE3610I The run-time option old-option was mapped to the run-time option le-option
CEE3611I The run-time option option was an invalid run-time option
CEE3612I Too many suboptions were specified for the run-time option option
CEE3614I An invalid character occurred in the numeric string string of the run-time option option
CEE3615I The installation default for the run-time option option could not be overridden
CEE3616I The string string was not a valid suboption of the run-time option option
CEE3617I The number number of the run-time option option exceeded the range of -2147483648 to 2147483647
CEE3618I The run-time option option was not valid from the invocation command
CEE3619I The value value was not a valid MSGQ number
CEE3622I The option option quoted suboption string string was not one character long
CEE3623I The UPSI option suboption string string was not eight characters long
CEE3633W The total length of the combined ENVAR strings exceeded 250 characters
CEE3634I The number number of the run-time option option exceeded the range of -32768 to 32767
CEE3635I The string string was not a valid RECFM suboption specification for run-time option option
CEE3636I The value number exceeded the maximum allowable LRECL or BLKSIZE of 32760 bytes
CEE3637I The number number specified in the suboption suboption of the run-time option option is not a valid hexadecimal number in the range 0 to FFFFFFFF
CEE3638I The table size of size, specified in the TRACE run-time option, exceeds the maximum allowed value of 16777215
LE Country Codes
HCO for DB2 LUW
DB2 External Compiler Module
Demonstration Applications
Compound SQL
User Defined Functions
Extensions to Embedded SQL Support
The INCLUDE Statement
The DECLARE TABLE 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
UDB-VERSION DB2 Directive Option
Compiling
DB2 ECM Preprocessor
Compiling Programs That Use a Remote DB2 Server
Automated Compiles
DB2 Compiler Directive
Error Codes
Building Applications
Stand-alone DB2 Applications
Client DB2 Applications and Stored Procedures
Building DB2 Applications with Eclipse
Linking
Binding
DB2 Stored Procedures
Working with Stored Procedures
Writing and Preparing Stored Procedures
Features of a Stored Procedure
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 Stored Procedures under DB2 LUW
Host Compatibility Option (HCO)
Introducing HCO
UNIX Requirements
HCO Tools
Sample Programs
Product Specifications
HCO Functions
DDL DB2 for z/OS Syntax Supported
Functions Processed Unchanged
Functions Changed to Comments
Functions That May Be Modified
DB2 LUW Syntax DDL
Features Supported by DB2 LUW
Column Functions and Scalars
Special Registers
Features Not Supported by DB2 LUW
Special Registers
Other Functions
Running HCO Tools
What to Do First
Accessing a Database on the Mainframe
HCO Tools
Create Database
Command Line Interface
DDL Processor
Downloading Source DDL
Downloading Data to Load Tables
Using the DDL Processor to Load Data
Command Line Interface
DCLGEN
Command Line Interface
DCLGEN Tool Examples
Exporting Data
Limitations
Command Line Interface
Importing Data
Limitations
Command Line Interface
Compiling and Run Time
Compiling DB2 Programs with HCO
DDL Processing
Collating Sequence For Data
Invoking the DB2 ECM
Error Messages When Compiling Program
Run-time Services
MFHCOCDS Tool
Dynamic Bind Utility
DSNTIAR and DSNTIAC Tools
DSNTIAR Tool Example
Return Codes
MFHCOEBC
Reference
DB2 Compiler Directive Options
ACCESS
ACTION
APREUSE
BIND
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-INIT-FLAG
GEN-SQLCA
HOSTVAR
HSFTRACE
IGNORE-NESTED
IMMEDIATE
IMMEDWRITE
INIT
INSERT
ISOLATION
KEEPDYNAMIC
LANGLEVEL
LEVEL
MSGAREA
MULTI-NESTED
NOT
OPTPROFILE
OPTHINT
OS400NAMING
OWNER
PASS
PRE
QUALFIX
QUALIFIER
QUERYOPT
RELEASE
REOPT
REPLVER
RETAIN
SORTSEQ
SQLERROR
SQLFLAG
SQLRULES
SQLWARN
STATICREADONLY
STRDEL
SYNCPOINT
SYNTAX
TEXT
TRANSFORM-GROUP
UDB-VERSION
VALIDATE
VERSION
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.
COBDB0900 - COBDB1004
COBDB0900 An internal error occurred.
COBDB0901 SQL processing cannot continue.
COBDB0902 An internal error occurred.
COBDB1000 Use of EXEC SQL INCLUDE SQLCA END-EXEC.
COBDB1001 MF DB2 Connect program produced the warning token.
COBDB1002 Statement is not in area B.
COBDB1004 INVALID SQL STATEMENT - statement ignored.
PL/I Programming
CodeWatch User's Guide
Overview
Introduction
Summary of Features
Getting Started
Program Preparation
Invoking CodeWatch
The STB File
Compressed STB Files
Searching for Source and STB Files
Redirecting User Program I/O
Extended ASCII Character Support
Start-up Files
Debugging a Program with Multiple Modules
Ending a Debugging Session
Getting Started with the Graphical Interface
Getting Started
Buttons
Selecting Text and Line Numbers
Help
The Command-line Interface
Special Symbols
CodeWatch Commands and Options
Command Variations
Entering CodeWatch Commands
Debugging Concepts
Using Action Lists
Pointer Concepts
The Execution Pointer
The Source File Pointer
Environment Concepts
Program Blocks
Block Activation Numbers
Absolute Activation Numbers
Relative Activation Numbers
Using Activation Numbers
Statement Identifiers
Line Numbers
Labels
Line Number and Statement Offsets
Entry and Exit Points
Statement Qualification by Environment
Referencing Included or Copied Files
CodeWatch Error Messages
Start-up Warnings
Start-up Errors
Syntax Errors
Semantic Errors
Aborted Program Recovery
CodeWatch Functionality
Program Control
Breakpoints
Catching Signals
Statement Stepping
Tracepoints
Watchpoints
Controlling Program Execution
Environment Control
Changing Environments
Stack Traceback
Symbolic Access
Variable Names
Referencing Elements of Arrays
Expression Evaluation
Variable Assignment
Listing Arguments
Modifying Return Values
Accessing Declaration Types
Examining the Source Program
String Search
Changing Source Files
The WHERE Command
The POINT Command
The PRINT Command
Other Features
Command Macros
Debugger Command Files
On-line Help
CodeWatch Commands
Arguments
Attach
Breakpoint
Breaking at Specific Activations of a Block
Breakpoints with Action Lists
Skipping Multiple Iterations of a Breakpoint
Temporarily Ignoring Breakpoints
Suppressing the Breakpoint Message
Conditional Watchpoints
Incurring Breakpoints
Call
Catch
Commandline
Continue
Detach
Dstep
Environment
Evaluate
Changing Values of Variables
Array Evaluation
C Preprocessor Macros
Dereferencing C char Pointers
C Function Calls
Find
Goto
Help
Kill
Lbreakpoint
Lcatch
Lenvironment
Let
Lmacro
Load
Log
Lreturn
Lsource
Lstep
Ltrace
Lwatch
Macro
Nbreakpoint
Ncatch
Nload
Nlog
Nmacro
Nmap
Nshlib
Ntrace
Nwatch
Peek
Point
Poke
Print
Quit
Read
Registers
Reload
Changing Command-line Arguments
Redirecting User Program I/O
Redirecting I/O Back to the Terminal
Return
Save
Shlib
Source
Stack
Step
Trace Entry
Animating the Program in the Source Window
Trace Statement
Animating the Program in the Source Window
Type
Watch
Suppressing the Watchpoint Message
Temporarily Ignoring Watchpoints
Skipping a Watchpoint Multiple Times
Watchpoints with Action Lists
Conditional Watchpoints
Incurring Watchpoints
Where
!
Debugging Open PL/I Programs
Program Blocks
Block Names
Referencing Nested Blocks
Built-in Function Support
Referencing Arrays and Aggregate Structures
Support for Open PL/I Include Files
Using CodeWatch with the Open PL/I Macro Preprocessor
Sample CodeWatch Session Using Open PL/I
Program Listing
Open PL/I User's Guide
Using Open PL/I
Compiling a Program
mfpp Syntax
mfpli Syntax
mfplx Syntax
mfvsam Syntax
Preprocessor Order of Execution
Examples
mfplx Options
Macro Preprocessor Options
CICS Preprocessor Options
DB2 Preprocessor Options
Compiler Options
Intel-Specific Options
Compiler Listings
The -l Option
The -map Option
The -xref Option
The -exp Option
Open PL/I Compiler Implementation Limits
Compilation Statistics
Temporary Files
Optimization
Linking a Program
Link Options
Using ldpli
Using ldpli with Windows Systems
Running a Program
Run-time Errors
Accessing Command-Line Arguments in Open PL/I Programs
Associating a Logical Open PL/I File with a Physical Disk Data File
Method 1 (Default)
Method 2
Method 3
Using CodeWatch
Creating a Sharable Library
Creating a DLL
Program Debugging
Using PLIDUMP
Finding Variables in PLIDUMP Output
Finding AUTOMATIC Variables
Finding STATIC Variables
Finding CONTROLLED Variables
NORENT WRITABLE
NORENT NOWRITABLE(FWS)
NORENT NOWRITABLE(PRV)
Compilation Data for Debugging
Copyright String
Timestamp String
Saved Options Strings
Using Open PL/I with Other Software Products
DB2
C++/Views
Open PL/I and Informix
Open PL/I and Micro Focus
Linking an Open PL/I Application Using Separate Shared Objects for Each Subroutine
Building an Example Application
Execution Summary
Compiling, Linking and Debugging of Fetchable Procedures
Compiling and Linking of Programs That Are to Be Used As Fetchable Procedures
Debugging of Fetchable Procedures
Language Concepts
Line Boundaries
Main Procedure
Data Types
Fixed Binary (p ≤ 7)
Fixed Binary (8 ≤ p ≤ 15)
Fixed Binary (15 ≤ p ≤ 31)
Fixed Decimal (p,q)
Float Binary (p ≤ 23)
Float Binary (23 < p ≤ 52)
Float Decimal (p)
Character (n)
Character (n) Varying
Widechar (n)
Widechar (n) Varying
Bit (n)
Bit (n) Aligned
Pointer
Label
Picture
Entry
File Variable
Structure
Area (n)
Offset
Arithmetic Precision
External Procedures
External Names
Maximum Number of Arguments for a Function or Subroutine Call
Open PL/I Calling Conventions
Calling Other Languages
C Calling Conventions
Argument Passing Conventions
HP Argument Passing Conventions (32-bit)
Intel Argument Passing Conventions (32-bit)
RS/6000 Argument Passing Conventions (32-bit)
Sun Sparc Argument Passing Conventions (32-bit)
Register Save Conventions
HP Register Save Conventions (32-bit)
Intel Register Save Conventions (32-bit)
RS/6000 Register Save Conventions (32-bit)
Sun Sparc Register Save Conventions (32-bit)
Function Result Conventions
HP Function Result Conventions (32-bit)
Intel Function Result Conventions (32-bit)
RS/6000 Function Result Conventions (32-bit)
Sun Sparc Function Result Conventions (32-bit)
Return of Data Types
Open PL/I Equivalent Data Types
Open PL/I SQL Options
DB2 SQL Support
DB2 SQL Precompiler Options
Coding DB2 SQL Statements in Open PL/I Applications
Defining the DB2 SQL Communications Area
Defining SQL Descriptor Areas
Embedding SQL Statements
Using Host Variables
Declaring Host Variables
Numeric Host Variables
Character Host Variables
Determining Equivalent SQL and PL/I Data Types
Determining Compatibility of SQL and PL/I Data Types
Using Host Structures
Using Indicator Variables
CONNECT TO Statement
COMPOUND Statement
Handling SQL Error Return Codes
Sample Programs
Open PL/I DB2 SQL Sample 1 Program
Compilation, Linking, and Execution
Open PL/I DB2 SQL Sample 2 Program
HCO for SQL Server Compiler Directive Options for PL/I
OpenESQL Support for Oracle PL/I Applications
Compiling a PL/I application for OCI
Setting BLOB and CLOB variables
Date and Timestamp Formatting with OpenESQL for OCI
Additional Considerations for Oracle
Recommended OpenESQL Directives for Open PL/I
Supported OpenESQL Compiler Options
Switch Module Support
Using the OpenESQL OCI Directive with PL/I: Examples
OpenESQL Compiler Options for Open PL/I
Open PL/I Compiler Diagnostic Messages
Interpreting Diagnostic Messages
Open PL/I Run-time Error Messages
Run-time Errors
LPI Run-time Error Codes
Value Table for ONCODE Built-in Function
Introduction
Table of Values Returned by ONCODE
Character Sets
EBCDIC/ASCII Equivalents
Environment Variables
Environment Variables Summary
Migration to Micro Focus File Formats
Overview
Reasons for Migrating to Micro Focus File Formats
Determine What File Formats You Are Using
Liant Indexed (aka) IBM/Informix CISAM
Liant Indexed (aka) IBM/Informix CISAM Conversion Process
Liant Variable Length Sequential Conversion Process
Liant Relative Record Conversion Process
Appendix - Unload Program
Appendix - Load Program
Appendix - Sample Shell Script to Build/Run
Appendix - Sample extfh.cfg
Service Interfaces Using the IMTK
Service Interfaces with the IMTK
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
Configuring an Enterprise Server
Configuring an Enterprise Server for a COBOL Program service
Configuring an Enterprise Server for a CICS service
Configuring an Enterprise Server for an IMS service
Managing Service Interface Projects
Annotating Maps
Changing Logical Field Names
Defining Field Direction
Grouping Fields
Defining Service Interfaces
Layout of the Service Interfaces Editor
Operations
Creating COBOL Program-based Operations
Creating CICS Commarea-based Operations
Defining Operation Details
Interface Fields
Mappings
USER ID and PASSWORD Fields
COBOL Assignments
Reusable Fields
Initialization or Termination Logic
Deploying Service Interfaces
Deploying to an Enterprise Server
Deploying to an Enterprise Server under UNIX
Deploying to 64-bit Platforms
Deploying Java Service Interfaces
Deploying Using the mfdepinst Command
Deploying the .car File Manually
Clients
Generating Clients
EJB and Client Generation
EJB Jar File
Client War File
Application Ear File
Editing Clients
Running Clients
Hosting ASP.NET Web Sites on 64-bit Operating Systems
Tracing Service Execution
Tracing CICS Service Execution
Tracing IMS Service Execution
How to...
Manage Service Interface Projects