IBM Enterprise COBOL for z/OS

https://www.ibm.com/docs/en/cobol-zos
Admin
IBM Enterprise COBOL for z/OS is a powerful, optimizing COBOL compiler designed for developing and...
Tokens:2,456,862
Snippets:24,947
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Environment Variable Setup for z/OS UNIX COPY

Source: https://www.ibm.com/docs/en/cobol-zos/6.5_topic=program-compiler-directing-statements

Provides examples of setting environment variables in the z/OS UNIX shell to specify copybook locations, including single and multiple path definitions.

```Shell
export MYCOPY=mystuff/today.cpy
export MYLIB=/u/user1
```

```Shell
export COPYLIB=/u/mystuff/copybooks
```

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

### cjbuild Utility Example Output and Compilation Steps

Source: https://www.ibm.com/docs/en/cobol-zos/6.5_topic=clrnocatij-step-2-running-cjbuild-utility-build-dll-java-stub-programs

Provides an example output of the `cjbuild` utility, showcasing the compilation and linking process for COBOL stub files and the subsequent Java compilation and JAR file creation. It highlights the command-line arguments used for COBOL compilation (`cob2`) and Java compilation (`javac`, `jar`).

```Shell
cjbuild, version 2.0.0
compatible stub file version: 6.0
=====================================

PROGRAM_FILE        = none
LIB_BASE_NAME       = app1
COBOL_DIR           = ./out
DLL_OUT_DIR         = //COBOL.LOAD
JAVA_CLASS_DIR      = ./class
JAVA_SRC_DIR        = .
JAR_FILE            = ./libapp1.jar
CLEANUP_SCRIPT_NAME = cjbuild_clean.sh
PACKAGE_NAME        = enterprise.COBOL
INTEROP_MODE        = MIX_31_64
JAVA_HOME           = /usr/lpp/java/J11.0_64
COBOL_INSTALL_DIR   = /home/user/cobol/igyv6r5

User env STEPLIB:
USERID.IGY.V6R5M0.SIGYCOMP:CEE.SCEERUN:CEE.SCEERUN2

Including file in app DLL: addlist_stub_app1.cbl
Including file in app DLL: COBPROD_stub_app1.cbl

# Compiling COBOL stub file addlist_stub_app1.cbl
/home/user/cobol/igyv6r5/bin/cob2 -qlist -qopt(1),nsymbol(national),dbcs,dispsign(sep) -c addlist_stub_app1.cbl -I /home/user/cobol/igyv6r5/include
# Command return code 0

# Compiling COBOL stub file COBPROD_stub_app1.cbl
/home/user/cobol/igyv6r5/bin/cob2 -qlist -qopt(1),nsymbol(national),dbcs,dispsign(sep) -c COBPROD_stub_app1.cbl -I /home/user/cobol/igyv6r5/include
# Command return code 0

# Linking application DLL
/home/user/cobol/igyv6r5/bin/cob2 -bdll,map -o //COBOL.LOAD(app1) addlist_stub_app1.o COBPROD_stub_app1.o /usr/lpp/java/J11.0_64/lib/j9vm/libjvm31.x /home/user/cobol/igyv6r5/lib/igzxjni2.x > libapp1.map
# Command return code 0

# Copying DLL side deck to current directory
cp -F bin //COBOL.EXP(app1) libapp1.x
# Command return code 0

# Compiling Java source program into bytecode
/usr/lpp/java/J11.0_64/bin/javac -d ./class -cp ./class ./cobol.java ./progs.java /home/user/jtoc/test/cobprod/COBPRODWS.java ./strg.java
# Command return code 0

# Building the .jar file
/usr/lpp/java/J11.0_64/bin/jar cvf ./libapp1.jar -C ./class enterprise/COBOL

```

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

### Configure Java Environment Variables for z/OS UNIX COBOL

Source: https://www.ibm.com/docs/en/cobol-zos/6.3_topic=64-running-mixed-amode-coboljava-interoperability-program

