IBM COBOL for AIX

https://www.ibm.com/docs/en/cobol-aix
Admin
IBM COBOL for AIX is a COBOL compiler that enables the development and execution of COBOL...
Tokens:111,156
Snippets:1,523
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Check installed compiler version

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=aix-checking-compiler-fileset-information

Example command to verify the version of the installed COBOL compiler.

```shell
lslpp -L cobol.cmp
```

--------------------------------

### Define a class instance method with METHOD-ID

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=method-id-paragraph-defining-class-instance

Example showing the start of a method definition using the IDENTIFICATION DIVISION and METHOD-ID paragraphs.

```COBOL
Identification Division.
Method-id. "credit".
```

--------------------------------

### Example FILE STATUS Clause

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=operations-using-file-status-keys

A specific implementation example of the FILE STATUS clause using a named variable.

```COBOL
FILE STATUS IS FS-CODE
```

--------------------------------

### Examples of man page commands

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=information-viewing-man-pages

Common examples of invoking man pages for COBOL for AIX tools.

```shell
man cob2
man scu
man gdgmgr 
```

--------------------------------

### Flexible Numeric Input Examples

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=functions-converting-numbers-numval-numval-c

Example inputs that can be processed by the NUMVAL function.

```text
1.23
-300
```

--------------------------------

### Strict Numeric Input Examples

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=functions-converting-numbers-numval-numval-c

Example inputs that must match the PICTURE clause definition exactly.

```text
+001.23
-300.00
```

--------------------------------

### Display source listing header format

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=program-changing-header-source-listing

Example output showing the standard header format on the first page of a COBOL for AIX source listing.

```text
PP 5724-Z87 IBM COBOL for AIX 5.1.0	     Date 09/15/2010   Time 15:05:19   Page     1
```

--------------------------------

### Define a get method in a COBOL class

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=methods-example-coding-get-method

This example shows the structure of an instance method within the OBJECT paragraph of a COBOL class, using a Linkage section to return a value.

```COBOL
 Identification Division.
 Class-id. Account inherits Base.
*  (ENVIRONMENT DIVISION not shown)
*  (FACTORY paragraph not shown)
*
 Identification division.
 Object.
  Data division.
  WORKING-STORAGE SECTION.
  01 AccountBalance pic S9(9) value zero.
*   (Other instance data not shown) 
*
  Procedure Division.
*
   Identification Division.
   Method-id. "getBalance".
   Data division.
   Linkage section.
   01 outBalance pic S9(9) binary.
*
   Procedure Division returning outBalance.
     Move AccountBalance to outBalance.
   End method "getBalance".
*
*  (Other instance methods not shown)
 End Object.
*
 End class Account.
```

--------------------------------

### Define REPOSITORY paragraph for a subclass

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=subclass-repository-paragraph-defining

This example shows the required structure for the Environment Division, Configuration Section, and Repository paragraph when defining a subclass.

```COBOL
Environment Division.                          Required
Configuration Section.                         Required
Repository.                                    Required
    Class CheckingAccount is "CheckingAccount" Optional
    Class Check           is "Check"           Required
    Class Account         is "Account".        Required
```

--------------------------------

### Example output of db2 describe command

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=systems-db2-file-system

The output format for the db2 describe command showing column names, data types, and constraints.

```text
                        Data type                    Column
Column name             schema    Data type name     Length   Scale Nulls
----------------------- --------- ------------------ -------- ----- ----
RBA                     SYSIBM    CHARACTER                8      0 No
F1                      SYSIBM    CHARACTER               41      0 No
F2                      SYSIBM    VARCHAR                 29      0 No
```

--------------------------------

### Define the start of a factory section

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=programs-defining-factory-section

Use this structure to initiate a factory definition within a COBOL class.

```COBOL
IDENTIFICATION DIVISION.
FACTORY.
```

--------------------------------

### Defining an Account Class in COBOL

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=class-example-defining

This example demonstrates the basic structure of a class definition, including the repository configuration and object data division.

```COBOL
 cbl thread,pgmname(longmixed)
 IDENTIFICATION DIVISION.
 Class-id. Account inherits Base.
 ENVIRONMENT DIVISION.
 Configuration section.
 Repository.
     Class Base    is "java.lang.Object"
     Class Account is "Account".
*
 IDENTIFICATION DIVISION.
 Object.
  DATA DIVISION.
  WORKING-STORAGE SECTION.
  01 AccountNumber  pic 9(6).
  01 AccountBalance pic S9(9) value zero.
*
  PROCEDURE DIVISION.
*
*   (Instance method definitions here)
*
 End Object.
*
 End class Account.
```

