COBOL Analyzer

Installation Guide

Overview

Installation Tasks

Deployment

Mainframe and Network Server

Repository Server

CA Server

CA Client

Single User Installation

Database Setup

SQL Server Database Setup

Configuring SQL Server for Multi-user Environments

Hardware and Software Requirements

Repository Server Hardware Requirements

Repository Server Software Requirements

CA Server Hardware Requirements

CA Server Software Requirements

CA Client Hardware Requirements

CA Client Software Requirements

CA Performance Optimization Guidelines

Choosing Hardware Configuration

Single User (One Machine)

Enterprise Installation (Multiple Users Using Separate Database Server)

Database Server

CA and Workspace Server

Processing Node/Nodes

Software Configuration

Verification Information

Parallel Verification

Choosing the Optimal Number of Queue Processors

Using More Computers

Installing and Uninstalling COBOL Analyzer

Installing CA on the Server or Client

Uninstalling COBOL Analyzer

Post-Installation Administrative Tasks

Configuring COBOL Analyzer

Licensing

Upgrading Customers

Concurrent Use

COBOL Analyzer Licensing

Business Rule Manager Licensing

Micro Focus End User License Agreement

Creating a Shared Folder for Workspaces

Upgrading Workspaces

Troubleshooting the Installation

Troubleshooting Workspace Access

Getting Started

Introducing COBOL Analyzer

COBOL Analyzer Products

COBOL Analyzer

Business Rule Manager

How COBOL Analyzer Models Applications

Understanding Application-Level Information

Understanding Object-Level Information

Workspaces and Projects

Single-User versus Multiuser Environments

Multiuser Environment Basics

Deployment Scenario

Mainframe and Network Server

COBOL Analyzer Server

Database Server

COBOL Analyzer Client

CA Privileges

Understanding Master Users

Designating Master Users and Ordinary Users

Using the Optional File Server

Public and Private Visibility

Protecting Projects

Dropping Indexes

COBOL Analyzer Basics

Creating a Workspace in SQL Server

Creating a Workspace in PostgreSQL

Creating a Workspace Using the Workspace Build Wizard

Refreshing the Workspace Path

Connecting to a Workspace in SQL Server

Troubleshooting Connection to MS SQL Server

Opening a Workspace

Registering Source Files

Host Environment Source Compatibility

Resolving Include Files

Resolving Program-to-Program Calls

Resolving Control Cards

Resolving JCL Procedures

Refreshing Registered Source Paths

Calculating Lines of Code

Queue Processor

Check Workspace Queue

Manage Queue

Verifying Source Files

How Verification Results Are Indicated

Using the COBOL Analyzer Main Window

Menus

Toolbars

Project Filtering

Using the Repository Browser Pane

Using the Search Assistant

Customizing the Search Assistant

Using the Browser

Selecting Objects

Selecting All

Selecting Multiple

Using the Type-Ahead Select Functions

Expanding Subtrees

Filtering Subtrees

Refreshing the Browser

Viewing the Entire Workspace

Performing a Text Search in the Repository

Using Wildcard Patterns in Searches

Finding and Replacing Text in Source Files

Using the Editor and Viewer

Editing Source

Finding and Replacing Source in a Selection

Viewing a List of Errors

Commenting Out Source

Printing Source

Setting Editor User Preferences

Specifying the Color of Items

Using the Chart Viewer

Interactive Chart View

Report Chart View

Using the Object Information Pane

Viewing Object Properties

Viewing Inventory Reports

Viewing Key Object Relationships with Query Repository

Using the Activity Log

Creating a To Do List

Viewing a To Do List

Using Tool Windows

Resizing Panes

Moving Panes

Setting Options

Managing Option Sets

Understanding the Options Manager Window

Creating an Option Set

Renaming an Option Set

Editing an Option Set

Copying an Option Set

Deleting an Option Set

Sharing an Option Set

Making an Option Set the Default

Assigning an Option Set

Importing and Exporting Option Sets

Setting General Options

Setting Environment User Preferences

Setting Archivers User Preferences

Setting Export Options

Adding a Selectable Item

Working with Reports and Diagrams

Using the Guide for a Tool