This section provides examples for setting the LIBPATH and CLASSPATH environment variables, essential for Java integration when running COBOL programs in a z/OS UNIX environment. $JAVAHOME represents the installed Java JDK home directory.

```shell
export LIBPATH={$JAVAHOME}/lib/s390x/j9vm:./ 
export CLASSPATH=./
```

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

### Create z/OS UNIX Directories with BPXBATCH

Source: https://www.ibm.com/docs/en/cobol-zos/6.4_topic=clrnocatij-sample-jcl-building-running-cobol-calls-java-application

This step ensures that required z/OS UNIX directories exist for the project. It uses the BPXBATCH utility to execute shell commands for creating directories. Dependencies include the BPXBATCH program and appropriate permissions for directory creation. Standard output and error streams are captured.

```JCL
//CRDIRS   EXEC PGM=BPXBATCH
//STDPARM  DD *,SYMBOLS=EXECSYS
SH mkdir -p &OUTDIR;
mkdir -p &WORKDIR;
mkdir -p &CLASSOUT;
mkdir -p &JVSRCOUT
/*
//STDOUT   DD SYSOUT=*
//STDERR   DD SYSOUT=*
//STDENV   DD *
NO_CUSTOM_SHELL=1
/*
```

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

### COBOL Example: Program Initialization Code

Source: https://www.ibm.com/docs/en/cobol-zos/6.3_topic=output-example-program-initialization-code

This example provides a look at the program initialization code generated by the COBOL compiler, showing the entry point and setup routines.

```COBOL
       IDENTIFICATION DIVISION.
       PROGRAM-ID. PROGINIT.
       DATA DIVISION.
       PROCEDURE DIVISION.
           DISPLAY 'Program initialization example'.
           GOBACK.

```

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

### cjbuild Command Usage

Source: https://www.ibm.com/docs/en/cobol-zos/6.5_topic=java-cjbuild-command-reference

This snippet shows the general syntax for executing the cjbuild utility and lists its available command-line options and their corresponding arguments. It helps users understand how to invoke the command with different configurations.

```bash
cjbuild [-h/--help] [-v/--verbose] [--version]
               [-c/--coboldir <cobol-dir>]
               [-d/--dlloutdir <dll-out-dir>]
               [-i/--progid <program-id>] ...
               [-j/--javaclassdir <java-class-dir>]
               [-k/--cleanscript <cleanup-script-name>]
               [-p/--pkgname <package-name>]
               [-r/--jar <jar-file>]
               [-s/--javasrcdir <java-src-dir>]
               [<program-file>] <lib-base-name>
```

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

### Example of Not Well-Formed XML Document

Source: https://www.ibm.com/docs/en/cobol-zos/6.5_topic=input-handling-xml-parse-exceptions

This snippet demonstrates an example of an XML document that is not well-formed due to a mismatch between the element start tag and end tag. This is used to illustrate the return and reason codes generated by the XML parser.

```XML
<msg>Hello</mmsg>
```

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

### COBOL Listing Header Example

Source: https://www.ibm.com/docs/en/cobol-zos/6.5_topic=6-changes-in-compiling-enterprise-cobol

An example of the listing header format for IBM Enterprise COBOL for z/OS, starting with version 6.1. This format aids in identifying the maintenance level of the compiler by including build level information.

```COBOL
PP 5655-EC6 IBM Enterprise COBOL for z/OS 6.5.0 PXXXXXX
```

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

### COBOL Repository Configuration for Object and Employee Arrays

Source: https://www.ibm.com/docs/en/cobol-zos/6.3_topic=java-declaring-arrays-strings

Provides a comprehensive COBOL example of the REPOSITORY paragraph, demonstrating how to define mappings for jobjectArray, a custom Employee class, and a Department array containing Employee objects.