--------------------------------

### Defining an Account Class with Factory Methods

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=section-example-defining-factory-methods

This example demonstrates the structure of a COBOL class, including the Factory division for static methods and the Object division for instance methods.

```COBOL
 cbl thread,pgmname(longmixed),lib
 Identification Division.
 Class-id. Account inherits Base.
 Environment Division.
 Configuration section.
 Repository.
     Class Base    is "java.lang.Object"
     Class Account is "Account".
*
 Identification division.
 Factory.
  Data division.
  Working-storage section.
  01 NumberOfAccounts pic 9(6) value zero.
*
  Procedure Division.
*
*    createAccount method to create a new Account
*    instance, then invoke the OBJECT paragraph's init
*    method on the instance to initialize its instance data:
   Identification Division.
   Method-id. "createAccount".
   Data division.
   Linkage section.
   01 inAccountNumber  pic S9(6) binary.
   01 outAccount object reference Account.
*      Facilitate access to JNI services:
     Copy JNI.
   Procedure Division using by value inAccountNumber
       returning outAccount.
*      Establish addressability to JNI environment structure:
     Set address of JNIEnv to JNIEnvPtr
     Set address of JNINativeInterface to JNIEnv
     Invoke Account New returning outAccount
     Invoke outAccount "init" using by value inAccountNumber
     Add 1 to NumberOfAccounts.
   End method "createAccount".
*
 End Factory.
*
 Identification division.
 Object.
  Data division.
  Working-storage section.
  01 AccountNumber  pic 9(6).
  01 AccountBalance pic S9(9) value zero.
*
  Procedure Division.
*
*    init method to initialize the account:
   Identification Division.
   Method-id. "init".
   Data division.
   Linkage section.
   01 inAccountNumber pic S9(9) binary.
   Procedure Division using by value inAccountNumber.
     Move inAccountNumber to AccountNumber.
   End method "init".
*
*    getBalance method to return the account balance:
   Identification Division.
   Method-id. "getBalance".
   Data division.
   Linkage section.
   01 outBalance pic S9(9) binary.
   Procedure Division returning outBalance.
     Move AccountBalance to outBalance.
   End method "getBalance".
*
*    credit method to deposit to the account: 
   Identification Division.
   Method-id. "credit".
   Data division.
   Linkage section.
   01 inCredit   pic S9(9) binary.
   Procedure Division using by value inCredit.
     Add inCredit to AccountBalance.
   End method "credit".
*
*    debit method to withdraw from the account:
   Identification Division.
   Method-id. "debit".
   Data division.
   Linkage section.
   01 inDebit    pic S9(9) binary.
   Procedure Division using by value inDebit.
     Subtract inDebit from AccountBalance.
   End method "debit".
*
*    print method to display formatted account number and balance: 
   Identification Division.
   Method-id. "print".
   Data division.
   Local-storage section.
   01 PrintableAccountNumber  pic ZZZZZZ999999.
   01 PrintableAccountBalance pic $$$$,$$$,$$9CR.
   Procedure Division.
     Move AccountNumber  to PrintableAccountNumber
     Move AccountBalance to PrintableAccountBalance
     Display " Account: " PrintableAccountNumber
     Display " Balance: " PrintableAccountBalance.
   End method "print".
*
 End Object.
*
 End class Account.
```

--------------------------------

### Defining Methods in a COBOL Class

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=method-example-defining

A complete example of an Account class in COBOL, demonstrating the definition of various methods such as init, getBalance, credit, debit, and print.