Purge Activity Log

Export and Import from the Workspace

Preparing Projects

Registering Source Files

Host Environment Source Compatibility

Resolving Include Files

Resolving Program-to-Program Calls

Resolving Control Cards

Resolving JCL Procedures

Refreshing Registered Source Paths

Setting Registration Options: Extensions Tab

Setting Registration Options: Source Files Tab

Creating New Source Files

Updating Source Files with Source Synchronization

Source Synchronization Settings

Source Synchronization and Interactive Analysis

Using Source Synchronization to Change the Registered Source Paths

Exporting Source Files from a Workspace

Deleting Objects from a Workspace

Deleting a Workspace

Japanese Language Support

Setting Up Projects

Creating Projects

Sharing Projects

Protecting Projects

Moving or Copying Files into Projects

Including Referenced and Referencing Objects in a Project

Removing Unused Support Objects from a Project

Emptying a Project

Deleting a Project

Verifying Source Files

Enabling Parallel Verification

Invalidating Files Before Reverification

Setting Workspace Verification Options: Legacy Dialects Tab

Setting Workspace Verification Options: Settings Tab

Enabling Staged Parsing

Basic Repository Information

Full Logical Objects Information

Interactive Analysis Information

Dead Code Statistics

Enabling Relaxed Parsing

Truncating Names of Absolute Elements

Setting Workspace Verification Options: Parallel Verification Tab

Setting Project Verification Options

Specifying the Processing Environment

Specifying Conditional Compiler Constants

Optimizing Verification for Advanced Program Analysis

Convert Missing Programs to System Programs

Specifying Boundary Decisions

Performing Post-Verification Program Analysis

Restrictions on Cobol Post-Verification Program Analysis

Restrictions on PL/I Post-Verification Program Analysis

Using Post-Verification Reports

Viewing Verification Reports

Including Files into Projects

Generating HTML Reports

Viewing CRUD Reports

Setting CRUD Report Options

Exporting for Fortify Security Analysis (MBS)

Distinguishing between Homonyms in the Reports

Inventorying Applications

Using Reference Reports

Understanding the Reference Reports Window

Main Pane

Preview Pane

Setting Reference Reports Options

Using Orphan Analysis Reports

Understanding the Orphan Analysis Window

Found Objects Pane

Orphan Source Pane

Setting Orphan Analysis Options

Deleting Orphans from a Project

Deleting Orphans from a Workspace

Resolving Decisions

Understanding Decisions

Understanding the Decision Resolution Tool Window

Decision List Pane

Available Targets Pane

Source Pane

Resolving Decisions Manually

Restoring Manually Resolved Decisions

Resolving Decisions Automatically

Setting Decision Resolution Tool User Preferences

Identifying Interfaces for Generic API Analysis

Identifying Unsupported API Calls to the Parser

Using the API Entry Tag

Using the vars Tag

Natural-Specific Usage

Using the rep and hc Tags

Using Predefined Patterns

Using Custom Patterns

Using the entity Subtag

Using the rel Subtag

Using Expressions

Basic Usage

Simple Notation

Switch Usage

Fallback Chain Usage

Fallback Semantics for Attributes

Using a Function Call

Understanding Enumeration Order

Understanding Decisions

Understanding Conditions

Usage Example

Lookup function call in Generic API

Analyzing Projects

Managing Tags

Understanding the Tag Manager Window

Specifying Access to Tags

Assigning Tags

Removing Tags

Creating Relationships Between Tags

Deleting Tags

Creating Tag Queries

Deleting Tag Queries

Refreshing the Tag Manager Window

Cleaning Up the Tag Manager Window

Generating Reports

Analyzing Relationship Flows

Understanding Relationship Flow Diagrams

Understanding Diagram Scopes

Understanding Diagram Layouts

Generating a Diagram for the Selected Project

Generating a Diagram for Objects Copied and Pasted onto the Canvas

Understanding the Diagrammer Window

Diagram Pane

Selecting an Object or Relationship

Searching for an Object

Navigating to an Object from a Relationship

Expanding and Collapsing Relationships

Moving an Object or Relationship

Resizing an Object

Hiding an Object

Deleting an Object or Relationship