```COBOL
Environment Division.
Configuration Section.
Repository.
    Class jobjectArray is "jobjectArray"
    Class Employee     is "com.acme.Employee"
    Class Department   is "jobjectArray:com.acme.Employee".
. .
Linkage section.
01 oa          usage object reference jobjectArray.
01 aDepartment usage object reference Department.
. .
Procedure division using by value aDepartment.
. .

```

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

### COBOL Procedure Division Start in z/OS

Source: https://www.ibm.com/docs/en/cobol-zos/6.3_topic=output-example-embedded-map-summary

Illustrates the beginning of the PROCEDURE DIVISION in a COBOL program on z/OS. It includes the main logic entry point and a display statement to indicate program start.

```COBOL
000487     procedure division.
000488       000-do-main-logic.
000489         display "PROGRAM IGYTCARA - Beginning".
```

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

### COBOL z/OS: RELEASE vs. RELEASE FROM - Example 1

Source: https://www.ibm.com/docs/en/cobol-zos/6.3_topic=files-coding-input-procedure

Provides a COBOL code example demonstrating the usage of the RELEASE statement, typically preceded by data movement and potentially a PERFORM for a subroutine.

```COBOL
MOVE SORT-EXT-RECORD
  TO SORT-RECORD
PERFORM RELEASE-SORT-RECORD
.
.
.
RELEASE-SORT-RECORD.
  RELEASE SORT-RECORD
```

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

### COBOL WHEN-COMPILED Example Value

Source: https://www.ibm.com/docs/en/cobol-zos/6.3_topic=registers-when-compiled

Provides an example of the WHEN-COMPILED special register's content based on a specific compilation date and time. If compilation started at 2:04 PM on October 15, 2007, the register would hold '10/15/0714.04.00'.

```COBOL
10/15/0714.04.00
```

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

### Build Java Application (BPXBATSL)

Source: https://www.ibm.com/docs/en/cobol-zos/6.4_topic=clrnocatij-sample-jcl-building-running-cobol-calls-java-application

This step compiles a Java application using the `javac` command executed via BPXBATSL. It requires a Java Development Kit (JDK) and its associated `javac` compiler. The compilation targets a specified output directory for class files. Environment variables for JAVA_HOME, CLASSPATH, and PATH are set.

```JCL
//BLDJAVA EXEC PGM=BPXBATSL
//STDPARM DD *,SYMBOLS=EXECSYS
PGM &JAVAHOME/bin/javac
 -d &CLASSOUT
 &WORKDIR/TestApp.java
/*
//STDOUT  DD SYSOUT=*
//STDERR  DD SYSOUT=*
//STDENV  DD *,SYMBOLS=EXECSYS
JAVA_HOME=&JAVAHOME
CLASSPATH=.:&CLASSOUT
PATH=.:/bin:/usr/bin:/usr/local/bin:&ZFSCBDIR/bin
/*
```

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

### COBOL ULENGTH Function Example with UTF-8

Source: https://www.ibm.com/docs/en/cobol-zos/6.5_topic=functions-ulength

Demonstrates the invocation of the ULENGTH function in COBOL with two arguments: a UTF-8 encoded string and a starting byte index. The function returns the count of UTF-8 characters from the specified position to the end of the string. Ensure the input string and starting index adhere to the specified constraints for correct results.

```COBOL
       IDENTIFICATION DIVISION.
         PROGRAM-ID. ULNEX3.
       DATA DIVISION.
        WORKING-STORAGE SECTION.
         1 RLEN PIC 9(4) BINARY.
         1 TEST-STRING PIC U BYTE-LENGTH 12. 
         1 START-INDEX PIC 9(9) BINARY.
       PROCEDURE DIVISION.
             MOVE UX"C2A061E0A08062F48FBFBF63" TO TEST-STRING
             MOVE 3 TO START-INDEX
             COMPUTE RLEN = FUNCTION ULENGTH(
               TEST-STRING START-INDEX)
             DISPLAY RLEN
             GOBACK.
       END PROGRAM ULNEX3.
```
Tokens:
Raw