```COBOL
 cbl thread,pgmname(longmixed)
 Identification Division.
 Class-id. Account inherits Base.
 Environment Division.
 Configuration section.
 Repository.
     Class Base    is "java.lang.Object"
     Class Account is "Account".
*
*  (FACTORY paragraph not shown)
*
 Identification division.
 Object.
  Data division.
  Working-storage section.
  01 AccountNumber  pic 9(6).
  01 AccountBalance pic S9(9) value zero.
*
  Procedure Division.
*
*    init method to initialize the account:
   Identification Division.
   Method-id. "init".
   Data division.
   Linkage section.
   01 inAccountNumber pic S9(9) binary.
   Procedure Division using by value inAccountNumber.
     Move inAccountNumber to AccountNumber.
   End method "init".
*
*    getBalance method to return the account balance:
   Identification Division.
   Method-id. "getBalance".
   Data division.
   Linkage section.
   01 outBalance pic S9(9) binary.
   Procedure Division returning outBalance.
     Move AccountBalance to outBalance.
   End method "getBalance".
*
*    credit method to deposit to the account: 
   Identification Division.
   Method-id. "credit".
   Data division.
   Linkage section.
   01 inCredit   pic S9(9) binary.
   Procedure Division using by value inCredit.
     Add inCredit to AccountBalance.
   End method "credit".
*
*    debit method to withdraw from the account: 
   Identification Division.
   Method-id. "debit".
   Data division.
   Linkage section.
   01 inDebit    pic S9(9) binary.
   Procedure Division using by value inDebit.
     Subtract inDebit from AccountBalance.
   End method "debit".
*
*    print method to display formatted account number and balance:
   Identification Division.
   Method-id. "print".
   Data division.
   Local-storage section.
   01 PrintableAccountNumber  pic ZZZZZZ999999.
   01 PrintableAccountBalance pic $$$$,$$$,$$9CR.
   Procedure Division.
     Move AccountNumber  to PrintableAccountNumber
     Move AccountBalance to PrintableAccountBalance
     Display " Account: " PrintableAccountNumber
     Display " Balance: " PrintableAccountBalance.
   End method "print".
*
 End Object.
*
 End class Account.
```

--------------------------------

### GDG generation increment examples

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=groups-insertion-wrapping-generation-files

Demonstrates how specifying relative generation numbers like (+1), (+4), and (+9997) results in new generation files and potential wrapping.

```text

0: base.g0001v00 
0: base.g0002v00

```

```text

0: base.g0001v00
0: base.g0002v00
0: base.g0006v00

```

```text

0: base.g0001v00 
0: base.g0002v00
0: base.g0004v00 
0: base.g0006v00

```

--------------------------------

### Display Output for Currency Sign

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=arithmetic-using-currency-signs

Example of the resulting output when a numeric value is formatted with the defined currency sign.

```text
Invoice amount is  $US1,500.00
```

--------------------------------

### Invoke a COBOL Factory Method

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=method-invoking-factory-static-methods

Example of invoking the createCheckingAccount factory method with specific arguments and a return variable.

```COBOL
Invoke CheckingAccount "createCheckingAccount"
  using by value 777777 300
  returning aCheckingAccount
```

--------------------------------

### GDG epoch adjustment example

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=groups-insertion-wrapping-generation-files

Shows how epoch numbers are adjusted when a generation number wraps from a high value to a low value to maintain the correct chronological order.

```text

0: base.g1000v00 
0: base.g9000v00

```

```text

0: base.g1000v00 
0: base.g9000v00
1: base.g0500v00

```

--------------------------------

### Define a file structure in COBOL

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=files-describing-structure-file-in-detail

Use the FD keyword to start a file description in the FILE SECTION, followed by record definitions.

```COBOL
DATA DIVISION.
FILE SECTION.
FD  filename
01  recordname
    nn . . . fieldlength & type
    nn . . . fieldlength & type
    . . .
```

--------------------------------

### Define a COBOL instance method header

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=method-overriding-instance

This example shows the LINKAGE SECTION and PROCEDURE DIVISION header for a debit method in an Account class.

```COBOL
Linkage section.
01 inDebit    pic S9(9) binary.
Procedure Division using by value inDebit.
```

--------------------------------

### Define CheckingAccount Class with Factory and Object Methods

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=section-example-defining-factory-methods

A comprehensive example showing the structure of a COBOL class including factory data, overloaded factory methods for object creation, and object-level methods for processing checks and printing status.