Assigning Tags

Assigning Business Names

Displaying Labels for Multiple Relationships

Hiding Relationship Labels

Displaying the Legend for a Diagram

Generating Diagram Reports

Excluding Objects Outside the Project

Showing Incomplete Composite Relationships

Colorizing Project Boundaries

Showing and Hiding Object Labels

Working with Groups

Grouping and Ungrouping Objects

Expanding and Collapsing Groups

Moving Objects Between Groups

Naming Groups

Deleting Groups

Black-Boxing Tagged Objects

Filtering Objects

Setting Filter Overrides

Clustering Objects

Creating Clusters Manually

Generating Tags from Clusters

Setting Clustering Factors

Setting Diagrams User Preferences

Using the Scope Editor

Understanding the Lefthand Pane of the Scope Editor

Understanding the Righthand Pane of the Scope Editor

Managing Scopes

Hiding a Scope in the Scope Drop-down

Displaying Only the Relationships Used in a Scope

Hiding Empty Relationships

Viewing a Diagram of a Scope

Viewing a Diagram of a Composite Relationship

Creating a Scope

Specifying the Relationships in a Scope

Editing Scope Details

Copying a Scope

Deleting a Scope

Deleting a Composite Relationship

Importing and Exporting Scopes

Hiding Columns in the Scope Editor

Creating Custom Composite Relationships

Defining a Relationship Filter

Pruning a Scope

Mirroring a Scope

Analyzing Global Data Flow

Understanding the Global Data Flow Panes

Data View Pane

Data Flow Pane

Origin Pane

Data Flow Relationships

Assigning Business Names Manually

Setting Global Data Flow User Preferences

Setting Global Data Flow Project Options

Estimating Complexity and Effort

Viewing Complexity Metrics

Setting Complexity Metrics User Preferences

Estimating Effort

Setting Effort Estimation Options

Specifying the Change Magnitude for a Source File

Identifying Classes of Data Items with Change Analyzer

Understanding Data Item Classification

Getting Started in Change Analyzer

Sample Usage of Change Analyzer

Understanding Change Analyzer

Change Candidates Pane

Fields Pane

Selecting Fields

Editing the Comment for a Field

Clearing Fields

Impact Tracing Pane

Source Pane

Searching for Change Candidates in Change Analyzer

Creating Projects in Change Analyzer

Setting Change Analyzer Options

Generating Change Analyzer Reports

Repository Exchange Protocol Syntax

Query Syntax

Example 1

Example 2

Portability Assessment

Quality Assessment

Analyzing Programs

Introducing Interactive Analysis

Understanding Interactive Analysis Models

Using the Interactive Analysis Main Window

Using Basic Navigation Controls

Using the Properties Window

Opening the Properties Window

Viewing and Navigating to Related Constructs

Opening a Properties Window for a Related Construct

Assigning Business Names Manually

Understanding Program Context

Using the Source Pane

Navigating and Searching for Source

Using the Simple Search Facility

Navigating to Related Constructs

Navigating to Multiple Occurrences of an Included Construct

Selecting and Copying Code

Selecting and Copying Constructs

Selecting and Copying Text

Setting Source Pane User Preferences

Collapsing and Expanding Paragraphs or Subprograms

Showing Source Code Boundaries

Using the Context Pane

Using the Objects Pane

Using the Watch Pane

Using the Screen Pane

Manually Extracting Business Names for Program Variables

Using the Bird's Eye Pane

Using the Model Reference Pane

Performing Advanced Searches

Specifying a Search Criterion

Executing Advanced Searches

Advanced String Attribute Operations

Working with Advanced Search Criteria

Creating a new Search Criterion

Editing a Search Criterion

Copying a Search Criterion or Folder

Saving a Search Criterion or Folder

Deleting a Search Criterion or Folder

Creating a Folder for Search Criteria

Copying a Search Criterion as Text

Exporting and Importing a Search Criterion or Folder

Staging Program Analysis with Code Search

Getting Started in Code Search

Understanding the Code Search Pane

Working with Categories

Working with Lists

Adding a Construct to a List Manually

Deleting a Construct from a List

Executing Code Search Searches

