FairCom RTG COBOL User Guide

FairCom RTG COBOL User Guide Documentation Overview FairCom RTG File Handler Overview Key Benefits of FairCom RTG COBOL FairCom RTG Server Advantages FairCom RTG SQL Access for Advanced Data Query Extensive Alternative APIs and Drivers FairCom RTG COBOL Quick Start FairCom RTG Setup and Installation FairCom RTG COBOL Directories The Samples Directory FairCom RTG Server Set-up FairCom RTG for Windows FairCom RTG for Unix/Linux Shared Memory for FairCom RTG Shared Memory Resource Considerations Runtime Configuration Configure the FairCom RTG Server Connecting to the FairCom RTG Server - RM/COBOL Secure SSL Communication FairCom RTG Runtime Drivers COBOL Compilers Supported by FairCom RTG COBOL ACUCOBOL-GT Recompiling the Runtime Recompiling the Windows Runtime Recompiling the Unix Runtime ACUCOBOL-GT Environment Variables CTREE_LIB DEFAULT_HOST EXTRA_KEYS_OK filename_HOST SET ENVIRONMENT ACUCOBOL-GT Verb Error message: "libctclient.so: cannot open shared object file" Advanced AcuCOBOL RTG Integration Adding Support for --setenv Command-Line Argument to Runtime Appending Indices to Existing Files from the RTG FSI Interface (ACUCOBOL) AIX 32-bit Server Shared Memory Requires EXTSHM ON ACUCOBOL API for SQL Conversion Error Checking SQL Conversion for ACUCOBOL Users ct_XDDOpen ct_XDDCheck ct_XDDClose XDDCHECK Errors Enabling XDDOPEN, XDDCHECK, and XDDCLOSE for Programmatic SQL Conversion Error Checking Micro Focus and ExtFH Compatible Interfaces Dynamic Redirection Recompiling Your Application (Optional) Using the CALLFH Compiler Directive Specifying c-tree as Indexed File Handler at Link Time Configuration Note for Micro Focus on 64-bit AIX Library Unloading Enhancement NOCANCEL Wrapper Module for Rocket (Microfocus) Enterprise Server on Linux isCOBOL Configuring isCOBOL Runtime Troubleshooting RM/COBOL Adjusting the RM/COBOL Configuration File Include RM Library with Local Runtime Environment Adjusting Paths Multiple File Systems with RM/COBOL Additional Documentation Data Conversion Convert AcuCOBOL Vision Data to FairCom RTG COBOL Convert Microfocus ExtFH C-ISAM Tables with ctmigra Convert RM/COBOL Format Data to FairCom RTG COBOL RTG Migrate FairCom RTG Configuration FairCom RTG Configuration and Management CTREE_CONF Environment Variable - COBOL CTREE_CONF_DUMP environment variable to specify configuration dump file FairCom RTG Configuration Tool - RTG Config Creating a New File (Basic) Creating a New File (Advanced) Editing a Configuration File COBOL Configuration Note Encrypting the Configuration File Checking the Configuration Using CTREE_LOG and ctutil CTREE_LOG Configuration File Elements FairCom RTG Configuration File Structure Elements <config> <instance> <localinstance> <redirinstance> <file> Wildcard File Matching Rules File Matching Precedence Settings Elements <automkdir> <batchaddition> <bulkaddition> <ctfixed> <ctflexrec> <datacompress> <datafilesuffix> <delcurrent> <detectlock> <encrypt> <extfhexit> <extfhreindexoncreate> <filecopy> <filepool> <fileversion> <forcedelete> <hugefile> <ignorelock> <indexfilesuffix> <inpool> <keycheck> <keycompress> <rle> <leading> <padding> <log> <debug> <error> <info> <profile> <warning> <locktimeout> <locktype> <maxlencheck> <maxsize> <map> <name> <dir> <memoryfile> <normalize> <optimisticadd> <permission> <prefetch> <recordcheck> <retrylock> <rowid> <runitlockdetect> <scancache> <skiplock> <smartcopy> <sqlize> <startonread> <temporary> <transaction> <trxholdslocks> <writethru> Substitution Specifiers FairCom RTG Transaction Support Transaction Control - Why you should want it Enabling RTG transaction control Switching transaction modes Automatic Recovery Transaction control and performance Transaction log files and best practices FairCom RTG SQL Access The FairCom RTG SQL Challenge Step-by-Step Sqlizing Instructions FairCom RTG Extended Data Definitions - XDD Type Mapping Table Variable-length fields mapped into LONGVAR* SQL field COBOL to SQL Type Mapping COBOL Date Baseline Can Be Set to Julian Starting Date of Dec 31, 1600 Create an XDD Manually Create an XDD from an XFD Create an XDD from Your COBOL Source Common SQL Limitations with FairCom RTG Data REDEFINES: Multiple Record Types Index Compatibility Viewing Sqlized Tables in FairCom DB SQL Explorer Adding SQL Indexes to Sqlized Files Preserve Imported Data Files upon SQL DROP Data Conversion Between COBOL and SQL COBOL to SQL SQL to COBOL Troubleshooting Data Conversion Errors Rules for SQL Conversion Exception Handling <XFDrules> root element <rule> XFDRules element <when> rule element <[Condition]> when elements <do> rule element <[Action]> do elements <[Target]> action element Rule Examples xddgen Techniques Using Group Names Splitting an OCCURR Combining Multiple XDD Directives Name Conflicts HIDDEN Directive Multi-Record Example Modern RTG Data Management File Maintenance Concerns with RTG FairCom RTG backup management FairCom RTG Hot Alter Table Hot Alter Table step-by-step examples Partitioned Files with FairCom RTG UTF-8 Data Stored in FairCom RTG Replication, Clusters, High Availability, and Disaster Recovery FairCom RTG Failover Configuration Changes to Your COBOL Program Replicating RTG File Operations FairCom RTG Utilities ctutil ctutil Notes ctutil Commands -alter -applyrules -augment -check -clone -compact -compress -conv -copy -cryptconf -exist -filecopy -fileid -info -make -makeidx -maxsize -load -partition -o word -rebuild -remove -rename -run -segment -setowner -setpath -sign -sqlcheck -sqlinfo convention_ID values -sqllink -sqlunlink -sqlize -sqlrefresh -test -tron -uncompress -unload -upgrade -xfd2xdd ctcbtran ctaddrtgi - Add SQL indexes over existing COBOL tables xddgen XDD Directives Handling DATE Fields in Your XFD Syntax for WITH DUPLICATES on RECORD KEY Suppress Dash or Replace with Underscore xddgen Configuration File Configuration Files Directory xddgen - New Configuration Option max-fixed-record-len xddgen - New Record Size Checks and Warnings ctclosefile - Close Open Memory and ctKEEPOPEN files ctclntrn and cthghtrn - Manage Transaction Mark Numbers ctcmpcif - IFIL-based Compact Utility Included ctfileid - Update File IDs ctfixdupscan - Detect and Fix Files that Suffer from File Definition Errors ctmigra - Conversion Utility Standalone Support for ctmigra ctstat - Statistics Utility cttrnmod - Change Transaction Mode Utility ct_tpc and cttpca TPC A Test startserver and stopserver Scripts Additional FairCom RTG Command-Line Tools Appendix A - Logging, Error Codes, and Troubleshooting Driver Error Codes FairCom RTG Error Codes FairCom RTG SQL Access Errors Configurable Log Output Listing connections with a particular file open Copying Server-Controlled Files C$ Not Supported in FairCom RTG Performance Tips and Tuning Performance Monitoring with ctstat Additional Monitoring Tools Troubleshooting Error 456 Error 407 Error 408 / 438 Client/Server Incompatibility File Matching Rules in ctree.conf isCOBOL Fails to Run cobol_Tutorial1 READ NEXT at End of File Appendix B - XDD Schema Structure <table> root element <key> table element <part> key element <segment> key element <filters> table element <field> filters element <filter> filters element <[Operator]> filter elements <field> operator element <value> operator element <schema> table element <field> schema element Appendix C - FairCom RTG COBOL Tutorials cobol_Tutorial1 Compile cobol_Tutorial1 with ACUCOBOL Compile cobol_Tutorial1 with isCOBOL Run cobol_Tutorial1 with ACUBOBOL Run cobol_Tutorial1 with isCOBOL Open cobol_Tutorial1 data through SQL (optional) cobol_Tutorial1 Source Code Sqlize Tutorial SQLIZEEXAMPLE.CBL CARDFILE.FD CARDFILE.SL rules.xml isCOBOL Samples Appendix D - RTG Version Upgrades Upgrade files to RTG 5 attribute resource format (Unified Data Types) FairCom Typographical Conventions Copyright Notice Index