```COBOL
 cbl thread,pgmname(longmixed),lib
 Identification Division.
 Class-id. CheckingAccount inherits Account.
 Environment Division.
 Configuration section.
 Repository.
     Class CheckingAccount is "CheckingAccount"
     Class Check           is "Check"
     Class Account         is "Account".
*
 Identification division.
 Factory.
  Data division.
  Working-storage section.
  01 NumberOfCheckingAccounts pic 9(6) value zero.
*
  Procedure Division.
*
*    createCheckingAccount overloaded method to create a new
*    CheckingAccount instance with a default balance, invoke 
*    inherited instance method init to initialize the account 
*    number, and increment factory data tally of checking accounts: 
   Identification Division.
   Method-id. "createCheckingAccount".
   Data division.
   Linkage section.
   01 inAccountNumber  pic S9(6) binary.
   01 outCheckingAccount object reference CheckingAccount.
*      Facilitate access to JNI services:
     Copy JNI.
   Procedure Division using by value inAccountNumber
       returning outCheckingAccount.
*      Establish addressability to JNI environment structure:
     Set address of JNIEnv to JNIEnvPtr
     Set address of JNINativeInterface to JNIEnv
     Invoke CheckingAccount New returning outCheckingAccount
     Invoke outCheckingAccount "init"
       using by value inAccountNumber
     Add 1 to NumberOfCheckingAccounts.
   End method "createCheckingAccount".
*
*    createCheckingAccount overloaded method to create a new
*    CheckingAccount instance, invoke inherited instance methods
*    init to initialize the account number and credit to set the
*    balance, and increment factory data tally of checking accounts: 
   Identification Division.
   Method-id. "createCheckingAccount".
   Data division.
   Linkage section.
   01 inAccountNumber  pic S9(6) binary.
   01 inInitialBalance pic S9(9) binary.
   01 outCheckingAccount object reference CheckingAccount.
     Copy JNI.
   Procedure Division using by value inAccountNumber
                                     inInitialBalance
       returning outCheckingAccount.
     Set address of JNIEnv to JNIEnvPtr
     Set address of JNINativeInterface to JNIEnv
     Invoke CheckingAccount New returning outCheckingAccount
     Invoke outCheckingAccount "init"
       using by value inAccountNumber
     Invoke outCheckingAccount "credit"
       using by value inInitialBalance
     Add 1 to NumberOfCheckingAccounts.
   End method "createCheckingAccount".
*
 End Factory.
*
 Identification division.
 Object.
  Data division.
  Working-storage section.
  01 CheckFee pic S9(9) value 1.
  Procedure Division.
*
*    processCheck method to get the check amount and payee,
*    add the check fee, and invoke inherited methods debit
*    to debit the payer and credit to credit the payee:
   Identification Division.
   Method-id. "processCheck".
   Data division.
   Local-storage section.
   01 amount pic S9(9) binary.
   01 payee usage object reference Account.
   Linkage section.
   01 aCheck usage object reference Check.
   Procedure Division using by value aCheck.
     Invoke aCheck "getAmount" returning amount
     Invoke aCheck "getPayee" returning payee
     Invoke payee  "credit" using by value amount
     Add checkFee to amount
     Invoke self   "debit"  using by value amount.
   End method "processCheck".
*
*    print method override to display account status:
   Identification Division.
   Method-id. "print".
   Data division.
   Local-storage section.
   01 printableFee pic $$,$$$,$$9.
   Procedure Division.
     Invoke super "print"
     Move CheckFee to printableFee
     Display " Check fee: " printableFee.
   End method "print".
*
 End Object.
*
 End class CheckingAccount.
```

--------------------------------

### Create a COBOL test program

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=aix-testing-installation-cobol

A simple COBOL source file that displays 'Hello World!' to the console.

```COBOL
[hello.cbl]
000100  IDENTIFICATION DIVISION.
000200  PROGRAM-ID.  HELLO.
000300  AUTHOR.      JOE PROGRAMMER.
000400  ENVIRONMENT DIVISION.
000500  DATA DIVISION.
000600  PROCEDURE DIVISION.
000700  MAINLINE.
000800      DISPLAY 'Hello World!'.
000900      STOP RUN.
```

--------------------------------

### Define an overloaded init method with two parameters

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=method-overloading-instance

Initializes an Account instance using both an account number and an opening balance.

```COBOL

Linkage section. 
01 inAccountNumber pic S9(9) binary. 
01 inBalance       pic S9(9) binary. 
Procedure Division using by value inAccountNumber
                                  inBalance. 

```

--------------------------------

### Initialize DB2 Environment

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=files-using-db2

Execute the DB2 profile script to initialize the environment for a specific instance.

```shell
. /home/db2inst1/sqllib/db2profile
```

--------------------------------

### Create GDG Catalog in DB2 File System

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=groups-creating-generation-data

Initialize the DB2 environment and use gdgmgr with the -F DB2 flag to create a catalog.

```bash
. /home/db2inst1/sqllib/db2profile
export DB2DBDFT=database
gdgmgr -F DB2 -c cics.dbGroup
```

--------------------------------

### Define COBOL Data Items for Arithmetic Examples

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=arithmetic-examples-fixed-point-floating-point-evaluations

Data structure definitions for an employee table and report metrics used in arithmetic evaluation examples.

```COBOL

01  employee-table.
    05  emp-count         pic  9(4).
    05  employee-record occurs 1 to 1000 times
            depending on emp-count.
        10 hours          pic +9(5)e+99.
. . .
01  report-matrix-col     pic  9(3).
01  report-matrix-min     pic  9(3).
01  report-matrix-max     pic  9(3).
01  report-matrix-tot     pic  9(3).
01  average-hours         pic  9(3)v9.
01  whole-hours           pic  9(4).

```