Using Construct Lists to Narrow a Code Search

Searching for Similar Constructs in Code Search

Extracting Business Rules in Code Search

Generating Business Rules in a Specified Rule Set

Generating an Impact Subtree Report in Code Search

Marking and Colorizing Constructs in Code Search

Creating Projects in Code Search

Generating Metrics and Detailed Reports

Running Code Search Reports in the Main Window

Creating a Custom Code Search Report

Working with Saved Reports

Code Search Report Results

Storing Code Search Reports

Running Code Search Reports in Interactive Analysis

Analyzing Impact Traces

Generating an Impact Trace

Understanding the Hierarchical View

Understanding the Diagram View

Data Flow Relationships

Setting Impact Pane User Preferences

Setting Impact Pane Project Options: Processing Tab

Setting Impact Pane Project Options: Relationships Tab

Setting Impact Pane Project Options: Impact Reports Tab

Exporting and Importing an Impact Trace

Generating a Subtree Report

Generating a Pane Report

Generating an Affected Code Report (COBOL Only)

Analyzing Program Control Flows

Using the Program Control Flow Pane

Drawing the Diagram

Choosing the Diagram View

Selecting Items

Setting Program Control Flow User Preferences

Setting Program Control Flow Project Options

Using the Execution Path Pane

Using the Flowchart Pane

Drawing the Diagram

Setting Flowchart User Preferences

Using the Animator

Setting Up a Glossary

Understanding the Glossary Pane

Searching for Terms

Using the Simple Search Facility

Using the Advanced Search Facility

Creating a List of Search Results

Assigning Business Attributes

Assigning Business Names Manually

Assigning Business Names in Batch Mode

Extracting Business Names from Screens

Importing and Exporting Business Attributes

Propagating Business Names

Deleting Business Attributes

Setting Glossary Workspace Options

Refreshing a Glossary

Generating Glossary Reports

Extracting Business Rules

Understanding Business Rules

How Business Rules Are Organized

How to Assign Segments to Business Rules

Understanding Business Rule Attributes

Understanding Triggers, I/O Data Elements, and Control Conditions

Understanding the Rules Pane Display

Extracting Business Rules Manually

Performing Basic Tasks in the Rules Pane

Creating Business Functions

Creating Rule Sets

Selecting Rules for Batch Processing

Moving or Copying Rules or Rule Sets

Copying a Rule or Rule Set with a Different Name

Deleting Rules, Rules Sets, and Business Functions

Changing the Order of Rules and Rule Sets

Exporting Rules, Rule Sets, and Business Functions

Importing Rules, Rule Sets, and Business Functions

Assigning Segments to Existing Rules

Deleting a Segment from a Rule

Flagging Segments in Source

Viewing the Activity Log

Editing Rule Attributes

Editing System Attributes

Editing the Name Attribute

Editing the Business Area Attribute

Editing the Technical Description Attribute

Editing the Business Description Attribute

Editing the To Be Reviewed By Attribute

Editing the Program Attribute

Editing the Segment Validity Attribute

Editing the Last Validation Time Attribute

Editing User-Defined Attributes

Editing the Audit Attribute

Editing the Classification Attribute

Editing the Status Attribute

Editing the Transition Attribute

Propagating Rule Attributes

Identifying Triggered Rule Sets

Identifying I/O Data Elements

Identifying I/O Data Elements Manually

Autodetecting I/O Data Elements

Retrieving Business Names for I/O Data Elements

Identifying Control Conditions

Specifying Control Conditions

Autoreplacing Variable Names in Control Conditions with Business Names

Searching for Rules

Batch Processing Rule Attributes

Usage Example

Substituting a Business Name for an I/O Element in an Attribute Value

Synchronizing Sources

Validating Rule Segments after Refreshing or Editing Code

Limitations on Automatic Rule Validation

Setting Business Rule Manager Project Options

Setting Options on the Rule Defaults Tab

Defining Rule Name Templates

Setting Options on the Automatic Rule Validation Tab

Setting Options on the Rule Export Tab

Setting Activity Log Options

Customizing Rule Attributes

Generating Reports

Generating Business Rule Reports

Generating Process Outline Reports

Generating Coverage Reports

Using the Batch Duplicate Finder

Finding Duplicates

Marking Items for Comparison

Marking Items Manually

Marking Items in Batch Mode

Setting BDF Search Options

Understanding Paragraph or Program Analysis

Understanding Common Part Analysis

Understanding Data Flow Analysis

Creating Components

Introducing Logic Analyzer

Componentization Methods

Structure-Based Componentization

Computation-Based Componentization

Domain-Based Componentization

Dead Code Elimination (DCE)

Entry Point Isolation

Componentization Outputs

Component Maker Basics

Getting Started in the Components Pane

Creating Components

Extracting Components

Converting Components

Deleting Components

Viewing the Text for Generated Files

Restricting the Display to Program-Related Components

Working with Interactive Analysis Lists

Viewing Audit Reports

Generating Coverage Reports

Setting Component Maker Options

Setting General Options

Setting Interface Options

Setting Optimize Options

Setting Document Options

Setting Component Type-Specific Options

Setting Structure-Based Type-Specific Options

Setting Computation-Based Type-Specific Options

Setting Domain-Based Type-Specific Options

Setting Component Conversion Options

Extracting Structure-Based Components

Understanding Ranges

Specifying Ranges for COBOL Programs

Specifying Ranges for PL/I Programs

Specifying Ranges for RPG Programs

Understanding Parameterized Slices

COBOL Naming Conventions

Parameterization Example

Extracting Structure-Based COBOL Components

Extracting Structure-Based PL/I Components

Extracting Structure-Based RPG Components

Extracting Computation-Based Components

Understanding Variable-Based Extraction

Understanding Blocking

Understanding Parameterized Slices

COBOL Naming Conventions

Parameterization Example

Extracting Computation-Based COBOL Components

Extracting Computation-Based Natural Components

Extracting Domain-Based Components

Understanding Program Specialization in Simplified Mode

Understanding Program Specialization in Advanced Mode

Understanding Program Specialization Lite

Extracting Domain-Based COBOL Components

Extracting Domain-Based PL/I Components

Eliminating Dead Code

Generating Dead Code Statistics

Understanding Dead Code Elimination

Extracting Optimized Components

Performing Entry Point Isolation

Extracting a COBOL Component with Entry Point Isolation

Technical Details

Verification Options

Override CICS Program Terminations

Support CICS HANDLE Statements

Perform Unisys TIP and DPS Calls Analysis

Perform Unisys Common-Storage Analysis

Relaxed Parsing

PERFORM Behavior for Micro Focus COBOL

Keep Legacy Copybooks Extraction Option

How Parameterized Slices Are Generated for COBOL Programs

Setting a Specialization Variable to Multiple Values

Arithmetic Exception Handling

Using the Batch Refresh Process

Understanding the Batch Refresh Process

Configuring the Batch Refresh Process

Configuring General Settings

Configuring User Exits

Understanding Exits

Configuring Exits

Configuring Advanced Settings

BRP Logging

Preparing Files for Batch Refresh Processing

Using Batch Refresh Process with homonyms in a workspace

Enabling Parallel Verification

Executing the Batch Refresh Process

Adding Source File Extensions

BRP Logging

Producing Utilities for BRP

Versioning

Logging

Source, Executable, and CFG Files

Guidelines for BRP Utilities

BRP and Non-BRP Modes

BRP Environment Parameters

Testing

Executing Batch Scripts

Example: Generating Reports

Example: Executing Repository Queries

Example: Creating Diagrams

Example: Performing an Advanced Search

Using Batch Scripts

AddNew.bj

AffectedCodeReport.bj

AnalyzeProgram.bj

ApplyPCF.bj

BusinessRulesReport.bj

BusinessRulesValidation.bj

ClipperMultiSearch.bj

ExportDescriptions.bj

ImpactReportFromList.bj

PortabilityAssessment.bj

Using Architecture Modeler

Introducing Architecture Modeler

Opening Architecture Modeler

Understanding the Application-Level Metamodel

Entity Type Properties

Source Name Property

Source Type Property

Entity Flags

Entity Type Attributes

Relationship Type Properties

Relationship Flags

Defining an Extension with Architecture Modeler