--------------------------------

### ODBC Initialization and Cleanup Procedures

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=apis-example-copybook-odbc-procedures

Contains COBOL sections for allocating environment, connection, and statement handles, as well as cleanup routines for disconnecting and freeing handles.

```COBOL
******************************************************************
* ODBC3P.CPY                                                     *
*----------------------------------------------------------------*
*  Sample ODBC initialization, clean-up and error handling       *
*    procedures    (ODBC Ver 3.0)                                *
******************************************************************
*** Initialization functions SECTION *****************************
 ODBC-Initialization SECTION.
*
  Allocate-Environment-Handle.
     CALL "SQLAllocHandle" USING
                             BY VALUE     SQL-HANDLE-ENV
                             BY VALUE     SQL-NULL-HANDLE
                             BY REFERENCE Henv
                           RETURNING      SQL-RC
      IF SQL-RC NOT = SQL-SUCCESS
       MOVE "SQLAllocHandle for Env" TO SQL-stmt
       MOVE SQL-HANDLE-ENV to DiagHandleType
       SET DiagHandle to Henv
       PERFORM SQLDiag-Function
     END-IF.
*
  Set-Env-Attr-to-Ver30-Behavior.
     CALL "SQLSetEnvAttr" USING
                            BY VALUE      Henv
                            BY VALUE      SQL-ATTR-ODBC-VERSION
                            BY VALUE      SQL-OV-ODBC3
*                                      or SQL-OV-ODBC2         *
*                                         for Ver 2.x behavior *
                            BY VALUE      SQL-IS-UINTEGER
                         RETURNING        SQL-RC
     IF SQL-RC NOT = SQL-SUCCESS
       MOVE "SQLSetEnvAttr" TO SQL-stmt
       MOVE SQL-HANDLE-ENV to DiagHandleType
       SET DiagHandle to Henv
       PERFORM SQLDiag-Function
     END-IF.
*
  Allocate-Connection-Handle.
     CALL "SQLAllocHandle" USING
                             By VALUE     SQL-HANDLE-DBC
                             BY VALUE     Henv
                             BY REFERENCE Hdbc
                           RETURNING      SQL-RC
     IF SQL-RC NOT = SQL-SUCCESS
         MOVE "SQLAllocHandle for Connection" to SQL-stmt
         MOVE SQL-HANDLE-ENV to DiagHandleType
         SET DiagHandle to Henv
         PERFORM SQLDiag-Function
     END-IF.
*** SQLAllocHandle for statement function SECTION ***************
 Allocate-Statement-Handle SECTION.
  Allocate-Stmt-Handle.
     CALL "SQLAllocHandle" USING
                             By VALUE     SQL-HANDLE-STMT
                             BY VALUE     Hdbc
                             BY REFERENCE Hstmt
                           RETURNING      SQL-RC
     IF SQL-RC NOT = SQL-SUCCESS
         MOVE "SQLAllocHandle for Stmt" TO SQL-stmt
         MOVE SQL-HANDLE-DBC to DiagHandleType
         SET DiagHandle to Hdbc
         PERFORM SQLDiag-Function
     END-IF.
*** Cleanup Functions SECTION ***********************************
 ODBC-Clean-Up SECTION.
*
  Free-Statement-Handle.
     CALL "SQLFreeHandle" USING
                            BY VALUE SQL-HANDLE-STMT
                            BY VALUE Hstmt
                          RETURNING  SQL-RC
     IF SQL-RC NOT = SQL-SUCCESS
         MOVE "SQLFreeHandle for Stmt" TO SQL-stmt
         MOVE SQL-HANDLE-STMT to DiagHandleType
         SET DiagHandle to Hstmt
         PERFORM SQLDiag-Function
     END-IF.
*
  SQLDisconnect-Function.
     CALL "SQLDisconnect" USING
                            BY VALUE Hdbc
                          RETURNING  SQL-RC
     IF SQL-RC NOT = SQL-SUCCESS
```

--------------------------------

### Create a class instance

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=client-creating-initializing-instances-classes

Use the INVOKE statement to instantiate a class and obtain an object reference.

```COBOL
INVOKE class-name NEW . . . RETURNING object-reference
```

--------------------------------

### Positioning the File Indicator with START

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=files-reading-records-from-file

Use the START statement to set the file position indicator to a specific record based on an alternate key before performing sequential reads.

```COBOL
START file-name KEY IS EQUAL TO ALTERNATE-RECORD-KEY
```

--------------------------------

### Invoke Intrinsic Functions

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=data-using-intrinsic-functions-built-in-functions

Examples of using function-identifiers within COBOL statements.

```COBOL
Unstring Function Upper-case(Name) Delimited By Space
    Into Fname Lname
Compute A = 1 + Function Log10(x)
Compute M = Function Max(x y z)
```

--------------------------------

### Define ODBC Function Prototype

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=overview-passing-pointers-as-arguments-in-odbc-calls

Example of a function definition where PSomeArgument points to SomeArgument.

```COBOL

RETCODE SQLSomeFunction(PSomeArgument)

```

--------------------------------

### XML Output from Program XGFX

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=output-example-generating-xml

Sample XML document representing a purchase order with bill-to and ship-to details.

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<po:purchaseOrder xmlns:po="http://www.example.com" orderDate="1999-10-20" orderComment="Hurry, my lawn is going wild!">
  <po:shipTo country="US" name="Alice Smith" street="123 Maple Street" city="Mill Valley" state="CA" zip="90952"/>
  <po:billTo country="US" name="Robert Smith" street="8 Oak Avenue" city="Old Town" state="PA" zip="95819"/>
  <po:items>
    <po:item partNum="872-AA" productName="Lawnmower" quantity="1" USPrice="148.95" shipDate=" " itemComment="Confirm...
  </po:items>
  <po:items>
    <po:item partNum="926-AA" productName="Baby Monitor" quantity="1" USPrice="39.98" shipDate="1999-05-21" itemComme...
  </po:items>
</po:purchaseOrder>
```

--------------------------------

### Configure Cache Sizes via Environment Variable

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=performance-enabling-client-side-caching

Sets the read cache to 16 pages and the insert cache to 64 pages for all SFS files.

```shell
export ENCINA_VSAM_CACHE=16:64
```

--------------------------------

### Specify XML encoding declaration

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=encoding-specifying

Example of an XML declaration specifying the ibm-1140 encoding.

```xml
<?xml version="1.0" encoding="ibm-1140"?>
```

--------------------------------

### Implement TestAccounts client program in COBOL

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=section-example-defining-factory-methods

A COBOL program demonstrating object instantiation and method invocation using factory methods.

```cobol

 cbl thread,pgmname(longmixed)
 Identification division.
 Program-id. "TestAccounts" recursive.
 Environment division.
 Configuration section.
 Repository.
     Class Account         is "Account"
     Class CheckingAccount is "CheckingAccount"
     Class Check           is "Check".
 Data Division.
*  Working data is declared in Local-storage
*  so that each thread has its own copy: 
 Local-storage section.
 01  anAccount        usage object reference Account.
 01  aCheckingAccount usage object reference CheckingAccount.
 01  aCheck           usage object reference Check.
 01  payee            usage object reference Account.
*
 Procedure division.
 Test-Account-section.
     Display "Test Account class"
*  Create account 123456 with 0 balance:
     Invoke Account "createAccount"
       using by value 123456
       returning anAccount
*  Deposit 500 to the account:     
     Invoke anAccount "credit" using by value 500
     Invoke anAccount "print"
     Display space
*
     Display "Test CheckingAccount class"
*  Create checking account 777777 with balance of 300: 
     Invoke CheckingAccount "createCheckingAccount"
       using by value 777777 300
       returning aCheckingAccount
*  Set account 123456 as the payee: 
     Set payee to anAccount
*  Initialize check for 125 to be paid by account 777777 to payee: 
     Invoke Check New
       using by value aCheckingAccount, payee, 125
       returning aCheck
*  Debit the payer, and credit the payee:  
     Invoke aCheckingAccount "processCheck"
       using by value aCheck
     Invoke aCheckingAccount "print"
     Invoke anAccount "print"
*
     Stop Run.
 End program "TestAccounts".

```

--------------------------------

### Example XML Output

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=output-example-enhancing-xml

The resulting XML structure after applying the redefined COBOL data structures.

```XML

<BaseValues>
  <BaseValueDate>01/02/03</BaseValueDate>
  <BaseValueLine>
    <Description>First</Description>
    <BaseDate>01/01/01</BaseDate>
    <BasePrice>$23.00</BasePrice>
    <BaseQuantity>123.000</BaseQuantity>
    <BaseValue>$765.00</BaseValue>
  </BaseValueLine>
  <BaseValueLine>
    <Description>Second</Description>
    <BaseDate>02/02/02</BaseDate>
    <BasePrice>$34.00</BasePrice>
    <BaseQuantity>234.000</BaseQuantity>
    <BaseValue>$654.00</BaseValue>
  </BaseValueLine>
  <TotalValue>Very high!</TotalValue>