Loading a Metamodel

Saving the Extended Metamodel

Adding a Sample Source File

Specifying Formatting Options for Text Files

Defining Entity Types

Defining Relationship Types

Architecture Modeler Internal Language Functions Description

Mapping Regular Expressions to Text File Searches

Editing Subexpressions

Mapping XPath Queries to XML File Searches

Exporting the Extended Metamodel

Reconfiguring COBOL Analyzer

Troubleshooting the Extended Metamodel

Using Galleries

CA Web

Installing CA Web

Deploying CA Web

Deploying Micro Focus COBOL Analyzer Web API

Troubleshooting

Getting Started with CA Web

CA Web Reports

REST API and Jenkins Plugin

REST API

First Steps with the REST API

Getting Started with the EA Jenkins Plugin

Adding the Next Generation Warnings Plugin

Support Notes

Supported Languages

Supported Features by Language

C/C++ Support

Registering C/C++ Files

Verifying C/C++ Files

COBOL Support

.NET/JVM COBOL

Separators Must Be Followed by Blanks

Copybooks in a Library

How COBOL Analyzer Calculates COBOL Dead Code Statistics

Dead Statements

Dead Data Elements

Dead Constructs

Dead Statements, Dead Data Elements, and Dead Lines from Copybooks

Interactive Analysis Usage

Special Handling of Cobol Program Complexity Metrics

Possible Padding in MOVE Statements

ACUCOBOL Support

Java Support

JSP Support

Resolving the Location of Java Types and Packages Referenced in JSP Files

.NET Support

PL/SQL Support

SQL Support

Renaming DCLGEN Include Files

Prefixes for SQL Names

VB Support

Generating Library Description Files

Restrictions on Visual Basic Support

Complexity Metrics

Complexity Metrics Overview

ADL File

Assembler Copybook File

COMS Configuration File

Control Cards File

Control Language File

CSD File

DASDL Include File

Database Description File

Database File

DBD File

DDL File

Device Description File

Fujitsu COBOL Program

Library Description File

System Definition File

Relationship Projections

Relationship Projections Overview

Assembler Statements

Program Relationship Projections

BMS Statements

BMS File Relationship Projections

BMS Copybook File Relationship Projections

C/C++ Statements

C File Relationship Projections

C++ File Relationship Projections

Header File Relationship Projections

Class Relationship Projections

Function Relationship Projections

CICS Statements

Program Relationship Projections

Cobol Statements

Cobol File Relationship Projections

Cobol Copybook File Relationship Projections

Program Relationship Projections

CSD Statements

CSD File Relationship Projections

DBD Statements

DBD File Relationship Projections

EXEC SQL Statements

EXEC SQL Program Relationship Projections

FCT Statements

FCT File Relationship Projections

IDMS DML Statements

Cobol File Relationship Projections

Cobol Copybook File Relationship Projections

Program Relationship Projections

IDMS Schema Statements

IDMS Schema File Relationship Projections

Java Statements

Java Annotation Relationship Projections

Java Class Relationship Projections

Java Enumeration Relationship Projections

Java File Relationship Projections

Java Interface Relationship Projections

Java Package Relationship Projections

Method Relationship Projections

JCL Statements

JCL File Relationship Projections

JCL Procedure Relationship Projections

Natural Statements

Natural File Relationship Projections

Natural Include File Relationship Projections

Program Relationship Projections

.NET Statements

.NET Assembly Relationship Projections

.NET Method Relationship Projections

.NET File Relationship Projections

.NET Project Relationship Projections

.NET Type Relationship Projections

PCT Statements

PCT File Relationship Projections

PL/I Statements

PL/I File Relationship Projections

Pl/I Include File Relationship Projections

Program Relationship Projections

PSB Statements

PSB File Relationship Projections

PSB Copybook File Relationship Projections

RPG Statements

RPG File Relationship Projections

Program Relationship Projections

SQL DDL Statements

DDL File Relationship Projections

System Definition Statements

System Definition File Relationship Projections

Visual Basic Statements

VB Project File Relationship Projections

Library Description File Relationship Projections

VB Class, Form, and User Control Relationship Projections

VB Module Relationship Projections