</BaseValues>

```

--------------------------------

### Define internal file-name in COBOL

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=files-file-concepts-terminology

Example of declaring an internal file-name within the FILE SECTION.

```cobol
Data division.
File section.
FD  LOG-FILE.
01  LOG-FILE-RECORD.
```

--------------------------------

### Evaluate Relational Comparisons

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=arithmetic-fixed-point-contrasted-floating-point

Example of an abbreviated comparison where multiple expressions are evaluated as a single unit.

```COBOL

if (a + d) = (b + e) and c

```

--------------------------------

### Define a group item with ODO

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=tables-creating-variable-length-depending

Example of a group item containing both the subject and object of the ODO clause.

```COBOL
WORKING-STORAGE SECTION.
01  MAIN-AREA.
    03 REC-1.
        05 FIELD-1                       PIC 9.
        05 FIELD-2 OCCURS 1 TO 5 TIMES
           DEPENDING ON FIELD-1          PIC X(05).
01  REC-2.
    03 REC-2-DATA                        PIC X(50).
```

--------------------------------

### Define an overloaded init method with one parameter

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=method-overloading-instance

Initializes an Account instance using a single account number parameter.

```COBOL

Linkage section.
01 inAccountNumber pic S9(9) binary.
Procedure Division using by value inAccountNumber.

```

--------------------------------

### Define COBOL data for XML generation

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=output-generating-xml

Example of defining a data structure and invoking XML generation.

```COBOL
01  doc pic x(512).
01  docSize pic 9(9) binary.
01  G. 
    05  A pic x(3) value "aaa". 
    05  B. 
        10  C pic x(3) value "ccc". 
        10  D pic x(3) value "ddd". 
    05  E pic x(3) value "eee".
    . . .
    XML Generate Doc from G
```

--------------------------------

### Initial generation data group state

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=groups-insertion-wrapping-generation-files

Example of an initial group state before a new generation is inserted.

```text

0: base.g0001v00 
0: base.g0999v00

```

--------------------------------

### Configure ACCEPT for File Input

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=items-assigning-input-from-screen-file-accept

Redirect input from a system device or an environment variable to read from a file instead of the screen.

```COBOL
SYSIN is Names-Input
```

```shell
export CONSOLE=/myfiles/myinput.rpt
```

--------------------------------

### Define Data Items for Comparison

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=functions-finding-largest-smallest-data-item

Example data definitions used as arguments for intrinsic comparison functions.

```COBOL

05  Arg1   Pic x(10)  Value "THOMASSON ".
05  Arg2   Pic x(10)  Value "THOMAS    ".
05  Arg3   Pic x(10)  Value "VALLEJO   ".

```

--------------------------------

### Perform arithmetic comparisons in COBOL

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=arithmetic-fixed-point-contrasted-floating-point

Examples of conditional statements involving arithmetic expressions and intrinsic functions.

```COBOL
if report-matrix-col <     function sqrt(emp-count) + 1
if whole-hours       not = function integer-part((average-hours) + 1)
```

--------------------------------

### Configure Cache Sizes and Flags via Environment Variable

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=performance-enabling-client-side-caching

Sets cache sizes and enables flexible caching options including dirty reads and inserts despite unique indices.

```shell
export ENCINA_VSAM_CACHE=16:64:ALLOW_DIRTY_READS,INSERTS_DESPITE_UNIQUE_INDICES
```

--------------------------------

### Perform general arithmetic operations in COBOL

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=arithmetic-fixed-point-contrasted-floating-point

Examples of standard arithmetic statements using COMPUTE and ADD.

```COBOL
compute report-matrix-col = (emp-count ** .5) + 1
add report-matrix-min to report-matrix-max giving report-matrix-tot
```

--------------------------------

### Initial GDG state

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=groups-insertion-wrapping-generation-files

Represents the starting state of a generation data group with a single base generation.

```text

0: base.g0001v00 

```

--------------------------------

### Performing arithmetic and intrinsic functions with COMPUTE

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=items-assigning-arithmetic-results-move-compute

Shows how to use COMPUTE for arithmetic expressions and calling intrinsic functions.

```COBOL
Compute z = y + (x ** 3)
Compute x = Function Max(x y z)
```

--------------------------------

### Connect to DB2 Database

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=files-using-db2

Use the db2 command to establish a connection to the target database.

```shell
> db2 connect to db2cob
        Database Connection Information
        Database server        = DB2/AIX64 9.7.0
        SQL authorization ID   = MYUID
        Local database alias   = DB2COB
```

--------------------------------

### Execute STRING Statement

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=string-example-statement

Performs the STRING operation to move data into RPT-LINE starting at the position specified by LINE-POS.

```COBOL

STRING
   LINE-NO SPACE CUST-INFO INV-NO SPACE DATE-DUE SPACE
      DELIMITED BY SIZE
   BAL-DUE
      DELIMITED BY DEC-POINT
   INTO RPT-LINE
   WITH POINTER LINE-POS.

```

--------------------------------

### Define ODO with external object

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=tables-creating-variable-length-depending

Example of defining a variable-length table where the ODO object is located outside the group item.

```COBOL
 DATA DIVISION.
 FILE SECTION.
 FD  LOCATION-FILE.
 01  LOCATION-RECORD.
     05  LOC-CODE                  PIC XX.
     05  LOC-DESCRIPTION           PIC X(20).
     05  FILLER                    PIC X(58).
 WORKING-STORAGE SECTION.
 01  FLAGS.
     05 LOCATION-EOF-FLAG          PIC X(5) VALUE SPACE.
        88 LOCATION-EOF               VALUE "FALSE".
 01  MISC-VALUES.
     05 LOCATION-TABLE-LENGTH      PIC 9(3) VALUE ZERO.
     05 LOCATION-TABLE-MAX         PIC 9(3) VALUE 100.
*****************************************************************
***                L O C A T I O N   T A B L E                ***
***                FILE CONTAINS LOCATION CODES.              ***
*****************************************************************
 01  LOCATION-TABLE.
     05 LOCATION-CODE OCCURS 1 TO 100 TIMES
          DEPENDING ON LOCATION-TABLE-LENGTH   PIC X(80).
```

--------------------------------

### Define a COBOL client program for the Account class

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=client-example-defining

This program demonstrates object instantiation, method invocation, and the use of LOCAL-STORAGE for thread-safe data management.

```COBOL
 cbl thread,pgmname(longmixed)
 Identification division.
 Program-id. "TestAccounts" recursive.
 Environment division.
 Configuration section.
 Repository.
     Class Account is "Account".
 Data Division.
*  Working data is declared in LOCAL-STORAGE instead of 
*  WORKING-STORAGE so that each thread has its own copy: 
 Local-storage section.
 01  anAccount usage object reference Account.
*
 Procedure division.
 Test-Account-section.
     Display "Test Account class"
*  Create account 123456 with 0 balance:
     Invoke Account "createAccount"
       using by value 123456
       returning anAccount
*  Deposit 500 to the account: 
     Invoke anAccount "credit" using by value 500
     Invoke anAccount "print"
     Display space
*
     Stop Run.
 End program "TestAccounts".
```

--------------------------------

### SCU fix code examples

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=scu-source-conversion-utility-options

List of common SCU fix codes and their corresponding descriptions for syntax and semantic changes.

```text
SCU0001 fix for IGYDS0001-W: Add missing space(s).
SCU0004 fix for IGYPS0019-W: Extra and misplaced periods in COBOL source. Scu removes the
extra periods.
SCU1002 fix for IGYGR1080-S: Non-floating point literal is assigned to floating point data
item. Scu converts it to floating point constant notation.
SCU1005 fix for IGYPS2024-S: SET used in place of MOVE. Scu converts SET stmt to MOVE stmt.
SCU1006 fix for IGYPS2094-S: "<>" converted to "NOT = ".
SCU1008 fix for IGYDS0017-E: "01" not in Area A. Scu moves 01 to Area A.
SCU3001 fix for IGYDS1063-E: OCCURS clause in level 01. Scu changes it to level 02 and adds 
a dummy 01. 
SCU8001 fix for IGYDS0093-S: RECORD SEQUENTIAL not supported. Scu replaces RECORD
SEQUENTIAL with LINE SEQUENTIAL.
SCX9001 specified for an 02 level data item following an 01 level OCCURS that has been changed
to an 02 level OCCURS with fix code SCU3001
```

--------------------------------

### Invoke a man page

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=information-viewing-man-pages

Use the man command followed by the specific utility or command name to view its documentation.

```shell
man command
```

--------------------------------

### Evaluate Implicit Comparisons

Source: https://www.ibm.com/docs/en/cobol-aix/5.1.0?topic=arithmetic-fixed-point-contrasted-floating-point

Example of an EVALUATE statement where arithmetic expressions are evaluated independently of one another's attributes.

```COBOL

evaluate (a + d)
    when (b + e) thru c
    when (f / g) thru (h * i)
    . . .
end-evaluate

```
Tokens:
Raw